ryoba 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8f9b74acd04ed36e1171fb82634e96d9da6bea4
+  data.tar.gz: ce38a2666fa0e0cc710386bf97a06e52312a9c6a
+SHA512:
+  metadata.gz: c341734a0b8656a61f4889b01a74b3ca2c3593532635ea533cf75c31d6e1859612641c24113e57df12ef1d21ba180b306cd32ab804a087e01a9f49453d0158e7
+  data.tar.gz: be4be1c45496f21e0c4ed2d7da8627bf845306fd2970d77223984120c0b416517d8ec6c2a2a63e9f72271e997838cfe3e88c6aa0027f669d684b6e84ef9ac730

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ryoba.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jonathan Hefner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# ryoba
+
+[Nokogiri](https://rubygems.org/gems/nokogiri) utility methods.
+
+
+## API
+
+- Nokogiri::XML::Node
+  - [#matches!](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:matches%21)
+  - [#text!](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:text%21)
+  - [#uri](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:uri)
+- Nokogiri::XML::Searchable
+  - [#ancestor](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:ancestor)
+  - [#ancestor!](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:ancestor%21)
+  - [#ancestors!](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:ancestors%21)
+  - [#at!](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:at%21)
+  - [#search!](http://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:search%21)
+
+
+## Installation
+
+Install from [Ruby Gems](https://rubygems.org/gems/ryoba):
+
+```bash
+$ gem install ryoba
+```
+
+Then require in your Ruby script:
+
+```ruby
+require "ryoba"
+```
+
+
+## Contributing
+
+Run `rake test` to run the tests.  You can also run `rake irb` for an
+interactive prompt that pre-loads the project code.
+
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "yard"
+
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end
+
+desc "Launch IRB with this gem pre-loaded"
+task :irb do
+  require "ryoba"
+  require "irb"
+  ARGV.clear
+  IRB.start
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/ryoba.rb

@@ -0,0 +1,6 @@
+require "nokogiri"
+
+require_relative "ryoba/version"
+require_relative "ryoba/error"
+require_relative "ryoba/nokogiri/xml/node"
+require_relative "ryoba/nokogiri/xml/searchable"

data/lib/ryoba/error.rb

@@ -0,0 +1,2 @@
+class Ryoba::Error < RuntimeError
+end

data/lib/ryoba/nokogiri/xml/node.rb

@@ -0,0 +1,72 @@
+require "uri"
+
+class Nokogiri::XML::Node
+
+  # Equivalent to +.text.strip+, but raises an error if the result is an
+  # empty string.
+  #
+  # @return [String]
+  # @raise [Ryoba::Error]
+  #   if result is an empty string
+  def text!
+    result = self.text.strip
+    if result.empty?
+      raise Ryoba::Error.new("No text in:\n#{self.to_html}")
+    end
+    result
+  end
+
+  # Like +Node#matches?+, but, instead of returning a boolean, returns
+  # the Node if it matches +selector+ and raises an error otherwise.
+  #
+  # @param selector [String]
+  #   selector to match
+  # @return [self]
+  # @raise [Ryoba::Error]
+  #   if Node does not match +selector+
+  def matches!(selector)
+    if !self.matches?(selector)
+      abbreviated = self.to_html[/[^>]+>/]
+      raise Ryoba::Error.new("Node #{abbreviated} does not match #{selector.inspect}")
+    end
+    self
+  end
+
+  HTML_ELEMENT_URI_ATTRIBUTES = {
+    "a" => "href",
+    "img" => "src",
+    "form" => "action",
+  }
+
+  # Returns a URI from a specified attribute's value.  If no attribute
+  # is specified, an appropriate attribute will be chosen from
+  # {HTML_ELEMENT_URI_ATTRIBUTES} using the Node's +name+, if possible.
+  # A relative URI will be converted to an absolute URI, based on the
+  # Node document's +url+, if possible.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML, "http://localhost/qux")
+  #     <body>
+  #       <a href="https://www.example.com/foo">FOO</a>
+  #       <div data-src="/bar" />
+  #       <p>blah</p>
+  #     </body>
+  #   XML
+  #
+  #   xml.at("a").uri                # == URI("https://www.example.com/foo")
+  #   xml.at("div").uri("data-src")  # == URI("http://localhost/qux/bar")
+  #   xml.at("p").uri                # == nil
+  #
+  # @param attribute_name [String]
+  #   name of the attribute to return as a URI
+  # @return [URI, nil]
+  def uri(attribute_name = nil)
+    attribute_name ||= HTML_ELEMENT_URI_ATTRIBUTES[self.name]
+    url = self[attribute_name]
+
+    if url
+      self.document.url ? URI.join(self.document.url, url) : URI(url)
+    end
+  end
+
+end

data/lib/ryoba/nokogiri/xml/searchable.rb

@@ -0,0 +1,68 @@
+module Nokogiri::XML::Searchable
+
+  # Like +Searchable#search+, but raises an exception if there are no
+  # results.
+  #
+  # @param queries [Array<String>]
+  # @return [Array<Nokogiri::XML::Element>]
+  # @raise [Ryoba::Error]
+  #   if all queries yield no results
+  def search!(*queries)
+    results = self.search(*queries)
+    if results.empty?
+      raise Ryoba::Error.new("No elements matching #{queries.map(&:inspect).join(" OR ")}")
+    end
+    results
+  end
+
+  # Like +Searchable#at+, but raises an exception if there are no
+  # results.
+  #
+  # @param queries [Array<String>]
+  # @return [Nokogiri::XML::Element]
+  # @raise [Ryoba::Error]
+  #   if all queries yield no results
+  def at!(*queries)
+    result = self.at(*queries)
+    if result.nil?
+      raise Ryoba::Error.new("No elements matching #{queries.map(&:inspect).join(" OR ")}")
+    end
+    result
+  end
+
+  # Like +Searchable#ancestors+, but raises an exception if there are no
+  # matching ancestors.
+  #
+  # @param selector [String]
+  # @return [Array<Nokogiri::XML::Element>]
+  # @raise [Ryoba::Error]
+  #   if no ancestors match +selector+
+  def ancestors!(selector = nil)
+    results = self.ancestors(selector)
+    if results.empty?
+      raise Ryoba::Error.new("No ancestors matching #{selector.inspect}")
+    end
+    results
+  end
+
+  # Like +Searchable#ancestors+, but returns only the first matching
+  # ancestor.
+  #
+  # @param selector [String]
+  # @return [Nokogiri::XML::Element, nil]
+  def ancestor(selector = nil)
+    self.ancestors(selector).first
+  end
+
+  # Like +Searchable#ancestors!+, but returns only the first matching
+  # ancestor.
+  #
+  # @param selector [String]
+  # @return [Nokogiri::XML::Element]
+  # @raise [Ryoba::Error]
+  #   if no ancestors match +selector+
+  def ancestor!(selector = nil)
+    self.ancestors!(selector).first
+  end
+
+end

data/lib/ryoba/version.rb

@@ -0,0 +1,3 @@
+module Ryoba
+  VERSION = "1.0.0"
+end

data/ryoba.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ryoba/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ryoba"
+  spec.version       = Ryoba::VERSION
+  spec.authors       = ["Jonathan Hefner"]
+  spec.email         = ["jonathan.hefner@gmail.com"]
+
+  spec.summary       = %q{Nokogiri utility methods}
+  spec.homepage      = "https://github.com/jonathanhefner/ryoba"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri", ">= 1.6.6", "< 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: ryoba
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- jonathan.hefner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ryoba.rb
+- lib/ryoba/error.rb
+- lib/ryoba/nokogiri/xml/node.rb
+- lib/ryoba/nokogiri/xml/searchable.rb
+- lib/ryoba/version.rb
+- ryoba.gemspec
+homepage: https://github.com/jonathanhefner/ryoba
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Nokogiri utility methods
+test_files: []