snfoil-context 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 96734bc3c562904649028a48af86b3bfce1c6afd8273bdf5112dd5e5d608013c
+  data.tar.gz: c380bc1234066ff9d29d6f969214b9d72a57f713ff98a11d64cf969e5310ee02
+SHA512:
+  metadata.gz: e6c4262868a512ea479115a6dc709425d7e264b9fbebaabab3134e299ced2e7b089833573d109627e670cffe2edd17cc92ffb9ff19e00f4341bf902b9cdb69e5
+  data.tar.gz: f9eb6db011db1d21437e95c6881a89b9e361310a16952cccf7a57b58ed6342533643622b6379a2eae1cc8a5ab2413a6e69228308cde9b0e58a6ef98da0cd2710

data/.github/workflows/main.yml

@@ -0,0 +1,46 @@
+name: build
+on: 
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6, 2.5]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1.81.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec
+  lint:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.7, 2.6, 2.5, '3.0']
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1.81.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run rubocop
+        run: bundle exec rubocop
+

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# GEMFILE
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.5.0
+
+# ================ LAYOUT ==============
+Layout/LineLength:
+  Max: 150
+
+# ================ LINT ================
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Lint/EmptyClass:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# ================ Metics ================
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# ================ RSPEC ================
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at howeszy@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+https://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "{}"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright {yyyy} {name of copyright owner}
+
+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
+
+https://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.

data/README.md

