rails_readonly_injector 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dee81bdb9e36457740b1f0bf42b0a426b71c529b
-  data.tar.gz: e1be2bdd0040986a650f2937173ef155ab03e1cb
+SHA256:
+  metadata.gz: 2e68a057aa63af3f0e46809dc301e596254913b0fa92729a689fdd47c91fd5bc
+  data.tar.gz: bee51c41e100a416caa4f752586eb1921d637a60c193843c930b7abd24e69878
 SHA512:
-  metadata.gz: ba266967fd09dcbda610866e85757a92181232ab4c396c635fa0e3c697cb012c6a3219f00cd4f607d9a4e5b5967ae985306c7974fa1a68d400ab60127e938fdc
-  data.tar.gz: 8e764d1c867cb779f52e61434e2ecf7f392d9967efaf5abf6d048c11b94448f913240eaf303d2659bc876558a3728bd512dc8b170f1350078cb0edf3dca2234b
+  metadata.gz: 48b772ac6faf91b543be796821d75a710fd3914169cee35c221a0799d3e4855c34bfdd938665c5cacde39292687599f45e5fa47b3549c655fa2893dcf9980e7e
+  data.tar.gz: 318587289d5e70529182438fece31a09ec5a56992676b1c67fa6381559e18b25bb9092e23d7e11c7bf2b03586021e5683ccf2e5e6a718613143b733ad155b5bd

data/.gitignore

@@ -7,4 +7,5 @@
 /spec/reports/
 /tmp/
 gemfiles/*.gemfile.lock
-.byebug_history
+.byebug_history
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Exclude:
+    - tmp/**/*
+    
+Metrics/BlockLength:
+  Exclude:
+    - rspec_specs/**/*

data/.travis.yml

@@ -13,9 +13,6 @@ branches:
   only:
     - master
 
-before_install:
-  - /bin/bash -c '[[ $BUNDLE_GEMFILE = *"rails_5_2"* ]] && { echo "Installing Cucumber-rails v1.6.0.pre..."; gem install cucumber-rails-1.6.0.pre.gem; }' || echo "Desired rails version is < 5.2. Skipping Cucumber 1.6.0.pre installation...";
-
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails_3' do
   gem 'rails', '~> 3'
   gem 'cucumber-rails', '~> 1.4.5'
@@ -47,7 +49,7 @@ end
 
 appraise 'rails_5_2' do
   gem 'rails', '~> 5.2.0'
-  gem 'cucumber-rails', '~> 1.6.0.pre', group: :test, require: false
+  gem 'cucumber-rails', '~> 1.6.0', group: :test, require: false
   gem 'rspec-rails', '~> 3.7.2', group: :test
   gem 'database_cleaner', '~> 1.0.1'
-end
+end

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in rails_readonly_injector.gemspec
 gemspec

data/Rakefile

@@ -1,7 +1,9 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 
 development_tasks_path = File.expand_path('../development_tasks', __FILE__)
 
 Dir[File.join(development_tasks_path, '*.rake')].each { |rb| load rb }
 
-task :default => ['dev:deploy_test_app', 'dev:run_tests']
+task default: ['dev:deploy_test_app', 'dev:run_tests']

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "rails_readonly_injector"
+require 'bundler/setup'
+require 'rails_readonly_injector'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "rails_readonly_injector"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/cucumber_features/step_definitions/generic_steps.rb

@@ -1,7 +1,9 @@
-Given("I execute:") do |code|
+# frozen_string_literal: true
+
+Given('I execute:') do |code|
   eval code
 end
 
-Then("The page should contain {string}") do |string|
+Then('The page should contain {string}') do |string|
   expect(page).to have_content(string)
-end
+end

data/cucumber_features/step_definitions/user_steps.rb

@@ -1,4 +1,6 @@
-Given("There is a user that has been persisted to the database") do  
+# frozen_string_literal: true
+
+Given('There is a user that has been persisted to the database') do
   RailsReadonlyInjector.config.read_only = false
   RailsReadonlyInjector.reload!
 
@@ -7,45 +9,45 @@ Given("There is a user that has been persisted to the database") do
   expect(@user.persisted?).to eq(true)
 end
 
-Given("There is a user that has not been persisted to the database") do
+Given('There is a user that has not been persisted to the database') do
   User.destroy_all
-  
+
   @user = User.new(name: 'Bob')
 end
 
-When("I update the user") do
+When('I update the user') do
   begin
     @user.update_attributes(name: 'Fred')
   rescue ActiveRecord::ReadOnlyRecord
   end
 end
 
-When("I save the user") do
+When('I save the user') do
   begin
     @user.save
   rescue ActiveRecord::ReadOnlyRecord
   end
 end
 
-Then("the user should not be updated") do
+Then('the user should not be updated') do
   @user.reload
-  
+
   expect(@user.name).to eq('Bob')
 end
 
-Then("the user should be updated") do
+Then('the user should be updated') do
   @user.reload
 
   expect(@user.name).to eq('Fred')
 end
 
-Then("the user should be saved") do
- @user.reload
+Then('the user should be saved') do
+  @user.reload
 
   expect(@user.persisted?).to eq(true)
 end
 
-Then("the user should not be saved") do
+Then('the user should not be saved') do
   expect(User.all.length).to eq(0)
 end
 
@@ -56,15 +58,15 @@ When("I'm using a web browser and attempt to update the user") do
 end
 
 When("I'm using a web browser and attempt to create a user") do
-  visit "/users/new"
+  visit '/users/new'
   fill_in 'user[name]', with: 'Fred'
   click_on 'Create User'
 end
 
-Then("the user should be created") do
+Then('the user should be created') do
   expect(User.all.length).to eq(1)
 end
 
-Then("I should be able to create a user without any errors") do
+Then('I should be able to create a user without any errors') do
   expect { User.create(name: 'Bob') }.not_to raise_error
-end
+end

data/development_tasks/support/file_helpers.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+# :nodoc:
+module FileHelpers
+  GEM_ROOT_PATH = File.expand_path('../../..', __FILE__).freeze
+  RAILS_APP_PATH = File.expand_path(File.join(GEM_ROOT_PATH, 'tmp', 'rails_app')).freeze
+
+  def append_to_file(path_to_file, content)
+    raise 'The specified path is not a file!' unless File.file? path_to_file
+
+    File.open(path_to_file, 'a') do |f|
+      f.write content
+    end
+  end
+
+  def append_to_beginning_of_file(path_to_file, content)
+    raise 'The specified path is not a file!' unless File.file? path_to_file
+
+    existing_content_as_array = File.open(path_to_file, 'r').readlines
+
+    new_content_arr = [content] + existing_content_as_array
+
+    write_file_with_content path_to_file, new_content_arr.join("\n")
+  end
+
+  def write_file_with_content(path_to_file, content)
+    File.open(path_to_file, 'w') do |f|
+      f.write content
+    end
+  end
+
+  def switch_to_gems_root_path
+    FileUtils.cd GEM_ROOT_PATH
+  end
+
+  def switch_to_rails_app_path
+    FileUtils.cd RAILS_APP_PATH
+  end
+
+  def generate_rails_application
+    # Remove the app, if it exists already
+    system("rm -rf #{RAILS_APP_PATH}")
+
+    FileUtils.mkdir_p RAILS_APP_PATH
+    system("bundle exec rails new #{RAILS_APP_PATH}")
+  end
+
+  def gems_root_path
+    GEM_ROOT_PATH
+  end
+
+  def rails_app_path
+    RAILS_APP_PATH
+  end
+end

