rails_readonly_injector 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c17f3a71ff8c4089bfc183fd0b661a50f0b3d60
-  data.tar.gz: eda68bb545c0cfe97dfc2c15227cd271a15f41ae
+  metadata.gz: 9509703bc12b066f6af792e478484e61bb0a0249
+  data.tar.gz: 21225186b776c134d52ec75b95ce3483fd70c21f
 SHA512:
-  metadata.gz: 55e15401c1aef32c37f4e7ad5b921a2ef7fc81554e421f948b598b778cc647f588cf76d901854bde6bdcde209cca70f76b0d8b8baed9c9c109d551193d14f58a
-  data.tar.gz: fd618f6e50007598655d667e9dcda0412ae5e9582c9b0e0a94437171f0d98c5106381f36c19811c97c34ae4bc0ca224cc420fc21fd0399f121bd23394550e01d
+  metadata.gz: e5aa0948322922fd1940fb817fe4ac52bdcbf3fdc2ff3f1630835e7cd80f4fd4f0bb990812f974b447c2364379f008c5bb951fbf643fd8feb82b5a8fb949c25b
+  data.tar.gz: 2d7734d7370b5eda65ceababacd75302013dddfd4c26ba2e95fcc4126e75db3c00310198d92a9e9d5d2b9790846f544422a8f67c4f03a4489431886108ec5bb6

data/.gitignore

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

data/.travis.yml

@@ -28,6 +28,7 @@ gemfile:
   - gemfiles/rails_4_1.gemfile
   - gemfiles/rails_4_2.gemfile
   - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
 
 matrix:
   fast_finish: true
@@ -38,6 +39,8 @@ matrix:
       gemfile: gemfiles/rails_4_2.gemfile
     - rvm: 2.1.3
       gemfile: gemfiles/rails_5_0.gemfile
+    - rvm: 2.1.3
+      gemfile: gemfiles/rails_5_1.gemfile
     - rvm: 2.2.7
       gemfile: gemfiles/rails_3.gemfile
     - rvm: 2.3.6

data/Appraisals

@@ -12,6 +12,7 @@ appraise 'rails_4_0' do
   gem 'rspec-rails', '~> 3.7.2', group: :test
   gem 'database_cleaner', '~> 1.0.1'
   gem 'sqlite3', '~> 1.3.13'
+  gem 'xpath', '~> 2.1.0'
 end
 
 appraise 'rails_4_1' do
@@ -35,4 +36,11 @@ appraise 'rails_5_0' 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
+
+appraise 'rails_5_1' do
+  gem 'rails', '~> 5.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'
 end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 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`).
+## 0.1.1
+ - Initial release

data/Gemfile.lock

@@ -1,23 +1,114 @@
 PATH
   remote: .
   specs:
-    rails_readonly_injector (0.1.0)
+    rails_readonly_injector (0.1.2)
+      rails (>= 3.0, < 5.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionmailer (4.2.10)
+      actionpack (= 4.2.10)
+      actionview (= 4.2.10)
+      activejob (= 4.2.10)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.10)
+      actionview (= 4.2.10)
+      activesupport (= 4.2.10)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.10)
+      activesupport (= 4.2.10)
+      globalid (>= 0.3.0)
+    activemodel (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+    activerecord (4.2.10)
+      activemodel (= 4.2.10)
+      activesupport (= 4.2.10)
+      arel (~> 6.0)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
     appraisal (2.2.0)
       bundler
       rake
       thor (>= 0.14.0)
+    arel (6.0.4)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    erubis (2.7.0)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rack (1.6.8)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.10)
+      actionmailer (= 4.2.10)
+      actionpack (= 4.2.10)
+      actionview (= 4.2.10)
+      activejob (= 4.2.10)
+      activemodel (= 4.2.10)
+      activerecord (= 4.2.10)
+      activesupport (= 4.2.10)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.10)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.10)
+      actionpack (= 4.2.10)
+      activesupport (= 4.2.10)
+      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)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal (~> 2.2.0)
+  appraisal (~> 2.2)
   bundler (~> 1.16)
   rails_readonly_injector!
   rake (~> 10.0)

data/README.md

@@ -2,6 +2,7 @@
 [![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)
+[![Gem Version](https://badge.fury.io/rb/rails_readonly_injector.svg)](https://badge.fury.io/rb/rails_readonly_injector)
 
 Easily switch a Rails site into 'read-only' mode, and back again, without restarting the server.
 
@@ -44,6 +45,10 @@ When you want to switch a site into read-only mode, you can then simply set `Rai
 
 If you want to reset the configuration to the defaults, you can simply call `RailsReadonlyInjector.reset_configuration!` from anywhere in your application.
 
+## Configuration Options
+- `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.
+- `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.

data/cucumber_features/configuration.feature

@@ -16,14 +16,4 @@ Feature: Configuration
 
     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 
+    Then I should be able to create a user without any errors

data/cucumber_features/step_definitions/user_steps.rb

@@ -40,8 +40,6 @@ Then("the user should be updated") do
 end
 
 Then("the user should be saved") do
- @user.reload
-
   expect(@user.persisted?).to eq(true)
 end
 

data/cucumber_features/user_controller_readonly.feature

@@ -6,7 +6,11 @@ Feature: User Controller - When in read only mode
     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'
+        if Rails::VERSION::STRING < '4.1.0'
+          render :text => 'The site is currently in read-only mode'
+        else
+          render :plain => 'The site is currently in read-only mode'
+        end
       end
     end
 
@@ -23,7 +27,11 @@ Feature: User Controller - When in read only mode
     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'
+        if Rails::VERSION::STRING < '4.1.0'
+          render :text => 'The site is currently in read-only mode'
+        else
+          render :plain => 'The site is currently in read-only mode'
+        end
       end
     end
 

data/cucumber_features/user_model_readonly.feature

@@ -23,4 +23,18 @@ Feature: User model - When in read-only mode
     RailsReadonlyInjector.reload!
     """
     When I save the user
-    Then the user should not be saved
+    Then the user should not be saved
+  
+  Scenario: An attempt to create an instance of a model exempt from read-only mode has been made
+    Given There is a user that has not been persisted to the database
+    Given I execute:
+    """
+    RailsReadonlyInjector.config do |config|
+      config.read_only = true
+      config.classes_to_exclude = [User]
+    end
+
+    RailsReadonlyInjector.reload!
+    """
+    When I save the user
+    Then the user should be saved

data/development_tasks/tests.rake

@@ -36,9 +36,12 @@ namespace :dev do
     ENV.delete('RUBYOPT')
 
     # Install gems
-    system("bundle install")
+    system("bundle install --binstubs")
 
+    puts "Installing Cucumber..."
     system("bundle exec rails generate cucumber:install")
+
+    puts "Installing RSpec..."
     system("bundle exec rails generate rspec:install")
 
     # RSpec: Include all files in support/
@@ -71,8 +74,8 @@ namespace :dev do
     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')
+    exit_code = system('bundle exec cucumber && bundle exec rspec')
+    exit exit_code
   end
 
   def parse_gemfile(file_path)

data/gemfiles/rails_4_0.gemfile

@@ -7,5 +7,6 @@ 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"
+gem "xpath", "~> 2.1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

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

data/lib/rails_readonly_injector.rb

@@ -3,14 +3,23 @@ require "rails_readonly_injector/configuration"
 
 module RailsReadonlyInjector
   def self.reload!
-    descendants = ActiveRecord::Base.descendants
 
-    if descendants.empty?
-      Rails.application.eager_load!
+    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)
+        next
+      end
+
       if self.config.read_only
         override_readonly_method(descendant_class)
       else

data/lib/rails_readonly_injector/configuration.rb

@@ -1,6 +1,6 @@
 module RailsReadonlyInjector
   class Configuration
-    attr_writer :read_only
+    attr_writer :read_only, :classes_to_exclude
 
     def read_only
       @read_only || false
@@ -15,6 +15,10 @@ module RailsReadonlyInjector
     def controller_rescue_action
       @controller_rescue_action || Proc.new {}
     end
+
+    def classes_to_exclude
+      @classes_to_exclude || []
+    end
   end
   private_constant :Configuration
 

data/lib/rails_readonly_injector/version.rb

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

data/rails_readonly_injector.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://www.github.com/xtrasimplicity/rails_readonly_injector"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.1.3"
 
-  spec.add_runtime_dependency "rails", ">= 3.0"
+  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.0'
+  spec.add_development_dependency 'appraisal', '~> 2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_readonly_injector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Walter
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: '2.2'
 description: 
 email:
 - andrew.walter@burnet.edu.au
@@ -76,6 +82,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -100,6 +107,7 @@ files:
 - gemfiles/rails_4_1.gemfile
 - gemfiles/rails_4_2.gemfile
 - gemfiles/rails_5_0.gemfile
+- gemfiles/rails_5_1.gemfile
 - lib/rails_readonly_injector.rb
 - lib/rails_readonly_injector/configuration.rb
 - lib/rails_readonly_injector/version.rb
@@ -108,7 +116,7 @@ files:
 - rspec_specs/readonly_site_toggle/configuration_spec.rb
 - rspec_specs/readonly_site_toggle_spec.rb
 - rspec_specs/support/.gitkeep
-homepage: https://www.github.com
+homepage: https://www.github.com/xtrasimplicity/rails_readonly_injector
 licenses:
 - MIT
 metadata: {}