rails_readonly_injector 0.2.0 → 1.2.0

data/rspec_specs/rails_readonly_injector/configuration_spec.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe RailsReadonlyInjector.config do
+  describe '#controller_rescue_action=' do
+    context 'when given a lambda expression' do
+      let(:exp) { -> { 'This is a test lambda!' } }
+      before do
+        RailsReadonlyInjector.config.controller_rescue_action = exp
+      end
+
+      subject { RailsReadonlyInjector.config.controller_rescue_action }
+
+      it { is_expected.to eq(exp) }
+    end
+
+    context 'when given a Proc' do
+      let(:passed_proc) { proc { 'This is a test Proc!' } }
+
+      before do
+        RailsReadonlyInjector.config.controller_rescue_action = passed_proc
+      end
+
+      subject { RailsReadonlyInjector.config.controller_rescue_action }
+
+      it { is_expected.to eq(passed_proc) }
+    end
+
+    context 'when an invalid value is assigned' do
+      it 'raises an error message' do
+        expect do
+          RailsReadonlyInjector.config.controller_rescue_action = nil
+        end.to raise_error 'A lambda or proc must be specified'
+      end
+    end
+  end
+
+  describe '#classes_to_include' do
+    context 'when not defined' do
+      context 'when using Rails < 5.0' do
+        before do
+          stub_const('Rails::VERSION::STRING', '4.1.0')
+        end
+
+        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
+            # :nodoc:
+            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
+
+  describe '#changed_attributes' do
+    setup do
+      RailsReadonlyInjector.reset_configuration!
+
+      RailsReadonlyInjector.config.read_only = false
+    end
+
+    context 'when one attribute is changed' do
+      before(:each) do
+        RailsReadonlyInjector.config.read_only = true
+      end
+
+      context 'and `reload!` is not called' do
+        subject { RailsReadonlyInjector.config.changed_attributes }
+
+        it 'returns a hash with the attribute and its old value' do
+          expect(subject).to eq(read_only: false)
+        end
+      end
+
+      context 'and `reload!` is called' do
+        before { RailsReadonlyInjector.reload! }
+        subject { RailsReadonlyInjector.config.changed_attributes }
+
+        it 'returns an empty hash' do
+          expect(subject).to eq({})
+        end
+      end
+    end
+
+    context 'when more than one attribute is changed' do
+      setup { class TestClassA < ActiveRecord::Base; end; }
+
+      before(:each) do
+        RailsReadonlyInjector.config do |c|
+          c.read_only = true
+          c.classes_to_include = [TestClassA]
+          c.classes_to_exclude = [User]
+        end
+      end
+
+      context 'and `reload!` is not called' do
+        subject { RailsReadonlyInjector.config.changed_attributes }
+
+        it 'returns a hash with the attribute and its old value' do
+          expect(subject).to eq(
+            read_only: false,
+            classes_to_include: nil,
+            classes_to_exclude: []
+          )
+        end
+      end
+
+      context 'and `reload!` is called' do
+        before { RailsReadonlyInjector.reload! }
+        subject { RailsReadonlyInjector.config.changed_attributes }
+
+        it 'returns an empty hash' do
+          expect(subject).to eq({})
+        end
+      end
+    end
+
+    context 'when an attribute is not changed' do
+      subject { RailsReadonlyInjector.config.changed_attributes }
+
+      it { is_expected.to eq({}) }
+    end
+  end
+
+  describe '#dirty?' do
+    setup do
+      RailsReadonlyInjector.config { |config| config.read_only = false }
+      RailsReadonlyInjector.reload!
+    end
+
+    context 'when `read_only` is changed' do
+      before(:each) { RailsReadonlyInjector.config.read_only = true }
+
+      context 'and `reload!` is not called' do
+        subject { RailsReadonlyInjector.config.dirty? }
+
+        it { is_expected.to eq(true) }
+      end
+
+      context 'and `reload!` is called' do
+        before { RailsReadonlyInjector.reload! }
+        subject { RailsReadonlyInjector.config.dirty? }
+
+        it { is_expected.to eq(false) }
+      end
+    end
+  end
+end

data/rspec_specs/{readonly_site_toggle_spec.rb → rails_readonly_injector_spec.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails_helper'
 
 RSpec.describe RailsReadonlyInjector do
@@ -13,7 +15,7 @@ RSpec.describe RailsReadonlyInjector do
     subject { RailsReadonlyInjector.config }
 
     it 'sets `read_only` to false' do
-      expect(RailsReadonlyInjector.config.read_only).to eq(false)
+      expect(RailsReadonlyInjector.config.send(:read_only)).to eq(false)
     end
   end
 
@@ -56,4 +58,43 @@ RSpec.describe RailsReadonlyInjector do
       it { is_expected.to eq(false) }
     end
   end
+
+  describe '#in_read_only_mode?' do
+    setup do
+      RailsReadonlyInjector.config.read_only = false
+      RailsReadonlyInjector.reload!
+    end
+
+    context 'when `reload!` is called' do
+      before do
+        RailsReadonlyInjector.config.read_only = true
+        RailsReadonlyInjector.reload!
+      end
+
+      it 'returns the correct value' do
+        expect(RailsReadonlyInjector.in_read_only_mode?).to eq(true)
+      end
+    end
+
+    context 'when `reload!` is not called' do
+      context 'when `config.read_only` is changed' do
+        before do
+          RailsReadonlyInjector.config.read_only = true
+        end
+
+        it 'returns the previous value' do
+          expect(RailsReadonlyInjector.in_read_only_mode?).to eq(false)
+        end
+      end
+
+      context 'when `config.read_only` is not changed' do
+        before { RailsReadonlyInjector.config.classes_to_exclude = [User] }
+        subject { RailsReadonlyInjector.in_read_only_mode? }
+
+        it 'returns the current value' do
+          expect(subject).to eq(RailsReadonlyInjector.config.send(:read_only))
+        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: 1.2.0
 platform: ruby
 authors:
 - Andrew Walter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2020-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,49 +29,63 @@ dependencies:
         version: '3.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.9.12
 description: 
 email:
 - andrew.walter@burnet.edu.au
@@ -79,13 +93,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -100,6 +116,8 @@ files:
 - cucumber_features/user_controller_readonly.feature
 - cucumber_features/user_model.feature
 - cucumber_features/user_model_readonly.feature
+- development_tasks/support/file_helpers.rb
+- development_tasks/support/gem_helpers.rb
 - development_tasks/tests.rake
 - gemfiles/.bundle/config
 - gemfiles/rails_3.gemfile
@@ -108,13 +126,14 @@ files:
 - gemfiles/rails_4_2.gemfile
 - gemfiles/rails_5_0.gemfile
 - gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_2.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/rails_readonly_injector/configuration_spec.rb
+- rspec_specs/rails_readonly_injector_spec.rb
 - rspec_specs/support/.gitkeep
 homepage: https://www.github.com/xtrasimplicity/rails_readonly_injector
 licenses:
@@ -135,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Globally toggle 'read-only' mode in a Rails application, on-demand, without

data/rspec_specs/readonly_site_toggle/configuration_spec.rb

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