snfoil 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa83f45d1f03f617f38920f9b8d5f58f91e3f09f086b1ce0cd5ee9885149b0c4
+  data.tar.gz: b66ceb4525d2d784057499975da6d63d01e0560f778f64ca91650fc51083899d
+SHA512:
+  metadata.gz: 352fe39c6ebcb7abbe6119dddd3f0ad5b8cd3a0c21ea407fafc8791c57b0494ebc07130698eb9a90caff5129933b9ad2e746644d82fd27b713b0dd32c224ae9e
+  data.tar.gz: ee2073826354fa610f4a97a0347ca68f252b0a91cf4fde06a3797da2c6efb4ec47e9ac31f474f3676630ef78e2d7c1f46abcaaf3c6c6572942f130ac19320add

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require:
+  - rubocop-rspec
+
+# ================ Style ===============
+# TODO: Activate later
+Style/Documentation:
+  Enabled: false
+
+# ================ LINT ================
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# ================ Metics ================
+Metrics/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# ================ RSPEC ================
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+Rspec/NestedGroups:
+  Max: 5

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

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/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in snfoil.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    snfoil (0.1.0)
+      activesupport (>= 5.1)
+      logger (~> 1.0)
+      pundit (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (1.1.1)
+      dry-core (~> 0.4, >= 0.4.3)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 1.0)
+      ice_nine (~> 0.11)
+    dry-types (1.2.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.4)
+    logger (1.4.2)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    parallel (1.19.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    pundit (2.1.0)
+      activesupport (>= 3.0.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  dry-struct (~> 1.0)
+  pry-byebug (~> 3.0)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 0.76.0)
+  rubocop-rspec (~> 1.36.0)
+  snfoil!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Matthew Howes
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sn_foil'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+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
+      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_concern'
+require_relative 'contexts/index_context_concern'
+require_relative 'contexts/show_context_concern'
+require_relative 'contexts/create_context_concern'
+require_relative 'contexts/update_context_concern'
+require_relative 'contexts/destroy_context_concern'
+
+module SnFoil
+  module Context
+    extend ActiveSupport::Concern
+
+    included do
+      include Contexts::BuildContextConcern
+      include Contexts::IndexContextConcern
+      include Contexts::ShowContextConcern
+      include Contexts::CreateContextConcern
+      include Contexts::UpdateContextConcern
+      include Contexts::DestroyContextConcern
+    end
+  end
+end

data/lib/sn_foil/contexts/build_context_concern.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative './setup_context_concern'
+require_relative './change_context_concern'
+
+module SnFoil
+  module Contexts
+    module BuildContextConcern
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContextConcern
+        include ChangeContextConcern
+      end
+
+      class_methods do
+        def build(params:, user: nil, **options)
+          new(user).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_concern.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative './setup_context_concern'
+
+module SnFoil
+  module Contexts
+    module ChangeContextConcern
+      extend ActiveSupport::Concern
+
+      included do
+        include SetupContextConcern
+      end
+
+      class_methods do
+        attr_reader :i_params, :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 before_change(method = nil, **options, &block)
+          raise ArgumentError, '#on_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 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
+
+      def run_hook(hook, **options)
+        return options unless hook_valid?(hook, **options)
+
+        return send(hook[:method], **options) if hook[:method]
+
+        hook[:block].call(options)
+      end
+
+      def hook_valid?(hook, **options)
+        return false if !hook[:if].nil? && hook[:if].call(options) == false
+        return false if !hook[:unless].nil? && hook[:unless].call(options) == true
+
+        true
+      end
+    end
+  end
+end