ruby-lsp-rubyfmt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8c479638aa3af78b4cfb62a38667b4ee5442bd55ce76fbc07ac14908c6f3ca11
+  data.tar.gz: ab1d2559148de64d2efd25d8f38c734dd535cf6f2f2e3aa8ea8f70084b73e219
+SHA512:
+  metadata.gz: 78b906a43886b546d05ea40fc2475e2fdbb21fa19e32c91998970bfce10fd74cfd053ae945819a9f432da9d400ba2a442e257f0eea5a066a7799c6f83bcf2c46
+  data.tar.gz: 295c86f42a0baae81315e19fd4f2ce3d538051bb567fb4702179e0f0d303751426a70605b15e3f3d59192e523570a63d1bc49e4421aee5969b1164d1dfdce69d

data/.github/workflows/ruby.yml

@@ -0,0 +1,44 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Set up Homebrew
+      id: set-up-homebrew
+      uses: Homebrew/actions/setup-homebrew@master
+    - name: Set up rubyfmt
+      run: brew install rubyfmt
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel
+    - name: Run tests
+      run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+require:
+  - rubocop-sorbet
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: disable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.2
+
+Naming/FileName:
+  Enabled: true
+
+Style/StderrPuts:
+  Enabled: true

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joshua.scharf@fullscript.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ruby-lsp-rubyfmt.gemspec
+gemspec
+
+# sorbet-static is not available on Windows. We also skip Tapioca since it depends on sorbet-static-and-runtime
+# C Ruby (MRI), Rubinius or TruffleRuby, but NOT Windows
+NON_WINDOWS_PLATFORMS = [:ruby]
+
+group :development do
+  gem "bundler", "~> 2.4.2"
+  gem "debug", "~> 1.8", require: false
+  gem "minitest", "~> 5.20"
+  gem "minitest-reporters", "~> 1.6"
+  gem "rake", "~> 13.1"
+  gem "rubocop", "~> 1.57"
+  gem "rubocop-shopify", "~> 2.14", require: false
+  gem "rubocop-minitest", "~> 0.33.0", require: false
+  gem "rubocop-rake", "~> 0.6.0", require: false
+  gem "rubocop-sorbet", "~> 0.7", require: false
+  gem "sorbet-static-and-runtime", platforms: NON_WINDOWS_PLATFORMS
+  gem "tapioca", require: false, platforms: NON_WINDOWS_PLATFORMS
+end

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    ruby-lsp-rubyfmt (0.1.0)
+      ruby-lsp (>= 0.12.0)
+      sorbet-runtime (>= 0.5.5685)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    erubi (1.12.0)
+    io-console (0.6.0)
+    irb (1.9.1)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.7.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.20.0)
+    minitest-reporters (1.6.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    netrc (0.11.0)
+    parallel (1.24.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    prism (0.17.1)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rbi (0.1.4)
+      prism (>= 0.17.1, < 0.18)
+      sorbet-runtime (>= 0.5.9204)
+    rdoc (6.6.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.2)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.58.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.33.0)
+      rubocop (>= 1.39, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-shopify (2.14.0)
+      rubocop (~> 1.51)
+    rubocop-sorbet (0.7.5)
+      rubocop (>= 0.90.0)
+    ruby-lsp (0.12.5)
+      language_server-protocol (~> 3.17.0)
+      prism (>= 0.17.1, < 0.18)
+      sorbet-runtime (>= 0.5.5685)
+    ruby-progressbar (1.13.0)
+    sorbet (0.5.11164)
+      sorbet-static (= 0.5.11164)
+    sorbet-runtime (0.5.11164)
+    sorbet-static (0.5.11164-universal-darwin)
+    sorbet-static-and-runtime (0.5.11164)
+      sorbet (= 0.5.11164)
+      sorbet-runtime (= 0.5.11164)
+    spoom (1.2.4)
+      erubi (>= 1.10.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      syntax_tree (>= 6.1.1)
+      thor (>= 0.19.2)
+    stringio (3.1.0)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    tapioca (0.11.14)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (>= 0.1.4, < 0.2)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.2.0, >= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.0)
+    unicode-display_width (2.5.0)
+    yard (0.9.34)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+
+PLATFORMS
+  arm64-darwin-22
+  arm64-darwin-23
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.4.2)
+  debug (~> 1.8)
+  minitest (~> 5.20)
+  minitest-reporters (~> 1.6)
+  rake (~> 13.1)
+  rubocop (~> 1.57)
+  rubocop-minitest (~> 0.33.0)
+  rubocop-rake (~> 0.6.0)
+  rubocop-shopify (~> 2.14)
+  rubocop-sorbet (~> 0.7)
+  ruby-lsp-rubyfmt!
+  sorbet-static-and-runtime
+  tapioca
+
+BUNDLED WITH
+   2.4.21

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Joshua Scharf
+
+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,65 @@
+# Ruby::Lsp::Rubyfmt
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-lsp-rubyfmt'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-lsp-rubyfmt
+
+## Dependency
+
+To use this Ruby LSP Addon, you need to have [`rubyfmt`](https://github.com/fables-tales/rubyfmt) installed as it's an external dependency.
+
+This addon calls the `rubyfmt` executable in `addon.rb`
+
+If you already have homebrew installed, you can install `rubyfmt` by running the following
+
+```
+brew install rubyfmt
+```
+
+If you don't, go to https://brew.sh and install it on your machine.
+
+Check if the installation was successfully by running the following
+```
+rubyfmt --version
+```
+
+If it was successful, you should see a version number printed.
+
+## Usage
+
+To use this addon, you need to modify the VS code setting `rubyLsp.formatter` in `settings.json`
+```
+"rubyLsp.formatter": "rubyfmt"
+```
+
+After that, open the VS code command pallete and select the option `Developer: Reload Window`.
+
+## 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 tags, 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]/ruby-lsp-rubyfmt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby::Lsp::Rubyfmt project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby-lsp-rubyfmt/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ruby/lsp/rubyfmt"
+
+# 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/ruby/lsp/rubyfmt/version.rb

@@ -0,0 +1,10 @@
+# typed: false
+# frozen_string_literal: true
+
+module Ruby
+  module Lsp
+    module Rubyfmt
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/ruby/lsp/rubyfmt.rb

@@ -0,0 +1,13 @@
+# typed: false
+# frozen_string_literal: true
+
+require "ruby/lsp/rubyfmt/version"
+
+module Ruby
+  module Lsp
+    module Rubyfmt
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/ruby_lsp/ruby-lsp-rubyfmt/addon.rb

@@ -0,0 +1,45 @@
+# typed: false
+# frozen_string_literal: true
+
+require "open3"
+
+module RubyLsp
+  module RubyLspRubyfmt
+    class Addon < RubyLsp::Addon
+      def name
+        "Ruby Fmt Formatter"
+      end
+
+      def activate
+        # The first argument is an identifier users can pick to select this formatter. To use this formatter, users must
+        # have rubyLsp.formatter configured to "rubyfmt"
+        # The second argument is a singleton instance that implements the `FormatterRunner` interface (see below)
+        RubyLsp::Requests::Formatting.register_formatter("rubyfmt", RubyFmtFormatterRunner.instance)
+      end
+
+      def deactivate
+      end
+    end
+
+    # Custom formatting runner
+    class RubyFmtFormatterRunner
+      # Make it a singleton class
+      include Singleton
+      # If using Sorbet to develop the addon, then include this interface to make sure the class is properly implemented
+      include RubyLsp::Requests::Support::FormatterRunner
+
+      # Use the initialize method to perform any sort of ahead of time work.
+      # For example, reading configurations for yourformatter since they are unlikely to change between requests
+      def initialize
+      end
+
+      # The main part of the interface is implementing the run method.
+      # It receives the URI and the document being formatted.
+      # IMPORTANT: This method must return the formatted document source without mutating the original one in document
+      def run(uri, document)
+        output, _status = Open3.capture2("rubyfmt", stdin_data: document.source)
+        output
+      end
+    end
+  end
+end

data/ruby-lsp-rubyfmt.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby/lsp/rubyfmt/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby-lsp-rubyfmt"
+  spec.version = Ruby::Lsp::Rubyfmt::VERSION
+  spec.authors = ["Joshua Scharf"]
+  spec.email = ["joshua@scharf.dev"]
+
+  spec.summary = "Ruby LSP rubyfmt"
+  spec.description = "An addon for the Ruby LSP that enables formatting with rubyfmt"
+  spec.homepage = "http://mygemserver.com"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/jscharf/ruby-lsp-rubyfmt"
+    spec.metadata["changelog_uri"] = "https://github.com/jscharf/ruby-lsp-rubyfmt"
+  else
+    raise(
+      "RubyGems 2.0 or newer is required to protect against " \
+        "public gem pushes.",
+    )
+  end
+
+  # 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(File.expand_path("..", __FILE__)) do
+    %x(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_dependency("ruby-lsp", ">= 0.12.0")
+  spec.add_dependency("sorbet-runtime", ">= 0.5.5685")
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: ruby-lsp-rubyfmt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Scharf
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5685
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5685
+description: An addon for the Ruby LSP that enables formatting with rubyfmt
+email:
+- joshua@scharf.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby/lsp/rubyfmt.rb
+- lib/ruby/lsp/rubyfmt/version.rb
+- lib/ruby_lsp/ruby-lsp-rubyfmt/addon.rb
+- ruby-lsp-rubyfmt.gemspec
+homepage: http://mygemserver.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://mygemserver.com
+  source_code_uri: https://github.com/jscharf/ruby-lsp-rubyfmt
+  changelog_uri: https://github.com/jscharf/ruby-lsp-rubyfmt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Ruby LSP rubyfmt
+test_files: []