rails_readonly_injector 0.2.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9509703bc12b066f6af792e478484e61bb0a0249
-  data.tar.gz: 21225186b776c134d52ec75b95ce3483fd70c21f
+SHA256:
+  metadata.gz: b312c92be7dd7bf454f93b2359d6615eac31e5db380c10823da084b1a012c43f
+  data.tar.gz: 82fd6c6929b64104bf7d68044e5c13557bf798cedaad996a5495234c99d08366
 SHA512:
-  metadata.gz: e5aa0948322922fd1940fb817fe4ac52bdcbf3fdc2ff3f1630835e7cd80f4fd4f0bb990812f974b447c2364379f008c5bb951fbf643fd8feb82b5a8fb949c25b
-  data.tar.gz: 2d7734d7370b5eda65ceababacd75302013dddfd4c26ba2e95fcc4126e75db3c00310198d92a9e9d5d2b9790846f544422a8f67c4f03a4489431886108ec5bb6
+  metadata.gz: 5ebe26220df8db19da6ddf8623b5fb7f3d09a3c192eac5ffec3794106b9008126cbb4276f222027e6e4bfbfa1871f3abbd7da2f7356267a77a9e57760a677a5c
+  data.tar.gz: 476aa9f4c712902fac248b7b185a931b13d056f4414b5b483842087c19ddc7116118ddece04f3a86f41f579f2af1efe5826bce525f3846c60e2a851cf9bc680d

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+  1.
+  2.
+  3.
+  4.
+
+## Specifications
+
+  - Version:
+  - Platform:
+  - Subsystem:

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+## Problem
+
+<!-- Describe the problem that this PR resolves -->
+
+#### Related issues:
+<!-- Link to issues that are related to this problem. If there aren't any, you can remove the heading. -->
+
+## How this PR resolves the problem
+
+<!--- Describe how your PR resolves this problem -->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue).
+- [ ] New feature (non-breaking change which adds functionality).
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
+
+## Checklist:
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+- [ ] I've added tests for my code.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.

data/.gitignore

