dried_interaction 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bb3c6571b1286ed2e0f2b327efb07eacb17bb0f6e6edca8355d6081de014bae
+  data.tar.gz: 44c570ac8b377f963bcde0d78de4bf67e3fbe57bd39ef4216e15c31b686909b5
+SHA512:
+  metadata.gz: 19f0b433ebed93ee5d903cdf794af2827582642445ea7a21bdb0410915a54807cb9011c42b26ea131c4a3b3fc2e0df5568a63ce93a6e60b0de8fab3a246767bb
+  data.tar.gz: ddbf74d37d6e4d8cacb5a56d6e6833362122f0b3f3250ea3ddedae6835221a9b016d932b18e70bb3bcdafe6e116b6729f36b329c6912cfdaef9733459e0727cc

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.17.3

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 glee812@yandex.ru. 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 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dried_interaction.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Gleb
+
+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,95 @@
+# DriedInteraction
+
+DriedInteraction is a simple gem that helps you write interactors with input params validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dried_interaction'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dried_interaction
+
+## Why it may be useful to you
+1. Keeps your business logic typed
+2. Validates interactor input data by default
+3. Includes incredible DRY stack gems by default for yours interactors
+
+## Usage
+### Setting up an interactor
+For setting up an interactor you need to include DriedInteraction into your class.
+Then you can add contract for call method which will validate input params.
+By default interactor returns Dry::Matcher::ResultMatcher.
+
+```rb
+class PublishPost
+  include DriedInteraction
+
+  option :normalize_params, reader: :private, default: -> { PostParamsNormalize.new }
+  option :post_repo, reader: :private, default: -> { PostRepo }
+  option :notify, reader: :private, default: -> { PostNotify.new }
+
+  contract do
+    required(:user).filled(Dry.Types.Instance(User))
+    required(:params).hash do
+      required(:title).filled(:string)
+      required(:content).filled(:string)
+      optional(:public).filled(:bool)
+    end
+  end
+
+  def call(user:, params:)
+    normalized_params = yield normalize_params.call(params)
+    post = yield save_post(normalized_params)
+    notify.call(post)
+
+    Success(post)
+  end
+
+  private
+
+  def save_post(params)
+    post = post_repo.new(params)
+    post.save ? Success(post) : Failure('Error message')
+  end
+end
+```
+
+### Interactor calling
+
+```rb
+PublishPost.new.call(user, params) do |interactor|
+  interactor.success do |post|
+    # handle success
+  end
+
+  interactor.failure do |error|
+    # handle failure
+  end
+end
+```
+
+## Additional info
+
+1. You have to return a monad from interactor as result.
+2. Contract failure will be handled as exception.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dried_interaction"
+
+# 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/dried_interaction.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dried_interaction/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dried_interaction"
+  spec.version       = DriedInteraction::VERSION
+  spec.authors       = ["gl-pv"]
+  spec.email         = ["gleeb812812@yandex.ru"]
+
+  spec.summary       = %q{Just a simple, ready to use interactor implementation with built in validation of input params}
+  spec.description   = %q{Just a simple, ready to use interactor implementation with built in validation of input params}
+  spec.homepage      = "https://github.com/gl-pv/dried_interaction"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/gl-pv/dried_interaction"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'dry-initializer', '~> 3.0'
+  spec.add_dependency 'dry-monads', '~> 1.0'
+  spec.add_dependency 'dry-matcher', '~> 0.7'
+  spec.add_dependency 'dry-validation', '~> 1.2'
+  spec.add_dependency 'dry-schema', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/dried_interaction/class_methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'dry/validation'
+require 'dry/schema'
+
+module DriedInteraction
+  module ClassMethods
+    attr_accessor :contract_validator
+
+    def contract(kind = :simple, &block)
+      case kind
+      when :simple
+        @contract_validator = Dry::Schema.Params(&block)
+      when :extended
+        @contract_validator = Dry::Validation.Contract(&block)
+      else
+        raise ArgumentError
+      end
+    end
+  end
+end

data/lib/dried_interaction/error.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+class DriedInteractionError < StandardError; end

data/lib/dried_interaction/instance_methods.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'dried_interaction/error'
+
+module DriedInteraction
+  module InstanceMethods
+    def call(*args)
+      interaction_contract_error('Call method allows only one argument') if args.size != 1
+
+      arg = args.first
+      contract = self.class.contract_validator
+      contract_params = fetch_contract_params(contract)
+      check_params_presence_in_args(contract_params, arg.keys)
+
+      contract_result = contract.(arg)
+      return interaction_contract_error(contract_result.errors.messages) if contract_result.failure?
+
+      super(arg)
+    end
+
+    def check_params_presence_in_args(contract_params, args_params)
+      missed_params = args_params - contract_params
+      return if missed_params.empty?
+
+      interaction_contract_error("Params (#{missed_params}) are not present in contract")
+    end
+
+    def fetch_contract_params(contract)
+      schema = contract.is_a?(Dry::Schema::Params) ? contract : contract.schema
+
+      schema.key_map.keys.map { |key| key.name.to_sym }
+    end
+
+    def interaction_contract_error(msgs)
+      raise DriedInteractionError, class: self.class.to_s, errors: Array.wrap(msgs).join('; ')
+    end
+  end
+end

data/lib/dried_interaction/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DriedInteraction
+  VERSION = '0.1.1'
+end

data/lib/dried_interaction.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'dry/matcher'
+require 'dry/matcher/result_matcher'
+require 'dry/monads'
+require 'dry-initializer'
+
+require 'dried_interaction/class_methods'
+require 'dried_interaction/instance_methods'
+
+module DriedInteraction
+  def self.included(klass)
+    klass.extend(ClassMethods)
+    klass.extend(Dry::Initializer)
+
+    klass.prepend(InstanceMethods)
+    klass.include(Dry::Monads[:result, :do])
+    klass.include(Dry::Matcher.for(:call, with: Dry::Matcher::ResultMatcher))
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: dried_interaction
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- gl-pv
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dry-matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Just a simple, ready to use interactor implementation with built in validation
+  of input params
+email:
+- gleeb812812@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dried_interaction-0.1.0.gem
+- dried_interaction.gemspec
+- lib/dried_interaction.rb
+- lib/dried_interaction/class_methods.rb
+- lib/dried_interaction/error.rb
+- lib/dried_interaction/instance_methods.rb
+- lib/dried_interaction/version.rb
+homepage: https://github.com/gl-pv/dried_interaction
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gl-pv/dried_interaction
+  source_code_uri: https://github.com/gl-pv/dried_interaction
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Just a simple, ready to use interactor implementation with built in validation
+  of input params
+test_files: []