hq

Simple wrapper for crystal-xml

HTML/XML Parsing

0.2.3 Latest release released about 7 years ago

maiha/hq.cr

almost 3 years ago

7 1 2

maiha

Source

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:

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

xpath

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

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

node attributes

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

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

Contributors

maiha maiha - creator, maintainer

hq:
  github: maiha/hq.cr
  version: ~> 0.2.3

License MIT

Crystal none

Authors

maiha maiha@wota.jp

Dependencies 2

myhtml 0.12

{'github' => 'kostya/myhtml', 'version' => 0.12}

try >= 0.3.0

{'github' => 'maiha/try.cr', 'version' => '>= 0.3.0'}

hq