flog-lsp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2595e43190ca9642ecf9a731be9dff01baf8be9523b8b2ab1601ef1960ecce13
+  data.tar.gz: 20459f663bc893bac5b0a85caa74a449016ccf89bc5995395cef00d15875bf55
+SHA512:
+  metadata.gz: 53b0894058314bb5745552e850aceebfb4a1a6fe79941fcede047ca1c1fb7af212936108efb25892e12596b9f90370fe91538b931b4c28f6aa84516b1e7cd5de
+  data.tar.gz: aa269244bc6c72dcf5fa437660e85971f182551f6480f958a99b9b61626c8ff3ef9251745f87b56eb83f01b95637ab44b2bb6559c1e9a7dba499ba1f084b6c5b

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-sorbet
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2024-03-22
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris AtLee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# FlogLsp
+
+TODO: Delete this and the text below, and describe your gem
+
+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/flog/lsp`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/flog-lsp.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]

data/exe/flog-lsp

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "flog_lsp/cli"
+FlogLsp::Cli.start

data/flog-lsp.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/flog_lsp/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "flog-lsp"
+  spec.version = FlogLsp::VERSION
+  spec.authors = ["Chris AtLee"]
+  spec.email = ["chris.atlee@shopify.com"]
+
+  spec.summary = "LSP for providing flog metrics in the editor"
+  spec.homepage = "https://github.com/catlee/flog-lsp"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/catlee/flog-lsp/blob/master/CHANGELOG.md"
+
+  # 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
+    %x(git ls-files -z).split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?("bin/", "test/", "spec/", "features/", ".git", ".github", "appveyor", "Gemfile")
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("flog", "~> 4.8")
+  spec.add_dependency("language_server-protocol", "~> 3.16")
+  spec.add_dependency("sorbet-runtime", "~> 0.5")
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/flog_lsp/cli.rb

@@ -0,0 +1,32 @@
+# typed: false
+# frozen_string_literal: true
+
+require "optparse"
+require "logger"
+require "flog_lsp/lsp"
+
+module FlogLsp
+  module Cli
+    class << self
+      def start
+        options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: flog-lsp [options]"
+          opts.on("-v", "--verbose", "Run verbosely") do |v|
+            options[:verbose] = v
+          end
+          opts.on("-h", "--help", "Prints this help") do
+            puts opts
+            exit
+          end
+        end.parse!
+        logger = FlogLsp.logger = Logger.new($stderr)
+        # logger = FlogLsp.logger = Logger.new("flog-lsp.log")
+        logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO
+        logger.info("flog-lsp version #{FlogLsp::VERSION} starting...")
+        lsp = FlogLsp::Server.new
+        lsp.start
+      end
+    end
+  end
+end

data/lib/flog_lsp/lsp.rb

@@ -0,0 +1,195 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "language_server-protocol"
+require "cgi"
+require "uri"
+require "flog"
+require_relative "version"
+
+# Alias for LanguageServer::Protocol
+LSP = LanguageServer::Protocol
+
+module FlogLsp
+  class Error < StandardError; end
+
+  class << self
+    def logger
+      @logger ||= Logger.new($stderr)
+    end
+
+    attr_writer :logger
+  end
+
+  class Server
+    HANDLERS = {
+      "initialize" => :handle_initialize,
+      "initialized" => :handle_initialized,
+      "textDocument/diagnostic" => :handle_diagnostic,
+      "textDocument/didOpen" => :handle_open,
+      "textDocument/didChange" => :handle_change,
+      "textDocument/didClose" => :handle_close,
+      "shutdown" => :handle_shutdown,
+      "exit" => :handle_exit,
+    }
+
+    def initialize
+      @file_data = {}
+      @options = {}
+    end
+
+    def score_threshold
+      @options.fetch(:score_threshold, 10)
+    end
+
+    def file_data(uri)
+      @file_data[uri] ||= begin
+        path = CGI.unescape(URI.parse(uri).path)
+        logger.debug("Loading file #{path}")
+        File.read(path)
+      end
+    end
+
+    def logger
+      FlogLsp.logger
+    end
+
+    def start
+      writer = LSP::Transport::Stdio::Writer.new
+      reader = LSP::Transport::Stdio::Reader.new
+      reader.read do |request|
+        response = handle(request)
+        unless response.nil?
+          writer.write(id: request[:id], result: response)
+        end
+      end
+    end
+
+    def handle(request)
+      logger.debug("Received request: #{request[:method]}")
+      if HANDLERS.key?(request[:method])
+        send(HANDLERS[request[:method]], request)
+      else
+        logger.warn("Unknown request: #{request[:method]}")
+        nil
+      end
+    end
+
+    def handle_initialize(request)
+      logger.debug("Initializing with request: #{request}")
+      @options = request[:params][:initializationOptions] || {}
+
+      LSP::Interface::InitializeResult.new(
+        capabilities: LSP::Interface::ServerCapabilities.new(
+          text_document_sync: LSP::Interface::TextDocumentSyncOptions.new(
+            change: LSP::Constant::TextDocumentSyncKind::INCREMENTAL,
+            open_close: true,
+          ),
+          diagnostic_provider: LSP::Interface::DiagnosticOptions.new(
+            identifier: "flog",
+            inter_file_dependencies: false,
+            workspace_diagnostics: false,
+          ),
+        ),
+        server_info: {
+          name: "Flog LSP",
+          version: FlogLsp::VERSION,
+        },
+      )
+    end
+
+    def handle_initialized(request)
+      nil
+    end
+
+    def handle_shutdown(request)
+      nil
+    end
+
+    def handle_exit(request)
+      Kernel.exit(0)
+    end
+
+    def handle_open(request)
+      # Load the file
+      uri = request[:params][:textDocument][:uri]
+      file_data(uri)
+      nil
+    end
+
+    def handle_close(request)
+      uri = request[:params][:textDocument][:uri]
+      @file_data.delete(uri)
+      nil
+    end
+
+    def get_prefix(lines, line, character)
+      lines[0...line].join + lines[line][0...character]
+    end
+
+    def get_suffix(lines, line, character)
+      if line >= lines.length
+        ""
+      else
+        lines[line][character..] + lines[line + 1..].join
+      end
+    end
+
+    def patch_contents(contents, range, text)
+      lines = contents.lines
+      prefix = get_prefix(lines, range[:start][:line], range[:start][:character])
+      suffix = get_suffix(lines, range[:end][:line], range[:end][:character])
+      prefix + text + suffix
+    end
+
+    def handle_change(request)
+      uri = request[:params][:textDocument][:uri]
+      request[:params][:contentChanges].each do |change|
+        @file_data[uri] = if change.key?(:range)
+          patch_contents(file_data(uri), change[:range], change[:text])
+        else
+          change[:text]
+        end
+      end
+      nil
+    end
+
+    def get_diagnostics(contents)
+      flog = Flog.new
+      flog.flog_ruby(contents)
+      flog.calculate_total_scores
+      flog.totals.filter_map do |method_name, score|
+        next if score <= score_threshold
+
+        location = flog.method_locations[method_name]
+        next unless location
+
+        _filename, range = location.split(":")
+        start_line, _end_line = range.split("-")
+        [method_name, start_line, score]
+      end
+    end
+
+    def handle_diagnostic(request)
+      uri = request[:params][:textDocument][:uri]
+      contents = file_data(uri)
+      diagnostics = get_diagnostics(contents).map do |method_name, start_line, score|
+        LSP::Interface::Diagnostic.new(
+          range: LSP::Interface::Range.new(
+            start: LSP::Interface::Position.new(line: start_line.to_i - 1, character: 0),
+            end: LSP::Interface::Position.new(line: start_line.to_i - 1, character: 0),
+            # end: LSP::Interface::Position.new(line: end_line.to_i - 1, character: 0),
+          ),
+          severity: LSP::Constant::DiagnosticSeverity::WARNING,
+          source: "flog",
+          message: "#{method_name} has a flog score of #{score.round(2)}",
+          data: { correctable: false },
+        )
+      end
+      LSP::Interface::FullDocumentDiagnosticReport.new(kind: "full", items: diagnostics)
+    rescue StandardError => e
+      logger.error("Error calculating flog: #{e}")
+      LSP::Interface::FullDocumentDiagnosticReport.new(kind: "full", items: [])
+    end
+  end
+end

data/lib/flog_lsp/version.rb

@@ -0,0 +1,6 @@
+# typed: false
+# frozen_string_literal: true
+
+module FlogLsp
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: flog-lsp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris AtLee
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: language_server-protocol
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description:
+email:
+- chris.atlee@shopify.com
+executables:
+- flog-lsp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/flog-lsp
+- flog-lsp.gemspec
+- lib/flog_lsp.rb
+- lib/flog_lsp/cli.rb
+- lib/flog_lsp/lsp.rb
+- lib/flog_lsp/version.rb
+homepage: https://github.com/catlee/flog-lsp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/catlee/flog-lsp
+  source_code_uri: https://github.com/catlee/flog-lsp
+  changelog_uri: https://github.com/catlee/flog-lsp/blob/master/CHANGELOG.md
+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.3.15
+signing_key:
+specification_version: 4
+summary: LSP for providing flog metrics in the editor
+test_files: []