@@ -8,4 +8,4 @@
 /tmp/
 gemfiles/*.gemfile.lock
 .byebug_history
-Gemfile.lock
+Gemfile.lock

data/.rubocop.yml

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

data/.travis.yml

@@ -13,7 +13,6 @@ branches:
   only:
     - master
 
-
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
   - chmod +x ./cc-test-reporter
@@ -29,6 +28,7 @@ gemfile:
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
   - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile
 
 matrix:
   fast_finish: true
@@ -41,6 +41,8 @@ matrix:
       gemfile: gemfiles/rails_5_0.gemfile
     - rvm: 2.1.3
       gemfile: gemfiles/rails_5_1.gemfile
+    - rvm: 2.1.3
+      gemfile: gemfiles/rails_5_2.gemfile
     - rvm: 2.2.7
       gemfile: gemfiles/rails_3.gemfile
     - rvm: 2.3.6

data/Appraisals

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 appraise 'rails_3' do
   gem 'rails', '~> 3'
   gem 'cucumber-rails', '~> 1.4.5'
@@ -43,4 +45,11 @@ appraise 'rails_5_1' do
   gem 'cucumber-rails', '~> 1.5.0', group: :test, require: false
   gem 'rspec-rails', '~> 3.7.2', group: :test
   gem 'database_cleaner', '~> 1.0.1'
-end
+end
+
+appraise 'rails_5_2' do
+  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'
+end

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.0.1
+ - Added support for Rails 5.2
+## 1.0.0
+ - Removed the ability to read the current read-only status using `RailsReadonlyInjector.config.read_only`, and replaced it with `RailsReadonlyInjector.in_read_only_mode?`.
+## 0.3.0
+ - Added ability to explicitly include specific classes.
 ## 0.2.0
  - Added ability to exclude specific classes from read-only mode.
  - Improved support for Rails 5 (Automatic inclusion of descendants of `ApplicationRecord` rather than `ActiveRecord::Base`).

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/README.md

@@ -1,5 +1,6 @@
 # Rails ReadOnly Injector
 [![Build Status](https://travis-ci.org/xtrasimplicity/rails_readonly_injector.svg?branch=master)](https://travis-ci.org/xtrasimplicity/rails_readonly_injector)
+[![Read the Docs](https://img.shields.io/readthedocs/pip.svg)](http://www.rubydoc.info/github/xtrasimplicity/rails_readonly_injector/master)
 [![Maintainability](https://api.codeclimate.com/v1/badges/427c153efd48ae03f688/maintainability)](https://codeclimate.com/github/xtrasimplicity/rails_readonly_injector/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/427c153efd48ae03f688/test_coverage)](https://codeclimate.com/github/xtrasimplicity/rails_readonly_injector/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/rails_readonly_injector.svg)](https://badge.fury.io/rb/rails_readonly_injector)
@@ -24,14 +25,16 @@ Or install it yourself as:
 
 ## Usage
 
-In order to switch a complete site into read-only mode, you will first need to set the action to occur when an attempt to commit changes to the database is made, from within a controller. Usually, this won't need to change once the application has booted, so I recommend defining it within an initializer, as follows:
+In order to switch a complete site into read-only mode, you will first need to set the action to occur when an attempt to commit changes to the database is made, from within a controller. This action will be executed from within the context of the referring controller.
+
+Usually, this won't need to change once the application has booted, so I recommend defining it within an initializer, as follows:
 
 ```
 # config/initializers/rails_readonly_injector.rb
 RailsReadonlyInjector.config do |config|
   config.controller_rescue_action = lambda do |context|
     # Define actions to be performed if changes to a read-only model are attempted to be committed to the database.
-    # This lambda expression is evaluated from within the instance of the referring controller.
+    # This lambda expression is evaluated from within the context of the referring controller.
 
     # You may want to set a redirect, or flash an error message, or something, here.
     # e.g.
@@ -41,21 +44,37 @@ RailsReadonlyInjector.config do |config|
 end
 ```
 
-When you want to switch a site into read-only mode, you can then simply set `RailsReadonlyInjector.read_only` to true and then call `RailsReadonlyInjector.reload!` to (re-)load the configuration. Alternatively, you can also set `read_only` from within the configuration block inside the initializer.
+When you want to switch a site into read-only mode, you can then simply
+* set `RailsReadOnlyInjector.config.read_only` to true, and then 
+* call `RailsReadonlyInjector.reload!` to (re-)load the configuration. 
+
+Alternatively, you can also set `read_only` from within the configuration block inside the initializer.
 
 If you want to reset the configuration to the defaults, you can simply call `RailsReadonlyInjector.reset_configuration!` from anywhere in your application.
 
+If you want to check whether read-only mode is currently enabled, you can use `RailsReadonlyInjector.in_read_only_mode?`.
+
 ## Configuration Options
+The following configuration options can be set through `RailsReadonlyInjector.config`:
+
 - `read_only` => Whether the site should be in read-only mode. (Default: false)
-- `exclude_classes` => An array of classes that should be exempt from read-only mode.
+- `classes_to_exclude` => An array of classes that should be _exempt_ from read-only mode. (Default: `[]`)
+- `classes_to_include` => An array of classes that should be set to read-only mode. (Defaults to `ActiveRecord::Base.descendants` on Rails 3-4, and `ApplicationRecord.descendants` on Rails 5.0+)
 - `controller_rescue_action` => A lambda expression/Proc to execute when an `ActiveRecord::ReadOnlyRecord` error is raised, from within a controller.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install the dependencies.
 
-RSpec specs and Cucumber features are stored in `rspec_specs` and `cucumber_features`, respectively. When `bundle exec rake` is run against an appraisal, the contents of these folders are copied to the necessary folders under the temporary rails application that is generated (by `bundle exec rake`) into `tmp/rails_app`.
+RSpec specs and Cucumber features are stored in `rspec_specs` and `cucumber_features`, respectively. When `bundle exec rake` is run against an appraisal, the contents of these folders are copied to the necessary folders under the temporary rails application that `bundle exec rake` generates into `tmp/rails_app`.
+
+To run tests for a specific version of Rails, simply run `bundle exec appraisal {APPRAISAL} bundle exec rake`, where `{APPRAISAL}` is one of the appraisals found under `Appraisals`. e.g. `bundle exec appraisal rails_4_1 bundle exec rake`
+
+If you don't want to re-build the temporary application each time you run tests, you can execute the following rake tasks against an appraisal:
 
-To run tests for a specific version of Rails, simply run `bundle exec appraisal {APPRAISAL} bundle exec rake`, where `{APPRAISAL}` is one of the appraisals found under `Appraisals`.
+* `dev:run_features` => Synchronises features from `cucumber_features` into the temporary rails application, and runs cucumber against the temporary application.
+* `dev:run_specs` => Synchronises specs from `rspec_specs` into the temporary rails application, and runs rspec against the temporary application.
+* `dev:run_tests` => Runs both `dev:run_features` and `dev:run_specs`, and ret on failure.
 
 ## Contributing
 

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,43 +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
+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
 
@@ -54,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