hmachine 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+vendor/
+pkg/
+doc/

data/Gemfile

@@ -0,0 +1,9 @@
+gem 'nokogiri'
+
+only :test do
+	gem 'rake'
+	gem 'contest'
+	gem 'redgreen'
+end
+
+bin_path 'vendor/bin'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Wunsch
+ 
+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

@@ -0,0 +1,21 @@
+# hMachine
+
+**Ruby microformat parser**
+
+## Warning
+
+This is so little right now. It's not even close to being done. Don't touch it until it has at least a minor version number (Right now it is v0.0.1). You've been warned.
+
+It should be:
+
++ A fully featured microformat parser, with support for every microformat
++ A CLI for fetching microformats from a url or a string of html
++ Extensions so you can do something like: `String.is_a_valid? :hcard` in your tests
++ Export microformats to other standards. hCard => vCard.
++ HTML outlininer (using HTML5 sectioning)
+
+Maybe some more than just that. It should be your lowercase-semantic-web friend.
+
+## License
+
+hMachine is licensed under the [MIT License](http://creativecommons.org/licenses/MIT/) and is Copyright (c) 2010 Mark Wunsch.

data/Rakefile

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'hmachine'
+
+require 'rake'
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+   t.libs << "test"
+   t.pattern = 'test/**/*_test.rb'
+   t.verbose = false
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "hmachine"
+    gemspec.summary = "Ruby microformat parser"
+    gemspec.description = "A Ruby microformat parser powered by Nokogiri"
+    gemspec.version = HMachine::VERSION
+    gemspec.homepage = "http://github.com/mwunsch/hmachine"
+    gemspec.authors = ["Mark Wunsch"]
+    gemspec.email = ["mark@markwunsch.com"]
+    gemspec.add_dependency 'nokogiri'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'hMachine'
+  rdoc.main     = 'README.md'
+  rdoc.rdoc_files.include('README.*', 'lib/**/*.rb', 'LICENSE')
+  rdoc.options  << '--inline-source'
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r hmachine"
+end

data/lib/hmachine/microformat/base.rb

@@ -0,0 +1,17 @@
+module HMachine
+  module Microformat
+    class Base
+            
+      def self.validate(node)
+        node['class'] == self::ROOT_CLASS
+      end
+      
+      def self.wiki_url
+        self::WIKI_URL
+      end
+      
+      attr_reader :node
+      
+    end
+  end
+end

data/lib/hmachine/microformat/hcard.rb

@@ -0,0 +1,24 @@
+module HMachine
+  module Microformat
+    class HCard < Base
+            
+      ROOT_CLASS = "vcard"
+      ROOT_SELECTOR = ".#{ROOT_CLASS}"
+      WIKI_URL = "http://microformats.org/wiki/hcard"
+      
+      def initialize(node)
+        raise "hCard not found in node" unless self.class.validate(node)
+        @node = node
+      end
+      
+      def to_vcard
+        # convert to vcard
+      end
+      
+      def self.infer_n_from_fn(fn)
+        # ...
+      end
+      
+    end
+  end
+end

data/lib/hmachine/microformat.rb

@@ -0,0 +1,30 @@
+require 'hmachine/microformat/base'
+require 'hmachine/microformat/hcard'
+
+module HMachine
+  module Microformat
+    
+    def self.find_hcard(html)
+      doc = HMachine.get_document(html)
+      find_in_node(HCard, doc)
+    end
+    
+    def self.find_all(html)
+      find_hcard html
+    end
+    
+    def self.find_in_node(microformat, node)
+      microformats = []
+      node.css(microformat::ROOT_SELECTOR).each do |node|
+        microformats << create_for_node(microformat, node) if microformat.validate(node)
+      end
+      microformats
+    end
+    
+    def self.create_for_node(microformat, node)
+      return unless microformat.validate(node)
+      microformat.new node
+    end
+    
+  end
+end

data/lib/hmachine.rb

@@ -0,0 +1,21 @@
+require 'uri'
+require 'nokogiri'
+
+require 'hmachine/microformat'
+
+module HMachine
+  VERSION = "0.0.1"
+  
+  def self.find(document)
+    html = get_document(document)
+    Microformat.find_all html
+  end
+  
+  def self.find_with_url(url)
+    # open url and call find method on resulting document
+  end
+  
+  def self.get_document(html)
+    html.is_a?(Nokogiri::XML::Node) ? html : Nokogiri::HTML.parse(html)
+  end
+end

data/test/fixtures/hcard/commercenet.html

@@ -0,0 +1,21 @@
+<!-- http://microformats.org/wiki/hcard#Live_example -->
+<div class="vcard">
+  <a class="fn org url" href="http://www.commerce.net/">CommerceNet</a>
+  <div class="adr">
+    <span class="type">Work</span>:
+    <div class="street-address">169 University Avenue</div>
+    <span class="locality">Palo Alto</span>,  
+    <abbr class="region" title="California">CA</abbr>  
+    <span class="postal-code">94301</span>
+    <div class="country-name">USA</div>
+  </div>
+  <div class="tel">
+   <span class="type">Work</span> +1-650-289-4040
+  </div>
+  <div class="tel">
+    <span class="type">Fax</span> +1-650-289-4041
+  </div>
+  <div>Email: 
+   <span class="email">info@commerce.net</span>
+  </div>
+</div>

data/test/fixtures/hcard/geo.html

@@ -0,0 +1,28 @@
+<!-- http://microformats.org/wiki/hcard-examples#GEO_parsing -->
+<div class="vcard">
+  <span class="fn n">
+     <a class="url" href="http://t37.net">
+       <span class="given-name">Fréderic</span> 
+       <span class="family-name">de Villamil</span> 
+     </a>
+  </span>
+  <span class="nickname">neuro</span>
+  <a class="email" href="mailto:neuroNOSPAM@t37.net">
+     <span class="type">pref</span><span>erred email</span>
+  </a>
+  <span class="org">Omatis</span>
+  <span class="adr">
+     <abbr class="type" title="dom">France</abbr>
+     <span class="type">home</span> address
+     <abbr class="type" title="postal">mail</abbr> and
+     <abbr class="type" title="parcel">shipments</abbr>:
+     <span class="street-address">12 rue Danton</span>
+     <span class="locality">Le Kremlin-Bicetre</span>
+     <span class="postal-code">94270</span>
+     <span class="country-name">France</span>
+  </span>
+  <span class="geo">
+     <abbr class="latitude" title="48.816667">N 48° 81.6667</abbr>
+     <abbr class="longitude" title="2.366667">E 2° 36.6667</abbr>
+  </span>
+</div>

data/test/hmachine_test.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class HMachineTest < Test::Unit::TestCase
+  setup do
+    @html = get_fixture('hcard/commercenet.html')
+  end
+  
+  test 'gets a Nokogiri doc for a string of HTML' do
+    doc = HMachine.get_document(@html)
+    assert doc.is_a?(Nokogiri::HTML::Document), "Document is a #{doc.class}"
+  end
+  
+  test 'finds the microformats in a document' do
+    microformats = HMachine.find(@html)
+    assert microformats.respond_to? :length
+  end
+end

data/test/microformat/hcard_test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class HCardTest < Test::Unit::TestCase
+  setup do
+    @html = get_fixture('hcard/commercenet.html')
+    @node = Nokogiri::HTML.parse(@html).css(HMachine::Microformat::HCard::ROOT_SELECTOR)[0]
+    @hcard = HMachine::Microformat::HCard.new(@node)
+  end
+  
+  describe 'Constants' do
+    test "hCard's root class" do
+      assert @hcard.class::ROOT_CLASS == 'vcard', "Root class is #{@hcard.class::ROOT_CLASS}"
+    end
+
+    test "hCard's root selector" do
+      assert @hcard.class::ROOT_SELECTOR == '.vcard', "Root selector is #{@hcard.class::ROOT_SELECTOR}"
+    end
+  end
+  
+  describe "Inheritance" do
+    test "hCard's wiki url" do
+      assert @hcard.class.wiki_url == @hcard.class::WIKI_URL, "Wiki url is #{@hcard.class.wiki_url}"
+    end
+    
+    test "hCard's validation" do
+      assert @hcard.class.validate(@node)
+    end
+  end
+  
+  test "rejects invalid nodes" do
+    assert_raise RuntimeError do 
+      HMachine::Microformat::HCard.new(Nokogiri::HTML.parse(@html)) 
+    end
+  end
+  
+  test 'retains original node' do
+    assert @hcard.node == @node
+  end
+  
+  
+  
+
+end

data/test/microformat_test.rb

@@ -0,0 +1,42 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class MicroformatTest < Test::Unit::TestCase
+  setup do
+    @html = get_fixture('hcard/commercenet.html')
+    @document = Nokogiri::HTML.parse(@html)
+    @hcard_class = HMachine::Microformat::HCard
+  end
+    
+  test 'creates a microformat for a given node' do
+    hcard = HMachine::Microformat.create_for_node(@hcard_class, @document.css(@hcard_class::ROOT_SELECTOR)[0])
+    assert hcard.is_a?(@hcard_class), "Created a #{hcard.class}"
+  end
+  
+  test "rejects invalid nodes" do
+    hcard = HMachine::Microformat.create_for_node(@hcard_class, @document)
+    assert hcard.nil? 
+  end
+  
+  test 'finds a given microformat in a document' do
+    first_hcard = HMachine::Microformat.find_in_node(@hcard_class, @document)[0]
+    assert first_hcard.is_a?(@hcard_class), "Object is a #{first_hcard.class}"
+  end
+  
+  test 'knows that there are multiple microformats in a document' do
+    hcards = HMachine::Microformat.find_in_node(@hcard_class, @document)
+    assert hcards.respond_to? :length
+  end
+  
+  test 'finds all the microformats in a document' do
+    microformats = HMachine::Microformat.find_all(@document)
+    assert microformats.length == 1, "Number of Microformats in document: #{microformats.length}"
+  end
+  
+  describe 'Find hCard' do    
+    test 'document contains an hCard' do
+      first_hcard = HMachine::Microformat.find_hcard(@document)[0]
+      assert first_hcard.is_a?(@hcard_class), "Object is a #{first_hcard.class}"
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), "../vendor/gems/environment")
+
+lib_path = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_path unless $LOAD_PATH.include?(lib_path)
+
+require 'contest'
+require 'redgreen'
+
+require 'hmachine'
+
+def get_fixture(filename)
+  open(File.join(File.dirname(__FILE__), 'fixtures', "#{filename}")).read
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: hmachine
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mark Wunsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A Ruby microformat parser powered by Nokogiri
+email: 
+- mark@markwunsch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/hmachine.rb
+- lib/hmachine/microformat.rb
+- lib/hmachine/microformat/base.rb
+- lib/hmachine/microformat/hcard.rb
+- test/fixtures/hcard/commercenet.html
+- test/fixtures/hcard/geo.html
+- test/hmachine_test.rb
+- test/microformat/hcard_test.rb
+- test/microformat_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mwunsch/hmachine
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby microformat parser
+test_files: 
+- test/hmachine_test.rb
+- test/microformat/hcard_test.rb
+- test/microformat_test.rb
+- test/test_helper.rb