sorbet-rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3f7dd83f8d099f5951a1a8bd13707c4e38d60e5
-  data.tar.gz: 4c7e2dc570d7695826c1c88d3f6711c7600dbe57
+  metadata.gz: ab8c01f01bcf1f1400adb25f52d0a6c35127a206
+  data.tar.gz: ad481caa38ffc63d0ea5159a091ff91503c6f17b
 SHA512:
-  metadata.gz: '0780d48a3e347edd504e6b3b2e11ca88e60118a29e25b3b0b4c931192aec27e8c2f2d1f2ddeff5c111a106a5174ed2feb8e7d462f92a59cc8a91284c9d0c48eb'
-  data.tar.gz: 8a3af472623c72b6cf615acd4a19b52b341b82ed18392feb8e25ddcd9a10177b329d3ab77c557b1ca32dacada4216f1ac92e6dcc1503ada0fa9507a087ebf786
+  metadata.gz: 488ffc6eac8fec70207a86a71f13f034b55732df73ea9a3dc0aba4f694fa59eb36f98f52dee3f80267f9437484d9b165360a55b3f0033a81d8f5dd4f2bebb40e
+  data.tar.gz: f82f7455bafb5a375ad65b6c0d725a15e2b4e0df53fbd3a3a69d65d7089571b29afbde8befb569ba4f8f1c66b708258bf6a91dcd5d5cae6bfbaa94f50c260abf

data/.gitignore

