shamu 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2e88c67ffd19033c4fafc5933fb288f8538a709
-  data.tar.gz: daaf1a9d1f8dcd9746f335ef0fa6122aa7c9dfa0
+  metadata.gz: c273a3ff9a688ea2ad15efb7f3136aa203fecda6
+  data.tar.gz: a9f5d0e08e4cdda4e8147c0b58b4c8ab6b46ab63
 SHA512:
-  metadata.gz: 74934132c1023791f4fff72aa458ae8815c72138044bc33b0de60a39d71802e7c976f8409b675a7bb67644d377576370ed3e88a79c21bce48a6b8fbca698c7b3
-  data.tar.gz: '00095f967a07a2517a92721450ab45b2ee991d43f526fcde7b9bb853ea8f98dd4dd014f000d8ff46247e83be0cd62cb93513491df24b79f1a73be1c1f293b3e0'
+  metadata.gz: 76c8c84815e68711e085d0a3f372e9b815ffadefb48c76606d3351539dd1ab6e85266f7b548963dd481f79362c8ddcd96d0e3c8e056602f4d8c110b9ec181b67
+  data.tar.gz: 791dc7e9eb66fa9f45ea7fee32d7292e93e4faa24c6cf083b41570269251d450a3155997b894f9a1ec3cb50fd544b9a2322a0387e3a96fe2537a2d9919e67366

data/.rubocop.yml

@@ -1,6 +1,24 @@
 AllCops:
   TargetRubyVersion: 2.3
 
+  Exclude:
+    - "bin/*"
+    - "vendor/bundle/**/*"
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/UselessAccessModifier:
+  Enabled: false
 
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
@@ -11,7 +29,6 @@ Lint/AssignmentInCondition:
 Lint/UnusedMethodArgument:
   Enabled: false
 
-
 Metrics/ClassLength:
   Max: 500
 
@@ -33,22 +50,25 @@ Metrics/ModuleLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Style/Alias:
   Enabled: false
 
-Style/CommentIndentation:
+Layout/CommentIndentation:
   Enabled: false
 
-Style/EmptyLines:
+Layout/EmptyLines:
   Enabled: false
 
-Style/EmptyLinesAroundBlockBody:
+Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
-Style/EmptyLinesAroundClassBody:
+Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
-Style/EmptyLinesAroundModuleBody:
+Layout/EmptyLinesAroundModuleBody:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
@@ -66,58 +86,73 @@ Style/GuardClause:
 Style/HashSyntax:
   Enabled: false
 
-Style/IndentArray:
+Layout/IndentArray:
   Enabled: false
 
-Style/IndentationConsistency:
+Layout/IndentationConsistency:
   Enabled: false
 
-Style/IndentationWidth:
+Layout/IndentationWidth:
   Enabled: false
 
 Style/Lambda:
   Enabled: false
 
-Style/MultilineBlockChain:
+Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/OptionHash:
-  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: false
 
-Style/ParallelAssignment:
+Style/NumericPredicate:
   Enabled: false
 
+Style/OptionHash:
+ Enabled: true
+
 Style/RegexpLiteral:
   Enabled: false
 
 Style/SignalException:
   Enabled: false
 
-Style/SpaceAroundBlockParameters:
+Layout/SpaceAroundBlockParameters:
   Enabled: false
 
-Style/SpaceAroundOperators:
+Style/PercentLiteralDelimiters:
   Enabled: false
 
-Style/SpaceInsideBrackets:
+Layout/SpaceAroundOperators:
   Enabled: false
 
-Style/SpaceInsideParens:
+Layout/SpaceInsideBrackets:
   Enabled: false
 
-Style/SpaceInsideStringInterpolation:
+Layout/SpaceInsideParens:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
   EnforcedStyle: space
 
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
-Style/TrailingBlankLines:
+Layout/TrailingBlankLines:
   Enabled: false
 
 Style/TrailingCommaInLiteral:
   Enabled: false
 
