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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a3a1d08e8732376ec9f1fb820d8bd8211f95e3d2c36f61ccb36d3895643ff7
-  data.tar.gz: 2d308920e2f8224710bafb3b71b28829ccd2af99379dfc90ca62fb7bf6a4bdde
+  metadata.gz: d75d54ff6ec8c8f4d444a2a3edd7d301184eb0f4e4645c2a398f8697f99e62de
+  data.tar.gz: e1aff83742024ba30e3a1cbf57049927b3214c4cab3f0f1d7cace090224c0d33
 SHA512:
-  metadata.gz: 7c71b2d4dbf65bb0011c344cadd72455dbb0b52ceb69ea781d12e2b0a5c5671adac2c78b1f1a032080032950977a796dc9652173cc5ba814dbb8c14fd2589af7
-  data.tar.gz: 3721a8426800c630dff2051f1de6118903f8af70d6e57eed87457c0600cdff419ccbadf6b4f4ad1f47c5b9fb220fb5f0f20dbb00fed3e57c8d9e15456920822b
+  metadata.gz: 20da7ed4fd98c6929f6972c1445d245a0415de6bb84193cbe4a95acedbe61e6c4d1607591b52dc8580fb4dbf068b3af5a3557bd0b0d3aebe592af1b8c7f6afa7
+  data.tar.gz: ab2725e8f12568b1403c16a62a7a85efafaa80e4917531f0fd1a46c3f0a8503d3570bfbf2c4ed25ae3f7e68241fc3f125471dbea59dd4fa8a593c2c8830d4a80

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+1.1.4
+
+* Remove accidentally included autogenerated annotations from `dry-monads.rbi`.
+
+1.1.3
+
+* Fix missing type annotation for `Dry::Monads::Maybe#value!`.
+
+1.1.2
+
+* Fix an issue when used alongside `sorbet-rails`.
+
+1.1.1
+
+* Remove the accidentally bundled `/rbi` directory.
+
+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
+* Initial release.

data/README.md

@@ -1,9 +1,14 @@
 ![dry-monads-sorbet](https://user-images.githubusercontent.com/2643026/69986703-dfc68200-1535-11ea-9035-38ecbdb67138.png)
 
-# Dry Monads Sorbet ![CI Badge](https://github.com/tricycle/dry-monads-sorbet/workflows/RSpec%20Test%20Suite/badge.svg)
+# Dry Monads Sorbet ![CI Badge](https://github.com/tricycle/dry-monads-sorbet/workflows/Continuous%20Integration/badge.svg)
 
 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/bundled_rbi/dry-monads.rbi

@@ -71,6 +71,11 @@ class Dry::Monads::Maybe
   end
   def value_or(val = nil, &blk); end
 
+  sig do
+    returns(Elem)
+  end
+  def value!; end
+
   sig do
     params(arg0: T.untyped)
       .returns(T.self_type)
@@ -105,12 +110,6 @@ class Dry::Monads::Maybe::Some < Dry::Monads::Maybe
 
   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
@@ -595,515 +594,5 @@ module Dry::Monads::Lazy::Mixin::Constructors
 end
 class Dry::Monads::Result::Fixed < Module
   def included(base); end
-  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/tasks/dry_monads_sorbet.rake

@@ -8,14 +8,14 @@ namespace :dry_monads_sorbet do
   task :update_rbi do
     FileUtils.rm_rf(dry_monads_sorbet_rbi_path)
 
-    copy_bundled_rbi('dry-monads.rbi')
+    dry_monads_sorbet_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)
+  def dry_monads_sorbet_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))

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.4'
     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.13
+  version: 1.1.4
 platform: ruby
 authors:
 - Luke Worth
@@ -140,7 +140,11 @@ 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 +155,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: