snfoil 0.9.1 → 1.0.0

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: snfoil
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Howes
 - Danny Murphy
 - Cliff Campbell
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,6 +54,175 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: snfoil-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: snfoil-policy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: snfoil-searcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: A collection of SnFoil gems and additional helper classes
 email:
 - howeszy@gmail.com
 - dmurph24@gmail.com
@@ -61,30 +231,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
 - 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
-- lib/sn_foil/context.rb
-- lib/sn_foil/contexts/build_context.rb
-- lib/sn_foil/contexts/change_context.rb
-- lib/sn_foil/contexts/create_context.rb
-- lib/sn_foil/contexts/destroy_context.rb
-- lib/sn_foil/contexts/index_context.rb
-- lib/sn_foil/contexts/setup_context.rb
-- lib/sn_foil/contexts/show_context.rb
-- lib/sn_foil/contexts/update_context.rb
-- lib/sn_foil/policy.rb
-- lib/sn_foil/searcher.rb
-- lib/sn_foil/version.rb
+- docs/build-context.md
+- docs/create-context.md
+- docs/destroy-context.md
+- docs/index-context.md
+- docs/show-context.md
+- docs/update-context.md
+- lib/snfoil.rb
+- lib/snfoil/adapters/orms/active_record.rb
+- lib/snfoil/adapters/orms/base_adapter.rb
+- lib/snfoil/crud/build_context.rb
+- lib/snfoil/crud/change_context.rb
+- lib/snfoil/crud/context.rb
+- lib/snfoil/crud/create_context.rb
+- lib/snfoil/crud/destroy_context.rb
+- lib/snfoil/crud/index_context.rb
+- lib/snfoil/crud/setup_context.rb
+- lib/snfoil/crud/show_context.rb
+- lib/snfoil/crud/update_context.rb
+- lib/snfoil/version.rb
+- snfoil.gemspec
 homepage: https://github.com/limited-effort/snfoil
 licenses:
-- MIT
+- Apache-2.0
 metadata:
+  homepage_uri: https://github.com/limited-effort/snfoil
+  source_code_uri: https://github.com/limited-effort/snfoil
+  changelog_uri: https://github.com/limited-effort/snfoil/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,14 +273,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: A boilerplate gem for providing basic contexts
+summary: A Toolbox of Context Behaviors
 test_files: []

data/Rakefile

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-task default: :spec

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

@@ -1,32 +0,0 @@
-# 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))
-        end
-
-        def all
-          __getobj__.all
-        end
-
-        def save
-          __getobj__.save
-        end
-
-        def destroy # rubocop:disable Naming/PredicateMethod -- reason: This is a method that calls the underlying ActiveRecord method
-          __getobj__.destroy
-          __getobj__.destroyed?
-        end
-
-        def attributes=(attributes)
-          __getobj__.attributes = attributes
-        end
-      end
-    end
-  end
-end

data/lib/sn_foil/context.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-require_relative 'contexts/build_context'
-require_relative 'contexts/index_context'
-require_relative 'contexts/show_context'
-require_relative 'contexts/create_context'
-require_relative 'contexts/update_context'
-require_relative 'contexts/destroy_context'
-
-module SnFoil
-  module Context
-    extend ActiveSupport::Concern
-
-    included do
-      include Contexts::BuildContext
-      include Contexts::IndexContext
-      include Contexts::ShowContext
-      include Contexts::CreateContext
-      include Contexts::UpdateContext
-      include Contexts::DestroyContext
-    end
-  end
-end

data/lib/sn_foil/contexts/build_context.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-require_relative 'setup_context'
-
-module SnFoil
-  module Contexts
-    module BuildContext
-      extend ActiveSupport::Concern
-
-      included do
-        include SetupContext
-      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)
-        object = if object
-                   wrap_object(object)
-                 else
-                   klass = options.fetch(:model) { model }
-                   wrap_object(klass).new
-                 end
-
-        object.attributes = params
-        options[:object] = object
-        options
-      end
-
-      def build(**options)
-        options[:action] = :build
-        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/change_context.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-require_relative 'setup_context'
-
-module SnFoil
-  module Contexts
-    module ChangeContext
-      extend ActiveSupport::Concern
-
-      included do
-        include SetupContext
-      end
-
-      class_methods do # rubocop:disable Metrics/BlockLength
-        attr_reader :i_params, :i_setup_change_hooks, :i_before_change_hooks, :i_after_change_hooks,
-                    :i_after_change_success_hooks, :i_after_change_failure_hooks
-
-        def params(*permitted_params)
-          @i_params ||= []
-          @i_params |= permitted_params
-        end
-
-        def setup_change(method = nil, **options, &block)
-          raise ArgumentError, '#setup_change requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_setup_change_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def before_change(method = nil, **options, &block)
-          raise ArgumentError, '#before_change requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_before_change_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def after_change(method = nil, **options, &block)
-          raise ArgumentError, '#after_change requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_after_change_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def after_change_success(method = nil, **options, &block)
-          raise ArgumentError, '#after_change_success requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_after_change_success_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def after_change_failure(method = nil, **options, &block)
-          raise ArgumentError, '#after_change_failure requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_after_change_failure_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-      end
-
-      def param_names
-        @param_names ||= self.class.i_params
-      end
-
-      def setup_change(**options)
-        options[:params] = options[:params].select { |params| param_names.include?(params) } if param_names
-        options
-      end
-
-      def before_change(**options)
-        options
-      end
-
-      def after_change(**options)
-        options
-      end
-
-      def after_change_success(**options)
-        options
-      end
-
-      def after_change_failure(**options)
-        options
-      end
-
-      def setup_change_hooks
-        self.class.i_setup_change_hooks || []
-      end
-
-      def before_change_hooks
-        self.class.i_before_change_hooks || []
-      end
-
-      def after_change_hooks
-        self.class.i_after_change_hooks || []
-      end
-
-      def after_change_success_hooks
-        self.class.i_after_change_success_hooks || []
-      end
-
-      def after_change_failure_hooks
-        self.class.i_after_change_failure_hooks || []
-      end
-    end
-  end
-end

data/lib/sn_foil/contexts/create_context.rb

@@ -1,158 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/concern'
-require_relative 'change_context'
-
-module SnFoil
-  module Contexts
-    module CreateContext # rubocop:disable Metrics/ModuleLength
-      extend ActiveSupport::Concern
-
-      included do
-        include BuildContext
-        include ChangeContext
-
-        alias_method :setup_create_object, :setup_build_object
-      end
-
-      class_methods do
-        attr_reader :i_setup_create_hooks, :i_before_create_hooks, :i_after_create_hooks,
-                    :i_after_create_success_hooks, :i_after_create_failure_hooks
-
-        def create(params:, entity: nil, **options)
-          new(entity).create(**options, params: params)
-        end
-
-        def setup_create(method = nil, **options, &block)
-          raise ArgumentError, '#setup_create requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_setup_create_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def before_create(method = nil, **options, &block)
-          raise ArgumentError, '#before_create requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_before_create_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def after_create(method = nil, **options, &block)
-          raise ArgumentError, '#after_create requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_after_create_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def after_create_success(method = nil, **options, &block)
-          raise ArgumentError, '#after_create_success requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_after_create_success_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-
-        def after_create_failure(method = nil, **options, &block)
-          raise ArgumentError, '#after_create_failure requires either a method name or a block' if method.nil? && block.nil?
-
-          (@i_after_create_failure_hooks ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
-        end
-      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], options.fetch(:authorize, :create?), **options)
-        options = create_hooks(**options)
-        options[:object]
-      end
-
-      def setup_create(**options)
-        options
-      end
-
-      def before_create(**options)
-        options
-      end
-
-      def after_create(**options)
-        options
-      end
-
-      def after_create_success(**options)
-        options
-      end
-
-      def after_create_failure(**options)
-        options
-      end
-
-      def setup_create_hooks
-        self.class.i_setup_create_hooks || []
-      end
-
-      def before_create_hooks
-        self.class.i_before_create_hooks || []
-      end
-
-      def after_create_hooks
-        self.class.i_after_create_hooks || []
-      end
-
-      def after_create_success_hooks
-        self.class.i_after_create_success_hooks || []
-      end
-
-      def after_create_failure_hooks
-        self.class.i_after_create_failure_hooks || []
-      end
-
-      private
-
-      def before_setup_create_object(**options)
-        options = setup_change(**options)
-        options = setup_change_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)
-        save_successful = options[:object].save
-        options[:object] = unwrap_object(options[:object])
-        options = if save_successful
-                    after_create_save_success(**options)
-                  else
-                    after_create_save_failure(**options)
-                  end
-        after_create_save(**options)
-      end
-
-      def before_create_save(**options)
-        options = before_change(**options)
-        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_change(**options)
-        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_change_success(**options)
-        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_change_failure(**options)
-        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
-end