format_restricter_rails 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4972618603956be5371074aff97c5789b6aec167
-  data.tar.gz: 627c68d3c620600806fd4553cb310dfa67ed3845
+SHA256:
+  metadata.gz: f580e752ae0d6e79c2f5cf704384edeeffeba8f954c4ad0e19c88b3d90926d0f
+  data.tar.gz: 1874e0d2575f44e105a877c332765da832497287631507cfa17c3876c517d000
 SHA512:
-  metadata.gz: 35317de7978900af29f0452fa8eda71db806ab3a65b817fe931da560a692e98ee4649b7c77eaabae7be0c0f0d8f342b841c748d9bc32d389adfd8dae11cc31a0
-  data.tar.gz: aed2f149cbb0e918fa32a80a571867b93f66e9b58f724cb7b2b441e63975f38110f932b50251e4ac091f6c799702df1d1f53ae6b13be56934d43b1174dcd587c
+  metadata.gz: 918da1d938efb0809aa1339686d2536a63ae26c7ef8aa1226b217152192092c6b0af2b7877960c9102f14ee2844441332a1ea3a29ee80612253ce537f9eca31a
+  data.tar.gz: 3b79d1f075da8e17840ae68edbfde09da167de62312c6fde473da00d2f9b3f254d02899e15fde02c5754dfa2dbb61acaa46b922f36cd8d611b37933c4e980d10

data/.gitignore

