smash_the_state 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 591b5f213e895130ff25cf2bc2638275d6f89a054abbe01c0fb55ff5c6f3cc84
-  data.tar.gz: 249752c9f3aa7a7efea1adf1dcc4af85bfe135235bf0d07b6961fb3a5eca2a80
+  metadata.gz: 9538187d0adbf668fd4cd35bfb97e04591c6d70c758109486251cf7ac66df1d7
+  data.tar.gz: 99eac2a8a14d9d30884b07171dab596ed8fd6ad662127cb3678e32a3a3041d3a
 SHA512:
-  metadata.gz: c74f691d3f1d7d9e6fe008e67d97b7da9cf24cef2d444a57744c1a4ee41f559358d39d6e1e74f5222f93c5d41c1eb9a53f3a61f9635a0cd522798fc77e0d2395
-  data.tar.gz: fbf4c5c27f114281a9db33f2d76d64a50f8f42594f1e2a5a84dfce2414893e1728dae5702e0ea8a65ccd4a3c82790ace05cba760e4634f08ab157e8b115c2e91
+  metadata.gz: 2cd363ad82626e3874e94c2c1a58fe41e6b44ce8cdb5260975f1e2132b3fde84cd4b5fdbd994ee374aeaed65dc40bca9c6f6a8bd4fb9f32829b58024657c6f5f
+  data.tar.gz: d23d8b91270cfdb27eb32e5faad64776c7da6f2b894d65a7b18e9ca7b6c04e87907555ff86b9b7666032a22cf0ad85452c4dffc709a0fc0d42e2f841259d667a

data/README.md

@@ -127,7 +127,7 @@ Let's say you have two database types: `WhiskeyDB` and `AbsintheDB`, each of whi
 
 ``` ruby
 class WhiskeyDBCreateMiddleware
-  def create_environment(state)
+  def self.create_environment(state)
     # do whiskey things
   end
 end
@@ -136,7 +136,7 @@ end
 
 ``` ruby
 class AbsintheDBCreateMiddleware
-  def create_environment(state)
+  def self.create_environment(state)
     # do absinthe things
   end
 end

data/lib/smash_the_state/operation/sequence.rb

@@ -93,13 +93,20 @@ module SmashTheState
         step.error_handler = block
       end
 
-      # rubocop:disable Lint/ShadowedException
       def middleware_class(state, original_state = nil)
-        middleware_class_block.call(state, original_state).constantize
-      rescue NameError, NoMethodError
-        nil
+        klass = middleware_class_block.call(state, original_state)
+
+        case klass
+        when Module, Class
+          klass
+        else
+          begin
+            klass.constantize if klass.respond_to?(:constantize)
+          rescue NameError
+            nil
+          end
+        end
       end
-      # rubocop:enable Lint/ShadowedException
 
       def add_middleware_step(step_name, options = {})
         step = Operation::Step.new step_name, options do |state, original_state|

data/lib/smash_the_state/operation/state.rb

@@ -18,8 +18,8 @@ module SmashTheState
         attr_accessor :representer
 
         def build(params = nil, &block)
-          Class.new(self).tap do |k|
-            k.class_exec(params, &block)
+          Class.new(self) do
+            class_exec(params, &block)
           end
         end
 
@@ -29,7 +29,7 @@ module SmashTheState
         def schema(key, options = {}, &block)
           attribute key,
                     :state_for_smashing,
-                    options.merge(
+                    **options.merge(
                       # allow for schemas to be provided inline *or* as a reference to a
                       # type definition
                       schema: attribute_options_to_ref_block(options) || block
@@ -39,19 +39,19 @@ module SmashTheState
         # for ActiveModel states we will treat the block as a collection of ActiveModel
         # validator directives
         def eval_validation_directives_block(state, &block)
-          state.tap do |s|
-            # each validate block should be a "fresh start" and not interfere with the
-            # previous blocks
-            s.class.clear_validators!
-            s.class_eval(&block)
-            s.validate || invalid!(s)
-          end
+          # each validate block should be a "fresh start" and not interfere with the
+          # previous blocks
+          state.singleton_class.clear_validators!
+          state.singleton_class.class_eval(&block)
+
+          state.validate || invalid!(state)
+          state
         end
 
         def extend_validation_directives_block(state, &block)
-          state.tap do |s|
-            s.class_eval(&block)
-          end
+          state.class_eval(&block)
+
+          state
         end
 
         # for non-ActiveModel states we will just evaluate the block as a validator
@@ -69,7 +69,7 @@ module SmashTheState
 
         # if a reference to a definition is provided, use the reference schema block
         def attribute_options_to_ref_block(options)
-          options[:ref] && options[:ref].schema_block
+          options[:ref]&.schema_block
         end
 
         def invalid!(state)

data/lib/smash_the_state/operation/step.rb

@@ -16,10 +16,6 @@ module SmashTheState
       def side_effect_free?
         options[:side_effect_free] == true
       end
-
-      def dup
-        super
-      end
     end
   end
 end

data/lib/smash_the_state/operation.rb

@@ -24,7 +24,7 @@ module SmashTheState
       # inheritance doesn't work with class attr_readers, this method is provided to
       # bootstrap an operation as a continuation of a "prelude" operation
       def continues_from(prelude)
-        @state_class = prelude.state_class && prelude.state_class.dup
+        @state_class = prelude.state_class&.dup
         sequence.steps.concat prelude.sequence.steps
 
         # also make the dry run sequence continue
@@ -52,7 +52,7 @@ module SmashTheState
         sequence.override_step(step_name, options, &block)
 
         # also override the dry run step
-        return if dry_run_sequence.steps_for_name(step_name).length.zero?
+        return if dry_run_sequence.steps_for_name(step_name).empty?
 
         dry_run_sequence.override_step(step_name, options, &block)
       end
@@ -122,7 +122,7 @@ module SmashTheState
         # state class can be nil if the schema is never defined. that's ok. in that
         # situation it's up to the first step to produce the original state and we'll pass
         # the params themselves in
-        state = state_class && state_class.new(params)
+        state = state_class&.new(params)
         sequence_to_run.call(state || params)
       end
     end

data/lib/smash_the_state/version.rb

@@ -1,3 +1,3 @@
 module SmashTheState
-  VERSION = "1.4.3".freeze
+  VERSION = "1.5.0".freeze
 end

data/spec/unit/operation/sequence_spec.rb

@@ -78,12 +78,10 @@ describe SmashTheState::Operation::Sequence do
       context "without an error handler" do
         it "re-raises the Error exception" do
           expect do
-            begin
-              instance.call([])
-              raise "should not hit this"
-            rescue SmashTheState::Operation::Error => e
-              expect(e.state).to eq([:foo])
-            end
+            instance.call([])
+            raise "should not hit this"
+          rescue SmashTheState::Operation::Error => e
+            expect(e.state).to eq([:foo])
           end
         end
       end
@@ -156,16 +154,14 @@ describe SmashTheState::Operation::Sequence do
 
     context "when no step by the given name exists" do
       it "raises an exception" do
-        begin
-          instance.override_step :four do
-          end
-
-          raise "should not reach this"
-        rescue SmashTheState::Operation::Sequence::BadOverride => e
-          expect(
-            e.to_s
-          ).to eq("overriding step :four failed because it does not exist")
+        instance.override_step :four do
         end
+
+        raise "should not reach this"
+      rescue SmashTheState::Operation::Sequence::BadOverride => e
+        expect(
+          e.to_s
+        ).to eq("overriding step :four failed because it does not exist")
       end
     end
 
@@ -204,28 +200,40 @@ describe SmashTheState::Operation::Sequence do
     end
 
     context "with a middleware_class_block" do
-      it "runs the middleware_class_block, passes in the state, constantizes" do
-        expect(instance.middleware_class("String")).to eq(String)
+      context "that returns a string" do
+        it "runs the middleware_class_block, passes in the state, constantizes" do
+          expect(instance.middleware_class("String")).to eq(String)
+        end
       end
-    end
 
-    context "with a NameError" do
-      it "returns nil" do
-        expect(instance.middleware_class("Whazzat")).to eq(nil)
-      end
-    end
+      context "that returns a constant" do
+        before do
+          instance.middleware_class_block = proc do |state|
+            state
+          end
+        end
 
-    context "with a NoMethodError" do
-      let!(:state) { double }
+        context "that is a class" do
+          let!(:klass) { Class.new }
 
-      before do
-        allow(state).to receive(:to_s) do
-          raise NoMethodError
+          it "runs the middleware_class_block, passes in the state" do
+            expect(instance.middleware_class(klass)).to eq(klass)
+          end
+        end
+
+        context "that returns a module" do
+          let!(:modyule) { Module.new }
+
+          it "runs the middleware_class_block, passes in the state" do
+            expect(instance.middleware_class(modyule)).to eq(modyule)
+          end
         end
       end
+    end
 
+    context "with a NameError" do
       it "returns nil" do
-        expect(instance.middleware_class(state)).to eq(nil)
+        expect(instance.middleware_class("Whazzat")).to eq(nil)
       end
     end
   end
@@ -254,7 +262,7 @@ describe SmashTheState::Operation::Sequence do
         instance.add_middleware_step :extra_step
       end
 
-      it "block receives both the state and original state" do
+      it "block receives the state and original state" do
         instance.middleware_class_block = proc do |state, original_state|
           expect(state).to eq(baz: "bing")
           expect(original_state).to eq(foo: "bar")

data/spec/unit/operation/state_spec.rb

@@ -112,13 +112,11 @@ describe SmashTheState::Operation::State do
     let!(:instance) { built.new }
 
     it "calls the block" do
-      begin
-        SmashTheState::Operation::State.eval_custom_validator_block(instance) do |i|
-          i.errors.add(:bread, "is moldy")
-        end
-      rescue SmashTheState::Operation::State::Invalid => e
-        expect(e.state.errors[:bread]).to include("is moldy")
+      SmashTheState::Operation::State.eval_custom_validator_block(instance) do |i|
+        i.errors.add(:bread, "is moldy")
       end
+    rescue SmashTheState::Operation::State::Invalid => e
+      expect(e.state.errors[:bread]).to include("is moldy")
     end
 
     it "only raises an error for the current state" do

data/spec/unit/operation_spec.rb

@@ -237,17 +237,17 @@ describe SmashTheState::Operation do
     context "with a custom dry run sequence block" do
       before do
         klass.step :step_one do |state, _original_state, run_options|
-          state.name = state.name + " one " + run_options.to_json
+          state.name = "#{state.name} one #{run_options.to_json}"
           state
         end
 
         klass.step :step_two do |state|
-          state.name = state.name + " two"
+          state.name = "#{state.name} two"
           state
         end
 
         klass.step :step_three do |state|
-          state.name = state.name + " three"
+          state.name = "#{state.name} three"
           state
         end
 
@@ -257,7 +257,7 @@ describe SmashTheState::Operation do
 
           # we'll provide a custom implementation of this step
           step :step_two do |state|
-            state.name = state.name + " custom"
+            state.name = "#{state.name} custom"
             state
           end
 
@@ -341,7 +341,7 @@ describe SmashTheState::Operation do
 
     context "when the policy permits" do
       it "newifies the policy class with the state, runs the method" do
-        state = klass.call(current_user: current_user)
+        state = klass.call(current_user:)
         expect(state.name).to eq("allowed")
       end
     end
@@ -352,13 +352,11 @@ describe SmashTheState::Operation do
       end
 
       it "raises an exception, embeds the policy instance" do
-        begin
-          klass.call(current_user: current_user)
-          raise "should not hit this"
-        rescue SmashTheState::Operation::NotAuthorized => e
-          expect(e.policy_instance).to be_a(@policy_klass)
-          expect(e.policy_instance.user).to eq(current_user)
-        end
+        klass.call(current_user:)
+        raise "should not hit this"
+      rescue SmashTheState::Operation::NotAuthorized => e
+        expect(e.policy_instance).to be_a(@policy_klass)
+        expect(e.policy_instance.user).to eq(current_user)
       end
     end
   end
@@ -434,7 +432,7 @@ describe SmashTheState::Operation do
     context "with a validation step" do
       before do
         klass.step :run_this do |state|
-          state.name = state.name + " People"
+          state.name = "#{state.name} People"
           state
         end
 
@@ -448,7 +446,7 @@ describe SmashTheState::Operation do
         end
 
         klass.step :safe, side_effect_free: true do |state|
-          state.name = state.name + " are nice"
+          state.name = "#{state.name} are nice"
           state
         end
       end
@@ -468,7 +466,7 @@ describe SmashTheState::Operation do
     context "with no validation step" do
       before do
         klass.step :run_this, side_effect_free: true do |state|
-          state.name = state.name + " People"
+          state.name = "#{state.name} People"
           state
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smash_the_state
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.5.0
 platform: ruby
 authors:
 - Dan Connor
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-21 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_attributes
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.1
+        version: 6.0.0
 description: ''
 email:
 - dan@danconnor.com
@@ -68,7 +68,7 @@ homepage: https://github.com/ibm-cloud/smash-the-state
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +83,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: A useful utility for transforming state that provides step sequencing, middleware,
   and validation.