rails_readonly_injector 0.2.0 → 1.2.0

data/development_tasks/tests.rake

@@ -1,130 +1,77 @@
-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
-    ENV.delete('BUNDLE_GEMFILE')
-    ENV.delete('BUNDLE_BIN_PATH')
-    ENV.delete('RUBYOPT')
+    unset_appraisal_environment_variables
 
     # Install gems
-    system("bundle install --binstubs")
+    system("bundle install")
 
-    puts "Installing Cucumber..."
-    system("bundle exec rails generate cucumber:install")
-
-    puts "Installing RSpec..."
-    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")
-  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 do
-    switch_to_rails_app_path
-
-    # Set up the Cucumber and RSpec tests
-    FileUtils.cp_r File.join(GEM_ROOT_PATH, 'cucumber_features', '.'), 'features'
-    FileUtils.cp_r File.join(GEM_ROOT_PATH, 'rspec_specs', '.'), 'spec'
-
-    exit_code = system('bundle exec cucumber && bundle exec rspec')
-    exit exit_code
+    system('RAILS_ENV=test bundle exec rake db:migrate')
   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?
+  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]
 
-      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
+  desc 'Synchronises features from `cucumber_features` into the temporary rails app, and runs them.'
+  task :run_features do
+    switch_to_rails_app_path
 
-  def switch_to_gems_root_path
-    FileUtils.cd GEM_ROOT_PATH
-  end
+    # Synchronise the cucumber features
+    FileUtils.cp_r File.join(gems_root_path, 'cucumber_features'), 'features'
 
-  def switch_to_rails_app_path
-    FileUtils.cd RAILS_APP_PATH
-  end
+    unset_appraisal_environment_variables
 
-  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
+    command_executed_successfully = system('bundle exec cucumber')
+    
+    exit 1 unless command_executed_successfully
   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
+  desc 'Synchronise specs from `rspec_specs` into the temporary rails app, and run rspec.'
+  task :run_specs do
+    switch_to_rails_app_path
 
-    existing_content_as_array = File.open(path_to_file, 'r').readlines
+    # Synchronise the RSpec specs
+    FileUtils.cp_r File.join(gems_root_path, 'rspec_specs'), 'spec'
 
-    new_content_arr = [content] + existing_content_as_array
+    unset_appraisal_environment_variables
 
-    write_file_with_content path_to_file, new_content_arr.join("\n")
+    command_executed_successfully = system('bundle exec rspec')
+    
+    exit 1 unless command_executed_successfully
   end
 
-  def write_file_with_content(path_to_file, content)
-    File.open(path_to_file, 'w') do |f|
-      f.write content
-    end
-  end
 end

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+gem "cucumber-rails", "~> 1.6.0", group: :test, require: false
+gem "rspec-rails", "~> 3.7.2", group: :test
+gem "database_cleaner", "~> 1.0.1"
+
+gemspec path: "../"

data/lib/rails_readonly_injector.rb

@@ -1,33 +1,50 @@
-require "rails_readonly_injector/version"
-require "rails_readonly_injector/configuration"
+# frozen_string_literal: true
+
+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!
-
-    Rails.application.eager_load!
-
-    if Rails::VERSION::STRING < '5.0.0'
-      descendants = ActiveRecord::Base.descendants
-    else
-      descendants = ApplicationRecord.descendants
-    end
-
-    descendants.each do |descendant_class|
-    
-      # Ensure excluded classes aren't set to read-only
-      if config.classes_to_exclude.include? descendant_class
-        restore_readonly_method(descendant_class)
+    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
+        restore_readonly_method(klass)
         next
       end
 
-      if self.config.read_only
-        override_readonly_method(descendant_class)
+      if config.send(:read_only)
+        override_readonly_method(klass)
       else
-        restore_readonly_method(descendant_class)
+        restore_readonly_method(klass)
       end
     end
 
     inject_error_handler_into_actioncontroller_base
