microformats 0.3 → 4.0.0

data/CHANGELOG.rdoc

@@ -1,6 +0,0 @@
-= 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

@@ -1,20 +0,0 @@
-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

@@ -1,147 +0,0 @@
-= Microformats
-
-<b>STILL IN DEVELOPMENT, IT SHOULD WORK, BUT USE AT YOUR OWN RISK!</b>
-
-<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 making consumed microdata
-directly searchable, which yields all sorts of new potential
-for relevant results.
-
-== Installation
-
-Install the Microformats gem as usual:
-
-  gem install microformats
-
-== Getting Started
-
-To use Microformats, first include the Microformats::Helper
-mixin into your view layer, like this in Rails:
-
-  # in app/helpers/application_helper.rb
-  module Application Helper
-    include Microformats::Helpers
-  end
-
-== Usage: vCards and Addresses
-
-You can easily markup a person and/or organization using the
-<tt>vcard</tt> helper method. This will use both the hCard Microformat
-and the http://www.data-vocabulary.org/Person microdata.
-
-<b>PLEASE NOTE:</b> 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 support
-for email.
-
-vCards can embed addresses using the Microformats::Vcard#address
-method, which gives you a block to run with a new
-Microformats::Address object.
-
-EXAMPLE (using ERB):
-
-  <% 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." %>
-    <% card.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 class='photo' 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'><span class='value-title' title='Home'></span></span>999.888.7766</span>
-    <span class='tel'><span class='type'><span class='value-title' title='Work'></span></span> 111.222.3344</span>
-    <a class='email' href='mailto:me@mydomain.com'><span class='value-title' title='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'><span class='value-title' title='Work'></span></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> option:
-
-  <%= 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 %>
-
-== Usage: Calendars and Events
-
-Calendars with many events can be represented using the
-Microformats::Calendar and Microformats::Event classes.
-This employs the hCal and hEvent microformats along with the
-http://www.data-vocabulary.org/Event microdata.
-
-<b>NOTE:</b> An Event can use a nested vCard to represent
-its location information.
-
-EXAMPLE:
-
-  <% vcalendar :id => "my_calendar" do |cal| %>
-    <h1>Upcoming Events</h1>
-    <% cal.event do |event| %>
-      <h2><%= event.url(event.name("Happy Hour"), :href => "http://meetup.com/happyhour") %></h2>
-      <%= event.photo "/images/happy_hour.jpg", :size => "250x150" %>
-      <%= event.description "Come hang out with us for half price drinks at lots of fun!" %>
-      <span class='time_range'>
-        From <%= event.starts_at "October 30, 2010 at 7:30PM" %> -
-        <%= event.ends_at "October 30, 2010 at 10:00PM", :text => "10:00PM" %>
-      </span>
-      <% event.location do |card| %>
-        <%= card.url(card.company("Frank's Bar", :is_company => true), :href => "http://franksbar.com") %>
-        <% card.address do |adr| %>
-          <%= adr.street "784 N Main St" %><br />
-          <%= adr.city "Chicago" %>, <%= adr.state "IL" %> <%= adr.zip "60016" %>
-        <% end %>
-      <% end %>
-    <% end %>
-    <!-- More events could be added... -->
-  <% end %>
-
-== Resources
-
-* http://www.data-vocabulary.org
-* http://microformats.org
-
-== Care to Help?
-
-There are still a lot of standards that need to be implemented into
-this library, including but not limited to: Events, Products, Reviews,
-Organizations. I will continue to work on these, but I'd be happy to
-accept pull requests!

data/lib/address.rb

