microformats2 2.1.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c79305c5f6a1a1152ae6cbf9d545cce75f644e57
-  data.tar.gz: 8d87627f5c95c472fd7bc3c22559a07fe33aa1d6
+  metadata.gz: 7cd6cf3a5932b16cf908e76912361c306a1c9191
+  data.tar.gz: 59a40a924d3a3ee9222f344459a445bd5925aefd
 SHA512:
-  metadata.gz: '080f403c008de68fe5264e0d0ee156f20aaf0d01478405ae008aca950f269ab015a125df0f88d3c168a27ac5d174fec6bc95dfd73bfbb179ab3291a72cef55a4'
-  data.tar.gz: e896b603087505d4746b7d818b8c6831319d58bce49aa87298a6a157ccd5eb9030a77cbbfb01d742c0125506367fbc218ee498c1f7b5843a00ed6be508726a2b
+  metadata.gz: af7fd7f90d0031996b8164b934877f3168d8b6c6f348055332defd395313a332392ae5a626166911335443b78f8ded3ae4fbd40f5c1ec914d79b95d288337286
+  data.tar.gz: 12bf5d0b7122ef5d551b16ff0ee4aca635d94f92958bc65565283d2de3689ceecedfe8ad9d82c923032b4216dbaa907fd8273010e13b9d2e6df28ab913ea2934

data/README.md

@@ -38,9 +38,9 @@ Not Implemented:
 
 ## Current Version
 
-2.1.0
+2.9.0
 
