snfoil 0.9.0 → 1.0.0

data/lib/snfoil/crud/create_context.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+require_relative './change_context'
+
+module SnFoil
+  module CRUD
+    module CreateContext
+      extend ActiveSupport::Concern
+
+      included do
+        include BuildContext
+        include ChangeContext
+
+        action :create, with: :create_action
+
+        setup_create { |options| run_interval(:setup, **options) }
+        setup_create { |options| run_interval(:setup_build, **options) }
+        setup_create { |options| run_interval(:setup_change, **options) }
+        before_create { |options| run_interval(:before_change, **options) }
+        after_create_success { |options| run_interval(:after_change_success, **options) }
+        after_create_failure { |options| run_interval(:after_change_failure, **options) }
+        after_create { |options| run_interval(:after_change, **options) }
+
+        def create_action(options)
+          wrap_object(options[:object]).save
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/crud/destroy_context.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+require_relative './setup_context'
+require_relative './change_context'
+
+module SnFoil
+  module CRUD
+    module DestroyContext
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContext
+        include ChangeContext
+
+        action :destroy, with: :destroy_action
+
+        setup_destroy { |options| run_interval(:setup, **options) }
+        setup_destroy { |options| run_interval(:setup_change, **options) }
+        before_destroy { |options| run_interval(:before_change, **options) }
+        after_destroy_success { |options| run_interval(:after_change_success, **options) }
+        after_destroy_failure { |options| run_interval(:after_change_failure, **options) }
+        after_destroy { |options| run_interval(:after_change, **options) }
+
+        setup_destroy do |options|
+          raise ArgumentError, 'one of the following keywords is required: id, object' unless options[:id] || options[:object]
+
+          options
+        end
+
+        before_destroy do |options|
+          options[:object] ||= scope.resolve.find(options[:id])
+
+          options
+        end
+
+        def destroy_action(options)
+          wrap_object(options[:object]).destroy
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/crud/index_context.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+require_relative './change_context'
+
+module SnFoil
+  module CRUD
+    module IndexContext
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContext
+
+        action :index, with: :index_action
+
+        setup_index { |options| run_interval(:setup, **options) }
+
+        before_index do |options|
+          options[:object] ||= options.fetch(:searcher) { self.class.snfoil_searcher }
+                                      .new(scope: scope.resolve)
+                                      .search(options.fetch(:params) { {} })
+
+          options
+        end
+
+        def index_action(**options)
+          options[:object]
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/crud/setup_context.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'snfoil/context'
+
+require 'active_support/concern'
+require 'active_support/core_ext/string/inflections'
+
+module SnFoil
+  module CRUD
+    module SetupContext
+      extend ActiveSupport::Concern
+
+      included do
+        include SnFoil::Context
+
+        interval :setup
+
+        authorize do |options|
+          options.fetch(:policy) { policy }
+                 .new(entity, options[:object], **options)
+                 .send(options.fetch(:authorize) { "#{options[:action]}?" })
+        end
+      end
+
+      class_methods do
+        attr_reader :snfoil_model, :snfoil_policy, :snfoil_searcher
+
+        def searcher(klass = nil)
+          @snfoil_searcher = klass
+        end
+
+        def model(klass = nil)
+          @snfoil_model = klass
+        end
+
+        def policy(klass = nil)
+          @snfoil_policy = klass
+        end
+      end
+
+      def model
+        self.class.snfoil_model
+      end
+
+      def policy
+        self.class.snfoil_policy
+      end
+
+      def scope(_object_class = nil, **options)
+        "#{policy.name}::Scope".safe_constantize.new(wrap_object(model), entity, **options)
+      end
+
+      def wrap_object(object)
+        return object unless adapter
+
+        adapter.new(object)
+      end
+
+      def unwrap_object(object)
+        return object unless adapter
+
+        adapter?(object) ? object.__getobj__ : object
+      end
+
+      def adapter?(object)
+        return false unless adapter
+
+        object.instance_of? adapter
+      end
+
+      def adapter
+        @adapter ||= SnFoil.adapter
+      end
+    end
+  end
+end

