irbs 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c8b175c641b45064dcf880ee4c21133ba9a6240f55c7237e8ef859bc3e51156
-  data.tar.gz: ad4a5fbf12afc99fee4ad48bd11c348acdb4c2cdf94e120656eeb8d50a2a3cf2
+  metadata.gz: c600bd915ecb07b4f4e420784092414e5222435aaef223e562e4db59af8a0cda
+  data.tar.gz: 594d0ee52c06c33e800795512b1ada463fdabfd4bde64e2fb82f3cea49f90e33
 SHA512:
-  metadata.gz: 1af6c2167935bad83840c1fba0497f3bda725c65d4521cdbf245e0d02aaa8cf93539bc9da5d010e12b8d3f5b0c284aa35459831c85fc3c9f172b8fbed3f5a392
-  data.tar.gz: d1682623eb9e908ad5b1e79ee9fb23824a57ed7ce216560de37678f4a934c9eb2cd378fcf1b1e71d17dd2effcceba8f93fd821a501466ad132366c72493a2b0e
+  metadata.gz: 6e6f22ca1f7f711185c51155ac7d154741dd2a62a5355e3d90de33c415e09c5d85d4d410d0fef909c6c40441278151fc7a7f77a286ae4dc905bc30eb21d56488
+  data.tar.gz: 3ac944dc1f0d1e04c97d500b91071bf449cc15eb7c472d16568e24d6b8996cd553dd7c47ac446c0429a002544e4c479132463c9bcb2578e5c492ca7739b4dbea

data/.rubocop.yml

@@ -25,6 +25,10 @@ Style/EmptyMethod:
 Style/BlockDelimiters:
   EnforcedStyle: semantic
 
+# ↑と相性が悪い
+Style/NumberedParameters:
+  Enabled: false
+
 # 内容は名前で示したい
 Style/Documentation:
   Enabled: false

data/Gemfile

@@ -3,9 +3,7 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in irbs.gemspec
-# gemspec
-
-gem 'yard'
+gemspec
 
 group :develepment do
   gem 'minitest', '~> 5.0'

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    irbs (0.2.1)
+      yard (~> 0.9.28)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -21,14 +27,14 @@ GEM
     logger (1.5.1)
     minitest (5.16.3)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.7.0)
+    rbs (2.8.1)
     regexp_parser (2.6.1)
     rexml (3.2.5)
     rubocop (1.39.0)
@@ -45,7 +51,7 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     securerandom (0.2.0)
-    steep (1.2.1)
+    steep (1.3.0)
       activesupport (>= 5.1)
       csv (>= 3.0.9)
       fileutils (>= 1.1.0)
@@ -56,7 +62,7 @@ GEM
       parallel (>= 1.0.0)
       parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.7.0)
+      rbs (>= 2.8.0)
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
@@ -74,11 +80,11 @@ PLATFORMS
   arm64-darwin-21
 
 DEPENDENCIES
+  irbs!
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 1.21)
   steep
-  yard
 
 BUNDLED WITH
    2.3.18

data/README.md

@@ -26,6 +26,8 @@ module App
     arg.to_s
   end
 
+  private
+
   # @sig (String) -> Integer
   def some_private_method(arg)
     arg.to_i
