html-schema 0.2.0

data/lib/html-schema/microdata/attribute.rb

@@ -0,0 +1,9 @@
+class HTMLSchema
+  class Microdata
+    class Attribute < HTMLSchema::Attribute
+      def to_hash
+        {:itemprop => classes.join(" ")}
+      end
+    end
+  end
+end

data/lib/html-schema/microdata/object.rb

@@ -0,0 +1,13 @@
+class HTMLSchema
+  class Microdata
+    class Object < HTMLSchema::Object
+      def schema_url
+        @schema_url ||= "http://schema.org/#{as.to_s.camelize}"
+      end
+      
+      def to_hash
+        {:itemscope => "itemscope", :itemtype => schema_url}
+      end
+    end
+  end
+end

data/lib/html-schema/microformat.rb

@@ -0,0 +1,218 @@
+class HTMLSchema
+  class Microformat
+    extend HTMLSchema::DSL
+    
+    type :object do 
+      attribute :name 
+      attribute :title
+      attribute :url
+      attribute :description
+      attribute :image
+      
+      type :address, :as => :adr do
+        #adr type: INTL, POSTAL, PARCEL, WORK, dom, home, pref
+        #tel type: VOICE, home, msg, work, pref, fax, cell, video, pager, bbs, modem, car, isdn, pcs
+        #email type: INTERNET, x400, pref
+        
+        attribute :street, :as => :"street-address"
+        attribute :suite, :as => :"extended-address"
+        attribute :city, :as => :locality
+        attribute :state, :as => :region
+        attribute :postal_code, :as => :"postal-code"
+        attribute :post_office_box, :as => :"post-office-box"
+        attribute :country, :as => :"country-name"
+      end
+      
+      type :composition, :as => :hentry do
+        attribute :feed, :as => :hfeed
+        attribute :title, :as => :"entry-title", :required => true
+        attribute :body, :as => :"entry-content"
+        attribute :description, :as => :"entry-summary"
+        attribute :updated_at, :as => :updated, :type => :date, :required => true
+        attribute :published_at, :as => :published, :type => :date
+        attribute :author, :type => :person, :required => true
+        attribute :bookmark
+        attribute :tag, :rel => :tag
+        
+        type :article do #, :as => :hnews
+          attribute :organization, :as => :"source-org", :type => :organization
+          attribute :location, :as => :"dateline", :type => :place
+          attribute :coordinates, :as => :geo, :type => :coordinates
+          attribute :license, :as => :"item-license"
+        end
+      end
+
+      type :event, :as => :vevent do
+        attribute :feed, :as => :vcalendar
+        attribute :description, :as => :summary
+        attribute :start_date, :as => :dtstart, :type => :date
+        attribute :end_date, :as => :dtend, :type => :date # ISO date
+        attribute :location, :as => :location, :type => :address
+        attribute :url
+        attribute :rdate
+        attribute :rrule
+        attribute :category
+        attribute :description
+        attribute :uid
+        attribute :coordinates, :as => :geo, :type => :coordinates
+        attribute :attendee, :type => :person
+        attribute :contact, :type => :person
+        attribute :organizer, :type => :person
+        attribute :image, :as => :attach, :type => :image
+        attribute :status
+      end
+
+      type :license, :as => :item do
+        attribute :link, :as => :"item-license"
+        attribute :url, :as => :"item-url"
+        attribute :author, :as => :attribution, :type => :person
+        attribute :organization, :as => :attribution, :type => :organization
+      end
+
+      type :measurement, :as => :hmeasure do
+        type :angle, :as => :hangle
+        type :money, :as => :hmoney
+
+        attribute :value, :as => :num
+        attribute :unit
+        attribute :item # (text | hCard | hCalendar)
+        # attribute :type, :as => type ? (text, e.g. "height", "width", "weight")
+      end
+
+      type :media, :as => :hmedia do
+        # http://weborganics.co.uk/ns/2009/09/media/0.1/
+        attribute :name, :as => :fn
+        attribute :author, :as => :contributor, :type => :person
+        attribute :url, :as => :photo
+        attribute :player
+        attribute :link, :as => :enclosure # download
+        attribute :duration
+        
+        type :audio
+        type :image
+        type :video
+      end
+
+      type :offer, :as => :hlisting do
+        attribute :version
+        attribute :action # class == sell | rent | trade | meet | announce | offer | wanted | event | service
+        attribute :lister, :type => :person, :required => true
+        attribute :published_at, :as => :dtlisted, :type => :date
+        attribute :expires_at, :as => :dtexpired, :type => :date
+        attribute :price
+        attribute :item, :type => :article
+        # <span class="item"><span class="fn">Parking space</span></span>, :required => true
+        # <span class="tel"><span class="type">home</span><span class="value">14981948194</span></span>
+        attribute :description
+        attribute :tag
+        attribute :link, :as => :permalink
+      end
+
+      type :person, :as => :vcard do
+        attribute :name, :as => :fn
+        attribute :address, :as => :adr, :type => :address
+        attribute :agent
+        attribute :birthday, :as => :bday
+        attribute :category
+        attribute :class
+        attribute :email
+        attribute :coordinates, :as => :geo, :type => :coordinates
+        attribute :key
+        attribute :label
+        attribute :logo
+        attribute :mailer
+        attribute :nickname
+        attribute :note
+        attribute :organization, :as => :org, :type => :organization
+        attribute :photo
+        attribute :rev
+        attribute :role
+        attribute :"sort-string"
+        attribute :sound
+        attribute :tel
+        attribute :job_title, :as => :title
+        attribute :tz
+        attribute :uid
+        attribute :url
+
+        type :author, :rel => :author
+        type :acquaintance, :rel => :acquaintance
+        type :child, :rel => :child
+        type :colleague, :rel => :colleague
+        type :contact, :rel => :contact
+        type :roommate, :rel => :"co-resident"
+        type :coworker, :rel => :"co-worker"
+        type :crush, :rel => :crush
+        type :date, :rel => :date
+        type :editor, :rel => :editor
+        type :fan, :rel => :fan
+        type :friend, :rel => :friend
+        type :kin, :rel => :kin
+        type :me, :rel => :me
+        type :met, :rel => :met
+        type :muse, :rel => :muse
+        type :neighbor, :rel => :neighbor
+        type :sibling, :rel => :sibling
+        type :spouse, :rel => :spouse
+        type :sweetheart, :rel => :sweetheart
+        type :member, :rel => :member
+        type :sponsor, :rel => :sponsor
+        type :user, :rel => :user
+      end
+
+      type :organization, :as => :org do
+        attribute :name, :as => :"organization-name"
+        attribute :unit, :as => :"organization-unit"
+      end
+
+      type :product, :as => :hProduct do
+        attribute :brand, :as => :organization
+        attribute :category
+        attribute :price
+        attribute :description
+        attribute :name, :as => :fn
+        attribute :image, :as => :photo
+        attribute :url
+        attribute :review, :type => :review
+        attribute :listing, :type => :offer
+        attribute :uid, :as => :identifier
+      end
+
+      type :rating do
+        attribute :best
+        attribute :worst
+        attribute :value
+      end
+
+      type :resume, :as => :hresume do
+        attribute :description, :as => :summary
+        attribute :contact, :type => :person
+        attribute :education, :type => :event
+        attribute :experience, :type => :event
+        attribute :skill
+        attribute :affiliation, :type => :organization
+        attribute :citation, :type => :citation
+      end
+
+      type :review, :as => :hReview do
+        attribute :version
+        attribute :summary
+        attribute :kind, :as => :type # product | business | event | person | place | website | url
+        attribute :event, :as => :item, :type => :event
+        attribute :item, :type => :person
+        attribute :reviewer, :type => :person
+        attribute :reviewed_at, :as => :dtreviewed, :type => :date
+        attribute :rating, :type => :rating
+        attribute :description
+        attribute :tag, :rel => :tag
+        attribute :url, :as => :permalink, :rel => :bookmark
+        attribute :license
+      end
+
+      type :value do
+        attribute :kind, :as => :type
+        attribute :value
+      end
+    end
+  end
+end

data/lib/html-schema/microformat/attribute.rb

@@ -0,0 +1,9 @@
+class HTMLSchema
+  class Microformat
+    class Attribute < HTMLSchema::Attribute
+      def to_hash
+        options.merge(:class => classes.join(" "))
+      end
+    end
+  end
+end

data/lib/html-schema/microformat/object.rb

@@ -0,0 +1,9 @@
+class HTMLSchema
+  class Microformat
+    class Object < HTMLSchema::Object
+      def to_hash
+        {:class => classes.join(" ")}
+      end
+    end
+  end
+end

data/lib/html-schema/object.rb

@@ -0,0 +1,63 @@
+class HTMLSchema
+  class Object
+    attr_accessor :parent, :source, :as, :types, :attributes, :_name
+    attr_accessor :classes
+    
+    def initialize(name, options = {}, &block)
+      @_name      = name
+      @attributes = {}
+      @types      = {}
+      @parent     = options[:parent]
+      @as         = options[:as]
+      @as         ||= @parent ? @parent.as : name
+      @classes    = Array(as).map(&:to_s)
+      
+      # inherit parent attributes
+      @parent.attributes.each do |key, attribute|
+        self.attribute key, attribute.value
+      end if @parent
+      
+      instance_eval(&block) if block_given?
+    end
+    
+    def attribute(name, options = {})
+      create_attribute name, options
+    end
+    
+    def type(name, options = {}, &block)
+      create_type name, options, &block
+    end
+    
+    def inspect
+      "#<#{self.class.name} name: #{_name.inspect}, attributes: #{attributes.inspect} parent: #{(parent.present? ? parent._name : nil).inspect}, types: #{types.keys.inspect}>"
+    end
+    
+    def [](key)
+      attributes[key]
+    end
+    
+    protected
+    def format_class
+      @format_class ||= "#{self.class.name.split("::")[0..-2].join("::")}".constantize
+    end
+    
+    def attribute_class
+      @attribute_class ||= "#{format_class.name}::Attribute".constantize
+    end
+    
+    def create_attribute(name, options = {})
+      attributes[name] = attribute_class.new(name, options.merge(:parent => _name))
+      
+      self.class.send :define_method, name do
+        self.attributes[name]
+      end unless self.respond_to?(name)
+    end
+    
+    def create_type(name, options = {}, &block)
+      types[name] = format_class[name] = self.class.new(name, options.reverse_merge(:parent => self), &block)
+      self.class.send :define_method, name do
+        self.types[name]
+      end unless self.respond_to?(name)
+    end
+  end
+end

data/spec/schema_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe HTMLSchema do
+  context ":output" do
+    before do
+      @schema = HTMLSchema.instance
+    end
+    
+    context ":organization" do
+      before do
+        @organization = @schema.organization
+      end
+      
+      it "should have attributes" do
+        @organization.to_hash.should              == {
+          :itemscope => "itemscope", 
+          :itemtype  => "http://schema.org/Organization",
+          :class     => "org"
+        }
+        
+        @organization.name.to_hash.should         == {:itemprop => "name", :class => "organization-name"}
+        @organization.description.to_hash.should  == {:itemprop => "description", :class => "description"}
+        @organization.url.to_hash.should          == {:itemprop => "url", :class => "url"}
+        @organization.image.to_hash.should        == {:itemprop => "image", :class => "image"}
+      end
+    end
+    
+    context ":person" do
+      before do
+        @person = @schema.person
+      end
+      
+      it "should have attributes" do
+        @person.to_hash.should              == {
+          #:itemprop  => "person", 
+          :itemscope => "itemscope", 
+          :itemtype  => "http://schema.org/Person",
+          :class     => "vcard"
+        }
+        @person.name.to_hash.should         == {:itemprop => "name", :class => "fn"}
+        @person.url.to_hash.should          == {:itemprop => "url", :class => "url"}
+        @person.image.to_hash.should        == {:itemprop => "image", :class => "image"}
+      end
+    end
+    
+    context ":address" do
+      before do
+        @address = @schema.address
+      end
+      
+      it "should have attributes" do
+        @address.to_hash.should              == {
+          #:itemprop  => "address", 
+          :itemscope => "itemscope", 
+          :itemtype  => "http://schema.org/PostalAddress",
+          :class     => "adr"
+        }
+        @address.name.to_hash.should         == {:itemprop => "name", :class => "name"}
+        @address.url.to_hash.should          == {:itemprop => "url", :class => "url"}
+        @address.image.to_hash.should        == {:itemprop => "image", :class => "image"}
+      end
+    end
+    
+    context ":article" do
+      before do
+        @article = @schema.article
+      end
+      
+      it "should have attributes" do
+        @article.to_hash.should == {
+          :itemscope => "itemscope",
+          :itemtype  => "http://schema.org/Article",
+          :class     => "hentry"
+        }
+        
+        @article.title.to_hash.should         == {:itemprop => "title", :class => "entry-title"}
+        @article.tag.to_hash.should           == {:itemprop => "keywords", :rel => "tag", :class => "tag"}
+        @article.description.to_hash.should   == {:itemprop => "description", :class => "entry-summary"}
+        @article.body.to_hash.should          == {:itemprop => "articleBody", :class => "entry-content"}
+        @article.published_at.to_hash.should  == {:itemprop => "datePublished", :class => "published"}
+        @article.author.to_hash.should        == {:itemprop => "author", :class => "author"}
+        @article.url.to_hash.should           == {:itemprop => "url", :class => "url"}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'active_support/core_ext'
+require 'rspec'
+
+# rspec spec/microdata/base_spec.rb
+
+RSpec.configure do |config|
+  
+end
+
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+
+require 'html-schema'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: html-schema
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Lance Pollard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-11 00:00:00 Z
+dependencies: []
+
+description: Unified Ruby API for HTML5 Microdata and Microformats
+email: lancejpollard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- lib/html-schema/api/attribute.rb
+- lib/html-schema/api/object.rb
+- lib/html-schema/api.rb
+- lib/html-schema/attribute.rb
+- lib/html-schema/configuration.rb
+- lib/html-schema/dsl.rb
+- lib/html-schema/helper.rb
+- lib/html-schema/microdata/attribute.rb
+- lib/html-schema/microdata/object.rb
+- lib/html-schema/microdata.rb
+- lib/html-schema/microformat/attribute.rb
+- lib/html-schema/microformat/object.rb
+- lib/html-schema/microformat.rb
+- lib/html-schema/object.rb
+- lib/html-schema.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/viatropos/html-schema
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: html-schema
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Unified Ruby API for HTML5 Microdata and Microformats
+test_files: []
+