solargraph-rspec 0.1.0

data/lib/solargraph/rspec/util.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+# Credits: This file is a copy of the file from the solargraph-rspec gem
+
+# rubocop:disable Naming/MethodParameterName
+module Solargraph
+  module Rspec
+    # Utility methods for building pins and references.
+    module Util
+      def self.build_public_method(
+        ns,
+        name,
+        types: nil,
+        location: nil,
+        comments: [],
+        attribute: false,
+        scope: :instance
+      )
+        opts = {
+          name: name,
+          location: location,
+          closure: ns,
+          scope: scope,
+          attribute: attribute,
+          comments: []
+        }
+
+        comments << "@return [#{types.join(",")}]" if types
+
+        opts[:comments] = comments.join("\n")
+
+        Solargraph::Pin::Method.new(**opts)
+      end
+
+      def self.build_module_include(ns, module_name, location)
+        Solargraph::Pin::Reference::Include.new(
+          closure: ns,
+          name: module_name,
+          location: location
+        )
+      end
+
+      def self.build_module_extend(ns, module_name, location)
+        Solargraph::Pin::Reference::Extend.new(
+          closure: ns,
+          name: module_name,
+          location: location
+        )
+      end
+
+      def self.dummy_location(path)
+        Solargraph::Location.new(
+          File.expand_path(path),
+          Solargraph::Range.from_to(0, 0, 0, 0)
+        )
+      end
+
+      # @param ast [Parser::AST::Node]
+      def self.build_location(ast, path)
+        Solargraph::Location.new(
+          File.expand_path(path),
+          Solargraph::Range.from_to(
+            ast.location.first_line,
+            ast.location.column,
+            ast.location.last_line,
+            ast.location.last_column
+          )
+        )
+      end
+
+      def self.method_return(path, type)
+        Solargraph::Pin::Reference::Override.method_return(path, type)
+      end
+    end
+  end
+end
+# rubocop:enable Naming/MethodParameterName

data/lib/solargraph/rspec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Rspec
+    VERSION = '0.1.0'
+  end
+end

data/lib/solargraph/rspec/walker.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# Credits: This file is a copy of the original file from the solargraph-rails gem.
+
+module Solargraph
+  module Rspec
+    class Walker
+      class Hook
+        attr_reader :node_type
+
+        # @param node_type [Symbol]
+        # @param args [Array]
+        # @param block [Proc]
+        def initialize(node_type, args, &block)
+          @node_type = node_type
+          @args = args
+          @proc = Proc.new(&block)
+        end
+
+        # @param node [Parser::AST::Node]
+        # @return [void]
+        def visit(node)
+          return unless matches?(node)
+
+          if @proc.arity == 1
+            @proc.call(node)
+          elsif @proc.arity == 2
+            walker = Walker.new(node)
+            @proc.call(node, walker)
+            walker.walk
+          end
+        end
+
+        private
+
+        # @param node [Parser::AST::Node]
+        # @return [Boolean]
+        def matches?(node)
+          return false unless node.type == node_type
+          return false unless node.children
+          return true if @args.empty?
+
+          a_child_matches = node.children.first.is_a?(::Parser::AST::Node) && node.children.any? do |child|
+            child.is_a?(::Parser::AST::Node) &&
+              match_children(child.children, @args[1..])
+          end
+
+          return true if a_child_matches
+
+          match_children(node.children)
+        end
+
+        # @param children [Array<Parser::AST::Node>]
+        def match_children(children, args = @args)
+          args.each_with_index.all? do |arg, i|
+            if arg == :any
+              true
+            elsif children[i].is_a?(::Parser::AST::Node) && arg.is_a?(Symbol)
+              children[i].type == arg
+            else
+              children[i] == arg
+            end
+          end
+        end
+      end
+
+      # https://github.com/castwide/solargraph/issues/522
+      def self.normalize_ast(source)
+        ast = source.node
+
+        if ast.is_a?(::Parser::AST::Node)
+          ast
+        else
+          NodeParser.parse_with_comments(source.code, source.filename)
+        end
+      end
+
+      # @param source [Solargraph::Source]
+      def self.from_source(source)
+        new(*normalize_ast(source))
+      end
+
+      # @return ast [Parser::AST::Node]
+      attr_reader :ast
+      # @return comments [Hash]
+      attr_reader :comments
+
+      # @param ast [Parser::AST::Node]
+      # @param comments [Hash]
+      def initialize(ast, comments = {})
+        @comments = comments
+        @ast = ast
+        @hooks = Hash.new([])
+      end
+
+      # @param node_type [Symbol]
+      # @param args [Array]
+      # @param block [Proc]
+      def on(node_type, args = [], &block)
+        @hooks[node_type] << Hook.new(node_type, args, &block)
+      end
+
+      # @return [void]
+      def walk
+        @ast.is_a?(Array) ? @ast.each { |node| traverse(node) } : traverse(@ast)
+      end
+
+      private
+
+      # @param node [Parser::AST::Node]
+      def traverse(node)
+        return unless node.is_a?(::Parser::AST::Node)
+
+        @hooks[node.type].each { |hook| hook.visit(node) }
+
+        node.children.each { |child| traverse(child) }
+      end
+    end
+  end
+end

data/lib/solargraph-rspec.rb

@@ -0,0 +1,19 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'solargraph'
+require 'active_support'
+
+require_relative 'solargraph/rspec/version'
+require_relative 'solargraph/rspec/convention'
+
+module Solargraph
+  module Rspec
+    class NodeParser
+      extend Solargraph::Parser::Legacy::ClassMethods
+    end
+  end
+end
+
+Solargraph::Convention.register Solargraph::Rspec::Convention
+# rubocop:enable Naming/FileName

data/lib/solargraph_rspec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'solargraph-rspec'

data/sig/solargraph/rspec.rbs

@@ -0,0 +1,6 @@
+module Solargraph
+  module Rspec
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/solargraph-rspec.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solargraph/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solargraph-rspec'
+  spec.version = Solargraph::Rspec::VERSION
+  spec.authors = ['Lekë Mula']
+  spec.email = ['leke.mula@gmail.com']
+
+  spec.summary = 'Solargraph plugin supporting RSpec code completion'
+  spec.description = 'RSpec is a testing tool of choice for many Ruby developers. ' \
+                     'This plugin provides code completion and other features for RSpec files in Solargraph.'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['source_code_uri'] = 'https://github.com/lekemula/solargraph-rspec'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '~> 6.0'
+  spec.add_runtime_dependency 'solargraph', '~> 0.49', '>= 0.49.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: solargraph-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lekë Mula
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: RSpec is a testing tool of choice for many Ruby developers. This plugin
+  provides code completion and other features for RSpec files in Solargraph.
+email:
+- leke.mula@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/solargraph-rspec.rb
+- lib/solargraph/rspec/config.rb
+- lib/solargraph/rspec/convention.rb
+- lib/solargraph/rspec/correctors/base.rb
+- lib/solargraph/rspec/correctors/context_block_methods_corrector.rb
+- lib/solargraph/rspec/correctors/context_block_namespace_corrector.rb
+- lib/solargraph/rspec/correctors/described_class_corrector.rb
+- lib/solargraph/rspec/correctors/dsl_methods_corrector.rb
+- lib/solargraph/rspec/correctors/example_and_hook_blocks_binding_corrector.rb
+- lib/solargraph/rspec/correctors/implicit_subject_method_corrector.rb
+- lib/solargraph/rspec/correctors/let_methods_corrector.rb
+- lib/solargraph/rspec/correctors/subject_method_corrector.rb
+- lib/solargraph/rspec/correctors/walker_base.rb
+- lib/solargraph/rspec/spec_walker.rb
+- lib/solargraph/rspec/util.rb
+- lib/solargraph/rspec/version.rb
+- lib/solargraph/rspec/walker.rb
+- lib/solargraph_rspec.rb
+- sig/solargraph/rspec.rbs
+- solargraph-rspec.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/lekemula/solargraph-rspec
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Solargraph plugin supporting RSpec code completion
+test_files: []