shamu 0.0.13 → 0.0.14

data/lib/shamu/features/features_service.rb

@@ -158,11 +158,11 @@ module Shamu
 
         # @param [String] path of the default config file.
         # @return [String]
-        def default_config_path=( path )
+        def default_config_path=( path ) # rubocop:disable Style/TrivialAccessors
           @default_config_path = path
         end
       end
 
     end
   end
-end
+end

data/lib/shamu/features/toggle.rb

@@ -76,7 +76,6 @@ module Shamu
         !retire_at || context.time > retire_at
       end
 
-
       def initialize( attributes )
         fail ArgumentError, "Must provide a retire_at attribute for '#{ attributes[ 'name' ] }' toggle." unless attributes["retire_at"] # rubocop:disable Metrics/LineLength
         fail ArgumentError, "Type must be one of #{ TYPES } for '#{ attributes[ 'name' ] }' toggle." unless TYPES.include?( attributes["type"] ) # rubocop:disable Metrics/LineLength
@@ -107,7 +106,7 @@ module Shamu
           def load_from_path( path, toggles, state )
             path = File.expand_path( path, state.file_path )
             File.open( path, "r" ) do |file|
-              yaml = YAML.load( file.read )
+              yaml = YAML.load( file.read ) # rubocop:disable  Security/YAMLLoad
               parse_node( yaml, toggles, ParsingState.new( state.name, File.dirname( path ) ) )
             end
           end
@@ -146,4 +145,4 @@ module Shamu
       ParsingState = Struct.new( :name, :file_path )
     end
   end
-end
+end

data/lib/shamu/json_api/context.rb

@@ -95,7 +95,6 @@ module Shamu
         presenter
       end
 
-
       # @return [Hash] of request param options to be output in the response meta.
       def params_meta
         return unless fields.any?

data/lib/shamu/json_api/rails/controller.rb

@@ -234,7 +234,6 @@ module Shamu
               presenters: presenters == :not_set ? json_context_presenters : presenters
           end
 
-
           # See (Shamu::Rails::Entity#request_params)
           def request_params( param_key )
             if relationships = json_request_payload[ :relationships ]
@@ -291,7 +290,6 @@ module Shamu
               end
           end
 
-
           def json_context_fields
             params[:fields]
           end

data/lib/shamu/rails/controller.rb

@@ -59,7 +59,6 @@ module Shamu
           secure_services.any? { |s| s.permit?( *args ) }
         end
 
-
         # @!visibility public
         #
         # Gets the security principal for the current request.

data/lib/shamu/rails/entity.rb

@@ -21,7 +21,7 @@ module Shamu
           return unless service.respond_to?( :request_for )
           return unless request = service.request_for( action, entity )
 
-          param_key ||= entity.model_name.param_key
+          param_key ||= entity.model_name.param_key if entity
           request.assign_attributes( request_params( param_key ) )
 
           service.authorize!( action, entity, request ) if service.respond_to?( :authorize! )

data/lib/shamu/security/policy.rb

@@ -55,7 +55,6 @@ module Shamu
         @roles     = roles || []
       end
 
-
       # Authorize the given `action` on the given resource. If it is not
       # {#permit? permitted} then an exception is raised.
       #
@@ -286,4 +285,4 @@ module Shamu
 
     end
   end
-end
+end

data/lib/shamu/services/active_record.rb

@@ -53,6 +53,22 @@ module Shamu
           end
         end
 
+        # @param [ActiveRecord::Relation, Enumerable] source
+        # @return [Boolean] true if the source supports paging and has paging
+        # constraints set.
+        def source_paged?( source )
+          source.respond_to?( :current_page ) && !!source.current_page
+        end
+
+        # (see Service#build_entity_list)
+        def build_entity_list( source )
+          if source_paged?( source )
+            Shamu::Entities::PagedList.new( source )
+          else
+            super
+          end
+        end
+
     end
   end
 end

data/lib/shamu/services/active_record_crud.rb

@@ -43,7 +43,7 @@ module Shamu
       extend ActiveSupport::Concern
 
       # Known DSL methods defined by {ActiveRecordCrud}.
-      DSL_METHODS = %i( create update change destroy find list lookup finders ).freeze
+      DSL_METHODS = %i[ create update change destroy find list lookup finders ].freeze
 
       included do |base|
         base.include Shamu::Services::RequestSupport
