dry-effects 0.1.4 → 0.1.5

data/.github/workflows/docsite.yml

@@ -1,34 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-name: docsite
-
-on:
-  push:
-    paths:
-      - docsite/**
-      - .github/workflows/docsite.yml
-    branches:
-      - master
-      - release-**
-    tags:
-
-jobs:
-  update-docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - name: Set up Ruby
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: "2.6.x"
-      - name: Install dependencies
-        run: |
-          gem install bundler
-          bundle install --jobs 4 --retry 3 --without benchmarks sql
-      - name: Symlink ossy
-        run: mkdir -p bin && ln -sf "$(bundle show ossy)/bin/ossy" bin/ossy
-      - name: Trigger dry-rb.org deploy
-        env:
-          GITHUB_LOGIN: dry-bot
-          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
-        run: bin/ossy github workflow dry-rb/dry-rb.org ci

data/.github/workflows/sync_configs.yml

@@ -1,56 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-name: sync_configs
-
-on:
-  repository_dispatch:
-
-jobs:
-  sync-configs:
-    runs-on: ubuntu-latest
-    if: github.event.action == 'sync_configs'
-    steps:
-      - uses: actions/checkout@v1
-      - name: Set up Ruby
-        uses: eregon/use-ruby-action@master
-        with:
-          ruby-version: 2.6
-      - name: Install latest bundler
-        run: |
-          gem install bundler
-          bundle config set without 'tools benchmarks docs'
-      - name: Install dependencies
-        run: bundle install --jobs 4 --retry 3 --without tools test benchmarks docs
-      - name: Symlink ossy
-        run: ln -sf "$(bundle info ossy --path)/bin/ossy" bin/ossy
-      - name: Clone devtools
-        run: git clone https://github.com/dry-rb/devtools.git tmp/devtools
-      - name: Compile file templates
-        env:
-          GITHUB_LOGIN: dry-bot
-          GITHUB_TOKEN: ${{ secrets.GH_PAT }}
-        run: |
-          if [ -f "project.yml" ]; then
-            for t in `ls tmp/devtools/templates`
-            do
-              bin/ossy t c tmp/devtools/templates/$t $(basename $t .erb) project.yml
-            done
-          fi
-      - name: Update configuration files from devtools
-        run: |
-          if [ -f ".github/workflows/custom_ci.yml" ]; then
-            rsync -arv --exclude '.github/workflows/ci.yml' tmp/devtools/shared/ . ;
-          else
-            rsync -arv tmp/devtools/shared/ . ;
-          fi
-      - name: Commit changes
-        run: |
-          rm bin/ossy
-          git config --local user.email "dry-bot@dry-rb.org"
-          git config --local user.name "dry-bot"
-          git add -A
-          git commit -m "[devtools] sync configs" || echo "nothing changed"
-      - name: Push changes
-        uses: ad-m/github-push-action@master
-        with:
-          github_token: ${{ secrets.GH_PAT }}

data/.gitignore

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

data/.rspec

@@ -1,4 +0,0 @@
---color
---require spec_helper
---order random
---warnings

data/.rubocop.yml

@@ -1,101 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/EachWithObject:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/ParallelAssignment:
-  Enabled: false
-
-Style/Alias:
-  Enabled: false
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/StabbyLambdaParentheses:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 20
-
-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/PredicateName:
-  Enabled: false
-
-Naming/FileName:
-  Exclude:
-    - "lib/dry-*.rb"
-
-Style/SymbolArray:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/DateTime:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -1,29 +0,0 @@
-# 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](http://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) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-eval_gemfile 'Gemfile.devtools'
-
-gemspec
-
-group :test do
-  gem 'dry-auto_inject', require: false
-  gem 'dry-system', github: 'dry-rb/dry-system', branch: 'master', require: false
-  gem 'warning'
-end
-
-group :tools do
-  gem 'pry-byebug', platform: :mri
-end
-
-gem 'dry-struct'
-gem 'dry-monads'

data/Gemfile.devtools

@@ -1,14 +0,0 @@
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gem "ossy", github: "solnic/ossy", branch: "master", platforms: :ruby
-
-group :test do
-  gem 'codacy-coverage', require: false, platforms: :ruby
-  gem 'simplecov', require: false, platforms: :ruby
-  gem 'warning'
-end
-
-group :tools do
-  # this is the same version that we use on codacy
-  gem 'rubocop', '0.71.0'
-end

data/Rakefile

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

data/docsite/source/effects.html.md

@@ -1,29 +0,0 @@
----
-title: Effects
-layout: gem-single
-name: dry-effects
-sections:
-  - reader
-  - state
-  - resolve
-  - cache
-  - current_time
-  - env
-  - interrupt
-  - defer
-  - timeout
-  - parallel
----
-
-`dry-effects` has a bunch of built-in effects and providers:
-
-- [Reader](/gems/dry-effects/0.1/effects/reader)
-- [State](/gems/dry-effects/0.1/effects/state)
-- [Resolve (Dependency Injection)](/gems/dry-effects/0.1/effects/resolve)
-- [Cache](/gems/dry-effects/0.1/effects/cache)
-- [Current Time](/gems/dry-effects/0.1/effects/current_time)
-- [Environment](/gems/dry-effects/0.1/effects/env)
-- [Interrupt](/gems/dry-effects/0.1/effects/interrupt)
-- [Deferred Execution](/gems/dry-effects/0.1/effects/defer)
-- [Timeout](/gems/dry-effects/0.1/effects/timeout)
-- [Parallel execution](/gems/dry-effects/0.1/effects/parallel)

data/docsite/source/effects/cache.html.md

@@ -1,84 +0,0 @@
----
-title: Cache
-layout: gem-single
-name: dry-effects
----
-
-Cache provides two interfaces for caching. Set up a handler:
-
-```ruby
-require 'dry/effects'
-
-class CacheMiddleware
-  # Providing scope is required
-  # All cache values will be scoped with this key
-  include Dry::Effects::Handler.Cache(:blog)
-
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    with_cache { @app.env }
-  end
-end
-```
-
-Using `prepend`:
-
-```ruby
-require 'dry/effects'
-
-class ShowUsers
-  include Dry::Effects.Resolve(:user_repo)
-  # It will cache .find_user calls
-  # Users with the same id won't be searched twice
-  # Effectively (no pun intended),
-  # it's `memoize` scoped with the call in CacheMiddleware
-  prepend Dry::Effects.Cache(blog: :find_user)
-
-  def call(user_ids)
-    users = user_ids.map { find_user(id) }
-    # ...
-  end
-
-  def find_user(id)
-    user_repo.find(id)
-  end
-end
-```
-
-Or using `include`:
-
-```ruby
-require 'dry/effects'
-
-class ShowUsers
-  include Dry::Effects.Resolve(:user_repo)
-  # When included, adds #cache method
-  include Dry::Effects.Cache(:blog)
-
-  def call(user_ids)
-    users = user_ids.map { cache(:user, id) { user_repo.find(id) } }
-    # ...
-  end
-end
-```
-
-### Cache longevity
-
-The default cache handler doesn't (yet) support long-lived storage. Cache values are discarded once `with_cache` returns.
-
-### Using in tests
-
-It's usually OK to have a global handler for cache effects:
-
-```ruby
-require 'dry/effects'
-
-with_cache = Object.new.extend(Dry::Effects::Handler.Cache(:my_app, as: :call))
-
-RSpec.configure do |config|
-  config.around(:each) { with_cache.(&ex) }
-end
-```

data/docsite/source/effects/current_time.html.md

@@ -1,186 +0,0 @@
----
-title: Current Time
-layout: gem-single
-name: dry-effects
----
-
-Obtaining the current time with `Time.now` is a classic example of a side effect. Code relying on accessing system time is harder to test. One possible solution is passing time around explicitly, but using effects can save you some typing depending on the case.
-
-Providing and obtaining the current time is straightforward:
-
-```ruby
-require 'dry/effects'
-
-class CurrentTimeMiddleware
-  include Dry::Effects::Handler.CurrentTime
-
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    # It will use Time.now internally once and set it fixed
-    with_current_time do
-      @app.(env)
-    end
-  end
-end
-
-###
-
-class CreateSubscription
-  include Dry::Effects.Resolve(:subscription_repo)
-  include Dry::Effects.CurrentTime
-
-  def call(values)
-    subscription_repo.create(
-      values.merge(start_at: current_time)
-    )
-  end
-end
-```
-
-### Providing time in tests
-
-A typical usage would be:
-
-```ruby
-require 'dry/effects'
-
-RSpec.configure do |config|
-  config.include Dry::Effects::Handler.CurrentTime
-  config.include Dry::Effects.CurrentTime
-
-  config.around { |ex| with_current_time(&ex) }
-end
-```
-
-Then anywhere in tests, you can use it:
-
-```ruby
-it 'uses current time as a start' do
-  subscription = create_subscription(...)
-  expect(subscription.start_at).to eql(current_time)
-end
-```
-
-To change the time, call `with_current_time` with a proc:
-
-```ruby
-it 'closes a subscription with current time' do
-  future = current_time + 86_400
-  closed_subscription = with_current_time(proc { future }) { close_subscription(subscription) }
-  expect(closed_subscription.closed_at).to eql(future)
-end
-```
-
-Wrapping time with a proc is required, read about generators below.
-
-### Time rounding
-
-`current_time` accepts an argument for rounding time values. It can be passed statically to the module builder or dynamically to the effect constructor:
-
-```ruby
-class CreateSubscription
-  include Dry::Effects.CurrentTime(round: 3)
-
-  def call(...)
-    # value will be rounded to milliseconds
-    current_time
-    # value will be rounded to microseconds
-    current_time(round: 6)
-  end
-end
-```
-
-### Time is fixed
-
-By default, calling `with_current_time` even without arguments will freeze the current time. This means `current_time` will return the same value during request processing etc.
-
-You can "unfix" time with passing `fixed: false` to the handler builder:
-
-```ruby
-include Dry::Effects::Handler.CurrentTime(fixed: false)
-```
-
-However, this is not recommended because it will make the behavior of `current_time` different in tests (where you pass a fixed value) and in a production environment.
-
-### Using a custom generator
-
-The default time provider accepts a custom generator which is a simple callable object. This way you can pass a proc with fixed time:
-
-```ruby
-frozen = Time.now
-with_fixed_time(proc { frozen }) do
-  # ...
-end
-```
-
-Or you can change time on every call:
-
-```ruby
-start = Time.now
-with_fixed_time(proc { start += 0.1 }) do
-  # ...
-end
-```
-
-### Discrete time shifts
-
-If you pass `step: x` to the handler, it will shift the current time on every access by `x`:
-
-```ruby
-with_fixed_time(step: 0.1) do
-  current_time # => ... 18:00:00.000
-  current_time # => ... 18:00:00.100
-  current_time # => ... 18:00:00.200
-end
-```
-
-You can also pass initial time:
-
-```ruby
-initial = Time.new(1970)
-with_fixed_time(initial: initial, step: 60) do
-  current_time # => 1970-01-01 00:00:00 +0000
-  current_time # => 1970-01-01 00:01:00 +0000
-  current_time # => 1970-01-01 00:02:00 +0000
-end
-```
-
-### Overriding handlers
-
-Handlers of current time can be overridden by an outer handler if you pass `overridable: true`:
-
-```ruby
-require 'dry/effects'
-
-class CurrentTimeMiddleware
-  include Dry::Effects::Handler.CurrentTime
-
-  def initialize(app)
-    @app = app
-  end
-
-  def call(env)
-    with_current_time(overridable: ENV['RACK_ENV'].eql?('test')) do
-      @app.(env)
-    end
-  end
-end
-```
-
-It's usually done in tests:
-
-```ruby
-# Using global time
-frozen_time = Time.now
-
-puts "Running with time #{frozen_time.iso8601}" if ENV['CI']
-
-RSpec.configure do |config|
-  config.include Dry::Effects::Handler.CurrentTime
-  config.include(Module.new { define_method(:current_time) { frozen_time } })
-  config.around { |ex| with_current_time(proc { frozen_time }, &ex) }
-end
-```