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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09d726e9f2209db8a2e19cba3783f6d8fc1a437c898f22b6203e6b5880b72994'
-  data.tar.gz: 3a13a252e5596c910dfe61bb991af4ea25faa8b46ee83b1131b9a3c54f1fbb50
+  metadata.gz: 887467b4c0cba080ef636b8f957618b21f2ef65cc348c04393c5c4de17f9971a
+  data.tar.gz: 11784667d63e2998fa65f13bf462e777e37b6e1ad6c66b34b06bd3502431c5bc
 SHA512:
-  metadata.gz: c409d96569345ac1d1112b18e8d88f10922f79da1bbf4b54f17c459d097b6b3d2225b1ac08651e984c1f1a4551f224abccba8009d7451d26f08b210ed6da327e
-  data.tar.gz: 90a4221c37ac5063b855fc94563cb2acda4cbe528bc3e52e064517ae830fd1ba969bf270f50e9598cde682566bf5881c0f2be62613ca7ce781ad86dda1d2bf98
+  metadata.gz: 4ee963c283b3a2fa20c87ce318cd4f910eada81892c9c0e1b3ae0e623308c33407729b323f6d3313f54c48de47e1160d333aab003aad6b375cbbb15452ab0198
+  data.tar.gz: 5e82ee22ee15faa265af53cc20e41898061056095fadbe67203dfb0905c51381c8322eef5f34767c46f64ac7eb10f2418ebf01674960780e6a43e05996c309ed

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/lib/dry-monads-sorbet.rb

@@ -2,5 +2,4 @@
 
 require 'dry/monads/all'
 require 'dry/monads/sorbet'
-
-Dir["dry-monads-sorbet/tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)
+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/version.rb

@@ -3,7 +3,7 @@
 module Dry
   module Monads
     module Sorbet
-      VERSION = '1.1.0.pre.9'
+      VERSION = '1.1.0.pre.10'
     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.9
+  version: 1.1.0.pre.10
 platform: ruby
 authors:
 - Luke Worth
@@ -131,6 +131,8 @@ files:
 - 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