shamu 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6f49a347f5a63383390bc51b9cba9616d7b7fec
-  data.tar.gz: 732419b2df2e8757cc4772f8e03d59411abbbcbe
+  metadata.gz: dd0f794321cd3d306d36b16935e133e3ded9270b
+  data.tar.gz: 244f8025c48879a691c7faa6f6e76b3b45efe2e0
 SHA512:
-  metadata.gz: 7355e1c846de3a9c53dbcaa6cc301433a0f901464f92f557ca2c0a439fa2385320e7faf53248b895b7364ea17c8ae71fdac828d14b779b0d31b57434c67b016e
-  data.tar.gz: 61c004a0899ae0707d5d6f1a2b21e200cb80622302c9ac0ed77496c79019888d72006e99cd34f5df07d899354066584d04ada782cf8fba1743f0f0c4f1be4500
+  metadata.gz: 57d00e95ce2bf7a4d1ddbc224aff0a2790255a6bd1c1ac907f7450b95a30b63c7ca2cc404d0754c7ee363761386fc5c1567f1f50114957488d538be85d2cbda8
+  data.tar.gz: e2ab805eb2ba0db7969601cb825f827c8d5346c8ebd34db8e836543a6726b7327c20b68f092681555b56f1832d8dd8512d08d8bc1ddaf3170e6f221d5b3ab1a0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shamu (0.0.17)
+    shamu (0.0.18)
       activemodel (>= 5.0)
       activesupport (>= 5.0)
       crc32 (~> 1)

data/lib/shamu/attributes.rb

@@ -46,6 +46,7 @@ module Shamu
       self.class.attributes.each_with_object({}) do |(name, options), attrs|
         next if ( only && !match_attribute?( only, name ) ) || ( except && match_attribute?( except, name ) )
         next unless serialize_attribute?( name, options )
+
         attrs[name] = send( name )
       end
     end

data/lib/shamu/attributes/assignment.rb

@@ -12,6 +12,12 @@ module Shamu
         public :assign_attributes
       end
 
+      # @param [Symbol] name of the attribute to assign.
+      # @param [Object] value to assign.
+      def []=( name, value )
+        send :"assign_#{ name }", value if attribute?( name )
+      end
+
       # @return [Array<Symbol>] the attributes that have been assigned.
       def assigned_attributes
         @assigned_attributes.to_a || []

data/lib/shamu/auditing/support.rb

@@ -20,50 +20,52 @@ module Shamu
         #
         # @!endgroup Dependencies
 
+        private
+
+          # Override {Shamu::Services::RequestSupport#with_partial_request} and to yield
+          # a {Transaction} as an additional argument to automatically
+          # {#audit_request audit the request}.
+          def with_partial_request( *args, &block )
+            super( *args ) do |request|
+              audit_request request do |transaction|
+                yield request, transaction
+              end
+            end
+          end
+
       end
 
       private
 
-        # @!visibility public
-        #
-        # Same as {#audit_request} but does not validate the request before
-        # yielding to the block.
-        def audit_partial_request( params, request_class, action: :smart, &block )
-          perform_audit_request( :with_partial_request, params, request_class, action: action, &block )
-        end
 
         # @!visibility public
         #
         # Audit the requested changes and report the request to the
         # {#auditing_service}.
         #
-        # See {Shamu::Services::RequestSupport#with_request}
-        #
-        # @param (see Shamu::Services::RequestSupport#with_request)
+        # @param [Services::Request] request the coerced request params.
         # @return (see Shamu::Services::RequestSupport#with_request)
-        # @yield (request, transaction)
-        # @yieldparam [Services::Request] request coerced from `params`.
+        # @yield (transaction)
         # @yieldparam [Transaction] transaction the audit transaction. Most fields
         #     will be populated automatically from the request but the block
         #     should call {Transaction#append_entity} to include any parent
         #     entities in the entity path.
