ryoba 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c8f9b74acd04ed36e1171fb82634e96d9da6bea4
-  data.tar.gz: ce38a2666fa0e0cc710386bf97a06e52312a9c6a
+SHA256:
+  metadata.gz: dbea6a62f02bcec9504fb66b9f43619103cf4a90010e7bc56b66e650d2737e04
+  data.tar.gz: fd92a7df7d967d79ae34f527d5f0c025d1e06b53592f86f4264539a44339bf52
 SHA512:
-  metadata.gz: c341734a0b8656a61f4889b01a74b3ca2c3593532635ea533cf75c31d6e1859612641c24113e57df12ef1d21ba180b306cd32ab804a087e01a9f49453d0158e7
-  data.tar.gz: be4be1c45496f21e0c4ed2d7da8627bf845306fd2970d77223984120c0b416517d8ec6c2a2a63e9f72271e997838cfe3e88c6aa0027f669d684b6e84ef9ac730
+  metadata.gz: 02d81589dd867ed1555ebb82123ff8cf132b571d3da5893517af6d4e7b7ccc99c54a704a271263fa0592064754329bf7d8e8692e18c9d436a5c95000d7e6d9ef
+  data.tar.gz: c0eede04b599c9d96f2f7294a778b0bc2ea53c13f17e2daeb8606e0b972e7b3776d3b94c2f6dd3c7aa33a7a94189d72b26509e20fc6fbd17d723bc7600ef4087

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## 2.0.0
+
+* [BREAKING] Drop support for Ruby < 3.4
+
+
+## 1.1.0
+
+* Rename `Nokogiri::XML::Node#text!` to `#content!`, and alias as
+  `#text!` and `#inner_text!`
+* Add `Nokogiri::XML::Node#content?`, and alias as `#inner_text?`
+* Add `Nokogiri::XML::Document#uri`
+
+
+## 1.0.0
+
+* Initial release

data/Gemfile

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

data/README.md

@@ -5,39 +5,34 @@
 
 ## 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)
+- [`Nokogiri::XML::Document`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Document)
+  - [`#uri`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Document:uri)
+- [`Nokogiri::XML::Node`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node)
+  - [`#content!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:content%21)
+    - aliased as [`#inner_text!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:inner_text%21)
+    - aliased as [`#text!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:text%21)
+  - [`#content?`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:content%3F)
+    - aliased as [`#inner_text?`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:inner_text%3F)
+  - [`#matches!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:matches%21)
+  - [`#uri`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Node:uri)
+- [`Nokogiri::XML::Searchable`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable)
+  - [`#ancestor`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:ancestor)
+  - [`#ancestor!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:ancestor%21)
+  - [`#ancestors!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:ancestors%21)
+  - [`#at!`](https://www.rubydoc.info/gems/ryoba/Nokogiri/XML/Searchable:at%21)
+  - [`#search!`](https://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"
-```
+Install the [`ryoba` gem](https://rubygems.org/gems/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.
+Run `rake test` to run the tests.
 
 
 ## License
 
-[MIT License](https://opensource.org/licenses/MIT)
+[MIT License](LICENSE.txt)

data/Rakefile

@@ -1,18 +1,5 @@
 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"

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

@@ -0,0 +1,19 @@
+require "uri"
+
+class Nokogiri::XML::Document
+
+  # Constructs a URI from the Document's +url+, unless +url+ is nil.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML, "https://www.example.com/foo")
+  #     <body>FOO</body>
+  #   XML
+  #
+  #   xml.uri  # == URI("https://www.example.com/foo")
+  #
+  # @return [URI, nil]
+  def uri
+    URI(url) if url
+  end
+
+end

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

@@ -2,25 +2,79 @@ require "uri"
 
 class Nokogiri::XML::Node
 
-  # Equivalent to +.text.strip+, but raises an error if the result is an
+  # Equivalent to +content.strip+, but returns nil if the result is an
   # empty string.
   #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <h1>
+  #         Headline 1
+  #       </h1>
+  #       <h2> Headline 2 </h2>
+  #       <h3> </h3>
+  #     </body>
+  #   XML
+  #
+  #   xml.at("h1").content?  # == "Headline 1"
+  #   xml.at("h2").content?  # == "Headline 2"
+  #   xml.at("h3").content?  # == nil
+  #
+  # @return [String, nil]
+  def content?
+    result = self.content.strip
+    result unless result.empty?
+  end
+
+  alias_method :inner_text?, :content?
+
+  # Equivalent to +content.strip+, but raises an exception if the result
+  # is an empty string.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <h1>
+  #         Headline 1
+  #       </h1>
+  #       <h2> Headline 2 </h2>
+  #       <h3> </h3>
+  #     </body>
+  #   XML
+  #
+  #   xml.at("h1").content!  # == "Headline 1"
+  #   xml.at("h2").content!  # == "Headline 2"
+  #   xml.at("h3").content!  # raises exception
+  #
   # @return [String]
   # @raise [Ryoba::Error]
-  #   if result is an empty string
-  def text!
-    result = self.text.strip
+  #   if +content.strip+ returns an empty string
+  def content!
+    result = self.content.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.
+  alias_method :inner_text!, :content!
+  alias_method :text!, :content!
+
+  # Like +Node#matches?+, but returns the Node if +selector+ matches,
+  # and raises an exception otherwise.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <div id="a" class="c" />
+  #       <div id="b" />
+  #     </body>
+  #   XML
+  #
+  #   xml.at("#a").matches!(".c")  # == Node div#a.c
+  #   xml.at("#b").matches!(".c")  # raises exception
   #
   # @param selector [String]
-  #   selector to match
   # @return [self]
   # @raise [Ryoba::Error]
   #   if Node does not match +selector+
@@ -38,35 +92,33 @@ class Nokogiri::XML::Node
     "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.
+  # Builds a URI from a specified attribute.  If no attribute is
+  # specified, an element-appropriate attribute is chosen from
+  # {HTML_ELEMENT_URI_ATTRIBUTES}, if possible.  Relative URIs are
+  # converted to absolute URIs using the Node's +document.url+, if
+  # possible.
   #
   # @example
-  #   xml = Nokogiri::XML(<<-XML, "http://localhost/qux")
+  #   xml = Nokogiri::XML(<<-XML, "http://localhost/qux/")
   #     <body>
   #       <a href="https://www.example.com/foo">FOO</a>
-  #       <div data-src="/bar" />
+  #       <img src="/bar" />
+  #       <div data-src="baz" />
   #       <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("img").uri              # == URI("http://localhost/bar")
+  #   xml.at("div").uri("data-src")  # == URI("http://localhost/qux/baz")
   #   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
+    URI.join(*self.document.url, url) if url
   end
 
 end

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

@@ -1,10 +1,20 @@
 module Nokogiri::XML::Searchable
 
-  # Like +Searchable#search+, but raises an exception if there are no
-  # results.
+  # Like +#search+, but raises an exception if there are no results.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <div id="a" />
+  #       <div id="b" />
+  #     </body>
+  #   XML
+  #
+  #   xml.search!("div")  # == NodeSet [div#a, div#b]
+  #   xml.search!("img")  # raises exception
   #
   # @param queries [Array<String>]
-  # @return [Array<Nokogiri::XML::Element>]
+  # @return [Nokogiri::XML::NodeSet]
   # @raise [Ryoba::Error]
   #   if all queries yield no results
   def search!(*queries)
@@ -15,8 +25,18 @@ module Nokogiri::XML::Searchable
     results
   end
 
-  # Like +Searchable#at+, but raises an exception if there are no
-  # results.
+  # Like +#at+, but raises an exception if there are no results.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <div id="a" />
+  #       <div id="b" />
+  #     </body>
+  #   XML
+  #
+  #   xml.at!("div")  # == Node div#a
+  #   xml.at!("img")  # raises exception
   #
   # @param queries [Array<String>]
   # @return [Nokogiri::XML::Element]
@@ -30,11 +50,27 @@ module Nokogiri::XML::Searchable
     result
   end
 
-  # Like +Searchable#ancestors+, but raises an exception if there are no
-  # matching ancestors.
+  # Like +#ancestors+, but raises an exception if there are no matching
+  # ancestors.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <div id="a">
+  #         <div id="b">
+  #           <img src="cat.jpg">
+  #         </div>
+  #       </div>
+  #     </body>
+  #   XML
+  #
+  #   xml.at("img").ancestors!         # == NodeSet [div#b, div#a, body]
+  #   xml.at("img").ancestors!("div")  # == NodeSet [div#b, div#a]
+  #   xml.at("img").ancestors!("#a")   # == NodeSet [div#a]
+  #   xml.at("img").ancestors!("#z")   # raises exception
   #
   # @param selector [String]
-  # @return [Array<Nokogiri::XML::Element>]
+  # @return [Nokogiri::XML::NodeSet]
   # @raise [Ryoba::Error]
   #   if no ancestors match +selector+
   def ancestors!(selector = nil)
@@ -45,8 +81,22 @@ module Nokogiri::XML::Searchable
     results
   end
 
-  # Like +Searchable#ancestors+, but returns only the first matching
-  # ancestor.
+  # Like +#ancestors+, but returns only the first matching ancestor.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <div id="a">
+  #         <div id="b">
+  #           <img src="cat.jpg">
+  #         </div>
+  #       </div>
+  #     </body>
+  #   XML
+  #
+  #   xml.at("img").ancestor        # == Node div#b
+  #   xml.at("img").ancestor("#a")  # == Node div#a
+  #   xml.at("img").ancestor("#z")  # == nil
   #
   # @param selector [String]
   # @return [Nokogiri::XML::Element, nil]
@@ -54,8 +104,22 @@ module Nokogiri::XML::Searchable
     self.ancestors(selector).first
   end
 
-  # Like +Searchable#ancestors!+, but returns only the first matching
-  # ancestor.
+  # Like {ancestors!}, but returns only the first matching ancestor.
+  #
+  # @example
+  #   xml = Nokogiri::XML(<<-XML)
+  #     <body>
+  #       <div id="a">
+  #         <div id="b">
+  #           <img src="cat.jpg">
+  #         </div>
+  #       </div>
+  #     </body>
+  #   XML
+  #
+  #   xml.at("img").ancestor!        # == Node div#b
+  #   xml.at("img").ancestor!("#a")  # == Node div#a
+  #   xml.at("img").ancestor!("#z")  # raises exception
   #
   # @param selector [String]
   # @return [Nokogiri::XML::Element]

data/lib/ryoba/version.rb

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

data/lib/ryoba.rb

@@ -2,5 +2,6 @@ require "nokogiri"
 
 require_relative "ryoba/version"
 require_relative "ryoba/error"
+require_relative "ryoba/nokogiri/xml/document"
 require_relative "ryoba/nokogiri/xml/node"
 require_relative "ryoba/nokogiri/xml/searchable"

data/ryoba.gemspec

@@ -1,29 +1,27 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ryoba/version"
+require_relative "lib/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.email         = ["jonathan@hefner.pro"]
 
   spec.summary       = %q{Nokogiri utility methods}
   spec.homepage      = "https://github.com/jonathanhefner/ryoba"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.4"
+
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.metadata["source_code_uri"] + "/blob/master/CHANGELOG.md"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.start_with?("test/", ".git") }
   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"
+  spec.add_dependency "nokogiri", ">= 1.6.6", "< 2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ryoba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonathan Hefner
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,77 +29,20 @@ dependencies:
     - - "<"
       - !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
+- jonathan@hefner.pro
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/ryoba.rb
 - lib/ryoba/error.rb
+- lib/ryoba/nokogiri/xml/document.rb
 - lib/ryoba/nokogiri/xml/node.rb
 - lib/ryoba/nokogiri/xml/searchable.rb
 - lib/ryoba/version.rb
@@ -108,8 +50,9 @@ files:
 homepage: https://github.com/jonathanhefner/ryoba
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/jonathanhefner/ryoba
+  changelog_uri: https://github.com/jonathanhefner/ryoba/blob/master/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -117,16 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Nokogiri utility methods
 test_files: []

data/.gitignore

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

data/.travis.yml

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