html-schema 0.2.0.1 → 0.5.0

data/Rakefile

@@ -5,14 +5,19 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
   s.name              = "html-schema"
   s.authors           = ["Lance Pollard"]
-  s.version           = "0.2.0.1"
-  s.description       = "Unified Ruby API for HTML5 Microdata and Microformats"
-  s.summary           = "Unified Ruby API for HTML5 Microdata and Microformats"
+  s.version           = "0.5.0"
+  s.summary           = "Schema.org API for Ruby (Microdata and Microformats under one API)"
+  s.description       = %{
+A unified interface to the semantic web.  You tell your ERB/Haml this is a "person" object,
+and it will give you the schema.org microdata, the microformats, or both.  Cuts out having to
+remember these "non-human" keys :).
+}
   s.homepage          = "http://github.com/viatropos/html-schema"
+  s.license           = "MIT"
   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.files             = %w(Rakefile) + Dir["{lib}/**/*"]
   s.require_path      = "lib"
 end
 

data/lib/html-schema.rb

@@ -1,6 +1,6 @@
 require 'active_support/core_ext'
 
-$:.unshift File.dirname(File.expand_path(__FILE__)) + "/html-schema"
+$:.unshift File.dirname(File.expand_path(__FILE__))
 
 class HTMLSchema
   class << self
@@ -60,24 +60,64 @@ class HTMLSchema
     
   end
   
+  def to_hash(options = {})
+    recursively_stringify_keys(api.types.keys.inject({}) do |hash, key|
+      hash[key] = api.types[key].to_object
+      hash
+    end, options)
+  end
+  
+  def to_yaml
+    to_hash.to_yaml
+  end
+  
   protected
   def define_api_method(name)
     self.class.send :define_method, name do
       self.api[name]
     end unless self.respond_to?(name)
   end
+  
+  def compact_keys
+    @compact_keys ||= {
+      :itemtype  => "t",
+      :itemscope => "s",
+      :itemprop  => "p", 
+      :class     => "c",
+      :rel       => "r",
+      :type      => "k"
+    }
+  end
+  
+  private
+  def recursively_stringify_keys(hash = {}, options = {})
+    hash.keys.inject({}) do |result, key|
+      value = hash[key]
+      result[options[:compact] ? (compact_keys[key] || key.to_s) : key.to_s] = case value
+      when ::Hash
+        recursively_stringify_keys(value, options)
+      when ::Array
+        value.map(&:to_s)
+      else
+        value.to_s
+      end
+      result
+    end
+  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'
+require 'html-schema/railtie'
+require 'html-schema/helper'
+require 'html-schema/object'
+require 'html-schema/attribute'
+require 'html-schema/configuration'
+require 'html-schema/dsl'
+require 'html-schema/api/object'
+require 'html-schema/api/attribute'
+require 'html-schema/microdata/object'
+require 'html-schema/microdata/attribute'
+require 'html-schema/microformat/object'
+require 'html-schema/microformat/attribute'
+require 'html-schema/api'
+require 'html-schema/microdata'
+require 'html-schema/microformat'

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

@@ -10,16 +10,35 @@ class HTMLSchema
         @microformat ||= HTMLSchema.instance.microformat[_name]
       end
       
-      def to_microdata
-        microdata.to_hash
+      def to_hash
+        result = {}
+        deep_merge(result, microdata.to_hash) if microdata
+        deep_merge(result, microformat.to_hash) if microformat
+        result
       end
       
-      def to_microformat
-        microformat.to_hash
+      def to_object
+        result = {}
+        deep_merge(result, microdata.to_object) if microdata
+        deep_merge(result, microformat.to_object) if microformat
+        result
       end
       
-      def to_hash
-        to_microdata.merge(to_microformat)
+      private
+      def deep_merge(result, object = {})
+        object.each do |key, value|
+          if result.has_key?(key)
+            case result[key]
+            when ::Hash
+              result[key] = deep_merge(result[key], value)
+            when ::Array
+              result[key] |= value
+            end
+          else
+            result[key] = value
+          end
+        end
+        result
       end
     end
   end