-        def audit_request( params, request_class, action: :smart, &block )
-          perform_audit_request( :with_request, params, request_class, action: action, &block )
-        end
-
-        def perform_audit_request( method, params, request_class, action: :smart, &block )
+        # @yieldreturn [Services::Result]
+        def audit_request( request, action: :smart, &block )
           transaction = Transaction.new \
-            user_id_chain: auditing_security_principal.user_id_chain
+            user_id_chain: auditing_security_principal.user_id_chain,
+            changes: request.to_attributes( only: request.assigned_attributes ),
+            action: audit_request_action( request, action )
 
-          result = send method, params, request_class do |request|
-            transaction.action  = audit_request_action( request, action )
-            transaction.changes = request.to_attributes
-
-            yield request, transaction
-          end
+          result = yield transaction if block_given?
+          result = Services::Result.coerce( result, request: request )
 
           if result.valid?
-            transaction.append_entity result.entity if result.entity
+            if result.entity
+              transaction.append_entity result.entity
+            elsif request.respond_to?( :id ) && defined? entity_class
+              transaction.append_entity [ entity_class, request.id ]
+            end
             auditing_service.commit( transaction )
           end
 

data/lib/shamu/entities/entity_path.rb

@@ -70,12 +70,13 @@ module Shamu
         def entity_path_name( entity )
           case entity
           when String then entity.sub( /Entity$/, "" )
-          when Class  then Class.model_name.name
+          when Class  then entity.model_name.name
           else             fail "Don't know how to compose #{ entity }"
           end
         end
 
         def build_composed_entity_path( name, id )
+          id = id.to_model_id if id.respond_to?( :to_model_id )
           "#{ name }[#{ id }]"
         end
 

data/lib/shamu/events/support.rb

@@ -21,20 +21,37 @@ module Shamu
 
       end
 
+      # (see Support.event_channel)
+      def event_channel
+        self.class.event_channel
+      end
+
       private
 
         # @!visibility public
         #
         # Publish the given `message` to the {#events_service}.
         #
-        # @param [Events::Message] message the custom event specific message to
+        # @param [Events::Message, Symbol] message the custom event specific message to
         #     publish.
         # @param [String] channel to publish to.
+        # @param [Hash] message_attrs arguments to use when creating an
+        # instance of `message`.
+        #
+        # If `message` is a symbol, looks for a {Message} class in
+        # {ServiceNamespace}::{OptionalServiceDomain}Events::{name.caemlize}.
         # @return [void]
-        def event!( message, channel: event_channel )
+        def event!( message, channel: event_channel, **message_attrs )
+          if message.is_a?( Symbol )
+            message = self.class
+                          .event_message_namespace
+                          .const_get( message.to_s.camelize )
+                          .new( message_attrs )
+          end
           events_service.publish channel, message
         end
 
+      class_methods do
         # @!visibility public
         #
         # The channel to {#publish_event publish events} to. Defaults to the
@@ -47,7 +64,7 @@ module Shamu
         # @return [String] the name of the channel.
         def event_channel
           @event_channel ||= begin
-            base_name = self.class.name || "Events"
+            base_name = name || "Events"
             parts     = base_name.split( "::" )
             parts[-1].sub!( /Service$/, "" )
             parts.pop if parts[-1] == parts[-2] || ( parts.length > 1 && parts[-1].blank? )
@@ -55,6 +72,28 @@ module Shamu
           end
         end
 
+        # The module that holds the per-message event classes for the service.
+        # @return [Module]
+        def event_message_namespace
+          @event_message_namespace ||=
+            begin
+              namespace = name.deconstantize
+              return unless namespace.present?
+
+              namespace = namespace.constantize
+              domain    = name.demodulize.sub( /Service/, "" ).singularize
+
+              # Must use exceptions instead of const_defined? so that rails has
+              # a change to autoload the constant.
+              begin
+                namespace.const_get( "#{ domain }Events" )
+              rescue NameError
+                namespace.const_get( "Events" )
+              end
+            end
+        end
+      end
+
     end
   end
-end
+end

data/lib/shamu/services/active_record_crud.rb

@@ -14,22 +14,22 @@ module Shamu
     #
     #     # Define finder methods #find, #list and #lookup using the given
     #     # default scope.
-    #     finders Models::User.active
+    #     define_finders Models::User.active
     #
     #     # Define change methods
-    #     create
-    #     update
+    #     define_create
+    #     define_update
     #
     #     # Common update/change behavior for #create and #update
-    #     change do |request, model|
+    #     define_change do |request, model|
     #       model.last_updated_at = Time.now
     #     end
     #
     #     # Standard destroy method
-    #     destroy
+    #     define_destroy
     #
     #     # Build the entity class from the given record.
-    #     build_entities do |records|
+    #     define_build_entities do |records|
     #       records.map do |record|
     #         parent = lookup_association( record.parent_id, self ) do
     #                    records.pluck( :parent_id )
@@ -123,7 +123,7 @@ module Shamu
             send method
           end
 
-          build_entities( &block )
+          define_build_entities( &block )
         end
 
         # @return [Class] the {Entities::Entity} class that the service will
@@ -138,49 +138,60 @@ module Shamu
           resource_not_configured
         end
 
+        # Define all basic CRUD methods without any customization.
+        def define_crud
+          define_create
+          define_update
+          define_destroy
+          define_finders
+        end
+
         # Define a `#create` method on the service that takes a single {Request}
         # parameter.
         #
-        # See {.apply_changes} for details.
-        # @yield (see .apply_changes)
-        # @yieldparam (see .apply_changes)
+        # @yield ( request, record, *args )
+        # @yieldparam [Services::Request] request object.
+        # @yieldparam [ActiveRecord::Base] record.
+        # @yieldparam [Array] args any additional arguments injected by an
+        # overridden {#with_request} method.
         # @return [void]
-        def create( &block )
+        def define_create( &block )
           define_method :create do |params = nil|
-            with_request params, request_class( :create ) do |request|
-              authorize! :create, entity_class, request
-
+            with_request params, request_class( :create ) do |request, *args|
               record = request.apply_to( model_class.new )
-              if block
-                yield( request, record )
-              elsif respond_to? :apply_changes
-                apply_changes( request, record )
+
+              if block_given?
+                result = instance_exec record, request, *args, &block
+                next result if result.is_a?( Services::Result )
               end
 
+              authorize! :create, build_entity( record ), request
+
               next record unless record.save
               build_entity record
             end
           end
         end
 
-        # rubocop:disable Metrics/MethodLength
-
         # Define an change `method` on the service that takes the id of the
         # resource to modify and a corresponding {Request} parameter.
         #
-        # See {.apply_changes} for details.
-        # @yield (see .apply_changes)
-        # @yieldparam (see .apply_changes)
+        # @yield ( request, record, *args )
+        # @yieldparam [Services::Request] request object.
+        # @yieldparam [ActiveRecord::Base] record.
+        # @yieldparam [Array] args any additional arguments injected by an
+        # overridden {#with_request} method.
         # @return [Result] the result of the request.
         # @return [void]
-        def change( method = :update, &block ) # rubocop:disable Metrics/PerceivedComplexity, Metrics/AbcSize
+        def define_change( method, default_scope = model_class, &block ) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/LineLength
           define_method method do |id, params = nil|
             klass = request_class( method )
 
             params, id = id, id[ :id ] if !params && !id.respond_to?( :to_model_id )
+            params[ :id ] ||= id       if params
 
-            with_partial_request params, klass do |request|
-              record = model_class.find( id.to_model_id || request.id )
+            with_partial_request params, klass do |request, *args|
+              record = default_scope.find( id.to_model_id || request.id )
               entity = build_entity( record )
 
               backfill_attributes = entity.to_attributes( only: request.unassigned_attributes )
@@ -190,11 +201,9 @@ module Shamu
               authorize! method, entity, request
 
               request.apply_to( record )
-
-              if block
-                yield( request, record )
-              elsif respond_to? :apply_changes
-                apply_changes( request, record )
+              if block_given?
+                result = instance_exec record, request, *args, &block
+                next result if result.is_a?( Services::Result )
               end
 
               next record unless record.save
@@ -203,69 +212,49 @@ module Shamu
           end
         end
 
-        # rubocop:enabled Metrics/MethodLength
-
-
-        # Define an `update` method on the service that takes the id of the
-        # resource to update and a {Request} parameter. After applying the
-        # changes the record is persisted and the updated entity result is
-        # returned.
-        #
-        # See {.apply_changes} for details.
-        # @yield (see .apply_changes)
-        # @yieldparam (see .apply_changes)
-        # @return [void]
-        def update( &block )
-          change :update, &block
+        # Defines an #update method. See {#define_change} for details.
+        def define_update( default_scope = model_class, &block )
+          define_change :update, default_scope, &block
         end
 
         # Define a `destroy( id )` method that takes an {Entities::Entity} {Entities::Entity#id}
         # and destroys the resource.
         #
+        # @yield ( request, record, *args )
+        # @yieldparam [Services::Request] request object.
+        # @yieldparam [ActiveRecord::Base] record.
+        # @yieldparam [Array] args any additional arguments injected by an
+        # overridden {#with_request} method.
         # @param [ActiveRecord::Relation] default_scope to use when finding
         #     records.
         # @return [void]
-        def destroy( default_scope = model_class.all )
+        def define_destroy( default_scope = model_class, &block )
           define_method :destroy do |params|
             klass = request_class( :destroy )
 
             params = { id: params } if params.respond_to?( :to_model_id )
 
-            with_request params, klass do |request|
+            with_request params, klass do |request, *args|
               record = default_scope.find( request.id )
               authorize! :destroy, build_entity( record )
+
+              instance_exec record, request, *args, &block if block_given?
               next record unless record.destroy
             end
           end
         end
 
-        # Define a private method `apply_changes` on the service used by the
-        # {.create} and {.change} defined methods to apply changes in a
-        # {Request} to the model.
-        #
-        # @yield ( request, record ) a block that applies changes in the
-        #     `request` to the `record`.
-        # @yieldparam [Request] request the {Request} containing all the changes
-        #     that should be applied to the `record`.
-        # @yieldparam [ActiveRecord::Base] record the record to be updated.
-        # @yieldreturn [void]
-        # @return [void]
-        def apply_changes( &block )
-          define_method :apply_changes, &block
-          private :apply_changes
-        end
-
         # Define the standard finder methods {.find}, {.lookup} and {.list}.
         #
         # @param [ActiveRecord::Relation] default_scope to use when finding
         #     records.
         # @return [void]
-        def finders( default_scope = model_class.all, only: nil, except: nil )
+        def define_finders( default_scope = model_class.all, only: nil, except: nil )
           methods = Array( only || [ :find, :lookup, :list ] )
           methods -= Array( except ) if except
 
           methods.each do |method|
-            send method, default_scope
+            send :"define_#{ method }", default_scope
           end
         end
 
@@ -278,7 +267,7 @@ module Shamu
         # @yield (id)
         # @yieldreturn (ActiveRecord::Base) the found record.
         # @return [void]
-        def find( default_scope = model_class.all, &block )
+        def define_find( default_scope = model_class.all, &block )
           if block_given?
             define_method :find do |id|
               wrap_not_found do
@@ -305,7 +294,7 @@ module Shamu
         # @yieldreturn [ActiveRecord::Relation] records for ids found in the
         #     underlying resource.
         # @return [void]
-        def lookup( default_scope = model_class.all, &block )
+        def define_lookup( default_scope = model_class.all, &block )
           define_method :lookup do |*ids|
             cached_lookup( ids ) do |uncached_ids|
               records = block_given? ? yield( uncached_ids ) : default_scope.where( id: uncached_ids )
@@ -325,7 +314,7 @@ module Shamu
         # @yieldparam [ListScope] scope to apply.
         # @yieldreturn [ActiveRecord::Relation] records matching the given scope.
         # @return [void]
-        def list( default_scope = model_class.all, &block )
+        def define_list( default_scope = model_class.all, &block )
           define_method :list do |params = nil|
             list_scope = Entities::ListScope.for( entity_class ).coerce( params )
             authorize! :list, entity_class, list_scope
@@ -351,7 +340,7 @@ module Shamu
         #   entities.
         # @yieldreturn [Array<Entities::Entity>] the projected entities.
         # @return [void]
-        def build_entities( &block )
+        def define_build_entities( &block )
           if block_given?
             define_method :build_entities, &block
           else
@@ -374,7 +363,7 @@ module Shamu
 
           def inferred_resource_name
             inferred = name || "Resource"
-            inferred.split( "::" ).last.sub( /Service/, "" )
+            inferred.split( "::" ).last.sub( /Service/, "" ).singularize
           end
 
           def inferred_namespace

data/lib/shamu/services/request.rb

@@ -25,7 +25,6 @@ module Shamu
     class Request
       include Shamu::Attributes
       include Shamu::Attributes::Assignment
-      include Shamu::Attributes::FluidAssignment
       include Shamu::Attributes::Validation
 
       # Applies the attributes of the request to the given model. Only handles
@@ -53,6 +52,37 @@ module Shamu
         end
       end
 
+      # Execute block if the request is satisfied by the service successfully.
+      def on_success( &block )
+        @on_success_callbacks ||= []
+        @on_success_callbacks << block
+      end
+
+      # Execute block if the request is not satisfied by the service.
+      def on_fail( &block )
+        @on_fail_callbacks ||= []
+        @on_fail_callbacks << block
+      end
+
+      # Execute block when the service is done processing the request.
+      def on_complete( &block )
+        @on_complete_callbacks ||= []
+        @on_complete_callbacks << block
+      end
+
+      # Run any {#on_success} or #{on_fail} callbacks.
+      # @param [Boolean] success true if the request was completed
+      # successfully.
+      def run_callbacks( success )
+        if success
+          @on_success_callbacks && @on_success_callbacks.each( &:call )
+        else
+          @on_fail_callbacks && @on_fail_callbacks.each( &:call )
+        end
+
+        @on_fail_callbacks && @on_fail_callbacks.each( &:call )
+      end
+
       class << self
         # Coerces a hash or params object to a proper {Request} object.
         # @param [Object] params to be coerced.

data/lib/shamu/services/request_support.rb

@@ -70,10 +70,10 @@ module Shamu
         #     end
         #   end
         def with_request( params, request_class, &block )
-          with_partial_request params, request_class do |request|
+          with_partial_request params, request_class do |request, *args|
             next unless request.valid?
 
-            yield request
+            yield request, *args
           end
         end
 
@@ -90,15 +90,10 @@ module Shamu
           request = request_class.coerce( params )
           sources = yield( request )
 
-          # Make sure the request captures errors even if the block doesn't
-          # check
-          request.valid?
+          result = Result.coerce( sources, request: request )
+          request.run_callbacks( result.valid? )
 
-          if sources.is_a?( Result )
-            sources
-          else
-            result( *Array.wrap( sources ), request: request )
-          end
+          result
         end
 
       # Static methods added to {RequestSupport}

data/lib/shamu/services/result.rb

@@ -48,7 +48,7 @@ module Shamu
       #   the first {Request} object found in the `values`.
       # @param [Entities::Entity] entity submitted to the service. If :not_set,
       #   uses the first {Entity} object found in the `values`.
-      def initialize( *values, request: :not_set, entity: :not_set )
+      def initialize( *values, request: :not_set, entity: :not_set ) # rubocop:disable Metrics/LineLength, Metrics/MethodLength, Metrics/PerceivedComplexity
         @values = values
         @value  = values.first
 
@@ -60,6 +60,10 @@ module Shamu
         end
 
         unless request == :not_set
+          # Make sure the request captures errors even if the block doesn't
+          # check
+          request && request.valid?
+
           @request = request
           append_error_source request
         end
@@ -93,8 +97,16 @@ module Shamu
         self
       end
 
-      private
+      # @return [Result] the value coerced to a {Result}.
+      def self.coerce( value, **args )
+        if value.is_a?( Result )
+          value
+        else
+          Result.new( *Array.wrap( value ), **args )
+        end
+      end
 
+      private
 
         def append_error_source( source )
           return unless source.respond_to?( :errors )
@@ -103,6 +115,7 @@ module Shamu
             errors.add attr, message unless errors[attr].include? message
           end
         end
+
     end
   end
 end

data/lib/shamu/services/service.rb

@@ -340,15 +340,6 @@ module Shamu
             end
           end
 
-        # @!visibility public
-        #
-        # @overload result( *values, request: nil, entity: nil )
-        # @param (see Result#initialize)
-        # @return [Result]
-        def result( *args )
-          Result.new( *args )
-        end
-
         # @!visibility public
         #
         # Return an error {#result} from a service request.

data/lib/shamu/version.rb

@@ -2,7 +2,7 @@
 
 module Shamu
   # The primary version number
-  VERSION_NUMBER  = "0.0.17"
+  VERSION_NUMBER  = "0.0.18"
 
   # Version suffix such as 'beta' or 'alpha'
   VERSION_SUFFIX  = ""

data/spec/lib/shamu/auditing/support_spec.rb

@@ -5,6 +5,7 @@ module AuditingSupportSpec
     include Shamu::Auditing::Support
 
     public :audit_request
+    public :with_request
   end
 
   class Change < Shamu::Services::Request
@@ -14,19 +15,22 @@ end
 
 describe Shamu::Auditing::Support do
   hunt( :service, Shamu::Auditing::AuditingService )
+
   let( :example_service ) { scorpion.new AuditingSupportSpec::ExampleService }
+  let( :request )         { AuditingSupportSpec::Change.new name: "Penguin" }
 
   it "audits the request on success" do
     expect( service ).to receive( :commit )
 
-    example_service.audit_request( { name: "Penguin" }, AuditingSupportSpec::Change ) do |request, transaction|
+    example_service.audit_request( request ) do |transaction|
     end
   end
 
   it "skips the request on failure" do
     expect( service ).not_to receive( :commit )
+    request.name = nil
 
-    example_service.audit_request( {}, AuditingSupportSpec::Change ) do |request, transaction|
+    example_service.audit_request( request ) do |transaction|
     end
   end
 
@@ -35,7 +39,16 @@ describe Shamu::Auditing::Support do
       expect( transaction.action ).to eq "change"
     end
 
-    example_service.audit_request( { name: "Penguin" }, AuditingSupportSpec::Change ) do |request, transaction|
+    example_service.audit_request( request ) do |request|
     end
   end
-end
+
+  it "wraps with_request" do
+    expect( service ).to receive( :commit )
+
+    example_service.with_request( { name: "Example" }, AuditingSupportSpec::Change ) do |request, transaction|
+      expect( request ).to be_a AuditingSupportSpec::Change
+      expect( transaction ).to be_a Shamu::Auditing::Transaction
+    end
+  end
+end

data/spec/lib/shamu/events/support_spec.rb

@@ -1,5 +1,19 @@
 require "spec_helper"
 
