rails_readonly_injector 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c17f3a71ff8c4089bfc183fd0b661a50f0b3d60
+  data.tar.gz: eda68bb545c0cfe97dfc2c15227cd271a15f41ae
+SHA512:
+  metadata.gz: 55e15401c1aef32c37f4e7ad5b921a2ef7fc81554e421f948b598b778cc647f588cf76d901854bde6bdcde209cca70f76b0d8b8baed9c9c109d551193d14f58a
+  data.tar.gz: fd618f6e50007598655d667e9dcda0412ae5e9582c9b0e0a94437171f0d98c5106381f36c19811c97c34ae4bc0ca224cc420fc21fd0399f121bd23394550e01d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+gemfiles/*.gemfile.lock
+.byebug_history

data/.travis.yml

@@ -0,0 +1,56 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=42f23507800f7e37490680c9eb163455d5214d7f8c7140d0757e4858fa809497
+language: ruby
+rvm:
+ - 2.1.3
+ - 2.2.7
+ - 2.3.6
+ - 2.4.1
+ - ruby-head
+
+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
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+gemfile:
+  - gemfiles/rails_3.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+
+matrix:
+  fast_finish: true
+  exclude:
+    - rvm: 2.1.3
+      gemfile: gemfiles/rails_4_1.gemfile
+    - rvm: 2.1.3
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 2.1.3
+      gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.2.7
+      gemfile: gemfiles/rails_3.gemfile
+    - rvm: 2.3.6
+      gemfile: gemfiles/rails_3.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails_3.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails_4_0.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails_4_1.gemfile
+    - rvm: jruby
+      gemfile: gemfiles/rails_3.gemfile
+    - rvm: rbx-3
+      gemfile: gemfiles/rails_3.gemfile
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -0,0 +1,38 @@
+appraise 'rails_3' do
+  gem 'rails', '~> 3'
+  gem 'cucumber-rails', '~> 1.4.5'
+  gem 'rspec-rails', '~> 3.7.2', group: :test
+  gem 'database_cleaner', '~> 1.0.1'
+  gem 'sass', '= 3.4.21'
+end
+
+appraise 'rails_4_0' do
+  gem 'rails', '~> 4.0.0'
+  gem 'cucumber-rails', '~> 1.5.0', group: :test, require: false
+  gem 'rspec-rails', '~> 3.7.2', group: :test
+  gem 'database_cleaner', '~> 1.0.1'
+  gem 'sqlite3', '~> 1.3.13'
+end
+
+appraise 'rails_4_1' do
+  gem 'rails', '~> 4.1.0'
+  gem 'cucumber-rails', '~> 1.5.0', group: :test, require: false
+  gem 'rspec-rails', '~> 3.7.2', group: :test
+  gem 'database_cleaner', '~> 1.0.1'
+  gem 'sqlite3', '~> 1.3.13'
+end
+
+appraise 'rails_4_2' do
+  gem 'rails', '~> 4.2.0'
+  gem 'cucumber-rails', '~> 1.5.0', group: :test, require: false
+  gem 'rspec-rails', '~> 3.7.2', group: :test
+  gem 'database_cleaner', '~> 1.0.1'
+  gem 'sqlite3', '~> 1.3.13'
+end
+
+appraise 'rails_5_0' do
+  gem 'rails', '~> 5.0.0'
+  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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andrew.walter@burnet.edu.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+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/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    rails_readonly_injector (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    rake (10.5.0)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2.0)
+  bundler (~> 1.16)
+  rails_readonly_injector!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew Walter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# Rails ReadOnly Injector
+[![Build Status](https://travis-ci.org/xtrasimplicity/rails_readonly_injector.svg?branch=master)](https://travis-ci.org/xtrasimplicity/rails_readonly_injector)
+[![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)
+
+Easily switch a Rails site into 'read-only' mode, and back again, without restarting the server.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_readonly_injector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_readonly_injector
+
+## 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:
+
+```
+# 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.
+
+    # You may want to set a redirect, or flash an error message, or something, here.
+    # e.g.
+    # flash[:danger] = 'The site is currently in read-only mode'
+    # redirect_to readonly_page_url
+  end
+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.
+
+If you want to reset the configuration to the defaults, you can simply call `RailsReadonlyInjector.reset_configuration!` from anywhere in your application.
+
+## 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`.
+
+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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xtrasimplicity/rails_readonly_injector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsReadonlyInjector project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/xtrasimplicity/rails_readonly_injector/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+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']

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cucumber_features/configuration.feature

@@ -0,0 +1,29 @@
+Feature: Configuration
+  Scenario: When changing from read-only back to writeable
+    Given I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = true
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    When I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = false
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    Then I should be able to create a user without any errors
+
+
+#Feature: Configuration
+#  Scenario: When `allowed_models` is set
+#    Given I configure RailsReadonlyInjector with:
+#    """
+#      RailsReadonlyInjector.config do |config|
+#        config.allowed_models = ['User']
+#    """
+#    When 

data/cucumber_features/step_definitions/generic_steps.rb

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

data/cucumber_features/step_definitions/user_steps.rb

@@ -0,0 +1,70 @@
+Given("There is a user that has been persisted to the database") do  
+  RailsReadonlyInjector.config.read_only = false
+  RailsReadonlyInjector.reload!
+
+  @user = User.create(name: 'Bob')
+
+  expect(@user.persisted?).to eq(true)
+end
+
+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
+  begin
+    @user.update_attributes(name: 'Fred')
+  rescue ActiveRecord::ReadOnlyRecord
+  end
+end
+
+When("I save the user") do
+  begin
+    @user.save
+  rescue ActiveRecord::ReadOnlyRecord
+  end
+end
+
+Then("the user should not be updated") do
+  @user.reload
+  
+  expect(@user.name).to eq('Bob')
+end
+
+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
+
+  expect(@user.persisted?).to eq(true)
+end
+
+Then("the user should not be saved") do
+  expect(User.all.length).to eq(0)
+end
+
+When("I'm using a web browser and attempt to update the user") do
+  visit "/users/#{@user.id}/edit"
+  fill_in 'user[name]', with: 'Fred'
+  click_on 'Update User'
+end
+
+When("I'm using a web browser and attempt to create a user") do
+  visit "/users/new"
+  fill_in 'user[name]', with: 'Fred'
+  click_on 'Create User'
+end
+
+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
+  expect { User.create(name: 'Bob') }.not_to raise_error
+end

data/cucumber_features/user_controller.feature

@@ -0,0 +1,20 @@
+Feature: Users Controller - When not in read only mode
+  Background:
+    Given I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = false
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+
+  Scenario:  A user has previously been persisted to the database, and an attempt to update it has been made
+    Given There is a user that has been persisted to the database
+    When I'm using a web browser and attempt to update the user
+    Then the user should be updated
+    
+
+  Scenario:  A new user is created (and was not previously persisted to the database), and an attempt to save it has been made
+    Given I'm using a web browser and attempt to create a user
+    Then the user should be created

data/cucumber_features/user_controller_readonly.feature

@@ -0,0 +1,33 @@
+Feature: User Controller - When in read only mode    
+  Scenario:  A user has previously been persisted to the database, and an attempt to update it has been made
+    Given There is a user that has been persisted to the database
+    And I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = true
+      config.controller_rescue_action = lambda do |context|
+        render :text => 'The site is currently in read-only mode'
+      end
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    When I'm using a web browser and attempt to update the user
+    Then The page should contain 'The site is currently in read-only mode'
+    And the user should not be updated
+    
+
+  Scenario:  A new user is created (and was not previously persisted to the database), and an attempt to save it has been made
+    Given I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = true
+      config.controller_rescue_action = lambda do |context|
+        render :text => 'The site is currently in read-only mode'
+      end
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    When I'm using a web browser and attempt to create a user
+    Then the user should not be saved

data/cucumber_features/user_model.feature

@@ -0,0 +1,20 @@
+Feature: User model - When not in read-only mode
+  Background:
+    Given I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = false
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+
+  Scenario:  A user has previously been persisted to the database, and an attempt to update it has been made
+    Given There is a user that has been persisted to the database
+    When I update the user
+    Then the user should be updated
+
+  Scenario:  A new user is created (and was not previously persisted to the database), and an attempt to save it has been made
+    Given There is a user that has not been persisted to the database
+    When I save the user
+    Then the user should be saved

data/cucumber_features/user_model_readonly.feature

@@ -0,0 +1,26 @@
+Feature: User model - When in read-only mode
+  Scenario: A user has previously been persisted to the database, and an attempt to update it has been made
+    Given There is a user that has been persisted to the database
+    And I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = true
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    When I update the user
+    Then the user should not be updated
+
+  Scenario:  A new user is created (and was not previously persisted to the database), and an attempt to save it has been made
+    Given There is a user that has not been persisted to the database
+    And I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = true
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    When I save the user
+    Then the user should not be saved

data/development_tasks/tests.rake

@@ -0,0 +1,127 @@
+require 'fileutils'
+
+namespace :dev do
+  RAILS_APP_PATH = File.expand_path('../../tmp/rails_app', __FILE__).freeze
+  GEM_ROOT_PATH = File.expand_path('../..', __FILE__).freeze
+
+  desc "Deploys a test rails application into the #{RAILS_APP_PATH} directory."
+  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}")
+
+    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 }
+
+    # 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}
+
+    # Make sure we don't use the gemfile from Appraisal
+    ENV.delete('BUNDLE_GEMFILE')
+    ENV.delete('BUNDLE_BIN_PATH')
+    ENV.delete('RUBYOPT')
+
+    # Install gems
+    system("bundle install")
+
+    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'"
+    
+    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("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'
+
+    system('bundle exec cucumber')
+    system('bundle exec rspec')
+  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
+end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_3.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3"
+gem "cucumber-rails", "~> 1.4.5"
+gem "rspec-rails", "~> 3.7.2", group: :test
+gem "database_cleaner", "~> 1.0.1"
+gem "sass", "= 3.4.21"
+
+gemspec path: "../"

data/gemfiles/rails_4_0.gemfile

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

data/gemfiles/rails_4_1.gemfile

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

data/gemfiles/rails_4_2.gemfile

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

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "cucumber-rails", "~> 1.5.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

@@ -0,0 +1,57 @@
+require "rails_readonly_injector/version"
+require "rails_readonly_injector/configuration"
+
+module RailsReadonlyInjector
+  def self.reload!
+    descendants = ActiveRecord::Base.descendants
+
+    if descendants.empty?
+      Rails.application.eager_load!
+      descendants = ActiveRecord::Base.descendants
+    end
+
+    descendants.each do |descendant_class|
+      if self.config.read_only
+        override_readonly_method(descendant_class)
+      else
+        restore_readonly_method(descendant_class)
+      end
+    end
+
+    inject_error_handler_into_actioncontroller_base
+  end
+
+  private
+
+  ALIASED_METHOD_NAME = :old_readonly?
+
+  def self.override_readonly_method(klass)
+    klass.class_eval do
+      alias_method ALIASED_METHOD_NAME, :readonly?
+
+      def readonly?
+        true
+      end
+    end
+  end
+
+  def self.restore_readonly_method(klass)
+    klass.class_eval do
+      def readonly?
+        super
+      end
+    end
+  end
+
+  def self.inject_error_handler_into_actioncontroller_base
+    ActionController::Base.class_eval do |klass|
+      rescue_from ActiveRecord::ReadOnlyRecord, with: :rescue_from_readonly_failure
+
+      protected
+
+      def rescue_from_readonly_failure
+        instance_eval &RailsReadonlyInjector.config.controller_rescue_action
+      end
+    end
+  end
+end

data/lib/rails_readonly_injector/configuration.rb

@@ -0,0 +1,40 @@
+module RailsReadonlyInjector
+  class Configuration
+    attr_writer :read_only
+
+    def read_only
+      @read_only || false
+    end
+
+    def controller_rescue_action=(action)
+      raise 'A lambda or proc must be specified' unless action.respond_to? :call
+
+      @controller_rescue_action = action
+    end
+
+    def controller_rescue_action
+      @controller_rescue_action || Proc.new {}
+    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?
+
+    self.configuration
+  end
+
+  def self.reset_configuration!
+    @config = Configuration.new
+
+    self.reload!
+  end
+
+  private
+
+  def self.configuration
+    @config ||= Configuration.new
+  end
+end

data/lib/rails_readonly_injector/version.rb

@@ -0,0 +1,3 @@
+module RailsReadonlyInjector
+  VERSION = "0.1.1"
+end

data/rails_readonly_injector.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_readonly_injector/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_readonly_injector"
+  spec.version       = RailsReadonlyInjector::VERSION
+  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"
+  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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1.3"
+
+  spec.add_runtime_dependency "rails", ">= 3.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'appraisal', '~> 2.2.0'
+end

data/rspec_specs/readonly_site_toggle/configuration_spec.rb

@@ -0,0 +1,31 @@
+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 }
+
+      subject { RailsReadonlyInjector.config.controller_rescue_action }
+
+      it { is_expected.to eq(lambda_expression) }
+    end
+
+    context 'when given a Proc' do
+      let(:proc) { Proc.new { "This is a test Proc!" } }
+
+      before { RailsReadonlyInjector.config.controller_rescue_action = proc }
+
+      subject { RailsReadonlyInjector.config.controller_rescue_action }
+
+      it { is_expected.to eq(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'
+      end
+    end
+  end
+end

data/rspec_specs/readonly_site_toggle_spec.rb

@@ -0,0 +1,59 @@
+require 'rails_helper'
+
+RSpec.describe RailsReadonlyInjector do
+  describe '.reset_configuration!' do
+    before do
+      RailsReadonlyInjector.config do |config|
+        config.read_only = true
+      end
+
+      RailsReadonlyInjector.reset_configuration!
+    end
+
+    subject { RailsReadonlyInjector.config }
+
+    it 'sets `read_only` to false' do
+      expect(RailsReadonlyInjector.config.read_only).to eq(false)
+    end
+  end
+
+  describe '.override_readonly_method' do
+    let(:klass) { User }
+
+    before do
+      RailsReadonlyInjector.config do |config|
+        config.read_only = true
+      end
+
+      RailsReadonlyInjector.reload!
+
+      RailsReadonlyInjector.send(:override_readonly_method, klass)
+    end
+
+    describe 'An ActiveRecord object\'s #readonly? method' do
+      subject { klass.new.readonly? }
+
+      it { is_expected.to eq(true) }
+    end
+  end
+
+  describe '.restore_readonly_method' do
+    let(:klass) { User }
+
+    before do
+      RailsReadonlyInjector.config do |config|
+        config.read_only = false
+      end
+
+      RailsReadonlyInjector.reload!
+
+      RailsReadonlyInjector.send(:restore_readonly_method, klass)
+    end
+
+    describe('An ActiveRecord object\'s #readonly? method') do
+      subject { klass.new.readonly? }
+
+      it { is_expected.to eq(false) }
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: rails_readonly_injector
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Andrew Walter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+description: 
+email:
+- andrew.walter@burnet.edu.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cucumber_features/configuration.feature
+- cucumber_features/step_definitions/.gitkeep
+- cucumber_features/step_definitions/generic_steps.rb
+- cucumber_features/step_definitions/user_steps.rb
+- cucumber_features/support/.gitkeep
+- cucumber_features/user_controller.feature
+- cucumber_features/user_controller_readonly.feature
+- cucumber_features/user_model.feature
+- cucumber_features/user_model_readonly.feature
+- development_tasks/tests.rake
+- gemfiles/.bundle/config
+- gemfiles/rails_3.gemfile
+- gemfiles/rails_4_0.gemfile
+- gemfiles/rails_4_1.gemfile
+- gemfiles/rails_4_2.gemfile
+- gemfiles/rails_5_0.gemfile
+- lib/rails_readonly_injector.rb
+- lib/rails_readonly_injector/configuration.rb
+- lib/rails_readonly_injector/version.rb
+- rails_readonly_injector.gemspec
+- rspec_specs/.gitkeep
+- rspec_specs/readonly_site_toggle/configuration_spec.rb
+- rspec_specs/readonly_site_toggle_spec.rb
+- rspec_specs/support/.gitkeep
+homepage: https://www.github.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Globally toggle 'read-only' mode in a Rails application, on-demand, without
+  having to restart the server.
+test_files: []