@@ -7,3 +7,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+/spec/dummy/db/*.sqlite3
+/spec/dummy/db/*.sqlite3-journal
+/spec/dummy/log/*.log
+/spec/dummy/tmp/
+/spec/dummy/.sass-cache

data/.rspec

@@ -1,2 +1,3 @@
---format documentation
+--format progress
 --color
+--require rails_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  Exclude:
+    - spec/dummy/db/schema.rb
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/StderrPuts:
+  Exclude:
+    - spec/dummy/bin/yarn
+
+Style/MixinUsage:
+  Exclude:
+    - spec/dummy/bin/setup
+    - spec/dummy/bin/update
+
+Metrics/LineLength:
+  Max: 130
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
-  - 2.3.0
-before_install: gem install bundler -v 1.11.2
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -1,9 +1,15 @@
 # CHANGELOG
 
+## 1.1.0 (Jan 08, 2018)
+
+1. Add automated tests.  (Issue #4)
+1. Configure travis CI to use cached versions of gems.  (Issue #8)
+1. Correct rubocop issues.  (Issue #11)
+
 ## 1.0.1 (May 11, 2016)
 
 1. (Fix) Formats not being blocked when when `only:` or `except:` are not specified (Issue #1)
 
 ## 1.0.0 (May 11, 2016)
 
-1. Initial Release
+1. Initial Release

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in format_restricter_rails.gemspec
 gemspec
+
+group :development, :test do
+  gem 'bootsnap', require: false
+  gem 'puma', '~> 3.7'
+end

data/README.md

@@ -1,14 +1,14 @@
 # format_restricter_rails
 
-This gem provides a simple way to block your Rails controller actions from trying to process unsupported formats.  Without this, you'll eventually start seeing the following errors on your production site:
+This gem provides a simple way to block your Rails controller actions from processing unsupported formats.  Without this, you'll eventually start seeing the following errors on your production site:
 
 ````
 ActionView::MissingTemplate (Missing template tasks/index, application/index with {:locale=>[:en], :formats=>[:json], :variants=>[], :handlers=>[:erb, :builder, :raw, :ruby, :coffee, :jbuilder]}
 ````
 
-Why are you getting these errors?  Because you designed your sweet little controller action to only process html requests and someone decided to send it a .json request.  Rails happily obliged, processed the action and failed when it couldn't find a corresponding json template to render.
+Why are you getting these errors?  Because you designed your snazzy controller action to only process html requests and someone decided to send it a .json request.  Rails happily obliged, processed the action and failed when it couldn't find a corresponding json template to render.
 
-When this happens, you may think to start defining `respond_to` calls in your actions.  Once you realize that's going to explode your code base, you'll probably try to call `respond_to :html` at the top of your controller class in hopes that will help.  Sadly, it won't; and that's where this gem comes in.  It provides a single controller class method, called `restrict_formats_to` that you can add to your controller to declare the formats that it is allowed to process.  When unallowed formats are requested, halts execution and returns an **HTTP Error 406 Not acceptable**.
+When this happens, you may start defining `respond_to` calls in your actions.  Once you realize that's going to explode your code base, you'll probably try to call `respond_to :html` at the top of your controller class in hopes that it will help.  Sadly, it won't; and that's where this gem comes in.  It provides a single controller class method called `restrict_formats_to` that does exactly what you want.  When unallowed formats are requested, the controller will halt execution and return **HTTP Error 406 Not acceptable**.
 
 ## Versioning Scheme
 
@@ -16,8 +16,7 @@ This gem uses [semver](http:/semver.org).
 
 ## Supported Rails Versions
 
-Currently tested with Rails 4+.
-Not tested in Rails 5 yet.
+Rails 4+.
 
 ## Installation
 
@@ -33,9 +32,9 @@ And then execute:
 
 ## Usage
 
-The `restrict_formats_to` is just a wrapper around a `before_action` helper and you can use the standard `only:` and `except:` options.
+Add `restrict_formats_to` to the top of a controller to restrict all actions in the controller to the specified format(s).
 
-#### Example 1: Restrict all actions 
+#### Example 1: Restrict all actions
 
 ````ruby
 class MySnazzyController < ApplicationController
@@ -45,22 +44,42 @@ class MySnazzyController < ApplicationController
   end
 
   def my_action_2
-  end  
+  end
 end
 ````
 
-#### Example 2: Mix and match
+You can also use `only:` and `except:` options to target specific actions.
+
+
+#### Example 2: Using the `only:` option
 
 ````ruby
 class MySnazzyController < ApplicationController
   restrict_formats_to :html, only: :my_action_1
-  restrict_formats_to :json, only: :my_action_2
+  restrict_formats_to :json, only: [:my_action_2, :my_action_3]
+
+  def my_action_1
+  end
+
+  def my_action_2
+  end
+
+  def my_action_3
+  end
+end
+````
+
+#### Example 2: Using the `except:` Option
+
+````ruby
+class MySnazzyController < ApplicationController
+  restrict_formats_to :html, except: :my_action_1
 
   def my_action_1
   end
 
   def my_action_2
-  end  
+  end
 end
 ````
 

data/Rakefile

@@ -1,11 +1,21 @@
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+Bundler::GemHelper.install_tasks
+
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :console do
   exec "pry -r format_restricter_rails -I ./lib"
-  #exec "irb -r format_restricter_rails -I ./lib"
-end
+  # exec "irb -r format_restricter_rails -I ./lib"
+end

data/bin/dummy

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+Dir.chdir('spec/dummy') do
+  `rails s -b 0.0.0.0`
+end

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/format_restricter_rails/engine', __FILE__)
+APP_PATH = File.expand_path('../../spec/dummy/config/application', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/{respond_to_by_controller.gemspec → format_restricter_rails.gemspec}

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'format_restricter_rails/version'
@@ -6,11 +5,11 @@ require 'format_restricter_rails/version'
 Gem::Specification.new do |spec|
   spec.name          = "format_restricter_rails"
   spec.version       = FormatRestricterRails::VERSION
-  spec.authors       = ["Roberts"]
+  spec.authors       = ["roberts1000"]
   spec.email         = ["roberts@corlewsolutions.com"]
 
-  spec.summary       = "Restrict the formats that your Rails controller actions are allowed to process"
-  spec.description   = "Restrict the formats that your Rails controller actions are allowed to process"
+  spec.summary       = "A Rails Engine that prevents Rails controllers from processing undesired formats."
+  spec.description   = "A Rails Engine that restricts the formats that your Rails controller actions are allowed to process."
   spec.homepage      = "https://github.com/corlewsolutions/format_restricter_rails"
   spec.license       = "MIT"
 
@@ -19,10 +18,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "pry", "~> 0.10.1"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry", "~> 0.11.3"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec-rails", "~> 3.7.2"
+  spec.add_development_dependency "sass-rails", "~> 5.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.11"
 
   spec.add_dependency "rails", ">= 4"
 end

data/lib/format_restricter_rails/engine.rb

@@ -1,4 +1,4 @@
-module FormatRestricterRails
-  class Engine < ::Rails::Engine
-  end
-end
+module FormatRestricterRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/format_restricter_rails/includes.rb

@@ -1,27 +1,24 @@
-module FormatRestricterRails
-  module Includes
-
-    def self.included(base)
-      base.extend(ClassMethods)
-      base.instance_eval do
-        private_class_method :register_before_action
-      end
-    end
-
-    module ClassMethods
-      def restrict_formats_to(*args)
-        options = args.extract_options!
-        allowed_formats = args.collect {|e| e.to_sym}
-        register_before_action(options, allowed_formats)
-      end
-
-      def register_before_action(options, allowed_formats)
-        before_action(options) do |controller|
-          unless allowed_formats.include?(request.format.symbol)
-            render nothing: true, status: 406
-          end
-        end
-      end
-    end
-  end
-end
+module FormatRestricterRails
+  module Includes
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.instance_eval do
+        private_class_method :register_before_action
+      end
+    end
+
+    module ClassMethods
+      def restrict_formats_to(*args)
+        options = args.extract_options!
+        allowed_formats = args.collect(&:to_sym)
+        register_before_action(options, allowed_formats)
+      end
+
+      def register_before_action(options, allowed_formats)
+        before_action(options) do |_controller|
+          render nothing: true, status: 406 unless allowed_formats.include?(request.format.symbol)
+        end
+      end
+    end
+  end
+end

data/lib/format_restricter_rails/railtie.rb

@@ -1,38 +1,35 @@
-module FormatRestricterRails
-
-  def self.include_modules_into_host_app
-    ApplicationController.include FormatRestricterRails::Includes
-  end
-
-  def self.was_eager_loaded?
-    @was_eager_loaded ||= false
-  end
-
-  def self.was_eager_loaded=value
-    @was_eager_loaded = value
-  end
-
-  class Railtie < Rails::Railtie
-    # This code will be run before Rails eager loads all of the application code. This method will typically only fire
-    # in production-like environments, however, it could happen in development if the necessary config options are set for the
-    # development.rb.
-    config.before_eager_load do
-      FormatRestricterRails.include_modules_into_host_app
-      FormatRestricterRails.was_eager_loaded = true
-    end
-
-    config.after_initialize do
-      # Don't rerun some setup code if eager loading occured.  It can result in weird things happening.
-      unless FormatRestricterRails.was_eager_loaded?
-        FormatRestricterRails.include_modules_into_host_app
-      end
-
-      # Make sure the code is reloaded in development
-      if Rails.env.development?
-        ActionDispatch::Callbacks.before do
-          FormatRestricterRails.include_modules_into_host_app
-        end
-      end
-    end
-  end
-end
+module FormatRestricterRails
+  def self.include_modules_into_host_app
+    ApplicationController.include FormatRestricterRails::Includes
+  end
+
+  def self.was_eager_loaded?
+    @was_eager_loaded ||= false
+  end
+
+  def self.was_eager_loaded=(value)
+    @was_eager_loaded = value
+  end
+
+  class Railtie < Rails::Railtie
+    # This code will be run before Rails eager loads all of the application code. This method will typically only fire
+    # in production-like environments, however, it could happen in development if the necessary config options are set for the
+    # development.rb.
+    config.before_eager_load do
+      FormatRestricterRails.include_modules_into_host_app
+      FormatRestricterRails.was_eager_loaded = true
+    end
+
+    config.after_initialize do
+      # Don't rerun some setup code if eager loading occured.  It can result in weird things happening.
+      FormatRestricterRails.include_modules_into_host_app unless FormatRestricterRails.was_eager_loaded?
+
+      # Make sure the code is reloaded in development
+      if Rails.env.development?
+        ActionDispatch::Callbacks.before do
+          FormatRestricterRails.include_modules_into_host_app
+        end
+      end
+    end
+  end
+end

data/lib/format_restricter_rails/version.rb

@@ -1,3 +1,3 @@
 module FormatRestricterRails
-  VERSION = "1.0.1"
+  VERSION = "1.1.0".freeze
 end

data/lib/format_restricter_rails.rb

@@ -7,7 +7,9 @@ require "format_restricter_rails/railtie"
 # Setup pry for development when running "rake console". Guard against load
 # errors in production (since pry is only loaded as a DEVELOPMENT dependency
 # in the .gemspec)
+# rubocop:disable Lint/HandleExceptions
 begin
   require "pry"
 rescue LoadError
 end
+# rubocop:enable Lint/HandleExceptions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: format_restricter_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
-- Roberts
+- roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.7.2
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 1.3.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 1.3.11
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -80,8 +108,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
-description: Restrict the formats that your Rails controller actions are allowed to
-  process
+description: A Rails Engine that restricts the formats that your Rails controller
+  actions are allowed to process.
 email:
 - roberts@corlewsolutions.com
 executables: []
@@ -90,20 +118,23 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/console
+- bin/dummy
+- bin/rails
 - bin/setup
+- format_restricter_rails.gemspec
 - lib/format_restricter_rails.rb
 - lib/format_restricter_rails/engine.rb
 - lib/format_restricter_rails/includes.rb
 - lib/format_restricter_rails/railtie.rb
 - lib/format_restricter_rails/version.rb
-- respond_to_by_controller.gemspec
 homepage: https://github.com/corlewsolutions/format_restricter_rails
 licenses:
 - MIT
@@ -124,8 +155,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
-summary: Restrict the formats that your Rails controller actions are allowed to process
+summary: A Rails Engine that prevents Rails controllers from processing undesired
+  formats.
 test_files: []