solargraph-dead_end 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1cb198b784ad3e4cfa4d956d034c1f5485b42512b49fcac24570ed631c9ea017
+  data.tar.gz: f219d6ef309f2e6f4aa7a056a6d0db88cef722e4d7a238c70da4bbe7b631bbfd
+SHA512:
+  metadata.gz: ae278e98e68e9f054c67e9360afa73f86372e74b40280630d952a8b58db9a94ce654afee509e049b317a2f0f7e47e48b675f19c1c38e1e3466d5a268efe53b85
+  data.tar.gz: 61647b707c5ed3ce59314e13320acb48e1215abf9fdee212bbad51543a42ed3941c980bd4e6791ae9f9664b84c462415b55db4a4c074b770bef7b4e1902bb5bd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.solargraph.yml

@@ -0,0 +1,23 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- standardrb
+- require_not_found
+formatter:
+  rubocop:
+    cops: safe
+    except: []
+    only: []
+    extra_args: []
+require_paths: []
+plugins:
+- solargraph-standardrb
+max_files: 5000

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-12-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in solargraph-dead_end.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+group :test, :development do
+  gem "byebug"
+  gem "pry"
+  gem "rspec", "~> 3.0"
+  gem "solargraph"
+  gem "solargraph-standardrb"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Fritz Meissner
+
+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,39 @@
+# Solargraph::DeadEnd
+
+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/solargraph/dead_end`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solargraph-dead_end'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install solargraph-dead_end
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/iftheshoefritz/solargraph-dead_end.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solargraph/dead_end"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/solargraph/dead_end/reporter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module DeadEnd
+    class Reporter < Solargraph::Diagnostics::Base
+      def diagnose(source, _api_map)
+        return [] if source.code.empty?
+
+        search = ::DeadEnd::CodeSearch.new(source.code, record_dir: nil).call
+
+        blocks = search.invalid_blocks
+
+        return [] if blocks.empty?
+
+        result = []
+        blocks.each do |block|
+          explain = ::DeadEnd::ExplainSyntax.new(
+            code_lines: block.lines
+          ).call
+
+          lines = ::DeadEnd::CaptureCodeContext.new(
+            blocks: block,
+            code_lines: search.code_lines
+          ).call
+
+          document = ::DeadEnd::DisplayCodeWithLineNumbers.new(
+            lines: lines,
+            terminal: @terminal,
+            highlight_lines: block.lines
+          ).call
+
+          result << error_output(explain, document, block)
+        end
+
+        result
+      end
+
+      private
+
+      def error_output(explain, document, block)
+        relevant_lines = block.lines.reject { |l| l.line.strip.empty? }
+        {
+          message: explain.errors.first + "\n" + document,
+          range: {
+            start: {
+              line: relevant_lines.first.line_number - 1,
+              character: 0
+            },
+            end: {
+              line: relevant_lines.last.line_number - 1,
+              character: relevant_lines.last.line.length
+            }
+          },
+          severity: 1,
+          source: "DeadEnd",
+          code: "Syntax"
+        }
+      end
+    end
+  end
+end

data/lib/solargraph/dead_end/version.rb

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

data/lib/solargraph-dead_end.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "solargraph"
+require "solargraph/dead_end/version"
+require "solargraph/dead_end/reporter"
+require "dead_end"
+
+Solargraph::Diagnostics.register "dead_end", Solargraph::DeadEnd::Reporter

data/solargraph-dead_end.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/solargraph/dead_end/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "solargraph-dead_end"
+  spec.version = Solargraph::DeadEnd::VERSION
+  spec.authors = ["Fritz Meissner"]
+  spec.email = ["fritz.meissner@gmail.com"]
+
+  spec.summary = "Solargraph DeadEnd reporter"
+  spec.description = "Solargraph DeadEnd reporter"
+  spec.homepage = "https://github.com/iftheshoefritz/solargraph-dead_end"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "solargraph", ">= 0.39.1"
+  spec.add_runtime_dependency "dead_end"
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: solargraph-dead_end
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fritz Meissner
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.39.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.39.1
+- !ruby/object:Gem::Dependency
+  name: dead_end
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solargraph DeadEnd reporter
+email:
+- fritz.meissner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".solargraph.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/solargraph-dead_end.rb
+- lib/solargraph/dead_end/reporter.rb
+- lib/solargraph/dead_end/version.rb
+- solargraph-dead_end.gemspec
+homepage: https://github.com/iftheshoefritz/solargraph-dead_end
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Solargraph DeadEnd reporter
+test_files: []