micromicro 2.0.1 → 3.1.0

data/lib/micro_micro/relationship.rb

@@ -4,31 +4,41 @@ module MicroMicro
   class Relationship
     include Collectible
 
+    # Extract {MicroMicro::Relationship}s from a context.
+    #
     # @param context [Nokogiri::HTML::Document, Nokogiri::XML::Element]
     # @return [Array<MicroMicro::Relationship>]
-    def self.relationships_from(context)
+    def self.from_context(context)
       context.css('[href][rel]:not([rel=""])')
              .reject { |node| Helpers.ignore_nodes?(node.ancestors) }
              .map { |node| new(node) }
     end
 
+    # Parse a node for relationship data.
+    #
     # @param node [Nokogiri::XML::Element]
+    # @return [MicroMicro::Relationship]
     def initialize(node)
       @node = node
     end
 
+    # The value of the node's +href+ attribute.
+    #
     # @return [String]
     def href
       @href ||= node['href']
     end
 
+    # The value of the node's +hreflang+ attribute, if present.
+    #
     # @return [String, nil]
     def hreflang
       @hreflang ||= node['hreflang']&.strip
     end
 
-    # :nocov:
     # @return [String]
+    #
+    # :nocov:
     def inspect
       "#<#{self.class}:#{format('%#0x', object_id)} " \
         "href: #{href.inspect}, " \
@@ -36,11 +46,15 @@ module MicroMicro
     end
     # :nocov:
 
+    # The value of the node's +media+ attribute, if present.
+    #
     # @return [String, nil]
     def media
       @media ||= node['media']&.strip
     end
 
+    # Return the parsed {MicroMicro::Relationship} as a Hash.
+    #
     # @return [Hash{Symbol => String}]
     def to_h
       {
@@ -51,24 +65,32 @@ module MicroMicro
         title: title,
         type: type,
         text: text
-      }.select { |_, value| value.present? }
+      }.compact_blank!
     end
 
+    # An Array of unique values from node's +rel+ attribute.
+    #
     # @return [Array<String>]
     def rels
       @rels ||= node['rel'].split.uniq.sort
     end
 
+    # The node's text content.
+    #
     # @return [String]
     def text
       @text ||= node.text
     end
 
+    # The value of the node's +title+ attribute, if present.
+    #
     # @return [String, nil]
     def title
       @title ||= node['title']&.strip
     end
 
+    # The value of the node's +type+ attribute, if present.
+    #
     # @return [String, nil]
     def type
       @type ||= node['type']&.strip
@@ -76,6 +98,7 @@ module MicroMicro
 
     private
 
+    # @return [Nokogiri::XML::Element]
     attr_reader :node
   end
 end

data/lib/micro_micro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MicroMicro
-  VERSION = '2.0.1'
+  VERSION = '3.1.0'
 end

data/lib/micromicro.rb

@@ -3,9 +3,9 @@
 require 'forwardable'
 
 require 'active_support/core_ext/array/grouping'
+require 'active_support/core_ext/enumerable'
 require 'active_support/core_ext/hash/deep_transform_values'
-require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/object/blank'
 require 'nokogiri'
 require 'nokogiri/html-ext'
@@ -15,6 +15,7 @@ require_relative 'micro_micro/collectible'
 require_relative 'micro_micro/helpers'
 
 require_relative 'micro_micro/parsers/date_time_parser'
+require_relative 'micro_micro/parsers/image_element_parser'
 require_relative 'micro_micro/parsers/value_class_pattern_parser'
 
 require_relative 'micro_micro/parsers/base_property_parser'
@@ -41,13 +42,14 @@ require_relative 'micro_micro/collections/relationships_collection'
 
 module MicroMicro
   # Parse a string of HTML for microformats2-encoded data.
-  # Convenience method for MicroMicro::Document.new.
   #
+  # Convenience method for {MicroMicro::Document#initialize}.
+  #
+  # @example
   #   MicroMicro.parse('<a href="/" class="h-card" rel="me">Jason Garber</a>', 'https://sixtwothree.org')
   #
-  # @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.
-  # @return [MicroMicro::Document]
+  # @param (see MicroMicro::Document#initialize)
+  # @return (see MicroMicro::Document#initialize)
   def self.parse(markup, base_url)
     Document.new(markup, base_url)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: micromicro
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -77,6 +77,7 @@ files:
 - lib/micro_micro/parsers/date_time_parser.rb
 - lib/micro_micro/parsers/date_time_property_parser.rb
 - lib/micro_micro/parsers/embedded_markup_property_parser.rb
+- lib/micro_micro/parsers/image_element_parser.rb
 - lib/micro_micro/parsers/implied_name_property_parser.rb
 - lib/micro_micro/parsers/implied_photo_property_parser.rb
 - lib/micro_micro/parsers/implied_url_property_parser.rb
@@ -93,7 +94,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/micromicro/issues
-  changelog_uri: https://github.com/jgarber623/micromicro/blob/v2.0.1/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/micromicro/blob/v3.1.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []