contexts 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e84208264b7a2f55fad385cfedaa7585f313378
-  data.tar.gz: 66c67a5a407c67712713b6eaf4cdeaaff6c0061e
+  metadata.gz: 137cc0152fdd49899c5443d6c52cf125d6aad5e5
+  data.tar.gz: afa3ddc36e78a1d62848dff1ec420a42689c0b2a
 SHA512:
-  metadata.gz: d3ddb4bd3abc5bd907d8c7f1c73735b5e110e3b0d9d769e9bd9ae8b925758360dd9a16aa0c3a86647770115e73dd7c27b6651a8e51be3ea1b40dddcb82ba96a7
-  data.tar.gz: 039fc6ce21c2ff758faeb82a355027aa7bcb3b90455ef6e7946dec838595c4ec72cb987818cdca538d53c283698f46f609e52a251fa7bb578c7d3d1cb2a390d9
+  metadata.gz: e45639cb32b939431ebbcc1b421de03cd630fb6f3baa51096caf83b44ed28f19e61b65e1db0a3f0e9fdd4c5df5596c40da4e8d20350bc3cd49a934fdef1c3025
+  data.tar.gz: 7e6e0ee4d91d7c075a37527f2f4a32e9e5b6ea78a492ca2a828fadff382ed5be1f897de6b02efa9e5c0bab697730421279bcedfb8fa514a2b285f13f930943fc

data/lib/contexts.rb

@@ -3,11 +3,7 @@ require 'mapper'
 
 module Contexts
   def self.resolve(name)
-    if name.is_a?(Class)
-      name.new
-    else
-      "#{name}_context".classify.constantize.new
-    end
+    "#{name}_context".classify.constantize.new
   end
 
   def self.included(base)
@@ -29,28 +25,31 @@ module Contexts
         names.each{ |name| contexts[name] ||= Contexts.resolve(name) }
       end
     end
+
+    alias_method :context,  :preload_contexts
+    alias_method :contexts, :preload_contexts
   end
 
   def contexts
     @contexts ||= (request.env['contexts'] || {})
   end
 
-  def current_context(key = nil)
-    if key
-      (ctx = contexts[key]) && ctx.current
+  def current_context(name = nil)
+    if name
+      (ctx = contexts[name]) && ctx.current
     else
       Hash[contexts.map{ |name, ctx| [ name, ctx.current ] }]
     end
   end
 
-  def locked_context(key = nil)
-    ctx = (session[:locked_context] ||= {})
+  def locked_context(name = nil)
+    locked = (session[:locked_context] ||= {})
 
-    key ? ctx[key.to_s] : ctx
+    name ? locked[name.to_s] : locked
   end
 
-  def context_locked?(key = nil)
-    locked_context(key).present?
+  def context_locked?(name = nil)
+    locked_context(name).present?
   end
 
   def lock_context(data)
@@ -62,13 +61,13 @@ module Contexts
   protected
 
   def apply_contexts
-    contexts.each{ |name, ctx| ctx.apply(self, locked_context(ctx.key)) }
+    contexts.each{ |name, ctx| ctx.apply(self, locked_context(name)) }
   end
 
   def default_url_options
     contexts.inject({}) do |options, (name, ctx)|
       option = ctx.respond_to?(:url_option) ? ctx.url_option : ctx.current
-      options[ctx.key] = option
+      options[name] = option
       options
     end
   end

data/lib/contexts/version.rb

@@ -1,3 +1,3 @@
 module Contexts
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end

data/lib/mapper.rb

@@ -13,12 +13,12 @@ module ActionDispatch::Routing
     def context(name, &blk)
       ctx = Contexts.resolve(name)
 
-      path = ":#{ctx.key}"
+      path = ":#{name}"
       path = "(#{path})" unless ctx.respond_to?(:required?) and ctx.required?
 
-      constraints ->(req) { (req.env['contexts'] ||= {})[ctx.key] = ctx } do
+      constraints ->(req) { (req.env['contexts'] ||= {})[name] = ctx } do
         if ctx.respond_to?(:constraints)
-          options = { constraints: { ctx.key => ctx.constraints } }
+          options = { constraints: { name => ctx.constraints } }
         end
 
         scope(path, options, &blk)

data/spec/controllers/application_controller_spec.rb

@@ -3,15 +3,15 @@ require 'spec_helper'
 describe ApplicationController, type: [:controller, :request] do
   context 'when context has constraints' do
     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: '/en').to route_to('application#index', locale: 'en')
+      expect(get: '/ru/locale').to route_to('application#index', locale: 'ru')
       expect(get: '/de').not_to be_routable
     end
   end
 
   context 'when context has no constraints' do
     it 'allows any value' do
-      expect(get: '/ru/moscow/city').to route_to('application#index', lang: 'ru', city: 'moscow')
+      expect(get: '/ru/moscow/city').to route_to('application#index', locale: 'ru', city: 'moscow')
     end
   end
 
@@ -23,14 +23,14 @@ describe ApplicationController, type: [:controller, :request] do
 
   context 'context locking' do
     it 'overrides current context' do
-      get '/ru/lang'
-      expect(controller).not_to be_context_locked(:lang)
+      get '/ru/locale'
+      expect(controller).not_to be_context_locked(:locale)
 
