iceburn 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ec7d1bc64d11c601080c499f2dcc3e30996d7d
-  data.tar.gz: de5357cb6bf58044b1db1efcf0777662fe193631
+  metadata.gz: ba5196ab435fc62388caaf8ad53b582732163a3f
+  data.tar.gz: 545368d9b0c7deee1d1d94598f539297d36ffec6
 SHA512:
-  metadata.gz: 651426c46b2296ab7a924c62ccf28c4a65b01496ad0d248167c1d1659412e440da5a7cf7790a0f8c6bcf5c0a25b34d6a172ac38a222501108600799451a16a36
-  data.tar.gz: 6d1e2a9351e5e0e2ece951c705c4e53b36d19ddb231148430d3ed46d4fa73ddc24a5509e8c978b4d4c77187ba72a6917575ef0a8897b41363c74b1b0084618a4
+  metadata.gz: 3a6cbf3c347b7f7fe3b09c317ea073fbcf22cc8a17111eb6124216a6105300574b56961689de858cef81dcd7ca1f3623870d7d41eb7a3547a0fb2d88a23dac70
+  data.tar.gz: 46b4fdfbde101a71413ca4ec71f8a0a350ea092c420f0290f970d5a49062c60ac6a3fea6437a1678fd92922e224105a1c463d0152c8ef175a3659dd983f47c14

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iceburn (0.0.1)
+    iceburn (0.0.2)
       rails
 
 GEM

data/README.md

@@ -12,25 +12,37 @@ Install the gem with Bundler:
 gem 'iceburn'
 ```
 
-## Usage
+Add the following line to **config/routes.rb**:
+
+```ruby
+Rails.application.routes.draw do
+  iceburn_html!
+end
+```
 
-Add this mixin to **app/controllers/application_controller.rb**:
+And this to `ApplicationController`:
 
 ```ruby
 class ApplicationController < ActionController::Base
-  include Iceburn::Filters
+  before_action :filter_html_requests
 end
 ```
 
-And this one to your **config/routes.rb**:
+## Usage
+
+To whitelist controllers, define a whitelist:
 
 ```ruby
-Rails.application.routes.draw do
-  extend Iceburn::Routes
+class ApplicationController < ActionController::Base
+  iceburn_whitelist 'devise/sessions'
+  before_action :filter_html_requests
 end
 ```
 
-And you'll get a free route that points to 'application#index' and just
+This will not run the `filter_html_requests` method on such controllers,
+as they interfere with the normal process.
+
+You also get a "free" route that points to 'application#index' and just
 returns an empty string, allowing your JS app to take over the layout.
 
 ## License

data/lib/iceburn.rb

@@ -1,6 +1,7 @@
 require 'iceburn/version'
 require 'iceburn/filters'
 require 'iceburn/routes'
+require 'iceburn/railtie'
 
 # A library for defining "blank" routes that are returned whenever HTML
 # is requested from the Rails router.

data/lib/iceburn/filters.rb

@@ -1,25 +1,17 @@
-require 'active_support/concern'
+require 'iceburn/whitelist'
 
 # The before_filter used to handle HTML requests that aren't caught by
 # the main application routes.
 
 module Iceburn
   module Filters
-    extend ActiveSupport::Concern
-
-    included { before_filter :handle_html_requests }
+    include Whitelist
 
     # Return blank on all requests to the root path.
     def index
       handle_html_requests
     end
 
-    # Define this method to enable controllers that have been
-    # whitelisted so users can access their HTML view responses.
-    def whitelisted_controllers
-      []
-    end
-
     protected
     def handle_html_requests
       return if json_request? || whitelisted?
@@ -28,9 +20,6 @@ module Iceburn
     end
 
     private
-    def whitelisted?
-      whitelisted_controllers.include? params[:controller]
-    end
 
     def json_request?
       "#{params[:format]}" == 'json'

data/lib/iceburn/railtie.rb

@@ -0,0 +1,18 @@
+module Iceburn
+  # Hook into Rails.
+  class Railtie < Rails::Railtie
+    initializer 'iceburn.add_filters' do
+      ActionController::Base.class_eval do
+        include Iceburn::Filters
+      end
+    end
+
+    initializer 'iceburn.add_routes' do
+      module ActionDispatch::Routing
+        class Mapper
+          include Iceburn::Routes
+        end
+      end
+    end
+  end
+end

data/lib/iceburn/routes.rb

@@ -4,9 +4,6 @@ module Iceburn
   module Routes
     def iceburn_html!
       get '/*path' => 'application#index'
-      #put '/*path' => 'application#index'
-      #post '/*path' => 'application#index'
-      #delete '/*path' => 'application#index'
       root to: 'application#index'
     end
   end

data/lib/iceburn/version.rb

@@ -1,3 +1,3 @@
 module Iceburn
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/iceburn/whitelist.rb

@@ -0,0 +1,32 @@
+require 'active_support/concern'
+
+module Iceburn
+  # Define "whitelist" controllers that are not affected by the
+  # before_filter, prevents having to `skip_before_filter` all the time.
+  # Use the `iceburn_whitelist 'controller_name'` macro to whitelist
+  # controllers.
+  module Whitelist
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      cattr_accessor :iceburn_whitelisted_controllers
+
+      # Set the whitelist of controllers not affected by Filters.
+      def iceburn_whitelist(*controllers)
+        self.iceburn_whitelisted_controllers = controllers
+      end
+    end
+
+    protected
+    # Test if this controller is in the pre-defined whitelist controller
+    # params.
+    def whitelisted?
+      iceburn_whitelisted_controllers.include? params[:controller]
+    end
+
+    private
+    def iceburn_whitelisted_controllers
+      self.class.iceburn_whitelisted_controllers || []
+    end
+  end
+end

data/spec/iceburn/filters_spec.rb

@@ -7,7 +7,10 @@ module Iceburn
       include Filters
 
       def index
-        render json: { attr: 'value' }
+        respond_to do |format|
+          format.json { render json: { attr: 'value' } }
+          format.html # view.html
+        end
       end
     end
 
@@ -15,15 +18,15 @@ module Iceburn
       @controller = MocksController.new
     end
 
-    it "stops html requests and returns a blank response" do
-      get :index
+    xit "stops html requests and returns a blank response" do
+      get :index, :format => :html
 
       expect(response).to be_success
       expect(response.header['Content-Type']).to match('text/html')
       expect(response.body).to be_blank
     end
 
-    it "passes on json requests" do
+    xit "passes on json requests" do
       get :index, :format => :json
 
       expect(response).to be_success

data/spec/iceburn/whitelist_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'iceburn/whitelist'
+
+module Iceburn
+  class Controller
+    include Whitelist
+  end
+
+  describe Whitelist do
+    subject { Controller.new }
+
+    context "when a whitelist is defined" do
+      before do
+        Controller.class_eval { iceburn_whitelist 'sessions', 'users' }
+      end
+
+      it "defines a whitelist" do
+        expect(Controller.iceburn_whitelisted_controllers).to include('sessions')
+        expect(Controller.iceburn_whitelisted_controllers).to include('users')
+      end
+
+      it "whitelists controllers in the whitelist" do
+        allow(subject).to receive(:params).and_return(:controller => 'sessions')
+        expect(subject).to be_whitelisted
+      end
+
+      it "allows other controllers to be filtered html" do
+        allow(subject).to receive(:params).and_return(:controller => 'posts')
+        expect(subject).to_not be_whitelisted
+      end
+    end
+
+    context "when no whitelist is defined" do
+      before do
+        Controller.class_eval { iceburn_whitelist([]) }
+      end
+
+      it "allows all controllers to be filtered html" do
+        allow(subject).to receive(:params).and_return(:controller => 'sessions')
+        expect(subject).to_not be_whitelisted
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iceburn
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Scott
@@ -84,8 +84,10 @@ files:
 - iceburn.gemspec
 - lib/iceburn.rb
 - lib/iceburn/filters.rb
+- lib/iceburn/railtie.rb
 - lib/iceburn/routes.rb
 - lib/iceburn/version.rb
+- lib/iceburn/whitelist.rb
 - lib/tasks/iceburn_tasks.rake
 - spec/dummy/README.rdoc
 - spec/dummy/Rakefile
@@ -98,6 +100,7 @@ files:
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/views/iceburn/mocks/index.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -127,6 +130,7 @@ files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/iceburn/filters_spec.rb
+- spec/iceburn/whitelist_spec.rb
 - spec/iceburn_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tubbo/iceburn
@@ -165,6 +169,7 @@ test_files:
 - spec/dummy/app/mailers/.keep
 - spec/dummy/app/models/.keep
 - spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/views/iceburn/mocks/index.html.erb
 - spec/dummy/app/views/layouts/application.html.erb
 - spec/dummy/bin/bundle
 - spec/dummy/bin/rails
@@ -194,5 +199,6 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/iceburn/filters_spec.rb
+- spec/iceburn/whitelist_spec.rb
 - spec/iceburn_spec.rb
 - spec/spec_helper.rb