rucoa 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1656b3603d72a44829a30fd9bd0d0d876ab9daa3af05cad16ad78298fa6fce7d
-  data.tar.gz: ff2fffdb7e90ed0f23cf782bc5c25db77dabb327c3e5b1d0a92aad8d2a5dc201
+  metadata.gz: f31a0a81d1013267e3bfc0358911e1306e22f0b34f40249604050914da18d8f4
+  data.tar.gz: b999e9fe78ee1dbb0b11662756c84399b474fb8522476429c90becb454fb0fd1
 SHA512:
-  metadata.gz: 49421faba6f35b3cf0bd33c12ae521cf55125fc8c8b044f5a4d353b4ee9413150b0ca4082884e786329b1cefa3cb5eb5ab513b9723e638cb9786ab768d2f8dd0
-  data.tar.gz: 8ef7dfaf46a49d70eb9404558191aadb3e1778f761a4642c432b53c9e3b1f208ff57f64a5b43ec7aef527dc4b573baaed10f4d859043574e86452b0af60aecb4
+  metadata.gz: 1af0f2fed0d7d7930f69768234263e77707f1f22d80e93392ae126c0cfa72d11b3356de6ba5c6f3476ff7b3f27239c1667ac1c2442e9e12301bdadb0a25fec47
+  data.tar.gz: bdd44ba9cb0284a16589798ec20ee7d9e9bf01989e054108859f3f8286a3f6382a45d84be056dd7a755de8b14d4cf9e28610652489e8e57f9c009b1f81c7f432

data/.rubocop.yml

@@ -29,6 +29,9 @@ RSpec/MultipleMemoizedHelpers:
 RSpec/NamedSubject:
   Enabled: false
 
+Security/MarshalLoad:
+  Enabled: false
+
 Sevencop/HashLiteralOrder:
   Enabled: true
 

data/Gemfile

@@ -11,3 +11,4 @@ gem 'rubocop-performance'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
 gem 'sevencop'
+gem 'yardspec'

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    rucoa (0.4.0)
+    rucoa (0.6.0)
       parser
+      rbs
       rubocop
+      yard
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +18,7 @@ GEM
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
+    rbs (2.6.0)
     regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -51,9 +54,15 @@ GEM
     rubocop-rspec (2.12.1)
       rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
-    sevencop (0.9.3)
+    sevencop (0.10.0)
       rubocop
     unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yardspec (0.2.0)
+      rspec
+      yard
 
 PLATFORMS
   x86_64-linux
@@ -67,6 +76,7 @@ DEPENDENCIES
   rubocop-rspec
   rucoa!
   sevencop
+  yardspec
 
 BUNDLED WITH
    2.3.21

data/README.md

@@ -15,15 +15,6 @@ To install rucoa gem, if your project is managed by bundler, add to your Gemfile
 gem 'rucoa'
 ```
 
-or in Rails application, we'll recommend you to do like this:
-
-```ruby
-# Gemfile
-group :development do
-  gem 'rucoa', require: false
-end
-```
-
 If bundler is not being used to manage dependencies, simply install the gem:
 
 ```bash
@@ -32,16 +23,55 @@ gem install rucoa
 
 ## Features
 
-- Diagnostics
-- Formatting
-- Quick Fix
-- Selection Range
-- Symbol
+### Diagnostics
+
+Displays RuboCop offenses and provides Quick Fix action for autocorrection.
+
+![demo](images/diagnostics.gif)
+
+### Formatting
+
+Run "Format Document" command or enable "Format On Save" in the settings to autocorrect RuboCop offenses.
+
+![demo](images/document-formatting.gif)
+
+### Selection
+
+Run "Expand Selection" command to select appropriate ranges.
+
+![demo](images/selection-ranges.gif)
+
+### Symbol
+
+See Outline section in the explorer panel to see document symbols in the current file, or run "Go to Symbol" command to search for symbols.
+
+This extension supports the folowiing types of symbols:
+
+- class
+- module
+- constant
+- instance method
+- singleton method (a.k.a. class method)
+- attribute (attr_accessor, attr_reader, and attr_writer)
+
+![demo](images/document-symbol.gif)
+
+## Experimental features
+
+### Completion
+
+Provides completion items for constant names and method names.
+
+### Hover
+
+Shows documentation for the symbol under the cursor.
+
+### Signature help
+
+Shows method signature help when you start to type method arguments like `"100".to_i(`.
 
-### Coming soon
+## Coming soon
 
-- Completion
-- Documentation
 - Go to Definition
 - Highlight
 - Semantic Tokens

data/lib/rucoa/cli.rb

@@ -16,8 +16,9 @@ module Rucoa
     # @return [void]
     def call
       Server.new(
-        input: $stdin,
-        output: $stdout
+        io_in: $stdin,
+        io_log: $stderr,
+        io_out: $stdout
       ).start
     end
   end

