rubocop-crystal 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3beb9db336ee0d664fdd093775a9c14dc9512c8ec84be250ec177a6763b4924d
-  data.tar.gz: 015acc39018447fef5d62304bf91dddab3b66faa795149f00b3e447de6db5990
+  metadata.gz: bbaf055e01ff70c7c189f9b6a73c94bf6ffbc50d7c0a335103177b5b8b52fb4a
+  data.tar.gz: ff97d8c93dd042f6dc9288a4adc97dc975c953fda4cc3e4c4af3b7ca7b8fb795
 SHA512:
-  metadata.gz: 2077733fe1bc6189b71854a249601f8294366a2d86cd013822bb6ec9fd1371e9229ad6622dc169426ae35c75b1f65e26f5308538a749e2b02fb7239ac99a087e
-  data.tar.gz: ea546caea1eeb127c946df8c97ec77ba7e5572db33c63402bba1ad4ffeeaca05d19d402d6c6a96aa37d4641f2aeda11d95a8f26a2e6b1c18a473961b8468d221
+  metadata.gz: 479c9f1a1c18e2147ebbbc22e8c4aa77d683e5601653d3ddbfa565ba7bee08d94aef3b92e1fabe41afcd5250a529a0a36672623db22a4206e840a40176d7fa4e
+  data.tar.gz: 262807664ebcfa6e7ae82af586e2c1535378184bfc20cb722932d62a6e6f75465acbd6781b79720a5cfec94460dea4ed31d55080f5192b1203b23c15ccf5b34a

data/.github/workflows/rspec.yml

@@ -0,0 +1,16 @@
+name: RSpec
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v4
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1.2'
+      - name: Install dependencies
+        run: gem install rspec rubocop
+      - name: Run spec
+        run: rspec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,16 @@
+name: Rubocop
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v4
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1.2'
+      - name: Install rubocop
+        run: gem install rubocop
+      - name: Run rubocop
+        run: rubocop

data/.github/workflows/test.yml

@@ -21,6 +21,6 @@ jobs:
           gem build rubocop-crystal
           gem install rubocop-crystal
       - name: Convert test files
-        run: rubocop --require rubocop-crystal --fail-level fatal -A test
+        run: rubocop --plugin rubocop-crystal -c config/default.yml --fail-level fatal -A test
       - name: Run tests (Crystal)
         run: crystal run test/string.cr

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,36 @@
+plugins:
+  - rubocop-internal_affairs
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'test/*'
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+# TODO: Find out what ruby version we actually require and then remove this.
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+InternalAffairs/OnSendWithoutOnCSend:
+  Exclude:
+    - 'lib/rubocop/cop/crystal/require_relative.rb'
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: False
+
+Style/FrozenStringLiteralComment:
+  Enabled: False
+
+Style/MutableConstant:
+  Enabled: False

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.0.3 (2025-04-28)
+
+### New features
+
+* Enable Style/BlockComments cop ([@zopolis4][])
+* Enable Style/WhileUntilDo cop ([@zopolis4][])
+* Add Crystal/MethodNameStartingWithUppercaseLetter cop ([@zopolis4][])
+
+### Changes
+
+* Convert to Rubocop plugin ([@zopolis4][])
+
 ## 0.0.2 (2024-08-01)
 
 ### New features

data/README.md

@@ -38,5 +38,9 @@ gem install rubocop-crystal
 ## Usage
 
 ```
-rubocop --require rubocop-crystal
+rubocop --plugin rubocop-crystal
 ```
+
+Note that there are some differences between Ruby and Crystal that can be automatically resolved, while some (at least for now) require manual intervention.
+
+If you wish to only process the autocorrectable offenses, add `--disable-uncorrectable`, while reporting only the offenses requiring manual intervention is waiting on rubocop/rubocop#13275.

data/config/default.yml

