microformats2 1.0.2 → 2.0.0.pre1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in microformats2.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard "rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 G5
+
+MIT License
+
+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

@@ -1,43 +1,134 @@
-# Microformats
+# Microformats2
 
-http://github.com/veganstraightedge/microformats2
+[![Build Status](https://travis-ci.org/G5/microformats2.png?branch=master)](https://travis-ci.org/G5/microformats2)
+[![Code Climate](https://codeclimate.com/github/G5/microformats2.png)](https://codeclimate.com/github/G5/microformats2)
 
-## DESCRIPTION
+A Ruby gem to parse HTML containing one or more [microformats2](http://microformats.org/wiki/microformats-2)
+and return a collection of dynamically defined Ruby objects.
 
-Generic Microformats 2 Extractor
+A work in progress.
 
-## FEATURES/PROBLEMS
+Implemented:
 
-* parses and extracts [Microformats 2](http://microformats.org/wiki/microformats-2) syntax
-* needs more test cases
-* needs better docs
-* needs to deal with nested microformats
-* needs to deal with class-value pattern
+* [parsing depth first, doc order](parse_a_document_for_microformats)
+* [parsing a p- property](http://microformats.org/wiki/microformats2-parsing#parsing_a_p-_property)
+* [parsing a u- property](http://microformats.org/wiki/microformats2-parsing#parsing_a_u-_property)
+* [parsing a dt- property](http://microformats.org/wiki/microformats2-parsing#parsing_a_dt-_property)
+* [parsing a e- property](http://microformats.org/wiki/microformats2-parsing#parsing_a_e-_property)
+* [parsing implied properties](http://microformats.org/wiki/microformats-2-parsing#parsing_for_implied_properties)
+* nested properties
+* nested microformat with associated property
 
-## SYNOPSIS
+Not Implemented:
 
-    Microformats2.parse(File.open("example.html"))
+* [normalize u-* property values](http://microformats.org/wiki/microformats2-parsing-faq#normalizing_u-.2A_property_values)
+* nested microformat without associated property
+* [rel](http://microformats.org/wiki/rel)
+* [value-class-pattern](http://microformats.org/wiki/value-class-pattern)
+* [include-pattern](http://microformats.org/wiki/include-pattern)
+* recognition of [vendor extensions](http://microformats.org/wiki/microformats2#VENDOR_EXTENSIONS)
+* backwards compatable support for microformats v1
 
-## REQUIREMENTS
 
-* Hoe
-* Nokogiri
+## Current Version
 
-## INSTALL
+2.0.0.pre1
 
-    sudo gem install microformats2
 
-## DEVELOPERS
+## Requirements
 
-After checking out the source, run:
+* "nokogiri", "~> 1.5.6"
+* "json", "~> 1.7.6"
+* "activesupport", "~> 3.2.12"
 
-    rake newb
 
-This task will install any missing dependencies,
-run the tests/specs, and generate the RDoc.
+## Installation
 
-## LICENSE
+Add this line to your application's Gemfile:
 
-**PUBLIC DOMAIN.**
-Your heart is as free as the air you breathe.
-The ground you stand on is liberated territory.
+    gem 'microformats2'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install microformats2
+
+
+## Usage
+
+```ruby
+require "microformats2"
+
+source = '<div class="h-card"><p class="p-name">Jessica Lynn Suttles</p></div>'
+collection = Microformats.parse(source)
+collection.cards.first.names.first.to_s #=> "Jessica Lynn Suttles"
+collection.card.name.to_s #=> "Jessica Lynn Suttles"
+```
+
+* `source` can be a URL, filepath, or HTML
+
+## Authors
+
+* Jessica Lynn Suttles / [@jlsuttles](https://github.com/jlsuttles)
+
+
+## Contributions
+
+1. Fork it
+2. Get it running (see Installation above)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Write your code and **specs**
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+If you find bugs, have feature requests or questions, please
+[file an issue](https://github.com/G5/microformats2/issues).
+
+
+## Specs
+
+To update spec cases that are scraped from other sites.
+**Warning:** This could break specs.
+```bash
+rake specs:update
+```
+
+To run specs
+```bash
+rake spec
+```
+
+To keep specs running
+```bash
+guard
+```
+
+
+## License
+
+Copyright (c) 2013 G5
+
+MIT License
+
+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/Rakefile

@@ -1,13 +1,69 @@
-# -*- ruby -*-
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "nokogiri"
+require "open-uri"
+require "pp"
 
-require 'rubygems'
-require 'hoe'
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]
 
-Hoe.spec 'microformats2' do
-  developer('Shane Becker', 'veganstraightedge@gmail.com')
-  extra_deps << ['nokogiri', ">= 0"]
-  self.readme_file = "README.md"
-end
+namespace :specs do
+  task :update do
+    sources = [
+      { dir: "microformats.org",
+        urls: ["http://microformats.org/wiki/microformats-2"],
+        html_selector: ".source-html4strict",
+        json_selector: ".source-javascript",
+        html_method: "inner_text"
+      },
+      { dir: "microformat2-node.jit.su",
+        urls: [
+          "http://microformat2-node.jit.su/h-adr.html",
+          "http://microformat2-node.jit.su/h-card.html",
+          "http://microformat2-node.jit.su/h-entry.html",
+          "http://microformat2-node.jit.su/h-event.html",
+          "http://microformat2-node.jit.su/h-geo.html",
+          "http://microformat2-node.jit.su/h-news.html",
+          "http://microformat2-node.jit.su/h-org.html",
+          "http://microformat2-node.jit.su/h-product.html",
+          "http://microformat2-node.jit.su/h-recipe.html",
+          "http://microformat2-node.jit.su/h-resume.html",
+          "http://microformat2-node.jit.su/h-review-aggregate.html",
+          "http://microformat2-node.jit.su/h-review.html",
+          "http://microformat2-node.jit.su/rel.html",
+          "http://microformat2-node.jit.su/includes.html",
+        ],
+        html_selector: ".e-x-microformat",
+        json_selector: ".language-json",
+        html_method: "inner_html"
+      }
+    ]
+
+    sources.each do |source|
+      source[:urls].each do |url|
+        document = Nokogiri::HTML(open(url).read)
+        html = document.css(source[:html_selector]).map { |e| e.send(source[:html_method]) }
+        json = document.css(source[:json_selector]).map { |e| e.inner_text }
+
+        name = url.split("/").last.gsub(/[.]\w+/, "")
+        path = File.join "spec/support/cases", source[:dir], name
+
+        FileUtils.mkdir_p(path)
 
+        ([html.length, json.length].min).times do |index|
 
-# vim: syntax=ruby
+          File.open(File.join(path, "#{name}-#{index}.html"), "w") do |f|
+            f.write "<!-- #{url} -->\n"
+            f.write html[index]
+          end
+
+          File.open(File.join(path, "#{name}-#{index}.js"), "w") do |f|
+            f.write "// #{url}\n"
+            f.write json[index]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/microformats2.rb

@@ -1,121 +1,36 @@
-require 'nokogiri'
-require 'time'
-require 'date'
+require "nokogiri"
+require "open-uri"
+require "json"
+require "active_support/inflector"
+
+require "microformats2/version"
+require "microformats2/format_parser"
+require "microformats2/property_parser"
+require "microformats2/collection"
+require "microformats2/format"
+require "microformats2/property/foundation"
+require "microformats2/property/text"
+require "microformats2/property/url"
+require "microformats2/property/date_time"
+require "microformats2/property/embedded"
+require "microformats2/property"
+require "microformats2/implied_property/foundation"
+require "microformats2/implied_property/name"
+require "microformats2/implied_property/photo"
+require "microformats2/implied_property/url"
 
 module Microformats2
-  VERSION = "1.0.2"
-
-  class LoadError < StandardError; end
-
-  def self.parse(html)
-    raise LoadError, "argument must be a String or File" unless [String, File].include?(html.class)
-
-    html = html.read if IO === html
-
-    doc = Nokogiri::HTML(html)
-    microformats = Hash.new{|hash, key| hash[key] = Array.new}
-    doc.css("*[class*=h-]").each do |microformat|
-      microformat.attribute("class").to_s.split.each do |mf_class|
-        if mf_class =~ /^h-/
-          constant_name = mf_class.gsub("-","_").gsub(/^([a-z])/){$1.upcase}.gsub(/_(.)/) { $1.upcase }
-
-          if Object.const_defined?(constant_name)
-            klass = Object.const_get(constant_name)
-          else
-            klass = Class.new
-            Object.const_set constant_name, klass
-          end
-
-          obj = klass.new
-
-          add_properties(microformat, obj)
-
-          microformats[constant_name.downcase.to_sym] << obj
-        end
-      end
-    end
-
-    microformats
-  end
-
-  def self.add_method(obj, method_name)
-    unless obj.respond_to?(method_name)
-      obj.class.class_eval { attr_accessor method_name }
+  class << self
+    def parse(html)
+      html = read_html(html)
+      document = Nokogiri::HTML(html)
+      Collection.new(document).parse
     end
 
-    obj
-  end
-
-  def self.populate_method(obj, method_name, value)
-    if cur = obj.send(method_name)
-      if cur.kind_of? Array
-        cur << value
-      else
-        obj.send("#{method_name}=", [cur, value])
-      end
-    else
-      obj.send("#{method_name}=", value)
-    end
-  end
-
-  class Stripper
-    def transform(property)
-      property.text.gsub(/\n+/, " ").gsub(/\s+/, " ").strip
-    end
-  end
-
-  class URL
-    def transform(property)
-      (property.attribute("href") || property.text).to_s
-    end
-  end
-
-  class Date
-    def transform(property)
-      value = (property.attribute("title") || property.text).to_s
-
-      if value[0..0] =~ /[a-zA-Z]/
-        value
-      else
-        DateTime.parse(value)
-      end
-    end
-  end
-
-  class TimeThingy
-    def transform(property)
-      Time.parse((property.attribute("title") || property.text).to_s)
-    end
-  end
-
-  FormatClass = {
-    "p" => Stripper.new,
-    "n" => Stripper.new,
-    "e" => Stripper.new,
-    "i" => Stripper.new,
-    "u" => URL.new,
-    "d" => Date.new,
-    "t" => TimeThingy.new
-  }
-
-  def self.add_properties(mf, obj)
-    FormatClass.each do |letter, trans|
-      mf.css("*[class*=#{letter}-]").each do |property|
-        property.attribute("class").to_s.split.each do |css_class|
-          if css_class[0..1] == "#{letter}-"
-            css_class   = css_class[2..-1].gsub("-","_")
-            method_name = css_class.gsub("-","_")
-            value       = trans.transform(property)
-            
-            if method_name == "class"
-              method_name = "klass"
-            end
-
-            add_method(obj, method_name)
-            populate_method(obj, method_name, value)
-          end
-        end
-      end
+    def read_html(html)
+      open(html).read
+    rescue Errno::ENOENT, Errno::ENAMETOOLONG => e
+      html
     end
-  end
+  end # class << self
 end