data/lib/rucoa/configuration.rb

@@ -2,57 +2,114 @@
 
 module Rucoa
   class Configuration
-    DEFAULT_SETTINGS = {
-      'base' => {
-        'enable' => 'auto',
-        'useBundler' => 'auto'
-      },
-      'feature' => {
-        'codeAction' => {
-          'enable' => true
-        },
-        'diagnostics' => {
-          'enable' => true
-        },
-        'documentSymbol' => {
-          'enable' => true
-        },
-        'formatting' => {
-          'enable' => true
-        },
-        'selectionRange' => {
-          'enable' => true
-        }
-      }
-    }.freeze
-
     def initialize
-      reset
+      @settings = {}
+    end
+
+    # @return [void]
+    def disable_code_action
+      disable_feature('codeAction')
+    end
+
+    # @return [void]
+    def disable_completion
+      disable_feature('completion')
+    end
+
+    # @return [void]
+    def disable_diagnostics
+      disable_feature('diagnostics')
+    end
+
+    # @return [void]
+    def disable_document_symbol
+      disable_feature('documentSymbol')
+    end
+
+    # @return [void]
+    def disable_formatting
+      disable_feature('formatting')
+    end
+
+    # @return [void]
+    def disable_hover
+      disable_feature('hover')
+    end
+
+    # @return [void]
+    def disable_selection_range
+      disable_feature('selectionRange')
+    end
+
+    # @return [void]
+    def disable_signature_help
+      disable_feature('signatureHelp')
+    end
+
+    # @return [void]
+    def enable_debug
+      @settings ||= {}
+      @settings['base'] ||= {}
+      @settings['base']['debug'] = true
     end
 
     # @return [Boolean]
+    # @example returns false if the configuration is empty
+    #   configuration = Rucoa::Configuration.new
+    #   expect(configuration).not_to be_enables_debug
+    # @example returns true if the configuration enables debug
+    #   configuration = Rucoa::Configuration.new
+    #   configuration.update('base' => { 'debug' => true })
+    #   expect(configuration).to be_enables_debug
+    def enables_debug?
+      fetch('base', 'debug', default: false)
+    end
+
+    # @return [Boolean]
+    # @example returns true if the configuration is empty
+    #   configuration = Rucoa::Configuration.new
+    #   expect(configuration).to be_enables_code_action
+    # @example returns false if the configuration disables code action
+    #   configuration = Rucoa::Configuration.new
+    #   configuration.disable_code_action
+    #   expect(configuration).not_to be_enables_code_action
     def enables_code_action?
-      @settings.dig('feature', 'codeAction', 'enable')
+      enables_feature?('codeAction')
+    end
+
+    # @return [Boolean]
+    def enables_completion?
+      enables_feature?('completion')
     end
 
     # @return [Boolean]
     def enables_diagnostics?
-      @settings.dig('feature', 'diagnostics', 'enable')
+      enables_feature?('diagnostics')
     end
 
     # @return [Boolean]
     def enables_document_symbol?
-      @settings.dig('feature', 'documentSymbol', 'enable')
+      enables_feature?('documentSymbol')
     end
 
     # @return [Boolean]
     def enables_formatting?
-      @settings.dig('feature', 'formatting', 'enable')
+      enables_feature?('formatting')
+    end
+
+    # @return [Boolean]
+    def enables_hover?
+      enables_feature?('hover')
     end
 
     # @return [Boolean]
     def enables_selection_range?
-      @settings.dig('feature', 'selectionRange', 'enable')
+      enables_feature?('selectionRange')
+    end
+
+    # @return [Boolean]
+    def enables_signature_help?
+      enables_feature?('signatureHelp')
     end
 
     # @param settings [Hash]
@@ -63,9 +120,31 @@ module Rucoa
 
     private
 
+    # @param feature [String]
     # @return [void]
-    def reset
-      @settings = DEFAULT_SETTINGS.dup
+    def disable_feature(feature)
+      @settings ||= {}
+      @settings['feature'] ||= {}
+      @settings['feature'][feature] ||= {}
+      @settings['feature'][feature]['enable'] = false
+    end
+
+    # @param feature [String]
+    # @return [Boolean]
+    def enables_feature?(feature)
+      fetch('feature', feature, 'enable', default: true)
+    end
+
+    # @param keys [Array<String>]
+    # @param default [Object]
+    # @return [Object]
+    def fetch(*keys, default:)
+      value = @settings.dig(*keys)
+      if value.nil?
+        default
+      else
+        value
+      end
     end
   end
 end

