structured-data 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c7033a829e9a0a17f4d55d068910ff78ddb0d87
-  data.tar.gz: 8b62bed97d79ee42de7e6190aa02627c609ff4c0
+  metadata.gz: 2a491959be0ade618bd52abbe1041163259835b8
+  data.tar.gz: d4f95162ec89f43777ff7267f73025b8835435cd
 SHA512:
-  metadata.gz: 5989b843b4fedd18aa5d6fbe07ab2c88f1f4609ba2193f3e6febeff35972efe3299dcff0384838544caec6397530089de7657fc40db13196bf1a6584c3f3d547
-  data.tar.gz: fa0c05c53f95e18de9ecc8d4f9770fc66f03cc1eb0de7cf0bb35459a596cbb91e2f9b4b166051f4aa6835e8ef9d339f0f4ab9b3259e4ef999f272cd16a152dce
+  metadata.gz: b991c3ed54fe25b2313a373c8d1ed092fab8ba8dae7c591302c56113bb79caf09601178aef979308522229d1706f89ea8084d031b49c52793addf400952659d9
+  data.tar.gz: 974caba471771dbc0cd7d2fc27c3168b2468cf1cd4c8bd8dac20f5e37ebc9e9351a1e7ded7a0faf06dc5a9f3955262649fde327e42a9b4a8aee8689394bda84f

data/.gitignore

@@ -1,2 +1,3 @@
 .DS_Store
 Gemfile.lock
+pkg

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,142 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude: # 自動生成されるものや外部ライブラリは除外
+    - 'vendor/**/*'
+    - 'db/schema.rb'
+
+#
+# Style
+#
+
+# 日本人なので日本語で書きたいときもある
+Style/AsciiComments:
+  Enabled: false
+
+# case
+# when foo?
+# when bar?
+# end
+# のようなものはcaseで書いたほうが見やすい
+Style/EmptyCaseCondition:
+  Enabled: false
+
+# 明示的に else で nil を返すのはわかりやすいので許可
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+# 複数行でも -> のほうがきれいに見えることが多い
+Style/Lambda:
+  EnforcedStyle: literal
+
+# 区切り文字が2個以上必須になる場合のみ_区切りを必須
+Style/NumericLiterals:
+  MinDigits: 7
+
+# ローカル変数とメソッド呼び出しの区別をつけたほうがわかりやすいことが多い
+Style/RedundantSelf:
+ Enabled: false
+
+# クォートはお好みで
+Style/StringLiterals:
+  Enabled: false
+
+# 意味的に先に否定のロジックを書いた方がわかりやすいケースもある
+Style/UnlessElse:
+  Enabled: false
+
+# 3.0で文字列がデフォルトでfrozenなのを信じてない
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/BlockDelimiters:
+  # メソッドチェインしている場合は複数行でも{}を使いたいので
+  # rubocop -a で変換されないよう除外
+  AutoCorrect: false
+  # expect { }.to で複数行xメソッドチェインが多発するので
+  # specを対象から除外する
+  Exclude:
+    - "spec/**/*.rb"
+
+# 公開ライブラリでもない限り、ドキュメントを書くことはほぼないと考える
+Style/Documentation:
+  Enabled: false
+
+# 代入の後改行したほうが横に長くなりづらく見やすい
+Style/MultilineAssignmentLayout:
+  Enabled: true
+
+# メソッドチェインで複数行になったときにインデントが長く横にのびるため
+# 出来る限り短くなるようにする
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# メソッドチェインで複数行になったときにインデントが長く横にのびるため
+# 出来る限り短くなるようにする
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+#
+# Lint
+#
+
+# 使っていない変数を見つけたい
+Lint/UselessAssignment:
+  Enabled: true
+
+#
+# Metrics
+#
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/BlockNesting:
+  Max: 3
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 100
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 120
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 30
+
+Metrics/BlockLength:
+  # rspec, routesは巨大なブロック不可避なので除外
+  Exclude:
+    - "spec/**/*.rb"
+    - "config/routes.rb"
+
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 7
+
+#
+# Performance
+#
+
+# パフォーマンスのメリットよりcasecmpを使った時のわかりづらさのデメリットのほうが大きい
+Performance/Casecmp:
+  Enabled: false
+

data/README.md

@@ -1,13 +1,11 @@
 # 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'