@@ -173,15 +173,21 @@ module Shamu
         # @yieldparam (see .apply_changes)
         # @return [Result] the result of the request.
         # @return [void]
-        def change( method = :update, &block )
+        def change( method = :update, &block ) # rubocop:disable Metrics/PerceivedComplexity, Metrics/AbcSize
           define_method method do |id, params = nil|
             klass = request_class( method )
 
-            id, params = id.id, id if id.is_a?( klass ) && !params
+            params, id = id, id[ :id ] if !params && !id.respond_to?( :to_model_id )
 
-            with_request params, klass do |request|
-              record = model_class.find( id.to_model_id )
-              authorize! method, build_entity( record ), request
+            with_partial_request params, klass do |request|
+              record = model_class.find( id.to_model_id || request.id )
+              entity = build_entity( record )
+
+              backfill_attributes = entity.to_attributes( only: request.unassigned_attributes )
+              request.assign_attributes backfill_attributes
+              next unless request.valid?
+
+              authorize! method, entity, request
 
               request.apply_to( record )
 
@@ -213,6 +219,26 @@ module Shamu
           change :update, &block
         end
 
+        # Define a `destroy( id )` method that takes an {Entities::Entity} {Entities::Entity#id}
+        # and destroys the resource.
+        #
+        # @param [ActiveRecord::Relation] default_scope to use when finding
+        #     records.
+        # @return [void]
+        def destroy( default_scope = model_class.all )
+          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|
+              record = default_scope.find( request.id )
+              authorize! :destroy, build_entity( record )
+              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.
@@ -311,22 +337,6 @@ module Shamu
           end
         end
 
-        # Define a `destroy( id )` method that takes an {Entities::Entity} {Entities::Entity#id}
-        # and destroys the resource.
-        #
-        # @param [ActiveRecord::Relation] default_scope to use when finding
-        #     records.
-        # @return [void]
-        def destroy( default_scope = model_class.all )
-          define_method :destroy do |id|
-            wrap_not_found do
-              record = default_scope.find( id.to_model_id )
-              authorize! :destroy, build_entity( record )
-              record.destroy
-            end
-          end
-        end
-
         # Define a private `build_entities( records )` method that
         # constructs an {Entities::Entity} for each of the given `records`.
         #

data/lib/shamu/services/lazy_transform.rb

@@ -53,6 +53,22 @@ module Shamu
         end
       end
 
+      # Get the last transformed value without transforming the entire list.
+      # @overload last(n)
+      # @overload last
+      # @return [Object]
+      def last( *args )
+        if args.any?
+          transformed.last( *args )
+        else
+          return @last if defined? @last
+          @last = begin
+            value = source.last
+            raise_if_not_transformed( transformer.call( [ value ] ) ).last unless value.nil?
+          end
+        end
+      end
+
       # @return [Boolean] true if there are no source values.
       def empty?
         source.empty?
@@ -80,6 +96,21 @@ module Shamu
         end
       end
 
+      # For all other methods, force a transform then delegate to the
+      # transformed list.
+
+      def method_missing( name, *args, &block )
+        if respond_to_missing?( name, false )
+          source.public_send( name, *args, &block )
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?( *args )
+        super || source.respond_to?( *args )
+      end
+
       private
 
         attr_reader :source

data/lib/shamu/services/request_support.rb

@@ -88,15 +88,16 @@ module Shamu
         # @see #with_request
         def with_partial_request( params, request_class, &block )
           request = request_class.coerce( params )
+          sources = yield( request )
+
           # Make sure the request captures errors even if the block doesn't
           # check
           request.valid?
-          sources = yield( request )
 
           if sources.is_a?( Result )
             sources
           else
-            result request, *Array.wrap( sources )
+            result( *Array.wrap( sources ), request: request )
           end
         end
 

data/lib/shamu/services/service.rb

@@ -101,7 +101,7 @@ module Shamu
         #
         # @param [Enumerable] records the raw list of records.
         # @yield (record)
-        # @yieldparam [Object] record the raw value from the `list` to to
+        # @yieldparam [Enumerable<Object>] records the raw values from the `list` to
         #     transform to an {Entities::Entity}.
         # @yieldreturn [Entities::Entity]
         # @return [Entities::List]
@@ -112,9 +112,17 @@ module Shamu
             transformer ||= method( :build_entities )
           end
 
-          Entities::List.new LazyTransform.new( records, &transformer )
+          build_entity_list build_records_transform( records, &transformer )
         end
 
+          def build_records_transform( records, &transformer )
+            LazyTransform.new( records, &transformer )
+          end
+
+          def build_entity_list( source )
+            Entities::List.new source
+          end
+
         # @!visibility public
         # Match a list of records with the ids used to look up those records.
         # Uses a {Entities::NullEntity} if the id doesn't have a matching record.
@@ -219,7 +227,7 @@ module Shamu
         # @!visibility public
         #
         # Find an associated entity from a dependent service. Attempts to
-        # effeciently handle multiple requests to lookup associations by caching
+        # efficiently handle multiple requests to lookup associations by caching
         # all the associated entities when {#lookup_association} is used
         # repeatedly when building an entity.
         #

data/lib/shamu/to_model_id_extension.rb

@@ -11,6 +11,7 @@ module Shamu
       Integer.include Integers
       String.include Strings
       Array.include Enumerables
+      NilClass.include Integers
 
       ActiveRecord::Base.include Models if defined? ActiveRecord::Base
     end
@@ -47,4 +48,4 @@ module Shamu
   end
 end
 
-Shamu::ToModelIdExtension.extend!
+Shamu::ToModelIdExtension.extend!

data/lib/shamu/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Shamu
   # The primary version number
-  VERSION_NUMBER  = "0.0.13"
+  VERSION_NUMBER  = "0.0.14"
 
   # Version suffix such as 'beta' or 'alpha'
   VERSION_SUFFIX  = ""

data/shamu.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path( "../lib", __FILE__ )
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "shamu/version"
@@ -23,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "activemodel", ">= 5.0"
   spec.add_dependency "activesupport", ">= 5.0"
   spec.add_dependency "scorpion-ioc", "~> 0.6"
-  spec.add_dependency "multi_json", "~> 1.11.2"
+  spec.add_dependency "multi_json", "~> 1.11"
   spec.add_dependency "rack", ">= 1"
   spec.add_dependency "listen", "~> 3"
   spec.add_dependency "crc32", "~> 1"

data/spec/lib/shamu/active_record_support.rb

@@ -1,5 +1,6 @@
 require "active_record"
 require "shamu/entities/active_record"
+require "shamu/entities/active_record_soft_destroy"
 
 module ActiveRecordSpec
   class Favorite < ::ActiveRecord::Base
@@ -29,4 +30,9 @@ module ActiveRecordSpec
   class FavoriteScope < Shamu::Entities::ListScope
     attribute :name
   end
+
+  class FavoriteEntity < Shamu::Entities::Entity
+    model :record
+    attribute :name, on: :record
+  end
 end

data/spec/lib/shamu/attributes/assignment_spec.rb

@@ -59,6 +59,49 @@ describe Shamu::Attributes::Assignment do
     expect( instance.q ).to eq "ABC"
   end
 
+  describe "#assigned_attributes" do
+    let( :klass ) do
+      Class.new do
+        include Shamu::Attributes
+        include Shamu::Attributes::Assignment
+
+        attribute :name
+        attribute :email
+      end
+    end
+
+    it "identifies attributes assigned in constructor" do
+      instance = klass.new name: "set"
+
+      expect( instance.assigned_attributes ).to include :name
+      expect( instance.assigned_attributes ).not_to include :email
+      expect( instance.unassigned_attributes ).to include :email
+    end
+
+    it "does not identity attributes memoized by reading" do
+      instance = klass.new name: "set"
+
+      expect( instance.email ).to be_nil
+      expect( instance.assigned_attributes ).to include :name
+      expect( instance.assigned_attributes ).not_to include :email
+      expect( instance.set?( :email ) ).to be_truthy
+    end
+
+    it "identifies attributes assigned explicitly" do
+      instance = klass.new
+      instance.name = "set"
+
+      expect( instance.assigned_attributes ).to include :name
+      expect( instance.assigned_attributes ).not_to include :email
+    end
+
+    it "identifies attribute_assigned?" do
+      instance = klass.new name: "set"
+      expect( instance.name_assigned? ).to be_truthy
+    end
+  end
+
+
   describe "coercion" do
     it "coerces using given method name" do
       klass = Class.new( base_klass ) do
