light_service-validated_context 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b2320137a6c0f04088e028ad9978b2d98f8a8fcd371c503f264ea7cf740741fb
+  data.tar.gz: bc4d7056281ee5dbbb0c8ef51b22abea07e9f9fe44bd0f3dc89efcca89933274
+SHA512:
+  metadata.gz: d3d9723e894f7a2bf924c6be97456c928e789e301312d575d9c81b1ac3ebcb4dd8030303054eea561c384e357c4a4c25353fbeb7f9201c9551c475f5eceabbb7
+  data.tar.gz: 372908640fc08d0e88b2a93748ba84ba7bd1b6d4ef32cbad8b218a6ea0250d0d9f21f5b745deb1948f1dc27487971af9c2d88a207a7b309063d9ea8d64181f21

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  light-service: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.1
+  Exclude:
+    - "bin/*"
+
+Style/LambdaCall:
+  Enabled: false

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 alessandro.fazzi@welaika.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,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in light_service-validated_context.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.26.0"
+
+gem "debug"

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    light_service-validated_context (0.1.0)
+      dry-types (~> 1.7.0)
+      light-service (>= 0.18.0)
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    debug (1.6.3)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.5.0)
+      reline (>= 0.3.0)
+    light-service (0.18.0)
+      activesupport (>= 4.0.0)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.26.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  debug
+  light_service-validated_context!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.26.0)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 'Alessandro Fazzi'
+
+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,94 @@
+# LightService - ValidatedContext
+
+This gem _patches_ `light-service` gem implementing validated keys
+for `expects` and `promises` action's macros.
+
+This gem is a plugin to `light-service`, thus it depends on it (~> 0.18.0).
+
+## What do I mean with validation
+
+- type check
+- type coercion
+- mandatory/optional presence
+- default value
+
+## Stability, affordability
+
+This plugin uses monkey patching in order to alter the behaviour of `light-service`.
+AFAIK this is the only way to achieve the goal. Because of this fact I consider
+`light_service-validated_context` more of an experiment/POC.
+
+## Goals
+
+- implement an advanced and flexible interface to declare,
+type-check, coerce and describe action's arguments without reinventing the wheel (the wheel we use under the wood is [`dry-types`](https://dry-rb.org/gems/dry-types))
+- testing DX and interfaces
+- study what parts of code are involved into this area of `light-service`'s code base
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'light_service-validated_context'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+```ruby
+class ActionOne
+  extend LightService::Action
+
+  expects VK.(:email, Types::Strict::String)
+  expects VK.(:age, Types::Coercible::Integer.constrained(gt: 30))
+  expects VK.(:ary, Types::Array.of(Types::Strict::Symbol).constrained(min_size: 1))
+  promises VK.(:text, Types::Strict::String.constrained(max_size: 10).default('foobar'))
+
+  executed do |context|
+    # something happens
+  end
+end
+
+result = ActionOne.execute(email: 'foo@example.com', age: '37', ary: [:foo])
+# => {:email=>"foo@example.com", :age=>37, :ary=>[:foo], :text=>"foobar"}
+result = ActionOne.execute(age: '37', ary: [:foo])
+# expected :email to be in the context during ActionOne (LightService::ExpectedKeysNotInContextError)
+result = ActionOne.execute(email: 'foo@example.com', age: '37', ary: [])
+# [] violates constraints (min_size?(1, []) failed) (LightService::ExpectedKeysNotInContextError)
+```
+
+Since all the validation and coercion logic is delegated to `dry-types`, you can
+read more about what you can achieve at https://dry-rb.org/gems/dry-types/1.2/
+
+`VK` objects needs to be created with 2 positional arguments:
+
+- key name as a symbol
+- A type
+
+`VK` and `ValidatedKey` (equivalent) are short aliases for `LightService::Context::ValidatedKey`.
+They are created only if not already defined in the global space. You're free to use the namespaced
+form to avoid name collisions.
+
+You can find more usage example in `spec/support/test_doubles.rb`
+
+## 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/pioneerskies/light_service-validated_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/pioneerskies/light_service-validated_context/blob/main/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 LightService::ValidatedContext project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pioneerskies/light_service-validated_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[rubocop spec]

data/lib/light_service/validated_context/context_overrides.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ValidatedContext
+  module ContextOverrides
+    def define_accessor_methods_for_keys(keys)
+      super keys.map(&:to_sym)
+    end
+  end
+end

data/lib/light_service/validated_context/expected_key_verifier.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ValidatedContext
+  module ExpectedKeyVerifier
+    def keys
+      action.expected_keys.map do |key|
+        next key unless key.is_a?(LightService::Context::ValidatedKey)
+
+        key.label
+      end
+    end
+
+    def raw_keys
+      action.expected_keys
+    end
+  end
+end

data/lib/light_service/validated_context/key_verifier.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ValidatedContext
+  module KeyVerifier
+    def are_all_keys_valid?(validated_keys)
+      errors = []
+
+      validated_keys.each do |key|
+        next unless key.is_a?(LightService::Context::ValidatedKey)
+
+        begin
+          context[key.label] = key.type[context[key.label] || Dry::Types::Undefined]
+        rescue Dry::Types::CoercionError => e
+          errors << e.message
+        end
+      end
+
+      [errors.none?, errors]
+    end
+
+    def are_all_keys_in_context?(keys)
+      keys_are_all_valid, validation_errors = are_all_keys_valid?(raw_keys)
+
+      not_found_keys = keys_not_found(keys)
+      keys_are_all_present = not_found_keys.none?
+
+      return true if keys_are_all_valid && keys_are_all_present
+
+      msg = if !keys_are_all_present
+              error_message
+            elsif !keys_are_all_valid
+              validation_errors.join(', ')
+            end
+
+      LightService::Configuration.logger.error msg
+      raise error_to_throw, msg
+    end
+  end
+end

data/lib/light_service/validated_context/promised_key_verifier.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ValidatedContext
+  module PromisedKeyVerifier
+    def keys
+      action.promised_keys.map do |key|
+        next key unless key.is_a?(LightService::Context::ValidatedKey)
+
+        key.label
+      end
+    end
+
+    def raw_keys
+      action.promised_keys
+    end
+  end
+end

data/lib/light_service/validated_context/validated_key.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ValidatedContext
+  ValidatedKey = Struct.new(:label, :type) do
+    def self.call(*args)
+      new(*args)
+    end
+
+    def to_sym
+      label.to_sym
+    end
+
+    def to_s
+      label.to_s
+    end
+  end
+end

data/lib/light_service/validated_context/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module LightService
+  module ValidatedContext
+    VERSION = "0.1.0"
+  end
+end

data/lib/light_service/validated_context.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+require 'light-service'
+require 'dry-types'
+
+module ValidatedContext; end
+
+module LightService
+  class Context
+    ValidatedKey = ::ValidatedContext::ValidatedKey
+    prepend ::ValidatedContext::ContextOverrides
+
+    class ExpectedKeyVerifier
+      prepend ::ValidatedContext::KeyVerifier
+      prepend ::ValidatedContext::ExpectedKeyVerifier
+    end
+
+    class PromisedKeyVerifier
+      prepend ::ValidatedContext::KeyVerifier
+      prepend ::ValidatedContext::PromisedKeyVerifier
+    end
+  end
+
+  module Types
+    include Dry.Types()
+  end
+end
+
+# Convenience namespace for implementor
+Types = LightService::Types unless Module.const_defined?('Types')
+
+# Convenience alias for implementor
+ValidatedKey = LightService::Context::ValidatedKey unless Module.const_defined?('ValidatedKey')
+VK = LightService::Context::ValidatedKey unless Module.const_defined?('VK')

data/light_service-validated_context.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/light_service/validated_context/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "light_service-validated_context"
+  spec.version = LightService::ValidatedContext::VERSION
+  spec.authors = ["'Alessandro Fazzi'"]
+  spec.email = ["alessandro.fazzi@welaika.com"]
+
+  spec.summary = "LightService plugin adding DSL for expected/promised keys validation"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://github.com/pioneerskies/light_service-validated_context"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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.
+  # rubocop:disable Layout/LineLength
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|github|solargraph|rspec|vscode)|appveyor)})
+    end
+  end
+  # rubocop:enable Layout/LineLength
+
+  # spec.bindir = "exe"
+  # spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "dry-types", "~> 1.7.0"
+  spec.add_dependency "light-service", ">= 0.18.0"
+  spec.add_dependency "zeitwerk"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/sig/light_service/validated_context.rbs

@@ -0,0 +1,6 @@
+module LightService
+  module ValidatedContext
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: light_service-validated_context
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "'Alessandro Fazzi'"
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: light-service
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- alessandro.fazzi@welaika.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/light_service/validated_context.rb
+- lib/light_service/validated_context/context_overrides.rb
+- lib/light_service/validated_context/expected_key_verifier.rb
+- lib/light_service/validated_context/key_verifier.rb
+- lib/light_service/validated_context/promised_key_verifier.rb
+- lib/light_service/validated_context/validated_key.rb
+- lib/light_service/validated_context/version.rb
+- light_service-validated_context.gemspec
+- sig/light_service/validated_context.rbs
+homepage: https://github.com/pioneerskies/light_service-validated_context
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pioneerskies/light_service-validated_context
+  source_code_uri: https://github.com/pioneerskies/light_service-validated_context
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: LightService plugin adding DSL for expected/promised keys validation
+test_files: []