dry-effects 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 66aa8408a51ae62ea853de06a0d19617925646c28783044e01338e46d5e75e0d
+  data.tar.gz: f226f1cbb69164f77db634870e139439290927f58075aa0a2fa83b37bb438c46
+SHA512:
+  metadata.gz: bebd714592097d5dde1852ad38bc5162e1d275c7c92d98a36a9f9445dead76dde4325a6b4e58758ca3fc40ae7ba554a2484c1ae64f59b344273f34da9e4d5305
+  data.tar.gz: '06600796cf9707b1e55141d3fec4cae8584a8525b3ed3155eb36be05095db85148e2cdc75f2d9aad662096cb454f5a8ab4070989022d6cc16ce98c3af87b3261'

data/.codeclimate.yml

@@ -0,0 +1,15 @@
+version: "2"
+
+prepare:
+  fetch:
+  - url: "https://raw.githubusercontent.com/dry-rb/devtools/master/.rubocop.yml"
+    path: ".rubocop.yml"
+
+exclude_patterns:
+  - "benchmarks/"
+  - "examples/"
+  - "spec/"
+
+plugins:
+  rubocop:
+    enabled: true

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,73 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/Alias:
+  Enabled: false
+
+Style/LambdaCall:
+  Enabled: false
+
+Style/StabbyLambdaParentheses:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 22
+
+Metrics/ClassLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Max: 10
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'lib/dry-*.rb'

data/.travis.yml

@@ -0,0 +1,31 @@
+---
+language: ruby
+cache: bundler
+bundler_args: --without benchmarks tools
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+rvm:
+  - 2.5.5
+  - 2.6.3
+  - truffleruby
+after_script:
+  - "[ -d coverage ] && ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+env:
+  global:
+    - COVERAGE=true
+matrix:
+  allow_failures:
+    - rvm: truffleruby
+  include:
+    - rvm: jruby-9.2.7.0
+      jdk: openjdk8
+notifications:
+  email: false
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/19098b4253a72c9796db
+    on_success: change # options: [always|never|change] default: always
+    on_failure: always # options: [always|never|change] default: always
+    on_start: false # default: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0
+
+TBD

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discourse.dry-rb.org](https://discourse.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org).

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/dry-rb/#{repo_name}" }
+
+gemspec
+
+group :test do
+  gem 'dry-auto_inject', require: false
+  gem 'dry-system', github: 'dry-system', branch: 'master', require: false
+  gem 'simplecov', require: false, platform: :mri
+  gem 'warning'
+end
+
+group :tools do
+  gem 'pry-byebug', platform: :mri
+  gem 'rubocop'
+end
+
+gem 'dry-struct'
+gem 'dry-monads'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nikita Shilnikov
+
+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,20 @@
+[travis]: https://travis-ci.com/dry-rb/dry-effects
+[codeclimate]: https://codeclimate.com/github/dry-rb/dry-effects/maintainability
+[coverage]: https://codeclimate.com/github/dry-rb/dry-effects/test_coverage
+[chat]: https://dry-rb.zulipchat.com
+
+# dry-effects [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
+
+[![Build Status](https://travis-ci.com/dry-rb/dry-effects.svg?branch=master)][travis]
+[![Maintainability](https://api.codeclimate.com/v1/badges/83bdab1ec9e1097c2284/maintainability)][codeclimate]
+[![Test Coverage](https://api.codeclimate.com/v1/badges/83bdab1ec9e1097c2284/test_coverage)][coverage]
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+See CONTRIBUTING.md.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/dry-effects.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/effects/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-effects'
+  spec.version       = Dry::Effects::VERSION
+  spec.authors       = ['Nikita Shilnikov']
+  spec.email         = ['fg@flashgordon.ru']
+
+  spec.summary       = 'Algebraic effects.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dry-rb/dry-effects'
+  spec.license       = 'MIT'
+
+  # 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['allowed_push_host'] = 'https://rubygems.org'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/dry-rb/dry-effects'
+    spec.metadata['bug_tracker_uri'] = 'https://github.com/dry-rb/dry-effects/issues'
+  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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
+  spec.add_runtime_dependency 'dry-container', '~> 0.7', '>= 0.7.2'
+  spec.add_runtime_dependency 'dry-core', '~> 0.4', '>= 0.4.7'
+  spec.add_runtime_dependency 'dry-equalizer', '~> 0.2', '>= 0.2.2'
+  spec.add_runtime_dependency 'dry-inflector', '~> 0.1', '>= 0.1.2'
+  spec.add_runtime_dependency 'dry-initializer', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/examples/amb.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Operation
+  include Dry::Effects.State(:counter)
+  include Dry::Effects.Amb(:feature_enabled)
+
+  def call
+    if feature_enabled?
+      self.counter += 10
+      :with_feature
+    else
+      self.counter += 1
+      :without_feature
+    end
+  end
+end
+
+module Handler
+  include Dry::Effects::Handler.State(:counter, as: :with_counter)
+  include Dry::Effects::Handler.Amb(:feature_enabled, as: :test_feature)
+end
+
+class AmbState
+  include Handler
+
+  def initialize
+    @operation = Operation.new
+  end
+
+  def call
+    test_feature { with_counter(0) { @operation.call } }
+  end
+end
+
+class StateAmb
+  include Handler
+
+  def initialize
+    @operation = Operation.new
+  end
+
+  def call
+    with_counter(0) { test_feature { @operation.call } }
+  end
+end
+
+amb_then_state = AmbState.new
+state_then_amb = StateAmb.new
+
+amb_then_state.() # => [[1, :without_feature], [10, :with_feature]]
+state_then_amb.() # => [11, [:without_feature, :with_feature]]

data/examples/state.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Operation
+  include Dry::Effects.State(:counter)
+
+  def call
+    3.times do
+      self.counter += 1
+    end
+
+    :done
+  end
+end
+
+class Wrapper
+  include Dry::Effects::Handler.State(:counter)
+
+  def initialize
+    @operation = Operation.new
+  end
+
+  def call
+    with_counter(0) { @operation.call }
+  end
+end
+
+__END__
+
+Wrapper.new.call # => [3, :done]

data/lib/dry/effects.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'dry/core/constants'
+require 'dry/effects/version'
+require 'dry/effects/container'
+require 'dry/effects/errors'
+require 'dry/effects/instructions/raise'
+
+module Dry
+  module Effects
+    include Core::Constants
+
+    class Error < StandardError; end
+
+    @effects = Container.new
+    @providers = Container.new
+
+    class << self
+      attr_reader :effects, :providers
+
+      def yield(effect)
+        result = ::Fiber.yield(effect)
+
+        if result.is_a?(Instruction)
+          result.()
+        else
+          result
+        end
+      rescue FiberError => e
+        if block_given?
+          yield(effect, e)
+        else
+          raise Errors::UnhandledEffectError, effect
+        end
+      end
+    end
+  end
+end
+
+require 'dry/effects/handler'
+require 'dry/effects/all'
+require 'dry/effects/extensions'

data/lib/dry/effects/all.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'concurrent/map'
+require 'dry/effects'
+require 'dry/effects/inflector'
+
+module Dry
+  module Effects
+    default = %i[
+      cache current_time random resolve defer
+      state interrupt amb retry fork parallel
+      async implicit env lock reader
+    ]
+
+    effect_modules = ::Concurrent::Map.new
+
+    default.each do |key|
+      class_name = Inflector.camelize(key)
+
+      if ::File.exist?("#{__dir__}/effects/#{key}.rb")
+        effects.register(key, memoize: true) do
+          require "dry/effects/effects/#{key}"
+          Effects.const_get(Inflector.camelize(key))
+        end
+
+        singleton_class.class_eval do
+          define_method(class_name) do |*args|
+            effect_modules.fetch_or_store([key, args]) do
+              ::Dry::Effects.effects[key].new(*args).freeze
+            end
+          end
+        end
+      end
+
+      if ::File.exists?("#{__dir__}/providers/#{key}.rb")
+        providers.register(key, memoize: true) do
+          require "dry/effects/providers/#{key}"
+          Providers.const_get(Inflector.camelize(key))
+        end
+
+        Handler.singleton_class.define_method(class_name) do |*args|
+          ::Dry::Effects.providers[key].mixin(*args)
+        end
+      end
+    end
+  end
+end