hmachine 0.0.1 → 0.1.0

data/.gitignore

@@ -1,3 +1,3 @@
-vendor/
 pkg/
-doc/
+doc/
+.bundle/

data/Gemfile

@@ -1,9 +1,11 @@
+source :gemcutter
+
 gem 'nokogiri'
 
-only :test do
+group :test do
 	gem 'rake'
 	gem 'contest'
 	gem 'redgreen'
-end
-
-bin_path 'vendor/bin'
+	gem 'fakeweb'
+	gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+--- 
+dependencies: 
+  fakeweb: 
+    group: 
+    - :test
+    version: ">= 0"
+  rake: 
+    group: 
+    - :test
+    version: ">= 0"
+  contest: 
+    group: 
+    - :test
+    version: ">= 0"
+  jeweler: 
+    group: 
+    - :test
+    version: ">= 0"
+  redgreen: 
+    group: 
+    - :test
+    version: ">= 0"
+  nokogiri: 
+    group: 
+    - :default
+    version: ">= 0"
+specs: 
+- nokogiri: 
+    version: 1.4.1
+- json_pure: 
+    version: 1.2.0
+- git: 
+    version: 1.2.5
+- redgreen: 
+    version: 1.2.2
+- rubyforge: 
+    version: 2.0.3
+- rake: 
+    version: 0.8.7
+- gemcutter: 
+    version: 0.3.0
+- jeweler: 
+    version: 1.4.0
+- contest: 
+    version: 0.1.2
+- fakeweb: 
+    version: 1.2.8
+hash: a411a98d29121a4b1d05b9fbe457c6e068325a09
+sources: 
+- Rubygems: 
+    uri: http://gemcutter.org

data/README.md

@@ -1,20 +1,134 @@
 # hMachine
 
-**Ruby microformat parser**
+**Ruby microformat parser and HTML toolkit**
 
-## Warning
+[RDoc](http://rdoc.info/projects/mwunsch/hmachine) | [Gem](http://rubygems.org/gems/hmachine) | [Metrics](http://getcaliper.com/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fmwunsch%2Fhmachine.git)
 
-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.
+## What hMachine is:
 
-It should be:
++ A robust microformat parser
++ A command-line tool for parsing microformats from a url or a string of markup
++ A DSL for defining semantic markup patterns
++ Export microformats to other standards:
+	+ hCard => vCard
 
-+ A fully featured microformat parser, with support for every microformat
-+ A CLI for fetching microformats from a url or a string of html
+It is your [lowercase semantic web](http://tantek.com/presentations/2004etech/realworldsemanticspres.html) friend.
+
+>Designed for humans first and machines second, microformats are a set of simple, open data formats built upon existing and widely adopted standards. Instead of throwing away what works today, microformats intend to solve simpler problems first by adapting to current behaviors and usage patterns (e.g. XHTML, blogging).
+
+Learn more about Microformats at http://microformats.org.
+
+## Usage
+
+The command line tool takes a SOURCE from the Standard Input or as an argument:
+
+	$: curl http://markwunsch.com | hmachine --hcard > ~/Desktop/me.vcf
+	
+OR
+
+	$: hmachine --hcard http://markwunsch.com > ~/Desktop/me.vcf
+
+## Installation
+
+With Ruby and Rubygems:
+
+	gem install hmachine
+	
+Or clone the repository and run `bundle install` to get the development dependencies.	
+
+#### Requirements:
+
++ [Nokogiri](http://github.com/tenderlove/nokogiri)
+
+## Microformats supported (right now, as of this very moment)
+
++ [rel-tag](http://microformats.org/wiki/rel-tag)
++ [rel-license](http://microformats.org/wiki/rel-license)
++ [VoteLinks](http://microformats.org/wiki/vote-links)
++ [XFN](http://microformats.org/wiki/XFN)
++ [XOXO](http://microformats.org/wiki/xoxo)
++ [XMDP](http://microformats.org/wiki/XMDP)
++ [geo](http://microformats.org/wiki/geo)
++ [adr](http://microformats.org/wiki/adr)
++ [hCard](http://microformats.org/wiki/hcard)
+
+More on the way.
+
+## Finding Microformats:
+	
+	# All microformats
+	HMachine.find 'http://foobar.com'
+	
+	# A specific microformat
+	HMachine.find 'http://foobar.com', :hcard
+	
+	# Search HTML too
+	HMachine.find big_string_of_html
+	
+### Parsing Microformats:
+
+	twitter_contacts = HMachine.find 'http://twitter.com/markwunsch', :hcard
+	me = twitter_contacts.first
+	me.fn
+	#=> "Mark Wunsch"
+	me.n.family_name
+	#=> "Wunsch"
+	me.url
+	#=> "http://markwunsch.com/"
+	File.open('mark.vcf','w') {|f| f.write me.to_vcard }
+	## Add me to your address book!	
+
+## POSH DSL
+
+The `HMachine` module defines a group of methods to search, validate, and extract nodes out of a Nokogiri document.
+
+All microformats inherit from `HMachine::POSH::Base`, because all microformats begin as [POSH formats](http://microformats.org/wiki/posh). If you wanted to create your own POSH format, you'd do something like this:
+
+	class Navigation < HMachine::POSH::Base
+		search {|document| document.css('ul#navigation') }
+		# Search a Nokogiri document for nodes of a certain type
+		
+		validate {|node| node.matches?('ul#navigation') }
+		# Validate that a node is the right element we want
+		
+		has_many :items do
+			search {|doc| doc.css('li') }
+		end
+		# has_many and has_one define Properties of the POSH format (HMachine::Property)
+		# Each Property object includes the HMachine module, so they can search, validate, and extract
+	end
+	
+Now you can do:
+
+	nav = Navigation.parse_first(document) 
+	# document is a Nokogiri document. 
+	# parse_first extracts just the first example of the format out of the document
+	
+	nav.items
+	# Returns an array of contents
+	# This method comes from the has_many call up above that defines the Property
+
+## Other Microformat parsers
+
++ [Mofo](http://mofo.rubyforge.org/) is a Ruby microformat parser backed by Hpricot.
++ [Sumo](http://www.danwebb.net/2007/2/9/sumo-a-generic-microformats-parser-for-javascript) is a JavaScript microformat parser.
++ [Operator](https://addons.mozilla.org/en-US/firefox/addon/4106) is a Firefox extension.
++ [hKit](http://code.google.com/p/hkit/) is a microformat parser for PHP.
++ [Oomph](http://visitmix.com/labs/oomph/) is a microformat toolkit add-in for Internet Explorer.
+	
+## Feature wishlist:
+
++ HTML outliner (using HTML5 sectioning)
 + 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)
++ Extensions to turn Ruby objects into semantic HTML. Hash.to_definition_list, Array.to_ordered_list, etc.	
+	
+## TODO:
 
-Maybe some more than just that. It should be your lowercase-semantic-web friend.
++ Handle nested microformats better (I like HMachine::Pattern::ValueClass's search implementation the best)
++ Code is ugly. Especially XOXO.
++ Better recursive parsing of trees. See above.
++ Tests are all kinds of disorganized.
++ Broader support for some of the weirder Patterns, like object[data]	
 
 ## License
 

data/Rakefile

@@ -1,6 +1,15 @@
+begin
+  # Try to require the preresolved locked set of gems.
+  require File.expand_path('../.bundle/environment', __FILE__)
+rescue LoadError
+  # Fall back on doing an unlocked resolve at runtime.
+  require "rubygems"
+  require "bundler"
+  Bundler.setup
+end
+
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
 require 'hmachine'
-
 require 'rake'
 
 task :default => :test
@@ -16,8 +25,8 @@ 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.summary = "Ruby microformat parser and HTML toolkit"
+    gemspec.description = "A Ruby microformat parser and HTML toolkit powered by Nokogiri"
     gemspec.version = HMachine::VERSION
     gemspec.homepage = "http://github.com/mwunsch/hmachine"
     gemspec.authors = ["Mark Wunsch"]

data/bin/hmachine

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+## hMachine: Microformat parser and HTML toolkit.
+##
+## Usage: hmachine [ OPTION ] [ SOURCE ]
+##
+## Find the Microformats in the given SOURCE. SOURCE can be a URL
+## or a string of HTML. If no Microformat is specified in UFORMAT,
+## hmachine will just print a list of what has been found.
+##
+## If a Microformat is specified, hmachine will convert it into a
+## more suitable format. eg. hCard becomes a vCard.
+##
+## If no SOURCE is given, hmachine will read from the Standard Input.
+##
+## Microformats:
+##    --vcard, --hcard          hCard => vCard converter
+##    --xfn                     Get XFN URLs
+##
+## Other Options:
+##    -h, --help                show this help message
+##    -v, --version             version of hMachine 
+##
+## Learn more about Microformats at http://microformats.org
+##
+##
+
+require 'optparse'
+
+def usage
+  File.readlines(__FILE__).
+  grep(/^##.*/).
+  map { |line| line.chomp[3..-1] }.
+  join("\n")
+end
+
+begin
+  require 'hmachine'
+rescue LoadError
+  $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+  require 'hmachine'
+end
+
+options = {}
+ARGV.options do |option|
+  option.banner = "Hi."
+  option.on('--hcard','--vcard') { options[:vcard] = true }
+  option.on('--xfn') { options[:xfn] = true }
+  option.on_tail('-h','--help') { puts usage ; exit }
+  option.on_tail('-v','--version') { puts HMachine::VERSION ; exit }
+  option.parse!
+end
+
+if ARGV.empty? && STDIN.tty?
+  puts usage
+  exit
+end
+
+def uformat_counts(group)
+  uf_count = HMachine::Microformat.microformats.values.collect do |uformat|
+    name = "#{uformat::FRIENDLY_NAME}"
+    found = group.select {|format| format.is_a?(uformat) }.count
+    if found > 0
+      name += "s" if found > 1
+      "Found #{found} #{name} in the document. Read more at: #{uformat::WIKI_URL}"
+    end
+  end.compact
+  if !uf_count.empty?
+    uf_count
+  else
+    puts "No microformats found in this document." ; exit
+  end
+end
+
+def parse_microformats(doc, type)
+  uformats = HMachine.find(doc, type)
+  if uformats
+    if uformats.respond_to?(:length)
+      uformats.each {|uf| yield uf if block_given? }
+    else
+      yield uformats if block_given?
+    end
+  else
+    puts "No #{type}s found in this document."
+  end
+end
+
+def input
+  ARGV.first ? ARGV.first : STDIN.read
+end
+
+if options.empty?
+  uformat_counts(HMachine.find(input)).each {|count| puts count }
+else
+  if options[:vcard]
+    parse_microformats(input, :hcard) {|hcard| puts hcard.to_vcard }
+  elsif options[:xfn]
+    parse_microformats(input, :xfn) {|xfn| puts xfn.url }
+  end
+end

data/hmachine.gemspec

@@ -0,0 +1,132 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hmachine}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Wunsch"]
+  s.date = %q{2010-02-24}
+  s.default_executable = %q{hmachine}
+  s.description = %q{A Ruby microformat parser and HTML toolkit powered by Nokogiri}
+  s.email = ["mark@markwunsch.com"]
+  s.executables = ["hmachine"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "bin/hmachine",
+     "hmachine.gemspec",
+     "lib/hmachine.rb",
+     "lib/hmachine/microformat.rb",
+     "lib/hmachine/microformat/adr.rb",
+     "lib/hmachine/microformat/geo.rb",
+     "lib/hmachine/microformat/hcard.rb",
+     "lib/hmachine/microformat/rellicense.rb",
+     "lib/hmachine/microformat/reltag.rb",
+     "lib/hmachine/microformat/votelinks.rb",
+     "lib/hmachine/microformat/xfn.rb",
+     "lib/hmachine/microformat/xmdp.rb",
+     "lib/hmachine/microformat/xoxo.rb",
+     "lib/hmachine/pattern.rb",
+     "lib/hmachine/pattern/abbr.rb",
+     "lib/hmachine/pattern/datetime.rb",
+     "lib/hmachine/pattern/typevalue.rb",
+     "lib/hmachine/pattern/url.rb",
+     "lib/hmachine/pattern/valueclass.rb",
+     "lib/hmachine/posh.rb",
+     "lib/hmachine/posh/anchor.rb",
+     "lib/hmachine/posh/base.rb",
+     "lib/hmachine/posh/definition_list.rb",
+     "test/fixtures/hcard/commercenet.html",
+     "test/fixtures/hcard/geo.html",
+     "test/fixtures/huffduffer.html",
+     "test/fixtures/likeorhate.html",
+     "test/fixtures/rel_license.html",
+     "test/fixtures/test-fixture/hcard/hcard1.html",
+     "test/fixtures/test-fixture/hcard/hcard11.html",
+     "test/fixtures/test-fixture/hcard/hcard12.html",
+     "test/fixtures/test-fixture/hcard/hcard17.html",
+     "test/fixtures/test-fixture/hcard/hcard2.html",
+     "test/fixtures/test-fixture/hcard/hcard3.html",
+     "test/fixtures/test-fixture/hcard/hcard4.html",
+     "test/fixtures/test-fixture/hcard/hcard5.html",
+     "test/fixtures/test-fixture/hcard/hcard6.html",
+     "test/fixtures/test-fixture/hcard/hcard7.html",
+     "test/fixtures/test-fixture/hcard/hcard8.html",
+     "test/fixtures/test-fixture/hcard/hcard9.html",
+     "test/fixtures/test-fixture/hcard/hcard99.html",
+     "test/fixtures/test-fixture/value-class-date-time/value-dt-test-YYYY-MM-DD--HH-MM.html",
+     "test/fixtures/test-fixture/value-class-date-time/value-dt-test-abbr-YYYY-MM-DD--HH-MM.html",
+     "test/fixtures/xfn.html",
+     "test/fixtures/xmdp.html",
+     "test/fixtures/xoxo.html",
+     "test/hmachine_test.rb",
+     "test/microformat/adr_test.rb",
+     "test/microformat/geo_test.rb",
+     "test/microformat/hcard_test.rb",
+     "test/microformat/rellicense_test.rb",
+     "test/microformat/reltag_test.rb",
+     "test/microformat/votelinks_test.rb",
+     "test/microformat/xfn_test.rb",
+     "test/microformat/xmdp_test.rb",
+     "test/microformat/xoxo_test.rb",
+     "test/microformat_test.rb",
+     "test/pattern/date_time_test.rb",
+     "test/pattern/value_class_test.rb",
+     "test/pattern_test.rb",
+     "test/posh/anchor_test.rb",
+     "test/posh/base_test.rb",
+     "test/posh/definition_list_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mwunsch/hmachine}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Ruby microformat parser and HTML toolkit}
+  s.test_files = [
+    "test/hmachine_test.rb",
+     "test/microformat/adr_test.rb",
+     "test/microformat/geo_test.rb",
+     "test/microformat/hcard_test.rb",
+     "test/microformat/rellicense_test.rb",
+     "test/microformat/reltag_test.rb",
+     "test/microformat/votelinks_test.rb",
+     "test/microformat/xfn_test.rb",
+     "test/microformat/xmdp_test.rb",
+     "test/microformat/xoxo_test.rb",
+     "test/microformat_test.rb",
+     "test/pattern/date_time_test.rb",
+     "test/pattern/value_class_test.rb",
+     "test/pattern_test.rb",
+     "test/posh/anchor_test.rb",
+     "test/posh/base_test.rb",
+     "test/posh/definition_list_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+  end
+end
+