@@ -1,97 +0,0 @@
-class Microformats::Address
-  include Microformats::FormattingHelpers
-
-  def initialize(template)
-    @template = template
-    @default_tag = :span
-  end
-
-  # You can directly initialize and run this class, but it's easier
-  # to use the Microformats::Helpers#vaddress helper method or the
-  # Microformats::Vcard#address method.
-  #
-  # OPTIONS:
-  # * :type - A string that specifies the type of address('home', 'work', etc)
-  # * :tag - The HTML wrapper element (defaults to :div)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def run(opts = {}, &block)
-    type = opts[:type] ? self.type(opts.delete(:type)) : nil
-    opts[:class] = combine_class_names('adr', opts[:class])
-    opts[:itemscope] = 'itemscope'
-    opts[:itemtype] = 'http://data-vocabulary.org/Address'
-    opts[:tag] ||= :div
-    concat_tag(opts) do
-      concat type if type
-      block.call(self)
-    end
-  end
-
-  # Outputs markup for the type of address ('work', 'home', etc.)
-  # There will be no visible text unless provided with the :text option.
-  #
-  # <em>NOTE: You get this for free with the :type option of
-  # Microformats::Helpers#vaddress, Microformats::Vcard#address and #run methods.</em>
-  #
-  # OPTIONS
-  # * :text - String, the text you want displayed as a text node (default is '')
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def type(str, opts = {})
-    inner = content_tag('', :class => 'value-title', :title => str)
-    text = opts.delete(:text) || ''
-    content_tag(inner + text, merge_html_attrs({:class => 'type'}, opts))
-  end
-
-  # Outputs the passed string as a street address.
-  #
-  # OPTIONS
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def street(str, opts = {})
-    content_tag(str, merge_html_attrs({:class => 'street-address', :itemprop => 'street-address'}, opts))
-  end
-
-  # Outputs the passed string as a city.
-  #
-  # OPTIONS
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def city(str, opts = {})
-    content_tag(str, merge_html_attrs({:class => 'locality', :itemprop => 'locality'}, opts))
-  end
-
-  # Outputs the passed string as a state.
-  #
-  # OPTIONS
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def state(str, opts = {})
-    content_tag(str, merge_html_attrs({:class => 'region', :itemprop => 'region'}, opts))
-  end
-
-  # Outputs the passed string as a postal code.
-  #
-  # OPTIONS
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def zip(str, opts = {})
-    content_tag(str, merge_html_attrs({:class => 'postal-code', :itemprop => 'postal-code'}, opts))
-  end
-  alias_method :postal_code, :zip
-
-  # Outputs the passed string as a country.
-  #
-  # OPTIONS
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def country(str, opts = {})
-    content_tag(str, merge_html_attrs({:class => 'country-name', :itemprop => 'country-name'}, opts))
-  end
-
-end

data/lib/calendar.rb

@@ -1,40 +0,0 @@
-class Microformats::Calendar
-  include Microformats::FormattingHelpers
-
-  def initialize(template)
-    @template = template
-    @default_tag = :span
-  end
-
-  # You can directly initialize and run this class, but it's easier
-  # to use the Microformats::Helpers#vcalendar helper method.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :div)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def run(opts = {}, &block)
-    opts[:class] = combine_class_names('vcalendar', opts[:class])
-    opts[:tag] ||= :div
-    concat_tag(opts) do
-      block.call(self)
-    end
-  end
-
-  # Creates a vEvent with the given options and a block.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :div)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  # EXAMPLE:
-  #   <% calendar.event :id => 'my_event' do |event| %>
-  #     This event is called <%= event.name "Cool Event" %>.
-  #   <% end %>
-  #
-  def event(opts = {}, &block)
-    ev = Microformats::Event.new(@template)
-    opts[:class] = combine_class_names('vevent', opts[:class])
-    ev.run(opts, &block)
-  end
-end

data/lib/event.rb

@@ -1,156 +0,0 @@
-class Microformats::Event
-  include Microformats::FormattingHelpers
-
-  def initialize(template)
-    @template = template
-    @default_tag = :span
-  end
-
-  # You can directly initialize and run this class, but it's easier
-  # to use the Microformats::Helpers#vevent helper method or the
-  # Microformats::Calendar#event method.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :div)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def run(opts = {}, &block)
-    opts[:class] = combine_class_names('vevent', opts[:class])
-    opts[:itemscope] = 'itemscope'
-    opts[:itemtype] = 'http://data-vocabulary.org/Event'
-    opts[:tag] ||= :div
-    concat_tag(opts) do
-      block.call(self)
-    end
-  end
-
-  # Marks up an event's name.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def name(str, opts={})
-    content_tag(str, merge_html_attrs({:itemprop => 'summary', :class => 'summary'}, opts))
-  end
-
-  # Marks up the event's URL. By default, it will output an <a> tag using
-  # the passed in string as both the href and the text. If the :href option
-  # is passed, then the string argument is treated as text.
-  #
-  # OPTIONS:
-  # * :href - If passed, the string argument will be treated as the text node.
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  # EXAMPLES:
-  #   event.url('http://google.com') #=> <a class='url' href='http://google.com' itemprop='url'>http://google.com</a>
-  #   event.url('Google', :href => 'http://google.com') #=> <a class='url' href='http://google.com' itemprop='url'>Google</a>
-  #   event.url('http://google.com', :tag => :span) #=> <span class='url' itemprop='url'>http://google.com</span>
-  #
-  def url(str, opts = {})
-    if opts[:href]
-      content_tag(str, merge_html_attrs({:tag => :a, :class => 'url', :itemprop => 'url'}, opts))
-    elsif opts[:tag]
-      content_tag(str, merge_html_attrs({:class => 'url', :itemprop => 'url'}, opts))
-    else
-      content_tag(str, merge_html_attrs({:tag => :a, :class => 'url', :href => str, :itemprop => 'url'}, opts))
-    end
-  end
-
-  # Marks up the event photo as an <img> tag. Takes the image URL as the first argument.
-  #
-  # OPTIONS
-  # * :size - Pass a string with WIDTHxHEIGHT like "200x100" in lieu of the :width and :height options.
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def photo(str, opts = {})
-    if size = opts.delete(:size)
-      opts[:width], opts[:height] = size.split('x')
-    end
-    content_tag(nil, merge_html_attrs({:tag => :img, :class => 'photo', :itemprop => 'photo', :src => str}, opts))
-  end
-
-  # Marks up an event's description.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def description(str, opts={})
-    content_tag(str, merge_html_attrs({:itemprop => 'description', :class => 'description'}, opts))
-  end
-
-  # Marks up the event's start time/date. Accepts either a Time object
-  # or a time String as the first argument. By default, the text node
-  # will be the date and time output like "Oct 20, 2010 at 7:30PM", but
-  # this can be overridden by the :text option.
-  #
-  # OPTIONS:
-  # * :text - String, will be displayed as the text node.
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def starts_at(time_or_str, opts={})
-    if time_or_str.is_a?(String)
-      time = Time.parse(time_or_str)
-      encoded_time = encode_time(time)
-      humanized_time = opts.delete(:text) || time_or_str
-    else
-      encoded_time = encode_time(time_or_str)
-      humanized_time = opts.delete(:text) || humanize_time(time_or_str)
-    end
-    inner_span = content_tag('', :class => 'value-title', :title => encoded_time)
-    content_tag(inner_span + humanized_time, merge_html_attrs({:tag => :time, :itemprop => 'startDate', :class => 'dtstart', :datetime => encoded_time}, opts))
-  end
-
-  # Marks up the event's end time/date. Accepts either a Time object
-  # or a time String as the first argument. By default, the text node
-  # will be the date and time output like "Oct 20, 2010 at 7:30PM", but
-  # this can be overridden by the :text option.
-  #
-  # OPTIONS:
-  # * :text - String, will be displayed as the text node.
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def ends_at(time_or_str, opts={})
-    if time_or_str.is_a?(String)
-      time = Time.parse(time_or_str)
-      encoded_time = encode_time(time)
-      humanized_time = opts.delete(:text) || time_or_str
-    else
-      encoded_time = encode_time(time_or_str)
-      humanized_time = opts.delete(:text) || humanize_time(time_or_str)
-    end
-    inner_span = content_tag('', :class => 'value-title', :title => encoded_time)
-    content_tag(inner_span + humanized_time, merge_html_attrs({:tag => :time, :itemprop => 'endDate', :class => 'dtend', :datetime => encoded_time}, opts))
-  end
-
-  # Marks up an event's category name.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :span)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  def category(str, opts = {})
-    content_tag(str, merge_html_attrs({:itemprop => 'eventType', :class => 'category'}, opts))
-  end
-
-  # Creates a vCard with the given options and a block to represent
-  # the event's location.
-  #
-  # OPTIONS:
-  # * :tag - The HTML wrapper element (defaults to :div)
-  # * Any other passed options will be treated as HTML attributes.
-  #
-  # EXAMPLE:
-  #   <% event.location :id => 'my_location' do |card| %>
-  #     We will be meeting at the <%= card.company "Obtiva" %> office.
-  #   <% end %>
-  #
-  def location(opts = {}, &block)
-    card = Microformats::Vcard.new(@template)
-    opts[:class] = combine_class_names('location', opts[:class])
-    card.run(opts, &block)
-  end
-
-end