seory 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4ad5a6d00f1d68662b39cb9716d1146b182688c
-  data.tar.gz: 847f039ab50d26b966e03b1f1175554d77ee6cb2
+  metadata.gz: 679ed7e93f25e0539660873f3b4ad92d89327082
+  data.tar.gz: 514f420b0f775555ee3d736120aa7c4a898e1bd1
 SHA512:
-  metadata.gz: 912cc7524283289708d5d852510c9a077dd60093521521a3eff1bb759891404abdf405b10e55fdb6e06255124047dcf1a622b00b5fcf50b440acb41e5f85810b
-  data.tar.gz: 8f64f9624cc492e8537d2e75b69c77595e4050c44c10d870cef44ac17134b2123a1f78a48467606c0524d2d6466399e802e72089a355592dbb1770013c995a4a
+  metadata.gz: 66e97190536b1dd87c7b3396a9d3c93e23da823530965565e399266d2a9f8680c358f1b00ec7ed19a8da1687902d2403ac4ef46c96e5119fb50f563368a2b19e
+  data.tar.gz: 50eb55d2c9df67fd68c8c2fb0e6b6271a96b32cda1dedac10a09fd6e0e6f3e61704594f3e46b125f1076640786d5f9225088e7af5190fac436caa9034dca4ac1

data/.travis.yml

@@ -3,6 +3,8 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+env:
+  - secure: "d3P4g1NRNxoCuhCHaqpNI6Khe6d/5jYpR0VJoxAvw5n2c46KuMn91IMTmTAF73vb7n8kQAXA347x53KBdgsBlmm6upaBKG8NrWiLgO16frTlmtUf1ng6VZzM3vqQjjo1YZLhM+kk3AoXgqZsSMwfgOo9BFQj6fYRwlveuJ+vrVM="
 notifications:
   webhooks:
     - https://idobata.io/hook/061179f9-4f3c-4c8c-bdf9-4efa9821c5c5

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rspec', '>= 3.0.0'
+gem 'codeclimate-test-reporter', group: :test, require: false

data/README.md

@@ -1,5 +1,8 @@
 # seory
 
