rbs_rails 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9b730da55f64b177f506e6f29efa54bba6878e3cd36b49df76703ac749feb1a
-  data.tar.gz: c759ea33ab9071df4806b81f14b5ca125b2f2df04054c4f3a9d2eb6e305c92ab
+  metadata.gz: 820a0b86c257e12194d883e6f5edda1793b54cb789c2b57da2e496e16041c803
+  data.tar.gz: 173abfdce9274fc34671198b7640f5e84a92c8b0bb1a7ede8224cd2fb851137d
 SHA512:
-  metadata.gz: 7a8fbf409f920b17353906c93d0f86d3c94b270801ab184e2e92b47ceb050659dfaa163cd3d0204e54e970db325826ddb7c6a6df5e380f8342bae760c7d0025c
-  data.tar.gz: 06a2387300377054f6ccc1cd9a5414cb64753adfb9ef5e109f95234ec50e8cc5a83b148aa46cc9140cfd47705eb9275c7ca762824564993a6226a77351f33102
+  metadata.gz: 500bb14e66e9d6188d931e8a655b8af42b17caf13fa9487e8ad22318a54f34b5e05c412e65c2e68258d13165cb5760d09dc00d52d05b7cb9c9696e97dbbcc8bb
+  data.tar.gz: 86e1ec208cba577ce7ed5ac4a6b7bcd5ada10fe7d3ca0fd4ba5e014a68144bbe3182fcbd04145e9b9472be24a627eb0d5c3a2b7424661caae25d43507390d15a

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+/test/sig

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gem_rbs"]
+	path = gem_rbs
+	url = https://github.com/ruby/gem_rbs.git

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 2.6.5
+  - 2.7.0
+  - ruby-head
+
+before_install:
+  - gem install bundler -v 2.1.4
+
+cache: bundler

data/Gemfile

@@ -4,3 +4,6 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 12.0"
+gem 'rbs', '>= 0.14.0'
+gem 'steep', '>= 0.34.0'
+gem 'minitest'

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,8 +1,6 @@
-# RbsRails
+# RBS Rails
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbs_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+RBS files generator for Ruby on Rails.
 
 ## Installation
 
@@ -22,7 +20,87 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### For Active Record models
+
+It has two tasks.
+
+* `copy_signature_files`: Copy type definition files for Rails from rbs_rails.
+* `generate_rbs_for_model`: Generate RBS files from model classes.
+
+```ruby
+# Rakefile
+
+task copy_signature_files: :environment do
+  require 'rbs_rails'
+
+  to = Rails.root.join('sig/rbs_rails/')
+  to.mkpath unless to.exist?
+  RbsRails.copy_signatures(to: to)
+end
+
+task generate_rbs_for_model: :environment do
+  require 'rbs_rails'
+
+  out_dir = Rails.root / 'sig'
+  out_dir.mkdir unless out_dir.exist?
+
+  Rails.application.eager_load!
+
+  ActiveRecord::Base.descendants.each do |klass|
+    next if klass.abstract_class?
+
+    path = out_dir / "app/models/#{klass.name.underscore}.rbs"
+    FileUtils.mkdir_p(path.dirname)
+
+    sig = RbsRails::ActiveRecord.class_to_rbs(klass)
+    path.write sig
+  end
+end
+```
+
+### For path helpers
+
+```ruby
+# Rakefile
+
+task generate_rbs_for_path_helpers: :environment do
+  require 'rbs_rails'
+  out_path = Rails.root.join 'sig/path_helpers.rbs'
+  rbs = RbsRails::PathHelpers.generate
+  out_path.write rbs
+end
+```
+
+### Steep integration
+
+You need to specify the following libraries by `Steepfile`.
+
+```ruby
+# Steepfile
+
+target :app do
+  signature 'sig'
+
+  check 'app'
+
+  repo_path "path/to/rbs_repo"
+
+  library 'pathname'
+  library 'logger'
+  library 'mutex_m'
+  library 'date'
+
+  library 'activesupport'
+  library 'actionpack'
+  library 'activejob'
+  library 'activemodel'
+  library 'actionview'
+  library 'activerecord'
+  library 'railties'
+end
+```
+
+You need to put RBS repo to `path/to/rbs_repo`. See https://github.com/ruby/gem_rbs
 
 ## Development
 

data/Rakefile

@@ -1,2 +1,20 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require 'rake/testtask'
+
+task :default => [:rbs_validate, :steep, :test]
+
+desc 'run Steep'
+task :steep do
+  sh 'steep', 'check'
+end
+
+task :rbs_validate do
+  rbs = Pathname(__dir__).join('bin/rbs').to_s
+  sh "ruby #{rbs} validate --silent"
+end
+
+Rake::TestTask.new do |test|
+  test.libs << 'test'
+  test.test_files = Dir['test/**/*_test.rb']
+  test.verbose = true
+end

data/Steepfile

@@ -0,0 +1,20 @@
+target :lib do
+  signature "sig"
+  signature 'assets/sig'
+
+  check "lib"                       # Directory name
+  repo_path ENV['RBS_REPO_DIR'] || './gem_rbs/gems'
+
+  library "pathname"
+  library "logger"
+  library "mutex_m"
+  library "date"
+
+  library 'activesupport'
+  library 'actionpack'
+  library 'activejob'
+  library 'activemodel'
+  library 'actionview'
+  library 'activerecord'
+  library 'railties'
+end

data/assets/sig/action_mailer.rbs

@@ -0,0 +1,8 @@
+module ActionMailer
+  class Base
+    # TODO
+    # extend ActionView::Layouts::ClassMethods
+
+    def self.default: (?Hash[Symbol, untyped] value) -> Hash[Symbol, untyped]
+  end
+end

data/assets/sig/builtin.rbs

@@ -0,0 +1,7 @@
+class Monitor
+end
+class MonitorMixin
+end
+
+module Singleton
+end

data/assets/sig/capybara.rbs

@@ -0,0 +1,14 @@
+module Capybara
+  module DSL
+  end
+
+  module Minitest
+    module Assertions
+    end
+  end
+
+  module Poltergeist
+    class Driver
+    end
+  end
+end

data/assets/sig/concurrent.rbs

@@ -0,0 +1,4 @@
+module Concurrent
+  class Map
+  end
+end

data/assets/sig/erb.rbs

@@ -0,0 +1,4 @@
+class ERB
+  class Compiler
+  end
+end

data/assets/sig/erubi.rbs

@@ -0,0 +1,4 @@
+module Erubi
+  class Engine
+  end
+end

data/assets/sig/i18n.rbs

@@ -0,0 +1,4 @@
+module I18n
+  class Config
+  end
+end

data/assets/sig/libxml.rbs

@@ -0,0 +1,10 @@
+# is it correct?
+
+module LibXML
+end
+module LibXML::XML
+end
+module LibXML::XML::SaxParser
+end
+module LibXML::XML::SaxParser::Callbacks
+end