contexts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 769797619302adbd6183a7498199810826cb6a37
+  data.tar.gz: 015c8f23bf692fab0904b72f4e6c9530bf4ac6b7
+SHA512:
+  metadata.gz: fd913b15066d17f2e1f7e1253daa729f543b41716f3d91c63c05c38b1114f3080efc3c05d2d59f94420fdfa865e11b6e1b5089cf6de4ad1afa9ffc3a9d88d33f
+  data.tar.gz: dc46451e7a778b23fed0589ef360dd1ede8461f41ccbf7ee9ad880c86df98548d316b78b3b3e86854c970c280bae67a24b7968043f98da4ddbf4a4e34c214f3e

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+/.bundle
+/Gemfile.lock
+/pkg
+/tmp
+/log
+/coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=doc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# Contexts
+
+This gem provides simple way to reuse routes logic in rails apps.
+
+## License
+
+Copyright (c) 2014 Kolesnikov Danil
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/contexts.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'contexts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'contexts'
+  spec.version       = Contexts::VERSION
+  spec.authors       = ['Kolesnikov Danil']
+  spec.email         = ['kolesnikovde@gmail.com']
+  spec.summary       = 'Simple way to reuse routes logic in rails apps'
+  spec.description   = 'Simple way to reuse routes logic in rails apps'
+  spec.homepage      = 'https://github.com/kolesnikovde/contexts'
+  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{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', '>= 4.0.0'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+end

data/lib/contexts.rb

@@ -0,0 +1,56 @@
+require 'contexts/version'
+require 'contexts/base'
+require 'mapper'
+
+module Contexts
+  def self.included(base)
+    base.class_eval do
+      before_action :apply_contexts
+
+      helper_method :contexts,
+                    :current_context,
+                    :locked_context,
+                    :context_locked?
+    end
+  end
+
+  def contexts
+    @contexts ||= (request.env['contexts'] || {})
+  end
+
+  def current_context(key = nil)
+    if key
+      (ctx = contexts[key]) && ctx.current
+    else
+      Hash[contexts.map{ |name, ctx| [ name, ctx.current ] }]
+    end
+  end
+
+  def locked_context(key = nil)
+    ctx = (session[:locked_context] ||= {})
+
+    key ? ctx[key.to_s] : ctx
+  end
+
+  def context_locked?(key = nil)
+    locked_context(key).present?
+  end
+
+  def lock_context(data)
+    ctx = locked_context
+    ctx.merge!(data.stringify_keys).reject!{ |k, v| v.blank? }
+    ctx
+  end
+
+  protected
+
+  def apply_contexts
+    contexts.each{ |name, ctx| ctx.apply(self, locked_context(ctx.key)) }
+  end
+
+  def default_url_options
+    options = super
+    contexts.each{ |name, ctx| options[ctx.key] = ctx.url_option }
+    options
+  end
+end

data/lib/contexts/base.rb

@@ -0,0 +1,38 @@
+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/lib/contexts/version.rb

@@ -0,0 +1,3 @@
+module Contexts
+  VERSION = '0.1.0'
+end

data/lib/mapper.rb

@@ -0,0 +1,27 @@
+module ActionDispatch::Routing
+  class Mapper
+    def contexts(*names, &blk)
+      names.reverse.each do |name|
+        blk = lambda do |blk|
+          lambda { context(name, &blk) }
+        end.call(blk)
+      end
+
+      blk.call
+    end
+
+    def context(name, &blk)
+      name = "#{name}_context".classify.constantize unless name.is_a?(Class)
+      ctx = name.new
+      path = ":#{ctx.key}"
+      path = "(#{path})" if ctx.required?
+
+      constraints = lambda do |req|
+        (req.env['contexts'] ||= {})[ctx.key] = ctx
+        ctx.matches_constraints?(req)
+      end
+
+      scope(path, constraints: constraints, &blk)
+    end
+  end
+end

data/spec/contexts_spec.rb

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

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,117 @@
+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
+
+  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
+    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')
+    end
+  end
+
+  context 'when context is required' do
+    it 'requires value' do
+      expect(get: '/').not_to be_routable
+      expect(get: '/en/').to route_to('application#index', lang: 'en')
+    end
+  end
+
+  describe '#contexts' do
+    it 'returns contexts hash' do
+      get '/en'
+
+      expect(controller.contexts[:lang]).to be_a(LanguageContext)
+    end
+  end
+
+  describe '#current_context' do
+    it 'returns current context value' do
+      get '/ru/hello'
+
+      expect(controller.current_context(:lang)).to eq(:ru)
+      expect(controller.current_context).to eq(lang: :ru)
+    end
+  end
+
+  context 'url helpers' do
+    it 'includes context' do
+      get '/ru'
+
+      expect(controller.hello_page_path).to eq('/ru/hello')
+    end
+
+    it 'uses default value' do
+      get '/en'
+
+      expect(controller.hello_page_path).to eq('/en/hello')
+    end
+
+    it 'allows to customize url option' do
+      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')
+    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/language_context.rb

@@ -0,0 +1,21 @@
+class LanguageContext < Contexts::Base
+  def key
+    :lang
+  end
+
+  def constraints
+    /ru|en/
+  end
+
+  def default
+    I18n.default_locale
+  end
+
+  def current
+    I18n.locale
+  end
+
+  def apply(ctrl, value)
+    I18n.locale = value || ctrl.params[key].presence || default
+  end
+end

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

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

data/spec/dummy/config/application.rb

@@ -0,0 +1,21 @@
+require File.expand_path('../boot', __FILE__)
+require 'action_controller/railtie'
+Bundler.require(*Rails.groups)
+require 'contexts'
+
+module Dummy
+  class Application < Rails::Application
+    config.secret_key_base = 'dummy_key'
+    config.session_store :cookie_store, key: '_dummy_session'
+    config.cache_classes = true
+    config.eager_load = false
+    config.consider_all_requests_local = true
+    config.action_dispatch.show_exceptions = false
+    config.action_controller.perform_caching = false
+    config.action_controller.allow_forgery_protection = false
+    config.active_support.deprecation = :stderr
+
+    config.i18n.available_locales = [ :en, :ru ]
+    config.i18n.default_locale = :en
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../application', __FILE__)
+
+Rails.application.initialize!

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: contexts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kolesnikov Danil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Simple way to reuse routes logic in rails apps
+email:
+- kolesnikovde@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- 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/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/spec_helper.rb
+homepage: https://github.com/kolesnikovde/contexts
+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: 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/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/spec_helper.rb