gretel-jsonld 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d3c3259c95025ca3013246ffef2562de36cd01d
+  data.tar.gz: cac38755ad0fafd73912c5e46c8f95900a9c70fa
+SHA512:
+  metadata.gz: 2e20f0fa070a8350e10ae6bb0b8aac604e90b5ce58c167fd914159cee6722a0a1a5b8c3cedc9338324c6ea59f0a282ca729059fe589e5bf8e15c9ff32dd9c80d
+  data.tar.gz: 8232b6731349a1bb5d49b6b8c510a2bc595d3d72314bf3837756e60d3737ba8dc1c633612a742d34876bd1aaa353d9da53835aedcd7fb98f9e12d703556b506f

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# CHANGELOG
+## [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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 yasaichi
+
+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,28 @@
+# Gretel::Jsonld
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gretel-jsonld'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install gretel-jsonld
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,24 @@
+# frozen_string_literal: true
+
+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    = "Gretel::Jsonld"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+
+
+
+
+
+require "bundler/gem_tasks"

data/lib/gretel/jsonld.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "gretel/jsonld/version"
+
+if defined?(Rails)
+  require "gretel/jsonld/railtie"
+else
+  require "gretel/jsonld/view_helpers"
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "json"
+require "gretel/jsonld/breadcrumb/list_item"
+
+module Gretel
+  module Jsonld
+    module Breadcrumb
+      class List
+        def initialize(link_collection)
+          @link_collection = link_collection
+        end
+
+        def to_json(*args)
+          {
+            "@context": "http://schema.org",
+            "@type": "BreadcrumbList",
+            itemListElement: item_list_element,
+          }.to_json(*args)
+        end
+
+        private
+
+        def item_list_element
+          @link_collection.map.with_index(1) do |link, index|
+            ::Gretel::Jsonld::Breadcrumb::ListItem.new(
+              id: link.url,
+              name: link.text,
+              position: index,
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Gretel
+  module Jsonld
+    module Breadcrumb
+      class ListItem
+        def initialize(id:, name:, position:)
+          @id = id
+          @name = name
+          @position = position
+        end
+
+        def to_json(*args)
+          {
+            "@type": "ListItem",
+            position: @position,
+            item: {
+              "@id": @id,
+              name: @name,
+            }
+          }.to_json(*args)
+        end
+      end
+    end
+  end
+end

data/lib/gretel/jsonld/railtie.rb

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

data/lib/gretel/jsonld/renderer.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "json"
+require "gretel/jsonld/breadcrumb/list"
+
+module Gretel
+  module Jsonld
+    class Renderer
+      def initialize(view_context)
+        @view_context = view_context
+      end
+
+      def render(link_collection)
+        return "" if link_collection.empty?
+
+        @view_context.content_tag(
+          :script,
+          JSON.generate(::Gretel::Jsonld::Breadcrumb::List.new(link_collection)).html_safe,
+          type: "application/ld+json",
+        )
+      end
+    end
+  end
+end

data/lib/gretel/jsonld/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gretel
+  module Jsonld
+    VERSION = "0.1.0"
+  end
+end

data/lib/gretel/jsonld/view_helpers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "action_view"
+require "gretel"
+require "gretel/jsonld/renderer"
+
+module Gretel
+  module Jsonld
+    module ViewHelpers
+      def jsonld_breadcrumbs(options = {})
+        gretel_jsonld_renderer.render(breadcrumbs(options))
+      end
+
+      private
+
+      def gretel_jsonld_renderer
+        @_gretel_jsonld_renderer ||= ::Gretel::Jsonld::Renderer.new(self)
+      end
+    end
+  end
+end
+
+ActionView::Base.include(Gretel::Jsonld::ViewHelpers)

data/lib/tasks/gretel/jsonld_tasks.rake

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

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: gretel-jsonld
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yasaichi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gretel
+  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: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: reek
+  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: rspec-rails
+  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: rubocop
+  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: gretel-json-ld enables gretel gem to handle JSON-LD based breadcrumbs.
+email:
+- yasaichi@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/gretel/jsonld.rb
+- lib/gretel/jsonld/breadcrumb/list.rb
+- lib/gretel/jsonld/breadcrumb/list_item.rb
+- lib/gretel/jsonld/railtie.rb
+- 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
+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: Gretel extension for supporting JSON-LD breadcrumbs
+test_files: []