-![Version 2.1.0](https://img.shields.io/badge/VERSION-2.1.0-green.svg)
+![Version 2.9.0](https://img.shields.io/badge/VERSION-2.9.0-green.svg)
 
 
 ## Requirements
@@ -80,8 +80,8 @@ source = "<div class='h-card'><p class='p-name'>Jessica Lynn Suttles</p></div>"
 collection = Microformats2.parse(source)
 # using singular accessors
 collection.card.name.to_s #=> "Jessica Lynn Suttles"
-# using plural accessors
-collection.cards.first.names.first.to_s #=> "Jessica Lynn Suttles"
+# using :all returns an array
+collection.card(:all)[0].name(:all).first.to_s #=> "Jessica Lynn Suttles"
 
 source = "<article class='h-entry'>
   <h1 class='p-name'>Microformats 2</h1>
@@ -90,7 +90,7 @@ source = "<article class='h-entry'>
 collection = Microformats2.parse(source)
 collection.entry.name.to_s #=> "Microformats 2"
 # accessing nested microformats
-collection.entry.author.format.name.to_s #=> "Jessica Lynn Suttles"
+collection.entry.author.name.to_s #=> "Jessica Lynn Suttles"
 
 # getting a copy of the canonical microformats2 hash structure
 collection.to_hash

data/lib/microformats2/collection.rb

@@ -1,6 +1,6 @@
 module Microformats2
   class Collection
-    attr_reader :all
+    attr_reader :items
 
     def initialize(element, url = nil)
       @element = element
@@ -19,30 +19,37 @@ module Microformats2
     end
 
     def parse
-      all
+      items
       parse_rels
       self
     end
 
-    def all
-      @all ||= FormatParser.parse(@element, @base).each do |format|
+    def items
+      @items ||= FormatParser.parse(@element, @base).each do |format|
         save_format_name(format.method_name)
         define_method(format.method_name)
         set_value(format.method_name, format)
       end
     end
 
+    def all
+      warn "[DEPRECATION] `all` is deprecated and will be removed in the next release.  Please use `items` instead."
+      items
+    end
+
     def first
-      all.first
+      warn "[DEPRECATION] `first` is deprecated and will be removed in the next release.  Please use `items.first` instead."
+      items.first
     end
 
     def last
-      all.last
+      warn "[DEPRECATION] `last` is deprecated and will be removed in the next release.  Please use `items.last` instead."
+      items.last
     end
 
     def to_hash
       hash = { items: [], rels: @rels }
-      all.each do |format|
+      items.each do |format|
         hash[:items] << format.to_hash
       end
       hash[:alternates] = @alternates unless @alternates.nil? || @alternates.empty?
@@ -64,10 +71,24 @@ module Microformats2
 
     def define_method(mn)
       unless respond_to?(mn)
-        self.class.class_eval { attr_accessor mn }
+        #self.class.class_eval { attr_accessor mn }
+        self.class.class_eval("
+          def #{mn}(arg = nil);
+            if arg == :all
+              @#{mn}_array
+            else
+              @#{mn}
+            end
+          end") 
+        self.class.class_eval("def #{mn}=(x); @#{mn} = x; end") 
       end
       unless respond_to?(mn.pluralize)
-        self.class.class_eval { attr_accessor mn.pluralize }
+        #self.class.class_eval { attr_accessor mn.pluralize }
+        self.class.class_eval("def #{mn.pluralize};
+          warn \"[DEPRECATION] pluralized accessors are deprecated and will be removed in the next release. Please use `#{mn}(:all)` instead.\"
+          return @#{mn}_array; end") 
+        self.class.class_eval("def #{mn.pluralize}=(x); @#{mn}_array = x; end") 
+
       end
     end
 
@@ -75,7 +96,8 @@ module Microformats2
       unless current = send(mn)
         send("#{mn}=", value)
       end
-      if current = send(mn.pluralize)
+      if current = send(mn, :all)
+        current = [current] if mn == mn.pluralize #otherwise h-news fails completely
         current << value
       else
         send("#{mn.pluralize}=", [value])

data/lib/microformats2/format.rb

@@ -7,18 +7,33 @@ module Microformats2
     def initialize(element, base)
       @element = element
       @base = base
-      @method_name = to_method_name(format_types.first)
+      @method_name = to_method_name(type.first)
       @property_names = []
+      @child_formats = []
+      @child_formats_parsed = false
     end
 
     def parse
-      format_types
+      type
       properties
       self
     end
 
+    def children
+      unless @child_formats_parsed
+        parse_child_formats
+        @child_formats_parsed = true
+      end
+      @child_formats
+    end
+
     def format_types
-      @format_types ||= @element.attribute("class").to_s.split.select do |html_class|
+      warn "[DEPRECATION] `format_types` is deprecated and will be removed in the next release.  Please use `type` instead."
+      type
+    end
+
+    def type
+      @type ||= @element.attribute("class").to_s.split.select do |html_class|
         html_class =~ Format::CLASS_REG_EXP
       end
     end
@@ -33,6 +48,12 @@ module Microformats2
       end
     end
 
+    def parse_child_formats
+      FormatParser.parse(@element.children, @base, true).each do |child_format|
+        @child_formats.push(child_format)
+      end
+    end
+
     def add_property(property_class, value)
       property = Property.new(nil, property_class, value, @base)
       assign_property(property)
@@ -55,9 +76,15 @@ module Microformats2
     end
 
     def to_hash
-      hash = { type: format_types, properties: {} }
+      hash = { type: type, properties: {} }
       @property_names.each do |method_name|
-        hash[:properties][method_name.to_sym] = send(method_name.pluralize).map(&:to_hash)
+        hash[:properties][method_name.to_sym] = send(method_name, :all).map(&:to_hash)
+      end
+      unless children.empty?
+        hash[:children] = []
+        children.each do |child_format|
+          hash[:children].push(child_format.to_hash)
+        end
       end
       hash
     end
@@ -90,10 +117,23 @@ module Microformats2
 
     def define_method(mn)
       unless respond_to?(mn)
-        self.singleton_class.class_eval { attr_accessor mn }
+        #self.singleton_class.class_eval { attr_accessor mn }
+        self.singleton_class.class_eval("
+          def #{mn}(arg = nil);
+            if arg == :all
+              @#{mn}_array
+            else
+              @#{mn}
+            end
+          end") 
+        self.singleton_class.class_eval("def #{mn}=(x); @#{mn} = x; end") 
       end
       unless respond_to?(mn.pluralize)
-        self.singleton_class.class_eval { attr_accessor mn.pluralize }
+        #self.singleton_class.class_eval { attr_accessor mn.pluralize }
+        self.singleton_class.class_eval("def #{mn.pluralize};
+          warn \"[DEPRECATION] pluralized accessors are deprecated and will be removed in the next release. Please use `#{mn}(:all)` instead.\"
+          return @#{mn}_array; end") 
+        self.singleton_class.class_eval("def #{mn.pluralize}=(x); @#{mn}_array = x; end") 
       end
     end
 
@@ -101,7 +141,7 @@ module Microformats2
       unless current = send(mn)
         send("#{mn}=", value)
       end
-      if current = send(mn.pluralize)
+      if current = send(mn,:all)
         current << value if current.respond_to? :<<
       else
         send("#{mn.pluralize}=", [value])

data/lib/microformats2/format_parser.rb

@@ -1,28 +1,30 @@
 module Microformats2
   class FormatParser
     class << self
-      def parse(element, base=nil)
+      def parse(element, base=nil, parsing_children = false)
         @@base = base
-        parse_node(element).flatten.compact
+        parse_node(element, parsing_children).flatten.compact
       end
 
-      def parse_node(node)
+      def parse_node(node, parsing_children=false)
         case
-        when node.is_a?(Nokogiri::HTML::Document) then parse_node(node.children)
-        when node.is_a?(Nokogiri::XML::NodeSet)   then parse_nodeset(node)
-        when node.is_a?(Nokogiri::XML::Element)   then [parse_for_microformats(node)]
+        when node.is_a?(Nokogiri::HTML::Document) then parse_node(node.children, parsing_children)
+        when node.is_a?(Nokogiri::XML::NodeSet)   then parse_nodeset(node, parsing_children)
+        when node.is_a?(Nokogiri::XML::Element)   then [parse_for_microformats(node, parsing_children)]
         end
       end
 
-      def parse_nodeset(nodeset)
-        nodeset.map { |node| parse_node(node) }
+      def parse_nodeset(nodeset, parsing_children=false)
+        nodeset.map { |node| parse_node(node, parsing_children) }
       end
 
-      def parse_for_microformats(element)
-        if format_classes(element).length >= 1
+      def parse_for_microformats(element, parsing_children=false)
+        if property_classes(element).length >= 1 and parsing_children
+          #do nothing because we don't want properties obj in children
+        elsif format_classes(element).length >= 1
           parse_microformat(element)
         else
-          parse_nodeset(element.children)
+          parse_nodeset(element.children, parsing_children)
         end
       end
 
@@ -35,6 +37,12 @@ module Microformats2
         klass.new(element, @@base).parse
       end
 
+      def property_classes(element)
+        element.attribute("class").to_s.split.select do |html_class|
+          html_class =~ Property::CLASS_REG_EXP
+        end
+      end
+
       def format_classes(element)
         element.attribute("class").to_s.split.select do |html_class|
           html_class =~ Format::CLASS_REG_EXP

data/lib/microformats2/property/date_time.rb

@@ -7,10 +7,10 @@ module Microformats2
       end
 
       def to_hash
-        if formats.empty?
+        if items.empty?
           to_s
         else
-          { value: to_s }.merge(formats.first.to_hash)
+          { value: to_s }.merge(items.first.to_hash)
         end
       end
 

data/lib/microformats2/property/foundation.rb

@@ -1,6 +1,10 @@
 module Microformats2
   module Property
     class Foundation
+
+      VALUE_CLASS_REG_EXP = /^(value)/
+      VALUE_TITLE_CLASS_REG_EXP = /^(value-title)/
+
       attr_reader :method_name
 
       def initialize(element, html_class, string_value=nil, base=nil)
@@ -12,7 +16,7 @@ module Microformats2
 
       def parse
         to_s
-        formats
+        items
         self
       end
 
@@ -21,18 +25,24 @@ module Microformats2
       end
 
       def format
-        formats.first
+        warn "[DEPRECATION] `format` is deprecated and will be removed in the next release.  Try just leaving this function out completely (example author.format.name.to_s => author.name.to_s).  You can also call `items.first` instead."
+        items.first
       end
 
       def formats
+        warn "[DEPRECATION] `formats` is deprecated and will be removed in the next release.  Please use `items` instead."
+        items
+      end
+
+      def items
         @formats ||= format_classes.length >=1 ? FormatParser.parse(@element, @base) : []
       end
 
       def to_hash
-        if formats.empty?
+        if items.empty?
           to_s
         else
-          { value: to_s }.merge(formats.first.to_hash)
+          { value: to_s }.merge(items.first.to_hash)
         end
       end
 
@@ -40,10 +50,45 @@ module Microformats2
         to_hash.to_json
       end
 
+      def method_missing(name, *arg, &block)
+        fmt = items.first
+        if fmt.respond_to?(name)
+          fmt.send(name)
+        else
+          super
+        end
+        
+      end
+
       protected
 
       def value_class_pattern
-        # TODO
+        result = value_parse(@element)
+        result = nil if result.empty?
+        result
+      end
+
+      def value_parse(element)
+          value_parse_node(element).flatten.compact
+      end
+
+      def value_parse_node(node)
+        case
+        when node.is_a?(Nokogiri::XML::NodeSet) then value_parse_nodeset(node)
+        when node.is_a?(Nokogiri::XML::Element) then [parse_for_value_class_pattern(node)]
+        end
+      end
+
+      def value_parse_nodeset(nodeset)
+        nodeset.map { |node| value_parse_node(node) }
+      end
+
+      def parse_for_value_class_pattern(element)
+        if value_title_classes(element).length >= 1
+            element.attribute("title").to_s.gsub(/\n+/, " ").gsub(/\s+/, " ").strip
+        elsif value_classes(element).length >= 1
+            element.inner_text.gsub(/\n+/, " ").gsub(/\s+/, " ").strip
+        end
       end
 
       def element_value
@@ -82,6 +127,17 @@ module Microformats2
           html_class =~ Format::CLASS_REG_EXP
         end
       end
+
+      def value_classes(element)
+        element.attribute("class").to_s.split.select do |html_class|
+          html_class =~ VALUE_CLASS_REG_EXP
+        end
+      end
+      def value_title_classes(element)
+        element.attribute("class").to_s.split.select do |html_class|
+          html_class =~ VALUE_TITLE_CLASS_REG_EXP
+        end
+      end
     end
   end
 end

data/lib/microformats2/property_parser.rb

@@ -20,6 +20,8 @@ module Microformats2
       def parse_for_properties(element)
         if property_classes(element).length >= 1
           parse_property(element)
+        elsif format_classes(element).length >= 1
+          #do nothing because we don't want child elements ending up with their properties here
         else
           parse_nodeset(element.children)
         end

data/lib/microformats2/version.rb

@@ -1,3 +1,3 @@
 module Microformats2
-  VERSION = "2.1.0"
+  VERSION = "2.9.0"
 end

data/microformats2.gemspec

@@ -27,4 +27,35 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rb-fsevent"
   gem.add_development_dependency "simplecov"
   gem.add_development_dependency "webmock"
+
+  gem.post_install_message = %q{
+
+  "Calling all. This is our last cry before our eternal silence."
+  - The 2.X version.
+
+  Coming VERY SOON: The 3.0 Version!
+
+  3.0 is a nearly complete re-write of the Microformats Ruby parser.
+  3.0 will fix almost all outstanding issues on the GitHub repo,
+  add classical Microformats support and more! But unfortunately,
+  the cost of doing this is that there will be some breaking changes
+  and changing API.
+
+  The 2.9 release is a transitional release. Really, we want you using 3.0,
+  but 2.9 gives you an opportunity to run your tests, fix any deprecation warnings,
+  and be able to migrate to 3.0 with greater confidence. 
+
+  In addition to deprecation warnings on changing methods,
+  there are two changes that will not throw a warning:
+
+  - no more exposed Nokogiri objects
+  - the class names are changing
+
+  If you depend on either of those directly, you'll want to do additional
+  manual acceptance testing in this transition to 2.9 and 3.0.
+
+  <3 
+
+  }
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microformats2
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Shane Becker
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -359,7 +359,19 @@ files:
 homepage: https://github.com/indieweb/microformats2-ruby
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: "\n\n  \"Calling all. This is our last cry before our eternal
+  silence.\"\n  - The 2.X version.\n\n  Coming VERY SOON: The 3.0 Version!\n\n  3.0
+  is a nearly complete re-write of the Microformats Ruby parser.\n  3.0 will fix almost
+  all outstanding issues on the GitHub repo,\n  add classical Microformats support
+  and more! But unfortunately,\n  the cost of doing this is that there will be some
+  breaking changes\n  and changing API.\n\n  The 2.9 release is a transitional release.
+  Really, we want you using 3.0,\n  but 2.9 gives you an opportunity to run your tests,
+  fix any deprecation warnings,\n  and be able to migrate to 3.0 with greater confidence.
+  \n\n  In addition to deprecation warnings on changing methods,\n  there are two
+  changes that will not throw a warning:\n\n  - no more exposed Nokogiri objects\n
+  \ - the class names are changing\n\n  If you depend on either of those directly,
+  you'll want to do additional\n  manual acceptance testing in this transition to
+  2.9 and 3.0.\n\n  <3 \n\n  "
 rdoc_options: []
 require_paths:
 - lib