+
+    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 config.dirty? && config.changed_attributes.key?(:read_only)
+      # Return the previously stored value
+      config.changed_attributes[:read_only]
+    else
+      config.send(:read_only)
+    end
+  end
+
+  # Sets the desired configuration object, if a block is provided,
+  # and then returns the current configuration object.
+  # @return [Configuration] The current configuration object.
+  def self.config
+    yield configuration if block_given?
+
+    configuration
   end
 
   private
@@ -53,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,44 +1,110 @@
+# frozen_string_literal: true
+
 module RailsReadonlyInjector
   class Configuration
-    attr_writer :read_only, :classes_to_exclude
+    attr_reader :controller_rescue_action, :classes_to_include, :classes_to_exclude
+
+    def initialize
+      @read_only = false
+      @controller_rescue_action = proc {}
+      @classes_to_exclude = []
+
+      @changed_attributes = {}
+    end
+
+    # @return [Array<Class>] An array of classes to include
+    # If not specified upon initialisation, it defaults to:
+    #   ActiveRecord::Base.descendants on Rails < 5.0.0, or
+    #   ApplicationRecord.descendants on Rails >= 5.0.0
+    def classes_to_include
+      return @classes_to_include if defined? @classes_to_include
+
+      Rails.application.eager_load!
+
+      if Rails::VERSION::STRING < '5.0.0'
+        ActiveRecord::Base.descendants
+      else
+        ApplicationRecord.descendants
+      end
+    end
+
+    #######################
+    # Setter Methods      #
+    #######################
 
-    def read_only
-      @read_only || false
+    # @param new_value [Boolean] Whether the site should be in read-only mode
+    def read_only=(new_value)
+      update_instance_variable('@read_only', new_value)
     end
 
+    # @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
 
-      @controller_rescue_action = action
+      update_instance_variable('@controller_rescue_action', action)
     end
 
-    def controller_rescue_action
-      @controller_rescue_action || Proc.new {}
+    # @param klasses [Array<Class>] The classes to exclude from being marked as read-only
+    def classes_to_exclude=(klasses)
+      update_instance_variable('@classes_to_exclude', klasses)
     end
 
-    def classes_to_exclude
-      @classes_to_exclude || []
+    # @param klasses [Array<Class>] The classes to mark as read-only
+    def classes_to_include=(klasses)
+      update_instance_variable('@classes_to_include', klasses)
     end
-  end
-  private_constant :Configuration
 
-   # Sets the specified configuration options, if a block is provided
-  # @return [Configuration] the current configuration object.
-  def self.config
-    yield self.configuration if block_given?
+    #####################
+    # Instance methods  #
+    #####################
 
-    self.configuration
-  end
+    # @return [Boolean] Whether the configuration
+    #   has changed since the config was last reloaded
+    def dirty?
+      !changed_attributes.empty?
+    end
 
-  def self.reset_configuration!
-    @config = Configuration.new
+    # @return [Hash] A hash of changed attributes
+    #   and their previous values
+    attr_reader :changed_attributes
+
+    private
+
+    # Updates the value of the specified instance variable
+    # and tracks the attribute's previous value (for `#dirty?`)
+    def update_instance_variable(variable_name, new_value)
+      old_value = instance_variable_get(variable_name).freeze
+
+      instance_variable_set(variable_name.to_sym, new_value)
+
+      unless old_value == new_value
+        changed_attributes[variable_name.to_s.delete('@').to_sym] = old_value
+      end
+    end
+
+    # Resets the changed attributes hash,
+    # so that `#dirty?` returns false
+    def reset_dirty_status!
+      @changed_attributes = {}
+    end
 
-    self.reload!
+    attr_reader :read_only
   end
+  private_constant :Configuration
 
   private
 
+  # @return [Configuration] The current configuration object
   def self.configuration
     @config ||= Configuration.new
   end
-end
+
+  # Resets the current configuration to the defaults
+  # and reloads RailsReadonlyInjector
+  def self.reset_configuration!
+    @config = Configuration.new
+
+    reload!
+  end
+end

data/lib/rails_readonly_injector/version.rb

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

data/rails_readonly_injector.gemspec

@@ -1,30 +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', '>= 12.3.3'
+  spec.add_development_dependency 'yard', '~> 0.9.12'
 end