data/lib/snfoil/crud/show_context.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+require_relative './setup_context'
+
+module SnFoil
+  module CRUD
+    module ShowContext
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContext
+
+        action :show, with: :show_action
+
+        setup_show do |options|
+          raise ArgumentError, 'one of the following keywords is required: id, object' unless options[:id] || options[:object]
+
+          options
+        end
+
+        setup_show do |options|
+          run_interval(:setup, **options)
+        end
+
+        before_show do |**options|
+          options[:object] ||= scope.resolve.find(options[:id])
+
+          options
+        end
+
+        def show_action(options)
+          options[:object]
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/crud/update_context.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/concern'
+require_relative './setup_context'
+require_relative './change_context'
+
+module SnFoil
+  module CRUD
+    module UpdateContext
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContext
+        include ChangeContext
+
+        action :update, with: :update_action
+
+        setup_update { |options| run_interval(:setup, **options) }
+        setup_update { |options| run_interval(:setup_change, **options) }
+        before_update { |options| run_interval(:before_change, **options) }
+        after_update_success { |options| run_interval(:after_change_success, **options) }
+        after_update_failure { |options| run_interval(:after_change_failure, **options) }
+        after_update { |options| run_interval(:after_change, **options) }
+
+        setup_update do |options|
+          raise ArgumentError, 'one of the following keywords is required: id, object' unless options[:id] || options[:object]
+
+          options
+        end
+
+        before_update do |options|
+          params = options.fetch(:params) { {} }
+          options[:object] ||= scope.resolve.find(options[:id])
+
+          wrap_object(options[:object]).attributes = params
+
+          options
+        end
+
+        def update_action(options)
+          wrap_object(options[:object]).save
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/version.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  VERSION = '1.0.0'
+end

data/lib/snfoil.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'logger'
+require 'snfoil/context'
+require 'snfoil/policy'
+require 'snfoil/searcher'
+
+require_relative 'snfoil/version'
+
+require_relative 'snfoil/crud/build_context'
+require_relative 'snfoil/crud/change_context'
+require_relative 'snfoil/crud/create_context'
+require_relative 'snfoil/crud/destroy_context'
+require_relative 'snfoil/crud/index_context'
+require_relative 'snfoil/crud/setup_context'
+require_relative 'snfoil/crud/show_context'
+require_relative 'snfoil/crud/update_context'
+require_relative 'snfoil/crud/context'
+
+require_relative 'snfoil/adapters/orms/base_adapter'
+require_relative 'snfoil/adapters/orms/active_record'
+
+module SnFoil
+  class Error < StandardError; end
+
+  mattr_accessor :orm, default: 'active_record'
+  mattr_writer :logger
+
+  class << self
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = name
+      end
+    end
+
+    def adapter
+      return @adapter if @adapter
+
+      @adapter ||= if orm.instance_of?(String) || orm.instance_of?(Symbol)
+                     if Object.const_defined?("SnFoil::Adapters::ORMs::#{orm.camelcase}")
+                       "SnFoil::Adapters::ORMs::#{orm.camelcase}".constantize
+                     else
+                       orm.constantize
+                     end
+                   else
+                     orm
+                   end
+    end
+
+    def configure
+      yield self
+    end
+  end
+end

data/snfoil.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'lib/snfoil/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snfoil'
+  spec.version       = SnFoil::VERSION
+  spec.authors     = ['Matthew Howes', 'Danny Murphy', 'Cliff Campbell']
+  spec.email       = ['howeszy@gmail.com', 'dmurph24@gmail.com', 'cliffcampbell@hey.com']
+
+  spec.summary       = 'A Toolbox of Context Behaviors'
+  spec.description   = 'A collection of SnFoil gems and additional helper classes'
+  spec.homepage      = 'https://github.com/limited-effort/snfoil'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/limited-effort/snfoil/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_list = %r{\A(?:test/|spec/|bin/|features/|Rakefile|\.\w)}
+  spec.files = Dir.chdir(File.expand_path(__dir__)) { `git ls-files -z`.split("\x0").reject { |f| f.match(ignore_list) } }
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 5.2.6'
+  spec.add_dependency 'logger', '~> 1.0'
+  spec.add_dependency 'pundit', '~> 2.0'
+  spec.add_dependency 'snfoil-context', '~> 1.0'
+  spec.add_dependency 'snfoil-policy', '~> 1.0'
+  spec.add_dependency 'snfoil-searcher', '~> 1.0'
+
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  spec.add_development_dependency 'dry-struct', '~> 1.0'
+  spec.add_development_dependency 'fasterer', '~> 0.10.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 1.29'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.4'
+end