microformats 0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+= Microformats CHANGELOG
+
+== Version 0.1
+ * Initial Implementation of Vcard
+ * Implements hCard microformat
+ * Implements Google's Person microdata http://www.data-vocabulary.org/Person/

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Powers
+
+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.rdoc

@@ -0,0 +1,95 @@
+= MICROFORMATS
+
+<em>Created by Chris Powers, September 11, 2010</em>
+
+== Two Great Tastes, One Great Library
+
+The goal of this Microformats library is to give the developer
+a series of simple view helper methods to richly markup their
+HTML documents using both the older Microformats standard and
+the new HTML5 Microdata standard.
+
+By using microformats, you are opening your data up to Google
+and other consumers for easy and intelligent consumption. In
+the future, Google plans on consuming microdata and making it
+directly searchable, which yields all sorts of new potential
+for relevant results.
+
+== Installation
+
+Install the Microformats gem as usual:
+
+  gem install microformats
+
+== Usage: Vcards
+
+You can easily markup a person and/or organization using the
+'vcard' helper method. This will use both the hCard Microformat
+and the http://www.data-vocabulary.org/Person/ microdata.
+
+<strong>PLEASE NOTE:</strong> These two microdata standards do
+not support the same fields. For example, hCard gives a person
+telephone numbers and email addresses. The Person microdata only
+gives organizations a single telephone number and has no knowledge
+of emails. It does, however, have a photo field, which is missing
+from hCard.
+
+To use it, first include the Microformats::Helper mixin into your view
+layer, like this in Rails:
+
+  module Application Helper
+    include Microformats::Helpers
+  end
+
+Then, you can do something like this in your view (using ERB here):
+
+  <% vcard do |card| %>
+    <%= card.photo "/images/me.jpg", :size => '200x300' %>
+    <%= card.name "John Doe" %>
+    <%= card.url "Visit my Site", :href => "http://mydomain.com" %>
+    <%= card.phone "999.888.7766", :type => 'Home' %>
+    <%= card.phone "111.222.3344", :type => 'Work' %>
+    <%= card.email "me@mydomain.com", :type => 'Home' %>
+
+    I work at <%= card.company "Acme Co." %>
+    <% vcard_address(:type => 'Work') do |adr| %>
+      <%= adr.street "123 Main" %>
+      <%= adr.city "Chicago" %>, <%= adr.state 'IL' %> <%= adr.zip '60010' %>
+    <% end %>
+    <%= card.download_link "http://mydomain.com" %>
+  <% end %>
+
+This will output the following markup:
+
+  <div class='vcard' itemscope='itemscope' itemtype='http://data-vocabulary.org/Person'>
+    <img itemprop='photo' src='/images/me.jpg' width='200' height='300' />
+    <span class='fn' itemprop='name'>John Doe</span>
+    <a class='url' href='http://mydomain.com' itemprop='url'>Visit my Site</a>
+    <span class='tel'><span class='type'>Home</span> 999.888.7766</span>
+    <span class='tel'><span class='type'>Work</span> 111.222.3344</span>
+    <span class='email'><span class='type'>Home</span> me@mydomain.com</span>
+
+    I work at <span class='org' itemprop='affiliation'>Acme Co.</span>
+    <div class='adr' itemscope='itemscope' itemtype='http://data-vocabulary.org/Address'>
+      <span class='type'>Work</span>
+      <span class='street-address' itemprop='street-address'>123 Main</span>
+      <span class='locality' itemprop='locality'>Chicago</span>, <span class='region' itemprop='region'>IL</span> <span class='postal-code' itemprop='postal-code'>60010</span>
+    </div>
+    <a href='http://h2vx.com/vcf/mydomain.com/page' type='text/directory'>Download vCard</a>
+  </div>
+
+While these helper methods default to using <span> tags
+(and <a> tags as appropriate), you can easily customize
+the tag used for any given piece of microdata by using the
+<tt>:tag</tt> options:
+
+  <%= card.name "John Doe", :tag => :h1 %>
+
+Also note that you get the <tt>download_link</tt> method
+that builds a link to h2vx.com that will automatically let
+the user download vCards from whatever page url you pass in.
+Usually you will just want to pass in the page that you are
+currently on, so this is a quick way to do this in Rails:
+
+  <%= card.download_link request.request_uri %>
+

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+# require 'rake/rdoctask'
+# require 'rake/gempackagetask'
+# require 'rcov/rcovtask'
+# require 'date'
+
+require 'spec/rake/spectask'
+
+desc 'Default: run the specs.'
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end

