html-schema 0.2.0

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "html-schema"
+  s.authors           = ["Lance Pollard"]
+  s.version           = "0.2.0"
+  s.description       = "Unified Ruby API for HTML5 Microdata and Microformats"
+  s.summary           = "Unified Ruby API for HTML5 Microdata and Microformats"
+  s.homepage          = "http://github.com/viatropos/html-schema"
+  s.email             = "lancejpollard@gmail.com"
+  s.rubyforge_project = "html-schema"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(Rakefile) + Dir["{lib,rails,spec}/**/*"] - Dir["spec/tmp"]
+  s.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+end
+
+desc 'run unit tests'
+task :test do
+  Dir["test/**/*"].each do |file|
+    next unless File.basename(file) =~ /test_/
+    next unless File.extname(file) == ".rb"
+    system "ruby #{file}"
+  end
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build #{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push #{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  command = "gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc"
+  command = "sudo #{command}" if ENV["SUDO"] == true
+  sh %{#{command}}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.md", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.md"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/lib/html-schema.rb

@@ -0,0 +1,83 @@
+require 'active_support/core_ext'
+
+$:.unshift File.dirname(File.expand_path(__FILE__)) + "/html-schema"
+
+class HTMLSchema
+  class << self
+    def root
+      @root ||= File.dirname(File.expand_path(__FILE__))
+    end
+    
+    def configure(&block)
+      yield configuration
+    end
+    
+    def configuration
+      @configuration ||= HTMLSchema::Configuration.new
+    end
+    
+    def [](key)
+      api[key]
+    end
+    
+    def instance
+      @instance ||= new
+    end
+    
+    def instance=(value)
+      @instance = value
+    end
+    
+    def bootstrap!(format)
+      format_name = format == :api ? "API" : format.to_s.camelize
+      Dir["#{HTMLSchema.root}/html-schema/#{format}/**/*.rb"].inject({}) do |hash, file|
+        name = ::File.basename(file, File.extname(file))
+        hash[name.to_sym] = "::HTMLSchema::#{format_name}::#{name.camelize}".constantize.new if name !~ /^(base|feed|attribute)$/
+        hash
+      end
+    end
+  end
+  
+  def initialize(types = {})
+    self.class.instance = self
+    api.types.keys.each { |key| define_api_method(key) }
+  end
+  
+  def api
+    @api          ||= HTMLSchema::API
+  end
+  
+  def microdata
+    @microdata    ||= HTMLSchema::Microdata
+  end
+  
+  def microformat
+    @microformat  ||= HTMLSchema::Microformat
+  end
+  
+  # todo, iterate through tree, so you can visualize it however you want.
+  def each(&block)
+    
+  end
+  
+  protected
+  def define_api_method(name)
+    self.class.send :define_method, name do
+      self.api[name]
+    end unless self.respond_to?(name)
+  end
+end
+
+require 'object'
+require 'attribute'
+require 'configuration'
+require 'dsl'
+require 'api/object'
+require 'api/attribute'
+require 'microdata/object'
+require 'microdata/attribute'
+require 'microformat/object'
+require 'microformat/attribute'
+require 'api'
+require 'microdata'
+require 'microformat'

data/lib/html-schema/api.rb

@@ -0,0 +1,253 @@
+class HTMLSchema
+  class API
+    extend HTMLSchema::DSL
+    
+    type :object do
+      attribute :id
+      attribute :title
+      attribute :name
+      attribute :url
+      attribute :description
+      attribute :image
+      
+      type :address do
+        attribute :street
+        attribute :suite
+        attribute :city
+        attribute :state
+        attribute :country
+        attribute :postal_code
+        attribute :post_office_box
+      end
+
+      type :composition do
+        attribute :abstract, :type => [:person, :organization]
+        attribute :average_rating, :type => :rating
+        attribute :award
+        attribute :rating, :type => :rating
+        attribute :genre
+        attribute :headline
+        attribute :language
+        attribute :interaction_count
+        attribute :family_friendly, :type => :boolean
+        attribute :keyword
+        attribute :offer, :type => :offer
+        attribute :review, :type => :review
+        attribute :editor, :type => :person
+        attribute :author, :type => :person
+        attribute :organization, :type => :organization
+        attribute :publisher, :type => :organization
+        attribute :location, :type => :address
+        attribute :videa, :type => :media
+        attribute :encoding, :type => :media
+        attribute :audio, :type => :media
+        attribute :tag
+        attribute :published_at, :type => :date
+
+        type :article do
+          attribute :body
+          attribute :section
+        end
+
+        type :media do
+          attribute :bitrate
+          attribute :size
+          attribute :url
+          attribute :embed_url
+          attribute :composition, :type => :article
+          attribute :format
+          attribute :player
+          attribute :allowed_in, :type => :address
+          attribute :subscription_required, :type => :boolean
+          attribute :expires_at, :type => :date
+          attribute :uploaded_at, :type => :date
+          attribute :duration, :as => :measurement
+          attribute :height, :type => :measurement
+          attribute :width, :type => :measurement
+
+          type :audio
+          type :image
+          type :video
+        end
+      end
+
+      type :coordinates do
+        attribute :elevation, :type => :measurement
+        attribute :latitude
+        attribute :longitude
+      end
+
+      type :event do
+        attribute :child_event, :type => :event
+        attribute :parent_event, :type => :event
+        attribute :start_date, :type => :date
+        attribute :end_date, :type => :date
+        attribute :location, :type => :address
+        attribute :duration, :type => :measurement
+        attribute :offer, :type => :offer
+        attribute :attendee, :type => :person
+        attribute :performer, :type => :person
+        attribute :organization, :type => :organization
+      end
+
+      type :figure do
+        attribute :image
+        attribute :legend
+        attribute :author, :type => [:person, :organization]
+        attribute :subject
+      end
+
+      type :item do
+        attribute :type
+        attribute :value
+      end
+
+      type :measurement do
+        attribute :value
+        attribute :unit
+        attribute :item, :type => [:text, :person, :organization, :media, :event]
+      end
+
+      type :offer do
+        attribute :rating, :type => :rating
+        attribute :availability
+        attribute :condition
+        attribute :item, :type => :product
+        attribute :price, :type => :measurement
+        attribute :min_price, :type => :measurement
+        attribute :max_price, :type => :measurement
+        attribute :currency
+        attribute :valid_until_date, :type => :date
+        attribute :review, :type => :review
+        attribute :seller, :type => :organization
+        attribute :count
+      end
+
+      type :organization do
+        attribute :address, :type => :address
+        attribute :average_rating, :type => :rating
+        attribute :contact, :type => [:person, :organization]
+        attribute :email
+        attribute :employee, :type => :person
+        attribute :event, :type => :event
+        attribute :fax
+        attribute :founder, :type => :person
+        attribute :founded_at, :type => :date
+
+        type :vendor do
+          attribute :branch_of, :type => :organization
+          attribute :hours
+          attribute :currency
+          attribute :payment_method
+          attribute :price_range
+          attribute :menu
+          attribute :reservations
+          attribute :cuisine
+        end
+      end
+
+      type :person do
+        attribute :address, :type => :address
+        attribute :home_address, :type => :address
+        attribute :work_address, :type => :address
+
+        # organizations
+        attribute :organization, :type => :organization
+        attribute :education, :type => :organization
+        attribute :membership, :type => :organization
+        attribute :company, :type => :organization
+
+        # events
+        attribute :performer_in, :type => :event
+
+        # dates
+        attribute :born_at, :type => :date
+        attribute :died_at, :type => :date
+
+        # relationships
+        attribute :children, :type => :person
+        attribute :parents, :type => :person
+        attribute :siblings, :type => :person
+        attribute :spouse, :type => :person
+        attribute :relationship, :type => :person
+        attribute :colleagues, :type => :person
+        # unidirectional
+        attribute :follows, :type => :person
+        # bidirectional
+        attribute :knows, :type => :person
+
+        # info
+        attribute :contact_info, :type => :contact
+        attribute :email
+        attribute :phone
+        attribute :fax
+        attribute :gender
+        attribute :interaction_count
+        attribute :job_title
+        attribute :nationality, :type => :place
+
+        type :author
+        type :acquaintance
+        type :child
+        type :colleague
+        type :contact
+        type :roommate
+        type :coworker
+        type :crush
+        type :date
+        type :editor
+        type :fan
+        type :friend
+        type :kin
+        type :me
+        type :met
+        type :muse
+        type :neighbor
+        type :sibling
+        type :spouse
+        type :sweetheart
+        type :member
+        type :sponsor
+        type :user
+      end
+
+      type :place do      
+        attribute :address, :type => :address
+        attribute :rating, :type => :rating
+        attribute :surrounding, :type => :place
+        attribute :event, :type => :event
+        attribute :fax
+        attribute :coordinates, :type => :coordinates
+        attribute :interaction_count
+        attribute :map
+        attribute :image, :type => :media
+        attribute :review, :type => :review
+        attribute :phone
+      end
+
+      type :product do
+        attribute :rating, :type => :rating
+        attribute :brand, :type => :organization
+        attribute :manufacturer, :type => :organization
+        attribute :model
+        attribute :offer, :type => :offer
+        attribute :review, :type => :review
+      end
+
+      type :rating do
+        attribute :best
+        attribute :value
+        attribute :worst
+        attribute :item, :type => [:person, :event, :media, :place, :organization]
+        attribute :rating_count
+        attribute :review_count
+      end
+
+      type :review do
+        attribute :body
+        attribute :item, :type => [:person, :event, :media, :place, :organization]
+        attribute :rating, :type => :rating
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+class HTMLSchema
+  class API
+    class Attribute < HTMLSchema::Attribute
+      def microdata
+        if @microdata.nil?
+          object     = HTMLSchema.instance.microdata[parent]
+          object     = object[_name] if object
+          object     = false if object.blank?
+          @microdata = object
+        end
+        
+        @microdata
+      end
+      
+      def microdata?
+        !!microdata
+      end
+      
+      def microformat
+        if @microformat.nil?
+          object     = HTMLSchema.instance.microformat[parent]
+          object     = object[_name] if object
+          object     = false if object.blank?
+          @microformat = object
+        end
+        @microformat
+      end
+      
+      def microformat?
+        !!microformat
+      end
+      
+      def to_microdata
+        microdata.to_hash
+      end
+      
+      def to_microformat
+        microformat.to_hash
+      end
+      
+      def to_hash
+        if microdata? && microformat?
+          to_microdata.merge(to_microformat)
+        elsif microdata?
+          to_microdata
+        elsif microformat?
+          to_microformat
+        else
+          {}
+        end
+      end
+    end
+  end
+end