contexts 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 152d6f29d9baeeed0af51ba46574a3f96d37ec7d
-  data.tar.gz: 2138c23ac0adb9f181f82dd7db13499f8ab3c21e
+  metadata.gz: b6b7149a89f0e5a6552c1087d1f58dd8bfa9967c
+  data.tar.gz: f61791aa859430bd5ab8e16f84f5838eef32635c
 SHA512:
-  metadata.gz: 6be9641c3cf6731b5f564c83c87f47ec74e9bdd327369a657f3f91eb474b09a70e77691e2c10a0c3773ad7a51f5a8434d381b706b76eff8b65db5a7375a7487f
-  data.tar.gz: d882b04c68bd96ce2a029bea9ddfbca66a4656e0a028dae2a669406e508ac161805bca7a311c92e14b123cae9ff6761518f53fa95ea83b9c5d517d18275234ce
+  metadata.gz: 18affc6a95b04672cee4d80ee67b4f0ee7062d3abe0e362c90e90aa92ff2e245e4139c8bf52ea8cd3ee4df8cfa878060bc8e28c51b8fc1e07f892046c3e2db7e
+  data.tar.gz: a3443e921fba6200f3f68c09f80e0e1eb9d222f0f633c475eb0817eba6582dce34a55fc8a6692ddc4b183d4e0e52f0d343d44be1e40a45fb486f2cf9d23a3a2d

data/README.md