data/lib/address.rb

@@ -0,0 +1,32 @@
+class Microformats::Address
+  def street(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'street-address', :itemprop => 'street-address')
+  end
+
+  def city(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'locality', :itemprop => 'locality')
+  end
+
+  def state(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'region', :itemprop => 'region')
+  end
+
+  def zip(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'postal-code', :itemprop => 'postal-code')
+  end
+  alias_method :postal_code, :zip
+
+  def country(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'country-name', :itemprop => 'country-name')
+  end
+
+  def content_tag(tag, content, opts={})
+    attrs = opts.inject([]) do |out, tuple|
+      k,v = tuple
+      out << "#{k}='#{v}'"
+    end
+    attr_string = attrs.sort.join(' ')
+    open_tag = attr_string == '' ? tag : "#{tag} #{attr_string}"
+    "<#{open_tag}>#{content}</#{tag}>"
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,21 @@
+module Microformats::Helpers
+  # FIXME: Figure out how to make this non-Rails specific
+  # i.e. not rely on using concat
+  def vcard(&block)
+    concat "<div class='vcard' itemscope='itemscope' itemtype='http://data-vocabulary.org/Person'>\n"
+    block.call(Microformats::Vcard.new)
+    concat "</div>\n"
+  end
+
+  # FIXME: Figure out how to make this non-Rails specific
+  # i.e. not rely on using concat
+  def vcard_address(opts = {}, &block)
+    address = Microformats::Address.new
+    type = opts[:type] ? address.content_tag(:span, opts[:type], :class => 'type') : nil
+    concat "<div class='adr' itemscope='itemscope' itemtype='http://data-vocabulary.org/Address'>\n"
+    concat type if type
+    block.call(address)
+    concat "</div>\n"
+  end
+
+end

data/lib/microformats.rb

@@ -0,0 +1,7 @@
+module Microformats
+
+end
+
+require 'vcard'
+require 'address'
+require 'helpers'

data/lib/vcard.rb

@@ -0,0 +1,70 @@
+class Microformats::Vcard
+  def initialize
+    @default_tag = :span
+  end
+
+  def name(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'fn', :itemprop => 'name')
+  end
+
+  def company(str, opts = {})
+    content_tag(opts[:tag] || :span, str, :class => 'org', :itemprop => 'affiliation')
+  end
+  alias_method :organization, :company
+
+  def url(str, opts = {})
+    if opts[:href]
+      content_tag(:a, str, :href => opts[:href], :class => 'url', :itemprop => 'url')
+    elsif opts[:tag]
+      content_tag(opts[:tag], str, :class => 'url', :itemprop => 'url')
+    else
+      content_tag(:a, str, :class => 'url', :href => str, :itemprop => 'url')
+    end
+  end
+
+  def photo(str, opts = {})
+    image_tag(str, opts.merge(:itemprop => 'photo'))
+  end
+
+  def phone(str, opts = {})
+    type = opts[:type] ? content_tag(:span, opts[:type], :class => 'type') + ' ' : ''
+    content_tag(opts[:tag] || :span, type + str, :class => 'tel')
+  end
+
+  def email(str, opts = {})
+    type = opts[:type] ? content_tag(:span, opts[:type], :class => 'type') + ' ' : ''
+    if opts[:tag] == :a
+      content_tag(:a, type + str, :class => 'email', :href => "mailto:#{str}")
+    else
+      content_tag(opts[:tag] || :span, type + str, :class => 'email')
+    end
+  end
+
+  def download_link(url, opts = {})
+    str = opts.delete(:text) || "Download vCard"
+    new_url = "http://h2vx.com/vcf/" + url.gsub("http://", '')
+    content_tag(:a, str, :href => new_url, :type => 'text/directory')
+  end
+
+  def content_tag(tag, content, opts={})
+    attrs = opts.inject([]) do |out, tuple|
+      k,v = tuple
+      out << "#{k}='#{v}'"
+    end
+    attr_string = attrs.sort.join(' ')
+    open_tag = attr_string == '' ? tag : "#{tag} #{attr_string}"
+    if [:img].include?(tag)
+      "<#{open_tag} />"
+    else
+      "<#{open_tag}>#{content}</#{tag}>"
+    end
+  end
+
+  def image_tag(src, opts={})
+    if size = opts.delete(:size)
+      opts[:width], opts[:height] = size.split('x')
+    end
+    opts[:src] = src
+    content_tag(:img, nil, opts)
+  end
+end

data/spec/address_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Microformats::Address do
+  before(:each) do
+    @address = Microformats::Address.new
+  end
+  
+  describe "street" do
+    it "should wrap the string with street-address" do
+      @address.street("123 Main").should == "<span class='street-address' itemprop='street-address'>123 Main</span>"
+    end
+    
+    it "should use the given tag" do
+      @address.street("123 Main", :tag => :strong).should == "<strong class='street-address' itemprop='street-address'>123 Main</strong>"
+    end
+  end
+  
+  describe "city" do
+    it "should wrap the string with locality" do
+      @address.city("Chicago").should == "<span class='locality' itemprop='locality'>Chicago</span>"
+    end
+    
+    it "should use the given tag" do
+      @address.city("Chicago", :tag => :strong).should == "<strong class='locality' itemprop='locality'>Chicago</strong>"
+    end
+  end
+  
+  describe "state" do
+    it "should wrap the string with region" do
+      @address.state("IL").should == "<span class='region' itemprop='region'>IL</span>"
+    end
+    
+    it "should use the given tag" do
+      @address.state("IL", :tag => :strong).should == "<strong class='region' itemprop='region'>IL</strong>"
+    end
+  end
+  
+  describe "zip" do
+    it "should wrap the string with postal-code" do
+      @address.zip("60085").should == "<span class='postal-code' itemprop='postal-code'>60085</span>"
+    end
+    
+    it "should use the given tag" do
+      @address.zip("60085", :tag => :strong).should == "<strong class='postal-code' itemprop='postal-code'>60085</strong>"
+    end
+  end
+  
+  describe "country" do
+    it "should wrap the string with country-name" do
+      @address.country("USA").should == "<span class='country-name' itemprop='country-name'>USA</span>"
+    end
+    
+    it "should use the given tag" do
+      @address.country("USA", :tag => :strong).should == "<strong class='country-name' itemprop='country-name'>USA</strong>"
+    end
+  end
+end

data/spec/helpers_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Microformats::Helpers do
+  class MyTester
+    include Microformats::Helpers
+    
+    def concat(str)
+      @output ||= ''
+      @output << str
+    end
+    
+    def output
+      @output
+    end
+  end
+  
+  before(:each) do
+    @tester = MyTester.new
+  end
+  
+  describe "vcard" do
+    it "should wrap a block in a vcard div" do
+      @tester.should_receive(:do_something)
+      @tester.vcard do
+        @tester.do_something
+      end
+      @tester.output.should == "<div class='vcard' itemscope='itemscope' itemtype='http://data-vocabulary.org/Person'>\n</div>\n"
+    end
+  end
+  
+  describe "vcard_address" do
+    context "with type" do
+      it "should wrap the block in an adr div and output the type" do
+        @tester.should_receive(:do_something)
+        @tester.vcard_address :type => 'Work' do
+          @tester.do_something
+        end
+        @tester.output.should == "<div class='adr' itemscope='itemscope' itemtype='http://data-vocabulary.org/Address'>\n<span class='type'>Work</span></div>\n"
+      end
+    end
+    
+    context "without type" do
+      it "should wrap the block in an adr div" do
+        @tester.should_receive(:do_something)
+        @tester.vcard_address do
+          @tester.do_something
+        end
+        @tester.output.should == "<div class='adr' itemscope='itemscope' itemtype='http://data-vocabulary.org/Address'>\n</div>\n"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'microformats.rb')

