snipp 0.0.2 → 0.0.3

data/README.md

@@ -1,4 +1,7 @@
 # Snipp
+[![Gem Version](https://badge.fury.io/rb/snipp.png)](http://badge.fury.io/rb/snipp)
+[![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
 
@@ -38,6 +41,8 @@ en:
       food_fruit_red_apple: "Apple"
 ```
 
+more https://github.com/yulii/snipp/blob/master/app/views/snipp/index.html.erb
+
 ## Contributing
 
 1. Fork it

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

@@ -0,0 +1,23 @@
+<h1>Breadcumbs - Rich Snippets Sample</h1>
+<h2>Basic</h2>
+<section id="case-A-1">
+  <h3>Simple Breadcumb</h3>
+  <%= breadcrumb [:root, :foods, :fruits] %>
+</section>
+<section id="case-A-2">
+  <h3>Designate separator</h3>
+  <%= breadcrumb [:root, :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: "/", params: [: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: "/" %>
+</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: "/", params: [:color, :name] %>
+</section>

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

@@ -1,3 +1,5 @@
 <h1>Rich Snippets Sample</h1>
 <h2>Breadcumb</h2>
-<%= breadcrumb [:root, :food, :food_fruit, :food_fruit_red, :food_fruit_red_apple], s: "/" %>
+<% = breadcrumb [:root, :foods, :fruits, :fruits_color, :food], s: "/", params: [:color, :name]  %>
+
+<% = breadcrumb [:root, :foods, :fruits, { path: fruits_color_path(:red), label: 'Red' }, { path: food_path(color: :red, name: :apple), label: 'Apple' }], s: "/" %>

data/config/locales/snipp.yml

@@ -3,7 +3,7 @@ en:
     breadcrumb:
       # Sample
       root: "Top"
-      food: "Food"
-      food_fruit: "Fruit"
-      food_fruit_red: "Red"
-      food_fruit_red_apple: "Apple"
+      foods: "Foods"
+      fruits: "Fruits"
+      fruits_color: "%{color}"
+      food: "%{name}"

data/lib/snipp/config.rb

@@ -0,0 +1,30 @@
+require 'active_support/configurable'
+
+module Snipp
+
+  def self.configure(&block)
+    yield @config ||= Snipp::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :markup
+
+    def param_name
+      config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
+    end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
+  end
+
+  configure do |config|
+    config.markup  = :microdata
+  end
+end

data/lib/snipp/helpers/action_view_extension.rb

@@ -1,35 +1,11 @@
 module Snipp
   module ActionViewExtension
 
-    # = breadcrumb [ :root, :seach, :item } ], s: "/"
-    # @params paths
-    # @params options
-    def breadcrumb paths, options = {}
-      sepalator = " #{options.delete(:sepalator)||options.delete(:s)||'>'} "
-      sepalator << '<div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
-
-      i18n_options = options.merge({ scope: [:views, :breadcrumb] })
-
-      bc = []
-      paths.each do |e|
-        if e.is_a?(Hash)
-          body = content_tag :span, e[:label], itemprop: :title
-          bc.push link_to body, e[:path], itemprop: :url
-        else
-          body = content_tag :span, I18n.t(e, i18n_options), itemprop: :title
-          bc.push link_to body, send("#{e}_path", options), itemprop: :url
-        end 
-      end
-      code = '<nav class="breadcrumb" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
-      code << bc.join(sepalator)
-
-      (paths.size - 1).times do
-        code << '</div>'
-      end
-      code << '</nav>'
-
-      return code.html_safe
-    end 
+    def self.included(base)
+      name = "#{Snipp.config.markup}".camelize
+      raise NotImplementedError, "#{name} is invalid. Specify correct Snipp.config.markup." unless Snipp::Markup.const_defined? name
+      base.send :include, Snipp::Markup.const_get(name)
+    end
 
   end
 end

data/lib/snipp/markups/microdata.rb

@@ -0,0 +1,38 @@
+module Snipp
+  module Markup
+    module Microdata
+
+      def breadcrumb paths, options = {}
+        sepalator = " #{options.delete(:sepalator)||options.delete(:s)||'>'} "
+        sepalator << '<div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
+  
+        # options for i18n
+        i18n_options = { scope: [:views, :breadcrumb] }
+        (options[:params]||[]).each do |e|
+          i18n_options[e] = params[e]
+        end
+  
+        bc = []
+        paths.each do |e|
+          if e.is_a?(Hash)
+            body = content_tag :span, I18n.t(e[:label], i18n_options.merge(default: e[:label])), itemprop: :title
+            bc.push link_to body, e[:path], itemprop: :url
+          else
+            body = content_tag :span, I18n.t(e, i18n_options), itemprop: :title
+            bc.push link_to body, send("#{e}_path"), itemprop: :url
+          end 
+        end
+        output = '<nav class="breadcrumb" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
+        output << bc.join(sepalator)
+  
+        (paths.size - 1).times do
+          output << '</div>'
+        end
+        output << '</nav>'
+  
+        return output.html_safe
+      end 
+
+    end
+  end
+end

data/lib/snipp/version.rb

@@ -1,3 +1,3 @@
 module Snipp
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/snipp.rb

@@ -1,6 +1,8 @@
 module Snipp
 end
 
+require 'snipp/config'
+require 'snipp/markups/microdata'
 require 'snipp/helpers/action_view_extension'
 require 'snipp/hooks'
 

data/spec/fake_rails.rb

@@ -11,19 +11,14 @@ end
 app.initialize!
 
 # routing
-SNIPP_TYPES = [:breadcumb]
 app.routes.draw do
   get "/" =>"snipp#index" ,as: :root
 
-  SNIPP_TYPES.each do |e|
-    get "/e" => "index##{e}" ,as: e
-  end
-
   # for Breadcumb
-  get "/food"                 => "snipp#index", as: :food
-  get "/food/fruit"           => "snipp#index", as: :food_fruit
-  get "/food/fruit/red"       => "snipp#index", as: :food_fruit_red
-  get "/food/fruit/red/apple" => "snipp#index", as: :food_fruit_red_apple
+  get "/foods"                     => "snipp#breadcrumb", as: :foods
+  get "/foods/fruits"              => "snipp#breadcrumb", as: :fruits
+  get "/foods/fruits/:color"       => "snipp#breadcrumb", as: :fruits_color
+  get "/foods/fruits/:color/:name" => "snipp#breadcrumb", as: :food
 end
 
 # controllers
@@ -33,6 +28,8 @@ class SnippController < ApplicationController
 
   def index ; end
 
+  def breadcrumb ; end
+
 end
 
 

data/spec/snipp/helpers/action_view_extension_spec.rb

@@ -0,0 +1,89 @@
+# 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_spec.rb

@@ -5,12 +5,10 @@ describe Snipp do
 
   before do
     Snipp::Hooks.init
-    visit "/"
-    puts page.html
+    visit "/foods/fruits/Red/Apple"
   end
 
-  describe do
-    it { expect(true).to be_true }
+  it "should be no error" do
+    expect(page).to have_content("Breadcumbs - Rich Snippets Sample")
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snipp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -41,17 +41,21 @@ files:
 - README.md
 - Rakefile
 - app/views/layouts/application.html.erb
+- app/views/snipp/breadcrumb.html.erb
 - app/views/snipp/index.html.erb
 - config/locales/snipp.yml
 - deploy_gem.sh
 - lib/snipp.rb
+- lib/snipp/config.rb
 - lib/snipp/engine.rb
 - lib/snipp/helpers/action_view_extension.rb
 - lib/snipp/hooks.rb
+- lib/snipp/markups/microdata.rb
 - lib/snipp/railtie.rb
 - lib/snipp/version.rb
 - snipp.gemspec
 - spec/fake_rails.rb
+- spec/snipp/helpers/action_view_extension_spec.rb
 - spec/snipp_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/yulii/snipp
@@ -80,5 +84,6 @@ specification_version: 3
 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_spec.rb
 - spec/spec_helper.rb