breadcrumbs_on_rails-json_ld 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b6de520c8eb43e4ca8b7b579b902dc47b3ef6ba
+  data.tar.gz: 4acd835273f87f4ae8bb0a82bdc6e4244542c79a
+SHA512:
+  metadata.gz: bb9ecc8e0436faa5cd4fe4bc5a37e3296cd5ba2435fd34101524707a63c4d13659878e3cb7c87f3daa12f6f825b339e5b23db629c3da42895b926fd91bc8f054
+  data.tar.gz: 97b4653ce07249815db1b751efc429c78f9176d5ab6b88c1ec6dcd3a60842e54d367d75c55ea08e2145a7d566ab7ee8485a444ed5b5820b35f2a914bf292ffea

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 necojackarc
+
+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,37 @@
+# BreadcrumbsOnRails::JsonLd
+BreadcrumbsOnRails::JsonLd provides a custom builder for [BreadcrumbsOnRails](https://github.com/weppos/breadcrumbs_on_rails).
+
+## Usage
+Pass `builder: BreadcrumbsOnRails::JsonLd::Builder` option to `render_breadcrumbs` and
+enclose them with `script type="application/ld+json"` tag as follows:
+
+```erb
+<script type="application/ld+json">
+  <%= render_breadcrumbs builder: BreadcrumbsOnRails::JsonLd::Builder %>
+</script>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'breadcrumbs_on_rails-json_ld'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install breadcrumbs_on_rails-json_ld
+```
+
+## TODO
+* Adopt RuboCop
+* Adopt RSpec
+* Add tests
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BreadcrumbsOnRails::JsonLd'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/breadcrumbs_on_rails/json_ld.rb

@@ -0,0 +1 @@
+require "breadcrumbs_on_rails/json_ld/builder"

data/lib/breadcrumbs_on_rails/json_ld/builder.rb

@@ -0,0 +1,29 @@
+require "breadcrumbs_on_rails"
+
+module BreadcrumbsOnRails
+  module JsonLd
+    class Builder < BreadcrumbsOnRails::Breadcrumbs::Builder
+      def render
+        JSON.pretty_generate(
+          "@context" => "http://schema.org",
+          "@type" => "BreadcrumbList",
+          "itemListElement" =>
+            @elements.map.with_index(1) { |elt, idx| render_element(elt, idx) },
+        )
+      end
+
+      private
+
+      def render_element(element, index)
+        {
+          "@type" => "ListItem",
+          "position" => index,
+          "item" => {
+            "@id" => "#{@context.root_url.chop}#{compute_path(element)}",
+            "name" => compute_name(element),
+          },
+        }
+      end
+    end
+  end
+end

data/lib/breadcrumbs_on_rails/json_ld/version.rb

@@ -0,0 +1,5 @@
+module BreadcrumbsOnRails
+  module JsonLd
+    VERSION = '1.0.0'
+  end
+end

data/lib/tasks/breadcrumbs_on_rails/json_ld_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :breadcrumbs_on_rails_json_ld do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: breadcrumbs_on_rails-json_ld
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- necojackarc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: breadcrumbs_on_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: JSON-LD plugin for Breadcrumbs on Rails
+email:
+- necojackarc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/breadcrumbs_on_rails/json_ld.rb
+- lib/breadcrumbs_on_rails/json_ld/builder.rb
+- lib/breadcrumbs_on_rails/json_ld/version.rb
+- lib/tasks/breadcrumbs_on_rails/json_ld_tasks.rake
+homepage: https://github.com/necojackarc/breadcrumbs_on_rails-json_ld
+licenses:
+- MIT
+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.6.13
+signing_key: 
+specification_version: 4
+summary: JSON-LD plugin for Breadcrumbs on Rails
+test_files: []