@@ -83,6 +126,19 @@ describe Shamu::Attributes::Assignment do
       expect( instance.label ).to eq "coerced"
     end
 
+    it "coerces using a class" do
+      coerce_class = Class.new do
+        def initialize( v ); end
+      end
+
+      klass = Class.new( base_klass ) do
+        attribute :label, coerce: coerce_class
+      end
+
+      instance = klass.new( label: "original" )
+      expect( instance.label ).to be_a coerce_class
+    end
+
     describe "smart" do
       let( :klass ) do
         Class.new( base_klass ) do
@@ -91,6 +147,7 @@ describe Shamu::Attributes::Assignment do
 
           attribute :user_id
           attribute :tag_ids
+          attribute :id
         end
       end
       let( :instance ) { klass.new }
@@ -109,16 +166,23 @@ describe Shamu::Attributes::Assignment do
         instance.expire_on = value
       end
 
-      it "coerces nnn_id to an Integer" do
+      it "coerces nnn_id to a model id" do
         value = double
-        expect( value ).to receive( :to_i )
+        expect( value ).to receive( :to_model_id )
 
         instance.user_id = value
       end
 
-      it "coerces nnn_ids to an array of Integers" do
+      it "coerces id to a model id" do
+        value = double
+        expect( value ).to receive( :to_model_id )
+
+        instance.id = value
+      end
+
+      it "coerces nnn_ids to an array o model ids" do
         value = double
-        expect( value ).to receive( :to_i )
+        expect( value ).to receive( :to_model_id )
 
         instance.tag_ids = value
       end
@@ -126,4 +190,4 @@ describe Shamu::Attributes::Assignment do
     end
   end
 
-end
+end

data/spec/lib/shamu/attributes/camel_case_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+
+describe Shamu::Attributes::CamelCase do
+  let( :klass ) do
+    Class.new do
+      include Shamu::Attributes
+      include Shamu::Attributes::Assignment
+      include Shamu::Attributes::CamelCase
+
+      attribute :name
+      attribute :camel_case
+    end
+  end
+
+  it "responds to camelcased version" do
+    expect( klass.new( camel_case: "Word" ).camelCase ).to eq "Word"
+  end
+
+  it "assigns camelized version from input args" do
+    expect( klass.new( camelCase: "Word" ).camel_case ).to eq "Word"
+  end
+
+  it "allows short non-camelized words" do
+    expect( klass.new( name: "Pete" ).name ).to eq "Pete"
+  end
+
+  it "assigns the original attribute" do
+    instance = klass.new
+    instance.camelCase = "Worked"
+
+    expect( instance.camel_case ).to eq "Worked"
+  end
+end

data/spec/lib/shamu/attributes/validation_spec.rb

@@ -50,4 +50,12 @@ describe Shamu::Attributes::Validation do
     instance.valid?
     instance.valid?
   end
-end
+
+  it "supports shamu validators with simple hash names" do
+    nested = Class.new( klass ) do
+      attribute :nested, valid: true
+    end
+
+    expect( nested.validators ).to include Shamu::Attributes::Validators::ValidValidator
+  end
+end

data/spec/lib/shamu/attributes_spec.rb

@@ -56,6 +56,10 @@ describe Shamu::Attributes do
     it "is false if the attribute has not been set" do
       expect( klass.new ).not_to be_set :name
     end
+
+    it "has per attribute set? method" do
+      expect( klass.new( name: "Set" ).name_set? ).to be_truthy
+    end
   end
 
 

data/spec/lib/shamu/entities/active_record_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 require "active_record"
 require "shamu/entities/active_record"
+require "shamu/entities/active_record_soft_destroy"
 
 describe Shamu::Entities::ActiveRecord do
   use_active_record
@@ -37,6 +38,32 @@ describe Shamu::Entities::ActiveRecord do
       expect( relation.limit_value ).to eq 25
     end
 
+    it "filters by window paging" do
+      klass = Class.new( ActiveRecordSpec::FavoriteScope ) do
+        include Shamu::Entities::ListScope::WindowPaging
+      end
+
+      scope    = klass.new( first: 10, after: 30 )
+      relation = ActiveRecordSpec::Favorite.by_list_scope( scope )
+
+      expect( relation.offset_value ).to eq 30
+      expect( relation.limit_value ).to eq 10
+    end
+
+    it "filters by inverse window paging" do
+      klass = Class.new( ActiveRecordSpec::FavoriteScope ) do
+        include Shamu::Entities::ListScope::WindowPaging
+      end
+
+      scope = klass.new
+      expect( scope ).to receive( :reverse_sort! ).at_least( :once )
+      scope.assign_attributes( last: 10, before: 30 )
+      relation = ActiveRecordSpec::Favorite.by_list_scope( scope )
+
+      expect( relation.offset_value ).to eq 30
+      expect( relation.limit_value ).to eq 10
+    end
+
     it "filters by dates" do
       klass = Class.new( ActiveRecordSpec::FavoriteScope ) do
         include Shamu::Entities::ListScope::Dates

data/spec/lib/shamu/entities/entity_lookup_models.rb

@@ -0,0 +1,11 @@
+module EntityLookupServiceSpecs
+  class ExamplesService < Shamu::Services::Service
+  end
+
+  class CustomService < Shamu::Services::Service
+  end
+
+  class ExampleEntity < Shamu::Entities::Entity
+    attribute :id
+  end
+end

data/spec/lib/shamu/entities/entity_lookup_service_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+require_relative "entity_lookup_models"
+
+
+describe Shamu::Entities::EntityLookupService do
+
+  let( :service ) do
+    scorpion.new( Shamu::Entities::EntityLookupService, { "Water" => EntityLookupServiceSpecs::CustomService }, {} )
+  end
+
+  describe "#service_class_for" do
+    it "finds default service" do
+      expect( service.service_class_for( "EntityLookupServiceSpecs::Example" ) ).to be \
+        EntityLookupServiceSpecs::ExamplesService
+    end
+
+    it "uses custom service" do
+      expect( service.service_class_for( "Water" ) ).to be EntityLookupServiceSpecs::CustomService
+    end
+  end
+
+  describe "#ids" do
+    it "maps entities to their entity path" do
+      entity = EntityLookupServiceSpecs::ExampleEntity.new( id: 5 )
+      expect( service.ids( entity ) ).to eq( [ "EntityLookupServiceSpecs::Example[5]" ] )
+    end
+  end
+
+  describe "#record_ids" do
+    it "gets the original record id" do
+      entity = EntityLookupServiceSpecs::ExampleEntity.new( id: 5 )
+      id     = service.ids( entity ).first
+
+      expect( service.record_ids( id ).first ).to eq( 5 )
+    end
+  end
+
+  describe "#lookup" do
+    let( :examples_service ) { double( EntityLookupServiceSpecs::ExamplesService ) }
+    let( :custom_service )   { double( EntityLookupServiceSpecs::CustomService ) }
+
+    before( :each ) do
+      allow( service.scorpion ).to receive( :fetch )
+        .with( EntityLookupServiceSpecs::ExamplesService )
+        .and_return( examples_service )
+
+      allow( service.scorpion ).to receive( :fetch )
+        .with( EntityLookupServiceSpecs::CustomService )
+        .and_return( custom_service )
+    end
+
+    it "finds an entity" do
+      expect( examples_service ).to receive( :lookup ).with( "4" ).and_return [ "Found" ]
+
+      expect( service.lookup( "EntityLookupServiceSpecs::Example[4]" ).to_a ).to eq [ "Found" ]
+    end
+
+    it "batches common entity types" do
+      expect( examples_service ).to receive( :lookup ).with( "4", "91" ).and_return( [ "One", "Two" ] )
+
+      returned = service.lookup( "EntityLookupServiceSpecs::Example[4]", "EntityLookupServiceSpecs::Example[91]" )
+      expect( returned.to_a ).to eq [ "One", "Two" ]
+    end
+
+    it "returns in same order" do
+      expect( examples_service ).to receive( :lookup ).with( "4", "91" ).and_return( [ "One", "Two" ] )
+      expect( custom_service ).to receive( :lookup ).with( "500" ).and_return( [ "Agua" ] )
+
+      returned = service.lookup( "EntityLookupServiceSpecs::Example[4]",
+                                 "Water[500]",
+                                 "EntityLookupServiceSpecs::Example[91]" )
+
+      expect( returned.to_a ).to eq [ "One", "Agua", "Two" ]
+    end
+
+  end
+end