Skip to content

Commit

Permalink
Merge branch 'master' into betterShow
Browse files Browse the repository at this point in the history
  • Loading branch information
aminya authored Mar 1, 2020
2 parents 9af7c7e + 9965f7c commit 21a0db6
Show file tree
Hide file tree
Showing 22 changed files with 358 additions and 330 deletions.
40 changes: 0 additions & 40 deletions .appveyor.yml

This file was deleted.

27 changes: 27 additions & 0 deletions .github/workflows/CompatHelper.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: CompatHelper

on:
schedule:
- cron: '0 1 * * *'
issues:
types: [opened, reopened]

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: [1.3.1]
julia-arch: [x64]
os: [ubuntu-latest]
steps:
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}
- name: Install dependencies
run: julia -e 'using Pkg; Pkg.add(Pkg.PackageSpec(name = "CompatHelper", url = "https://github.com/bcbi/CompatHelper.jl.git"))'
- name: CompatHelper.main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
JULIA_DEBUG: CompatHelper
run: julia -e 'using CompatHelper; CompatHelper.main()'
10 changes: 10 additions & 0 deletions .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: TagBot
on:
create
jobs:
TagBot:
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
28 changes: 28 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: CI
on:
- push
- pull_request
jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
version:
- '1.3'
- 'nightly'
os:
- ubuntu-latest
- macOS-latest
- windows-latest
arch:
- x64
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-runtest@latest
30 changes: 30 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation

on:
push:
branches:
- 'master'
- 'release-'
tags: '*'
pull_request:

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: [1.3.1]
julia-arch: [x64]
os: [ubuntu-latest]
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}
- name: Install dependencies
run: julia --project=docs -e 'using Pkg; Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
run: julia --project=docs --color=yes docs/make.jl
26 changes: 0 additions & 26 deletions .travis.yml

This file was deleted.

2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The EzXML.jl package is licensed under the MIT "Expat" License:
The EzXMLPatched.jl package is licensed under the MIT "Expat" License:

> Copyright (c) 2016: Kenta Sato.
>
Expand Down
6 changes: 3 additions & 3 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "EzXML"
uuid = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
name = "EzXMLPatched"
uuid = "ebbc4602-91c8-4f2e-9b89-acc792d9cec0"
authors = ["Kenta Sato <[email protected]>"]
version = "1.1.0"
version = "1.0.0"

[deps]
XML2_jll = "02c8fc9c-b97f-50b9-bbe4-9be30ff0a78a"
Expand Down
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
<p align="center"><img src="/docs/EzXML.jl.png" alt="EzXML.jl Logo" width="350" /></p>
<p align="center"><img src="/docs/EzXMLPatched.jl.png" alt="EzXMLPatched.jl Logo" width="350" /></p>

EzXML.jl - XML/HTML tools for primates
EzXMLPatched.jl - XML/HTML tools for primates
======================================

[![Docs Stable][docs-stable-img]][docs-stable-url]
[![Docs Latest][docs-latest-img]][docs-latest-url]
[![TravisCI Status][travisci-img]][travisci-url]
[![Appveyor Status][appveyor-img]][appveyor-url]
![Build Status (Github Actions)](https://github.com/aminya/EzXMLPatched.jl/workflows/CI/badge.svg)
[![codecov.io][codecov-img]][codecov-url]

EzXML.jl is a package to handle XML/HTML documents for primates.
EzXMLPatched.jl is a package to handle XML/HTML documents for primates.

The main features are:
* Reading and writing XML/HTML documents.
Expand All @@ -24,9 +23,9 @@ The main features are:
Installation
------------

Install EzXML.jl as follows:
Install EzXMLPatched.jl as follows:
```
julia -e 'using Pkg; Pkg.add("EzXML")'
julia -e 'using Pkg; Pkg.add("EzXMLPatched")'
```

This package depends on [libxml2](http://xmlsoft.org/) 2.9.9, which will be automatically installed as an artifact via [XML2_jll.jl](https://github.com/JuliaBinaryWrappers/XML2_jll.jl) if you use Julia 1.3 or later.
Expand All @@ -35,7 +34,7 @@ Currently, Windows, Linux, macOS, and FreeBSD are now supported.
Version compatibility
---------------------

| EzXML.jl | Julia |
| EzXMLPatched.jl | Julia |
|:--------:|:------------:|
| 1.0 | 1.0 or later |
| 1.1 | 1.3 or later |
Expand All @@ -45,7 +44,7 @@ Usage

```julia
# Load the package.
using EzXML
using EzXMLPatched

# Parse an XML string
# (use `readxml(<filename>)` to read a document from a file).
Expand Down Expand Up @@ -86,13 +85,13 @@ end
Quick reference
---------------

See the [reference page](https://bicycle1885.github.io/EzXML.jl/stable/reference/) or docstrings for more details.
See the [reference page](https://bicycle1885.github.io/EzXMLPatched.jl/stable/reference/) or docstrings for more details.

Types:
* `EzXML.Document`: an XML/HTML document
* `EzXML.Node`: an XML/HTML node including elements, attributes, texts, etc.
* `EzXML.XMLError`: an error happened in libxml2
* `EzXML.StreamReader`: a streaming XML reader
* `EzXMLPatched.Document`: an XML/HTML document
* `EzXMLPatched.Node`: an XML/HTML node including elements, attributes, texts, etc.
* `EzXMLPatched.XMLError`: an error happened in libxml2
* `EzXMLPatched.StreamReader`: a streaming XML reader

IO:
* From file: `readxml(filename|stream)`, `readhtml(filename|stream)`
Expand Down Expand Up @@ -130,8 +129,8 @@ Accessors:
* Namespaces: `namespace(node)`, `namespaces(node)`

Constructors:
* `EzXML.Document` type: `XMLDocument(version="1.0")`, `HTMLDocument(uri=nothing, externalID=nothing)`
* `EzXML.Node` type: `XMLDocumentNode(version="1.0")`, `HTMLDocumentNode(uri, externalID)`, `ElementNode(name)`, `TextNode(content)`, `CommentNode(content)`, `CDataNode(content)`, `AttributeNode(name, value)`, `DTDNode(name, [systemID, [externalID]])`
* `EzXMLPatched.Document` type: `XMLDocument(version="1.0")`, `HTMLDocument(uri=nothing, externalID=nothing)`
* `EzXMLPatched.Node` type: `XMLDocumentNode(version="1.0")`, `HTMLDocumentNode(uri, externalID)`, `ElementNode(name)`, `TextNode(content)`, `CommentNode(content)`, `CDataNode(content)`, `AttributeNode(name, value)`, `DTDNode(name, [systemID, [externalID]])`

Queries:
* XPath: `findall(xpath, doc|node)`, `findfirst(xpath, doc|node)`, `findlast(xpath, doc|node)`
Expand All @@ -150,12 +149,12 @@ Other XML/HTML packages in Julia
* [LibExpat.jl](https://github.com/amitmurthy/LibExpat.jl)

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://bicycle1885.github.io/EzXML.jl/stable
[docs-stable-url]: https://bicycle1885.github.io/EzXMLPatched.jl/stable
[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg
[docs-latest-url]: https://bicycle1885.github.io/EzXML.jl/latest
[travisci-img]: https://travis-ci.org/bicycle1885/EzXML.jl.svg?branch=master
[travisci-url]: https://travis-ci.org/bicycle1885/EzXML.jl
[docs-latest-url]: https://bicycle1885.github.io/EzXMLPatched.jl/latest
[travisci-img]: https://travis-ci.org/bicycle1885/EzXMLPatched.jl.svg?branch=master
[travisci-url]: https://travis-ci.org/bicycle1885/EzXMLPatched.jl
[appveyor-img]: https://ci.appveyor.com/api/projects/status/n5d7o2mmy8ckdjc8?svg=true
[appveyor-url]: https://ci.appveyor.com/project/bicycle1885/ezxml-jl
[codecov-img]: http://codecov.io/github/bicycle1885/EzXML.jl/coverage.svg?branch=master
[codecov-url]: http://codecov.io/github/bicycle1885/EzXML.jl?branch=master
[codecov-img]: http://codecov.io/github/bicycle1885/EzXMLPatched.jl/coverage.svg?branch=master
[codecov-url]: http://codecov.io/github/bicycle1885/EzXMLPatched.jl?branch=master
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
EzXML = "8f5d6c58-4d21-5cfd-889c-e3ad7ee6a615"
EzXMLPatched = "ebbc4602-91c8-4f2e-9b89-acc792d9cec0"

[compat]
Documenter = "~0.24"
8 changes: 4 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
using Documenter
using EzXML
using EzXMLPatched

makedocs(
sitename="EzXML.jl",
modules=[EzXML],
sitename="EzXMLPatched.jl",
modules=[EzXMLPatched],
pages=["index.md", "manual.md", "reference.md", "devnotes.md"])

deploydocs(
repo="github.com/bicycle1885/EzXML.jl.git",
repo="github.com/bicycle1885/EzXMLPatched.jl.git",
target="build")
2 changes: 1 addition & 1 deletion docs/setup.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
using Pkg
Pkg.instantiate()
Pkg.develop(PackageSpec(path=pwd()))
Pkg.build("EzXML")
Pkg.build("EzXMLPatched")
4 changes: 2 additions & 2 deletions docs/src/devnotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ allocated by libxml2. There are several node-like types in libxml2 that have
common fields to constitute an XML tree. These fields are always located at the
first fields of struct definitions, so we can safely use them by casting a
pointer to `_Node`. Especially, the first field, `_private`, is reserved for
applications and EzXML.jl uses it to store a pointer to a `Node` object. That
applications and EzXMLPatched.jl uses it to store a pointer to a `Node` object. That
is, a `Node` object points to a node struct and the node struct keeps an
opposite pointer to the `Node` object. These bidirectional references are
especially important in this package.
Expand All @@ -33,7 +33,7 @@ after finished freeing nodes, which may result in a segmentation fault. Another
important role of keeping owner reference is that it prohibits owner objects
from being deallocated by Julia's garbage collecter.

Since the `owner` field is not managed by libxml2, EzXML.jl needs to update the
Since the `owner` field is not managed by libxml2, EzXMLPatched.jl needs to update the
field when changing the structure of an XML tree. For example, linking a tree
with another tree will lead to an inconsistent situation where descendants nodes
reference different owner nodes. `update_owners!` updates the owner node of a
Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Home
====

EzXML.jl is a package for handling XML and HTML documents. The APIs are simple
EzXMLPatched.jl is a package for handling XML and HTML documents. The APIs are simple
and consistent, and provide a range of functionalities including:
* Reading and writing XML/HTML documents.
* Traversing XML/HTML trees with DOM interfaces.
Expand All @@ -15,7 +15,7 @@ and consistent, and provide a range of functionalities including:
Here is an example of parsing and traversing an XML document:
```julia
# Load the package.
using EzXML
using EzXMLPatched

# Parse an XML string
# (use `readxml(<filename>)` to read a document from a file).
Expand Down
Loading

0 comments on commit 21a0db6

Please sign in to comment.