rbs_heuristic_prototype 0.4.0 → 0.5.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (13) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/Gemfile.lock +27 -24
  4. data/README.md +3 -9
  5. data/lib/generators/rbs_heuristic_prototype/install_generator.rb +1 -1
  6. data/lib/rbs_heuristic_prototype/filters/type_args_filter.rb +66 -0
  7. data/lib/rbs_heuristic_prototype/rake_task.rb +8 -5
  8. data/lib/rbs_heuristic_prototype/version.rb +1 -1
  9. data/lib/rbs_heuristic_prototype.rb +1 -0
  10. data/rbs_collection.lock.yaml +20 -16
  11. data/rbs_heuristic_prototype.gemspec +1 -0
  12. data/sig/rbs_heuristic_prototype/rake_task.rbs +1 -1
  13. metadata +17 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: af9a660bde45e0c64701f350cfa2fed63112aec3c6fd3320f0387b084c5a6236
4
- data.tar.gz: 92f823a5423774c78a092b35719ec66d440e9d63dedc5488d07c7049fd3b03df
3
+ metadata.gz: 27bbb60b69e731dbd572ba5ccb38e312c9620082e0aadd454be79f82cfd78bbe
4
+ data.tar.gz: 329389107d5a1180a80cc5e51394915a4901f23eb40a74a268ce8a59c82239f0
5
5
  SHA512:
6
- metadata.gz: e0dce9def43b5ccd0445b2f4d748626381bf83eeb9831082b9bd184d49f7cc0a0c039c16a3dda9df2ae7bb595a056e2b39551c13dbc8b74a91dcbd54f474732d
7
- data.tar.gz: 9d7aeaa4971e0b3535e94abb963dde4ad11528c8601a770ddae778fa4adde37a0bca5c4b7dda2088fe651ebf0ecd9dae843df4ea02aa00a97fd7824cc4c6417d
6
+ metadata.gz: 07a7565cf27c7be5128971b5b95eb91574f801f997c683aa43b8644c204f79d3f2bcba85c746d452372b0c2f30242beb21bcd6fa1c6cbe8d490f69470000904c
7
+ data.tar.gz: 563a9a8d48b267a009c8640adcfb47c37e52f9a4fd88b172ed6f0356e6a05130fc522977e18f6ba99ae79c657a57bec326c10149f07cdb9edb6cf4e4b04145c2
data/Gemfile CHANGED
@@ -8,7 +8,7 @@ gemspec
8
8
  gem "activerecord"
9
9
  gem "railties"
10
10
  gem "rake", "~> 13.0"
11
- gem "rubocop", "~> 1.55"
11
+ gem "rubocop", "~> 1.56"
12
12
 
13
13
  group :development do
14
14
  gem "rspec", require: false
data/Gemfile.lock CHANGED
@@ -1,36 +1,38 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- rbs_heuristic_prototype (0.4.0)
4
+ rbs_heuristic_prototype (0.5.1)
5
+ activesupport
5
6
  rbs
6
7
 
7
8
  GEM
8
9
  remote: https://rubygems.org/
9
10
  specs:
10
- actionpack (7.0.6)
11
- actionview (= 7.0.6)
12
- activesupport (= 7.0.6)
11
+ actionpack (7.0.7)
12
+ actionview (= 7.0.7)
13
+ activesupport (= 7.0.7)
13
14
  rack (~> 2.0, >= 2.2.4)
14
15
  rack-test (>= 0.6.3)
15
16
  rails-dom-testing (~> 2.0)
16
17
  rails-html-sanitizer (~> 1.0, >= 1.2.0)
17
- actionview (7.0.6)
18
- activesupport (= 7.0.6)
18
+ actionview (7.0.7)
19
+ activesupport (= 7.0.7)
19
20
  builder (~> 3.1)
20
21
  erubi (~> 1.4)
21
22
  rails-dom-testing (~> 2.0)
22
23
  rails-html-sanitizer (~> 1.1, >= 1.2.0)
23
- activemodel (7.0.6)
24
- activesupport (= 7.0.6)
25
- activerecord (7.0.6)
26
- activemodel (= 7.0.6)
27
- activesupport (= 7.0.6)
28
- activesupport (7.0.6)
24
+ activemodel (7.0.7)
25
+ activesupport (= 7.0.7)
26
+ activerecord (7.0.7)
27
+ activemodel (= 7.0.7)
28
+ activesupport (= 7.0.7)
29
+ activesupport (7.0.7)
29
30
  concurrent-ruby (~> 1.0, >= 1.0.2)