@@ -3,11 +3,24 @@
 [![Code Climate](https://codeclimate.com/github/kolesnikovde/contexts/badges/gpa.svg)](https://codeclimate.com/github/kolesnikovde/contexts)
 [![Test Coverage](https://codeclimate.com/github/kolesnikovde/contexts/badges/coverage.svg)](https://codeclimate.com/github/kolesnikovde/contexts)
 
-
 # Contexts
 
 This gem provides simple way to reuse routes logic in rails apps.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contexts'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Check out specs and [dummy app](https://github.com/kolesnikovde/contexts/tree/master/spec/dummy).
+
 ## License
 
 Copyright (c) 2014 Kolesnikov Danil

data/lib/contexts.rb

@@ -1,5 +1,4 @@
 require 'contexts/version'
-require 'contexts/base'
 require 'mapper'
 
 module Contexts
@@ -49,8 +48,10 @@ module Contexts
   end
 
   def default_url_options
-    options = super
-    contexts.each{ |name, ctx| options[ctx.key] = ctx.url_option }
-    options
+    contexts.inject({}) do |options, (name, ctx)|
+      option = ctx.respond_to?(:url_option) ? ctx.url_option : ctx.current
+      options[ctx.key] = option
+      options
+    end
   end
 end

data/lib/contexts/version.rb

@@ -1,3 +1,3 @@
 module Contexts
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 end

data/lib/mapper.rb

@@ -14,14 +14,15 @@ module ActionDispatch::Routing
       name = "#{name}_context".classify.constantize unless name.is_a?(Class)
       ctx = name.new
       path = ":#{ctx.key}"
-      path = "(#{path})" unless ctx.required?
+      path = "(#{path})" unless ctx.respond_to?(:required?) and ctx.required?
 
-      constraints = lambda do |req|
-        (req.env['contexts'] ||= {})[ctx.key] = ctx
-        ctx.matches_constraints?(req)
-      end
+      constraints ->(req) { (req.env['contexts'] ||= {})[ctx.key] = ctx } do
+        if ctx.respond_to?(:constraints)
+          options = { constraints: { ctx.key => ctx.constraints } }
+        end
 
-      scope(path, constraints: constraints, &blk)
+        scope(path, options, &blk)
+      end
     end
   end
 end

data/spec/controllers/application_controller_spec.rb

@@ -1,60 +1,36 @@
 require 'spec_helper'
-require 'dummy/app/controllers/application_controller'
-require 'dummy/app/contexts/language_context'
-
-shared_examples 'context controller' do
-  before(:all) do
-    Rails.application.routes.draw do
-      contexts :language do
-        get '/', to: 'application#index', as: :root
-        get '/hello', to: 'application#index', as: :hello_page
-      end
-    end
-  end
-
-  after(:all) do
-    Rails.application.reload_routes!
-  end
 
+describe ApplicationController, type: [:controller, :request] do
   context 'when context has constraints' do
-    class RequestBasedConstraint
-      def self.matches?(req)
-        req.params[:lang] =~ /ru|en/
-      end
-    end
-
-    constraints = {
-      regexp: /ru|en/,
-      proc: ->(req) { req.params[:lang] =~ /ru|en/ },
-      request_based: RequestBasedConstraint
-    }
-
-    constraints.each do |name, con|
-      it "checks value via #{name}" do
-        allow_any_instance_of(LanguageContext).to receive(:constraints).and_return(con)
-
-        expect(get: '/en').to route_to('application#index', lang: 'en')
-        expect(get: '/ru/hello').to route_to('application#index', lang: 'ru')
-        expect(get: '/de').not_to be_routable
-      end
+    it "checks value via regexp" do
+      expect(get: '/en').to route_to('application#index', lang: 'en')
+      expect(get: '/ru/lang').to route_to('application#index', lang: 'ru')
+      expect(get: '/de').not_to be_routable
     end
   end
 
   context 'when context has no constraints' do
     it 'allows any value' do
-      allow_any_instance_of(LanguageContext).to receive(:constraints).and_return(nil)
-
-      expect(get: '/').to route_to('application#index')
-      expect(get: '/de/').to route_to('application#index', lang: 'de')
+      expect(get: '/ru/moscow/city').to route_to('application#index', lang: 'ru', city: 'moscow')
     end
   end
 
   context 'when context is required' do
     it 'requires value' do
-      allow_any_instance_of(LanguageContext).to receive(:required?).and_return(true)
+      expect(get: '/moscow/city').to route_to('application#index', city: 'moscow')
+    end
+  end
+
+  context 'context locking' do
+    it 'overrides current context' do
+      get '/ru/lang'
+      expect(controller).not_to be_context_locked(:lang)
+
+      controller.lock_context(lang: :en)
 
-      expect(get: '/').not_to be_routable
-      expect(get: '/en/').to route_to('application#index', lang: 'en')
+      expect(controller).to be_context_locked(:lang)
+      expect(controller.locked_context(:lang)).to eq(:en)
+      expect(controller.locked_context).to eq('lang' => :en)
     end
   end
 
@@ -68,7 +44,7 @@ shared_examples 'context controller' do
 
   describe '#current_context' do
     it 'returns current context value' do
-      get '/ru/hello'
+      get '/ru/lang'
 
       expect(controller.current_context(:lang)).to eq(:ru)
       expect(controller.current_context).to eq(lang: :ru)
@@ -77,43 +53,16 @@ shared_examples 'context controller' do
 
   context 'url helpers' do
     it 'includes context' do
-      get '/ru'
-
-      expect(controller.hello_page_path).to eq('/ru/hello')
-    end
+      get '/ru/moscow/city'
 
-    it 'uses default value' do
-      get '/en'
-
-      expect(controller.hello_page_path).to eq('/en/hello')
+      expect(controller.city_page_path).to eq('/ru/moscow/city')
     end
 
     it 'allows to customize url option' do
+      get '/ru/moscow/city'
       get '/en'
 
-      ctx = controller.contexts[:lang]
-      allow(ctx).to receive(:url_option) do
-        ctx.current if ctx.current != ctx.default
-      end
-
-      expect(controller.hello_page_path).to eq('/hello')
+      expect(controller.lang_page_path).to eq('/lang')
     end
   end
-
-  context 'context locking' do
-    it 'overrides current context' do
-      get '/ru/hello'
-      expect(controller).not_to be_context_locked(:lang)
-
-      controller.lock_context(lang: :en)
-
-      expect(controller).to be_context_locked(:lang)
-      expect(controller.locked_context(:lang)).to eq(:en)
-      expect(controller.locked_context).to eq('lang' => :en)
-    end
-  end
-end
-
-describe ApplicationController, type: [:controller, :request] do
-  it_behaves_like 'context controller'
 end

data/spec/dummy/app/contexts/city_context.rb

@@ -0,0 +1,17 @@
+class CityContext
+  def key
+    :city
+  end
+
+  def required?
+    true
+  end
+
+  def current
+    @city
+  end
+
+  def apply(controller, value)
+    @city = value || controller.params[key].presence
+  end
+end

data/spec/dummy/app/contexts/language_context.rb

@@ -1,4 +1,4 @@
-class LanguageContext < Contexts::Base
+class LanguageContext
   def key
     :lang
   end
@@ -19,7 +19,11 @@ class LanguageContext < Contexts::Base
     I18n.locale
   end
 
-  def apply(ctrl, value)
-    I18n.locale = value || ctrl.params[key].presence || default
+  def apply(controller, value)
+    I18n.locale = value || controller.params[key].presence || default
+  end
+
+  def url_option
+    current unless current == default
   end
 end

data/spec/dummy/app/controllers/application_controller.rb

@@ -1,8 +1,6 @@
 class ApplicationController < ActionController::Base
   include Contexts
 
-  protect_from_forgery with: :exception
-
   def index
     render nothing: true
   end

data/spec/dummy/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  contexts :language do
+    get '/', to: 'application#index', as: :root
+    get '/lang', to: 'application#index', as: :lang_page
+
+    context :city do
+      get '/city/', to: 'application#index', as: :city_page
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,11 @@ ENV['RAILS_ENV'] = 'test'
 require File.expand_path('../dummy/config/environment.rb',  __FILE__)
 require 'rspec/rails'
 
+require 'dummy/app/controllers/application_controller'
+require 'dummy/app/contexts/language_context'
+require 'dummy/app/contexts/city_context'
+require 'dummy/config/routes'
+
 RSpec.configure do |config|
   config.order = 'random'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contexts
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kolesnikov Danil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -110,16 +110,16 @@ files:
 - Rakefile
 - contexts.gemspec
 - lib/contexts.rb
-- lib/contexts/base.rb
 - lib/contexts/version.rb
 - lib/mapper.rb
-- spec/contexts_spec.rb
 - spec/controllers/application_controller_spec.rb
+- spec/dummy/app/contexts/city_context.rb
 - spec/dummy/app/contexts/language_context.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/environment.rb
+- spec/dummy/config/routes.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kolesnikovde/contexts
 licenses:
@@ -146,11 +146,12 @@ signing_key:
 specification_version: 4
 summary: Simple way to reuse routes logic in rails apps
 test_files:
-- spec/contexts_spec.rb
 - spec/controllers/application_controller_spec.rb
+- spec/dummy/app/contexts/city_context.rb
 - spec/dummy/app/contexts/language_context.rb
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
 - spec/dummy/config/environment.rb
+- spec/dummy/config/routes.rb
 - spec/spec_helper.rb

data/lib/contexts/base.rb

@@ -1,38 +0,0 @@
-module Contexts
-  class Base
-    def key
-    end
-
-    def required?
-      true
-    end
-
-    def current
-    end
-
-    def default
-    end
-
-    def constraints
-    end
-
-    def url_option
-      current
-    end
-
-    def apply(controller, value)
-    end
-
-    def matches_constraints?(request)
-      if (con = constraints).nil?
-        true
-      elsif con.respond_to?(:matches?)
-        con.matches?(request)
-      elsif con.is_a?(Proc)
-        con.call(request)
-      else
-        con === request.params[key]
-      end
-    end
-  end
-end

data/spec/contexts_spec.rb

@@ -1,4 +0,0 @@
-require 'spec_helper'
-
-describe Contexts do
-end