data/development_tasks/support/gem_helpers.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module GemHelpers
+  def add_gem(name, attributes = {})
+    line = if attributes.empty?
+             "gem '#{name}'"
+           else
+             "gem '#{name}', #{attributes}"
+           end
+
+    append_to_file('Gemfile', "#{line}\n")
+  end
+
+  # 'Override'/force a specific gem version, as defined in the Appraisal.
+  def ensure_gem_versions_defined_in_appraisal_are_used
+    gems_defined_in_appraisal = retrieve_gems_from_gemfile(ENV['BUNDLE_GEMFILE'])
+    gems_defined_in_gemfile = retrieve_gems_from_gemfile('Gemfile').collect(&:gem_name)
+
+    gems_defined_in_appraisal.reject { |l| gems_defined_in_gemfile.include? l.gem_name }.each do |gem|
+      add_gem gem.gem_name, gem.attributes.join(',')
+    end
+  end
+
+  def install_simplecov(coverage_dir)
+    append_to_beginning_of_file 'spec/spec_helper.rb', %(
+      require 'simplecov'
+      require 'rails_readonly_injector'
+    )
+    append_to_beginning_of_file 'features/support/env.rb', "require 'simplecov'"
+
+    write_file_with_content '.simplecov', %(
+      SimpleCov.start do
+        coverage_dir '#{coverage_dir}'
+      end
+    )
+  end
+
+  def unset_appraisal_environment_variables
+    ENV.delete('BUNDLE_GEMFILE')
+    ENV.delete('BUNDLE_BIN_PATH')
+    ENV.delete('RUBYOPT')
+  end
+
+  private
+
+  def retrieve_gems_from_gemfile(file_path)
+    gems = []
+
+    File.open(file_path).readlines.each do |line|
+      matches = line.match(/^\s*gem\s+['|"]/)
+
+      next if matches.nil?
+
+      parts = line.split(',')
+
+      gem_name = parts.first.gsub(/\s*gem\s*|["|']|\n/, '')
+
+      gems << OpenStruct.new(gem_name: gem_name, attributes: parts.drop(1))
+    end
+
+    gems
+  end
+end

data/development_tasks/tests.rake

@@ -1,34 +1,26 @@
-require 'fileutils'
+# frozen_string_literal: true
+
+require_relative 'support/file_helpers'
+require_relative 'support/gem_helpers'
 
 namespace :dev do
-  RAILS_APP_PATH = File.expand_path('../../tmp/rails_app', __FILE__).freeze
-  GEM_ROOT_PATH = File.expand_path('../..', __FILE__).freeze
+  include GemHelpers
+  include FileHelpers
 
-  desc "Deploys a test rails application into the #{RAILS_APP_PATH} directory."
+  desc 'Deploys a test rails application.'
   task :deploy_test_app do
     switch_to_gems_root_path
 
-    # Remove the app, if it exists already
-    system("rm -rf #{RAILS_APP_PATH}")
-
-    puts "Creating a new rails application..."
-    FileUtils.mkdir_p RAILS_APP_PATH
-    system("bundle exec rails new #{RAILS_APP_PATH}")
+    puts 'Creating a new rails application...'
+    generate_rails_application
 
     switch_to_rails_app_path
 
-    # Read gems defined in this Appraisal,
-    # so we can write them to the Gemfile rails generated.
-    # i.e. To 'override'/force a specific version.
-    gems_defined_in_appraisal = parse_gemfile(ENV['BUNDLE_GEMFILE'])
-    gems_defined_in_gemfile = parse_gemfile('Gemfile').collect { |l| l.gem_name }
-
-    gems_to_override = gems_defined_in_appraisal.reject { |l| gems_defined_in_gemfile.include? l.gem_name }.collect { |gem| gem.original_line_in_gemfile }
+    ensure_gem_versions_defined_in_appraisal_are_used
 
     # Add required gems to the gemfile
-    append_to_file 'Gemfile', gems_to_override.join("\n")
-    append_to_file 'Gemfile', %{gem 'simplecov', require: false, group: :test\n}
-    append_to_file 'Gemfile', %{gem "rails_readonly_injector", path: "#{GEM_ROOT_PATH}"\n}
+    add_gem 'simplecov', require: false, group: :test
+    add_gem 'rails_readonly_injector', path: gems_root_path
 
     # Make sure we don't use the gemfile from Appraisal
     unset_appraisal_environment_variables
@@ -36,40 +28,30 @@ namespace :dev do
     # Install gems
     system("bundle install")
 
-    system("bundle exec rails generate cucumber:install")
-    system("bundle exec rails generate rspec:install")
+    puts 'Executing Generators...'
+    system('bundle exec rails generate cucumber:install')
+    system('bundle exec rails generate rspec:install')
 
     # RSpec: Include all files in support/
     append_to_file 'spec/spec_helper.rb', "Dir.glob('support/**/*.rb').each { |rb| require rb }"
 
-    # Set up SimpleCov
-    append_to_beginning_of_file 'spec/spec_helper.rb', %{
-      require 'simplecov'
-      require 'rails_readonly_injector'
-    }
-    append_to_beginning_of_file 'features/support/env.rb', "require 'simplecov'"
+    install_simplecov("#{gems_root_path}/coverage")
     
-    write_file_with_content '.simplecov', %{
-      SimpleCov.start do
-        coverage_dir '#{GEM_ROOT_PATH}/coverage'
-      end
-    }
-
     # Prepare database migrations, etc
-    system("bundle exec rails generate scaffold User name:string")
+    system('bundle exec rails generate scaffold User name:string')
     
-    system("RAILS_ENV=test bundle exec rake db:migrate")
+    system('RAILS_ENV=test bundle exec rake db:migrate')
   end
 
-  desc "Synchronises tests from `cucumber_features` and `rspec_specs` into the rails application in #{RAILS_APP_PATH}, and runs the tests against the application."
-  task :run_tests => [:run_features, :run_specs]
+  desc 'Synchronises tests from `cucumber_features` and `rspec_specs` into the temporary rails app, and runs them.'
+  task run_tests: %i[run_features run_specs]
 
-  desc "Synchronises features from `cucumber_features` into the rails application in #{RAILS_APP_PATH}, and runs them against the application."
+  desc 'Synchronises features from `cucumber_features` into the temporary rails app, and runs them.'
   task :run_features do
     switch_to_rails_app_path
 
     # Synchronise the cucumber features
-    FileUtils.cp_r File.join(GEM_ROOT_PATH, 'cucumber_features', '.'), 'features'
+    FileUtils.cp_r File.join(gems_root_path, 'cucumber_features'), 'features'
 
     unset_appraisal_environment_variables
 
@@ -78,74 +60,18 @@ namespace :dev do
     exit 1 unless command_executed_successfully
   end
 
-  desc "Synchronises specs from `rspec_specs` into the rails application in #{RAILS_APP_PATH}, and runs them against the application."
+  desc 'Synchronise specs from `rspec_specs` into the temporary rails app, and run rspec.'
   task :run_specs do
     switch_to_rails_app_path
 
-    # Synchronise the cucumber features
-    FileUtils.cp_r File.join(GEM_ROOT_PATH, 'rspec_specs', '.'), 'spec'
+    # Synchronise the RSpec specs
+    FileUtils.cp_r File.join(gems_root_path, 'rspec_specs'), 'spec'
 
     unset_appraisal_environment_variables
 
-    
     command_executed_successfully = system('bundle exec rspec')
     
     exit 1 unless command_executed_successfully
   end
 
-  def parse_gemfile(file_path)
-    gems = []
-
-    File.open(file_path).readlines.each do |line|
-      matches = line.match /^\s*gem\s+['|"]/
-
-      next if matches.nil?
-
-      parts = line.split(',')
-      
-      gem_name = parts.first.gsub(/\s*gem\s*|["|']|\n/, '')
-
-      gems << OpenStruct.new({ gem_name: gem_name, original_line_in_gemfile: line })
-    end
-
-    gems
-  end
-
-  def switch_to_gems_root_path
-    FileUtils.cd GEM_ROOT_PATH
-  end
-
-  def switch_to_rails_app_path
-    FileUtils.cd RAILS_APP_PATH
-  end
-
-  def append_to_file(path_to_file, content)
-    raise 'The specified path is not a file!' unless File.file? path_to_file
-
-    File.open(path_to_file, 'a') do |f|
-      f.write content
-    end
-  end
-
-  def append_to_beginning_of_file(path_to_file, content)
-    raise 'The specified path is not a file!' unless File.file? path_to_file
-
-    existing_content_as_array = File.open(path_to_file, 'r').readlines
-
-    new_content_arr = [content] + existing_content_as_array
-
-    write_file_with_content path_to_file, new_content_arr.join("\n")
-  end
-
-  def write_file_with_content(path_to_file, content)
-    File.open(path_to_file, 'w') do |f|
-      f.write content
-    end
-  end
-
-  def unset_appraisal_environment_variables
-    ENV.delete('BUNDLE_GEMFILE')
-    ENV.delete('BUNDLE_BIN_PATH')
-    ENV.delete('RUBYOPT')
-  end
 end

data/gemfiles/rails_5_2.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.2.0"
-gem "cucumber-rails", "~> 1.6.0.pre", group: :test, require: false
+gem "cucumber-rails", "~> 1.6.0", group: :test, require: false
 gem "rspec-rails", "~> 3.7.2", group: :test
 gem "database_cleaner", "~> 1.0.1"
 

data/lib/rails_readonly_injector.rb

@@ -1,13 +1,13 @@
-require "rails_readonly_injector/version"
-require "rails_readonly_injector/configuration"
+# frozen_string_literal: true
 
-module RailsReadonlyInjector
+require 'rails_readonly_injector/version'
+require 'rails_readonly_injector/configuration'
 
+module RailsReadonlyInjector
   # Applies changes defined in the `config` object
   # and resets `config.dirty?` to false
   def self.reload!
     config.classes_to_include.each do |klass|
-    
       # Ensure we restore classes that we want to exclude, to their defaults
       # in case they were previously marked as read-only.
       if config.classes_to_exclude.include? klass
@@ -15,7 +15,7 @@ module RailsReadonlyInjector
         next
       end
 
-      if self.config.send(:read_only)
+      if config.send(:read_only)
         override_readonly_method(klass)
       else
         restore_readonly_method(klass)
@@ -24,17 +24,17 @@ module RailsReadonlyInjector
 
     inject_error_handler_into_actioncontroller_base
 
-    self.config.send(:reset_dirty_status!)
+    config.send(:reset_dirty_status!)
   end
 
   # Returns the currently loaded `config.read_only` value.
   # @return [Boolean] Whether the currently loaded config is set to read-only.
   def self.in_read_only_mode?
-    if self.config.dirty? && self.config.changed_attributes.has_key?(:read_only)
+    if config.dirty? && config.changed_attributes.key?(:read_only)
       # Return the previously stored value
-      self.config.changed_attributes[:read_only]
+      config.changed_attributes[:read_only]
     else
-      self.config.send(:read_only)
+      config.send(:read_only)
     end
   end
 
@@ -42,9 +42,9 @@ module RailsReadonlyInjector
   # and then returns the current configuration object.
   # @return [Configuration] The current configuration object.
   def self.config
-    yield self.configuration if block_given?
-  
-    self.configuration
+    yield configuration if block_given?
+
+    configuration
   end
 
   private
@@ -70,7 +70,7 @@ module RailsReadonlyInjector
   end
 
   def self.inject_error_handler_into_actioncontroller_base
-    ActionController::Base.class_eval do |klass|
+    ActionController::Base.class_eval do
       rescue_from ActiveRecord::ReadOnlyRecord, with: :rescue_from_readonly_failure
 
       protected

data/lib/rails_readonly_injector/configuration.rb

@@ -1,14 +1,15 @@
-module RailsReadonlyInjector
+# frozen_string_literal: true
 
+module RailsReadonlyInjector
   class Configuration
     attr_reader :controller_rescue_action, :classes_to_include, :classes_to_exclude
 
     def initialize
       @read_only = false
-      @controller_rescue_action = Proc.new {}
+      @controller_rescue_action = proc {}
       @classes_to_exclude = []
 
-      @changed_attributes = Hash.new
+      @changed_attributes = {}
     end
 
     # @return [Array<Class>] An array of classes to include
@@ -19,7 +20,7 @@ module RailsReadonlyInjector
       return @classes_to_include if defined? @classes_to_include
 
       Rails.application.eager_load!
-      
+
       if Rails::VERSION::STRING < '5.0.0'
         ActiveRecord::Base.descendants
       else
@@ -36,7 +37,7 @@ module RailsReadonlyInjector
       update_instance_variable('@read_only', new_value)
     end
 
-    # @param action [Lambda, Proc] The action to execute when rescuing from 
+    # @param action [Lambda, Proc] The action to execute when rescuing from
     #   `ActiveRecord::RecordReadOnly` errors, within a controller
     def controller_rescue_action=(action)
       raise 'A lambda or proc must be specified' unless action.respond_to? :call
@@ -58,7 +59,7 @@ module RailsReadonlyInjector
     # Instance methods  #
     #####################
 
-    # @return [Boolean] Whether the configuration 
+    # @return [Boolean] Whether the configuration
     #   has changed since the config was last reloaded
     def dirty?
       !changed_attributes.empty?
@@ -66,9 +67,7 @@ module RailsReadonlyInjector
 
     # @return [Hash] A hash of changed attributes
     #   and their previous values
-    def changed_attributes
-      @changed_attributes
-    end
+    attr_reader :changed_attributes
 
     private
 
@@ -80,19 +79,17 @@ module RailsReadonlyInjector
       instance_variable_set(variable_name.to_sym, new_value)
 
       unless old_value == new_value
-        changed_attributes[variable_name.to_s.gsub('@', '').to_sym] = old_value
+        changed_attributes[variable_name.to_s.delete('@').to_sym] = old_value
       end
     end
 
     # Resets the changed attributes hash,
-    # so that `#dirty?` returns false 
+    # so that `#dirty?` returns false
     def reset_dirty_status!
-     @changed_attributes = Hash.new
+      @changed_attributes = {}
     end
 
-    def read_only
-      @read_only
-    end
+    attr_reader :read_only
   end
   private_constant :Configuration
 
@@ -108,6 +105,6 @@ module RailsReadonlyInjector
   def self.reset_configuration!
     @config = Configuration.new
 
-    self.reload!
+    reload!
   end
-end
+end

data/lib/rails_readonly_injector/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsReadonlyInjector
-  VERSION = "1.0.1"
+  VERSION = '1.1.0'
 end

data/rails_readonly_injector.gemspec

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rails_readonly_injector/version"
+require 'rails_readonly_injector/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rails_readonly_injector"
+  spec.name          = 'rails_readonly_injector'
   spec.version       = RailsReadonlyInjector::VERSION
-  spec.authors       = ["Andrew Walter"]
-  spec.email         = ["andrew.walter@burnet.edu.au"]
+  spec.authors       = ['Andrew Walter']
+  spec.email         = ['andrew.walter@burnet.edu.au']
 
   spec.summary       = "Globally toggle 'read-only' mode in a Rails application, on-demand, without having to restart the server."
-  spec.homepage      = "https://www.github.com/xtrasimplicity/rails_readonly_injector"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://www.github.com/xtrasimplicity/rails_readonly_injector'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.required_ruby_version = ">= 2.1.3"
+  spec.required_ruby_version = '>= 2.1.3'
+
+  spec.add_runtime_dependency 'rails', ['>= 3.0', '< 5.3']
 
-  spec.add_runtime_dependency "rails", [">= 3.0", "<= 5.2"]
-  
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'appraisal', '~> 2.2'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'yard', '~> 0.9.12'
 end

data/rspec_specs/rails_readonly_injector/configuration_spec.rb

@@ -1,30 +1,37 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 
 RSpec.describe RailsReadonlyInjector.config do
   describe '#controller_rescue_action=' do
     context 'when given a lambda expression' do
-      let(:lambda_expression) { lambda { "This is a test lambda!" } }
-
-      before { RailsReadonlyInjector.config.controller_rescue_action = lambda_expression }
+      let(:exp) { -> { 'This is a test lambda!' } }
+      before do
+        RailsReadonlyInjector.config.controller_rescue_action = exp
+      end
 
       subject { RailsReadonlyInjector.config.controller_rescue_action }
 
-      it { is_expected.to eq(lambda_expression) }
+      it { is_expected.to eq(exp) }
     end
 
     context 'when given a Proc' do
-      let(:proc) { Proc.new { "This is a test Proc!" } }
+      let(:passed_proc) { proc { 'This is a test Proc!' } }
 
-      before { RailsReadonlyInjector.config.controller_rescue_action = proc }
+      before do
+        RailsReadonlyInjector.config.controller_rescue_action = passed_proc
+      end
 
       subject { RailsReadonlyInjector.config.controller_rescue_action }
 
-      it { is_expected.to eq(proc) }
+      it { is_expected.to eq(passed_proc) }
     end
 
     context 'when an invalid value is assigned' do
       it 'raises an error message' do
-        expect { RailsReadonlyInjector.config.controller_rescue_action = nil }.to raise_error 'A lambda or proc must be specified'
+        expect do
+          RailsReadonlyInjector.config.controller_rescue_action = nil
+        end.to raise_error 'A lambda or proc must be specified'
       end
     end
   end
@@ -32,7 +39,7 @@ RSpec.describe RailsReadonlyInjector.config do
   describe '#classes_to_include' do
     context 'when not defined' do
       context 'when using Rails < 5.0' do
-        before do 
+        before do
           stub_const('Rails::VERSION::STRING', '4.1.0')
         end
 
@@ -41,17 +48,16 @@ RSpec.describe RailsReadonlyInjector.config do
 
           RailsReadonlyInjector.config.classes_to_include
         end
-
       end
 
       context 'when using Rails >= 5.0' do
         before do
           stub_const('Rails::VERSION::STRING', '5.0.0')
-          
+
           unless defined? ApplicationRecord
+            # :nodoc:
             class ApplicationRecord
-              def descendants
-              end
+              def descendants; end
             end
           end
         end
@@ -61,7 +67,6 @@ RSpec.describe RailsReadonlyInjector.config do
 
           RailsReadonlyInjector.config.classes_to_include
         end
-
       end
     end
   end
@@ -82,7 +87,7 @@ RSpec.describe RailsReadonlyInjector.config do
         subject { RailsReadonlyInjector.config.changed_attributes }
 
         it 'returns a hash with the attribute and its old value' do
-          expect(subject).to eq({ read_only: false })
+          expect(subject).to eq(read_only: false)
         end
       end
 
@@ -111,11 +116,11 @@ RSpec.describe RailsReadonlyInjector.config do
         subject { RailsReadonlyInjector.config.changed_attributes }
 
         it 'returns a hash with the attribute and its old value' do
-          expect(subject).to eq({
+          expect(subject).to eq(
             read_only: false,
-            classes_to_include: nil, # We expect this to be nil, as the `getter` method _returns_ (but does not assign) dynamic descendants of ActiveRecord::Base/ApplicationRecord, if undefined
+            classes_to_include: nil,
             classes_to_exclude: []
-          })
+          )
         end
       end
 
@@ -136,28 +141,27 @@ RSpec.describe RailsReadonlyInjector.config do
     end
   end
 
-
   describe '#dirty?' do
     setup do
       RailsReadonlyInjector.config { |config| config.read_only = false }
       RailsReadonlyInjector.reload!
     end
 
-   context 'when `read_only` is changed' do
-    before(:each) { RailsReadonlyInjector.config.read_only = true }
-    
-    context 'and `reload!` is not called' do
-      subject { RailsReadonlyInjector.config.dirty? }
+    context 'when `read_only` is changed' do
+      before(:each) { RailsReadonlyInjector.config.read_only = true }
 
-      it { is_expected.to eq(true) }
-    end
+      context 'and `reload!` is not called' do
+        subject { RailsReadonlyInjector.config.dirty? }
+
+        it { is_expected.to eq(true) }
+      end
 
-    context 'and `reload!` is called' do
-      before { RailsReadonlyInjector.reload! }
-      subject { RailsReadonlyInjector.config.dirty? }
+      context 'and `reload!` is called' do
+        before { RailsReadonlyInjector.reload! }
+        subject { RailsReadonlyInjector.config.dirty? }
 
-      it { is_expected.to eq(false) }
+        it { is_expected.to eq(false) }
+      end
     end
-   end
   end
-end
+end

data/rspec_specs/rails_readonly_injector_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 
 RSpec.describe RailsReadonlyInjector do
@@ -87,9 +89,10 @@ RSpec.describe RailsReadonlyInjector do
 
       context 'when `config.read_only` is not changed' do
         before { RailsReadonlyInjector.config.classes_to_exclude = [User] }
+        subject { RailsReadonlyInjector.in_read_only_mode? }
 
         it 'returns the current value' do
-          expect(RailsReadonlyInjector.in_read_only_mode?).to eq(RailsReadonlyInjector.config.send(:read_only))
+          expect(subject).to eq(RailsReadonlyInjector.config.send(:read_only))
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_readonly_injector
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew Walter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,51 +27,51 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -96,18 +96,17 @@ files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- cucumber-rails-1.6.0.pre.gem
 - cucumber_features/configuration.feature
 - cucumber_features/step_definitions/.gitkeep
 - cucumber_features/step_definitions/generic_steps.rb
@@ -117,6 +116,8 @@ files:
 - cucumber_features/user_controller_readonly.feature
 - cucumber_features/user_model.feature
 - cucumber_features/user_model_readonly.feature
+- development_tasks/support/file_helpers.rb
+- development_tasks/support/gem_helpers.rb
 - development_tasks/tests.rake
 - gemfiles/.bundle/config
 - gemfiles/rails_3.gemfile
@@ -153,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Globally toggle 'read-only' mode in a Rails application, on-demand, without

data/Gemfile.lock

@@ -1,134 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rails_readonly_injector (1.0.0)
-      rails (>= 3.0, <= 5.2)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (5.2.0)
-      actionpack (= 5.2.0)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailer (5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (5.2.0)
-      actionview (= 5.2.0)
-      activesupport (= 5.2.0)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.0)
-      activesupport (= 5.2.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.0)
-      activesupport (= 5.2.0)
-      globalid (>= 0.3.6)
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
-      arel (>= 9.0)
-    activestorage (5.2.0)
-      actionpack (= 5.2.0)
-      activerecord (= 5.2.0)
-      marcel (~> 0.3.1)
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    appraisal (2.2.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (9.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
-    erubi (1.7.1)
-    globalid (0.4.1)
-      activesupport (>= 4.2.0)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    loofah (2.2.2)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.0)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.2)
-      mimemagic (~> 0.3.2)
-    method_source (0.9.0)
-    mimemagic (0.3.2)
-    mini_mime (1.0.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nio4r (2.3.0)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    rack (2.0.4)
-    rack-test (1.0.0)
-      rack (>= 1.0, < 3)
-    rails (5.2.0)
-      actioncable (= 5.2.0)
-      actionmailer (= 5.2.0)
-      actionpack (= 5.2.0)
-      actionview (= 5.2.0)
-      activejob (= 5.2.0)
-      activemodel (= 5.2.0)
-      activerecord (= 5.2.0)
-      activestorage (= 5.2.0)
-      activesupport (= 5.2.0)
-      bundler (>= 1.3.0)
-      railties (= 5.2.0)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.0)
-      actionpack (= 5.2.0)
-      activesupport (= 5.2.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.18.1, < 2.0)
-    rake (10.5.0)
-    sprockets (3.7.1)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.0)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
-    yard (0.9.12)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal (~> 2.2)
-  bundler (~> 1.16)
-  rails_readonly_injector!
-  rake (~> 10.0)
-  yard (~> 0.9.12)
-
-BUNDLED WITH
-   1.16.1