dry-monads-sorbet 1.1.0.pre.8 → 1.1.0.pre.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3704faf9058a337f617d13a61127c3dcb960736ca41e5376fad4789db361d0f7
-  data.tar.gz: f783228f5f4614bab5478825e2cad5204bfaf70b63f747df036e0e051a0b2fdd
+  metadata.gz: 04a3a1d08e8732376ec9f1fb820d8bd8211f95e3d2c36f61ccb36d3895643ff7
+  data.tar.gz: 2d308920e2f8224710bafb3b71b28829ccd2af99379dfc90ca62fb7bf6a4bdde
 SHA512:
-  metadata.gz: ae16dc69ba60bd8fa11f6b6d60826a9c067582817fb9b064c05b732c5a9283b1f452112557a6fd3e6fb8511ccdbe0c315f0d6fcff3222a847f8a8119b033ee3b
-  data.tar.gz: 97b657d04c751aecfedb2b950e5c92600b882b7b9923da41b428a2798af1bbc8253d3112e70a7eb0014628a91bd117d7dec467ffa38842780255c86e7aee2add
+  metadata.gz: 7c71b2d4dbf65bb0011c344cadd72455dbb0b52ceb69ea781d12e2b0a5c5671adac2c78b1f1a032080032950977a796dc9652173cc5ba814dbb8c14fd2589af7
+  data.tar.gz: 3721a8426800c630dff2051f1de6118903f8af70d6e57eed87457c0600cdff419ccbadf6b4f4ad1f47c5b9fb220fb5f0f20dbb00fed3e57c8d9e15456920822b

data/README.md

@@ -4,10 +4,40 @@
 
 Sorbet type hints for Dry::Monads.
 
-## Install
+## Installation
+
+Add the gem to your Gemfile:
 
 `gem 'dry-monads-sorbet'`
 
+### Copying the bundled RBI
+
+You must copy in the bundled `.rbi` file that this gem maintains to add type annotations to your own project to type check your usage of `Dry::Monads`.
+
+Following in the footsteps of `sorbet-rails` we've extracted this process to a rake task.
+
+### In a Rails project:
+
+The rake task that copies the bundled `.rbi` files into your project should already be loaded. You can run it by entering:
+
+```bash
+bundle exec rake dry_monads_sorbet:update_rbi
+```
+
+### Outside of Rail's projects:
+
+Include the `Rakefile` in your own projects `Rakefile` to get access to the rbi update command:
+
+```ruby
+require 'dry-monads-sorbet'
+
+spec = Gem::Specification.find_by_name 'dry-monads-sorbet'
+rakefile = "#{spec.gem_dir}/lib/dry-monads-sorbet/Rakefile"
+load rakefile
+```
+
+After including the Rakefile you should then have access to the task as described in the Rails project section.
+
 ## Usage
 
 ```ruby

data/{rbi/dry-monads-sorbet.rbi → lib/bundled_rbi/dry-monads.rbi}

@@ -1,7 +1,11 @@
 # typed: strong
 #
-# dry-monads-1.3.1
+# This rbi file is bundled in the dry-monads-sorbet gem and is copied down
+# into projects using the dry_monads_sorbet:update_rbi rake task.
 #
+# Any changes to the type annotations for Dry::Monads should be made
+# in the dry-monads-sorbet gem itself in its bundled_rbi directory.
+
 module Dry
 end
 module Dry::Monads
@@ -594,3 +598,512 @@ class Dry::Monads::Result::Fixed < Module
   def initialize(error, **options); end
   def self.[](error, **options); end
 end
+# This file is autogenerated. Do not edit it by hand. Regenerate it with:
+#   srb rbi gems
+
+# typed: true
+#
+# If you would like to make changes to this file, great! Please create the gem's shim here:
+#
+#   https://github.com/sorbet/sorbet-typed/new/master?filename=lib/dry-monads/all/dry-monads.rbi
+#
+# dry-monads-1.3.5
+module Dry
+end
+module Dry::Monads
+  def self.Result(error, **options); end
+  def self.[](*monads); end
+  def self.all_loaded?; end
+  def self.constructors; end
+  def self.included(base); end
+  def self.known_monads; end
+  def self.load_monad(name); end
+  def self.register_mixin(name, mod); end
+  def self.registry; end
+  def self.registry=(registry); end
+  extend Dry::Monads::Maybe::Mixin::Constructors
+  extend Dry::Monads::Maybe::Mixin::Constructors
+  extend Dry::Monads::Result::Mixin::Constructors
+  extend Dry::Monads::Validated::Mixin::Constructors
+  include Dry::Core::Constants
+end
+module Dry::Monads::Curry
+  def self.call(value); end
+end
+class Dry::Monads::UnwrapError < StandardError
+  def initialize(ctx); end
+end
+class Dry::Monads::InvalidFailureTypeError < StandardError
+  def initialize(failure); end
+end
+class Dry::Monads::ConstructorNotAppliedError < NoMethodError
+  def initialize(method_name, constructor_name); end
+end
+module Dry::Monads::RightBiased
+end
+module Dry::Monads::RightBiased::Right
+  def ===(other); end
+  def and(mb); end
+  def apply(val = nil); end
+  def bind(*args, **kwargs); end
+  def curry; end
+  def deconstruct; end
+  def deconstruct_keys(keys); end
+  def destructure(*args, **kwargs); end
+  def discard; end
+  def flatten; end
+  def fmap(*arg0); end
+  def or(*arg0); end
+  def or_fmap(*arg0); end
+  def self.included(m); end
+  def tee(*args, &block); end
+  def value!; end
+  def value_or(_val = nil); end
+end
+module Dry::Monads::RightBiased::Left
+  def and(_); end
+  def apply(*arg0); end
+  def bind(*arg0); end
+  def deconstruct; end
+  def deconstruct_keys(keys); end
+  def discard; end
+  def flatten; end
+  def fmap(*arg0); end
+  def or(*arg0); end
+  def or_fmap(*arg0); end
+  def self.trace_caller; end
+  def tee(*arg0); end
+  def value!; end
+  def value_or(val = nil); end
+end
+module Dry::Monads::Transformer
+  def fmap2(*args); end
+  def fmap3(*args); end
+end
+class Dry::Monads::Maybe
+  def failure?; end
+  def monad; end
+  def none?; end
+  def self.coerce(value); end
+  def self.lift(*args, &block); end
+  def self.pure(value = nil, &block); end
+  def self.to_proc; end
+  def some?; end
+  def success?; end
+  def to_maybe; end
+  def to_monad; end
+  include Dry::Monads::Transformer
+end
+class Dry::Monads::Maybe::Some < Dry::Monads::Maybe
+  def fmap(*args, &block); end
+  def initialize(value = nil); end
+  def inspect; end
+  def maybe(*args, &block); end
+  def self.[](*value); end
+  def self.call(*arg0); end
+  def self.to_proc; end
+  def to_result(_fail = nil); end
+  def to_s; end
+  include Anonymous_Dry_Equalizer_40
+  include Dry::Equalizer::Methods
+  include Dry::Monads::RightBiased::Right
+end
+module Anonymous_Dry_Equalizer_40
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+class Dry::Monads::Maybe::None < Dry::Monads::Maybe
+  def ==(other); end
+  def deconstruct; end
+  def eql?(other); end
+  def hash; end
+  def initialize(trace = nil); end
+  def inspect; end
+  def maybe(*arg0); end
+  def or(*args); end
+  def or_fmap(*args, &block); end
+  def self.instance; end
+  def self.method_missing(m, *arg1); end
+  def to_result(fail = nil); end
+  def to_s; end
+  def trace; end
+  include Dry::Monads::RightBiased::Left
+end
+module Dry::Monads::Maybe::Mixin
+  include Dry::Monads::Maybe::Mixin::Constructors
+end
+module Dry::Monads::Maybe::Mixin::Constructors
+  def Maybe(value); end
+  def None; end
+  def Some(value = nil, &block); end
+end
+module Dry::Monads::Maybe::Hash
+  def self.all(hash, trace = nil); end
+  def self.filter(hash); end
+end
+class Dry::Monads::Result
+  def failure; end
+  def monad; end
+  def self.pure(value = nil, &block); end
+  def success; end
+  def to_monad; end
+  def to_result; end
+  include Anonymous_Module_41
+  include Dry::Monads::Transformer
+end
+class Dry::Monads::Result::Success < Dry::Monads::Result
+  def either(f, _); end
+  def failure?; end
+  def flip; end
+  def fmap(*args, &block); end
+  def initialize(value); end
+  def inspect; end
+  def result(_, f); end
+  def self.[](*value); end
+  def self.call(*arg0); end
+  def self.to_proc; end
+  def success; end
+  def success?; end
+  def to_maybe; end
+  def to_s; end
+  def to_validated; end
+  include Anonymous_Dry_Equalizer_42
+  include Dry::Equalizer::Methods
+  include Dry::Monads::RightBiased::Right
+end
+class Dry::Monads::Result::Failure < Dry::Monads::Result
+  def ===(other); end
+  def either(_, g); end
+  def failure; end
+  def failure?; end
+  def flip; end
+  def initialize(value, trace = nil); end
+  def inspect; end
+  def or(*args); end
+  def or_fmap(*args, &block); end
+  def result(f, _); end
+  def self.[](*value); end
+  def self.call(*arg0); end
+  def self.to_proc; end
+  def success?; end
+  def to_maybe; end
+  def to_s; end
+  def to_validated; end
+  def trace; end
+  def value_or(val = nil); end
+  include Anonymous_Dry_Equalizer_43
+  include Dry::Equalizer::Methods
+  include Dry::Monads::RightBiased::Left
+end
+class Dry::Monads::Task
+  def ==(other); end
+  def apply(val = nil); end
+  def bind(&block); end
+  def compare_promises(x, y); end
+  def complete?; end
+  def curry(value); end
+  def discard; end
+  def fmap(&block); end
+  def initialize(promise); end
+  def inspect; end
+  def monad; end
+  def or(&block); end
+  def or_fmap(&block); end
+  def promise; end
+  def self.[](executor, &block); end
+  def self.failed(exc); end
+  def self.new(promise = nil, &block); end
+  def self.pure(value = nil, &block); end
+  def then(&block); end
+  def to_maybe; end
+  def to_monad; end
+  def to_result; end
+  def to_s; end
+  def value!; end
+  def value_or(&block); end
+  def wait(timeout = nil); end
+  include Anonymous_Module_44
+end
+class Dry::Monads::Try
+  def error?; end
+  def exception; end
+  def failure?; end
+  def self.[](*exceptions, &block); end
+  def self.lift(*args, &block); end
+  def self.pure(value = nil, exceptions = nil, &block); end
+  def self.run(exceptions, f); end
+  def success?; end
+  def to_monad; end
+  def value?; end
+  include Anonymous_Module_45
+end
+class Dry::Monads::Try::Value < Dry::Monads::Try
+  def bind(*args); end
+  def bind_call(*args, **kwargs); end
+  def catchable; end
+  def fmap(*args, &block); end
+  def initialize(exceptions, value); end
+  def inspect; end
+  def self.call(*arg0); end
+  def self.to_proc; end
+  def to_maybe; end
+  def to_result; end
+  def to_s; end
+  include Anonymous_Dry_Equalizer_46
+  include Dry::Equalizer::Methods
+  include Dry::Monads::RightBiased::Right
+end
+class Dry::Monads::Try::Error < Dry::Monads::Try
+  def ===(other); end
+  def initialize(exception); end
+  def inspect; end
+  def or(*args); end
+  def self.call(*arg0); end
+  def to_maybe; end
+  def to_result; end
+  def to_s; end
+  include Anonymous_Dry_Equalizer_47
+  include Dry::Equalizer::Methods
+  include Dry::Monads::RightBiased::Left
+end
+class Dry::Monads::Validated
+  def bind(*arg0); end
+  def self.pure(value = nil, &block); end
+  def to_monad; end
+  include Anonymous_Module_48
+end
+class Dry::Monads::Validated::Valid < Dry::Monads::Validated
+  def ===(other); end
+  def alt_map(_ = nil); end
+  def apply(val = nil); end
+  def fmap(proc = nil, &block); end
+  def initialize(value); end
+  def inspect; end
+  def or(_ = nil); end
+  def to_maybe; end
+  def to_result; end
+  def to_s; end
+  def value!; end
+  include Anonymous_Dry_Equalizer_49
+  include Dry::Equalizer::Methods
+end
+class Dry::Monads::Validated::Invalid < Dry::Monads::Validated
+  def ===(other); end
+  def alt_map(proc = nil, &block); end
+  def apply(val = nil); end
+  def error; end
+  def fmap(_ = nil); end
+  def initialize(error, trace = nil); end
+  def inspect; end
+  def or(proc = nil, &block); end
+  def to_maybe; end
+  def to_result; end
+  def to_s; end
+  def trace; end
+  include Anonymous_Dry_Equalizer_50
+  include Dry::Equalizer::Methods
+end
+module Dry::Monads::ConversionStubs
+  def self.[](*method_names); end
+end
+module Dry::Monads::ConversionStubs::Methods
+  def self.to_maybe; end
+  def self.to_result; end
+  def self.to_validated; end
+  def to_maybe; end
+  def to_result; end
+  def to_validated; end
+end
+class Dry::Monads::Task::Promise < Concurrent::Promise
+  def on_fulfill(result); end
+  def on_reject(reason); end
+end
+module Anonymous_Module_44
+  def to_maybe(*arg0); end
+  def to_result(*arg0); end
+end
+module Dry::Monads::Task::Mixin
+  def self.[](executor); end
+  include Dry::Monads::Task::Mixin::Constructors
+end
+module Dry::Monads::Task::Mixin::Constructors
+  def Task(&block); end
+end
+module Anonymous_Module_41
+  def to_maybe(*arg0); end
+  def to_validated(*arg0); end
+end
+module Anonymous_Dry_Equalizer_42
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Anonymous_Dry_Equalizer_43
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Dry::Monads::Result::Mixin
+  include Dry::Monads::Result::Mixin::Constructors
+end
+module Dry::Monads::Result::Mixin::Constructors
+  def Failure(value = nil, &block); end
+  def Success(value = nil, &block); end
+end
+module Anonymous_Module_45
+  def to_maybe(*arg0); end
+  def to_result(*arg0); end
+end
+module Anonymous_Dry_Equalizer_46
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Anonymous_Dry_Equalizer_47
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Dry::Monads::Try::Mixin
+  def Error(error = nil, &block); end
+  def Value(value = nil, exceptions = nil, &block); end
+  include Dry::Monads::Try::Mixin::Constructors
+end
+module Dry::Monads::Try::Mixin::Constructors
+  def Try(*exceptions, &f); end
+end
+module Anonymous_Module_48
+  def to_maybe(*arg0); end
+  def to_result(*arg0); end
+end
+module Anonymous_Dry_Equalizer_49
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Anonymous_Dry_Equalizer_50
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Dry::Monads::Validated::Mixin
+  include Dry::Monads::Validated::Mixin::Constructors
+end
+module Dry::Monads::Validated::Mixin::Constructors
+  def Invalid(value = nil, &block); end
+  def Valid(value = nil, &block); end
+end
+class Dry::Monads::List
+  def +(other); end
+  def apply(list = nil); end
+  def bind(*args); end
+  def coerce(other); end
+  def collect; end
+  def deconstruct; end
+  def empty?; end
+  def filter; end
+  def first; end
+  def fmap(*args); end
+  def fold_left(initial); end
+  def fold_right(initial); end
+  def foldl(initial); end
+  def foldr(initial); end
+  def head; end
+  def initialize(value, type = nil); end
+  def inspect; end
+  def last; end
+  def map(&block); end
+  def monad; end
+  def reduce(initial); end
+  def reverse; end
+  def select; end
+  def self.[](*values); end
+  def self.coerce(value, type = nil); end
+  def self.pure(value = nil, type = nil, &block); end
+  def self.unfold(state, type = nil); end
+  def size; end
+  def sort; end
+  def tail; end
+  def to_a; end
+  def to_ary; end
+  def to_monad; end
+  def to_s; end
+  def traverse(proc = nil, &block); end
+  def type; end
+  def typed(type = nil); end
+  def typed?; end
+  def value; end
+  extend Anonymous_Dry_Core_Deprecations_Tagged_51
+  extend Dry::Core::Deprecations::Interface
+  include Anonymous_Dry_Equalizer_52
+  include Dry::Equalizer::Methods
+  include Dry::Monads::Transformer
+end
+module Anonymous_Dry_Core_Deprecations_Tagged_51
+end
+module Anonymous_Dry_Equalizer_52
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+class Dry::Monads::List::ListBuilder
+  def [](*args); end
+  def coerce(value); end
+  def initialize(type); end
+  def pure(val = nil, &block); end
+  def self.[](*arg0); end
+  def type; end
+end
+module Dry::Monads::List::Mixin
+  def List(value); end
+end
+module Dry::Monads::Do
+  def self.coerce_to_monad(monads); end
+  def self.for(*methods); end
+  def self.halt(result); end
+  def self.included(base); end
+  def self.wrap_method(target, method_name); end
+  extend Dry::Monads::Do::Mixin
+end
+module Dry::Monads::Do::Mixin
+  def bind(monads); end
+  def call; end
+end
+class Dry::Monads::Do::Halt < StandardError
+  def initialize(result); end
+  def result; end
+end
+module Dry::Monads::Do::All
+  def self.included(base); end
+  extend Dry::Monads::Do::All::InstanceMixin
+end
+class Dry::Monads::Do::All::MethodTracker < Module
+  def extend_object(target); end
+  def initialize(wrappers); end
+  def wrap_method(target, method); end
+  def wrappers; end
+end
+module Dry::Monads::Do::All::InstanceMixin
+  def extended(object); end
+end
+class Dry::Monads::Lazy < Dry::Monads::Task
+  def force!; end
+  def force; end
+  def inspect; end
+  def self.[](executor, &block); end
+  def self.new(promise = nil, &block); end
+  def to_s; end
+  def value!; end
+end
+module Dry::Monads::Lazy::Mixin
+  include Dry::Monads::Lazy::Mixin::Constructors
+end
+module Dry::Monads::Lazy::Mixin::Constructors
+  def Lazy(&block); end
+end
+class Dry::Monads::Result::Fixed < Module
+  def included(base); end
+  def initialize(error, **_options); end
+  def self.[](error, **options); end
+end

data/lib/dry-monads-sorbet.rb

@@ -2,3 +2,4 @@
 
 require 'dry/monads/all'
 require 'dry/monads/sorbet'
+require 'dry-monads-sorbet/railtie' if defined?(Rails)

data/lib/dry-monads-sorbet/Rakefile

@@ -0,0 +1,2 @@
+path = File.expand_path(__dir__)
+Dir.glob("#{path}/tasks/**/*.rake").each { |f| import f }

data/lib/dry-monads-sorbet/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module DryMonadsSorbet
+  class Railtie < Rails::Railtie
+    railtie_name 'dry-monads-sorbet'
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/dry-monads-sorbet/tasks/dry_monads_sorbet.rake

@@ -0,0 +1,25 @@
+require 'dry-monads-sorbet'
+require 'pathname'
+
+DRY_MONADS_SORBET_RAKE_DIR  = File.dirname(__FILE__)
+
+namespace :dry_monads_sorbet do
+  desc "Generate rbis for dry/monads"
+  task :update_rbi do
+    FileUtils.rm_rf(dry_monads_sorbet_rbi_path)
+
+    copy_bundled_rbi('dry-monads.rbi')
+  end
+
+  def dry_monads_sorbet_rbi_path
+    Pathname.new(Rake.original_dir).join('sorbet', 'dry-monads-sorbet')
+  end
+
+  def copy_bundled_rbi(filename)
+    bundled_rbi_file_path = File.join(DRY_MONADS_SORBET_RAKE_DIR, '..', '..', 'bundled_rbi', filename)
+    copy_to_path = dry_monads_sorbet_rbi_path.join(filename)
+    FileUtils.mkdir_p(File.dirname(copy_to_path))
+    FileUtils.cp(bundled_rbi_file_path, copy_to_path)
+    puts "Copied bundled rbi file: #{filename}"
+  end
+end

data/lib/dry/monads/sorbet/version.rb

@@ -3,7 +3,7 @@
 module Dry
   module Monads
     module Sorbet
-      VERSION = '1.1.0.pre.8'
+      VERSION = '1.1.0.pre.13'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-monads-sorbet
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre.8
+  version: 1.1.0.pre.13
 platform: ruby
 authors:
 - Luke Worth
@@ -129,10 +129,13 @@ files:
 - bin/console
 - bin/setup
 - dry-monads-sorbet.gemspec
+- lib/bundled_rbi/dry-monads.rbi
 - lib/dry-monads-sorbet.rb
+- lib/dry-monads-sorbet/Rakefile
+- lib/dry-monads-sorbet/railtie.rb
+- lib/dry-monads-sorbet/tasks/dry_monads_sorbet.rake
 - lib/dry/monads/sorbet.rb
 - lib/dry/monads/sorbet/version.rb
-- rbi/dry-monads-sorbet.rbi
 homepage: https://github.com/tricycle/dry-monads-sorbet
 licenses:
 - MIT