micromicro 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c5c3cb23e1c8338fef3d7cca36c47e4dcc834f3819525c01bd7ce6dab314971
-  data.tar.gz: 27794eaac80a6701c7910f4e31200a4bc999d0b8082b3ca1d2dd5a87a0bdaa82
+  metadata.gz: d9c965d277e7c87c68de6ce7a12aff28da257d813573de2519bfe36943df1f4f
+  data.tar.gz: a62d02a8fe962b060c36a9c615445f586fe76ea1c570d71f05175d140d631d32
 SHA512:
-  metadata.gz: d59f245021fb8bec36e1e319cffce3c3a6168ea763952efc8759bda7cb7a7bf13420632cdcfd2b988d72524a348f5a1238ff206cfd3aa75bfb5a57621f4f3b8c
-  data.tar.gz: 9355a25a3b65fe72828abf95d4dcec2829e46772904487b030a906cd95708f4bc946570f507bae326df2a3e8066e3de1c332799977cf8db749269e095bba413b
+  metadata.gz: 8ee19e4ca072c36137746dd54e435405a9a749761c9b735d75ff9f97a5c28f8e5367f79c3a7ad45c83039eb8cb54f1043cac2dd7ddcd1bfd2d4fbbad0d218ad6
+  data.tar.gz: f5f88370b3fc92e2d467c8e358798c6266b5fb9dbfe50fb13e74b2235572e9adfbfeb4f171b1df3d5bf474cc549bac7adfe3fa7c2a59b6830d2bacc3cab3d500

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 2.0.1 / 2022-08-20
+
+- Use ruby/debug instead of pry-byebug (2965b2e)
+- Update nokogiri-html-ext to v0.2.2 (921c486)
+- Include root items with property class names (dd14212)
+
+## 2.0.0 / 2022-08-12
+
+- Refactor implied property parsers (203fec9)
+- Add `Helpers` module (caa1c02)
+- New `PropertiesCollection` and `Property` instance methods (e9bb38b):
+  - `PropertiesCollection#plain_text_properties`
+  - `PropertiesCollection#url_properties`
+  - `Property#date_time_property?`
+  - `Property#embedded_markup_property?`
+  - `Property#plain_text_property?`
+  - `Property#url_property?`
+- Remove Addressable (66c2bb4)
+- Refactor classes to use nokogiri-html-ext (33fdf4a)
+- Update activesupport (563bf56)
+- **Breaking change:** Set minimum supported Ruby to 2.7 (ba17d05)
+- Update development Ruby to 2.7.6 (ba17d05)
+- Remove Reek (c1e76c5)
+- Update runtime dependency version constraints (f83f26a)
+- ~~**Breaking change:** Set minimum supported Ruby to 2.6~~ (fc588cd)
+- ~~Update development Ruby to 2.6.10~~ (d05a2ac)
+
+## 1.1.0 / 2021-06-10
+
+- Replace Absolutely dependency with Addressable (e93721b)
+- Add support for Ruby 3.0 (d897c54)
+- Update development Ruby version to 2.6.10 (051c9ad)
+
 ## 1.0.0 / 2020-11-08
 
 - Add `MicroMicro::Item#plain_text_properties` and `MicroMicro::Item#url_properties` methods (351e1f1)

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve MicroMicro:
 
 ## Getting Started
 
