action_interceptor 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04669ca4f3feb14833aa912c88dff4787e3c4c1e
-  data.tar.gz: 63cb94be3b6dc259fb9ea5c9db942aa59549c436
+  metadata.gz: 164253286739cc3f66b62a86b6b8c8650ebf441b
+  data.tar.gz: 96fc1302173b587524f3ede0cf8bfdeaf5953f5f
 SHA512:
-  metadata.gz: 175943387c1c16fa25aa2c5a827dd130a56eadb4706bdb72d3228cd48127e49e5c59ed3c10dc9ce1f87dd947c9cebefa7ebb034d3ceb3927bd8e95a905ab48b0
-  data.tar.gz: f56f418f2136734120cd716df80d6a3d41a830a59723b3273d6e64839bd808fac43c21f648195ca2f10ce76750d6db5dadc922efe7f739a563b7c46fb88112df
+  metadata.gz: 8d25e02cd76eca730ef751cc702305a67f14b32a5df1e2958fc52e26eaf4a600dca359430f304c9d3fffd2f060b97ab26664d7762ce02c881c24982f2df0e86c
+  data.tar.gz: b1063a7a075619f8e8fdd511cec3b738595b1f7de4421d1d9d1bb87616f1ef7da5f8b2f11500bf6d2a3a4cf727d102e494cbb46f4a7065dbce616f8f0a884ed5

data/README.md

@@ -87,19 +87,38 @@ end
 As shown above, interceptions work like before_filters and
 can be skipped using the skip_interceptor method.
 
-The `acts_as_interceptor` method will ensure the following:
+Just by including the gem in your app, the following convenience methods
+will also be added to all controllers as helper methods, so they will also
+be available in views: `current_page?(url)`, `current_url`, `current_url_hash`,
+`with_interceptor(&block)` and `without_interceptor(&block)`.
+
+- `with_interceptor(&block)` executes the given block:
+  - Adding the intercepted URL param to all links and redirects
+  - As if it was declared in the context of `self`
+- `without_interceptor(&block)` executes the given block:
+  - With the default URL params for all links and redirects
+  - As if it was declared in the context of `self`
+
+- `current_url_hash` returns a hash containing the `intercepted_url_key` and the
+  `current_url`, signed and encrypted.
+
+- And the following methods, backported from Rails 4:
+  - `current_url` returns the current url.
+  - `current_page?(url)` returns true iif the given url is the `current_url`.
+
+When called, the `acts_as_interceptor` method will ensure the following:
 
 - The `url_options` method for that controller will be overriden, causing all
   links and redirects for the controller and associated views to include
-  the signed return url. This can be skipped by calling `acts_as_interceptor`
-  like this: `acts_as_interceptor override_url_options: false`. In that case,
-  you are responsible for passing the `intercepted_url_hash` to any internal
-  links and redirects.
+  the signed return url. This behavior can be skipped by passing
+  `:override_url_options => false` to the `acts_as_interceptor` call,
+  like so: `acts_as_interceptor :override_url_options => false`.
+  In that case, you are responsible for wrapping any internal links and
+  redirects in `with_interceptor` blocks.
 
 - The following convenience methods will be added to the controller:
-  `redirect_back(options = {})`, `intercepted_url`, `intercepted_url=`,
-  `intercepted_url_hash`, `without_interceptor(&block)`,
-  `url_options_without_interceptor` and `url_options_with_interceptor`.
+  `redirect_back(options = {})`, `intercepted_url`,
+  `intercepted_url=` and `intercepted_url_hash`.
   These methods have the following behavior:
 
   - redirect_back(options = {}) redirects the user back to where the
@@ -113,14 +132,6 @@ The `acts_as_interceptor` method will ensure the following:
   - `intercepted_url_hash` returns a hash containing the `interceptor_url_key`
     and the signed `intercepted_url`.
 
-  - `without_interceptor(&block)` executes a block with the old url options.
-
-  - `url_options_without_interceptor` returns the old url options.
-
-  - `url_options_with_interceptor` returns the old url options merged with
-    the `intercepted_url_hash`. Can be used even if you specified
-    `override_url_options: false`.
-
 When users complete the given task, use the following method to
 redirect them back to where the interception occurred:
 
@@ -134,17 +145,6 @@ Alternatively, you can use `intercepted_url` in views:
 <%= link_to 'Back', intercepted_url %>
 ```
 
-Finally, just by including the gem in your app, the following convenience
-methods will be added to all controllers: `current_url`, `current_url_hash`,
-`current_page?(url)` and `with_interceptor(&block)`.
-
-- `current_url` returns the current url.
-- `current_url_hash` returns a hash containing the `intercepted_url_key` and the
-  `current_url`, signed and encrypted.
-- `current_page?(url)` returns true iif the given url is the `current_url`.
-- `with_interceptor(&block)` executes the given block as if it was an
-  interceptor for the current controller.
-
 ## Contributing
 
 1. Fork it

data/lib/action_interceptor/common.rb

@@ -0,0 +1,61 @@
+module ActionInterceptor
+  module Common
+
+    protected
+
+    def url_for(options = {})
+      url = super
+      return url unless use_interceptor
+
+      @interceptor_url_for_hash ||= is_interceptor ? \
+                                    intercepted_url_hash : current_url_hash
+
+      uri = URI(url)
+      new_query = URI.decode_www_form(uri.query || '') + \
+                    @interceptor_url_for_hash.to_a
+      uri.query = URI.encode_www_form(new_query)
+      uri.to_s
+    end
+
+    # Executes the given block as if it was inside an interceptor
+    def with_interceptor(&block)
+      previous_use_interceptor = use_interceptor
+
+      begin
+        # Send the referer with intercepted requests
+        # So we don't rely on the user's browser to do it for us
+        self.use_interceptor = true
+
+        # Execute the block as if it was defined in this controller
+        instance_exec &block
+      rescue LocalJumpError => e
+        # Silently ignore `return` errors in the block
+        # and return the given value
+        e.exit_value
+      ensure
+        self.use_interceptor = previous_use_interceptor
+      end
+    end
+
+    # Executes the given block as if it was not inside an interceptor
+    def without_interceptor(&block)
+      previous_use_interceptor = use_interceptor
+
+      begin
+        # Send the referer with intercepted requests
+        # So we don't rely on the user's browser to do it for us
+        self.use_interceptor = false
+
+        # Execute the block as if it was defined in this controller
+        instance_exec &block
+      rescue LocalJumpError => e
+        # Silently ignore `return` errors in the block
+        # and return the given value
+        e.exit_value
+      ensure
+        self.use_interceptor = previous_use_interceptor
+      end
+    end
+
+  end
+end

data/lib/action_interceptor/controller.rb

@@ -1,9 +1,12 @@
+require 'action_interceptor/common'
 require 'action_interceptor/encryptor'
 require 'action_interceptor/undefined_interceptor'
 
 module ActionInterceptor
   module Controller
 
+    include Common
+
     def self.included(base)
       base.class_attribute :is_interceptor, :use_interceptor,
                            :interceptor_filters
@@ -13,7 +16,8 @@ module ActionInterceptor
 
       base.before_filter :delete_intercepted_url
 
-      base.helper_method :current_page?, :current_url, :current_url_hash
+      base.helper_method :is_interceptor, :use_interceptor, :use_interceptor=,
+                         :current_page?, :current_url, :current_url_hash, 
 
       base.extend(ClassMethods)
     end
@@ -40,60 +44,6 @@ module ActionInterceptor
       @current_url_hash = {key => url}
     end
 
-    def url_for(options = {})
-      url = super
-      return url unless self.use_interceptor
-
-      @intercepted_url_hash ||= self.is_interceptor ? intercepted_url_hash : \
-                                                      current_url_hash
-
-      uri = URI(url)
-      new_query = URI.decode_www_form(uri.query || '') + \
-                    @intercepted_url_hash.to_a
-      uri.query = URI.encode_www_form(new_query)
-      uri.to_s
-    end
-
-    # Executes the given block as if it was inside an interceptor
-    def with_interceptor(&block)
-      previous_use_interceptor = self.use_interceptor
-
-      begin
-        # Send the referer with intercepted requests
-        # So we don't rely on the user's browser to do it for us
-        self.use_interceptor = true
-
-        # Execute the block as if it was defined in this controller
-        instance_exec &block
-      rescue LocalJumpError => e
-        # Silently ignore `return` errors in the block
-        # and return the given value
-        e.exit_value
-      ensure
-        self.use_interceptor = previous_use_interceptor
-      end
-    end
-
-    # Executes the given block as if it was not inside an interceptor
-    def without_interceptor(&block)
-      previous_use_interceptor = self.use_interceptor
-
-      begin
-        # Send the referer with intercepted requests
-        # So we don't rely on the user's browser to do it for us
-        self.use_interceptor = false
-
-        # Execute the block as if it was defined in this controller
-        instance_exec &block
-      rescue LocalJumpError => e
-        # Silently ignore `return` errors in the block
-        # and return the given value
-        e.exit_value
-      ensure
-        self.use_interceptor = previous_use_interceptor
-      end
-    end
-
     def delete_intercepted_url
       session.delete(ActionInterceptor.intercepted_url_key)
     end

data/lib/action_interceptor/version.rb

@@ -1,4 +1,4 @@
 module ActionInterceptor
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end
 

data/lib/action_interceptor/view.rb

@@ -1,61 +1,9 @@
+require 'action_interceptor/common'
+
 module ActionInterceptor
   module View
 
-    # Can't reuse url_for from controller
-    # because the view's super method is different
-    def url_for(options = {})
-      url = super
-      return url unless controller.use_interceptor
-
-      @intercepted_url_hash ||= controller.is_interceptor ? \
-                                intercepted_url_hash : current_url_hash
-
-      uri = URI(url)
-      new_query = URI.decode_www_form(uri.query || '') + \
-                    @intercepted_url_hash.to_a
-      uri.query = URI.encode_www_form(new_query)
-      uri.to_s
-    end
-
-    # Executes the given block as if it was inside an interceptor
-    def with_interceptor(&block)
-      previous_use_interceptor = controller.use_interceptor
-
-      begin
-        # Send the referer with intercepted requests
-        # So we don't rely on the user's browser to do it for us
-        controller.use_interceptor = true
-
-        # Execute the block as if it was defined in this controller
-        instance_exec &block
-      rescue LocalJumpError => e
-        # Silently ignore `return` errors in the block
-        # and return the given value
-        e.exit_value
-      ensure
-        controller.use_interceptor = previous_use_interceptor
-      end
-    end
-
-    # Executes the given block as if it was not inside an interceptor
-    def without_interceptor(&block)
-      previous_use_interceptor = controller.use_interceptor
-
-      begin
-        # Send the referer with intercepted requests
-        # So we don't rely on the user's browser to do it for us
-        controller.use_interceptor = false
-
-        # Execute the block as if it was defined in this controller
-        instance_exec &block
-      rescue LocalJumpError => e
-        # Silently ignore `return` errors in the block
-        # and return the given value
-        e.exit_value
-      ensure
-        controller.use_interceptor = previous_use_interceptor
-      end
-    end
+    include Common
 
   end
 end

data/spec/lib/action_interceptor/controller_spec.rb

@@ -20,6 +20,8 @@ module ActionInterceptor
         :current_url, true)).to be_true
       expect(ActionController::Base.new.respond_to?(
         :current_url_hash, true)).to be_true
+      expect(ActionController::Base.new.respond_to?(
+        :url_for, true)).to be_true
       expect(ActionController::Base.new.respond_to?(
         :with_interceptor, true)).to be_true
       expect(ActionController::Base.new.respond_to?(

data/spec/lib/action_interceptor/view_spec.rb

@@ -4,8 +4,12 @@ module ActionInterceptor
   describe View do
 
     it 'modifies ActionView::Base' do
-      expect(ActionView::Base.new).to respond_to(:with_interceptor)
-      expect(ActionView::Base.new).to respond_to(:without_interceptor)
+      expect(ActionView::Base.new.respond_to?(
+        :url_for, true)).to be_true
+      expect(ActionView::Base.new.respond_to?(
+        :with_interceptor, true)).to be_true
+      expect(ActionView::Base.new.respond_to?(
+        :without_interceptor, true)).to be_true
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_interceptor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dante Soares
@@ -66,6 +66,7 @@ files:
 - Rakefile
 - config/initializers/action_interceptor.rb
 - lib/action_interceptor.rb
+- lib/action_interceptor/common.rb
 - lib/action_interceptor/controller.rb
 - lib/action_interceptor/encryptor.rb
 - lib/action_interceptor/engine.rb