-      controller.lock_context(lang: :en)
+      controller.lock_context(locale: :en)
 
-      expect(controller).to be_context_locked(:lang)
-      expect(controller.locked_context(:lang)).to eq(:en)
-      expect(controller.locked_context).to eq('lang' => :en)
+      expect(controller).to be_context_locked(:locale)
+      expect(controller.locked_context(:locale)).to eq(:en)
+      expect(controller.locked_context).to eq('locale' => :en)
     end
   end
 
@@ -38,16 +38,16 @@ describe ApplicationController, type: [:controller, :request] do
     it 'returns contexts hash' do
       get '/en'
 
-      expect(controller.contexts[:lang]).to be_a(LanguageContext)
+      expect(controller.contexts[:locale]).to be_a(LocaleContext)
     end
   end
 
   describe '#current_context' do
     it 'returns current context value' do
-      get '/ru/lang'
+      get '/ru/locale'
 
-      expect(controller.current_context(:lang)).to eq(:ru)
-      expect(controller.current_context).to eq(lang: :ru)
+      expect(controller.current_context(:locale)).to eq(:ru)
+      expect(controller.current_context).to eq(locale: :ru)
     end
   end
 
@@ -62,7 +62,7 @@ describe ApplicationController, type: [:controller, :request] do
       get '/ru/moscow/city'
       get '/en'
 
-      expect(controller.lang_page_path).to eq('/lang')
+      expect(controller.locale_page_path).to eq('/locale')
     end
   end
 end

data/spec/controllers/context_controller_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ContextController, type: :controller do
+  it 'preloads contexts' do
+    get :index
+
+    expect(controller.current_context(:locale)).to eq(:en)
+    expect(controller.current_context(:city)).to eq(nil)
+
+    controller.contexts[:locale].apply(controller, :ru)
+    expect(controller.locale_page_path).to eq('/ru/locale')
+  end
+end

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

@@ -1,8 +1,4 @@
 class CityContext
-  def key
-    :city
-  end
-
   def required?
     true
   end
@@ -12,6 +8,6 @@ class CityContext
   end
 
   def apply(controller, value)
-    @city = value || controller.params[key].presence
+    @city = value || controller.params[:city].presence
   end
 end

data/spec/dummy/app/contexts/{language_context.rb → locale_context.rb}

@@ -1,12 +1,4 @@
-class LanguageContext
-  def key
-    :lang
-  end
-
-  def required?
-    false
-  end
-
+class LocaleContext
   def constraints
     Regexp.new(I18n.available_locales.join('|'))
   end
@@ -20,7 +12,7 @@ class LanguageContext
   end
 
   def apply(controller, value)
-    I18n.locale = value || controller.params[key].presence || default
+    I18n.locale = value || controller.params[:locale].presence || default
   end
 
   def url_option

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

@@ -0,0 +1,3 @@
+class ContextController < ApplicationController
+  context :locale
+end

data/spec/dummy/routes.rb

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

data/spec/dummy_app.rb

@@ -18,8 +18,8 @@ end
 
 Rails.application.initialize!
 
-require 'dummy/app/contexts/language_context'
+require 'dummy/app/contexts/locale_context'
 require 'dummy/app/contexts/city_context'
 require 'dummy/app/controllers/application_controller'
-require 'dummy/app/controllers/context_preload_controller'
+require 'dummy/app/controllers/context_controller'
 require 'dummy/routes'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contexts
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kolesnikov Danil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-18 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -113,11 +113,11 @@ files:
 - lib/contexts/version.rb
 - lib/mapper.rb
 - spec/controllers/application_controller_spec.rb
-- spec/controllers/context_preload_controller_spec.rb
+- spec/controllers/context_controller_spec.rb
 - spec/dummy/app/contexts/city_context.rb
-- spec/dummy/app/contexts/language_context.rb
+- spec/dummy/app/contexts/locale_context.rb
 - spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/context_preload_controller.rb
+- spec/dummy/app/controllers/context_controller.rb
 - spec/dummy/routes.rb
 - spec/dummy_app.rb
 - spec/spec_helper.rb
@@ -147,11 +147,11 @@ specification_version: 4
 summary: Simple way to reuse routes logic in rails apps
 test_files:
 - spec/controllers/application_controller_spec.rb
-- spec/controllers/context_preload_controller_spec.rb
+- spec/controllers/context_controller_spec.rb
 - spec/dummy/app/contexts/city_context.rb
-- spec/dummy/app/contexts/language_context.rb
+- spec/dummy/app/contexts/locale_context.rb
 - spec/dummy/app/controllers/application_controller.rb
-- spec/dummy/app/controllers/context_preload_controller.rb
+- spec/dummy/app/controllers/context_controller.rb
 - spec/dummy/routes.rb
 - spec/dummy_app.rb
 - spec/spec_helper.rb

data/spec/controllers/context_preload_controller_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe ContextPreloadController, type: [:controller, :request] do
-  describe '.preload_contexts' do
-    it 'populates contexts' do
-      get '/'
-
-      expect(controller.current_context(:lang)).to eq(:en)
-      expect(controller.current_context(:city)).to eq(nil)
-    end
-  end
-end

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

@@ -1,3 +0,0 @@
-class ContextPreloadController < ApplicationController
-  preload_contexts :language
-end