seory 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31a71be5bea7d32b2895e6b280c50db69074f284
-  data.tar.gz: e313695b9b65b658367267bcc5c9a89d82b151d9
+  metadata.gz: e4ad5a6d00f1d68662b39cb9716d1146b182688c
+  data.tar.gz: 847f039ab50d26b966e03b1f1175554d77ee6cb2
 SHA512:
-  metadata.gz: 92c72d830486a8487178f108e7d9459c7aad9ebab926668263f1f9460f0846212f17fe2115b88fbeca780fb89a989d3307ce7c93edf97598994381148f701e5c
-  data.tar.gz: efd6daee3a8d918db5c596adf39f9da80fb4e6ad75825b195e99ca4069e04055bbbec103e20728030ecba3bb7d0cb32e0b5969e62f1f2289f8630ab7b6c78533
+  metadata.gz: 912cc7524283289708d5d852510c9a077dd60093521521a3eff1bb759891404abdf405b10e55fdb6e06255124047dcf1a622b00b5fcf50b440acb41e5f85810b
+  data.tar.gz: 8f64f9624cc492e8537d2e75b69c77595e4050c44c10d870cef44ac17134b2123a1f78a48467606c0524d2d6466399e802e72089a355592dbb1770013c995a4a

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+notifications:
+  webhooks:
+    - https://idobata.io/hook/061179f9-4f3c-4c8c-bdf9-4efa9821c5c5
+

data/README.md

@@ -1,6 +1,6 @@
-# Seory
+# seory
 
-Manage SEO contets in Rails app. based on controller, action and more complex context.
+Manage SEO contents in Rails app. based on controller, action and more complex context.
 
 ## Installation
 
@@ -22,7 +22,7 @@ Specify SEO content as ruby code.  For example, `config/initializers/seory.rb`
 
 ```ruby
 # Specify SEO content based on `controller#action` rule