@@ -9,6 +9,10 @@ Crystal/InterpolationInSingleQuotes:
   Description: "This cop uses %q in place of ' if the enclosed string would be affected by interpolation."
   Enabled: true
 
+Crystal/MethodNameStartingWithUppercaseLetter:
+  Description: 'This cop detects method names that start with uppercase letters.'
+  Enabled: true
+
 Crystal/RequireRelative:
   Description: 'This cop replaces require_relative with require while maintaining behavior.'
   Enabled: true
@@ -16,9 +20,15 @@ Crystal/RequireRelative:
 Lint/ImplicitStringConcatenation:
   Enabled: true
 
+Style/BlockComments:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Style/MethodDefParentheses:
+Style/WhileUntilDo:
   Enabled: true

data/lib/rubocop/cop/crystal/interpolation_in_single_quotes.rb

@@ -23,10 +23,10 @@ module RuboCop
           return unless node.source.start_with?("'")
           # Replace the single quotes deliminating the string with double quotes, and check if the resulting ast is still the same.
           # If it is, the string doesn't have any interpolation to avoid, and we're done here.
-          return if node == parse('"' + node.source[1..-2] + '"').ast
+          return if node == parse("\"#{node.source[1..-2]}\"").ast
 
           add_offense(node) do |corrector|
-            corrector.replace(node, '%q(' + node.source[1..-2] + ')')
+            corrector.replace(node, "%q(#{node.source[1..-2]})")
           end
         end
       end

data/lib/rubocop/cop/crystal/method_name_starting_with_uppercase_letter.rb

@@ -0,0 +1,30 @@
+module RuboCop
+  module Cop
+    module Crystal
+      # Method names cannot start with uppercase letters in Crystal:
+      # https://crystal-lang.org/reference/latest/syntax_and_semantics/methods_and_instance_variables.html
+      # ^ "Method names begin with a lowercase letter and, as a convention, only use lowercase letters, underscores and numbers."
+      #
+      # @example
+      #   # bad
+      #   def Foo(bar)
+      #     qux
+      #   end
+      #   Foo(bar)
+      #
+      #   # good
+      #   def foo(bar)
+      #     qux
+      #   end
+      #   foo(bar)
+      #
+      class MethodNameStartingWithUppercaseLetter < Base
+        MSG = 'Method names must start with a lowecase letter in Crystal.'
+
+        def on_def(node)
+          add_offense(node.loc.name) if node.method_name.to_s.chr.capitalize!.nil?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/crystal/require_relative.rb

@@ -24,11 +24,11 @@ module RuboCop
 
         def on_send(node)
           add_offense(node) do |corrector|
-            if node.first_argument.value.start_with?('.', '/')
-              require_value = node.first_argument.value
-            else
-              require_value = "./#{node.first_argument.value}"
-            end
+            require_value = if node.first_argument.value.start_with?('.', '/')
+                              node.first_argument.value
+                            else
+                              "./#{node.first_argument.value}"
+                            end
             corrector.replace(node, "require '#{require_value}'")
           end
         end

data/lib/rubocop/cop/crystal_cops.rb

@@ -1,3 +1,4 @@
 require_relative 'crystal/file_extension'
 require_relative 'crystal/interpolation_in_single_quotes'
+require_relative 'crystal/method_name_starting_with_uppercase_letter'
 require_relative 'crystal/require_relative'

data/lib/rubocop/crystal/plugin.rb

@@ -0,0 +1,28 @@
+require 'lint_roller'
+
+module RuboCop
+  module Crystal
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-crystal',
+          version: '0.0.3',
+          homepage: 'https://github.com/Zopolis4/rubocop-crystal',
+          description: 'A RuboCop extension for converting Ruby to Crystal.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop-crystal.rb

@@ -1,8 +1,6 @@
 require 'rubocop'
 
 require_relative 'rubocop/crystal'
-require_relative 'rubocop/crystal/inject'
-
-RuboCop::Crystal::Inject.defaults!
+require_relative 'rubocop/crystal/plugin'
 
 require_relative 'rubocop/cop/crystal_cops'

data/rubocop-crystal.gemspec

@@ -1,14 +1,17 @@
 Gem::Specification.new do |spec|
   spec.name     = 'rubocop-crystal'
   spec.summary  = 'A RuboCop extension for converting Ruby to Crystal.'
-  spec.version  = '0.0.2'
+  spec.version  = '0.0.3'
   spec.license  = 'GPL-3.0-or-later'
   spec.author   = 'Zopolis4'
   spec.email    = 'creatorsmithmdt@gmail.com'
   spec.homepage = 'https://github.com/Zopolis4/rubocop-crystal'
 
+  spec.metadata['default_lint_roller_plugin'] = 'RuboCop::Crystal::Plugin'
+
   spec.files         = `git ls-files`.split("\n")
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '>= 1.65.1'
+  spec.add_dependency 'lint_roller'
+  spec.add_dependency 'rubocop', '>= 1.72.1'
 end

data/spec/rubocop/cop/crystal/interpolation_in_single_quotes_spec.rb

@@ -0,0 +1,30 @@
+RSpec.describe RuboCop::Cop::Crystal::InterpolationInSingleQuotes, :config do
+  it 'does not register an offense when a non-interpolated string is in double quotes' do
+    expect_no_offenses(<<~RUBY)
+      "foo"
+    RUBY
+  end
+
+  it 'does not register an offense when an interpolated string is in double quotes' do
+    expect_no_offenses(<<~'RUBY')
+      "foo #{bar}"
+    RUBY
+  end
+
+  it 'does not register an offense when a non-interpolated string is in single quotes' do
+    expect_no_offenses(<<~RUBY)
+      'foo'
+    RUBY
+  end
+
+  it 'registers an offense when an interpolated string is in single quotes' do
+    expect_offense(<<~'RUBY')
+      'foo #{bar}'
+      ^^^^^^^^^^^^ Crystal does not support the use of single-quote deliminated strings to avoid interpolation.
+    RUBY
+
+    expect_correction(<<~'RUBY')
+      %q(foo #{bar})
+    RUBY
+  end
+end

data/spec/rubocop/cop/crystal/method_name_starting_with_uppercase_letter_spec.rb

@@ -0,0 +1,35 @@
+RSpec.describe RuboCop::Cop::Crystal::MethodNameStartingWithUppercaseLetter, :config do
+  it 'registers an offense when the first letter of a method name is capitalized' do
+    expect_offense(<<~RUBY)
+      def Foo
+          ^^^ Method names must start with a lowecase letter in Crystal.
+        bar
+      end
+    RUBY
+  end
+
+  it 'registers an offense when all the letters of a method name are capitalized' do
+    expect_offense(<<~RUBY)
+      def FOO
+          ^^^ Method names must start with a lowecase letter in Crystal.
+        bar
+      end
+    RUBY
+  end
+
+  it 'does not register an offense when the first letter of a method name is lowercase' do
+    expect_no_offenses(<<~RUBY)
+      def foo
+        bar
+      end
+    RUBY
+  end
+
+  it 'does not register an offense when the first letter of a method name is lowercase regardless of the rest of the method name' do
+    expect_no_offenses(<<~RUBY)
+      def fOO
+        bar
+      end
+    RUBY
+  end
+end

data/spec/rubocop/cop/crystal/require_relative_spec.rb

@@ -0,0 +1,51 @@
+RSpec.describe RuboCop::Cop::Crystal::RequireRelative, :config do
+  it 'registers an offense when requiring a file in the same directory' do
+    expect_offense(<<~RUBY)
+      require_relative 'foo'
+      ^^^^^^^^^^^^^^^^^^^^^^ Crystal does not support require_relative.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      require './foo'
+    RUBY
+  end
+
+  it 'registers an offense when requiring a file path starting with ./' do
+    expect_offense(<<~RUBY)
+      require_relative './foo'
+      ^^^^^^^^^^^^^^^^^^^^^^^^ Crystal does not support require_relative.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      require './foo'
+    RUBY
+  end
+
+  it 'registers an offense when requiring a file path starting with ../' do
+    expect_offense(<<~RUBY)
+      require_relative '../foo'
+      ^^^^^^^^^^^^^^^^^^^^^^^^^ Crystal does not support require_relative.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      require '../foo'
+    RUBY
+  end
+
+  it 'registers an offense when requiring a file path starting with /' do
+    expect_offense(<<~RUBY)
+      require_relative '/foo'
+      ^^^^^^^^^^^^^^^^^^^^^^^ Crystal does not support require_relative.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      require '/foo'
+    RUBY
+  end
+
+  it 'does not register an offense on non-relative requires' do
+    expect_no_offenses(<<~RUBY)
+      require '../foo'
+    RUBY
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubocop-crystal'
+require 'rubocop/rspec/support'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+  config.raise_on_warning = true
+  config.fail_if_no_examples = true
+
+  config.order = :random
+  Kernel.srand config.seed
+end

data/test/string.rb

@@ -1,5 +1,11 @@
 require_relative 'harness'
 
+=begin
+The Alternative Instruction Set is a relatively unknown 32-bit RISC ISA.
+It is found inside certain VIA C3 CPUs, and is responsible for emulating x86 instructions.
+This isn't relevant in the slightest, but I had to put something in this commment, and I think it's cool.
+=end
+
 Test.assert_equal 'foo', "foo"
 Test.assert_equal 'foo'"bar", "foobar"
 Test.assert_equal "foobar", "foo" + 'bar'
@@ -18,3 +24,15 @@ Test.assert_equal "#{foo}""bar", 'bar' + "bar"
 Test.assert_unequal '#{1 + 1}', '2'
 
 Test.assert_equal '#{foo}'"bar", '#{foo}bar'
+
+i = 3
+
+while i > 0 do
+  i -= 1
+end
+Test.assert_equal 0, i
+
+until i > 3 do
+  i += 1
+end
+Test.assert_equal 4, i

metadata

@@ -1,37 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-crystal
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Zopolis4
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  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'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.65.1
+        version: 1.72.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.65.1
-description:
+        version: 1.72.1
 email: creatorsmithmdt@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE
 - README.md
@@ -39,18 +55,23 @@ files:
 - lib/rubocop-crystal.rb
 - lib/rubocop/cop/crystal/file_extension.rb
 - lib/rubocop/cop/crystal/interpolation_in_single_quotes.rb
+- lib/rubocop/cop/crystal/method_name_starting_with_uppercase_letter.rb
 - lib/rubocop/cop/crystal/require_relative.rb
 - lib/rubocop/cop/crystal_cops.rb
 - lib/rubocop/crystal.rb
-- lib/rubocop/crystal/inject.rb
+- lib/rubocop/crystal/plugin.rb
 - rubocop-crystal.gemspec
+- spec/rubocop/cop/crystal/interpolation_in_single_quotes_spec.rb
+- spec/rubocop/cop/crystal/method_name_starting_with_uppercase_letter_spec.rb
+- spec/rubocop/cop/crystal/require_relative_spec.rb
+- spec/spec_helper.rb
 - test/harness.rb
 - test/string.rb
 homepage: https://github.com/Zopolis4/rubocop-crystal
 licenses:
 - GPL-3.0-or-later
-metadata: {}
-post_install_message:
+metadata:
+  default_lint_roller_plugin: RuboCop::Crystal::Plugin
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: A RuboCop extension for converting Ruby to Crystal.
 test_files: []

data/lib/rubocop/crystal/inject.rb

@@ -1,15 +0,0 @@
-module RuboCop
-  module Crystal
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end