snfoil 0.5.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 272fc63879df9b9d3e112dcc8e73638a85a1a75f2faab91530e20fb888cf6c80
+  data.tar.gz: 6e5994391f96c17b4016f55e2c52c1cb1fff935c6dfdb05d20572e0232bdbd6b
+SHA512:
+  metadata.gz: 90fc1492c594aabe7dc780fc341c3e3fb3d12a7c264b6e85fb08c3bfebd45a69d2cd87a0903e02c979e43c6909f7e5a9c32c39d8cc5f66edf2af541b2182dba6
+  data.tar.gz: 1f08ef48c2509a37f25016d9d5ca2e2e0b34bd828180d16e46f42715820690a0ee950e55c869079209f2fe604ab8f6671ddccb7fd1a8cc8592d330bbf0b33bda

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at howeszy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -0,0 +1,43 @@
+# Sn::Foil
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sn_foil`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snfoil'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snfoil
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snfoil. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sn::Foil project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/snfoil/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/sn_foil.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'sn_foil/version'
+require_relative 'sn_foil/contexts/build_context'
+require_relative 'sn_foil/contexts/index_context'
+require_relative 'sn_foil/contexts/show_context'
+require_relative 'sn_foil/contexts/create_context'
+require_relative 'sn_foil/contexts/update_context'
+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'
+
+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/lib/sn_foil/adapters/orms/active_record.rb

@@ -0,0 +1,36 @@
+# 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
+          __getobj__.destroy
+          __getobj__.destroyed?
+        end
+
+        def attributes=(attributes)
+          __getobj__.attributes = attributes
+        end
+
+        def is_a?(klass)
+          __getobj__.class.object_id == klass.object_id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SnFoil
+  module Adapters
+    module ORMs
+      class BaseAdapter < SimpleDelegator
+        def new(**_params)
+          raise NotImplementedError, '#new not implemented in adapter'
+        end
+
+        def all
+          raise NotImplementedError, '#all not implemented in adapter'
+        end
+
+        def save
+          raise NotImplementedError, '#save not implemented in adapter'
+        end
+
+        def destroy
+          raise NotImplementedError, '#destroy not implemented in adapter'
+        end
+
+        def attributes=(_attributes)
+          raise NotImplementedError, '#attributes= not implemented in adapter'
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/context.rb

@@ -0,0 +1,24 @@
+# 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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative './setup_context'
+require_relative './change_context'
+
+module SnFoil
+  module Contexts
+    module BuildContext
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContext
+        include ChangeContext
+      end
+
+      class_methods do
+        def build(params:, entity: nil, **options)
+          new(entity).build(**options, params: params)
+        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
+
+        klass = options.fetch(:model) { model }
+        options.merge! object: wrap_object(klass).new(**params)
+      end
+
+      def build(**options)
+        options[:action] = :build
+        options = setup_build(setup_change(**options))
+        options = setup_build_object(**options)
+        unwrap_object(options[:object])
+      end
+
+      def setup_build(**options)
+        options
+      end
+    end
+  end
+end

data/lib/sn_foil/contexts/change_context.rb

@@ -0,0 +1,100 @@
+# 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(*whitelisted_params)
+          @i_params ||= []
+          @i_params |= whitelisted_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

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative './setup_context'
+require_relative './change_context'
+
+module SnFoil
+  module Contexts
+    module CreateContext # rubocop:disable Metrics/ModuleLength
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContext
+        include ChangeContext
+      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 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_create_object(**options)
+        options = setup_create_object(**options)
+        authorize(options[:object], :create?, **options)
+        options = create_hooks(**options)
+        unwrap_object(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_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) }
+      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
+                    after_create_save_success(**options)
+                  else
+                    after_create_save_failure(**options)
+                  end
+        after_create_save(**options)
+      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) }
+      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) }
+      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) }
+      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) }
+      end
+    end
+  end
+end