+[![Build Status](https://travis-ci.org/esminc/seory.svg?branch=master)](https://travis-ci.org/esminc/seory)
+[![Code Climate](https://codeclimate.com/github/esminc/seory.png)](https://codeclimate.com/github/esminc/seory)
+
 Manage SEO contents in Rails app. based on controller, action and more complex context.
 
 ## Installation
@@ -22,19 +25,19 @@ 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] {
-  title:    'Great products | My Great Site[MGS]'
-  desc:     'A lot of greate products'
+match *%w[products#popular products#new_release] do
+  title            'Great products | My Great Site[MGS]'
+  meta_description 'A lot of great products'
 
-  keywords: %w[Software Internet Service]
+  meta_keywords    %w[Software Internet Service].join(',')
 
-  h1:       'Most popular products'
-}
+  h1               'Most popular products'
+end
 
 # Can contain dynamic content based on controller using assigned ivar
-match slug('brands#show') {
-  title { assign(:brand).name }
-}
+match slug('brands#show') do
+  title { assigns(:brand).name }
+end
 
 # Match with request fullpath
 match path('/products/special-product') do
@@ -43,26 +46,26 @@ end
 
 # Custom lookup rule with controller
 match(->(controller) { controller.params[:page].to_i == 1 }) do
-  keywords do
-    search = assign(:search_object)
+  meta_keywords do
+    search = assigns(:search_object)
 
     # do something
   end
 end
 
 # Use custom word part
-match slug(products#index) do
+match slug('products#index') do
   misc(:page_name) { "#{controller.params[:page].to_i} page | Good products") }
 
-  title  :page_name
-  h1     :page_name
+  title :page_name
+  h1    :page_name
 
-  desc   { "Page for #{page_name}" }
+  meta_description { "Page for #{page_name}" }
 }
 
 default do
-  title  'My Great Service'
-  h1     { I18n.t("#{controller_name}.h1", scope: 'label.misc_pages' }
+  title 'My Great Service'
+  h1    { I18n.t("#{controller_name}.h1", scope: 'label.misc_pages' }
 end
 ```
 

data/lib/seory.rb

@@ -1,10 +1,31 @@
-require "seory/version"
+require 'seory/version'
+require 'seory/railtie' if defined?(Rails)
+require 'active_support/all'
 
 module Seory
   CONTENTS = %w[title h1 h2 meta_description meta_keywords canonical_url og_image_url].map(&:to_sym)
 
-  class Error < RuntimeError
-  end
+  class Error < RuntimeError; end
+
+  autoload :Dsl,'seory/dsl'
+
+  mattr_accessor(:config_dir) { 'config/seory' }
+  self.config_dir = 'config/seory'
+
+  class << self
+    def describe(*args, &block)
+      @object ||= Object.new.tap {|obj| obj.extend Seory::Dsl }
 
-  autoload :Dsl, 'seory/dsl'
+      @object.describe(*args, &block)
+    end
+    alias seo_content describe
+
+    def helper(&block)
+      @object.helper(&block)
+    end
+
+    def default_repository
+      @object.send(:seory_repository)
+    end
+  end
 end

data/lib/seory/condition.rb

@@ -0,0 +1,29 @@
+require 'seory'
+require 'seory/condition/block'
+require 'seory/condition/params'
+require 'seory/condition/path'
+require 'seory/condition/slug'
+
+module Seory
+  module Condition
+    class SupposionFailed < Seory::Error; end
+    extend self
+
+    def [](condition)
+      if condition.respond_to?(:match?)
+        condition
+      else
+        suppose(condition)
+      end
+    end
+
+    private
+
+    def suppose(condition)
+      condition_class = [Params, Slug].detect {|klass| klass.supposable?(condition) }
+      raise SupposionFailed.new(condition.inspect) unless condition_class
+
+      condition_class.new(condition)
+    end
+  end
+end

data/lib/seory/{page_condition/block_condition.rb → condition/block.rb}

@@ -1,6 +1,6 @@
 module Seory
-  module PageCondition
-    class BlockCondition
+  module Condition
+    class Block
       def initialize(block)
         @block = block
       end

data/lib/seory/condition/build_dsl.rb

@@ -0,0 +1,19 @@
+require 'seory/condition'
+
+module Seory
+  module Condition
+    module BuildDsl
+      def slug(slug)
+        Slug.new(slug)
+      end
+
+      def path(path)
+        Path.new(path)
+      end
+
+      def params(params)
+        Params.new(params)
+      end
+    end
+  end
+end

data/lib/seory/{page_condition/params_condition.rb → condition/params.rb}

@@ -1,6 +1,6 @@
 module Seory
-  module PageCondition
-    class ParamsCondition
+  module Condition
+    class Params
       def self.supposable?(condition_object)
         condition_object.is_a?(Hash)
       end

data/lib/seory/{page_condition/path_condition.rb → condition/path.rb}

@@ -1,6 +1,6 @@
 module Seory
-  module PageCondition
-    class PathCondition
+  module Condition
+    class Path
       def initialize(path, exact_match = false)
         @path        = path
         @exact_match = exact_match

data/lib/seory/{page_condition/slug_condition.rb → condition/slug.rb}

@@ -1,6 +1,6 @@
 module Seory
-  module PageCondition
-    class SlugCondition
+  module Condition
+    class Slug
       def self.supposable?(condition_object)
         controller, action = condition_object.to_s.split('#')
         controller && action
@@ -14,8 +14,10 @@ module Seory
         action_slug(controller) == @slug
       end
 
+      private
+
       def action_slug(controller)
-        [controller.controller_name, controller.action_name].join('#')
+        [controller.controller_path, controller.action_name].join('#')
       end
     end
   end

data/lib/seory/dsl.rb

@@ -1,65 +1,28 @@
 require 'seory'
-require 'seory/page_contents'
-require 'seory/page_condition/build_dsl'
 require 'seory/repository'
 
 module Seory
   module Dsl
+    def describe(group_name = Repository.extract_label_from_trace(caller), &block)
+      seory_repository << Descriptor.new(group_name, seory_repository).describe(&block)
+    end
+    alias seo_content describe
 
-    def describe(&block)
-      @repository = Repository.new
-      Descriptor.new(@repository).describe(&block)
+    def helper(&block)
+      seory_repository.helper = Module.new(&block)
     end
 
     def lookup(controller)
-      @repository.lookup(controller)
+      seory_repository.lookup(controller)
     end
 
-    class PageContentsBuilder
-      def initialize(*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)
-        instance_exec(&block)
-
-        @page_contents
-      end
+    private
 
-      def misc(name, val = nil, &block)
-        @page_contents.define(name, val, &block)
-      end
-
-      Seory::CONTENTS.each do |name|
-        define_method(name) {|val = nil, &block| misc(name, val, &block) }
-      end
+    def seory_repository
+      @__seory_repository ||= Repository.new
     end
 
-    class Descriptor
-      include Seory::PageCondition::BuildDsl
-
-      def initialize(repository)
-        @repository = repository
-      end
-
-      def describe(&block)
-        instance_exec(&block)
-
-        @repository
-      end
-
-      def match(*conditions, &def_builder)
-        @repository << PageContentsBuilder.new(*conditions).build!(&def_builder)
-      end
-
-      def default(&def_builder)
-        match(:default, &def_builder)
-      end
-    end
+    autoload :PageBuilder, 'seory/dsl/page_builder'
+    autoload :Descriptor,  'seory/dsl/descriptor'
   end
 end

data/lib/seory/dsl/descriptor.rb

@@ -0,0 +1,29 @@
+require 'seory/page_group'
+require 'seory/condition/build_dsl'
+
+module Seory
+  module Dsl
+    class Descriptor
+      include Seory::Condition::BuildDsl
+
+      def initialize(group_name, repository)
+        @page_group = PageGroup.new(group_name)
+        @repository = repository
+      end
+
+      def describe(&block)
+        instance_exec(&block)
+
+        @page_group
+      end
+
+      def match(*conditions, &def_builder)
+        @page_group.add PageBuilder.new(*conditions).build!(&def_builder)
+      end
+
+      def default(&def_builder)
+        @page_group.default = PageBuilder.new(:default).build!(&def_builder)
+      end
+    end
+  end
+end

data/lib/seory/dsl/page_builder.rb

@@ -0,0 +1,35 @@
+require 'seory'
+require 'seory/page'
+
+module Seory
+  module Dsl
+    class PageBuilder
+      def initialize(*conditions)
+        @page_contents =
+          if conditions.size == 1 && (block = conditions.first).is_a?(Proc)
+            Page.new(&block)
+          else
+            Page.new(*conditions)
+          end
+      end
+
+      def build!(&block)
+        instance_exec(&block)
+
+        @page_contents
+      end
+
+      def misc(name, val = nil, &block)
+        @page_contents.define(name, val, &block)
+      end
+
+      def assign_reader(*names)
+        @page_contents.assign_reader(*names)
+      end
+
+      Seory::CONTENTS.each do |name|
+        define_method(name) {|val = nil, &block| misc(name, val, &block) }
+      end
+    end
+  end
+end

data/lib/seory/page.rb

@@ -0,0 +1,53 @@
+require 'seory'
+require 'seory/condition'
+
+module Seory
+  class EmptyCondition < ::Seory::Error; end
+  class AccessorNameTaken < ::Seory::Error; end
+
+  class Page
+
+    attr_reader :assign_name_accessors
+
+    def initialize(*conditions, &block)
+      @conditions  =
+        if block_given?
+          [Condition::Block.new(block)]
+        elsif conditions.first == :default
+          :default
+        else
+          conditions.map {|condition| Seory::Condition[condition] }
+        end
+
+      raise EmptyCondition if @conditions.blank?
+
+      @contents, @assign_name_accessors = {}, []
+    end
+
+    def define(name, value = nil, &block)
+      @contents[name] = block_given? ? block : value
+    end
+
+    def assign_reader(*assign_names)
+      if (taken = Seory::CONTENTS & assign_names).size > 0
+        raise AccessorNameTaken, taken.join(', ')
+      end
+
+      assign_name_accessors.concat(assign_names)
+    end
+
+    def content_for(name)
+      @contents[name]
+    end
+
+    def match?(controller)
+      return true if default?
+
+      @conditions.any? {|condition| condition.match?(controller) }
+    end
+
+    def default?
+      @conditions == :default
+    end
+  end
+end

data/lib/seory/page_group.rb

@@ -0,0 +1,15 @@
+module Seory
+  class PageGroup
+    attr_accessor :default
+    attr_reader   :name, :pages
+
+    def initialize(name)
+      @name  = name
+      @pages = []
+    end
+
+    def add(page)
+      @pages << page
+    end
+  end
+end