-match %w[products#popular products#new_release], {
+match *%w[products#popular products#new_release] {
   title:    'Great products | My Great Site[MGS]'
   desc:     'A lot of greate products'
 
@@ -32,22 +32,27 @@ match %w[products#popular products#new_release], {
 }
 
 # Can contain dynamic content based on controller using assigned ivar
-match 'brands#show' {
+match slug('brands#show') {
   title { assign(:brand).name }
 }
 
+# Match with request fullpath
+match path('/products/special-product') do
+  title 'Special Product Detail'
+end
+
 # Custom lookup rule with controller
-match ->(controller) { controller.params[:page].to_i == 1 }, {
+match(->(controller) { controller.params[:page].to_i == 1 }) do
   keywords do
     search = assign(:search_object)
 
     # do something
   end
-}
+end
 
-# [TODO] Use custom word part
-match %w[products#index] do
-  page_name { "#{page_part} Good products") }
+# Use custom word part
+match slug(products#index) do
+  misc(:page_name) { "#{controller.params[:page].to_i} page | Good products") }
 
   title  :page_name
   h1     :page_name
@@ -69,6 +74,7 @@ module ApplicationHelper
   # which returns Seory::Runtime object with configured
   include Seory::Helper
 end
+```
 
 ```haml
 %html

data/lib/seory/dsl.rb

@@ -1,5 +1,6 @@
 require 'seory'
 require 'seory/page_contents'
+require 'seory/page_condition/build_dsl'
 require 'seory/repository'
 
 module Seory
@@ -16,7 +17,12 @@ module Seory
 
     class PageContentsBuilder
       def initialize(*conditions)
-        @page_contents = PageContents.new(*conditions)
+        @page_contents =
+          if conditions.size == 1 && (block = conditions.first).is_a?(Proc)
+            PageContents.new(&block)
+          else
+            PageContents.new(*conditions)
+          end
       end
 
       def build!(&block)
@@ -35,6 +41,8 @@ module Seory
     end
 
     class Descriptor
+      include Seory::PageCondition::BuildDsl
+
       def initialize(repository)
         @repository = repository
       end

data/lib/seory/page_condition/block_condition.rb

@@ -0,0 +1,13 @@
+module Seory
+  module PageCondition
+    class BlockCondition
+      def initialize(block)
+        @block = block
+      end
+
+      def match?(controller)
+        @block.call(controller)
+      end
+    end
+  end
+end

data/lib/seory/page_condition/build_dsl.rb

@@ -0,0 +1,19 @@
+require 'seory/page_condition'
+
+module Seory
+  module PageCondition
+    module BuildDsl
+      def slug(slug)
+        SlugCondition.new(slug)
+      end
+
+      def path(path)
+        PathCondition.new(path)
+      end
+
+      def params(params)
+        ParamsCondition.new(params)
+      end
+    end
+  end
+end

data/lib/seory/page_condition/default_condition.rb

@@ -0,0 +1,10 @@
+module Seory
+  module PageCondition
+    class DefaultCondition
+      def match?(controller)
+        true
+      end
+    end
+  end
+end
+

data/lib/seory/page_condition/params_condition.rb

@@ -0,0 +1,17 @@
+module Seory
+  module PageCondition
+    class ParamsCondition
+      def self.supposable?(condition_object)
+        condition_object.is_a?(Hash)
+      end
+
+      def initialize(params)
+        @params = params
+      end
+
+      def match?(controller)
+        @params.all? {|k, v| controller.params[k] == v }
+      end
+    end
+  end
+end

data/lib/seory/page_condition/path_condition.rb

@@ -0,0 +1,14 @@
+module Seory
+  module PageCondition
+    class PathCondition
+      def initialize(path, exact_match = false)
+        @path        = path
+        @exact_match = exact_match
+      end
+
+      def match?(controller)
+        controller.request.fullpath.start_with?(@path)
+      end
+    end
+  end
+end

data/lib/seory/page_condition/slug_condition.rb

@@ -0,0 +1,22 @@
+module Seory
+  module PageCondition
+    class SlugCondition
+      def self.supposable?(condition_object)
+        controller, action = condition_object.to_s.split('#')
+        controller && action
+      end
+
+      def initialize(slug)
+        @slug = slug
+      end
+
+      def match?(controller)
+        action_slug(controller) == @slug
+      end
+
+      def action_slug(controller)
+        [controller.controller_name, controller.action_name].join('#')
+      end
+    end
+  end
+end

data/lib/seory/page_condition.rb

@@ -0,0 +1,32 @@
+require 'seory'
+require 'seory/page_condition/block_condition'
+require 'seory/page_condition/default_condition'
+require 'seory/page_condition/params_condition'
+require 'seory/page_condition/path_condition'
+require 'seory/page_condition/slug_condition'
+
+module Seory
+  module PageCondition
+    class SupposionFailed < Seory::Error; end
+    extend self
+
+    def [](condition)
+      if condition == :default
+        DefaultCondition.new
+      elsif condition.respond_to?(:match?)
+        condition
+      else
+        suppose(condition)
+      end
+    end
+
+    private
+
+    def suppose(condition)
+      klass = [ParamsCondition, SlugCondition].detect {|klass| klass.supposable?(condition) }
+      raise SupposionFailed.new(condition.inspect) unless klass
+
+      klass.new(condition)
+    end
+  end
+end

data/lib/seory/page_contents.rb

@@ -1,4 +1,6 @@
 require 'seory'
+require 'seory/page_condition'
+
 require 'active_support/all'
 
 module Seory
@@ -6,7 +8,13 @@ module Seory
 
   class PageContents
     def initialize(*conditions, &block)
-      @conditions  = block_given? ? block : conditions
+      @conditions  =
+        if block_given?
+          [PageCondition::BlockCondition.new(block)]
+        else
+          conditions.map {|condition| Seory::PageCondition[condition] }
+        end
+
       raise EmptyCondition if @conditions.blank?
 
       @contents = {}
@@ -21,19 +29,13 @@ module Seory
     end
 
     def match?(controller)
-      return true if @conditions == [:default]
+      return true if default?
 
-      if @conditions.respond_to?(:call)
-        @conditions.call(controller)
-      else
-        @conditions.include?(action_slug(controller))
-      end
+      @conditions.any? {|condition| condition.match?(controller) }
     end
 
-    private
-
-    def action_slug(controller)
-      [controller.controller_name, controller.action_name].join('#')
+    def default?
+      @conditions.all? {|c| c.is_a?(Seory::PageCondition::DefaultCondition) }
     end
   end
 end

data/lib/seory/repository.rb

@@ -12,7 +12,12 @@ module Seory
 
     def lookup(controller)
       page_contents = @store.detect {|page| page.match?(controller) }
-      Seory::Runtime.new(page_contents, controller)
+
+      Seory::Runtime.new(page_contents, controller, default)
+    end
+
+    def default
+      @store.detect(&:default?)
     end
   end
 end

data/lib/seory/runtime.rb

@@ -8,9 +8,10 @@ module Seory
 
     attr_reader :controller
 
-    def initialize(page_contents, controller)
+    def initialize(page_contents, controller, fallback = nil)
       @page_contents = page_contents
       @controller    = controller
+      @fallback      = fallback
     end
 
     def assigns(name)
@@ -28,14 +29,21 @@ module Seory
     private
 
     def calculate_content_for(name)
-      case page_content = @page_contents.content_for(name)
+      case page_content = lookup_content_for(name)
       when String
         page_content
+      when Symbol
+        calculate_content_for(page_content)
       when ->(o) { o.respond_to?(:call) }
         instance_exec(&page_content)
       else
         raise 'BUG'
       end
     end
+
+    def lookup_content_for(name)
+      @page_contents.content_for(name) || \
+      @fallback.try {|fb| fb.content_for(name) }
+    end
   end
 end

data/lib/seory/version.rb

@@ -1,3 +1,3 @@
 module Seory
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/seory/dsl_spec.rb

@@ -2,39 +2,90 @@ require 'spec_helper'
 require 'seory/dsl'
 
 describe Seory::Dsl do
-  let(:seory_class) { Object.new.extend(Seory::Dsl) }
-  before do
-    seory_class.describe do
-      match 'products#index' do
-        title 'My Great Product'
-        h1    'Great Product Name'
-
-        misc :option, 'static optional val'
-      end
+  subject(:seory) { seory_class.lookup(controller) }
+
+  context 'with traditional syntax' do
+    let(:seory_class) { Object.new.extend(Seory::Dsl) }
+    before do
+      seory_class.describe do
+        match ->(c) { c.controller_name == 'reports' } do
+          title 'Useful reports'
+        end
+
+        match 'products#index' do
+          title 'My Great Product'
+          h1    'Great Product Name'
 
-      default do
-        title 'Misc site'
-        h1    { controller.controller_name.upcase }
+          misc :option, 'static optional val'
+        end
 
-        misc(:option) { "dynamic option name at #{controller.controller_name}" }
+        default do
+          title 'Misc site'
+          h1    { controller.controller_name.upcase }
+          h2    'default h2'
+
+          misc(:option) { "dynamic option name at #{controller.controller_name}" }
+        end
       end
     end
-  end
 
-  subject(:seory) { seory_class.lookup(controller) }
+    context 'at reports#index / match with proc' do
+      let(:controller) { double('controller', controller_name: 'reports', action_name: 'index') }
+
+      specify { expect(seory.title).to eq 'Useful reports' }
+    end
+
+    context 'at products#index' do
+      let(:controller) { double('controller', controller_name: 'products', action_name: 'index') }
+
+      specify { expect(seory.title).to eq 'My Great Product' }
+      specify { expect(seory.h1).to eq 'Great Product Name' }
+      specify { expect(seory.misc(:option)).to eq 'static optional val' }
+
+      specify { expect(seory.h2).to eq 'default h2' }
+    end
 
-  context 'at products#index' do
-    let(:controller) { double('controller', controller_name: 'products', action_name: 'index') }
+    context 'at misc#show' do
+      let(:controller) { double('controller', controller_name: 'misc', action_name: 'show') }
 
-    specify { expect(seory.title).to eq 'My Great Product' }
-    specify { expect(seory.h1).to eq 'Great Product Name' }
-    specify { expect(seory.misc(:option)).to eq 'static optional val' }
+      specify { expect(seory.h1).to eq 'MISC' }
+      specify { expect(seory.misc(:option)).to eq 'dynamic option name at misc' }
+    end
   end
 
-  context 'at misc#show' do
-    let(:controller) { double('controller', controller_name: 'misc', action_name: 'show') }
+  context 'with matcher build dsl syntax' do
+    let(:seory_class) { Object.new.extend(Seory::Dsl) }
+    before do
+      seory_class.describe do
+        match path('/products/special-product') do
+          title 'Special Product Detail'
+        end
+
+        match slug('products#show') do
+          title 'Great Product Detail'
+        end
+      end
+    end
+
+    context 'at products#show' do
+      let(:controller) do
+        double('controller', controller_name: 'products', action_name: 'show', params: {id: 42}).tap do |c|
+          allow(c).to receive_message_chain(:request, :fullpath) { '/products/42' }
+        end
+      end
+
+      specify { expect(seory.title).to eq 'Great Product Detail' }
+    end
+
+    context 'at special product with path /products/special-product (although products#show)' do
+      let(:controller) do
+        double('controller', controller_name: 'products', action_name: 'show').tap do |c|
+          allow(c).to receive_message_chain(:request, :fullpath) { '/products/special-product' }
+        end
+      end
 
-    specify { expect(seory.h1).to eq 'MISC' }
-    specify { expect(seory.misc(:option)).to eq 'dynamic option name at misc' }
+      specify { expect(seory.title).to eq 'Special Product Detail' }
+    end
   end
+
 end

data/spec/seory/page_condition/path_condition_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'seory/page_condition/path_condition'
+
+describe Seory::PageCondition::PathCondition do
+  let(:controller) { double('controller') }
+  let(:path_condition) do
+    Seory::PageCondition::PathCondition.new('/users/alice')
+  end
+
+  context 'Accessed to /users/alice (controller: users, action: show, id: alice)' do
+    before do
+      allow(controller).to receive_message_chain(:request, :fullpath) { '/users/alice' }
+    end
+
+    specify { expect(path_condition.match?(controller)).to be_truthy }
+  end
+
+  context 'Accessed to /users/bob (controller: users, action: show, id: bob)' do
+    before do
+      allow(controller).to receive_message_chain(:request, :fullpath) { '/users/bob' }
+    end
+
+    specify { expect(path_condition.match?(controller)).to be_falsy }
+  end
+end

data/spec/seory/page_contents_spec.rb

@@ -26,6 +26,16 @@ describe Seory::PageContents do
 
       specify { expect(seory_def.content_for(:title).call).to eq 'A title' }
     end
+
+    context 'define aliased content' do
+      before do
+        seory_def.define(:title) { 'A title' }
+
+        seory_def.define(:h1, :title)
+      end
+
+      specify { expect(seory_def.content_for(:h1)).to eq :title }
+    end
   end
 
   describe 'condition and #match?' do
@@ -58,5 +68,54 @@ describe Seory::PageContents do
         expect(page_contents.match?(controller)).to be_truthy
       end
     end
+
+    describe 'hash conditions' do
+      let(:controller) { double('controller', params: params.with_indifferent_access) }
+
+      context 'when the condition exactly equals the params' do
+        let(:params) { { "controller" => 'users', "action" => 'show' } }
+        let(:condition) { { controller: 'users', action: 'show' } }
+
+        specify do
+          expect(init_with(condition).match?(controller)).to be_truthy
+        end
+      end
+
+      context 'when the condition is a sub-hash of the params' do
+        let(:params) { { "controller" => 'users', "action" => 'show', "id" => "123" } }
+        let(:condition) { { controller: 'users', action: 'show' } }
+
+        specify do
+          expect(init_with(condition).match?(controller)).to be_truthy
+        end
+      end
+
+      context 'when the condition differs with the params' do
+        let(:params) { { "controller" => 'users', "action" => 'show' } }
+        let(:condition) { { controller: 'users', action: 'index' } }
+
+        specify do
+          expect(init_with(condition).match?(controller)).to be_falsy
+        end
+      end
+    end
+
+    describe 'proc conditions' do
+      let(:page_content) do
+        init_with {|c| c.controller_name == 'users' }
+      end
+
+      specify 'match UsersController' do
+        allow(controller).to receive(:controller_name) { 'users' }
+
+        expect(page_content.match?(controller)).to be_truthy
+      end
+
+      specify 'not match GoodsController' do
+        allow(controller).to receive(:controller_name) { 'goods' }
+
+        expect(page_content.match?(controller)).to be_falsy
+      end
+    end
   end
 end

data/spec/seory/runtime_spec.rb

@@ -46,4 +46,27 @@ describe Seory::Runtime do
 
     specify { expect(seory.title).to eq 'Good Shop with 42 products!' }
   end
+
+  context 'Custom content created by misc()' do
+    before do
+      page_contents.define(:custom, 'custom variable')
+
+      page_contents.define(:title) { misc(:custom).upcase }
+    end
+
+    specify 'it was also accessible from other content' do
+      expect(seory.title).to eq 'CUSTOM VARIABLE'
+    end
+  end
+
+  context 'defined aliased content' do
+    before do
+      page_contents.define(:title) { 'A title' }
+      page_contents.define(:h1, :title)
+    end
+
+    specify 'it was also accessible from other content' do
+      expect(seory.h1).to eq 'A title'
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seory
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - moro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,18 +62,27 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/seory.rb
 - lib/seory/dsl.rb
+- lib/seory/page_condition.rb
+- lib/seory/page_condition/block_condition.rb
+- lib/seory/page_condition/build_dsl.rb
+- lib/seory/page_condition/default_condition.rb
+- lib/seory/page_condition/params_condition.rb
+- lib/seory/page_condition/path_condition.rb
+- lib/seory/page_condition/slug_condition.rb
 - lib/seory/page_contents.rb
 - lib/seory/repository.rb
 - lib/seory/runtime.rb
 - lib/seory/version.rb
 - seory.gemspec
 - spec/seory/dsl_spec.rb
+- spec/seory/page_condition/path_condition_spec.rb
 - spec/seory/page_contents_spec.rb
 - spec/seory/runtime_spec.rb
 - spec/spec_helper.rb
@@ -103,6 +112,7 @@ specification_version: 4
 summary: SEO contents manager for Rails.
 test_files:
 - spec/seory/dsl_spec.rb
+- spec/seory/page_condition/path_condition_spec.rb
 - spec/seory/page_contents_spec.rb
 - spec/seory/runtime_spec.rb
 - spec/spec_helper.rb