+module EventsSupportSpec
+  class Service < Shamu::Services::Service
+    include Shamu::Events::Support
+
+    public :event!
+  end
+
+  module Events
+    class Boom < Shamu::Events::Message
+      attribute :name
+    end
+  end
+end
+
 describe Shamu::Events::Support do
   describe "#event_channel" do
     {
@@ -27,18 +41,16 @@ describe Shamu::Events::Support do
   describe "event!" do
     hunt( :events_service, Shamu::Events::EventsService )
 
-    let( :klass ) do
-      Class.new( Shamu::Services::Service ) do
-        include Shamu::Events::Support
-
-        public :event!
-      end
-    end
-    let( :service ) { scorpion.new klass }
+    let( :service ) { scorpion.new EventsSupportSpec::Service }
 
     it "publishes message to events_service" do
       expect( events_service ).to receive( :publish )
       service.event! Shamu::Events::Message.new
     end
+
+    it "creates message from attributes" do
+      expect( events_service ).to receive( :publish )
+      service.event! :boom, name: "Me"
+    end
   end
-end
+end

data/spec/lib/shamu/services/active_record_crud_spec.rb

@@ -33,10 +33,8 @@ module ActiveRecordCrudSpec
     include Shamu::Services::ActiveRecordCrud
 
     resource FavoriteEntity, ActiveRecordSpec::Favorite
-    create
-    change
-    finders
-    destroy
+    define_crud
+
   end
 
   class FavoriteListScope < Shamu::Entities::ListScope
@@ -46,6 +44,7 @@ end
 
 describe Shamu::Services::ActiveRecordCrud do
   use_active_record
+
   before( :all )  { Shamu::ToModelIdExtension.extend! }
 
   let( :klass )   { ActiveRecordCrudSpec::Service }
@@ -125,15 +124,6 @@ describe Shamu::Services::ActiveRecordCrud do
       service.create request
     end
 
-    it "calls apply_changes if present" do
-      expect( service ).to receive( :apply_changes )
-        .with(
-          request,
-          kind_of( ActiveRecord::Base )
-        )
-      service.create( request )
-    end
-
     it "returns a Result" do
       expect( service.create( request ) ).to be_a Shamu::Services::Result
     end
@@ -148,24 +138,27 @@ describe Shamu::Services::ActiveRecordCrud do
     it "yields if block given" do
       expect do |b|
         yield_klass = Class.new( klass ) do
-          create( &b )
+          define_create( &b )
         end
 
         scorpion.new( yield_klass ).create( request )
       end.to yield_with_args(
-        request,
-        kind_of( ActiveRecord::Base )
+        kind_of( ActiveRecord::Base ),
+        request
       )
     end
 
-    it "does not call apply_changes if block given" do
+    it "short-circuits if block yields a Services::Result" do
       yield_klass = Class.new( klass ) do
-        create { |_, _| }
+        define_create do
+          Shamu::Services::Result.new
+        end
       end
 
       service = scorpion.new( yield_klass )
-      expect( service ).not_to receive :apply_changes
-      service.create
+
+      expect( service ).not_to receive( :build_entity )
+      service.create request
     end
 
     it "calls #authorize!" do
@@ -198,37 +191,34 @@ describe Shamu::Services::ActiveRecordCrud do
       service.update entity, request
     end
 
-    it "calls apply_changes if present" do
-      expect( service ).to receive( :apply_changes )
-        .with(
-          kind_of( Shamu::Services::Request ),
-          kind_of( ::ActiveRecord::Base )
-        )
-      service.create( request )
-    end
-
     it "yields if block given" do
       entity = service.create.entity
 
       expect do |b|
         yield_klass = Class.new( klass ) do
-          change( :update, &b )
+          define_change( :update, &b )
         end
 
         scorpion.new( yield_klass ).update entity.id, request
-      end.to yield_with_args( request, kind_of( ::ActiveRecord::Base ) )
+      end.to yield_with_args( kind_of( ::ActiveRecord::Base ), request )
     end
 
-    it "does not call apply_changes if block given" do
-      entity = service.create.entity
+    it "short-circuits if block yields a Services::Result" do
+      entity
+      record  = service.class.model_class.all.first
+      records = [ record ]
+
+      expect( records ).to receive( :find ).and_return record
+      expect( record ).not_to receive( :save )
 
       yield_klass = Class.new( klass ) do
-        change( :update ) { |_, _| }
+        define_update records do
+          Shamu::Services::Result.new
+        end
       end
 
       service = scorpion.new( yield_klass )
-      expect( service ).not_to receive :apply_changes
-      service.update entity.id
+      service.update entity.id, request
     end
 
     it "calls #authorize!" do
@@ -244,19 +234,6 @@ describe Shamu::Services::ActiveRecordCrud do
     end
   end
 
-  describe ".apply_changes" do
-    it "defines an apply_changes method from the block" do
-      klass = Class.new( Shamu::Services::Service ) do
-        include Shamu::Services::ActiveRecordCrud
-
-        apply_changes do |record, request|
-        end
-      end
-
-      expect( klass.new.respond_to?( :apply_changes, true ) ).to be_truthy
-    end
-  end
-
   describe ".finders" do
     it "builds #lookup" do
       expect( service ).to respond_to :lookup
@@ -279,7 +256,7 @@ describe Shamu::Services::ActiveRecordCrud do
       end
 
       it "excludes unwanted methods" do
-        klass.finders except: :list
+        klass.define_finders except: :list
 
         expect( klass.new ).to respond_to :find
         expect( klass.new ).to respond_to :lookup
@@ -287,7 +264,7 @@ describe Shamu::Services::ActiveRecordCrud do
       end
 
       it "includes only specific methods" do
-        klass.finders only: :list
+        klass.define_finders only: :list
 
         expect( klass.new ).not_to respond_to :find
         expect( klass.new ).not_to respond_to :lookup
@@ -307,7 +284,7 @@ describe Shamu::Services::ActiveRecordCrud do
     it "yields to block if block given" do
       find_klass = Class.new( klass )
       expect do |b|
-        find_klass.find do |_|
+        find_klass.define_find do |_|
           b.to_proc.call
           ActiveRecordSpec::Favorite.all.first
         end
@@ -353,7 +330,7 @@ describe Shamu::Services::ActiveRecordCrud do
     it "yields to block if given?" do
       expect do |b|
         yield_klass = Class.new( klass ) do
-          lookup( &b )
+          define_lookup( &b )
         end
 
         scorpion.new( yield_klass ).lookup entity.id
@@ -392,7 +369,7 @@ describe Shamu::Services::ActiveRecordCrud do
     it "yields if block given" do
       expect do |b|
         yield_klass = Class.new( klass ) do
-          list( &b )
+          define_list( &b )
         end
 
         scorpion.new( yield_klass ).list
@@ -438,6 +415,22 @@ describe Shamu::Services::ActiveRecordCrud do
       end.to change( ActiveRecordSpec::Favorite, :count ).by( -1 )
     end
 
+    it "short-circuits if block yields a Services::Result" do
+      record = klass.model_class.all.first
+      records = [ record ]
+
+      expect( records ).to receive( :find ).and_return record
+
+      yield_klass = Class.new( klass ) do
+        define_destroy records do
+          Shamu::Services::Result.new
+        end
+      end
+
+      service = scorpion.new( yield_klass )
+      service.destroy entity
+    end
+
     it "calls #authorize!" do
       expect( service ).to receive( :authorize! ).with(
         :destroy,
@@ -458,7 +451,7 @@ describe Shamu::Services::ActiveRecordCrud do
     let( :klass ) do
       ec = entity_class
       Class.new( super() ) do
-        build_entities do |records|
+        define_build_entities do |records|
           records.map do |record|
             scorpion.fetch ec, { record: record }, {}
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shamu
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Paul Alexander
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel