polidef 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b3dbfbbb15b1f7359e911f4a4474a7078e0d16dca163ba16c561f0714c8b74e
+  data.tar.gz: 826f24903a0d1195e57e2b790c1f80155be59153c8e64691f0d76098bac156af
+SHA512:
+  metadata.gz: 77f6df7b46eb951844778e8ab8caca4124002fa4af83add1d2671aeeff269c2420636d1ab28d8ecdc871f497d7399fcad61e084ed182f23bee4aae3994688ba5
+  data.tar.gz: b1dfeae924d565447d9118067ad906a44330653926c1187364261a5763f1cc8830c5a1ba8d1fe9aab05c4269137fd2d6376dd5506801a758a65f3d529f4f024d

data/.standard.yml

@@ -0,0 +1 @@
+format: progress

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# [0.1.0] - Update on initial release
+
+## Added
+
+## Fixed
+

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 jd_gonzales@icloud.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,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in polidef.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    polidef (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    minitest (5.22.2)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.34.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.60)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  polidef!
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jonathan Gonzales
+
+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,153 @@
+# Polidef
+
+**Still a WIP v1.0.0 is planned for early March 2024**
+
+Polidef allows you to create easily testable policy objects that can be very generic for use in multiple objects or be very very specific all while avoiding heavy scaffolding in code.
+
+## Who is this for?
+This gem isn't recommended for newer applications that are still working through determining their domain as something like this can end up complicating features more so than it can help. The target audience is for those who have inherited a more mature codebase where the code design is not always ideal. The abstraction here can help provide you with ways of naming important "conditional based" concepts in your domain, especially those that tend to grow with more and more `&&`s or `||`s. 
+
+The techniques here are certainly implementable with POROs (Plain Old Ruby Objects) but the convinence of these abstractions, especially for testing maybe useful.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'polidef'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install polidef
+
+## Usage
+**As of Feb 2024, this project is still a WIP. I've tried to notate available API's as they are on the `main` branch but it may not always be accurate.**
+
+### Simple Policies
+The simpilest way to implement a `Polidef::Policy` is to create a class which implements a `#policy` method that evaluates to the _truthy_ version of your logic. Think along the lines of:
+
+> "ThisObject can_do_this if Policy is fulfilled"
+
+**Policy Object**
+
+``` ruby
+class NotificationPolicy < Polidef::Policy
+  dependencies :user, :subject, :channel
+  
+  def policy
+    policy_chain([:user_can_recieve?, :channel_usable?])
+      .or_policy(:subject_overrides_preferences?)
+  end
+  
+  private
+  
+  def user_can_recieve?
+    user.prefences.notifications_enabled? && !user.notifications_muted?
+  end
+  
+  def channel_usable?
+    channel.state == 'active'
+  end
+  
+  def subject_overrides_preferences?
+    subject.overrides_notification_policy?
+  end
+end
+```
+
+We can then use `NotificationPolicy` where ever we need to in a few different ways:
+
+``` ruby
+# ...
+include Polidef::Policies
+## a block
+def send_notification_to(recipient, notifier: NotificationService)
+  with_fulfilled_policy(:notification_policy, dependencies: {user: recipient, subject: self, channel: channel}) do
+    notifier.send_notification_to(recipient, subject: subject)
+  end
+end
+
+## a method
+def send_notification_to(recipient, notifier: NotificationService)
+  if policy_fulfilled?(:notification_policy, user: recipient, subject: self, channel: channel)
+    notifier.send_notification_to(recipient, subject: subject)
+  else # policy implicitely rejected
+    notifier.perform_later(current_user.time_till_unmute, user_id: current_user.id subject_id: subject.id, channel_id: channel.id)
+  end
+end
+```
+
+Testing the `NotificationPolicy` is simple with the provided assertions. Since we want to know if the `#send_notification` works and don't care about the specifics of the `NotificationPolicy` and/or we don't want to have to mock/stub (or worse, persist) each dependency for the test we can instead, use `asserts_with_policy`.
+
+``` ruby
+# ...
+include Polidef::PolicyAssertions
+
+# ...
+
+def test_send_notification_for
+  message = build(:message_in_default_channel, content: "Test")
+
+  mock_notification_service = Minitest::Mock.new
+  mock_notification_service.expects(:send_notification_to, nil, [User], subject: message)
+  
+  # Forces Policy fulfilled
+  assert_with_fulfilled_policy :notification_policy do
+    message.send_notification_to(@user, notifier: mock_notification_service)
+  end
+  
+  assert_mock mock_notification_service
+end
+
+def test_send_notification_for
+  message = build(:message_in_default_channel, content: "Test")
+
+  mock_notification_service = Minitest::Mock.new
+  mock_notification_service.expects(:perform_later, 'job-id-123', [Time], Hash)
+  
+  # Forces Policy rejected
+  assert_with_rejected_policy :notification_policy do
+    message.send_notification_to(@user, notifier: mock_notification_service)
+  end
+
+  assert_mock mock_notification_service
+end
+```
+
+## Plans & Todos
+### Planned features
+- Support for inline Policy declarations (50% complete)
+- Support for `policy_rejected` inverse of fulfilled methods
+- Support for decorators using `SimpleDelegator` for very generic policies
+- Useful testing API to test individual Policies
+- Support for `rails generate policy --deps dep_1, dep_2 ...`
+- "Conditional chaining" API for readability
+
+### Planned Housekeeping
+- More thorough examples
+- Integrate a documentation framework (RDoc and Yard maybe?)
+- A small static site
+- Issue & PR templates
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/juliusdelta/polidef. 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/juliusdelta/polidef/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Polidef project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/juliusdelta/polidef/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/polidef/policies.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Polidef
+  module Policies
+    def with_fulfilled_policy(policy, dependencies:)
+      policy_class = Policy.inline_policies.find { |p| p[:name] == policy }
+      policy_class ||= Object.const_get(policy.to_sym.to_s.split("_").map(&:capitalize).join("")).new
+      policy_class._assign_attrs(dependencies)
+
+      result = policy_class._policy_try
+
+      yield if result
+    end
+
+    def policy_fulfilled?(policy, dependencies:)
+      policy_class = Object.const_get(policy.to_sym.to_s.split("_").map(&:capitalize).join("")).new
+      policy_class._assign_attrs(dependencies)
+
+      policy_class._policy_try
+    end
+
+    def policy_rejected?(policy, dependencies:)
+      policy_class = Object.const_get(policy.to_sym.to_s.split("_").map(&:capitalize).join("")).new
+      policy_class._assign_attrs(dependencies)
+
+      result = policy_class._policy_try
+
+      !result
+    end
+
+    module ClassMethods
+      # extract to InlinePolicy class
+      def defpolicy(policy_name, dependencies, &block)
+        klass = Class.new(Policy) do
+          def initialize(deps)
+            deps[:dependencies].each do |dep|
+              instance_variable_set(:"@#{dep}", nil)
+              self.class.send(:attr_accessor, dep)
+            end
+          end
+
+          def policy
+            yield
+          end
+        end
+
+        klass.include(Policies)
+        klass.add_inline_policy({name: policy_name, policy: klass.new(dependencies)})
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/polidef/policy.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Polidef
+  class Policy
+    def self.policy_dependencies(*args)
+      @policy_dependencies ||= args
+    end
+
+    def self.inline_policies
+      @inline_policies ||= []
+    end
+
+    def self.add_inline_policy(policy_hash)
+      inline_policies << policy_hash
+    end
+
+    def initialize
+      _generate_attrs
+    end
+
+    def policy
+      raise NotImplementedError
+    end
+
+    def policy_chain(policies_collection)
+      _policy_chain(policies_collection)
+    end
+
+    def or_policy(single_policy)
+      _or_policy(single_policy)
+    end
+
+    def _policy_chain(policies_collection)
+      @_policy_state = nil
+
+      policies_collection.each do |chain_link|
+        break unless @_policy_state
+        @_policy_state = send(:chain_link)
+      end
+
+      itself
+    end
+
+    def _or_policy(single_policy)
+      return if @_policy_state
+      @_policy_state = send(:single_policy)
+
+      itself
+    end
+
+    def _policy_try
+      send(:policy)
+    end
+
+    def _generate_attrs
+      self.class.policy_dependencies.each do |dep|
+        instance_variable_set(:"@#{dep}", nil)
+        self.class.send(:attr_accessor, dep)
+      end
+    end
+
+    def _assign_attrs(dependencies)
+      dependencies.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    end
+  end
+end

data/lib/polidef/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Polidef
+  VERSION = "0.0.1"
+end

data/lib/polidef.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Polidef
+  class Error < StandardError; end
+end
+
+require_relative "polidef/version"
+require_relative "polidef/policy"
+require_relative "polidef/policies"

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: polidef
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- JD Gonzales
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+description: |
+  Polidef is a convience API for managing complex and potentially stateful conditionals through policy objects.
+  Complex conditionals are fragile and can require a lot of state to exist in order to execute as expected. Polidef
+  seeks to simplify implementation and testing so you spend less time wrangling conditional state and more time
+  doing other things.
+email:
+- jd_gonzales@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/polidef.rb
+- lib/polidef/policies.rb
+- lib/polidef/policy.rb
+- lib/polidef/version.rb
+homepage: https://github.com/juliusdelta/polidef
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/juliusdelta/polidef
+  source_code_uri: https://github.com/juliusdelta/polidef
+  changelog_uri: https://github.com/juliusdelta/polidef/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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Useful abstractions to manage complex conditionals.
+test_files: []