@@ -48,7 +50,7 @@ end
 See example task in [`Rakefile`](https://github.com/diaphragm/irbs/tree/master/Rakefile) and [`exmaple/`](https://github.com/diaphragm/irbs/tree/master/example) for more examples.
 
 This library uses itself for type checking.
-See typecheck task in [`Rakefile`](https://github.com/diaphragm/irbs/tree/master/Rakefile) and [`isig/irbs.rbs`](https://github.com/diaphragm/irbs/tree/master/isig/irbs.rbs)
+See typecheck task in [`Rakefile`](https://github.com/diaphragm/irbs/tree/master/Rakefile) and [`isig/irbs.rbs`](https://github.com/diaphragm/irbs/tree/master/sig/isig.rbs)
 
 ## Development
 

data/Rakefile

@@ -22,15 +22,15 @@ end
 
 desc 'typecheck'
 task :typecheck do
-  sh 'mkdir -p isig'
+  sh 'mkdir -p sig'
 
-  sh 'exe/irbs "lib/**/*.rb" -o isig/irbs.rbs'
+  sh 'exe/irbs "lib/**/*.rb" -o sig/isig.rbs'
   sh 'steep check lib'
 end
 
 desc 'Example of usage with TypeProf and Steep'
 task :example do
-  sh 'exe/irbs example/app.rb -o example/irbs.rbs --ignore-constant'
-  sh 'typeprof example/app.rb example/irbs.rbs -o example/typeprof.rbs'
+  sh 'exe/irbs example/app.rb -o example/isig.rbs --ignore-constant'
+  sh 'typeprof example/app.rb example/isig.rbs -o example/typeprof.rbs'
   sh 'steep check example'
 end

data/Steepfile

@@ -29,7 +29,7 @@
 # end
 
 target :lib do
-  signature 'isig'
+  signature 'sig'
 
   check 'lib'
 end

data/example/app.rb

@@ -5,6 +5,10 @@ module Submodule
   end
 end
 
+module PrependModule
+  prepend Submodule
+end
+
 module Example
   # @rbs type key = String | Symbol
   class App

data/example/{irbs.rbs → isig.rbs}

@@ -3,6 +3,10 @@
 module ::Submodule
 end
 
+module ::PrependModule
+  prepend ::Submodule
+end
+
 module ::Example
 end
 

data/example/typeprof.rbs

@@ -5,6 +5,10 @@ module Submodule
   def submethod: -> nil
 end
 
+module PrependModule
+  prepend Submodule
+end
+
 module Example
   class App
     HOGE: String

data/irbs.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'yard', '~> 0.9.28'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/irbs/cli.rb

@@ -5,17 +5,18 @@ require 'optparse'
 module Irbs
   class CLI
     # @sig String
-    NO_CONSTANT_HELP_MESSAGE = 'Generate no constant signatures. ' \
+    IGNORE_CONSTANT_HELP_MESSAGE = 'Generate no constant signatures. ' \
       'For using TypeProf. ' \
       '(TypeProf genarate duplicate constant signature even if already exists.)'
-    private_constant :NO_CONSTANT_HELP_MESSAGE
+    private_constant :IGNORE_CONSTANT_HELP_MESSAGE
 
     class << self
       # @sig (Array[String]) -> void
       def run(argv)
         config = parse_opt(argv)
         Core.new(config).generate
-        config.stdout.close
+      ensure
+        config&.stdout&.close
       end
 
       private
@@ -25,10 +26,10 @@ module Irbs
         config = Irbs::Config.new
         opt = OptionParser.new
 
-        opt.on('-o output', 'default: stdout') do
+        opt.on('-o output', 'Output filename. (Default: stdout)') do
           config.stdout = File.open(_1, 'w')
         end
-        opt.on('--ignore-constant', NO_CONSTANT_HELP_MESSAGE) do
+        opt.on('--ignore-constant', IGNORE_CONSTANT_HELP_MESSAGE) do
           config.ingore_constant = _1
         end
         config.paths = opt.parse(argv)

data/lib/irbs/core.rb

@@ -11,9 +11,15 @@ module Irbs
     def initialize(config)
       @config = config
 
+      # YARD::Parser::SourceParser.after_parse_file do |parser|
+      #   next unless parser.file == 'example/app.rb'
+      #   $parser = parser.instance_variable_get(:@parser)
+      # end
+
       YARD::Tags::Library.define_tag('Signature', :sig)
       YARD::Tags::Library.define_tag('Raw rbs code', :rbs)
-      YARD.parse(config.paths)
+
+      YARD::Parser::SourceParser.parse(config.paths)
       YARD::Registry.load_all
     end
 

data/lib/irbs/monkey_patch.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Irbs
+  # @rbs def statement: () -> untyped
+  module MonkeyPatch
+    protected
+
+    def process_mixin(mixin)
+      super.tap do
+        i = statement.method_name(true) == :include ? 0 : -1
+        ident = statement[0].source
+        _1[i].instance_variable_set(:@__ident, ident)
+      end
+    end
+  end
+end
+
+class YARD::Handlers::Ruby::MixinHandler # rubocop:disable Style/ClassAndModuleChildren
+  prepend ::Irbs::MonkeyPatch
+end

data/lib/irbs/rbs_generator.rb

@@ -45,10 +45,10 @@ module Irbs
     end
 
     # @sig () -> String
-    def to_rbs # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity
+    def to_rbs # rubocop:todo Metrics/AbcSize
       [
         namespace_definition,
-        raw_rbss.map{ Template.rbs(_1) },
+        raw_rbses.map{ Template.rbs(_1) },
         class_mixins.map{ Template.extend(_1) },
         instance_mixins.map{ Template.include(_1) },
         config.ingore_constant ? nil : constants.map{ Template.constant(_1) },
@@ -64,7 +64,7 @@ module Irbs
     end
 
     # @sig () -> Array[YARD::Tags::Tag]
-    def raw_rbss
+    def raw_rbses
       obj.tags(:rbs)
     end
 

data/lib/irbs/template.rb

@@ -24,7 +24,9 @@ module Irbs
 
       # @sig (YARD::CodeObjects::ModuleObject) -> String
       def include(mod)
-        "  include ::#{mod.path}"
+        ident = mod.instance_variable_get(:@__ident)
+
+        "  #{ident} ::#{mod.path}"
       end
 
       # @sig (YARD::CodeObjects::ModuleObject) -> String

data/lib/irbs/version.rb

@@ -2,5 +2,5 @@
 
 module Irbs
   # @sig String
-  VERSION = '0.1.0'
+  VERSION = '0.2.1'
 end

data/lib/irbs.rb

@@ -4,6 +4,7 @@ require_relative 'irbs/attribute_wrapper'
 require_relative 'irbs/cli'
 require_relative 'irbs/config'
 require_relative 'irbs/core'
+require_relative 'irbs/monkey_patch'
 require_relative 'irbs/rbs_generator'
 require_relative 'irbs/template'
 require_relative 'irbs/version'

data/{isig/irbs.rbs → sig/isig.rbs}

@@ -1,11 +1,11 @@
-# Irbs 0.1.0
+# Irbs 0.2.1
 
 module ::Irbs
   VERSION: String
 end
 
 class ::Irbs::CLI
-  NO_CONSTANT_HELP_MESSAGE: String
+  IGNORE_CONSTANT_HELP_MESSAGE: String
   public def self.run: (Array[String]) -> void
   private def self.parse_opt: (Array[String]) -> Irbs::Config
 end
@@ -32,6 +32,10 @@ module ::Irbs::Template
   public def self.rbs: (YARD::Tags::Tag) -> String
 end
 
+module ::Irbs::MonkeyPatch
+  def statement: () -> untyped
+end
+
 class ::Irbs::RbsGenerator
   extend ::Forwardable
   private attr_reader obj: YARD::CodeObjects::NamespaceObject
@@ -44,7 +48,7 @@ class ::Irbs::RbsGenerator
   private def writeout: () -> void
   private def to_rbs: () -> String
   private def namespace_definition: () -> String
-  private def raw_rbss: () -> Array[YARD::Tags::Tag]
+  private def raw_rbses: () -> Array[YARD::Tags::Tag]
   private def child_namespaces: () -> Array[YARD::CodeObjects::NamespaceObject]
   private def constants: () -> Array[YARD::CodeObjects::ConstantObject]
   private def meths: () -> Array[YARD::CodeObjects::MethodObject]

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: irbs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - diaphragm
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
-dependencies: []
+date: 2022-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.28
 description:
 email:
 - 7163746+diaphragm@users.noreply.github.com
@@ -26,21 +40,22 @@ files:
 - Rakefile
 - Steepfile
 - example/app.rb
-- example/irbs.rbs
+- example/isig.rbs
 - example/typeprof.rbs
 - exe/irbs
 - irbs.gemspec
-- isig/irbs.rbs
 - lib/irbs.rb
 - lib/irbs/attribute_wrapper.rb
 - lib/irbs/cli.rb
 - lib/irbs/config.rb
 - lib/irbs/core.rb
+- lib/irbs/monkey_patch.rb
 - lib/irbs/rbs_generator.rb
 - lib/irbs/template.rb
 - lib/irbs/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
+- sig/isig.rbs
 homepage: https://github.com/diaphragm/irbs
 licenses:
 - MIT