-Style/TrivialAccessors:
+Style/WhileUntilModifier:
   Enabled: false
 
 Style/UnneededInterpolation:

data/Gemfile

@@ -16,7 +16,7 @@ group :test do
 
   gem "sqlite3", "~> 1.3.11"
   gem "guard", "~> 2.12.8"
-  gem "rubocop", "~> 0.39.0"
+  gem "rubocop", "~> 0.49.0"
   gem "guard-rubocop"
   gem "spring"
   gem "guard-rspec"
@@ -26,10 +26,10 @@ group :test do
   gem "fuubar"
   gem "yard"
   gem "yard-activesupport-concern"
-  gem "simplecov"
+  gem "simplecov", "~> 0.14"
   gem "ruby_gntp", "~> 0.3.4"
   gem "awesome_print"
 
-  gem "codeclimate-test-reporter", group: :test, require: nil
+  gem "codeclimate-test-reporter", "~> 1.0 ", group: :test, require: nil
   gem "rspec_junit_formatter", "~> 0.2.2", platforms: :mri
 end

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    shamu (0.0.13)
+    shamu (0.0.14)
       activemodel (>= 5.0)
       activesupport (>= 5.0)
       crc32 (~> 1)
       listen (~> 3)
       loofah (~> 2)
-      multi_json (~> 1.11.2)
+      multi_json (~> 1.11)
       rack (>= 1)
       scorpion-ioc (~> 0.6)
 
@@ -56,8 +56,8 @@ GEM
     awesome_print (1.7.0)
     builder (3.2.3)
     byebug (9.0.6)
-    codeclimate-test-reporter (1.0.8)
-      simplecov (<= 0.13)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
     coderay (1.1.1)
     combustion (0.6.0)
       activesupport (>= 3.0.0)
@@ -112,7 +112,7 @@ GEM
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
     minitest (5.10.2)
-    multi_json (1.11.3)
+    multi_json (1.12.1)
     nenv (0.3.0)
     nio4r (2.0.0)
     nokogiri (1.7.2)
@@ -120,6 +120,7 @@ GEM
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    parallel (1.11.2)
     parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -193,8 +194,9 @@ GEM
     rspec_junit_formatter (0.2.3)
       builder (< 4)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.39.0)
-      parser (>= 2.3.0.7, < 3.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
@@ -205,7 +207,7 @@ GEM
     scorpion-ioc (0.6.0)
       rails (>= 4.0)
     shellany (0.0.1)
-    simplecov (0.13.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -242,7 +244,7 @@ DEPENDENCIES
   awesome_print
   bundler (~> 1.6)
   byebug
-  codeclimate-test-reporter
+  codeclimate-test-reporter (~> 1.0)
   combustion (~> 0.5)
   fuubar
   guard (~> 2.12.8)
@@ -258,10 +260,10 @@ DEPENDENCIES
   rspec-rails
   rspec-wait
   rspec_junit_formatter (~> 0.2.2)
-  rubocop (~> 0.39.0)
+  rubocop (~> 0.49.0)
   ruby_gntp (~> 0.3.4)
   shamu!
-  simplecov
+  simplecov (~> 0.14)
   spring
   sqlite3 (~> 1.3.11)
   yard

data/circle.yml

@@ -5,7 +5,7 @@ database:
 
 test:
   override:
-    - RAILS_ENV=test bundle exec rspec -r rspec_junit_formatter --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
+    - RAILS_ENV=test bundle exec rspec -r rspec_junit_formatter --format progress --format RspecJunitFormatter -o $CIRCLE_TEST_REPORTS/rspec/junit.xml
     - bundle exec rubocop
 
   post:

data/lib/shamu/attributes/assignment.rb

@@ -12,6 +12,30 @@ module Shamu
         public :assign_attributes
       end
 
+      # @return [Array<Symbol>] the attributes that have been assigned.
+      def assigned_attributes
+        @assigned_attributes.to_a || []
+      end
+
+      # @return [Array<Symbol>] the attributes that have not been assigned.
+      def unassigned_attributes
+        self.class.attributes.keys - assigned_attributes
+      end
+
+      # @return [Boolean] true if the attribute as explicitly been defined -
+      # not just present/memoized.
+      def assigned?( name )
+        assigned_attributes.include?( name )
+      end
+
+      private
+
+        def assigned_attribute!( name )
+          @assigned_attributes ||= Set.new
+          @assigned_attributes << name
+        end
+
+
       class_methods do
 
         # Define a new attribute for the class.
@@ -36,7 +60,7 @@ module Shamu
         #     attribute :tags, coerce: :to_s, array: true
         #   end
         def attribute( name, *args, **options, &block )
-          super
+          super( name, *args, **options )
           define_attribute_assignment( name, **options )
           define_attribute_writer( name, **options )
         end
@@ -52,6 +76,7 @@ module Shamu
 
             class_eval <<-RUBY, __FILE__, __LINE__ + 1
               def assign_#{ name }( *values )
+                assigned_attribute!( :#{ name } )
                 @#{ name } = coerce_#{ name }#{ array ? '_array' : '' }( *values )
               end
             RUBY
@@ -73,10 +98,14 @@ module Shamu
             private :"coerce_#{ name }_array"
           end
 
-          def define_attribute_coercion( name, coerce )
+          def define_attribute_coercion( name, coerce ) # rubocop:disable Metrics/PerceivedComplexity
             coerce = cource_method( name, coerce )
 
-            if !coerce || coerce.is_a?( Symbol )
+            if coerce.is_a?( Class )
+              define_method :"coerce_#{ name }" do |value|
+                coerce.new( value ) if value
+              end
+            elsif !coerce || coerce.is_a?( Symbol )
               class_eval <<-RUBY, __FILE__, __LINE__ + 1
                 def coerce_#{ name }( value )
                   value#{ coerce && ".#{ coerce }" }
@@ -93,7 +122,7 @@ module Shamu
             if coerce == :smart
               case name
               when /_at$/, /_on$/ then :to_datetime
-              when /_ids?$/       then :to_i
+              when /(^|_)ids?$/   then :to_model_id
               end
             else
               coerce
@@ -107,8 +136,18 @@ module Shamu
             alias_method :"#{ as }=", :"#{ name }=" if as
           end
 
+          def define_attribute_reader( name, as: nil, ** )
+            super
+
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{ name }_assigned?                # def attribute_assigned?
+                assigned?( :#{ name } )              #   assigned( :attribute )
+              end                                    # end
+            RUBY
+          end
+
       end
 
     end
   end
-end
+end

data/lib/shamu/attributes/camel_case.rb

@@ -0,0 +1,21 @@
+module Shamu
+  module Attributes
+
+    # Automatically add camelCase aliases for all attributes.
+    module CamelCase
+      extend ActiveSupport::Concern
+
+      included do |base|
+        raise "Must include Shamu::Attributes first." unless base < Shamu::Attributes
+      end
+
+      class_methods do
+        def attribute( name, *args, **options, &block )
+          options[ :as ] ||= name.to_s.camelize( :lower ).to_sym
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/shamu/attributes/validation.rb

@@ -46,7 +46,11 @@ module Shamu
           super
 
           validation_options = options.each_with_object({}) do |(key, value), opts|
-            opts[key] = value unless attribute_option_keys.include?( key )
+            next if attribute_option_keys.include?( key )
+
+            validator = "#{ key.to_s.camelize }Validator"
+            key = "shamu/attributes/validators/#{ key }" if Shamu::Attributes::Validators.const_defined?( validator.to_sym ) # rubocop:disable Metrics/LineLength
+            opts[ key ] = value
           end
           validates name, validation_options if validation_options.any?
         end
@@ -67,6 +71,14 @@ module Shamu
           @validated = true
           run_validations!
         end
+
+        private
+
+          def assign_attribute!( * )
+            # If any attribute changes we should re-run the validations
+            @validated = false
+            super
+          end
       end
 
     end

data/lib/shamu/attributes/validators/valid_validator.rb

@@ -0,0 +1,14 @@
+module Shamu
+  module Attributes
+    module Validators
+      # Validates that an attribute's value returns true for `valid?`.
+      #
+      # validates :nested_request, valid: true
+      class ValidValidator < ActiveModel::EachValidator
+        def validate_each( record, attribute, value )
+          record.errors.add attribute, :invalid if value && !value.valid?
+        end
+      end
+    end
+  end
+end

data/lib/shamu/attributes/validators.rb

@@ -0,0 +1,7 @@
+module Shamu
+  module Attributes
+    module Validators
+      require "shamu/attributes/validators/valid_validator"
+    end
+  end
+end

data/lib/shamu/attributes.rb

@@ -27,7 +27,9 @@ module Shamu
     require "shamu/attributes/assignment"
     require "shamu/attributes/fluid_assignment"
     require "shamu/attributes/validation"
+    require "shamu/attributes/validators"
     require "shamu/attributes/equality"
+    require "shamu/attributes/camel_case"
     require "shamu/attributes/html_sanitation"
 
     def initialize( *attributes )
@@ -108,19 +110,18 @@ module Shamu
 
       def build_value( build, value )
         if build.is_a?( Class )
-          klass = build
-          build = ->(v) { klass.new( v ) }
+          build.new( value )
+        else
+          build.call( value )
         end
-
-        build.call( value )
       end
 
       def resolve_attributes( attributes )
         if attributes.respond_to?( :to_attributes )
           attributes.to_attributes
         # Allow protected attributes to be used without explicitly being set.
-        # All 'Attributes' classes are them selves the explicit set of permitted
-        # attributes.
+        # All 'Attributes' classes are themselves the explicit set of permitted
+        # attributes so there is no danger of 'over assignment'.
         elsif attributes.respond_to?( :to_unsafe_h )
           attributes.to_unsafe_h
         elsif attributes.respond_to?( :to_hash )
@@ -161,7 +162,7 @@ module Shamu
       #     to.
       # @param [Object,#call] default value if not set.
       # @param [Class,#call] build method used to build a nested object on
-      #     assignement of a hash with nested keys.
+      #     assignment of a hash with nested keys.
       # @param [Boolean] serialize true if the attribute should be included in
       #   {#to_attributes}. Default true.
       # @yieldreturn the value of the attribute. The result is memoized so the
@@ -203,7 +204,7 @@ module Shamu
         # @return [Array<Symbol>] keys used by the {.attribute} method options
         #   argument. Used by {Attributes::Validation} to filter option keys.
         def attribute_option_keys
-          [ :on, :build, :default, :serialize ]
+          [ :on, :build, :default, :serialize, :as ]
         end
 
         def create_attribute( name, *args, **options )
@@ -219,6 +220,10 @@ module Shamu
               return @#{ name } if defined? @#{ name }              #   return @attribute if defined? @attribute
               @#{ name } = fetch_#{ name }                          #   @attribute = fetch_attribute
             end                                                     # end
+
+            def #{ name }_set?                                      # def attribute_set?
+              defined? @#{ name }                                   #   defined? @attribute
+            end                                                     # end
           RUBY
 
           alias_method as, name if as

data/lib/shamu/auditing/auditing_service.rb

@@ -13,11 +13,7 @@ module Shamu
     class AuditingService < Services::Service
 
       def self.create( scorpion, *args )
-        if defined? ActiveRecord
-          scorpion.fetch Shamu::Auditing::ActiveRecord::Service, *args
-        else
-          fail "No available auditing service available."
-        end
+        scorpion.fetch Shamu::Auditing::LoggingAuditingService, *args
       end
 
       # Records an auditable event in persistent storage.

data/lib/shamu/auditing/support.rb

@@ -24,6 +24,14 @@ module Shamu
 
       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
@@ -40,10 +48,14 @@ module Shamu
         #     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 )
           transaction = Transaction.new \
             user_id_chain: auditing_security_principal.user_id_chain
 
-          result = with_request params, request_class do |request|
+          result = send method, params, request_class do |request|
             transaction.action  = audit_request_action( request, action )
             transaction.changes = request.to_attributes
 
@@ -72,4 +84,4 @@ module Shamu
         end
     end
   end
-end
+end

data/lib/shamu/entities/active_record.rb

@@ -30,6 +30,7 @@ module Shamu
         criteria = apply_custom_list_scope( criteria, scope )
         criteria = apply_paging_scope( criteria, scope )        if scope.respond_to?( :paged? )
         criteria = apply_scoped_paging_scope( criteria, scope ) if scope.respond_to?( :scoped_page? )
+        criteria = apply_window_paging_scope( criteria, scope ) if scope.respond_to?( :window_paged? )
         criteria = apply_dates_scope( criteria, scope )         if scope.respond_to?( :dated? )
         criteria = apply_sorting_scope( criteria, scope )       if scope.respond_to?( :sorted? )
         criteria
@@ -60,7 +61,7 @@ module Shamu
 
         def apply_sorting_scope( criteria, scope )
           if scope.sort_by
-            criteria = scope.sort_by.reduce( criteria ) do |crit, ( field, direction )|
+            criteria = scope.sort_by_resolved.reduce( criteria ) do |crit, ( field, direction )|
               apply_sort( crit, field, direction )
             end
           end
@@ -84,6 +85,18 @@ module Shamu
           criteria
         end
 
+        def apply_window_paging_scope( criteria, scope )
+          if scope.window_paged?
+            criteria = criteria.page( 1 )
+            criteria = criteria.per( scope.first )      if scope.first
+            criteria = criteria.padding( scope.after )  if scope.after
+            criteria = criteria.per( scope.last )       if scope.last
+            criteria = criteria.padding( scope.before ) if scope.before
+          end
+
+          criteria
+        end
+
         def apply_dates_scope( criteria, scope )
           criteria = criteria.where( criteria.arel_table[:since].gteq( scope.since ) ) if scope.since
           criteria = criteria.where( criteria.arel_table[:until].lteq( scope.until ) ) if scope.until
@@ -114,10 +127,11 @@ module Shamu
         class StandardListScopeTemplate < ListScope
           include ListScope::Paging
           include ListScope::ScopedPaging
+          include ListScope::WindowPaging
           include ListScope::Dates
           include ListScope::Sorting
         end
 
     end
   end
-end
+end

data/lib/shamu/entities/active_record_soft_destroy.rb

@@ -29,12 +29,16 @@ module Shamu
         # @return [ActiveRecord::Relation]
         scope :destroyed, ->() { unscope( where: :destroyed_at ).where( arel_table[ :destroyed_at ].not_eq( nil ) ) }
 
+        # Limit the records to those that have not been destroyed.
+        # @return [ActiveRecord::Relation]
+        scope :except_destroyed, ->() { unscope( where: :destroyed_at ).where( arel_table[ :destroyed_at ].eq( nil ) ) }
+
         # Include live and soft destroyed records.
         # @return [ActiveRecord::Relation]
         scope :including_destroyed, ->() { unscope( where: :destroyed_at ) }
 
-        # Exclude destroyed records by dfault.
-        default_scope { where( destroyed_at: nil ) }
+        # Exclude destroyed records by default.
+        default_scope { except_destroyed }
 
         #
         # @!endgroup Scopes
@@ -88,4 +92,4 @@ module Shamu
 
     end
   end
-end
+end

data/lib/shamu/entities/entity.rb

@@ -196,4 +196,4 @@ module Shamu
       end
     end
   end
-end
+end