dry-monads-sorbet 1.1.0.pre.11 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc959005a547da04b1abb2c034035c42d38bf090e0b9655b27cf043f7fcc4b10
-  data.tar.gz: 18237d14463293d2b09050e4ef18195c1e78517316b57bd7ee685a2834f25d65
+  metadata.gz: 25c5b71c33daec16deda28a30aa06d0ba39738295c86c87c497554f12d7a9ca3
+  data.tar.gz: 1479a94070fa413a7adefdd171b740987a583b62802cdb6f14f919cdd4730f4e
 SHA512:
-  metadata.gz: 633bfd82f597a03899c183813972cd78db85f06445322f6c8ad2477de44b5f40101f7c28dbd987cb1b3547b6f40c3436594a49b23e8b7e1dc7026d19d8d28fa6
-  data.tar.gz: 8d3f1acb482d1122e9b5b9c1099593cf4cca8f5daee8872ab7d263705079c4a8ed530c3cdc7af62e5c045086c1c9fe7b2134c70cb3eb537e73355b67a3799ae3
+  metadata.gz: '08ef83a7c701035db63f190270acd65599d5f37703e5debee6d659a0460e324be13e012ace46238d1bdaa6a65576ac8836dfb07e55868eeffbf0f93b71ef9705'
+  data.tar.gz: 246a737a59c34f0e8a371be92a6ccf0d22c0d66fab043f21ac0c7edcd1b1bb22d99e861ecd614765e4fe52cc6f41f7e0309eb3a9f0abe5cb11f18e3e49b77f76

data/CHANGELOG.md

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

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')
+    dry_monads_sorbet_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}"
+  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))
     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.11'
+      VERSION = '1.1.2'
     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.11
+  version: 1.1.2
 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: