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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a3a1d08e8732376ec9f1fb820d8bd8211f95e3d2c36f61ccb36d3895643ff7
-  data.tar.gz: 2d308920e2f8224710bafb3b71b28829ccd2af99379dfc90ca62fb7bf6a4bdde
+  metadata.gz: 3c5965a0f167ece1beaf05b22c473323d653e4b6c34600b01890127264186368
+  data.tar.gz: 290798ca858d2101ead489df61ba3321eebad985145ac19f04aa78bd810ef9ff
 SHA512:
-  metadata.gz: 7c71b2d4dbf65bb0011c344cadd72455dbb0b52ceb69ea781d12e2b0a5c5671adac2c78b1f1a032080032950977a796dc9652173cc5ba814dbb8c14fd2589af7
-  data.tar.gz: 3721a8426800c630dff2051f1de6118903f8af70d6e57eed87457c0600cdff419ccbadf6b4f4ad1f47c5b9fb220fb5f0f20dbb00fed3e57c8d9e15456920822b
+  metadata.gz: 45cf68ceaed400c7b1baed20b7085cfc664ea4a1e554a9078a55b5d7252ca391a8011155482fa6165ca5530c92d402b55a38e30489016a79ea26277d5514bdb3
+  data.tar.gz: b56702acd5840bf58fbfcff813ce4bf954d7967b9882f614af9261a8e6367baed03ea445bea5adc40e467ec5ea81924b3dee32761c464fbf990a9d83ce0508d2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+1.1.0
+
+* Now shipping the rbi bundled with the gem with a rake task to update this as/when we update the gem.
+
 1.0.0
 
 * Initial release

data/README.md

@@ -4,6 +4,11 @@
 
 Sorbet type hints for Dry::Monads.
 
+This gem is very small, it opens up the `Dry::Monads::Result` and `Dry::Monads::Maybe` classes to add type members
+that are subsequently referred to in a bundled `.rbi` file for the `dry-monads` gem.
+
+The bundled rbi annotations are installed/updated via a rake task included in the gem.
+
 ## Installation
 
 Add the gem to your Gemfile:
@@ -24,7 +29,7 @@ The rake task that copies the bundled `.rbi` files into your project should alre
 bundle exec rake dry_monads_sorbet:update_rbi
 ```
 
-### Outside of Rail's projects:
+### Outside of Rails projects:
 
 Include the `Rakefile` in your own projects `Rakefile` to get access to the rbi update command:
 
@@ -40,13 +45,36 @@ After including the Rakefile you should then have access to the task as describe
 
 ## Usage
 
+Usage is fairly simple, just annotate your methods as follows:
+
 ```ruby
 require 'dry/monads/sorbet'
 
-class MyClass
+class MyLoginService
   extend T::Sig
 
-  sig{returns(Dry::Monads::Result[StandardError, String])}
-  def my_result
-  ...
+  sig{params(username: String).returns(Dry::Monads::Result[StandardError, String])}
+  def check_username(username)
+    case username
+    when 'samuelgiles93'
+      Dry::Monads::Success('Hi Sam!')
+    else
+      Dry::Monads::Failure(
+        StandardError.new('Unauthorised')
+      )
+    end
+  end
+
+  sig{params(username: String).returns(Dry::Monads::Maybe[Integer])}
+  def find_fullname(username)
+    case username
+    when 'samuelgiles93'
+      Dry::Monads::Some('Samuel Giles')
+    else
+      Dry::Monads::None()
+    end
+  end
+end
 ```
+
+With the type annotations in place you'll get type errors when you attempt to say call a method that doesn't exist on the `Some` of a `Maybe` or the `Success` of a `Result`.

data/dry-monads-sorbet.gemspec

@@ -21,6 +21,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.post_install_message = <<~TEXT
+    dry-monads-sorbet has been installed/updated.
+
+    This gem ships with a bundled rbi file that must be copied into your project.
+    You can use the included "dry_monads_sorbet:update_rbi" to do this.
+  TEXT
 
   spec.add_dependency 'sorbet'
   spec.add_dependency 'sorbet-runtime'

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

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

data/rbi/dry-monads.rbi

@@ -0,0 +1,593 @@
+# typed: strong
+#
+# dry-monads-1.3.1
+#
+# Note: This file depends on dry/monads/sorbet to define generics.
+
+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
+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::Transformer
+  def fmap2(*args); end
+  def fmap3(*args); end
+end
+class Dry::Monads::Maybe
+  extend T::Helpers
+  abstract!
+  sealed!
+
+  sig do
+    type_parameters(:New)
+      .params(blk: T.proc.params(arg0: Elem).returns(Dry::Monads::Maybe[T.type_parameter(:out, :New)]))
+      .returns(Dry::Monads::Maybe[T.type_parameter(:out, :New)])
+  end
+  def bind(&blk); end
+
+  sig do
+    type_parameters(:New)
+      .params(blk: T.proc.params(arg0: Elem).returns(T.type_parameter(:out, :New)))
+      .returns(Dry::Monads::Maybe[T.type_parameter(:out, :New)])
+  end
+  def fmap(&blk); end
+
+  sig do
+    params(val: T.any(Elem, NilClass),
+           blk: T.nilable(T.proc.returns(Elem)))
+      .returns(Elem)
+  end
+  def value_or(val = nil, &blk); end
+
+  sig do
+    params(arg0: T.untyped)
+      .returns(T.self_type)
+  end
+  def or(*arg0); end
+
+  sig do
+    type_parameters(:Error)
+      .params(val: T.nilable(T.type_parameter(:Error)),
+              blk: T.nilable(T.proc.returns(T.type_parameter(:Error))))
+      .returns(Dry::Monads::Result[T.type_parameter(:out, :Error), Elem])
+  end
+  def to_result(val = nil, &blk); end
+
+  sig {returns(T::Boolean)}
+  def failure?; end
+  def monad; end
+
+  sig {returns(T::Boolean)}
+  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
+
+  sig {returns(T::Boolean)}
+  def some?; end
+
+  sig {returns(T::Boolean)}
+  def success?; end
+  def to_maybe; end
+  def to_monad; end
+  include Dry::Monads::Transformer
+end
+class Dry::Monads::Maybe::Some < Dry::Monads::Maybe
+  extend T::Sig
+  extend T::Generic
+  Elem = type_member
+
+  sig {params(value: Elem).void}
+  def initialize(value = nil); end
+
+  sig do
+    returns(Elem)
+  end
+  def value!; 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_s; end
+  include Anonymous_Dry_Equalizer_33
+  include Dry::Equalizer::Methods
+end
+module Anonymous_Dry_Equalizer_33
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+class Dry::Monads::Maybe::None < Dry::Monads::Maybe
+  extend T::Sig
+  extend T::Generic
+  Elem = type_member
+
+  def ==(other); end
+  def deconstruct; end
+  def eql?(other); end
+  def hash; end
+  sig {params().void}
+  def initialize(); 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_s; end
+  def trace; end
+  include Dry::Core::Constants
+end
+module Dry::Monads::Maybe::Mixin
+  include Dry::Monads::Maybe::Mixin::Constructors
+end
+module Dry::Monads::Maybe::Mixin::Constructors
+  sig {type_parameters(:T).params(value: T.nilable(T.type_parameter(:T))).returns(Dry::Monads::Maybe[T.type_parameter(:T)])}
+  def Maybe(value); end
+  sig {type_parameters(:T).params().returns(Dry::Monads::Maybe[T.type_parameter(:out, :T)])}
+  def None; end
+  sig {type_parameters(:T).params(value: T.type_parameter(:T)).returns(Dry::Monads::Maybe[T.type_parameter(:T)])}
+  def Some(value = nil); end
+end
+module Dry::Monads::Maybe::Hash
+  def self.all(hash, trace = nil); end
+  def self.filter(hash); end
+end
+class Dry::Monads::Result
+  extend T::Helpers
+  abstract!
+  sealed!
+
+  sig do
+    type_parameters(:NewSuccessType)
+      .params(blk: T.proc.params(arg0: SuccessType).returns(Dry::Monads::Result[FailureType, T.type_parameter(:out, :NewSuccessType)]))
+      .returns(Dry::Monads::Result[FailureType, T.type_parameter(:out, :NewSuccessType)])
+  end
+  def bind(&blk); end
+
+  sig do
+    type_parameters(:New)
+      .params(blk: T.proc.params(arg0: SuccessType).returns(T.type_parameter(:out, :New)))
+      .returns(Dry::Monads::Result[FailureType, T.type_parameter(:out, :New)])
+  end
+  def fmap(&blk); end
+
+  sig do
+    type_parameters(:Val)
+      .params(val: T.nilable(T.type_parameter(:Val)), blk: T.nilable(T.proc.params(arg0: FailureType).returns(T.type_parameter(:Val))))
+      .returns(T.any(SuccessType, T.type_parameter(:Val)))
+  end
+  def value_or(val = nil, &blk); end
+
+  sig do
+    returns(SuccessType)
+  end
+  def value!; end
+  def to_maybe; end
+  def either(f, _); end
+
+  sig {returns(T::Boolean)}
+  def success?; end
+
+  sig {returns(T::Boolean)}
+  def failure?; end
+
+  sig {returns(FailureType)}
+  def failure; end
+
+  sig do
+    params(blk: T.proc.params(arg0: FailureType).returns(Dry::Monads::Result[FailureType, SuccessType]))
+      .returns(Dry::Monads::Result[FailureType, SuccessType])
+  end
+  def or(&blk); 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_34
+  include Dry::Monads::Transformer
+end
+class Dry::Monads::Result::Success < Dry::Monads::Result
+  extend T::Sig
+  extend T::Generic
+  FailureType = type_member
+  SuccessType = type_member
+
+  def flip; 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 to_s; end
+  def to_validated; end
+  include Anonymous_Dry_Equalizer_35
+  include Dry::Equalizer::Methods
+end
+class Dry::Monads::Result::Failure < Dry::Monads::Result
+  extend T::Sig
+  extend T::Generic
+  FailureType = type_member
+  SuccessType = type_member
+
+  def ===(other); end
+  def failure; end
+  def flip; end
+  def initialize(value, trace = nil); end
+  def inspect; 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 to_s; end
+  def to_validated; end
+  def trace; end
+  def value_or(val = nil); end
+  include Anonymous_Dry_Equalizer_36
+  include Dry::Equalizer::Methods
+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_37
+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_38
+end
+class Dry::Monads::Try::Value < Dry::Monads::Try
+  extend T::Generic
+  FailureType = type_member
+  SuccessType = type_member
+
+  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_39
+  include Dry::Equalizer::Methods
+end
+class Dry::Monads::Try::Error < Dry::Monads::Try
+  extend T::Generic
+  FailureType = type_member
+  SuccessType = type_member
+
+  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_40
+  include Dry::Equalizer::Methods
+end
+class Dry::Monads::Validated
+  def bind(*arg0); end
+  def self.pure(value = nil, &block); end
+  def to_monad; end
+  include Anonymous_Module_41
+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_42
+  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_43
+  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_37
+  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_34
+  def to_maybe(*arg0); end
+  def to_validated(*arg0); end
+end
+module Anonymous_Dry_Equalizer_35
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Anonymous_Dry_Equalizer_36
+  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
+  sig do
+    type_parameters(:FailureType, :SuccessType)
+      .params(value: T.nilable(T.type_parameter(:FailureType)),
+              block: T.nilable(T.untyped))
+      .returns(Dry::Monads::Result[T.type_parameter(:FailureType),
+                                   T.type_parameter(:out, :SuccessType)])
+  end
+  def Failure(value = nil, &block); end
+
+  sig do
+    type_parameters(:FailureType, :SuccessType)
+      .params(value: T.nilable(T.type_parameter(:SuccessType)),
+              block: T.nilable(T.untyped))
+      .returns(Dry::Monads::Result[T.type_parameter(:out, :FailureType),
+                                   T.type_parameter(:SuccessType)])
+  end
+  def Success(value = nil, &block); end
+end
+module Anonymous_Module_38
+  def to_maybe(*arg0); end
+  def to_result(*arg0); end
+end
+module Anonymous_Dry_Equalizer_39
+  def cmp?(comparator, other); end
+  def hash; end
+  def inspect; end
+end
+module Anonymous_Dry_Equalizer_40
+  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_41
+  def to_maybe(*arg0); end
+  def to_result(*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::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_44
+  extend Dry::Core::Deprecations::Interface
+  include Anonymous_Dry_Equalizer_45
+  include Dry::Equalizer::Methods
+  include Dry::Monads::Transformer
+end
+module Anonymous_Dry_Core_Deprecations_Tagged_44
+end
+module Anonymous_Dry_Equalizer_45
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-monads-sorbet
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre.13
+  version: 1.1.0
 platform: ruby
 authors:
 - Luke Worth
@@ -136,11 +136,16 @@ files:
 - lib/dry-monads-sorbet/tasks/dry_monads_sorbet.rake
 - lib/dry/monads/sorbet.rb
 - lib/dry/monads/sorbet/version.rb
+- rbi/dry-monads.rbi
 homepage: https://github.com/tricycle/dry-monads-sorbet
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  dry-monads-sorbet has been installed/updated.
+
+  This gem ships with a bundled rbi file that must be copied into your project.
+  You can use the included "dry_monads_sorbet:update_rbi" to do this.
 rdoc_options: []
 require_paths:
 - lib
@@ -151,9 +156,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: