snfoil 0.5.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6aa27a0dd5398b8e3abea471b5e8d3548aa4ff5239edabe7ee229306bde4787
-  data.tar.gz: 358b5e5b46347c30768272c5f50c08aa8f61a3fb44a016f26504a700f82c2c11
+  metadata.gz: 5029787f4c700bd7cd9e96bab7a1dc4e7b6b026d6ccef0da1bc180c3430b72cf
+  data.tar.gz: d699faeb7386a4d84f04d5df66802c08ee8f788008fa5d4c9331823417c20420
 SHA512:
-  metadata.gz: cf0c36ee0cf32bdf2f43503aec6076f8115df1f84e9cb0b954c7d58d0ea2583236d2dd7dd9dcab14f2ccb7680b8e004ae43fdcfcfc0df627681d2c1e365b077c
-  data.tar.gz: 613b3ce470d9c567d4fa06c915a1610e8b3ad35d26691f69455dc4e95cad874497bcbf21ca40f7f717df506730f7ecbc8b0f0a297393b6dbd166c7cdf1c76d6c
+  metadata.gz: f42e51e0d446fb0c6eee95dde45ea50da55e41c0a1a610fb95d3145531c2ebdd41be922485d71b5c5747a42e68814526c8a5973a41ed0604b0555e2affd7db80
+  data.tar.gz: 85fd3b571c33e1b48efd189b13c66654bca2e5b847250b11395e0855680150924223a209adc4b46135b18cdb13c9dd4ab62e2839975c0f95cf6f183cefea3d42

data/TODO.md

@@ -0,0 +1,5 @@
+# TODO
+## Tests
+### Contexts
+- Add tests for propagation of :authorize in options aggregate
+- Add tests for Create now using Build

data/lib/sn_foil.rb

@@ -10,6 +10,8 @@ require_relative 'sn_foil/contexts/destroy_context'
 require_relative 'sn_foil/context'
 require_relative 'sn_foil/policy'
 require_relative 'sn_foil/searcher'
+require_relative 'sn_foil/adapters/orms/base_adapter'
+require_relative 'sn_foil/adapters/orms/active_record'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'logger'
 

data/lib/sn_foil/adapters/orms/active_record.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative 'base_adapter'
+
 module SnFoil
   module Adapters
     module ORMs
       class ActiveRecord < SnFoil::Adapters::ORMs::BaseAdapter
-        def new(*params)
-          self.class.new(__getobj__.new(*params))
+        def new(**params)
+          self.class.new(__getobj__.new(params))
         end
 
         def all
@@ -21,9 +23,13 @@ module SnFoil
           __getobj__.destroyed?
         end
 
-        def attributes=(*attributes)
+        def attributes=(attributes)
           __getobj__.attributes = attributes
         end
+
+        def is_a?(klass)
+          __getobj__.class.object_id == klass.object_id
+        end
       end
     end
   end

data/lib/sn_foil/adapters/orms/base_adapter.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'delegate'
+
 module SnFoil
   module Adapters
     module ORMs
       class BaseAdapter < SimpleDelegator
-        def new(*_params)
+        def new(**_params)
           raise NotImplementedError, '#new not implemented in adapter'
         end
 
@@ -20,7 +22,7 @@ module SnFoil
           raise NotImplementedError, '#destroy not implemented in adapter'
         end
 
-        def attributes=(**_attributes)
+        def attributes=(_attributes)
           raise NotImplementedError, '#attributes= not implemented in adapter'
         end
       end

data/lib/sn_foil/contexts/build_context.rb

@@ -2,7 +2,6 @@
 
 require 'active_support/concern'
 require_relative './setup_context'
-require_relative './change_context'
 
 module SnFoil
   module Contexts
@@ -11,33 +10,58 @@ module SnFoil
 
       included do
         include SetupContext
-        include ChangeContext
       end
 
       class_methods do
+        attr_reader :i_setup_build_hooks
+
         def build(params:, entity: nil, **options)
           new(entity).build(**options, params: params)
         end
+
+        def setup_build(method = nil, **options, &block)
+          raise ArgumentError, '#setup_build requires either a method name or a block' if method.nil? && block.nil?
+
+          (@i_setup_build_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
+        end
       end
 
       def setup_build_object(params: {}, object: nil, **options)
-        SnFoil.logger.info 'Warning: Using build bypasses authorize.  It is safer to interact with models through create' unless ENV['ISTEST']
-        return wrap_object(object) if object
+        object = if object
+                   wrap_object(object)
+                 else
+                   klass = options.fetch(:model) { model }
+                   wrap_object(klass).new
+                 end
 
-        klass = options.fetch(:model) { model }
-        options.merge! object: wrap_object(klass).new(**params)
+        object.attributes = params
+        options.merge! object: object
       end
 
       def build(**options)
         options[:action] = :build
-        options = setup_build(setup_change(**options))
+        options = before_setup_build_object(**options)
         options = setup_build_object(**options)
+        authorize(options[:object], options[:authorize], **options) if options[:authorize]
         unwrap_object(options[:object])
       end
 
       def setup_build(**options)
         options
       end
+
+      def setup_build_hooks
+        self.class.i_setup_build_hooks || []
+      end
+
+      private
+
+      def before_setup_build_object(**options)
+        options = setup(**options)
+        options = setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_build(**options)
+        setup_build_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+      end
     end
   end
 end

data/lib/sn_foil/contexts/create_context.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'active_support/concern'
-require_relative './setup_context'
 require_relative './change_context'
 
 module SnFoil
@@ -10,8 +9,10 @@ module SnFoil
       extend ActiveSupport::Concern
 
       included do
-        include SetupContext
+        include BuildContext
         include ChangeContext
+
+        alias_method :setup_create_object, :setup_build_object
       end
 
       class_methods do
@@ -52,25 +53,14 @@ module SnFoil
         end
       end
 
-      def setup_create_object(params: {}, object: nil, **options)
-        object = if object
-                   wrap_object(object)
-                 else
-                   klass = options.fetch(:model) { model }
-                   wrap_object(klass).new
-                 end
-
-        object.attributes = params
-        options.merge! object: object
-      end
-
       def create(**options)
         options[:action] = :create
+        options = before_setup_build_object(**options)
         options = before_setup_create_object(**options)
         options = setup_create_object(**options)
-        authorize(options[:object], :create?, **options)
+        authorize(options[:object], options.fetch(:authorize) { :create? }, **options)
         options = create_hooks(**options)
-        unwrap_object(options[:object])
+        options[:object]
       end
 
       def setup_create(**options)
@@ -116,18 +106,18 @@ module SnFoil
       private
 
       def before_setup_create_object(**options)
-        options = setup_create(**options)
-        options = setup_create_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = setup_change(**options)
         options = setup_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
-        options = setup(**options)
-        setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_create(**options)
+        setup_create_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
 
       # This method is private to help protect the order of execution of hooks
       def create_hooks(options)
         options = before_create_save(**options)
-        options = if options[:object].save
+        save_successful = options[:object].save
+        options.merge!(object: unwrap_object(options[:object]))
+        options = if save_successful
                     after_create_save_success(**options)
                   else
                     after_create_save_failure(**options)
@@ -136,31 +126,31 @@ module SnFoil
       end
 
       def before_create_save(**options)
-        options = before_create(**options)
-        options = before_create_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = before_change(**options)
-        before_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = before_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = before_create(**options)
+        before_create_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
 
       def after_create_save(**options)
-        options = after_create(**options)
-        options = after_create_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = after_change(**options)
-        after_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = after_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = after_create(**options)
+        after_create_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
 
       def after_create_save_success(**options)
-        options = after_create_success(**options)
-        options = after_create_success_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = after_change_success(**options)
-        after_change_success_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = after_change_success_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = after_create_success(**options)
+        after_create_success_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
 
       def after_create_save_failure(**options)
-        options = after_create_failure(**options)
-        options = after_create_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = after_change_failure(**options)
-        after_change_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = after_change_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = after_create_failure(**options)
+        after_create_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
     end
   end

data/lib/sn_foil/contexts/destroy_context.rb

@@ -62,9 +62,9 @@ module SnFoil
         options[:action] = :destroy
         options = before_setup_destroy_object(**options)
         options = setup_destroy_object(**options)
-        authorize(options[:object], :destroy?, **options)
+        authorize(options[:object], options.fetch(:authorize) { :destroy? }, **options)
         options = destroy_hooks(**options)
-        unwrap_object(options[:object])
+        options[:object]
       end
 
       def setup_destroy(**options)
@@ -110,18 +110,20 @@ module SnFoil
       private
 
       def before_setup_destroy_object(**options)
-        options = setup_destroy(**options)
-        options = setup_destroy_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup(**options)
+        options = setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = setup_change(**options)
         options = setup_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
-        options = setup(**options)
-        setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_destroy(**options)
+        setup_destroy_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
 
       # This method is private to help protect the order of execution of hooks
       def destroy_hooks(options)
         options = before_destroy_save(options)
-        options = if options[:object].destroy
+        destroy_successful = options[:object].destroy
+        options.merge!(object: unwrap_object(options[:object]))
+        options = if destroy_successful
                     after_destroy_save_success(options)
                   else
                     after_destroy_save_failure(options)
@@ -130,31 +132,31 @@ module SnFoil
       end
 
       def before_destroy_save(options)
-        options = before_destroy(**options)
-        options = before_destroy_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = before_change(**options)
-        before_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = before_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = before_destroy(**options)
+        before_destroy_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
 
       def after_destroy_save(options)
-        options = after_destroy(**options)
-        options = after_destroy_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = after_change(**options)
-        after_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_destroy(**options)
+        after_destroy_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
 
       def after_destroy_save_success(options)
-        options = after_destroy_success(**options)
-        options = after_destroy_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = after_change_success(**options)
-        after_change_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_change_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_destroy_success(**options)
+        after_destroy_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
 
       def after_destroy_save_failure(options)
-        options = after_destroy_failure(**options)
-        options = after_destroy_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = after_change_failure(**options)
-        after_change_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_change_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_destroy_failure(**options)
+        after_destroy_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
     end
   end

data/lib/sn_foil/contexts/index_context.rb

@@ -54,10 +54,10 @@ module SnFoil
       private
 
       def before_setup_index(**options)
-        options = setup_index(**options)
-        options = setup_index_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = setup(**options)
-        setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_index(**options)
+        setup_index_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
     end
   end

data/lib/sn_foil/contexts/show_context.rb

@@ -51,10 +51,10 @@ module SnFoil
       private
 
       def before_setup_show(**options)
-        options = setup_show(**options)
-        options = setup_show_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = setup(**options)
-        setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_show(**options)
+        setup_show_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
     end
   end

data/lib/sn_foil/contexts/update_context.rb

@@ -56,7 +56,8 @@ module SnFoil
         raise ArgumentError, 'one of the following keywords is required: id, object' unless id || object
 
         object = wrap_object(object || scope.resolve.find(id))
-        authorize(object, :update?, **options)
+        authorize(object, options.fetch(:authorize) { :update? }, **options)
+
         object.attributes = params
         options.merge! object: object
       end
@@ -65,9 +66,9 @@ module SnFoil
         options[:action] = :update
         options = before_setup_update_object(**options)
         options = setup_update_object(**options)
-        authorize(options[:object], :update?, **options)
+        authorize(options[:object], options.fetch(:authorize) { :update? }, **options)
         options = update_hooks(**options)
-        unwrap_object(options[:object])
+        options[:object]
       end
 
       def setup_update(**options)
@@ -113,18 +114,20 @@ module SnFoil
       private
 
       def before_setup_update_object(**options)
-        options = setup_update(**options)
-        options = setup_update_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup(**options)
+        options = setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
         options = setup_change(**options)
         options = setup_change_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
-        options = setup(**options)
-        setup_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
+        options = setup_update(**options)
+        setup_update_hooks.reduce(options) { |opts, hook| run_hook(hook, opts) }
       end
 
       # This method is private to help protect the order of execution of hooks
       def update_hooks(options)
         options = before_update_save(options)
-        options = if options[:object].save
+        update_successful = options[:object].save
+        options.merge!(object: unwrap_object(options[:object]))
+        options = if update_successful
                     after_update_save_success(options)
                   else
                     after_update_save_failure(options)
@@ -133,31 +136,31 @@ module SnFoil
       end
 
       def before_update_save(options)
-        options = before_update(**options)
-        options = before_update_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = before_change(**options)
-        before_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = before_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = before_update(**options)
+        before_update_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
 
       def after_update_save(options)
-        options = after_update(**options)
-        options = after_update_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = after_change(**options)
-        after_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_change_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_update(**options)
+        after_update_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
 
       def after_update_save_success(options)
-        options = after_update_success(**options)
-        options = after_update_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = after_change_success(**options)
-        after_change_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_change_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_update_success(**options)
+        after_update_success_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
 
       def after_update_save_failure(options)
-        options = after_update_failure(**options)
-        options = after_update_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
         options = after_change_failure(**options)
-        after_change_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_change_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
+        options = after_update_failure(**options)
+        after_update_failure_hooks.reduce(options) { |opts, hook| run_hook(hook, **opts) }
       end
     end
   end

data/lib/sn_foil/searcher.rb

@@ -7,7 +7,7 @@ module SnFoil
     extend ActiveSupport::Concern
 
     class_methods do
-      attr_reader :i_model, :i_setup, :i_filters, :i_search_step
+      attr_reader :i_model, :i_setup, :i_filters, :i_search_step, :i_booleans
 
       def model(klass = nil)
         @i_model = klass
@@ -27,6 +27,11 @@ module SnFoil
           unless: options[:unless]
         }
       end