30
31
  i18n (>= 1.6, < 2)
31
32
  minitest (>= 5.1)
32
33
  tzinfo (~> 2.0)
33
34
  ast (2.4.2)
35
+ base64 (0.1.1)
34
36
  builder (3.2.4)
35
37
  coderay (1.1.3)
36
38
  concurrent-ruby (1.2.2)
@@ -53,9 +55,9 @@ GEM
53
55
  nokogiri (>= 1.12.0)
54
56
  method_source (1.0.0)
55
57
  minitest (5.19.0)
56
- nokogiri (1.15.2-x86_64-darwin)
58
+ nokogiri (1.15.4-x86_64-darwin)
57
59
  racc (~> 1.4)
58
- nokogiri (1.15.2-x86_64-linux)
60
+ nokogiri (1.15.4-x86_64-linux)
59
61
  racc (~> 1.4)
60
62
  parallel (1.23.0)
61
63
  parser (3.2.2.3)
@@ -65,19 +67,19 @@ GEM
65
67
  coderay (~> 1.1)
66
68
  method_source (~> 1.0)
67
69
  racc (1.7.1)
68
- rack (2.2.7)
70
+ rack (2.2.8)
69
71
  rack-test (2.1.0)
70
72
  rack (>= 1.3)
71
- rails-dom-testing (2.1.1)
73
+ rails-dom-testing (2.2.0)
72
74
  activesupport (>= 5.0.0)
73
75
  minitest
74
76
  nokogiri (>= 1.6)
75
77
  rails-html-sanitizer (1.6.0)
76
78
  loofah (~> 2.21)
77
79
  nokogiri (~> 1.14)
78
- railties (7.0.6)
79
- actionpack (= 7.0.6)
80
- activesupport (= 7.0.6)
80
+ railties (7.0.7)
81
+ actionpack (= 7.0.7)
82
+ activesupport (= 7.0.7)
81
83
  method_source
82
84
  rake (>= 12.2)
83
85
  thor (~> 1.0)
@@ -87,7 +89,7 @@ GEM
87
89
  rb-fsevent (0.11.2)
88
90
  rb-inotify (0.10.1)
89
91
  ffi (~> 1.0)
90
- rbs (3.1.2)
92
+ rbs (3.1.3)
91
93
  regexp_parser (2.8.1)
92
94
  rexml (3.2.6)
93
95
  rspec (3.12.0)
@@ -106,7 +108,8 @@ GEM
106
108
  diff-lcs (>= 1.2.0, < 2.0)
107
109
  rspec-support (~> 3.12.0)
108
110
  rspec-support (3.12.0)
109
- rubocop (1.55.0)
111
+ rubocop (1.56.0)
112
+ base64 (~> 0.1.1)
110
113
  json (~> 2.3)
111
114
  language_server-protocol (>= 3.17.0)
112
115
  parallel (~> 1.10)
@@ -121,7 +124,7 @@ GEM
121
124
  parser (>= 3.2.1.0)
122
125
  ruby-progressbar (1.13.0)
123
126
  securerandom (0.2.2)
124
- steep (1.5.2)
127
+ steep (1.5.3)
125
128
  activesupport (>= 5.1)
126
129
  concurrent-ruby (>= 1.1.10)
127
130
  csv (>= 3.0.9)
@@ -143,7 +146,7 @@ GEM
143
146
  tzinfo (2.0.6)
144
147
  concurrent-ruby (~> 1.0)
145
148
  unicode-display_width (2.4.2)
146
- zeitwerk (2.6.8)
149
+ zeitwerk (2.6.11)
147
150
 
148
151
  PLATFORMS
149
152
  x86_64-darwin-19
@@ -157,7 +160,7 @@ DEPENDENCIES
157
160
  rbs_heuristic_prototype!
158
161
  rspec
159
162
  rspec-daemon
160
- rubocop (~> 1.55)
163
+ rubocop (~> 1.56)
161
164
  steep
162
165
 
163
166
  BUNDLED WITH
data/README.md CHANGED
@@ -8,7 +8,7 @@ Add a new entry to your Gemfile and run bundle install:
8
8
 
9
9
  ```
10
10
  group :development do
11
- gem 'rbs_heuristic_prototype'
11
+ gem 'rbs_heuristic_prototype', require: false
12
12
  end
13
13
  ```
14
14
 