@@ -0,0 +1,77 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Rails app
+/spec/support/rails_app/tmp/*
+/spec/support/rails_app/.bundle
+
+# Ignore the default SQLite database.
+/spec/support/rails_app/db/*.sqlite3
+/spec/support/rails_app/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/spec/support/rails_app/log/*
+/spec/support/rails_app/tmp/*
+!/spec/support/rails_app/log/.keep
+!/spec/support/rails_app/tmp/.keep
+
+# Ignore uploaded files in development
+/spec/support/rails_app/storage/*
+!/spec/support/rails_app/storage/.keep
+
+/spec/support/rails_app/node_modules
+/spec/support/rails_app/yarn-error.log
+
+/spec/support/rails_app/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/spec/support/rails_app/config/master.key

data/Gemfile

@@ -1 +1,7 @@
 source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'simplecov', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,176 @@
+PATH
+  remote: .
+  specs:
+    sorbet-rails (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    awesome_print (1.8.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    erubi (1.8.0)
+    ffi (1.11.1)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    puma (3.12.1)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    ruby_dep (1.5.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (>= 1.8.0)
+  bundler (>= 1.3.0)
+  byebug (>= 11.0.1)
+  listen (>= 3.1.5)
+  puma (>= 3.12.1)
+  rails (>= 5.2.3)
+  rspec (~> 3.8)
+  rspec-rails (>= 3.8.2)
+  simplecov
+  sorbet-rails!
+  sqlite3 (>= 1.4.1)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -1,50 +1,50 @@
 # sorbet-rails
-Set of tools to make sorbet work with rails seamlessly.
+A set of tools to make the [Sorbet](https://sorbet.org) type checker work with Ruby on Rails seamlessly.
 
-This gem adds a few rake tasks to generate RBI for dynamic methods generated by Rails. It also includes sigs for related Rails classes. The generated rbis are added to `sorbet/rails-rbi/` folder.
+This gem adds a few Rake tasks to generate Ruby Interface (RBI) files for dynamic methods generated by Rails. It also includes signatures for related Rails classes. The RBI files are added to a `sorbet/rails-rbi/` folder.
 
-Please feel free to send PR requests or file issues to improve the functionality of the gem!
+## Initial Setup
 
-## Initial setup
+1. Install the gem and set up Sorbet, up to being able to run `srb tc`. Follow the steps [here](https://sorbet.org/docs/adopting).
 
-Following the steps below to setup the rbis after `srb tc`
-1. Include ActiveRecord RBI
-```
-  $ srb tc sorbet-typed
-```
-2. Generate routes RBI
+2. Include the ActiveRecord RBI file:
+```sh
+  $ srb rbi sorbet-typed
 ```
+3. Generate RBI files for routes and models:
+```sh
   $ rake rails_rbi:routes
-```
-3. Generate models RBI
-```
   $ rake rails_rbi:models
 ```
-4. Auto-upgrade the typecheck level of files
+4. Auto-upgrade the typecheck level of files:
+```sh
+  $ srb tc --suggest-typed --typed=strict --error-white-list=7022 --autocorrect
 ```
-  $ srb tc --suggest-typed --typed=strict --error-white-list=7022 -a
-```
-Because we've generated RBI files for models & routes, a lot more files should be type-checkable now
+Because we've generated RBI files for routes and models, a lot more files should be type-checkable now.
 
-## ActiveRecord RBI
+## RBI Files
 
-There are ActiveRecord RBI that we vendor with this gem. Please run `srb tc sorbet-typed` to include the provided RBI in your `sorbet/rbi_list`
+### ActiveRecord RBI
 
-## Routes RBI
-The following rake task generates `_path` and `_url` methods for all named routes defined in `routes.rb`
-```
-  rake rails_rbi:routes
-```
-## Models RBI
-The following rake task generates rbi files for all models in the Rails App (all descendants of ActiveRecord::Base)
-```
-  rake rails_rbi:models
+There is an ActiveRecord RBI file that we vendor with this gem. Run `srb rbi sorbet-typed` to include the provided RBI file in your `sorbet/rbi_list`.
+
+### Routes RBI
+
+This Rake task generates an RBI file defining `_path` and `_url` methods for all named routes in `routes.rb`:
+```sh
+  $ rake rails_rbi:routes
 ```
-You can also regenerate rbi files for specific models
+### Models RBI
+
+This Rake task generates RBI files for all models in the Rails application (all descendants of `ActiveRecord::Base`):
+```sh
+  $ rake rails_rbi:models
 ```
-  rake rails_rbi:models[ModelName,AnotherOne,...]
+You can also regenerate RBI files for specific models:
+```sh
+  $ rake rails_rbi:models[ModelName,AnotherOne,...]
 ```
-At the moment, the generation task generate the following signatures
+The generation task currently creates the following signatures:
 - Column getters & setters
 - Associations getters & setters
 - Enum values, checkers & scopes
@@ -52,44 +52,67 @@ At the moment, the generation task generate the following signatures
 - Model relation class
 
 ## Tips & Tricks
+
 ### `find`, `first` and `last` 
-These 3 methods can either return a single nilable record or an array of records. Sorbet does not allow us to define multiple sigs for a function. It doesn't support defining one function sig that has varying returning value depending on the input param type. We opt to define the most commonly used sig for these methods, and monkey-patch new functions for the secondary use.
+
+These 3 methods can either return a single nilable record or an array of records. Sorbet does not allow us to define multiple signatures for a function. It doesn't support defining one function signature that has varying returning value depending on the input parameter type. We opt to define the most commonly used signature for these methods, and monkey-patch new functions for the secondary use case.
 
 In short:
-- Use `find`, `first` and `last` to fetch a single record
+- Use `find`, `first` and `last` to fetch a single record.
 - Use `find_n`, `first_n`, `last_n` to fetch an array of records.
 
 ### `find_by_<attributes>`, `<attribute>_changed?`, etc.
-Rails supports dynamic methods based on attribute names, such as `find_by_<attribute>`, `<attribute>_changed?`, etc. They all have static counterparts. Instead of generating all possible dynamic methods that Rails support, we recommend to use of the static version of these methods instead (also recommended by RuboCop). We've added sigs for th
 
-Following are the list of attribute dynamic methods and their static counterpart. The static methods have proper sigs.
+Rails supports dynamic methods based on attribute names, such as `find_by_<attribute>`, `<attribute>_changed?`, etc. They all have static counterparts. Instead of generating all possible dynamic methods that Rails support, we recommend to use of the static version of these methods instead (also recommended by RuboCop).
+
+Following are the list of attribute dynamic methods and their static counterparts. The static methods have proper signatures:
 - `find_by_<attributes>` -> `find_by(<attributes>)`
 - `find_by_<attributes>!` -> `find_by!(<attributes>)`
 - `<attribute>_changed?` -> `attribute_changed?(<attribute>)`
 - `saved_change_to_<attribute>?` -> `saved_change_to_attribute?(<attribute>)`
 
 ### `after_commit` and other callbacks
-Consider codemod-ing `after_commit` callbacks to use instance method functions. Sorbet doesn't support binding an optional block with a different context. Because of this, when using a callback with a custom block, the block is evaluated in the wrong context (Class-level context). 
 
-```
+Consider converting `after_commit` callbacks to use instance method functions. Sorbet doesn't support binding an optional block with a different context. Because of this, when using a callback with a custom block, the block is evaluated in the wrong context (Class-level context). Refer to [this page](https://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html) for a full list of callbacks available in Rails.
+
+Before:
+```ruby
 after_commit do ... end
 ```
-codemod to 
-```
+After:
+```ruby
 after_commit :after_commit
 def after_commit
   ...
 end
 ```
 
-I've created a gist with codemod commands to convert the code automatically
-https://gist.github.com/manhhung741/d2e0a8f9c4178f328b241dd8b28ccc67
+If you wanted to make these changes using [Codemod](https://github.com/facebook/codemod), try these commands:
+```shell
+# from methods like after_commit do <...> end
+codemod -d app/models/ --extensions rb \
+  '(\s*)(before|after)_(validation|save|create|commit|find|initialize|destroy) do' \
+  '\1\2_\3 :\2_\3\n\1def \2_\3'
 
-See this link for a full list of callbacks available in Rails:
-https://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html
+# from methods like after_commit { <...> }
+codemod -d app/models/ --extensions rb \
+  '(\s*)(before|after)_(validation|save|create|commit|find|initialize|destroy) \{ (.*) \}' \
+  '\1\2_\3 :\2_\3\n\1def \2_\3\n\1\1\4\n\1end'
+```
+Note that Codemod's preview may show that the indentation is off, but it works.
 
 ### Look for `# typed: ignore` files
 
-Because sorbet initial setup tries to flag files at the typecheck level that generates 0 errors, there may be files in your repository that is `# typed: ignore`. This is because sometimes Rails allow very dynamic code that Sorbet does not regard as typecheck-able. 
+Because Sorbet's initial setup tries to flag files at whichever typecheck level generates 0 errors, there may be files in your repository that are `# typed: ignore`. This is because sometimes Rails allows very dynamic code that Sorbet does not believe it can typecheck.
+
+It is worth going through the list of files that is ignored and resolve them (and auto upgrade the types of other files; see [initial setup](#initial-setup) above). Usually this will make many more files able to be typechecked.
+
+## Contributing
+
+Contributions and ideas are welcome! Please don't hesitate to open an issue or send a pull request to improve the functionality of this gem.
+
+This project adheres to the Contributor Covenant [code of conduct](https://github.com/chanzuckerberg/.github/tree/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to opensource@chanzuckerberg.com.
+
+## License
 
-It is worth going through the list of files that is ignored and resolve them (and auto upgrade the types of other files -- see Initial Setup #4). Usually this will resolve in many more files typecheckable.
+[MIT](https://github.com/chanzuckerberg/sorbet-rails/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/SECURITY.md

@@ -0,0 +1,5 @@
+# Reporting Security Vulnerabilities
+
+The Chan Zuckerberg Initiative takes security issues seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
+
+If you believe you have found a security issue, please contact us at security@chanzuckerberg.com.