format_restricter_rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f580e752ae0d6e79c2f5cf704384edeeffeba8f954c4ad0e19c88b3d90926d0f
-  data.tar.gz: 1874e0d2575f44e105a877c332765da832497287631507cfa17c3876c517d000
+  metadata.gz: 2f2bae3923b56bbc18ead2cf5fad9c1e1a03edeaaa30eb6ba111e9d1428ce96a
+  data.tar.gz: e6cc8b95986088cdf06078dbf6820b7a1772f257c23ca1095695e2d60ac6ad9f
 SHA512:
-  metadata.gz: 918da1d938efb0809aa1339686d2536a63ae26c7ef8aa1226b217152192092c6b0af2b7877960c9102f14ee2844441332a1ea3a29ee80612253ce537f9eca31a
-  data.tar.gz: 3b79d1f075da8e17840ae68edbfde09da167de62312c6fde473da00d2f9b3f254d02899e15fde02c5754dfa2dbb61acaa46b922f36cd8d611b37933c4e980d10
+  metadata.gz: f209f31a8803d9d20d61a87b81111991cfb075464a490853a60cb24216dbe2358063dd09e1b9c032805dad81c71d6aaa69201744d2cd0e8359e04716a85d6d7a
+  data.tar.gz: 25fccc5bd94268c62f1c9d369ffb590e9c04e79db93ba6ea846e5e1843c93df24644f82e246eff496e15fa8ae993d1cfbb4bf8806b0967f641f10d05b69ea8ba

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/rubocop/
 
 /spec/dummy/db/*.sqlite3
 /spec/dummy/db/*.sqlite3-journal

data/.rubocop.yml

@@ -1,31 +1,14 @@
-AllCops:
-  Exclude:
-    - spec/dummy/db/schema.rb
+# DO NOT MODIFY THIS FILE unless you want to deviate from the rubocop_plus ruleset.
 
-Style/StringLiterals:
-  Enabled: false
+# This file defines the settings used by rubocop when it runs.  You would normally add your customizations directly to this
+# file, but this file has been pre configured to read settings out of the rubocop_plus gem instead.
 
-Style/SymbolArray:
-  Enabled: false
+# Tell rubocop to load its settings from the rubocop_plus gem.
+inherit_gem:
+  rubocop_plus: config/rubocop.yml
 
-Style/Documentation:
-  Enabled: false
+Rails:
+  Enabled: true
 
-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/**/*
+# Place custom settings below this comment.  All customizations will OVERRIDE rubocop_plus rules.  rubocop_plus & rubocop
+# do not attempt to merge these settings with their defaults.  Long term changes should be ported to the rubocop_plus gem.

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.2.0 (Jan 18, 2018)
+
+1. Use the `to_prepare` hook to simplify the implementation. (Issue #14)
+1. Add the rubocop_plus gem and cleanup internal code.  (Issue #16)
+
 ## 1.1.0 (Jan 08, 2018)
 
 1. Add automated tests.  (Issue #4)
@@ -8,7 +13,7 @@
 
 ## 1.0.1 (May 11, 2016)
 
-1. (Fix) Formats not being blocked when when `only:` or `except:` are not specified (Issue #1)
+1. Fix formats not being blocked when when `only:` or `except:` are not specified (Issue #1)
 
 ## 1.0.0 (May 11, 2016)
 

data/Gemfile

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

data/lib/format_restricter_rails/includes.rb

@@ -1,19 +1,22 @@
 module FormatRestricterRails
+  # Create a wrapping module so we can expose class methods into the host controllers.
   module Includes
     def self.included(base)
       base.extend(ClassMethods)
-      base.instance_eval do
-        private_class_method :register_before_action
-      end
+      # This is one way to mark the register_before_action method as private in a module.
+      base.instance_eval { private_class_method :register_before_action }
     end
 
+    # Define the methods that can be called by host controllers.
     module ClassMethods
+      # This is the main API that host controllers will call at the top the controller.
       def restrict_formats_to(*args)
         options = args.extract_options!
         allowed_formats = args.collect(&:to_sym)
         register_before_action(options, allowed_formats)
       end
 
+      # This method is turned into a private method above.
       def register_before_action(options, allowed_formats)
         before_action(options) do |_controller|
           render nothing: true, status: 406 unless allowed_formats.include?(request.format.symbol)

data/lib/format_restricter_rails/railtie.rb

@@ -1,35 +1,8 @@
 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
-
+  # This Railtie exposes the format_resticter_rails API to the host application controllers.
   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
+    config.to_prepare do
+      ApplicationController.include FormatRestricterRails::Includes
     end
   end
 end

data/lib/format_restricter_rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: format_restricter_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - roberts1000
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-08 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler