hq

0.2.34 versions

github.com/maiha/hq.cr

a simple wrapper for crystal-xml

8 stars

0 dependents

License: MIT

Installation

# Add this to your shard.yml
dependencies:
  hq:
    github: maiha/hq.cr
    version: ~> 0.2.3

Then run:

shards install

shard.yml

Crystal: no constraint declared
License: MIT
Author: maiha <maiha@wota.jp>

Dependencies

Runtime Dependencies

try>= 0.3.0github: maiha/try.cr
myhtml0.12github: kostya/myhtml

README

# hq.cr [![Build Status](https://travis-ci.org/maiha/hq.cr.svg?branch=master)](https://travis-ci.org/maiha/hq.cr)

a simple wrapper for crystal-xml and myhtml
- gateway pattern : suppress errors until values are referenced
- handy accessors : provide useful extractors and conversions

## Installation

- crystal: 0.23.x

Add this to your application's `shard.yml`:

```yaml
dependencies:
  hq:
    github: maiha/hq.cr
    version: 0.2.3
```

## xpath

```crystal
require "hq"

node = Hq.parse("<html><body><div>82 users</div></body></html>")
node.xpath("/html/body/div").text # => "82 users"
node.xpath("/html/body/div").int  # => 82
node.xpath("/html/body/nav").int? # => nil
node.xpath("/html/body").path     # => "/html/body"
node.xpath("/html/div").text      # raise Hq::NotFound.new(key: "/html/div")
```

## css

- css selector

```crystal
nodes = Hq::Css.parse <<-EOF
  <ul>
    <li>foo</li>
    <li>bar</li>
  </ul>
  EOF
nodes.css("li").map(&.text)  # => ["foo", "bar"]
```

- node attributes

```crystal
nodes = Hq::Css.parse <<-EOF
  <a href="https://github.com/crystal-lang/crystal" class="official">crystal</a>
  <a href="https://github.com/maiha/hq.cr">hq.cr</a>
  EOF
nodes.css("a").each do |a|
  p [a["href"], a["class"]?]
end

# => ["https://github.com/crystal-lang/crystal", "official"]
# => ["https://github.com/maiha/hq.cr", nil]
```

## Roadmap

#### 0.2.0

- [x] support `css(tag)`

#### 0.3.0

- [ ] support `css(tag_with_class)` 
- [x] support `Css::Node#attributes`

#### 0.4.0

- [ ] support `Hq.mapping` like `jq.cr`

## Contributing

1. Fork it ( https://github.com/maiha/hq.cr/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [maiha](https://github.com/maiha) maiha - creator, maintainer

hq

Installation

shard.yml

Dependencies

Runtime Dependencies

README

Documentation

Links

This release

Dependents

Repository

Metadata