rails_readonly_injector 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9509703bc12b066f6af792e478484e61bb0a0249
-  data.tar.gz: 21225186b776c134d52ec75b95ce3483fd70c21f
+  metadata.gz: 25d251e5a12704817f3a4568882e00d68c6d80de
+  data.tar.gz: 1b5b6fdbe4cb1772286002fb24ecc22b63e4f5f7
 SHA512:
-  metadata.gz: e5aa0948322922fd1940fb817fe4ac52bdcbf3fdc2ff3f1630835e7cd80f4fd4f0bb990812f974b447c2364379f008c5bb951fbf643fd8feb82b5a8fb949c25b
-  data.tar.gz: 2d7734d7370b5eda65ceababacd75302013dddfd4c26ba2e95fcc4126e75db3c00310198d92a9e9d5d2b9790846f544422a8f67c4f03a4489431886108ec5bb6
+  metadata.gz: 9182f0b556f492a5180677208f42833840bc091b6047ce6fbad5fa19ecb491a153575ea68b80f6971526bae58d1a5217be0f03e39b32737aa8fa33f512a5801c
+  data.tar.gz: 358b647a57d38f3b0f3235f0b6ad3dc0ee00055384403158a7556446b3b4acaf2b168d93cbfbcb18f2ac9ffaffa4bc197ef365a1c550363fd529ad0409174b8e

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 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/README.md

@@ -47,7 +47,8 @@ If you want to reset the configuration to the defaults, you can simply call `Rai
 
 ## 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.
+- `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
 

data/lib/rails_readonly_injector.rb

@@ -3,27 +3,18 @@ require "rails_readonly_injector/configuration"
 
 module RailsReadonlyInjector
   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|
+    config.classes_to_include.each do |klass|
     
-      # Ensure excluded classes aren't set to read-only
-      if config.classes_to_exclude.include? descendant_class
-        restore_readonly_method(descendant_class)
+      # Ensure we don't impact classes that we want to exclude
+      if config.classes_to_exclude.include? klass
+        restore_readonly_method(klass)
         next
       end
 
       if self.config.read_only
-        override_readonly_method(descendant_class)
+        override_readonly_method(klass)
       else
-        restore_readonly_method(descendant_class)
+        restore_readonly_method(klass)
       end
     end
 

data/lib/rails_readonly_injector/configuration.rb

@@ -1,6 +1,6 @@
 module RailsReadonlyInjector
   class Configuration
-    attr_writer :read_only, :classes_to_exclude
+    attr_writer :read_only, :classes_to_exclude, :classes_to_include
 
     def read_only
       @read_only || false
@@ -19,6 +19,18 @@ module RailsReadonlyInjector
     def classes_to_exclude
       @classes_to_exclude || []
     end
+
+    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
   end
   private_constant :Configuration
 

data/lib/rails_readonly_injector/version.rb

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

data/rspec_specs/readonly_site_toggle/configuration_spec.rb

@@ -28,4 +28,39 @@ RSpec.describe RailsReadonlyInjector.config do
       end
     end
   end
+
+  describe '#classes_to_include' do
+    context 'when not defined' do
+      context 'when using Rails < 5.0' do
+        before { stub_const('Rails::VERSION::STRING', '4.1.0') }
+
+        it 'returns the descendants of ActiveRecord::Base' do
+          expect(ActiveRecord::Base).to receive(:descendants)
+
+          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
+            class ApplicationRecord
+              def descendants
+              end
+            end
+          end
+        end
+
+        it 'returns the descendants of ActiveRecord::Base' do
+          expect(ApplicationRecord).to receive(:descendants)
+
+          RailsReadonlyInjector.config.classes_to_include
+        end
+
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_readonly_injector
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Walter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails