seory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 596af9785f1ff0011c40d7816efbe7ab4bfbdc4e
+  data.tar.gz: e7f043fea0dcebf5175e085e74c7d5340435bda2
+SHA512:
+  metadata.gz: 96abaeb3e7afed6dd3efa2f4e8686ddffc3e6d3e2f2e7c7db348b53d063cb8882eed21ed0c0e0c414cedb936077e16a2021629501ebcecdb15174bc4f0b0c434
+  data.tar.gz: a9e4f15b2ab04800148b5378b7e88476e8241b0829e003407f1de4b705aef185ecb4c80c8b9d324e0562d639b4acdcb7f5667778f395beda378b2ade400412c0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seory.gemspec
+gemspec
+
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 moro
+
+MIT License
+
+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,87 @@
+# Seory
+
+Manage SEO contets in Rails app. based on controller, action and more complex context.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'seory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install seory
+
+## Usage
+
+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'
+
+  keywords: %w[Software Internet Service]
+
+  h1:       'Most popular products'
+}
+
+# Can contain dynamic content based on controller using assigned ivar
+match 'brands#show' {
+  title: -> { assign(:brand).name }
+}
+
+# Custom lookup rule with controller
+match ->(controller) { controller.params[:page].to_i == 1 }, {
+  keywords: -> do
+    search = assign(:search_object)
+
+  end
+}
+
+# [TODO] Use custom word part
+match %w[products#index] do
+  page_name { "#{page_part} Good products") }
+
+  title  :page_name
+  h1     :page_name
+
+  desc   { "Page for #{page_name}" }
+}
+
+default do
+  title  'My Great Service'
+  h1     { I18n.t("#{controller_name}.h1", scope: 'label.misc_pages' }
+end
+```
+
+Then we can use seory in your application.
+```ruby
+module ApplicationHelper
+
+  # provides seory() method,
+  # which returns Seory::Runtime object with configured
+  include Seory::Helper
+end
+
+```haml
+%html
+  %head
+    %title= seory.title
+    ...
+  %body
+    %h1= seory.h1
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/esminc/seory/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/seory/dsl.rb

@@ -0,0 +1,51 @@
+require 'seory/page_contents'
+require 'seory/runtime'
+
+module Seory
+  module Dsl
+    extend self
+
+    def describe(&block)
+      [].tap do |repositories|
+        Descriptor.new(repositories).instance_exec(&block)
+      end
+    end
+
+    def lookup(controller)
+      page_contents = repositories.detect {|page| page.match?(controller) }
+      Seory::Runtime.new(page_contents, controller)
+    end
+
+    class PageContentsBuilder
+      def initialize(*conditions)
+        @page_contents = PageContents.new(*conditions)
+      end
+
+      def build!(&block)
+        instance_exec(&block)
+
+        @page_contents
+      end
+
+      Seory::Runtime::CONTENTS.each do |name|
+        define_method(name) do |val = nil, &block|
+          @page_contents.define(name, val, &block)
+        end
+      end
+    end
+
+    class Descriptor
+      def initialize(repositories)
+        @repositories = repositories
+      end
+
+      def match(*conditions, &def_builder)
+        @repositories << PageContentsBuilder.new(*conditions).build!(&def_builder)
+      end
+
+      def default(&def_builder)
+        match(:default, &def_builder)
+      end
+    end
+  end
+end

data/lib/seory/page_contents.rb

@@ -0,0 +1,39 @@
+require 'seory'
+require 'active_support/all'
+
+module Seory
+  class EmptyCondition < ::Seory::Error; end
+
+  class PageContents
+    def initialize(*conditions, &block)
+      @conditions  = block_given? ? block : conditions
+      raise EmptyCondition if @conditions.blank?
+
+      @contents = {}
+    end
+
+    def define(name, value = nil, &block)
+      @contents[name] = block_given? ? block : value
+    end
+
+    def content_for(name)
+      @contents[name]
+    end
+
+    def match?(controller)
+      return true if @conditions == [:default]
+
+      if @conditions.respond_to?(:call)
+        @conditions.call(controller)
+      else
+        @conditions.include?(action_slug(controller))
+      end
+    end
+
+    private
+
+    def action_slug(controller)
+      [controller.controller_name, controller.action_name].join('#')
+    end
+  end
+end

data/lib/seory/runtime.rb

@@ -0,0 +1,34 @@
+# TODO move somewhere
+require 'active_support/all'
+
+module Seory
+  class Runtime
+    delegate :action_name, to: :controller
+
+    CONTENTS = %w[title h1 h2 meta_description meta_keywords canonical_url image_url].map(&:to_sym)
+
+    attr_reader :controller
+
+    def initialize(page_contents, controller)
+      @page_contents = page_contents
+      @controller    = controller
+    end
+
+    CONTENTS.each do |name|
+      define_method(name) { calculate_content_for(name) }
+    end
+
+    private
+
+    def calculate_content_for(name)
+      case page_content = @page_contents.content_for(name)
+      when String
+        page_content
+      when ->(o) { o.respond_to?(:call) }
+        instance_exec(&page_content)
+      else
+        raise 'BUG'
+      end
+    end
+  end
+end

data/lib/seory/version.rb

@@ -0,0 +1,3 @@
+module Seory
+  VERSION = "0.0.1"
+end

data/lib/seory.rb

@@ -0,0 +1,6 @@
+require "seory/version"
+
+module Seory
+  class Error < RuntimeError
+  end
+end

data/seory.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'seory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seory"
+  spec.version       = Seory::VERSION
+  spec.authors       = ["moro"]
+  spec.email         = ["moronatural@gmail.com"]
+  spec.summary       = %q{SEO contents manager for Rails.}
+  spec.description   = %q{Manage SEO contets in Rails app. based on controller, action and more complex context.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/seory/dsl_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'seory/dsl'
+
+describe Seory::Dsl do
+  before do
+    Seory::Dsl.describe do
+      match 'products#index' do
+        title 'My Great Product'
+        h1    'Great Product Name'
+      end
+
+      default do
+        title 'Misc site'
+        h1    { controller.controller_name.upcase }
+      end
+    end
+  end
+
+  subject(:seory) { Seory::Dsl.lookup(controller) }
+
+  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' }
+  end
+
+  context 'at misc#show' do
+    let(:controller) { double('controller', controller_name: 'misc', action_name: 'show') }
+
+    specify { expect(seory.h1).to eq 'MISC' }
+  end
+end

data/spec/seory/page_contents_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+require 'seory/page_contents'
+
+describe Seory::PageContents do
+  specify 'cant define without condition' do
+    expect { Seory::PageContents.new }.to raise_error(Seory::EmptyCondition)
+  end
+
+  context 'content PageContents' do
+    let(:seory_def) do
+      Seory::PageContents.new(:default)
+    end
+
+    context 'define static content' do
+      before do
+        seory_def.define(:title, 'A title')
+      end
+
+      specify { expect(seory_def.content_for(:title)).to eq 'A title' }
+    end
+
+    context 'define dynamic content' do
+      before do
+        seory_def.define(:title) { 'A title' }
+      end
+
+      specify { expect(seory_def.content_for(:title).call).to eq 'A title' }
+    end
+  end
+
+  describe 'condition and #match?' do
+    def init_with(*args, &block)
+      Seory::PageContents.new(*args, &block)
+    end
+
+    let(:controller) { double('controller', controller_name: 'people', action_name: 'index') }
+
+    specify '`:default` matches everything (stacked in bottom)' do
+      expect(init_with(:default)).to be_match(double('something'))
+    end
+
+    describe 'controller_name#action_name' do
+      specify do
+        expect(init_with('people#index').match?(controller)).to be_truthy
+      end
+
+      specify do
+        expect(init_with('people#show').match?(controller)).to be_falsy
+      end
+
+      specify 'supports some actions' do
+        expect(init_with('people#show', 'people#index').match?(controller)).to be_truthy
+      end
+
+      specify do
+        page_contents = init_with {|c| c.controller_name == 'people' }
+
+        expect(page_contents.match?(controller)).to be_truthy
+      end
+    end
+  end
+end

data/spec/seory/runtime_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'seory/runtime'
+require 'seory/page_contents'
+
+describe Seory::Runtime do
+  let(:seory) do
+    Seory::Runtime.new(page_contents, controller)
+  end
+
+  let(:controller) { double('controller') }
+  let(:page_contents) { Seory::PageContents.new(:default) }
+
+  context 'static content' do
+    before do
+      page_contents.define(:title, 'A title')
+      page_contents.define(:h1,    'Most importatnt HEADER 1')
+    end
+
+    describe '#title' do
+      specify { expect(seory.title).to eq 'A title' }
+    end
+
+    describe '#h1' do
+      specify { expect(seory.h1).to eq 'Most importatnt HEADER 1' }
+    end
+  end
+
+  context 'controller based dynamic content' do
+    before do
+      allow(controller).to receive(:action_name) { 'edit' }
+
+      page_contents.define(:title) { "#{action_name.upcase} | My Site" }
+    end
+
+    describe '#titie' do
+      specify { expect(seory.title).to eq 'EDIT | My Site' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,82 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# (such as loading up an entire rails app) will add to the boot time of your
+# test suite on EVERY test run, even for an individual file that may not need
+# all of that loaded.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # RSpec filters the backtrace by default so as not to be so noisy.
+    # This causes the full backtrace to be printed when running a single
+    # spec file (e.g. to troubleshoot a particular spec failure).
+    config.full_backtrace = true
+
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.formatter = 'doc' if config.formatters.none?
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: seory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- moro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Manage SEO contets in Rails app. based on controller, action and more
+  complex context.
+email:
+- moronatural@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/seory.rb
+- lib/seory/dsl.rb
+- lib/seory/page_contents.rb
+- lib/seory/runtime.rb
+- lib/seory/version.rb
+- seory.gemspec
+- spec/seory/dsl_spec.rb
+- spec/seory/page_contents_spec.rb
+- spec/seory/runtime_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: SEO contents manager for Rails.
+test_files:
+- spec/seory/dsl_spec.rb
+- spec/seory/page_contents_spec.rb
+- spec/seory/runtime_spec.rb
+- spec/spec_helper.rb