+gem 'structured-data'
 ```
 
 And then execute:
@@ -16,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install structured_data
+    $ gem install structured-data
 
 ## Usage
 
@@ -58,10 +56,16 @@ repo.dump
 
 ### Rails support
 
-Call the helper method in Controller or View
+```ruby
+# in controller or view
+breadcrumb_list do
+  add url: '/products', name: 'Product'
+  add url: '/products/tshirts, name: 'Tshirt'
+end
+```
 
 ```slim
-= set_breadcrumb_item(url: '/products', name: 'Products')
+= display_structured_data
 ```
 
 ## Contributing

data/lib/structured_data.rb

@@ -1,55 +1,6 @@
-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 = []
@@ -65,14 +16,20 @@ module StructuredData
   end
 
   class BreadcrumbList
+    Item = Struct.new('Item', :url, :name)
+
     def initialize
       @items = []
     end
 
-    def <<(item)
+    def add(item)
       @items << item
     end
 
+    def <<(item)
+      add(item)
+    end
+
     def empty?
       @items.empty?
     end
@@ -87,6 +44,14 @@ module StructuredData
       JSON.pretty_generate(hash)
     end
 
+    def each(&block)
+      @items.map { |i| Item.new(i[:url], i[:name]) }.each(&block)
+    end
+
+    def size
+      @items.size
+    end
+
     private
 
     def items_to_hash
@@ -134,5 +99,4 @@ module StructuredData
   end
 end
 
-ActionView::Base.send :include, StructuredData::ViewHelper
-ActionController::Base.send :include, StructuredData::ControllerHelper
+require 'structured_data/rails_extentions'

data/lib/structured_data/rails_extentions.rb

@@ -0,0 +1,25 @@
+module StructuredData
+  module RailsExtentions
+    def self.included(controller)
+      controller.helper_method :repository
+      controller.helper_method :display_structured_data
+
+      controller.include StructuredData::RailsExtentions::BreadclumbList
+      controller.include StructuredData::RailsExtentions::SiteNavigationElement
+    end
+
+    def repository
+      @structured_data_repository ||= StructuredData::Repository.new
+    end
+
+    def display_structured_data
+      repository << breadcrumb_list unless breadcrumb_list.empty?
+      repository << site_navigation_element unless site_navigation_element.empty?
+
+      view_context.content_tag(:script, repository.dump.html_safe, type: 'application/ld+json')
+    end
+  end
+end
+
+require 'structured_data/rails_extentions/breadcrumb_list'
+require 'structured_data/rails_extentions/site_navigation_element'

data/lib/structured_data/rails_extentions/breadcrumb_list.rb

@@ -0,0 +1,24 @@
+module StructuredData
+  module RailsExtentions
+    module BreadclumbList
+      def self.included(controller)
+        controller.helper_method :breadcrumb_list
+        controller.helper_method :set_breadcrumb_list_item
+      end
+
+      def breadcrumb_list(&block)
+        @breadcrumb_list ||= StructuredData::BreadcrumbList.new
+
+        if block_given?
+          @breadcrumb_list.instance_eval(&block)
+        else
+          @breadcrumb_list
+        end
+      end
+
+      def set_breadcrumb_list_item(url:, name:)
+        breadcrumb_list << { url: url, name: name }
+      end
+    end
+  end
+end

data/lib/structured_data/rails_extentions/site_navigation_element.rb

@@ -0,0 +1,24 @@
+module StructuredData
+  module RailsExtentions
+    module SiteNavigationElement
+      def self.included(controller)
+        controller.helper_method :site_navigation_element
+        controller.helper_method :set_site_navigation_element_item
+      end
+
+      def site_navigation_element
+        @site_navigation_element ||= StructuredData::SiteNavigationElement.new
+
+        if block_given?
+          yield @@site_navigation_element
+        else
+          @site_navigation_element
+        end
+      end
+
+      def set_site_navigation_element_item(url:, name:)
+        site_navigation_element << { url: url, name: name }
+      end
+    end
+  end
+end

data/lib/structured_data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: structured-data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - AKAMATSU Yuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -74,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -82,6 +84,9 @@ files:
 - bin/setup
 - lib/structured-data.rb
 - lib/structured_data.rb
+- lib/structured_data/rails_extentions.rb
+- lib/structured_data/rails_extentions/breadcrumb_list.rb
+- lib/structured_data/rails_extentions/site_navigation_element.rb
 - lib/structured_data/version.rb
 - structured_data.gemspec
 homepage: https://github.com/ukstudio/structured-data