+
+      def booleans(*fields)
+        @i_booleans ||= []
+        @i_booleans |= fields.map(&:to_sym)
+      end
     end
 
     def model
@@ -55,6 +60,10 @@ module SnFoil
       self.class.i_filters || []
     end
 
+    def booleans
+      self.class.i_booleans || []
+    end
+
     private
 
     def apply_setup(filtered_scope, params)
@@ -90,15 +99,24 @@ module SnFoil
 
     def transform_params_booleans(params)
       params.map do |key, value|
-        value = if value == 'true'
-                  true
-                elsif value == 'false'
-                  false
+        value = if booleans.include?(key.to_sym)
+                  value_to_boolean(value)
                 else
                   value
                 end
         [key, value]
       end.to_h
     end
+
+    def value_to_boolean(value)
+      string_val = value.to_s
+      if value == true || %w[true 1].include?(string_val)
+        true
+      elsif value == false || %w[false 0].include?(string_val)
+        false
+      else
+        value
+      end
+    end
   end
 end

data/lib/sn_foil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SnFoil
-  VERSION = '0.5.3'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snfoil
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Matthew Howes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,6 +162,7 @@ files:
 - CODE_OF_CONDUCT.md
 - README.md
 - Rakefile
+- TODO.md
 - lib/sn_foil.rb
 - lib/sn_foil/adapters/orms/active_record.rb
 - lib/sn_foil/adapters/orms/base_adapter.rb
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A boilerplate gem for providing basic contexts