data/lib/html-schema/attribute.rb

@@ -9,6 +9,7 @@ class HTMLSchema
       @as         = options[:as] || name
       @classes    = Array(as).map(&:to_s)
       @required   = options[:required] == true
+      @type       = options[:type] || :string
       
       @options    = options.except(:as, :parent, :required, :type)
       @options.each do |key, value|
@@ -34,6 +35,14 @@ class HTMLSchema
       @value = format(value)
     end
     
+    def to_hash
+      {}
+    end
+    
+    def to_object
+      to_hash.merge(:type => type)
+    end
+    
     class << self
       def attribute?
         true

data/lib/html-schema/dsl.rb

@@ -19,5 +19,11 @@ class HTMLSchema
     def []=(key, value)
       types[key] = value
     end
+    
+    def to_hash
+      types.keys.inject({}) do |hash, key|
+        hash[key] = types[key].to_hash
+      end
+    end
   end
 end

data/lib/html-schema/microdata.rb

@@ -24,7 +24,7 @@ class HTMLSchema
           attribute :country, :as => :addressCountry#, :type => :place, :source => :country
         end
       end
-
+      
       type :composition, :as => :Composition do
         attribute :abstract, :as => :about, :type => :base
         attribute :average_rating, :as => :aggregateRating, :type => :rating
@@ -56,7 +56,7 @@ class HTMLSchema
 
         # dates
         attribute :published_at, :as => :datePublished, :type => :date
-        attribute :updated_at, :as => :datePublished, :type => :date
+        #attribute :updated_at, :as => :datePublished, :type => :date
         
         type :blog, :as => :Blog
         type :book, :as => :Book

data/lib/html-schema/object.rb

@@ -36,6 +36,12 @@ class HTMLSchema
       attributes[key]
     end
     
+    def to_object
+      result = to_hash.merge(:attributes => attributes.keys.inject({}) { |hash, key| hash[key] = attributes[key].to_object ; hash })
+      result[:parent] = parent._name if parent
+      result
+    end
+    
     protected
     def format_class
       @format_class ||= "#{self.class.name.split("::")[0..-2].join("::")}".constantize

data/lib/html-schema/railtie.rb

@@ -0,0 +1,9 @@
+class HTMLSchema
+  class Railtie < Rails::Railtie
+    initializer "htmlschema.insert_into_action_view" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, HTMLSchema::Helper
+      end
+    end
+  end if defined?(::Rails)
+end

metadata

@@ -1,14 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: html-schema
 version: !ruby/object:Gem::Version 
-  hash: 93
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  - 1
-  version: 0.2.0.1
+  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors: 
 - Lance Pollard
@@ -16,11 +10,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-06 00:00:00 -05:00
-default_executable: 
+date: 2011-09-20 00:00:00 Z
 dependencies: []
 
-description: Unified Ruby API for HTML5 Microdata and Microformats
+description: "\n\
+  A unified interface to the semantic web.  You tell your ERB/Haml this is a \"person\" object,\n\
+  and it will give you the schema.org microdata, the microformats, or both.  Cuts out having to\n\
+  remember these \"non-human\" keys :).\n"
 email: lancejpollard@gmail.com
 executables: []
 
@@ -44,13 +40,11 @@ files:
 - lib/html-schema/microformat/object.rb
 - lib/html-schema/microformat.rb
 - lib/html-schema/object.rb
+- lib/html-schema/railtie.rb
 - lib/html-schema.rb
-- spec/schema_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/viatropos/html-schema
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -61,25 +55,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: html-schema
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Unified Ruby API for HTML5 Microdata and Microformats
+summary: Schema.org API for Ruby (Microdata and Microformats under one API)
 test_files: []
 

data/spec/schema_spec.rb

@@ -1,87 +0,0 @@
-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.updated_at.to_hash.should    == {:class => "updated"}
-        @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

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