structured-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c7033a829e9a0a17f4d55d068910ff78ddb0d87
+  data.tar.gz: 8b62bed97d79ee42de7e6190aa02627c609ff4c0
+SHA512:
+  metadata.gz: 5989b843b4fedd18aa5d6fbe07ab2c88f1f4609ba2193f3e6febeff35972efe3299dcff0384838544caec6397530089de7657fc40db13196bf1a6584c3f3d547
+  data.tar.gz: fa0c05c53f95e18de9ecc8d4f9770fc66f03cc1eb0de7cf0bb35459a596cbb91e2f9b4b166051f4aa6835e8ef9d339f0f4ab9b3259e4ef999f272cd16a152dce

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in structured_data.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 AKAMATSU Yuki
+
+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

@@ -0,0 +1,70 @@
+# StructuredData
+
+[![CircleCI](https://circleci.com/gh/ukstudio/structured_data/tree/master.svg?style=svg)](https://circleci.com/gh/ukstudio/structured_data/tree/master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'structured_data'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structured_data
+
+## Usage
+
+```ruby
+repo = StructuredData::Repository.new
+
+breadcrumb = StructuredData::BreadcrumbList.new
+breadcrumb << { url: '/products', name: 'Products' }
+breadcrumb << { url: '/products/book', name: 'Book' }
+
+repo << breadcrumb
+repo.dump
+```
+
+```json
+[{
+  "@context": "http://schema.org",
+  "@type": "BreadcrumbList",
+  "itemListElement": [
+    {
+      "@type": "ListItem",
+      "position": 1,
+      "item": {
+        "@id": "/products",
+        "name": "Products"
+      }
+    },
+    {
+      "@type": "ListItem",
+      "position": 2,
+      "item": {
+        "@id": "/products/book",
+        "name": "Book"
+      }
+    }
+  ]
+}]
+```
+
+### Rails support
+
+Call the helper method in Controller or View
+
+```slim
+= set_breadcrumb_item(url: '/products', name: 'Products')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ukstudio/structured_data.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "structured_data"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/structured-data.rb

@@ -0,0 +1 @@
+require 'structured_data'

data/lib/structured_data.rb

@@ -0,0 +1,138 @@
+require 'action_controller'
+require 'action_view'
+require 'json'
+
+module StructuredData
+  module ViewHelper
+    def repository
+      @structured_data_repository ||= StructuredData::Repository.new
+    end
+
+    def breadcrumb_list
+      @breadcrumb_list ||= StructuredData::BreadcrumbList.new
+    end
+
+    def set_breadcrumb_item(url:, name:)
+      breadcrumb_list << { url: url, name: name }
+    end
+
+    def site_navigation_element
+      @site_navigation_element ||= StructuredData::SiteNavigationElement.new
+    end
+
+    def set_site_navigation_element(url:, name:)
+      site_navigation_element << { url: url, name: name }
+    end
+
+    def display_strctured_data
+      repository << breadcrumb_list unless breadcrumb_list.empty?
+      repository << site_navigation_element unless site_navigation_element.empty?
+
+      self.content_tag(:script, repository.dump.html_safe, type: 'application/ld+json')
+    end
+  end
+
+  module ControllerHelper
+    def breadcrumb_list
+      @breadcrumb_list ||= StructuredData::BreadcrumbList.new
+    end
+
+    def set_breadcrumb_item(url:, name:)
+      breadcrumb_list << { url: url, name: name }
+    end
+
+    def site_navigation_element
+      @site_navigation_element ||= StructuredData::SiteNavigationElement.new
+    end
+
+    def set_site_navigation_element(url:, name:)
+      site_navigation_element << { url: url, name: name }
+    end
+  end
+
+  class Repository
+    def initialize
+      @items = []
+    end
+
+    def <<(item)
+      @items << item
+    end
+
+    def dump
+      "[" + @items.map(&:dump).join(',') + "]"
+    end
+  end
+
+  class BreadcrumbList
+    def initialize
+      @items = []
+    end
+
+    def <<(item)
+      @items << item
+    end
+
+    def empty?
+      @items.empty?
+    end
+
+    def dump
+      hash = {
+        "@context": "http://schema.org",
+        "@type": "BreadcrumbList",
+      }
+
+      hash['itemListElement'] = items_to_hash
+      JSON.pretty_generate(hash)
+    end
+
+    private
+
+    def items_to_hash
+      @items.map.with_index do |item, i|
+        {
+          "@type": "ListItem",
+          "position": i + 1,
+          "item": {
+            "@id": item[:url],
+            "name": item[:name]
+          }
+        }
+      end
+    end
+  end
+
+  class SiteNavigationElement
+    def initialize
+      @urls  = []
+      @names = []
+    end
+
+    def <<(item)
+      @urls  << item[:url]
+      @names << item[:name]
+
+      item
+    end
+
+    def empty?
+      @urls.empty? && @names.empty?
+    end
+
+    def dump
+      hash = {
+        "@context": "http://schema.org",
+        "@type": "SiteNavigationElement",
+      }
+
+      hash[:url] = @urls
+      hash[:name] = @names
+
+      JSON.pretty_generate(hash)
+    end
+  end
+end
+
+ActionView::Base.send :include, StructuredData::ViewHelper
+ActionController::Base.send :include, StructuredData::ControllerHelper

data/lib/structured_data/version.rb

@@ -0,0 +1,3 @@
+module StructuredData
+  VERSION = "0.1.0"
+end

data/structured_data.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structured_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structured-data"
+  spec.version       = StructuredData::VERSION
+  spec.authors       = ["AKAMATSU Yuki"]
+  spec.email         = ["y.akamatsu@ukstudio.jp"]
+
+  spec.summary       = %q{A generator of structured data for SEO}
+  spec.description   = %q{Generate JSON+LD for Google Structured Data}
+  spec.homepage      = "https://github.com/ukstudio/structured-data"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "actionpack"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: structured-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AKAMATSU Yuki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Generate JSON+LD for Google Structured Data
+email:
+- y.akamatsu@ukstudio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/structured-data.rb
+- lib/structured_data.rb
+- lib/structured_data/version.rb
+- structured_data.gemspec
+homepage: https://github.com/ukstudio/structured-data
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A generator of structured data for SEO
+test_files: []