RubyGems - snipp - Versions diffs - 0.0.1 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (21) hide show

data/.gitignore +18 -0
data/.rspec +2 -0
data/Gemfile +9 -0
data/LICENSE.txt +22 -0
data/README.md +52 -0
data/Rakefile +4 -0
data/app/views/layouts/application.html.erb +15 -0
data/app/views/snipp/index.html.erb +3 -0
data/config/locales/snipp.yml +9 -0
data/deploy_gem.sh +34 -0
data/lib/snipp/engine.rb +4 -0
data/lib/snipp/helpers/action_view_extension.rb +30 -0
data/lib/snipp/hooks.rb +9 -0
data/lib/snipp/railtie.rb +7 -0
data/lib/snipp/version.rb +3 -0
data/lib/snipp.rb +10 -0
data/snipp.gemspec +21 -0
data/spec/fake_rails.rb +40 -0
data/spec/snipp_spec.rb +16 -0
data/spec/spec_helper.rb +20 -0
metadata +84 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/

data/.rspec ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ --color
2	+ --format d

data/Gemfile ADDED Viewed

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+group :test do
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'coveralls', :require => false
+end

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2013 yulii
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,52 @@
+# Snipp
+TODO: Write a gem description
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'snipp'
+```
+And then execute:
+```sh
+$ bundle
+```
+Or install it yourself as:
+```sh
+$ gem install snipp
+```
+## Usage
+### Breadcrumbs
+```html+ruby
+<%= breadcrumb [:root, :food, :food_fruit, :food_fruit_red, :food_fruit_red_apple], s: "/" %>
+```
+link to `root_path`, `food_path`, `food_fruit_path`, `food_fruit_red`, `food_fruit_red_apple`
+Link text
+```yaml
+en:
+  views:
+    breadcrumb:
+      # Sample
+      root: "Top"
+      food: "Food"
+      food_fruit: "Fruit"
+      food_fruit_red: "Red"
+      food_fruit_red_apple: "Apple"
+```
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+## LICENSE
+(The MIT License)
+Copyright © 2013 yulii. See LICENSE.txt for further details.

data/Rakefile ADDED Viewed

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/views/layouts/application.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <title>Snipp</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

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

@@ -0,0 +1,3 @@
+<h1>Rich Snippets Sample</h1>
+<h2>Breadcumb</h2>
+<%= breadcrumb [:root, :food, :food_fruit, :food_fruit_red, :food_fruit_red_apple], s: "/" %>

data/config/locales/snipp.yml ADDED Viewed

@@ -0,0 +1,9 @@
+en:
+  views:
+    breadcrumb:
+      # Sample
+      root: "Top"
+      food: "Food"
+      food_fruit: "Fruit"
+      food_fruit_red: "Red"
+      food_fruit_red_apple: "Apple"

data/deploy_gem.sh ADDED Viewed

@@ -0,0 +1,34 @@
+#!/bin/sh
+LIB_NAME="snipp"
+if [ $# -ne 1 ]
+then
+	echo "invalid VERSION"
+	exit 1
+fi
+GEMSPEC="${LIB_NAME}.gemspec"
+PKG_FILE="${LIB_NAME}-$1.gem"
+echo "[RUN] gem install"
+bundle install
+echo "[RUN] rake"
+bundle exec rake
+if [ $? -eq 1 ]
+then
+	exit 1
+fi
+echo "[RUN] gem build ${GEMSPEC}"
+gem build ${GEMSPEC}
+if [ $? -eq 1 ]
+then
+	exit 1
+fi
+echo "[RUN] mv ${PKG_FILE} pkg/"
+mv ${PKG_FILE} ./pkg
+echo "[RUN] gem push pkg/${PKG_FILE}"
+gem push pkg/${PKG_FILE}
+echo "[RUN] git tag -a version-$1"
+git tag -a version-$1 -m ""
+git push --tags

data/lib/snipp/engine.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Snipp
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/snipp/helpers/action_view_extension.rb ADDED Viewed

@@ -0,0 +1,30 @@
+module Snipp
+  module ActionViewExtension
+    # = breadcrumb [ :root, :seach, :item } ], s: "/"
+    # @params paths
+    # @params options
+    def breadcrumb paths, options = {}
+      sepalator = "&nbsp;#{options.delete(:sepalator)||options.delete(:s)||'&gt;'}&nbsp;"
+      sepalator << '<div itemprop="child" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">'
+      i18n_options = options.merge({ scope: [:views, :breadcrumb] })
+      bc = []
+      paths.each do |e|
+        body = content_tag :span, I18n.t(e, i18n_options), itemprop: :title
+        bc.push link_to body, send("#{e}_path", options), itemprop: :url
+      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
+  end
+end

data/lib/snipp/hooks.rb ADDED Viewed

@@ -0,0 +1,9 @@
+module Snipp
+  class Hooks
+    def self.init
+      ActiveSupport.on_load(:action_view) do
+        ::ActionView::Base.send :include, Snipp::ActionViewExtension
+      end
+    end
+  end
+end

data/lib/snipp/railtie.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Snipp
+  class Railtie < ::Rails::Railtie
+    initializer :snipp do |app|
+      Snipp::Hooks.init
+    end
+  end
+end

data/lib/snipp/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Snipp
+  VERSION = "0.0.1"
+end

data/lib/snipp.rb ADDED Viewed

@@ -0,0 +1,10 @@
+module Snipp
+end
+require 'snipp/helpers/action_view_extension'
+require 'snipp/hooks'
+if defined? Rails
+  require 'snipp/railtie'
+  require 'snipp/engine'
+end

data/snipp.gemspec ADDED Viewed

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snipp/version'
+Gem::Specification.new do |gem|
+  gem.name          = "snipp"
+  gem.version       = Snipp::VERSION
+  gem.authors       = ["yulii"]
+  gem.email         = ["yuliinfo@gmail.com"]
+  gem.description   = %q{Structured Data Snippets}
+  gem.summary       = %q{Let search engines understand the content on your website}
+  gem.homepage      = "https://github.com/yulii/snipp"
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "rails", "~>3.2.11"
+end

data/spec/fake_rails.rb ADDED Viewed

@@ -0,0 +1,40 @@
+require 'action_controller/railtie'
+require 'action_view/railtie'
+# config
+app = Class.new Rails::Application
+app.config.active_support.deprecation = :log
+app.config.secret_token = "e65e0140352e39703c113b0ce30335e8"
+app.config.generators do |g|
+#  g.template_engine :haml
+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
+end
+# controllers
+class ApplicationController < ActionController::Base ; end
+class SnippController < ApplicationController
+  def index ; end
+end
+# helpers
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/snipp_spec.rb ADDED Viewed

@@ -0,0 +1,16 @@
+# coding: UTF-8
+require 'spec_helper'
+describe Snipp do
+  before do
+    Snipp::Hooks.init
+    visit "/"
+    puts page.html
+  end
+  describe do
+    it { expect(true).to be_true }
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'rubygems'
+require 'snipp'
+require 'fake_rails'
+require 'capybara/rails'
+require 'coveralls'
+Coveralls.wear!('rails')
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec do |c|
+    c.syntax = :expect    # disables `should`
+  end
+  config.include Capybara::DSL
+end
+Capybara.configure do |config|
+  config.match = :prefer_exact
+  config.ignore_hidden_elements = false
+end

metadata ADDED Viewed

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: snipp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- yulii
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+description: Structured Data Snippets
+email:
+- yuliinfo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/layouts/application.html.erb
+- app/views/snipp/index.html.erb
+- config/locales/snipp.yml
+- deploy_gem.sh
+- lib/snipp.rb
+- lib/snipp/engine.rb
+- lib/snipp/helpers/action_view_extension.rb
+- lib/snipp/hooks.rb
+- lib/snipp/railtie.rb
+- lib/snipp/version.rb
+- snipp.gemspec
+- spec/fake_rails.rb
+- spec/snipp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/yulii/snipp
+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:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Let search engines understand the content on your website
+test_files:
+- spec/fake_rails.rb
+- spec/snipp_spec.rb
+- spec/spec_helper.rb

snipp 0.0.1