data/spec/vcard_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Microformats::Vcard do
+  before(:each) do
+    @vcard = Microformats::Vcard.new
+  end
+  
+  describe "name" do
+    it "should wrap a string with fn class, default to span" do
+      @vcard.name("John Doe").should == "<span class='fn' itemprop='name'>John Doe</span>"
+    end
+    
+    it "should use the given tag" do
+      @vcard.name("John Doe", :tag => :strong).should == "<strong class='fn' itemprop='name'>John Doe</strong>"
+    end
+  end
+  
+  describe "company" do
+    it "should wrap a string with org class, default to span" do
+      @vcard.company("Acme Co.").should == "<span class='org' itemprop='affiliation'>Acme Co.</span>"
+    end
+    
+    it "should use the given tag" do
+      @vcard.company("Acme Co.", :tag => :strong).should == "<strong class='org' itemprop='affiliation'>Acme Co.</strong>"
+    end
+  end
+  
+  describe "url" do
+    it "should default to a tag with url class, using the URL for text and href" do
+      @vcard.url("http://google.com").should == "<a class='url' href='http://google.com' itemprop='url'>http://google.com</a>"
+    end
+    
+    it "should use given href" do
+      @vcard.url('Google', :href => "http://google.com").should == "<a class='url' href='http://google.com' itemprop='url'>Google</a>"
+    end
+    
+    it "should use given tag" do
+      @vcard.url('http://google.com', :tag => :strong).should == "<strong class='url' itemprop='url'>http://google.com</strong>"
+    end
+  end
+  
+  describe "photo" do
+    it "should create an image tag using the passed string as the src, adding itemprop photo" do
+      @vcard.photo("/images/me.png").should == "<img itemprop='photo' src='/images/me.png' />"
+    end
+    
+    it "should use :size option to set width and height" do
+      @vcard.photo("/images/me.png", :size => "200x100").should == "<img height='100' itemprop='photo' src='/images/me.png' width='200' />"
+    end
+    
+    it "should pass through options" do
+      @vcard.photo("/images/me.png", :height => 100, :width => 200).should == "<img height='100' itemprop='photo' src='/images/me.png' width='200' />"
+    end
+    
+  end
+  
+  describe "phone" do
+    it "should wrap string with a tel class" do
+      @vcard.phone('123.456.7890').should == "<span class='tel'>123.456.7890</span>"
+    end
+    
+    it "should add a type span if given" do
+      out = @vcard.phone('123.456.7890', :type => 'Work')
+      out.should == "<span class='tel'><span class='type'>Work</span> 123.456.7890</span>"
+    end
+    
+    it "should use the given tag" do
+      out = @vcard.phone('123.456.7890', :type => 'Work', :tag => :strong)
+      out.should == "<strong class='tel'><span class='type'>Work</span> 123.456.7890</strong>"
+    end
+  end
+  
+  describe "email" do
+    it "should wrap string with a email class" do
+      @vcard.email('john@doe.com').should == "<span class='email'>john@doe.com</span>"
+    end
+    
+    it "should add a type span if given" do
+      out = @vcard.email('john@doe.com', :type => 'Work')
+      out.should == "<span class='email'><span class='type'>Work</span> john@doe.com</span>"
+    end
+    
+    it "should use the given tag" do
+      out = @vcard.email('john@doe.com', :type => 'Work', :tag => :strong)
+      out.should == "<strong class='email'><span class='type'>Work</span> john@doe.com</strong>"
+    end
+    
+    it "should use mailto if using an 'a' tag" do
+      out = @vcard.email('john@doe.com', :type => 'Work', :tag => :a)
+      out.should == "<a class='email' href='mailto:john@doe.com'><span class='type'>Work</span> john@doe.com</a>"
+    end
+  end
+  
+  describe "download_link" do
+    it "should output a link to h2vx.com using the passed url" do
+      out = @vcard.download_link('mydomain.com/page')
+      out.should == "<a href='http://h2vx.com/vcf/mydomain.com/page' type='text/directory'>Download vCard</a>"
+    end
+    
+    it "should strip the protocol from a passed url" do
+      out = @vcard.download_link('http://mydomain.com/page')
+      out.should == "<a href='http://h2vx.com/vcf/mydomain.com/page' type='text/directory'>Download vCard</a>"
+    end
+    
+    it "should use :text option as text node if present" do
+      out = @vcard.download_link('mydomain.com/page', :text => "Download Me Now")
+      out.should == "<a href='http://h2vx.com/vcf/mydomain.com/page' type='text/directory'>Download Me Now</a>"
+    end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: microformats
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Chris Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-11 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: chrisjpowers@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+- Rakefile
+- lib/microformats.rb
+- lib/address.rb
+- lib/helpers.rb
+- lib/vcard.rb
+- spec/address_spec.rb
+- spec/helpers_spec.rb
+- spec/spec_helper.rb
+- spec/vcard_spec.rb
+has_rdoc: true
+homepage: http://github.com/chrisjpowers/microformats
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The Microformats gem gives you helper methods for richly marking up your HTML with microformats and HTML5 microdata.
+test_files: []
+