-MicroMicro is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/micromicro).
+MicroMicro is developed using Ruby 2.7.6 and is additionally tested against Ruby 3.0 and 3.1 using [GitHub Actions](https://github.com/jgarber623/micromicro/actions).
 
-Before making changes to MicroMicro, you'll want to install Ruby 2.5.8. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.5.8 using your method of choice, install the project's gems by running:
+Before making changes to MicroMicro, you'll want to install Ruby 2.7.6. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.7.6 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/README.md

@@ -1,42 +1,43 @@
 # MicroMicro
 
-**A Ruby gem for extracting [microformats2](http://microformats.org/wiki/microformats2)-encoded data from HTML documents.**
+**A Ruby gem for extracting [microformats2](https://microformats.org/wiki/microformats2)-encoded data from HTML documents.**
 
-[![Build](https://img.shields.io/travis/com/jgarber623/micromicro/master.svg?style=for-the-badge)](https://travis-ci.com/jgarber623/micromicro)
-[![Dependencies](https://img.shields.io/depfu/jgarber623/micromicro.svg?style=for-the-badge)](https://depfu.com/github/jgarber623/micromicro)
-[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/micromicro.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/micromicro)
-[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/micromicro.svg?style=for-the-badge)](https://codeclimate.com/github/jgarber623/micromicro/code)
+[![Gem](https://img.shields.io/gem/v/micromicro.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/micromicro)
+[![Downloads](https://img.shields.io/gem/dt/micromicro.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/micromicro)
+[![Build](https://img.shields.io/github/workflow/status/jgarber623/micromicro/CI?logo=github&style=for-the-badge)](https://github.com/jgarber623/micromicro/actions/workflows/ci.yml)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/micromicro.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/micromicro)
+[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/micromicro.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/micromicro/code)
 
 ## Key Features
 
-- Parses microformats2-encoded HTML documents according to the [microformats2 parsing specification](http://microformats.org/wiki/microformats2-parsing)
+- Parses microformats2-encoded HTML documents according to the [microformats2 parsing specification](https://microformats.org/wiki/microformats2-parsing)
 - Passes all microformats2 tests from [the official test suite](https://github.com/microformats/tests)¹
-- Supports Ruby 2.5 and newer
+- Supports Ruby 2.7 and newer
 
-**Note:** MicroMicro **does not** parse [Classic Microformats](http://microformats.org/wiki/Main_Page#Classic_Microformats) (referred to in [the parsing specification](http://microformats.org/wiki/microformats2-parsing#note_backward_compatibility_details) as "backcompat root classes" and "backcompat properties"). If parsing documents marked up in this fashion, consider using [the official microformats-ruby parser](https://github.com/microformats/microformats-ruby).
+**Note:** MicroMicro **does not** parse [Classic Microformats](https://microformats.org/wiki/Main_Page#Classic_Microformats) (referred to in [the parsing specification](https://microformats.org/wiki/microformats2-parsing#note_backward_compatibility_details) as "backcompat root classes" and "backcompat properties" and in vocabulary specifications in the "Parser Compatibility" sections [e.g. [h-entry](https://microformats.org/wiki/h-entry#Parser_Compatibility)]). To parse documents marked up with Classic Microformats, consider using [the official microformats-ruby parser](https://github.com/microformats/microformats-ruby).
 
 <small>¹ …with some exceptions until [this pull request](https://github.com/microformats/tests/pull/112) is merged.</small>
 
 ## Getting Started
 
-Before installing and using MicroMicro, you'll want to have [Ruby](https://www.ruby-lang.org) 2.5 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
+Before installing and using MicroMicro, you'll want to have [Ruby](https://www.ruby-lang.org) 2.7 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
 
-MicroMicro is developed using Ruby 2.5.8 and is additionally tested against Ruby 2.6 and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/micromicro).
+MicroMicro is developed using Ruby 2.7.6 and is additionally tested against Ruby 3.0 and 3.1 using [GitHub Actions](https://github.com/jgarber623/micromicro/actions).
 
 ## Installation
 
-If you're using [Bundler](https://bundler.io), add MicroMicro to your project's `Gemfile`:
+If you're using [Bundler](https://bundler.io) to manage gem dependencies, add MicroMicro to your project's Gemfile:
 
 ```ruby
-source 'https://rubygems.org'
-
 gem 'micromicro'
 ```
 
-…and hop over to your command prompt and run…
+…and run `bundle install` in your shell.
+
+To install the gem manually, run the following in your shell:
 
 ```sh
-$ bundle install
+gem install micromicro
 ```
 
 ## Usage
@@ -64,10 +65,10 @@ The `Hash` produced by calling `doc.to_h` may be converted to JSON (e.g. `doc.to
 Another example pulling the source HTML from [Tantek](https://tantek.com)'s website:
 
 ```ruby
-require "net/http"
-require "micromicro"
+require 'net/http'
+require 'micromicro'
 
-url = "https://tantek.com"
+url = 'https://tantek.com'
 rsp = Net::HTTP.get(URI.parse(url))
 
 doc = MicroMicro.parse(rsp, url)
@@ -144,11 +145,11 @@ doc.relationships.find { |relationship| relationship.rels.include?('webmention')
 
 ## Contributing
 
-Interested in helping improve MicroMicro? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/micromicro/blob/master/CONTRIBUTING.md) for details.
+Interested in helping improve MicroMicro? Awesome! Your help is greatly appreciated. See [CONTRIBUTING.md](https://github.com/jgarber623/micromicro/blob/main/CONTRIBUTING.md) for details.
 
 ## Acknowledgments
 
-MicroMicro wouldn't exist without the hard work of everyone involved in the [microformats](http://microformats.org) community. Additionally, the comprehensive [microformats test suite](https://github.com/microformats/tests) was invaluable in the development of this Ruby gem.
+MicroMicro wouldn't exist without the hard work of everyone involved in the [microformats](https://microformats.org) community. Additionally, the comprehensive [microformats test suite](https://github.com/microformats/tests) was invaluable in the development of this Ruby gem.
 
 MicroMicro is written and maintained by [Jason Garber](https://sixtwothree.org).
 

data/lib/micro_micro/collectible.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MicroMicro
   module Collectible
     attr_accessor :collection

data/lib/micro_micro/collections/base_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MicroMicro
   module Collections
     class BaseCollection
@@ -12,10 +14,14 @@ module MicroMicro
         members.each { |member| push(member) }
       end
 
+      # :nocov:
       # @return [String]
       def inspect
-        format(%(#<#{self.class.name}:%#0x count: #{count}, members: #{members.inspect}>), object_id)
+        "#<#{self.class}:#{format('%#0x', object_id)} " \
+          "count: #{count}, " \
+          "members: #{members.inspect}>"
       end
+      # :nocov:
 
       # @param member [MicroMicro::Item, MicroMicro::Property, MicroMicro::Relationship]
       def push(member)

data/lib/micro_micro/collections/items_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MicroMicro
   module Collections
     class ItemsCollection < BaseCollection
@@ -8,7 +10,7 @@ module MicroMicro
 
       # @return [Array<String>]
       def types
-        @types ||= map(&:types).flatten.uniq.sort
+        @types ||= flat_map(&:types).uniq.sort
       end
     end
   end

data/lib/micro_micro/collections/properties_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MicroMicro
   module Collections
     class PropertiesCollection < BaseCollection
@@ -6,11 +8,21 @@ module MicroMicro
         @names ||= map(&:name).uniq.sort
       end
 
+      # @return [MicroMicro::Collections::PropertiesCollection]
+      def plain_text_properties
+        self.class.new(select(&:plain_text_property?))
+      end
+
       # @return [Hash{Symbol => Array<String, Hash>}]
       def to_h
         group_by(&:name).symbolize_keys.deep_transform_values(&:value)
       end
 
+      # @return [MicroMicro::Collections::PropertiesCollection]
+      def url_properties
+        self.class.new(select(&:url_property?))
+      end
+
       # @return [Array<String, Hash>]
       def values
         @values ||= map(&:value).uniq

data/lib/micro_micro/collections/relationships_collection.rb

@@ -1,26 +1,27 @@
+# frozen_string_literal: true
+
 module MicroMicro
   module Collections
     class RelationshipsCollection < BaseCollection
-      # @see http://microformats.org/wiki/microformats2-parsing#parse_a_hyperlink_element_for_rel_microformats
-      #
-      # @return [Hash{Symbol => Hash{Symbol => Array, String}}]
-      def group_by_url
-        group_by(&:href).symbolize_keys.transform_values { |relationships| relationships.first.to_h.slice!(:href) }
-      end
-
-      # @see http://microformats.org/wiki/microformats2-parsing#parse_a_hyperlink_element_for_rel_microformats
+      # @see https://microformats.org/wiki/microformats2-parsing#parse_a_hyperlink_element_for_rel_microformats
       #
       # @return [Hash{Symbol => Array<String>}]
       def group_by_rel
-        # flat_map { |member| member.rels.map { |rel| [rel, member.href] } }.group_by(&:shift).symbolize_keys.transform_values(&:flatten).transform_values(&:uniq)
         each_with_object(Hash.new { |hash, key| hash[key] = [] }) do |member, hash|
           member.rels.each { |rel| hash[rel] << member.href }
         end.symbolize_keys.transform_values(&:uniq)
       end
 
+      # @see https://microformats.org/wiki/microformats2-parsing#parse_a_hyperlink_element_for_rel_microformats
+      #
+      # @return [Hash{Symbol => Hash{Symbol => Array, String}}]
+      def group_by_url
+        group_by(&:href).symbolize_keys.transform_values { |relationships| relationships.first.to_h.slice!(:href) }
+      end
+
       # @return [Array<String>]
       def rels
-        @rels ||= map(&:rels).flatten.uniq.sort
+        @rels ||= flat_map(&:rels).uniq.sort
       end
 
       # @return [Array<String>]

data/lib/micro_micro/document.rb

@@ -1,29 +1,7 @@
+# frozen_string_literal: true
+
 module MicroMicro
   class Document
-    # A map of HTML `srcset` attributes and their associated element names
-    #
-    # @see https://html.spec.whatwg.org/#srcset-attributes
-    # @see https://html.spec.whatwg.org/#attributes-3
-    HTML_IMAGE_CANDIDATE_STRINGS_ATTRIBUTES_MAP = {
-      'imagesrcset' => %w[link],
-      'srcset'      => %w[img source]
-    }.freeze
-
-    # A map of HTML URL attributes and their associated element names
-    #
-    # @see https://html.spec.whatwg.org/#attributes-3
-    HTML_URL_ATTRIBUTES_MAP = {
-      'action'     => %w[form],
-      'cite'       => %w[blockquote del ins q],
-      'data'       => %w[object],
-      'formaction' => %w[button input],
-      'href'       => %w[a area base link],
-      'manifest'   => %w[html],
-      'ping'       => %w[a area],
-      'poster'     => %w[video],
-      'src'        => %w[audio embed iframe img input script source track video]
-    }.freeze
-
     # Parse a string of HTML for microformats2-encoded data.
     #
     #   MicroMicro::Document.new('<a href="/" class="h-card" rel="me">Jason Garber</a>', 'https://sixtwothree.org')
@@ -38,22 +16,23 @@ module MicroMicro
     # @param markup [String] The HTML to parse for microformats2-encoded data.
     # @param base_url [String] The URL associated with markup. Used for relative URL resolution.
     def initialize(markup, base_url)
-      @markup = markup
-      @base_url = base_url
-
-      resolve_relative_urls
+      @document = Nokogiri::HTML(markup, base_url).resolve_relative_urls!
     end
 
+    # :nocov:
     # @return [String]
     def inspect
-      format(%(#<#{self.class.name}:%#0x items: #{items.inspect}, relationships: #{relationships.inspect}>), object_id)
+      "#<#{self.class}:#{format('%#0x', object_id)} " \
+        "items: #{items.inspect}, " \
+        "relationships: #{relationships.inspect}>"
     end
+    # :nocov:
 
     # A collection of items parsed from the provided markup.
     #
     # @return [MicroMicro::Collections::ItemsCollection]
     def items
-      @items ||= Collections::ItemsCollection.new(Item.items_from(document))
+      @items ||= Collections::ItemsCollection.new(Item.from_context(document.element_children))
     end
 
     # A collection of relationships parsed from the provided markup.
@@ -65,7 +44,7 @@ module MicroMicro
 
     # Return the parsed document as a Hash.
     #
-    # @see http://microformats.org/wiki/microformats2-parsing#parse_a_document_for_microformats
+    # @see https://microformats.org/wiki/microformats2-parsing#parse_a_document_for_microformats
     #
     # @return [Hash{Symbol => Array, Hash}]
     def to_h
@@ -76,76 +55,9 @@ module MicroMicro
       }
     end
 
-    # Ignore this node?
-    #
-    # @param node [Nokogiri::XML::Element]
-    # @return [Boolean]
-    def self.ignore_node?(node)
-      ignored_node_names.include?(node.name)
-    end
-
-    # A list of HTML element names the parser should ignore.
-    #
-    # @return [Array<String>]
-    def self.ignored_node_names
-      %w[script style template]
-    end
-
-    # @see http://microformats.org/wiki/microformats2-parsing#parse_an_element_for_properties
-    # @see http://microformats.org/wiki/microformats2-parsing#parsing_for_implied_properties
-    #
-    # @param context [Nokogiri::HTML::Document, Nokogiri::XML::NodeSet, Nokogiri::XML::Element]
-    # @yield [context]
-    # @return [String]
-    def self.text_content_from(context)
-      context.css(*ignored_node_names).unlink
-
-      yield(context) if block_given?
-
-      context.text.strip
-    end
-
     private
 
-    attr_reader :base_url, :markup
-
-    # @return [Nokogiri::XML::Element, nil]
-    def base_element
-      @base_element ||= Nokogiri::HTML(markup).at('//base[@href]')
-    end
-
     # @return [Nokogiri::HTML::Document]
-    def document
-      @document ||= Nokogiri::HTML(markup, resolved_base_url)
-    end
-
-    def resolve_relative_urls
-      HTML_URL_ATTRIBUTES_MAP.each do |attribute, names|
-        document.xpath(*names.map { |name| "//#{name}[@#{attribute}]" }).each do |node|
-          node[attribute] = Absolutely.to_abs(base: resolved_base_url, relative: node[attribute].strip)
-        end
-      end
-
-      HTML_IMAGE_CANDIDATE_STRINGS_ATTRIBUTES_MAP.each do |attribute, names|
-        document.xpath(*names.map { |name| "//#{name}[@#{attribute}]" }).each do |node|
-          candidates = node[attribute].split(',').map(&:strip).map { |candidate| candidate.match(/^(?<url>.+?)(?<descriptor>\s+.+)?$/) }
-
-          node[attribute] = candidates.map { |candidate| "#{Absolutely.to_abs(base: resolved_base_url, relative: candidate[:url])}#{candidate[:descriptor]}" }.join(', ')
-        end
-      end
-
-      self
-    end
-
-    # @return [String]
-    def resolved_base_url
-      @resolved_base_url ||= begin
-        if base_element
-          Absolutely.to_abs(base: base_url, relative: base_element['href'].strip)
-        else
-          base_url
-        end
-      end
-    end
+    attr_reader :document
   end
 end

data/lib/micro_micro/helpers.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module MicroMicro
+  module Helpers
+    IGNORED_NODE_NAMES = %w[script style template].freeze
+
+    # @param node [Nokogiri::XML::Element]
+    # @param attributes_map [Hash{String => Array}]
+    # @return [String, nil]
+    def self.attribute_value_from(node, attributes_map)
+      attributes_map.filter_map do |attribute, names|
+        node[attribute] if names.include?(node.name) && node[attribute]
+      end.first
+    end
+
+    # @param node [Nokogiri::XML::Element]
+    # @return [Boolean]
+    def self.ignore_node?(node)
+      IGNORED_NODE_NAMES.include?(node.name)
+    end
+
+    # @param nodes [Nokogiri::XML::NodeSet]
+    # @return [Boolean]
+    def self.ignore_nodes?(nodes)
+      (nodes.map(&:name) & IGNORED_NODE_NAMES).any?
+    end
+
+    # @param node [Nokogiri::XML::Element]
+    # @return [Boolean]
+    def self.item_node?(node)
+      root_class_names_from(node).any?
+    end
+
+    # @param nodes [Nokogiri::XML::NodeSet]
+    # @return [Boolean]
+    def self.item_nodes?(nodes)
+      nodes.filter_map { |node| item_node?(node) }.any?
+    end
+
+    # @param node [Nokogiri::XML::Element]
+    # @return [Array<String>]
+    def self.property_class_names_from(node)
+      node.classes.grep(/^(?:dt|e|p|u)(?:-[0-9a-z]+)?(?:-[a-z]+)+$/).uniq
+    end
+
+    # @param node [Nokogiri::XML::Element]
+    # @return [Boolean]
+    def self.property_node?(node)
+      property_class_names_from(node).any?
+    end
+
+    # @param node [Nokogiri::XML::Element]
+    # @return [Array<String>]
+    def self.root_class_names_from(node)
+      node.classes.grep(/^h(?:-[0-9a-z]+)?(?:-[a-z]+)+$/).uniq.sort
+    end
+
+    # @see https://microformats.org/wiki/microformats2-parsing#parse_an_element_for_properties
+    # @see https://microformats.org/wiki/microformats2-parsing#parsing_for_implied_properties
+    #
+    # @param context [Nokogiri::HTML::Document, Nokogiri::XML::NodeSet, Nokogiri::XML::Element]
+    # @yield [context]
+    # @return [String]
+    def self.text_content_from(context)
+      context.css(*IGNORED_NODE_NAMES).unlink
+
+      yield(context) if block_given?
+
+      context.text.strip
+    end
+
+    # @see https://microformats.org/wiki/value-class-pattern#Basic_Parsing
+    #
+    # @param node [Nokogiri::XML::Element]
+    # @return [Boolean]
+    def self.value_class_node?(node)
+      node.classes.include?('value')
+    end
+
+    # @see https://microformats.org/wiki/value-class-pattern#Parsing_value_from_a_title_attribute
+    #
+    # @param node [Nokogiri::XML::Element]
+    # @return [Boolean]
+    def self.value_title_node?(node)
+      node.classes.include?('value-title')
+    end
+  end
+end

data/lib/micro_micro/implied_property.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MicroMicro
   class ImpliedProperty < Property
     IMPLIED_PROPERTY_PARSERS_MAP = {