snipp 0.0.4 → 0.0.5

data/README.md

@@ -3,7 +3,7 @@
 [![Coverage Status](https://coveralls.io/repos/yulii/snipp/badge.png?branch=master)](https://coveralls.io/r/yulii/snipp)
 [![Build Status](https://travis-ci.org/yulii/snipp.png)](https://travis-ci.org/yulii/snipp)
 
-TODO: Write a gem description
+Rich snippets and structured data helpers.
 
 ## Installation
 
@@ -21,6 +21,29 @@ Or install it yourself as:
 $ gem install snipp
 ```
 ## Usage
+Call `item_tag` like `content_tag`
+```html+ruby
+<%= item_tag :div, scope: true, type: :review do %>
+  <%= item_tag :span, 'Snipp', prop: :itemreviewd %>
+  Reviewed by <%= item_tag :span, '@yulii', prop: :reviewer %> on
+  <%= item_tag :time, 'April 1', prop: :dtreviewd, datetime: "2013-04-01" %>.
+  <%= item_tag :span, 'Review summary...', prop: :summary %>
+  <%= item_tag :span, 'Review description...', prop: :description %>
+  Rating: <%= item_tag :span, '4.5', prop: :rating %>
+<% end %>
+```
+This would output
+```html
+<div itemscope itemtype="http://data-vocabulary.org/Review">
+  <span itemprop="itemreviewed">Snipp</span>
+  Reviewed by <span itemprop="reviewer">@yulii</span> on
+  <time itemprop="dtreviewed" datetime="2013-04-01">April 1</time>.
+  <span itemprop="summary">Review summary...</span>
+  <span itemprop="description">Review description...</span>
+  Rating: <span itemprop="rating">4.5</span>
+</div>
+```
+
 ### Breadcrumbs
 ```html+ruby
 <%= breadcrumb [:root, :food, :food_fruit, :food_fruit_red, :food_fruit_red_apple], s: "/" %>
@@ -41,7 +64,7 @@ en:
       food_fruit_red_apple: "Apple"
 ```
 
-more https://github.com/yulii/snipp/blob/master/app/views/snipp/index.html.erb
+For more information, read erb files in `app/view/snipp/`
 
 ## Contributing
 

data/app/views/snipp/breadcrumb.html.erb

@@ -1,23 +1,23 @@
-<h1>Breadcumbs - Rich Snippets Sample</h1>
+<h1>Breadcrumb - Rich Snippets Sample</h1>
 <h2>Basic</h2>
 <section id="case-A-1">
-  <h3>Simple Breadcumb</h3>
-  <%= breadcrumb [:root, :foods, :fruits] %>
+  <h3>Simple Breadcrumb</h3>
+  <%= breadcrumb [:index, :foods, :fruits] %>
 </section>
 <section id="case-A-2">
   <h3>Designate separator</h3>
-  <%= breadcrumb [:root, :foods, :fruits], s: "/" %>
+  <%= breadcrumb [:index, :foods, :fruits], s: "/" %>
 </section>
 <h2>Advanced</h2>
 <section id="case-B-1">
   <h3>Specify Parameters for URL (path) and i18n</h3>
-  <%= breadcrumb [:root, :foods, :fruits, :fruits_color, :food], s: "/", args: [:color, :name]  %>
+  <%= breadcrumb [:index, :foods, :fruits, :fruits_color, :food], s: "/", args: [:color, :name]  %>
 </section>
 <section id="case-B-2">
   <h3>Customize Variables</h3>
-  <%= breadcrumb [:root, :foods, :fruits, { path: fruits_color_path('Red'), label: 'Red' }, { path: food_path(color: 'Red', name: 'Apple'), label: 'Apple' }], s: "/" %>
+  <%= breadcrumb [:index, :foods, :fruits, { path: fruits_color_path('Red'), label: 'Red' }, { path: food_path(color: 'Red', name: 'Apple'), label: 'Apple' }], s: "/" %>
 </section>
 <section id="case-B-3">
   <h3>Customize Variables and Specify Parameters</h3>
-  <%= breadcrumb [:root, :foods, :fruits, { path: fruits_color_path, label: :fruits_color }, { path: food_path, label: :food }], s: "/", args: [:color, :name] %>
+  <%= breadcrumb [:index, :foods, :fruits, { path: fruits_color_path, label: :fruits_color }, { path: food_path, label: :food }], s: "/", args: [:color, :name] %>
 </section>

data/app/views/snipp/geo.html.erb

@@ -0,0 +1,6 @@
+<h1>Geo - Rich Snippets Sample</h1>
+<h2>Basic</h2>
+<section id="case-A-1">
+  <h3>Simple Geo</h3>
+  <%= geo 38.5323, 77.0040 %>
+</section>

data/app/views/snipp/index.html.erb

@@ -1,5 +1,21 @@
-<h1>Rich Snippets Sample</h1>
-<h2>Breadcumb</h2>
-<% = breadcrumb [:root, :foods, :fruits, :fruits_color, :food], s: "/", params: [:color, :name]  %>
+<h1>Index - Rich Snippets Sample</h1>
 
-<% = breadcrumb [:root, :foods, :fruits, { path: fruits_color_path(:red), label: 'Red' }, { path: food_path(color: :red, name: :apple), label: 'Apple' }], s: "/" %>
+<h2>Reviews</h2>
+<h3>ERB code</h3>
+<%= item_tag :div, scope: true, type: :review do %>
+  <%= item_tag :span, 'Snipp', prop: :itemreviewd %>
+  Reviewed by <%= item_tag :span, '@yulii', prop: :reviewer %> on
+  <%= item_tag :time, 'April 1', prop: :dtreviewd, datetime: "2013-04-01" %>.
+  <%= item_tag :span, 'Review summary...', prop: :summary %>
+  <%= item_tag :span, 'Review description...', prop: :description %>
+  Rating: <%= item_tag :span, '4.5', prop: :rating %>
+<% end %>
+<h3>Output code</h3>
+<div itemscope itemtype="http://data-vocabulary.org/Review">
+  <span itemprop="itemreviewed">Snipp</span>
+  Reviewed by <span itemprop="reviewer">@yulii</span> on
+  <time itemprop="dtreviewed" datetime="2013-04-01">April 1</time>.
+  <span itemprop="summary">Review summary...</span>
+  <span itemprop="description">Review description...</span>
+  Rating: <span itemprop="rating">4.5</span>
+</div>

data/config/locales/snipp.yml

@@ -2,7 +2,7 @@ en:
   views:
     breadcrumb:
       # Sample
-      root: "Top"
+      index: "Top"
       foods: "Foods"
       fruits: "Fruits"
       fruits_color: "%{color}"

data/lib/snipp/markups/microdata.rb

@@ -4,7 +4,7 @@ module Snipp
 
       def breadcrumb paths, options = {}
         sepalator = " #{options.delete(:sepalator)||options.delete(:s)||'>'} "
-        sepalator << '<div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
+        sepalator << "<div#{item_options prop: :child, scope: true, type: :breadcrumb}>"
   
         # options for i18n
         i18n_options = { scope: [:views, :breadcrumb] }
@@ -22,7 +22,7 @@ module Snipp
             bc.push link_to body, send("#{e}_path"), itemprop: :url
           end 
         end
-        output = '<nav class="breadcrumb" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
+        output = "<nav class=\"breadcrumb\"#{item_options scope: true, type: :breadcrumb}>"
         output << bc.join(sepalator)
   
         (paths.size - 1).times do
@@ -33,6 +33,33 @@ module Snipp
         return output.html_safe
       end 
 
+      def geo latitude, longitude, options = {}
+        item_tag :span, prop: :geo, scope: true, type: :geo, class: "geo" do
+          "#{content_tag :span, latitude, itemprop: :latitude}#{content_tag :span, longitude, itemprop: :longitude}".html_safe
+        end
+      end
+
+      def item_tag name, content_or_options_with_block = nil, options = nil, escape = true, &block
+        if block_given?
+          options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
+          content = capture(&block)
+        else
+          content = content_or_options_with_block
+        end
+        item_options = item_options options, escape if options
+        tag_options  = tag_options  options, escape if options
+        content = if block_given? then capture(&block) else content_or_options_with_block end
+         "<#{name}#{tag_options}#{item_options}>#{escape ? ERB::Util.h(content) : content}</#{name}>".html_safe
+      end
+
+      def item_options options, escape = true
+        attrs = ''
+        attrs << " itemprop=\"#{escape ? ERB::Util.h(options.delete :prop) : options.delete(:prop)}\"" if options.key? :prop
+        attrs << " itemscope" if options.delete :scope
+        attrs << " itemtype=\"http://data-vocabulary.org/#{options.delete(:type).to_s.camelize}\"" if options.key? :type
+        attrs.html_safe
+      end
+
     end
   end
 end

data/lib/snipp/version.rb

@@ -1,3 +1,3 @@
 module Snipp
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/fake_rails.rb

@@ -11,8 +11,12 @@ end
 app.initialize!
 
 # routing
+ITEMTYPES = [:index, :breadcrumb, :geo]
 app.routes.draw do
-  get "/" =>"snipp#index" ,as: :root
+
+  ITEMTYPES.each do |e|
+    get "/#{e}" => "snipp##{e}", as: e
+  end
 
   # for Breadcumb
   get "/foods"                     => "snipp#breadcrumb", as: :foods
@@ -26,9 +30,10 @@ class ApplicationController < ActionController::Base ; end
 
 class SnippController < ApplicationController
 
-  def index ; end
-
-  def breadcrumb ; end
+  ITEMTYPES.each do |e|
+    define_method e do
+    end
+  end
 
 end
 

data/spec/snipp/helpers/action_view_extension_spec.rb

@@ -1,89 +1,10 @@
 # coding: UTF-8
 require 'spec_helper'
 
-class Snipp::ActionViewExtension::Spec
-
-  BREADCRUMBS = [
-    { id: "#case-A-1", path: [:root, :foods, :fruits], separator: '>' },
-    { id: "#case-A-2", path: [:root, :foods, :fruits], separator: '/' },
-    { id: "#case-B-1", path: [:root, :foods, :fruits, :fruits_color, :food], separator: '/', params: [:color, :name] },
-#    { id: "#case-B-2", path: [:root, :foods, :fruits, { path: app.fruits_color_path('Red'), label: 'Red' }, { path: app.food_path(color: 'Red', name: 'Apple'), label: 'Apple' }], separator: '/' },
-#    { id: "#case-B-3", path: [:root, :foods, :fruits, { path: app.fruits_color_path, label: :fruits_color }, { path: app.food_path, label: :food }], separator: '/', params: [:color, :name] },
-  ]
-
-end
-
 describe Snipp::ActionViewExtension do
 
   before do
     Snipp::Hooks.init
-    visit "/foods/fruits/Red/Apple"
-  end
-
-# <nav class="breadcrumb" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">
-#   <a href="/" itemprop="url">
-#     <span itemprop="title">Top</span>
-#   </a>&nbsp;/&nbsp;
-#   <div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">
-#     <a href="/foods" itemprop="url">
-#       <span itemprop="title">Foods</span>
-#     </a>&nbsp;/&nbsp;
-#     <div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">
-#       <a href="/foods/fruits" itemprop="url">
-#         <span itemprop="title">Fruits</span>
-#       </a>&nbsp;/&nbsp;
-#       <div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">
-#         <a href="/foods/fruits/Red" itemprop="url">
-#           <span itemprop="title">Red</span>
-#         </a>&nbsp;/&nbsp;
-#         <div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">
-#           <a href="/foods/fruits/Red/Apple" itemprop="url">
-#             <span itemprop="title">Apple</span>
-#           </a>
-#         </div>
-#       </div>
-#     </div>
-#   </div>
-# </nav>
-
-
-  let(:itemtype) { "http://data-vocabulary.org/Breadcrumb" }
-
-  describe "breadcrumbs" do
-
-    Snipp::ActionViewExtension::Spec::BREADCRUMBS.each do |e|
-      context e[:id] do
-        it "should have a `nav[itemscope]` tag" do
-          within(e[:id]) { expect(page).to have_selector("nav[itemtype=\"#{itemtype}\"][itemscope]", count: 1) }
-        end
-        it "should have correct number of `div[itemscope]` tags" do
-          within(e[:id]) { expect(page).to have_selector("div[itemtype=\"#{itemtype}\"][itemscope]", count: (e[:path].size - 1)) }
-        end
-        it "should have correct number of `itemprop` attribute that equals `child`" do
-          within(e[:id]) { expect(page).to have_selector('[itemprop="child"][itemscope]', count: (e[:path].size - 1)) }
-        end
-        it "should have correct number of `a[itemprop\"url\"]` tags" do
-          within(e[:id]) { expect(page).to have_selector('a[itemprop="url"]', count: e[:path].size) }
-        end
-        it "should have correct number of `span[itemprop\"title\"]` tags" do
-          within(e[:id]) { expect(page).to have_selector('span[itemprop="title"]', count: e[:path].size) }
-        end
-        it "should have correct number of separators" do
-          within(e[:id]) { expect(page).to have_content(e[:separator], count: (e[:path].size - 1)) }
-        end
-      end
-    end
-
-    describe "a variety of ways to define breadcrumbs" do
-      let(:html) { page.find("#case-B-1 nav").native.to_s }
-
-      it "should be equivalent" do
-        expect(page.find("#case-B-2 nav").native.to_s).to eq html
-      end
-      it "should be equivalent" do
-        expect(page.find("#case-B-3 nav").native.to_s).to eq html
-      end
-    end
   end
 
 end

data/spec/snipp/markups/microdata/breadcrumb_spec.rb

@@ -0,0 +1,60 @@
+# coding: UTF-8
+require 'spec_helper'
+
+class Snipp::Markup::Microdata::Spec
+
+  BREADCRUMBS = [
+    { id: "#case-A-1", path: [:index, :foods, :fruits], separator: '>' },
+    { id: "#case-A-2", path: [:index, :foods, :fruits], separator: '/' },
+    { id: "#case-B-1", path: [:index, :foods, :fruits, :fruits_color, :food], separator: '/', params: [:color, :name] },
+#    { id: "#case-B-2", path: [:index, :foods, :fruits, { path: app.fruits_color_path('Red'), label: 'Red' }, { path: app.food_path(color: 'Red', name: 'Apple'), label: 'Apple' }], separator: '/' },
+#    { id: "#case-B-3", path: [:index, :foods, :fruits, { path: app.fruits_color_path, label: :fruits_color }, { path: app.food_path, label: :food }], separator: '/', params: [:color, :name] },
+  ]
+
+end
+
+describe Snipp::Markup::Microdata do
+
+  before do
+    Snipp::Hooks.init
+    visit "/foods/fruits/Red/Apple"
+  end
+
+  let(:itemtype) { "http://data-vocabulary.org/Breadcrumb" }
+
+  describe "breadcrumbs" do
+
+    Snipp::Markup::Microdata::Spec::BREADCRUMBS.each do |e|
+      context e[:id] do
+        it "should have a `nav[itemscope]` tag" do
+          within(e[:id]) { expect(page).to have_selector("nav[itemtype=\"#{itemtype}\"][itemscope]", count: 1) }
+        end
+        it "should have correct number of `div[itemscope]` tags" do
+          within(e[:id]) { expect(page).to have_selector("div[itemtype=\"#{itemtype}\"][itemscope]", count: (e[:path].size - 1)) }
+        end
+        it "should have correct number of `itemprop` attribute that equals `child`" do
+          within(e[:id]) { expect(page).to have_selector('[itemprop="child"][itemscope]', count: (e[:path].size - 1)) }
+        end
+        it "should have correct number of separators" do
+          within(e[:id]) { expect(page).to have_content(e[:separator], count: (e[:path].size - 1)) }
+        end
+        ['[itemscope]', 'a[itemprop="url"]', 'span[itemprop="title"]'].each do |s|
+          it "should have correct number of `#{s}` tags" do
+            within(e[:id]) { expect(page).to have_selector(s, count: e[:path].size) }
+          end
+        end
+      end
+    end
+
+    describe "a variety of ways to define breadcrumbs" do
+      let(:html) { page.find("#case-B-1 nav").native.to_s }
+
+      ["#case-B-2", "#case-B-3"].each do |e|
+        it "should be equivalent" do
+          expect(page.find("#{e} nav").native.to_s).to eq html
+        end
+      end
+    end
+  end
+
+end

data/spec/snipp/markups/microdata/geo_spec.rb

@@ -0,0 +1,44 @@
+# coding: UTF-8
+require 'spec_helper'
+
+class Snipp::Markup::Microdata::Spec
+
+  GEO = [
+    { id: "#case-A-1", latitude: 38.5323, longitude: 77.0040 },
+  ]
+
+end
+
+describe Snipp::Markup::Microdata do
+
+  before do
+    Snipp::Hooks.init
+    visit "/geo"
+  end
+
+  let(:itemtype) { "http://data-vocabulary.org/Geo" }
+
+  shared_examples_for 'defined the latitude and longitude' do |e|
+    it { expect(page).to have_selector('[itemprop="latitude"]', text: e[:latitude], count: 1) }
+    it { expect(page).to have_selector('[itemprop="longitude"]', text: e[:longitude], count: 1) }
+  end
+
+  describe "geo" do
+
+    Snipp::Markup::Microdata::Spec::GEO.each do |e|
+      context e[:id] do
+        it "should have a `span[itemscope]` tag" do
+          within(e[:id]) { expect(page).to have_selector("span[itemtype=\"#{itemtype}\"][itemscope]", count: 1) }
+        end
+        [:latitude, :longitude].each do |arg|
+          it "should have a `itemprop` attribute that equals `#{arg}`" do
+            within(e[:id]) { expect(page).to have_selector("[itemprop=\"#{arg}\"]", count: 1) }
+          end
+        end
+        it_should_behave_like 'defined the latitude and longitude', e
+      end
+    end
+
+  end
+
+end

data/spec/snipp_spec.rb

@@ -5,10 +5,21 @@ describe Snipp do
 
   before do
     Snipp::Hooks.init
-    visit "/foods/fruits/Red/Apple"
   end
 
-  it "should be no error" do
-    expect(page).to have_content("Breadcumbs - Rich Snippets Sample")
+  ITEMTYPES.each do |e|
+    describe "no errors" do
+      before do
+        case e
+        when :breadcrumb
+          visit "/foods/fruits/Red/Apple"
+        else
+          visit send("#{e}_path")
+        end
+      end
+      it "should have no errors when visits /#{e}" do
+        expect(page).to have_content("#{e.to_s.camelize} - Rich Snippets Sample")
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect    # disables `should`
   end
+  config.include Rails.application.routes.url_helpers
   config.include Capybara::DSL
 end
 Capybara.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snipp
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -43,6 +43,7 @@ files:
 - Rakefile
 - app/views/layouts/application.html.erb
 - app/views/snipp/breadcrumb.html.erb
+- app/views/snipp/geo.html.erb
 - app/views/snipp/index.html.erb
 - config/locales/snipp.yml
 - deploy_gem.sh
@@ -57,6 +58,8 @@ files:
 - snipp.gemspec
 - spec/fake_rails.rb
 - spec/snipp/helpers/action_view_extension_spec.rb
+- spec/snipp/markups/microdata/breadcrumb_spec.rb
+- spec/snipp/markups/microdata/geo_spec.rb
 - spec/snipp_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/yulii/snipp
@@ -86,5 +89,7 @@ summary: Let search engines understand the content on your website
 test_files:
 - spec/fake_rails.rb
 - spec/snipp/helpers/action_view_extension_spec.rb
+- spec/snipp/markups/microdata/breadcrumb_spec.rb
+- spec/snipp/markups/microdata/geo_spec.rb
 - spec/snipp_spec.rb
 - spec/spec_helper.rb