gretel-jsonld 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ee0aa4c582e0ed7f3be4f2b3b45a68fbc91b307
-  data.tar.gz: 3c6e4229650d0c54bb5f85a63e6286fc5f929ea8
+  metadata.gz: b148016c75478dd947e087855608b34439be9ba8
+  data.tar.gz: ab4814c23a2a01042724350f8ea5fae3321dab89
 SHA512:
-  metadata.gz: 845201072ef51ec8237ab5c78bb58bb9cafc8b352fdffa1aa1067813fbf05d4983eed2b7a6859cd20c55ca35d3b5482e367d8fcd490f072228911239eef925c1
-  data.tar.gz: 4af53b5deea25b7afd2a95614b0fbef8e677eca5e3bf8d01ee03ccaf60c376d75388805bf6153a7f7789b89148f89f5b71697335820c51285598e3b12b7b8bc3
+  metadata.gz: ccda8ccceb6689db485af211b7ad4d16fefbb17a98f3fcfa0853b6e6545fd3ed696a98a0f1e058f94bec13e16522e1aee4799a820151a376785fe7821cca3447
+  data.tar.gz: cce14c004c513533c2c1b8c83772fc941917da428ebbca6d0c16cb844c21401ac429db8f8f39f444326ebe34a6f912ad3ffd20bfe4bf8e915f7b958addad4786

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
+## [0.2.0](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.2.0) (November 25, 2017)
+* [Write README](https://github.com/yasaichi/gretel-jsonld/pull/7)
+* [Use `JSONLD` as module name instead of `Jsonld`](https://github.com/yasaichi/gretel-jsonld/pull/6)
+* [Specify the required Ruby version](https://github.com/yasaichi/gretel-jsonld/pull/5)
+
 ## [0.1.1](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.1.1) (November 25, 2017)
-* Cope with Rails 4.0 or former
+* [Cope with Rails 4.0 or former](https://github.com/yasaichi/gretel-jsonld/pull/4)
 
 ## [0.1.0](https://github.com/yasaichi/gretel-jsonld/releases/tag/v0.1.0) (November 23, 2017)
 * The initial release to reserve the gem name

data/README.md

@@ -1,11 +1,13 @@
-# Gretel::Jsonld
-Short description and motivation.
+# gretel-jsonld
+[![Gem Version](https://badge.fury.io/rb/gretel-jsonld.svg)](http://badge.fury.io/rb/gretel-jsonld)
+[![Build Status](https://travis-ci.org/yasaichi/gretel-jsonld.svg?branch=master)](https://travis-ci.org/yasaichi/gretel-jsonld)
+[![Code Climate](https://api.codeclimate.com/v1/badges/fc3fd5037eb200bedbf5/maintainability)](https://codeclimate.com/github/yasaichi/gretel-jsonld/maintainability)
+[![Test Coverage](https://codeclimate.com/github/yasaichi/gretel-jsonld/badges/coverage.svg)](https://codeclimate.com/github/yasaichi/gretel-jsonld/coverage)
 
-## Usage
-How to use my plugin.
+gretel-jsonld enables gretel gem to handle JSON-LD based breadcrumbs.
 
 ## Installation
-Add this line to your application's Gemfile:
+Add this line to your application's `Gemfile`:
 
 ```ruby
 gem 'gretel-jsonld'
@@ -16,13 +18,109 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install gretel-jsonld
+## Usage
+First, run the installation generator with:
+
+```sh
+$ rails generate gretel:install
+```
+
+Next, define "crumbs" in `config/breadcrumbs.rb`:
+
+```ruby
+# See also: https://github.com/lassebunk/gretel#more-examples
+
+# Root crumb
+crumb :root do
+  link 'Home', root_path
+end
+
+# Issue list
+crumb :issues do
+  link 'All issues', issues_path
+end
+
+# Issue
+crumb :issue do |issue|
+  link issue.title, issue
+  parent :issues
+end
+```
+
+Then, add this line to your application's layout:
+
+```erb
+<%= jsonld_breadcrumbs %>
 ```
 
+Finally, specify a current breadcrumb in each view:
+
+```erb
+<% breadcrumb :issue, @issue %>
+```
+
+This will generate the following breadcrumbs, marked up with JSON-LD (indented for readability):
+
+```html
+<script type="application/ld+json">
+{
+  "@context":"http://schema.org",
+  "@type":"BreadcrumbList",
+  "itemListElement":[
+    {
+      "@type":"ListItem",
+      "position":1,
+      "item":{
+        "@id":"/",
+        "name":"Home"
+      }
+    },
+    {
+      "@type":"ListItem",
+      "position":2,
+      "item":{
+        "@id":"/issues",
+        "name":"All issues"
+      }
+    },
+    {
+      "@type":"ListItem",
+      "position":3,
+      "item":{
+        "@id":"/issues/46",
+        "name":"My Issue"
+      }
+    }
+  ]
+}
+</script>
+```
+
+## Options
+
+You can pass `jsonld_breadcrumbs` the same options as `breadcrumbs`:
+
+```erb
+<%= jsonld_breadcrumbs link_current_to_request_path: false %>
+```
+
+For further information, please see [gretel's documentation](https://github.com/lassebunk/gretel/blob/master/README.md#options).
+
+## Supported versions
+Note that gretel-jsonld doesn't support all versions of gretel, Ruby and Rails:
+
+* gretel: gretel-jsonld supports __only 3.x__ for now
+* Ruby: gretel 3.x supports __1.9.3 or later__, but gretel-jsonld does __only 2.2.2 or later__
+* Rails: gretel 3.x supports __3.1 or later__, but gretel-jsonld does __only 3.2 or later__
+
 ## Contributing
-Contribution directions go here.
+You should follow the steps below:
+
+1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
+2. Create a feature branch: `git checkout -b add-new-feature`
+3. Commit your changes: `git commit -am 'Add new feature'`
+4. Push the branch: `git push origin add-new-feature`
+4. [Send us a pull request](https://help.github.com/articles/about-pull-requests/)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -10,7 +10,7 @@ require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Gretel::Jsonld"
+  rdoc.title    = "Gretel::JSONLD"
   rdoc.options << "--line-numbers"
   rdoc.rdoc_files.include("README.md")
   rdoc.rdoc_files.include("lib/**/*.rb")

data/lib/gretel/jsonld/breadcrumb/list.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require "json"
+require "active_support"
+require "active_support/json/encoding"
 require "gretel/jsonld/breadcrumb/list_item"
 
 module Gretel
-  module Jsonld
+  module JSONLD
     module Breadcrumb
       class List
         def initialize(link_collection)
@@ -28,7 +30,7 @@ module Gretel
 
         def item_list_element
           @link_collection.map.with_index(1) do |link, index|
-            ::Gretel::Jsonld::Breadcrumb::ListItem.new(
+            ::Gretel::JSONLD::Breadcrumb::ListItem.new(
               id: link.url,
               name: link.text,
               position: index,

data/lib/gretel/jsonld/breadcrumb/list_item.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require "json"
+require "active_support"
+require "active_support/json/encoding"
 
 module Gretel
-  module Jsonld
+  module JSONLD
     module Breadcrumb
       class ListItem
         def initialize(id:, name:, position:)

data/lib/gretel/jsonld/railtie.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require "active_support"
 require "active_support/lazy_load_hooks"
 require "rails/railtie"
 
 module Gretel
-  module Jsonld
+  module JSONLD
     class Railtie < ::Rails::Railtie
       initializer "gretel.jsonld" do
         ::ActiveSupport.on_load(:action_view) do

data/lib/gretel/jsonld/renderer.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require "json"
+require "active_support"
+require "active_support/core_ext/string/output_safety"
 require "gretel/jsonld/breadcrumb/list"
 
 module Gretel
-  module Jsonld
+  module JSONLD
     class Renderer
       def initialize(view_context)
         @view_context = view_context
@@ -15,7 +17,7 @@ module Gretel
 
         @view_context.content_tag(
           :script,
-          JSON.generate(::Gretel::Jsonld::Breadcrumb::List.new(link_collection)).html_safe,
+          JSON.generate(::Gretel::JSONLD::Breadcrumb::List.new(link_collection)).html_safe,
           type: "application/ld+json",
         )
       end

data/lib/gretel/jsonld/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Gretel
-  module Jsonld
-    VERSION = "0.1.1"
+  module JSONLD
+    VERSION = "0.2.0".freeze
   end
 end

data/lib/gretel/jsonld/view_helpers.rb

@@ -5,7 +5,7 @@ require "gretel"
 require "gretel/jsonld/renderer"
 
 module Gretel
-  module Jsonld
+  module JSONLD
     module ViewHelpers
       def jsonld_breadcrumbs(options = {})
         gretel_jsonld_renderer.render(breadcrumbs(options))
@@ -14,10 +14,10 @@ module Gretel
       private
 
       def gretel_jsonld_renderer
-        @_gretel_jsonld_renderer ||= ::Gretel::Jsonld::Renderer.new(self)
+        @_gretel_jsonld_renderer ||= ::Gretel::JSONLD::Renderer.new(self)
       end
     end
   end
 end
 
-ActionView::Base.include(Gretel::Jsonld::ViewHelpers)
+ActionView::Base.include(Gretel::JSONLD::ViewHelpers)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gretel-jsonld
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-24 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gretel
@@ -126,7 +126,6 @@ files:
 - lib/gretel/jsonld/renderer.rb
 - lib/gretel/jsonld/version.rb
 - lib/gretel/jsonld/view_helpers.rb
-- lib/tasks/gretel/jsonld_tasks.rake
 homepage: https://github.com/yasaichi/gretel-jsonld
 licenses:
 - MIT
@@ -139,7 +138,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/tasks/gretel/jsonld_tasks.rake

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-# desc "Explaining what the task does"
-# task :gretel_jsonld do
-#   # Task goes here
-# end