data/lib/rucoa/definition_archiver.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Rucoa
+  class DefinitionArchiver
+    RUBY_DEFINITIONS_DUMP_PATH = ::File.expand_path('../../data/definitions_ruby_3_1', __dir__).freeze
+    private_constant :RUBY_DEFINITIONS_DUMP_PATH
+
+    class << self
+      # @param definitions [Array<Rucoa::Definition::Base>]
+      # @return [void]
+      def dump(definitions)
+        pathname = ::Pathname.new(RUBY_DEFINITIONS_DUMP_PATH)
+        pathname.parent.mkpath
+        pathname.write(
+          ::Marshal.dump(definitions)
+        )
+      end
+
+      # @return [Array<Rucoa::Definition::Base>]
+      def load
+        ::Marshal.load(
+          ::File.binread(RUBY_DEFINITIONS_DUMP_PATH)
+        )
+      end
+    end
+  end
+end

data/lib/rucoa/definition_builders/rbs_constant_definition_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module DefinitionBuilders
+    # Build Rucoa contant definition from RBS constant declaration.
+    class RbsConstantDefinitionBuilder
+      class << self
+        # @param declaration [RBS::AST::Declarations::Constant]
+        # @return [Rucoa::Definitions::ConstantDefinition]
+        def call(declaration:)
+          new(
+            declaration: declaration
+          ).call
+        end
+      end
+
+      # @param declaration [RBS::AST::Declarations::Constant]
+      # @return [Rucoa::Definitions::ConstantDefinition]
+      def initialize(declaration:)
+        @declaration = declaration
+      end
+
+      # @return [Rucoa::Definitions::ConstantDefinition]
+      def call
+        ::Rucoa::Definitions::ConstantDefinition.new(
+          full_qualified_name: full_qualified_name,
+          source_path: source_path
+        )
+      end
+
+      private
+
+      # @return [String]
+      def full_qualified_name
+        @declaration.name.to_s.delete_prefix('::')
+      end
+
+      # @return [String]
+      def source_path
+        @declaration.location.name
+      end
+    end
+  end
+end

data/lib/rucoa/definition_builders/rbs_method_definition_builder.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require 'rbs'
+
+module Rucoa
+  module DefinitionBuilders
+    # Build Rucoa method definition from RBS method definition.
+    class RbsMethodDefinitionBuilder
+      class << self
+        # @param declaration [RBS::AST::Declarations::Class, RBS::AST::Declarations::Module]
+        # @param method_definition [RBS::AST::Members::MethodDefinition]
+        # @return [Rucoa::Definitions::MethodDefinition]
+        def call(declaration:, method_definition:)
+          new(
+            declaration: declaration,
+            method_definition: method_definition
+          ).call
+        end
+      end
+
+      # @param declaration [RBS::AST::Declarations::Class, RBS::AST::Declarations::Module]
+      # @param method_definition [RBS::AST::Members::MethodDefinition]
+      def initialize(declaration:, method_definition:)
+        @declaration = declaration
+        @method_definition = method_definition
+      end
+
+      # @return [Rucoa::Definitions::MethodDefinition]
+      def call
+        Definitions::MethodDefinition.new(
+          description: description,
+          kind: kind,
+          method_name: method_name,
+          namespace: namespace,
+          source_path: source_path,
+          types: types
+        )
+      end
+
+      private
+
+      # @return [Array<Rucoa::Types::MethodType>]
+      def types
+        @method_definition.types.map do |method_type|
+          RbsMethodTypeToRucoaMethodTypeMapper.call(
+            method_type: method_type
+          )
+        end
+      end
+
+      # @return [String, nil]
+      def description
+        @method_definition.comment&.string&.sub(/\A\s*<!--.*-->\s*/m, '')
+      end
+
+      # @return [String]
+      def namespace
+        @declaration.name.to_s.delete_prefix('::')
+      end
+
+      # @return [String]
+      def method_name
+        @method_definition.name.to_s
+      end
+
+      # @return [Symbol]
+      def kind
+        @method_definition.kind
+      end
+
+      # @return [String]
+      def source_path
+        @declaration.location.name
+      end
+
+      class RbsMethodTypeToRucoaMethodTypeMapper
+        class << self
+          # @param method_type [RBS::Types::MethodType]
+          # @return [Rucoa::Types::MethodType]
+          def call(method_type:)
+            new(method_type: method_type).call
+          end
+
+          # @param type [RBS::Types::Base]
+          # @return [String]
+          def stringify(type)
+            type.to_s.delete_prefix('::')
+          end
+        end
+
+        # @param method_type [RBS::Types::MethodType]
+        def initialize(method_type:)
+          @method_type = method_type
+        end
+
+        # @return [Rucoa::Types::MethodType]
+        def call
+          Types::MethodType.new(
+            parameters_string: @method_type.type.param_to_s,
+            return_type: self.class.stringify(@method_type.type.return_type)
+          )
+        end
+      end
+    end
+  end
+end