@@ -18,14 +18,6 @@ After the installation, please run rake task generator:
18
18
  bundle exec rails g rbs_heuristic_prototype:install
19
19
  ```
20
20
 
21
- Additionally, it would be better to add the following entry to your rbs_collection.yml:
22
-
23
- ```
24
- gems:
25
- - name: rbs_heuristic_prototype
26
- ignore: true
27
- ```
28
-
29
21
  ## Usage
30
22
 
31
23
  1. Run `rbs prototype rb` or `rbs prototype runtime` first
@@ -45,6 +37,8 @@ by `rbs prototype` according to the heuristic rules.
45
37
  * Rule 4:
46
38
  * Convert a scoped module/class definition (ex. `Foo::Bar::Baz`) to the nested definitions
47
39
  * This is useful to define intermediate modules automatically like what Rails and zeitwerk does.
40
+ * Rule 5:
41
+ * Convert a module reference without type arguments (ex. `include Enumerable`) to a module reference with type arguments (ex. `include Enumerable[untyped]`)
48
42
 
49
43
  ## Development
50
44
 
data/lib/generators/rbs_heuristic_prototype/install_generator.rb CHANGED
@@ -7,7 +7,7 @@ module RbsHeuristicPrototype
7
7
  def create_raketask
8
8
  create_file "lib/tasks/rbs_heuristic_prototype.rake", <<~RUBY
9
9
  begin
10
- require 'rbs_heuristic_prototype'
10
+ require 'rbs_heuristic_prototype/rake_task'
11
11
  RbsHeuristicPrototype::RakeTask.new
12
12
  rescue LoadError
13
13
  # failed to load rbs_heuristic_prototype. Skip to load rbs_heuristic_prototype tasks.
data/lib/rbs_heuristic_prototype/filters/type_args_filter.rb ADDED
@@ -0,0 +1,66 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "base"
4
+
5
+ module RbsHeuristicPrototype
6
+ module Filters
7
+ class TypeArgsFilter < Base
8
+ def process_class(decl)
9
+ decl = super(decl)
10
+ RBS::AST::Declarations::Class.new(
11
+ name: decl.name,
12
+ type_params: decl.type_params,
13
+ super_class: process_super_class(decl.super_class),
14
+ members: decl.members,
15
+ annotations: decl.annotations,
16
+ location: decl.location,
17
+ comment: decl.comment
18
+ )
19
+ end
20
+
21
+ def process_super_class(decl)
22
+ return unless decl
23
+
24
+ class_decl = external_env.class_decls[decl.name.absolute!]
25
+ if class_decl && decl.args.empty?
26
+ RBS::AST::Declarations::Class::Super.new(
27
+ name: decl.name,
28
+ args: class_decl.type_params.size.times.map { :untyped },
29
+ location: decl.location
30
+ )
31
+ else
32
+ decl
33
+ end
34
+ end
35
+
36
+ def process_member(decl)
37
+ case decl
38
+ when RBS::AST::Members::Include
39
+ process_include(decl)
40
+ else
41
+ super
42
+ end
43
+ end
44
+
45
+ def process_include(decl)
46
+ class_decl = external_env.class_decls[decl.name.absolute!]
47
+ if class_decl && decl.args.empty?
48
+ RBS::AST::Members::Include.new(
49
+ name: decl.name,
50
+ args: class_decl.type_params.size.times.map { :untyped },
51
+ annotations: decl.annotations,
52
+ location: decl.location,
53
+ comment: decl.comment
54
+ )
55
+ else
56
+ decl
57
+ end
58
+ end
59
+
60
+ def external_env
61
+ loader = RBS::EnvironmentLoader.new
62
+ RBS::Environment.from_loader(loader)
63
+ end
64
+ end
65
+ end
66
+ end
data/lib/rbs_heuristic_prototype/rake_task.rb CHANGED
@@ -7,10 +7,11 @@ require "rake/tasklib"
7
7
  module RbsHeuristicPrototype
8
8
  class RakeTask < Rake::TaskLib
9
9
  FILTERS = {
10
- active_model_validations: Filters::ActiveModelValidationsFilter,
11
- boolean_methods: Filters::BooleanMethodsFilter,
12
- deep_module: Filters::DeepModuleFilter,
13
- symbol_array_constants: Filters::SymbolArrayConstantsFilter
10
+ active_model_validations: "RbsHeuristicPrototype::Filters::ActiveModelValidationsFilter",
11
+ boolean_methods: "RbsHeuristicPrototype::Filters::BooleanMethodsFilter",
12
+ deep_module: "RbsHeuristicPrototype::Filters::DeepModuleFilter",
13
+ symbol_array_constants: "RbsHeuristicPrototype::Filters::SymbolArrayConstantsFilter",
14
+ type_args: "RbsHeuristicPrototype::Filters::TypeArgsFilter"
14
15
  }.freeze
15
16
 
16
17
  attr_reader :name, :path
@@ -37,11 +38,13 @@ module RbsHeuristicPrototype
37
38
  def define_apply_task
38
39
  desc "Apply heuristic filters to prototype signatures"
39
40
  task("#{name}:apply": :environment) do
41
+ require "rbs_heuristic_prototype" # load RbsHeuristicPrototype lazily
42
+
40
43
  path.find do |entry|
41
44
  next unless entry.file?
42
45
 
43
46
  env = FILTERS.inject(load_env(entry)) do |result, (_name, filter)|
44
- filter.new(result).apply
47
+ filter.constantize.new(result).apply
45
48
  end
46
49
 
47
50
  write_env(entry, env)
data/lib/rbs_heuristic_prototype/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module RbsHeuristicPrototype
4
- VERSION = "0.4.0"
4
+ VERSION = "0.5.1"
5
5
  end
data/lib/rbs_heuristic_prototype.rb CHANGED
@@ -4,6 +4,7 @@ require_relative "rbs_heuristic_prototype/filters/active_model_validations_filte
4
4
  require_relative "rbs_heuristic_prototype/filters/boolean_methods_filter"
5
5
  require_relative "rbs_heuristic_prototype/filters/deep_module_filter"
6
6
  require_relative "rbs_heuristic_prototype/filters/symbol_array_constants_filter"
7
+ require_relative "rbs_heuristic_prototype/filters/type_args_filter"
7
8
  require_relative "rbs_heuristic_prototype/rake_task"
8
9
  require_relative "rbs_heuristic_prototype/version"
9
10
 
data/rbs_collection.lock.yaml CHANGED
@@ -2,7 +2,7 @@
2
2
  sources:
3
3
  - type: git
4
4
  name: ruby/gem_rbs_collection
5
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
5
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
6
6
  remote: https://github.com/ruby/gem_rbs_collection.git
7
7
  repo_dir: gems
8
8
  path: ".gem_rbs_collection"
@@ -16,7 +16,7 @@ gems:
16
16
  source:
17
17
  type: git
18
18
  name: ruby/gem_rbs_collection
19
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
19
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
20
20
  remote: https://github.com/ruby/gem_rbs_collection.git
21
21
  repo_dir: gems
22
22
  - name: actionview
@@ -24,7 +24,7 @@ gems:
24
24
  source:
25
25
  type: git
26
26
  name: ruby/gem_rbs_collection
27
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
27
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
28
28
  remote: https://github.com/ruby/gem_rbs_collection.git
29
29
  repo_dir: gems
30
30
  - name: activemodel
@@ -32,7 +32,7 @@ gems:
32
32
  source:
33
33
  type: git
34
34
  name: ruby/gem_rbs_collection
35
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
35
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
36
36
  remote: https://github.com/ruby/gem_rbs_collection.git
37
37
  repo_dir: gems
38
38
  - name: activerecord
@@ -40,7 +40,7 @@ gems:
40
40
  source:
41
41
  type: git
42
42
  name: ruby/gem_rbs_collection
43
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
43
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
44
44
  remote: https://github.com/ruby/gem_rbs_collection.git
45
45
  repo_dir: gems
46
46
  - name: activesupport
@@ -48,7 +48,7 @@ gems:
48
48
  source:
49
49
  type: git
50
50
  name: ruby/gem_rbs_collection
51
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
51
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
52
52
  remote: https://github.com/ruby/gem_rbs_collection.git
53
53
  repo_dir: gems
54
54
  - name: ast
@@ -56,9 +56,13 @@ gems:
56
56
  source:
57
57
  type: git
58
58
  name: ruby/gem_rbs_collection
59
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
59
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
60
60
  remote: https://github.com/ruby/gem_rbs_collection.git
61
61
  repo_dir: gems
62
+ - name: base64
63
+ version: '0'
64
+ source:
65
+ type: stdlib
62
66
  - name: cgi
63
67
  version: '0'
64
68
  source:
@@ -68,7 +72,7 @@ gems:
68
72
  source:
69
73
  type: git
70
74
  name: ruby/gem_rbs_collection
71
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
75
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
72
76
  remote: https://github.com/ruby/gem_rbs_collection.git
73
77
  repo_dir: gems
74
78
  - name: date
@@ -80,7 +84,7 @@ gems:
80
84
  source:
81
85
  type: git
82
86
  name: ruby/gem_rbs_collection
83
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
87
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
84
88
  remote: https://github.com/ruby/gem_rbs_collection.git
85
89
  repo_dir: gems
86
90
  - name: json
@@ -108,7 +112,7 @@ gems:
108
112
  source:
109
113
  type: git
110
114
  name: ruby/gem_rbs_collection
111
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
115
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
112
116
  remote: https://github.com/ruby/gem_rbs_collection.git
113
117
  repo_dir: gems
114
118
  - name: optparse
@@ -120,7 +124,7 @@ gems:
120
124
  source:
121
125
  type: git
122
126
  name: ruby/gem_rbs_collection
123
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
127
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
124
128
  remote: https://github.com/ruby/gem_rbs_collection.git
125
129
  repo_dir: gems
126
130
  - name: pathname
@@ -132,7 +136,7 @@ gems:
132
136
  source:
133
137
  type: git
134
138
  name: ruby/gem_rbs_collection
135
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
139
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
136
140
  remote: https://github.com/ruby/gem_rbs_collection.git
137
141
  repo_dir: gems
138
142
  - name: rails-dom-testing
@@ -140,7 +144,7 @@ gems:
140
144
  source:
141
145
  type: git
142
146
  name: ruby/gem_rbs_collection
143
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
147
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
144
148
  remote: https://github.com/ruby/gem_rbs_collection.git
145
149
  repo_dir: gems
146
150
  - name: railties
@@ -148,7 +152,7 @@ gems:
148
152
  source:
149
153
  type: git
150
154
  name: ruby/gem_rbs_collection
151
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
155
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
152
156
  remote: https://github.com/ruby/gem_rbs_collection.git
153
157
  repo_dir: gems
154
158
  - name: rainbow
@@ -156,11 +160,11 @@ gems:
156
160
  source:
157
161
  type: git
158
162
  name: ruby/gem_rbs_collection
159
- revision: 9330d49993d18362cce9190b9596f03d1f4915f8
163
+ revision: a4c633634493ab7ae73219022f56acff56ab69af
160
164
  remote: https://github.com/ruby/gem_rbs_collection.git
161
165
  repo_dir: gems
162
166
  - name: rbs
163
- version: 3.1.2
167
+ version: 3.1.3
164
168
  source:
165
169
  type: rubygems
166
170
  - name: rdoc
data/rbs_heuristic_prototype.gemspec CHANGED
@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
27
27
  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
28
28
  spec.require_paths = ["lib"]
29
29
 
30
+ spec.add_dependency "activesupport"
30
31
  spec.add_dependency "rbs"
31
32
  end
data/sig/rbs_heuristic_prototype/rake_task.rbs CHANGED
@@ -1,6 +1,6 @@
1
1
  module RbsHeuristicPrototype
2
2
  class RakeTask < Rake::TaskLib
3
- FILTERS: Hash[Symbol, singleton(Filters::Base)]
3
+ FILTERS: Hash[Symbol, String]
4
4
 
5
5
  attr_reader name: Symbol
6
6
  attr_reader path: Pathname
metadata CHANGED
@@ -1,15 +1,29 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rbs_heuristic_prototype
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.5.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Takeshi KOMIYA
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2023-08-01 00:00:00.000000000 Z
11
+ date: 2023-08-25 00:00:00.000000000 Z
12
12
  dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: activesupport
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
13
27
  - !ruby/object:Gem::Dependency
14
28
  name: rbs
15
29
  requirement: !ruby/object:Gem::Requirement
@@ -49,6 +63,7 @@ files:
49
63
  - lib/rbs_heuristic_prototype/filters/boolean_methods_filter.rb
50
64
  - lib/rbs_heuristic_prototype/filters/deep_module_filter.rb
51
65
  - lib/rbs_heuristic_prototype/filters/symbol_array_constants_filter.rb
66
+ - lib/rbs_heuristic_prototype/filters/type_args_filter.rb
52
67
  - lib/rbs_heuristic_prototype/rake_task.rb
53
68
  - lib/rbs_heuristic_prototype/version.rb
54
69
  - rbs_collection.lock.yaml