dry-monads-sorbet 1.1.0.pre.10 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 887467b4c0cba080ef636b8f957618b21f2ef65cc348c04393c5c4de17f9971a
-  data.tar.gz: 11784667d63e2998fa65f13bf462e777e37b6e1ad6c66b34b06bd3502431c5bc
+  metadata.gz: 79bc66c3eab53916acb4abb65238a4f570b1080e5d3d89b9a10e31e7dc4536c8
+  data.tar.gz: 9a31dcdb58f30b95e49215da0d56ce52a07cdaf55bce20ab74277e55bb496e8a
 SHA512:
-  metadata.gz: 4ee963c283b3a2fa20c87ce318cd4f910eada81892c9c0e1b3ae0e623308c33407729b323f6d3313f54c48de47e1160d333aab003aad6b375cbbb15452ab0198
-  data.tar.gz: 5e82ee22ee15faa265af53cc20e41898061056095fadbe67203dfb0905c51381c8322eef5f34767c46f64ac7eb10f2418ebf01674960780e6a43e05996c309ed
+  metadata.gz: ee8019df627a72a37d96b3bc19edceb990922e4b2ed4e495961ae826d1248a9fc004350fb9da7bcf622ebda97d9ed67a570c45625f43efbff2741e0320f4f132
+  data.tar.gz: 1ce9a387e1c3c806e110bf1544f425e04ffbf4495ba8ed3e8e8e028a7bd1163988c80c7751bd28b647e82da9b593a090432791df2ca3197a526ee7e84c4d9ca5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+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

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

@@ -1,5 +1,8 @@
 # typed: strong
 #
+# 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.
 

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

@@ -1,23 +1,25 @@
 require 'dry-monads-sorbet'
+require 'pathname'
 
 DRY_MONADS_SORBET_RAKE_DIR  = File.dirname(__FILE__)
 
 namespace :dry_monads_sorbet do
-  task :update_rbi, :environment do |t, args|
+  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
-    Rake.original_dir.join('sorbet', 'dry-monads-sorbet')
+    Pathname.new(Rake.original_dir).join('sorbet', 'dry-monads-sorbet')
   end
 
   def copy_bundled_rbi(filename)
-    puts "Copy bundled file #{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.10'
+      VERSION = '1.1.1'
     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.10
+  version: 1.1.1
 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: