tarquinn 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecb0edee29d3f22108388751e86d64641f06e927
-  data.tar.gz: 4502cfa609572a32c6137bd2ff2639ee90641065
+  metadata.gz: 127a3336f88c936432f99b747ce1fcc05a8ac383
+  data.tar.gz: 945174dc6e9dd2d0a53cd3c999577035df8683e9
 SHA512:
-  metadata.gz: 1c57b6df4121b783036ff66f4bb32591e98c16c3a7e57abc997158a55d0b5d67455894c557a2a135e840aef91c6722f4732876cdd18af4e4ac5e5a3bc1f4d9e5
-  data.tar.gz: 2ba5ac3b72a550cbd48dc45858331e69d2e944fe62cac24e703461af7dabb9be7502bc6d44a25ee7e8d14124048ca3a1fee412d6f28764e9f5fa855e91da3e75
+  metadata.gz: 159300d5d10e03e370861da7562adce6cb149f4b6d18923d2f0df8f19d8e69abbbdacb9a85dfec4e82bb9f21d7405d6e4e2f13500c5ec1e194cc6d57afff49f9
+  data.tar.gz: b1bcc793e2466dca7f3a1c4cb679912c22d930dff9b4409a17583d5e3cd10cfd6e35a7cfdb2d12c91e11c62579ab306959ca19a69fe12c0e834ada7380d63d6f

data/.gitignore

@@ -0,0 +1,2 @@
+/coverage
+/pkg

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile.lock

@@ -1,14 +1,31 @@
 PATH
   remote: .
   specs:
-    tarquinn (0.0.1)
+    tarquinn (0.0.2)
+      activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    coderay (1.1.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    i18n (0.7.0)
     json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.8.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
     rake (10.4.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -23,12 +40,18 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
+    slop (3.6.0)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.6)
+  pry
+  pry-nav
   rake
   rspec (~> 2.14)
   simplecov

data/README.md

@@ -0,0 +1,46 @@
+Tarquinn
+========
+
+This gem makes easier to controll generic redirection
+
+Getting started
+---------------
+1. Add Tarquinn to your `Gemfile` and `bundle install`:
+
+  ```ruby
+    gem 'tarquinn'
+  ```
+
+2. Include Tarquinn to your controller or to your base controller
+  ```ruby
+    ApplicationController < ActionController::Base
+      include Tarquinn
+    end
+  ```
+
+3. Program your redirection on your controllers
+  ```ruby
+    BaseController < ApplicationController
+      redirection_rule :redirect_login, :loggin_needed?
+
+      private
+
+      def redirect_login
+        login_path
+      end
+
+      def loggin_needed?
+        user.present?
+      end
+    end
+
+    StaticController < BaseController
+      skip_redirection_rule :redirect_login, :is_home?
+
+      private
+
+      def is_home?
+        params[:action] == 'home'
+      end
+    end
+  ```

data/lib/tarquinn/handler.rb

@@ -24,7 +24,7 @@ class Tarquinn::Handler
   end
 
   def redirect_path
-    controller.send(config.redirect)
+    controller.send(redirect_method)
   end
 
   def is_redirect?

data/lib/tarquinn/version.rb

@@ -1,3 +1,3 @@
 module Tarquinn
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/tarquinn.rb

@@ -1,3 +1,6 @@
+require 'active_support'
+require 'active_support/core_ext'
+
 module Tarquinn
   require 'tarquinn/version'
   require 'tarquinn/handler'

data/spec/lib/tarquinn/builder_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Tarquinn::Builder do
+  describe '#build' do
+    let(:controller) do
+      double('controller')
+    end
+
+    it do
+      expect(subject.build(controller)).to be_a(Tarquinn::Engine)
+    end
+  end
+end

data/spec/lib/tarquinn/config_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Tarquinn::Config do
+  let(:subject) { described_class.new(:redirect) }
+
+  describe '#add_redirection_rules' do
+    context 'when not passing a block' do
+      it do
+        expect do
+          subject.add_redirection_rules(:methods)
+        end.to change { subject.methods }
+      end
+
+      it do
+        expect do
+          subject.add_redirection_rules(:methods)
+        end.not_to change { subject.blocks }
+      end
+    end
+
+    context 'when not passing only a block' do
+      it do
+        expect do
+          subject.add_redirection_rules { true }
+        end.not_to change { subject.methods }
+      end
+
+      it do
+        expect do
+          subject.add_redirection_rules { true }
+        end.to change { subject.blocks }
+      end
+    end
+  end
+end

data/spec/lib/tarquinn/engine_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Tarquinn::Engine do
+  let(:redirection_path) { '/path' }
+  let(:redirection_path2) { '/path2' }
+  let(:controller) do
+    double('controller', redirect_path: redirection_path, redirect_path2: redirection_path2)
+  end
+  let(:config) { Tarquinn::Config.new(:redirect_path) }
+  let(:config2) { Tarquinn::Config.new(:redirect_path2) }
+  let(:configs) { { redirect_path: config, redirect_path2: config2 } }
+  let(:subject) { described_class.new configs, controller }
+
+  describe '#perform_redirect?' do
+    context 'when no redirection should be performed' do
+      before do
+        config.add_skip_rules { true }
+        config2.add_skip_rules { true }
+      end
+
+      it do
+        expect(subject.perform_redirect?).to be_falsey
+      end
+    end
+
+    context 'when all redirection is required' do
+      before do
+        config.add_redirection_rules { true }
+        config2.add_redirection_rules { true }
+      end
+
+      it do
+        expect(subject.perform_redirect?).to be_truthy
+      end
+    end
+
+    context 'when only one allow for redirection' do
+      before do
+        config.add_redirection_rules { true }
+        config2.add_skip_rules { true }
+      end
+
+      it do
+        expect(subject.perform_redirect?).to be_truthy
+      end
+    end
+  end
+
+  describe '#perform_redirect' do
+    context 'when no redirection should be performed' do
+      before do
+        config.add_skip_rules { true }
+        config2.add_skip_rules { true }
+      end
+
+      it 'redirects to the first redirection' do
+        expect(controller).not_to receive(:redirect_to).with(redirection_path)
+        subject.perform_redirect
+      end
+    end
+
+    context 'when all redirection is required' do
+      before do
+        config.add_redirection_rules { true }
+        config2.add_redirection_rules { true }
+      end
+
+      it do
+        expect(controller).to receive(:redirect_to)
+        subject.perform_redirect
+      end
+    end
+
+    context 'when only one allow for redirection' do
+      context 'when its the first redirection' do
+        before do
+          config.add_redirection_rules { true }
+          config2.add_skip_rules { true }
+        end
+
+        it do
+          expect(controller).to receive(:redirect_to).with(redirection_path)
+          subject.perform_redirect
+        end
+      end
+
+      context 'when its the second redirection' do
+        before do
+          config.add_skip_rules { true }
+          config2.add_redirection_rules { true }
+        end
+
+        it do
+          expect(controller).to receive(:redirect_to).with(redirection_path2)
+          subject.perform_redirect
+        end
+      end
+    end
+  end
+end

data/spec/lib/tarquinn/handler_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Tarquinn::Handler do
+  let(:redirection_path) { '/path' }
+  let(:controller) { double('controller', true: true, false: false, redirect_path: redirection_path) }
+  let(:config) { Tarquinn::Config.new(:redirect_path) }
+  let(:subject) { described_class.new config, controller }
+
+  describe '#perform_redirect?' do
+    context 'when rules allow for redirection' do
+      before do
+        config.add_redirection_rules { true }
+      end
+
+      it do
+        expect(subject.perform_redirect?).to be_truthy
+      end
+
+      context 'but some grant a skip' do
+        before do
+          config.add_skip_rules { true }
+        end
+
+        it do
+          expect(subject.perform_redirect?).to be_falsey
+        end
+      end
+    end
+
+    context 'when rules do not allow for redirection' do
+      before do
+        config.add_redirection_rules { false }
+      end
+
+      it do
+        expect(subject.perform_redirect?).to be_falsey
+      end
+
+      context 'but some do not grant a skip' do
+        before do
+          config.add_skip_rules { false }
+        end
+
+        it do
+          expect(subject.perform_redirect?).to be_falsey
+        end
+      end
+    end
+
+    context 'when passing a method name for evaluation' do
+      context 'when method returns true' do
+        before do
+          config.add_redirection_rules :true
+        end
+
+        it do
+          expect(subject.perform_redirect?).to be_truthy
+        end
+
+        context 'but some grant a skip' do
+          before do
+            config.add_skip_rules :true
+          end
+
+          it do
+            expect(subject.perform_redirect?).to be_falsey
+          end
+        end
+      end
+
+      context 'when method returns false' do
+        before do
+          config.add_redirection_rules :false
+        end
+
+        it do
+          expect(subject.perform_redirect?).to be_falsey
+        end
+
+        context 'but some do not grant a skip' do
+          before do
+            config.add_skip_rules :false
+          end
+
+          it do
+            expect(subject.perform_redirect?).to be_falsey
+          end
+        end
+      end
+    end
+
+    describe '#redirect' do
+      it do
+        expect(controller).to receive(:redirect_to).with(redirection_path)
+        subject.redirect
+      end
+    end
+  end
+end

data/spec/lib/tarquinn_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Tarquinn do
+  let(:controller) { Tarquinn::Controller.new }
+
+  describe 'redirection' do
+    context 'when configuration calls for a method that allows redirection' do
+      it 'redirects to redirection path given by the method' do
+        expect(controller).to receive(:redirect_to).with('/path')
+        controller.parse_request
+      end
+    end
+
+    context 'when redirection skip method returns true' do
+      before do
+        allow(controller).to receive(:should_skip_redirect?) { true }
+      end
+
+      it 'does not redirect to redirection path given by the method' do
+        expect(controller).not_to receive(:redirect_to)
+        controller.parse_request
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,13 @@
 require 'simplecov'
-SimpleCov.start
+
+SimpleCov.profiles.define 'gem' do
+  add_filter '/spec/'
+end
+
+SimpleCov.start 'gem'
 
 require 'tarquinn'
+require 'pry-nav'
 
 support_files = File.expand_path("spec/support/**/*.rb")
 Dir[support_files].each { |file| require file  }

data/spec/support/models/tarquinn/controller.rb

@@ -0,0 +1,30 @@
+class Tarquinn::Controller
+  def self.before_action(_)
+  end
+
+  include Tarquinn
+
+  redirection_rule :redirection_path, :should_redirect?
+  skip_redirection_rule :redirection_path, :should_skip_redirect?
+
+  def parse_request
+    perform_redirection
+  end
+
+  private
+
+  def redirection_path
+    '/path'
+  end
+
+  def redirect_to(_)
+  end
+
+  def should_redirect?
+    true
+  end
+
+  def should_skip_redirect?
+    false
+  end
+end

data/tarquinn.gemspec

@@ -17,8 +17,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_runtime_dependency 'activesupport'
+
   gem.add_development_dependency "bundler", "~> 1.6"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec", "~> 2.14"
   gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-nav'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tarquinn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-08-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-nav
+  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: Gem for easy redirection controll
 email:
 - darthjee@gmail.com
@@ -73,6 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -86,7 +130,13 @@ files:
 - lib/tarquinn/engine.rb
 - lib/tarquinn/handler.rb
 - lib/tarquinn/version.rb
+- spec/lib/tarquinn/builder_spec.rb
+- spec/lib/tarquinn/config_spec.rb
+- spec/lib/tarquinn/engine_spec.rb
+- spec/lib/tarquinn/handler_spec.rb
+- spec/lib/tarquinn_spec.rb
 - spec/spec_helper.rb
+- spec/support/models/tarquinn/controller.rb
 - tarquinn.gemspec
 homepage: https://github.com/darthje/tarquinn
 licenses: []