@@ -0,0 +1,274 @@
+# SnFoil::Context
+
+![build](https://github.com/limited-effort/snfoil-context/actions/workflows/main.yml/badge.svg) [![maintainability](https://api.codeclimate.com/v1/badges/6a7a2f643707c17cb879/maintainability)](https://codeclimate.com/github/limited-effort/snfoil-context/maintainability)
+
+SnFoil Contexts are a simple way to insure a workflow pipeline can be easily established end extended.  It helps by creating workflow, allowing additional in steps at specific intervals, and reacting to a success or failure, you should find your code being more maintainable and testable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snfoil-context'
+```
+
+## Usage
+While contexts are powerful, they aren't a magic bullet.  Each function should strive to only contain a single purpose.  This also has the added benefit of outlining some basic tests - if it is in a function it should have a related test.
+
+### Action
+To start you will need to define an action.  
+
+Arguments:
+* `name` - The name of this action will also set the name of all the hooks and methods later generated.
+* `with` - Keyword Param - The method name of the primary action.  Either this or a block is required
+* `block` - Block -  The block of the primary action.  Either this or with is required
+
+```ruby
+# lib/contexts/token_context
+require 'snfoil/context'
+
+class TokenContext
+  include SnFoil::Context
+
+  action :expire { |options| options[:object].update(expired_at: Time.current) }
+end
+```
+
+This will generate the methods and hooks of the pipeline.  In this example the following get made:
+* setup_expire
+* before_expire
+* after_expire_success
+* after_expire_failure
+* after_expire
+
+If you want to reuse the primary action or just prefer methods, you can pass in the method name you would like to call, rather than providing a block.  If a method name and a block is provided, the block is ignored. 
+
+
+```ruby
+# lib/contexts/token_context
+require 'snfoil/context'
+
+class TokenContext
+  include SnFoil::Context
+
+  action :expire, with: :expire_token
+
+  def expire_token(options)
+    options[:object].update(expired_at: Time.current)
+  end
+end
+```
+
+#### Primary Actions
+The primary action is the function that determine whether or not the action is successful.  To do this, the primary action must always return a truthy value if the action was successful, or a falsey one if it failed.
+
+The primary action is passed one argument which is the return value of the closest preceeding interval function.
+
+```ruby
+# lib/contexts/token_context
+require 'snfoil/context'
+
+class TokenContext
+  include SnFoil::Context
+
+  action :expire, with: :expire_token
+
+  before_expire do |options|
+    options[:foo] = bar
+    options
+  end
+
+  def expire_token(options)
+    puts options[:foo] # => logs 'bar' to the console
+    ...
+  end
+end
+```
+
+#### Intervals
+The following are the intervals SnFoil Contexts sets up in the order they occur.  The suggested uses are just very simply examples.  You can chain contexts to setup very complex interactions in a very easy to manage workflow.
+
+<table>
+    <thead>
+        <th>Name</th>
+        <th>Suggested Use</th>
+    </thead>
+    <tbody>
+        <tr>
+            <td>setup_&lt;action&gt;</td>
+            <td>
+              <div>* find or create a model</div>
+              <div>* setup params needed later in the action</div>
+              <div>* set scoping </div>
+            </td>
+        </tr>
+        <tr>
+            <td>before_&lt;action&gt;</td>
+            <td>
+                <div>* alter model or set attributes</div>
+            </td>
+        </tr>
+        <tr>
+            <td>primary action</td>
+            <td>
+                <div>* persist database changes</div>
+                <div>* make primary network call</div>
+            </td>
+        </tr>
+        <tr>
+            <td>after_&lt;action&gt;_success</td>
+            <td>
+              <div>* setup additional relationships</div>
+              <div>* success specific logging</div>
+            </td>
+        </tr>
+        <tr>
+            <td>after_&lt;action&gt;_failure</td>
+            <td>
+              <div>* cleanup failed remenants</div>
+              <div>* call bug tracker</div>
+              <div>* failure specific logging</div>
+            </td>
+        </tr>
+        <tr>
+            <td>after_&lt;action&gt;</td>
+            <td>
+              <div>* perform necessary required cleanup</div>
+              <div>* log outcome</div>
+            </td>
+        </tr>
+    </tbody>
+<table>
+
+
+#### Hook and Method Design
+
+SnFoil Contexts try hard to not store variables longer than necessary.  To facilitate this we have choosen to pass an object (we normally use a hash called options) to each hook and method, and the return from the hook or method is passed down the chain to the next hook or method.  
+
+The only method or block that does not get its value passwed down the chain is the primary action - which must always return a truthy value of whether or not the action was successful.
+
+#### Hooks
+Hooks make it very easy to compose multiple actions that need to occur in a specific order.  You can have as many repeated hooks as you would like.  This makes defining single responsibility hooks very simple, and they will get called in the order they are defined.
+
+<strong>Important Note</strong> Hooks <u>always</u> need to return the options hash at the end.
+
+##### Example
+```ruby
+# Call the webhooks for third party integrations
+after_expire_success do |options|
+    call_webhook_for_model(options[:object])
+    options
+end
+
+# Commit business logic to internal process
+after_expire_success do |options|
+    finalize_business_logic(options[:object])
+    options
+end
+
+# notify error tracker
+after_expire_error do |options|
+    notify_errors(options[:object].errors)
+    options
+end
+```
+
+#### Methods
+Methods allow users to create inheritable actions that occur in a specific order.  Methods will always run after their hook counterpart.  Since these are inheritable, you can chain needed actions all the way through the parent heirarchy by using the `super` keyword. 
+
+<strong>Important Note</strong> Methods <u>always</u> need to return the options hash at the end.
+
+<i>Author's opinion:</i> While simplier than hooks, they do not allow for as clean of a composition as hooks.
+
+##### Example
+
+```ruby
+# Call the webhooks for third party integrations
+# Commit business logic to internal process
+def after_expire_success(**options)
+    options = super
+
+    call_webhook_for_model(options[:object])
+    finalize_business_logic(options[:object])
+
+    options
+end
+
+# notify error tracker
+def after_expire_error(**options)
+    options = super
+
+    notify_errors(options[:object].errors)
+
+    options
+end
+```
+
+### Authorize
+The original purpose of all of SnFoil was to ensure there was a good consistent way to authenticate and authorize entities.  As such authorize hooks were built directly into the workflow.
+
+These authorization hooks are always called twice.  Once after `setup_<action>` and once after `before_<action>`
+
+The `authorize` method functions much like primary action except the first argument is usually the name of action you are authorizing.
+
+Arguments:
+* `name` - The name of this action to be authorized.  If ommited, all actions without a specific associated authorize will use this one..
+* `with` - Keyword Param - The method name of the primary action.  Either this or a block is required
+* `block` - Block -  The block of the primary action.  Either this or with is required
+
+```ruby
+# lib/contexts/token_context
+require 'snfoil/context'
+
+class TokenContext
+  include SnFoil::Context
+
+  action :expire, with: :expire_token
+
+  authorize :expire { |options| options[:entity].is_admin? }
+
+  ...
+end
+```
+
+You can also call authorize without an action name.  This will have all action authorize with the provided method or block unless there is a more specific authorize action configured.  Its probably easier explained with an example
+
+
+```ruby
+# lib/contexts/token_context
+require 'snfoil/context'
+
+class TokenContext
+  include SnFoil::Context
+
+  action :expire, with: :expire_token #=> will authorize by checking the entity is an admin
+  action :search, with: :query_tokens #=> will authorize by checking the entity is a user
+  action :show, with: :find_token #=> will authorize by checking the entity is a user
+
+  authorize :expire { |options| options[:entity].is_admin? }
+  authorize { |options| options[:entity].is_user? }
+
+  ...
+end
+```
+
+#### Why before and after?
+Simply to make sure the entity it actually allowed access the primary target and is allowed to make the requested alterations/interactions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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/limited-effort/snfoil-context. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/limited-effort/snfoil-context/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2 License](https://opensource.org/licenses/Apache-2.0).
+
+## Code of Conduct
+
+Everyone interacting in the Snfoil::Context project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/limited-effort/snfoil-context/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'snfoil/policy'
+
+# 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/snfoil/context/argument_error.rb

@@ -0,0 +1,21 @@
+# 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
+  module Context
+    class ArgumentError < ::ArgumentError; end
+  end
+end

data/lib/snfoil/context/error.rb

@@ -0,0 +1,21 @@
+# 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
+  module Context
+    class Error < RuntimeError; end
+  end
+end

data/lib/snfoil/context/structure.rb

@@ -0,0 +1,79 @@
+# 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_relative './error'
+require 'active_support/concern'
+
+module SnFoil
+  module Context
+    # Basic structure needed to support a SnFoil context
+    #
+    # @author Matthew Howes
+    #
+    # @since 0.1.0
+    module Structure
+      extend ActiveSupport::Concern
+
+      class_methods do
+        attr_reader :i_authorizations
+
+        def authorize(action_name = nil, with: nil, &block)
+          @i_authorizations ||= {}
+          action_name = action_name&.to_sym
+
+          raise SnFoil::Context::Error, "#{name} already has authorize defined for #{action_name || ':default'}" if @i_authorizations[action_name]
+
+          @i_authorizations[action_name] = { method: with, block: block }
+        end
+      end
+
+      attr_reader :entity
+
+      def initialize(entity = nil)
+        @entity = entity
+      end
+
+      def authorize(name, **options)
+        configured_call = self.class.i_authorizations&.fetch(name.to_sym, nil)
+        configured_call ||= self.class.i_authorizations&.fetch(nil, nil)
+
+        if configured_call
+          run_hook(configured_call, **options)
+        else
+          SnFoil.logger.info "No configuration for #{name} in #{self.class.name}. Authorize not called" if SnFoil.respond_to?(:logger)
+          true
+        end
+      end
+
+      private
+
+      def run_hook(hook, **options)
+        return options unless hook && hook_valid?(hook, **options)
+
+        return send(hook[:method], **options) if hook[:method]
+
+        instance_exec options, &hook[:block]
+      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

data/lib/snfoil/context/version.rb

@@ -0,0 +1,21 @@
+# 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
+  module Context
+    VERSION = '0.0.1'
+  end
+end

data/lib/snfoil/context.rb

@@ -0,0 +1,110 @@
+# 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_relative './context/error'
+require_relative './context/argument_error'
+require_relative './context/structure'
+
+require 'active_support/concern'
+
+module SnFoil
+  # ActiveSupport::Concern for adding SnFoil Context functionality
+  #
+  # @author Matthew Howes
+  #
+  # @since 0.1.0
+  module Context
+    extend ActiveSupport::Concern
+
+    included do
+      include SnFoil::Context::Structure
+    end
+
+    class_methods do
+      def action(name, with: nil, &block)
+        raise SnFoil::Context::Error, "action #{name} already defined for #{self.name}" if (@defined_actions ||= []).include?(name)
+
+        @defined_actions << name
+        setup_hooks(name)
+        define_action_primary(name, with, block)
+      end
+    end
+
+    private
+
+    # rubocop:disable reason:  These are builder/mapping methods that are just too complex to simplify without
+    # making them more complex.  If anyone has a better way please let me know
+    class_methods do # rubocop:disable Metrics/BlockLength
+      def define_action_primary(name, method, block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        define_method(name) do |**options| # rubocop:disable Metrics/MethodLength
+          options[:action] = name.to_sym
+          options = run_action_group(format('setup_%s', name), **options)
+          authorize(name, **options) if respond_to?(:authorize)
+
+          options = run_action_group(format('before_%s', name), **options)
+          authorize(name, **options) if respond_to?(:authorize)
+
+          options = if run_action_primary(method, block, **options)
+                      run_action_group(format('after_%s_success', name), **options)
+                    else
+                      run_action_group(format('after_%s_failure', name), **options)
+                    end
+          run_action_group(format('after_%s', name), **options)
+        end
+      end
+
+      def setup_hooks(name)
+        hook_builder('setup_%s', name)
+        hook_builder('before_%s', name)
+        hook_builder('after_%s_success', name)
+        hook_builder('after_%s_failure', name)
+        hook_builder('after_%s', name)
+      end
+
+      def hook_builder(name_format, name)
+        assign_singleton_methods format(name_format, name),
+                                 format("#{name_format}_hooks", name)
+      end
+
+      def assign_singleton_methods(method_name, singleton_var)
+        instance_variable_set("@#{singleton_var}", [])
+        define_singleton_method(singleton_var) { instance_variable_get("@#{singleton_var}") }
+        define_singleton_method(method_name) do |method = nil, **options, &block|
+          raise SnFoil::Context::ArgumentError, "\##{method_name} requires either a method name or a block" if method.nil? && block.nil?
+
+          instance_variable_get("@#{singleton_var}") << { method: method,
+                                                          block: block,
+                                                          if: options[:if],
+                                                          unless: options[:unless] }
+        end
+      end
+    end
+
+    def run_action_primary(method, block, **options)
+      return send(method, **options) if method
+
+      instance_exec options, &block
+    end
+
+    def run_action_group(group_name, **options)
+      options = self.class.instance_variable_get("@#{group_name}_hooks")
+                    .reduce(options) { |opts, hook| run_hook(hook, opts) }
+      options = send(group_name, **options) if respond_to?(group_name)
+
+      options
+    end
+  end
+end

data/snfoil-policy.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/snfoil/context/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snfoil-context'
+  spec.version       = SnFoil::Context::VERSION
+  spec.authors       = ['Matthew Howes']
+  spec.email         = ['howeszy@gmail.com']
+
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/limited-effort/snfoil-context'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/limited-effort/snfoil-context/blob/main/CHANGELOG.md'
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  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_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.21'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: snfoil-context
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Howes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.6
+- !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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: ''
+email:
+- howeszy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/snfoil/context.rb
+- lib/snfoil/context/argument_error.rb
+- lib/snfoil/context/error.rb
+- lib/snfoil/context/structure.rb
+- lib/snfoil/context/version.rb
+- snfoil-policy.gemspec
+homepage: https://github.com/limited-effort/snfoil-context
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/limited-effort/snfoil-context
+  source_code_uri: https://github.com/limited-effort/snfoil-context
+  changelog_uri: https://github.com/limited-effort/snfoil-context/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []