clear_logic 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a5c1820917b795fd279d87e1fb80123d6912ca317200906e5535e1768feb1418
+  data.tar.gz: 35a2da8237ddff477f586597a86f353834ce066f22c5fd052050625ad26ee82e
+SHA512:
+  metadata.gz: 889d1c305931fc619cd7ff316f7b5747fd83fb9478e3a24e207fe244dad9add4cb01c60ae8dd21268ffa80466d95b6f684cec7636eaab4f9d37afa5a8014d41c
+  data.tar.gz: f704322fff29893f8863f66bdd4741e8f80fd17e010786abe5c1dd7580e4371e8886ec75cae95ead6b740421458187decfdd62b80ab3c043a57146dd32ec41b9

data/.gitignore

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

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.5.1
+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 yaroslav.bezrukavyi@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clear_logic.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    clear_logic (0.1.0)
+      dry-inflector
+      dry-initializer (>= 2.5.0)
+      dry-matcher (>= 0.7)
+      dry-monads (>= 0.3.1)
+      dry-transaction (>= 0.12.0)
+      dry-types (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dry-configurable (0.8.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.7)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.2)
+    dry-events (0.1.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+    dry-inflector (0.1.2)
+    dry-initializer (3.0.1)
+    dry-logic (1.0.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-matcher (0.7.0)
+    dry-monads (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer
+    dry-transaction (0.13.0)
+      dry-container (>= 0.2.8)
+      dry-events (>= 0.1.0)
+      dry-matcher (>= 0.7.0)
+      dry-monads (>= 0.4.0)
+    dry-types (1.0.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0)
+    ffaker (2.11.0)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  clear_logic!
+  ffaker
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 bezrukavyi
+
+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,482 @@
+# ClearLogic
+
+Service object based on [dry-rb](https://dry-rb.org/)
+
+## Installation
+
+```ruby
+gem 'clear_logic'
+```
+
+## Usage
+
+- [Interface](#interface)
+- [Types](#types)
+- [Context](#context)
+- [Stride](#stride)
+- [Result](#result)
+- [Logger](#logger)
+- [Matcher](#matcher)
+
+
+## Interface
+
+DSL for building class initializer with params and options based on [`dry-initializer`](https://github.com/dry-rb/dry-initializer)
+
+```ruby
+class MyService < ClearLogic::Service
+  context :name, Dry::Types['strict.string'], as: :param
+  context :test, Dry::Types['strict.bool'], default: -> { false }
+  
+  stride :some_step
+
+  def some_step(context)
+    context.name # => first argument
+    success(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call('Liskov', test: true)
+
+result.success? # => true
+result.context.name # => 'some string'
+result.context.test # => true
+```
+
+```ruby
+result = MyService.call('Lenon')
+
+result.success? # => true
+result.context.name # => 'some string'
+result.context.test # => false
+```
+
+# Types
+
+You can register own `class` types.
+
+In your initializer:
+
+```ruby
+ActiveRecord::Base.connection.tables.map { |x| x.classify.safe_constantize }.compact.each do |model|
+  ClearLogic::Types.register(model, prefix: 'model')
+end
+```
+
+In your initializer:
+
+```ruby
+Dry::Types['model.user']
+```
+
+## Context
+
+In each step you work with `context`. Context have next methods which are available to you:
+- `args`
+- `[]`
+- `[]=`
+- `exit_success?`
+- `catched_error?`
+- `failure_error?`
+- `to_h`
+
+And next accessors:
+- `catched_error`
+- `failure_error`
+- `service`
+- `exit_success`
+- `step`
+
+```ruby
+class MyService < ClearLogic::Service
+  context :name, Dry::Types['strict.string'], as: :param
+  
+  stride :some_step
+
+  def some_step(context)
+    fetch_user
+
+    success(context)
+  end
+
+  private
+
+  def fetch_user
+    context[:user] = User.find_by(name: context.name)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call('Buscemi')
+
+result.context.name # => 'Buscemi'
+result.context.step # => :some_step # return last step
+result.context.args # => ['Buscemi']
+
+result.context[:some_option] # => true
+
+result.context.to_h # => {:catched_error=>nil, :failure_error=>nil, :service=>MyService, :exit_success=>nil, :step=>:some_step, :options=>{:some_option=>true}, :args=>['Buscemi']}
+
+result.context.exit_success? # => false
+result.context.catched_error? # => false
+result.context.failure_error? # => false
+```
+
+## Stride
+
+Business transaction DSL based on [`dry-transaction`](https://github.com/dry-rb/dry-transaction)
+
+### Catch failed step
+
+```ruby
+class MyService < ClearLogic::Service
+  stride :first, failure: :some_rollback
+  stride :second
+
+  def first(context)
+    # ...
+    failure(context)
+  end
+  
+  def second(context)
+    # ...
+    success(context)
+  end
+
+  def some_rollback(context)
+    # Do sth if first step is failed
+    success(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call
+
+result.success? # => true
+```
+
+### Catch specific errors
+
+```ruby
+class MyService < ClearLogic::Service
+  stride :first
+  stride :second, rescue: { StandardError => :some_rescue }
+
+  def first(context)
+    # ...
+    success(context)
+  end
+  
+  def second(context)
+    # ...
+    raise StandardError
+  end
+
+  def some_rescue(context)
+    # Do sth if first step is raised error from `rescue` option
+    failure(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call
+
+result.success? # => false
+result.context.catched_error? # => true
+result.context.catched_error.class # => StandardError
+```
+
+### Exit success from process
+
+```ruby
+class MyService < ClearLogic::Service
+  stride :first
+  stride :second, rescue: { StandardError => :some_rescue }
+
+  def first(context)
+    context[:test] = 'first'
+    exit_success(context)
+  end
+  
+  def second(context)
+    context[:test] = 'second'
+    success(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call
+
+result.success? # => true
+result.context[:test] # => 'first'
+result.exit_success? # => true'
+```
+
+## Result
+
+Result with status of failed execution based on [`dry-monads`](https://github.com/dry-rb/dry-monads)
+
+### Default errors
+
+Aside from default monads methods `success` and `failure` you have next failure methods which give you status of failed execution:
+
+- `unauthorized`
+- `forbidden`
+- `not_found`
+- `invalid`
+
+```ruby
+class MyService < ClearLogic::Service
+  stride :first
+  stride :second
+
+  def first(context)
+    # ...
+    not_found(context)
+  end
+  
+  def second(context)
+    # If will not be handled
+    failure(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call
+
+result.failure? # => false
+result.context.failure_error? # => true
+result.context.failure_error.status # => :not_found
+```
+
+### Custom errors
+
+You also can use own errors
+
+```ruby
+class MyService < ClearLogic::Service
+  errors :failed_logic
+
+  stride :first
+  stride :second
+
+  def first(context)
+    # ...
+    failed_logic(context)
+  end
+  
+  def second(context)
+    # If will not be handled
+    success(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call
+
+result.failure? # => false
+result.context.failure_error? # => true
+result.context.failure_error.status # => :failed_logic
+```
+
+## Logger
+
+DSL for insert log context state on each step
+
+### Default logger
+
+```ruby
+class MyService < ClearLogic::Service
+  stride :first, log: true
+  stride :second
+  stride :third, log: true
+
+  def first(context)
+    context[:test] = ['first']
+    success(context)
+  end
+  
+  def second(context)
+  context[:test] += ['second']
+    success(context)
+  end
+  
+  def third(context)
+  context[:test] += ['third']
+    success(context)
+  end
+end
+```
+
+In console:
+
+```ruby
+result = MyService.call
+```
+
+In `log/my_service.log`
+
+```pl
+# Logfile created on 2019-06-06 10:28:42 +0300 by logger.rb/61378
+
+[19-06-06 10:28:42.087 #14159#79000]  INFO -- : {
+  "catched_error": null,
+  "failure_error": null,
+  "service": "LoggerService",
+  "exit_success": null,
+  "step": "first_log",
+  "options": {
+    "test": [
+      "first"
+    ]
+  },
+  "args": [
+
+  ]
+}
+[19-06-06 10:28:42.087 #14159#79000]  INFO -- : {
+  "catched_error": null,
+  "failure_error": null,
+  "service": "LoggerService",
+  "exit_success": null,
+  "step": "third_log",
+  "options": {
+    "test": [
+      "first",
+      "second",
+      "third"
+    ]
+  },
+  "args": [
+
+  ]
+}
+
+```
+
+### Custom logger
+
+```ruby
+class MyLogger < ::Logger
+  def format_message(severity, time, progname, context)
+    context[:test][0] + "\n"
+  end
+end
+
+class MyService < ClearLogic::Service
+  logger MyLogger
+
+  stride :first, log: true
+
+  def first(context)
+    context[:test] = ['first']
+    success(context)
+  end
+  
+  def second(context)
+  context[:test] += ['second']
+    success(context)
+  end
+end
+```
+
+In `log/my_service.log`
+
+```pl
+# Logfile created on 2019-06-06 10:28:42 +0300 by logger.rb/61378
+first
+first
+```
+
+
+## Matcher
+
+Service for handling failed result based on [`dry-matcher`](https://github.com/dry-rb/dry-matcher)
+
+```ruby
+class MyService < ClearLogic::Service
+  context :user_id, Dry::Types['strict.integer']
+
+  errors :custom_error
+
+  stride :find_user
+  stride :check_policy
+
+  def initilize
+  end
+
+  def find_user(context)
+    return not_found(context) unless fetched_user
+
+    success(context)
+  end
+  
+  def check_policy(context)
+    return forbidden(context) unless user_policy.has_ability?
+
+    success(context)
+  end
+
+  def fetched_user
+    @fetched_user ||= User.find_by(id: context.user_id)
+  end
+
+  def user_policy
+    @user_policy ||= PolicyUser.call(fetched_user)
+  end
+end
+```
+
+In matcher you can check [custom errors](#custom-errors) and [default result](#default-errors) errors
+
+In console:
+
+```ruby
+result = MyService.call(user_id: 1)
+
+match_result = ClearLogic::Matcher.call(result) do |on|
+  on.failure(:unauthorized) { :unauthorized_result }
+  on.failure(:forbidden) { :forbidden_result }
+  on.failure(:not_found) { :not_found_result }
+  on.failure(:invalid) { :invalid_result }
+  on.failure(:custom_error) { :custom_error_result }
+  on.failure { :failure_result }
+  on.success { :success_result }
+end
+
+match_result # => :not_found_result
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bezrukavyi/clear_logic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ClearLogic project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bezrukavyi/clear_logic/blob/master/CODE_OF_CONDUCT.md).