rubocop-crystal 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da6ff9b5f99f7f17858b981c4ade0ae98dd8952b8fb2418c786f883b1e46b0fd
-  data.tar.gz: da72279b406edb2637e76d029b8a8b8242a81baa7e47b5b6fdf2a73046b30d94
+  metadata.gz: 3beb9db336ee0d664fdd093775a9c14dc9512c8ec84be250ec177a6763b4924d
+  data.tar.gz: 015acc39018447fef5d62304bf91dddab3b66faa795149f00b3e447de6db5990
 SHA512:
-  metadata.gz: b418ac09e30e0c12d7c3fa70968d27cdc313275eeb30a798b74320aa808cf72478a5c32c000d259938fb1b776976732c7aef88cb4ff9fd90b4c668b4fcaaad9d
-  data.tar.gz: 8d48ac6beabda86bcc801b91eaab3479f62c9b437725349215ad50dbbee3bc013823a9bea22d8fe75a615adb63465ee20cb501cef4556c0959fc78abfd8fa9b8
+  metadata.gz: 2077733fe1bc6189b71854a249601f8294366a2d86cd013822bb6ec9fd1371e9229ad6622dc169426ae35c75b1f65e26f5308538a749e2b02fb7239ac99a087e
+  data.tar.gz: ea546caea1eeb127c946df8c97ec77ba7e5572db33c63402bba1ad4ffeeaca05d19d402d6c6a96aa37d4641f2aeda11d95a8f26a2e6b1c18a473961b8468d221

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Test
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v4
+      - name: Install Crystal
+        uses: crystal-lang/install-crystal@v1
+      - name: Install Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1.2'
+      - name: Run tests (Ruby)
+        run: ruby test/string.rb
+      - name: Install Rubocop
+        run: gem install rubocop
+      - name: Build and install rubocop-crystal
+        run: |
+          gem build rubocop-crystal
+          gem install rubocop-crystal
+      - name: Convert test files
+        run: rubocop --require rubocop-crystal --fail-level fatal -A test
+      - name: Run tests (Crystal)
+        run: crystal run test/string.cr

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.0.2 (2024-08-01)
+
+### New features
+
+* Enable Style/StringLiterals cop ([@zopolis4][])
+* Enable Style/MethodDefParentheses cop ([@zopolis4][])
+* Enable Lint/ImplicitStringConcatenation cop ([@zopolis4][])
+* Add Crystal/InterpolationInSingleQuotes cop ([@zopolis4][])
+* Add Crystal/RequireRelative cop ([@zopolis4][])
+
 ## 0.0.1 (2024-03-25)
 
 ### New features

data/README.md

@@ -2,21 +2,32 @@
 
 The beginnings of a RuboCop extension for converting Ruby to Crystal.
 
-## Testing
-
-Right now it is being tested on [basictest/test.rb](https://github.com/ruby/ruby/blob/master/basictest/test.rb) from the Ruby tree.
-
-Because that only gets to line 4, and certainly doesnt get far enough to give a pass/fail number, I am only testing it locally.
-
-Once it supports enough to run minitest, I'll convert it into a proper testing setup.
-
-## Versioning
-
-The end goal is to be able to run everything inside `basictest`, `boostraptest`, and `test` from the Ruby tree.
-
-Minor versions are incremented when a directory now passes all tests (`basictest`, `test/json`).
-
-My sincere apologies to dedicated [0ver](https://0ver.org/) fans, but there will be a major release once all tests pass.
+## TODO
+
+Many things. In particular, how are types going to work?
+
+Getting static type information about Ruby files isn't the difficult part, the problem is conveying this information to the Crystal compiler while still maintaining valid syntax.
+
+Inserting Crystal types into Ruby code is a no-go, because that causes `Lint/Syntax` errors in RuboCop.
+
+Possible paths foward:
+- Modify the parser to accept Crystal type declarations, or at least not break on them.
+- Modify Crystal to accept type declarations from `.rbs` and/or `.rbi` files.
+- Modify Crystal to accept type declarations from sorbet/rbs-inline/other annotations.
+  - Write [Ameba](https://github.com/crystal-ameba/ameba) [extension](https://crystal-ameba.github.io/2019/07/22/how-to-write-extension/) to convert the type annotations, as it works with Crystal syntax.
+- Find a way to convey type information to Crystal using valid Ruby syntax.
+
+Interesting repos:
+- [rbs](https://github.com/ruby/rbs)
+- [steep](https://github.com/soutaro/steep)
+- [sorbet](https://github.com/sorbet/sorbet)
+- [tapioca](https://github.com/Shopify/tapioca)
+- [parlour](https://github.com/AaronC81/parlour)
+- [gloss](https://github.com/johansenja/gloss)
+- [claret](https://github.com/stevegeek/claret)
+- [irbs](https://github.com/diaphragm/irbs)
+- [rbs-inline](https://github.com/soutaro/rbs-inline)
+- [syntax-tree-rbs](https://github.com/ruby-syntax-tree/syntax_tree-rbs)
 
 ## Installation
 

data/config/default.yml

@@ -4,4 +4,21 @@ AllCops:
 Crystal/FileExtension:
   Description: 'This cop renames files ending in `.rb` to `.cr`.'
   Enabled: true
-  VersionAdded: '0.0.1'
+
+Crystal/InterpolationInSingleQuotes:
+  Description: "This cop uses %q in place of ' if the enclosed string would be affected by interpolation."
+  Enabled: true
+
+Crystal/RequireRelative:
+  Description: 'This cop replaces require_relative with require while maintaining behavior.'
+  Enabled: true
+
+Lint/ImplicitStringConcatenation:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/MethodDefParentheses:
+  Enabled: true

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

@@ -0,0 +1,35 @@
+module RuboCop
+  module Cop
+    module Crystal
+      # In ruby, strings deliminated with single quotes do not have interpolation applied.
+      # Crystal does not support this, so use %q literals to replicate this functionality.
+      # Only do this for strings which would be affected by interpolation, and let Style/StringLiterals handle the rest.
+      #
+      # @example
+      #   # bad
+      #   '#{foo}'
+      #   'cat #{con}'
+      #
+      #   # good
+      #   %q(#{foo})
+      #   %q(cat #{con})
+      #
+      class InterpolationInSingleQuotes < Base
+        extend AutoCorrector
+        MSG = 'Crystal does not support the use of single-quote deliminated strings to avoid interpolation.'
+
+        def on_str(node)
+          # We're only interested in single-quote deliminated strings.
+          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
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, '%q(' + node.source[1..-2] + ')')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module RuboCop
+  module Cop
+    module Crystal
+      # In ruby, require_relative attempts to load the library relative to the directory of the currently executing file.
+      # Crystal does not have require_relative, but it has the same behavior in the form of require './foo'
+      #
+      # @example
+      #   # bad
+      #   require_relative 'foo'
+      #   require_relative './bar'
+      #   require_relative '../baz'
+      #   require_relative '/qux'
+      #
+      #   # good
+      #   require './foo'
+      #   require './bar'
+      #   require '../baz'
+      #   require '/qux'
+      #
+      class RequireRelative < Base
+        extend AutoCorrector
+        MSG = 'Crystal does not support require_relative.'
+        RESTRICT_ON_SEND = [:require_relative]
+
+        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
+            corrector.replace(node, "require '#{require_value}'")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/crystal_cops.rb

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

data/rubocop-crystal.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |spec|
   spec.name     = 'rubocop-crystal'
   spec.summary  = 'A RuboCop extension for converting Ruby to Crystal.'
-  spec.version  = '0.0.1'
+  spec.version  = '0.0.2'
   spec.license  = 'GPL-3.0-or-later'
   spec.author   = 'Zopolis4'
   spec.email    = 'creatorsmithmdt@gmail.com'
@@ -10,5 +10,5 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split("\n")
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rubocop'
+  spec.add_dependency 'rubocop', '>= 1.65.1'
 end

data/test/harness.rb

@@ -0,0 +1,41 @@
+class Test
+  @@failed_tests = 0
+  @@passed_tests = 0
+
+  def self.failed_tests
+    @@failed_tests
+  end
+
+  def self.passed_tests
+    @@passed_tests
+  end
+
+  def self.assert_equal(expected, actual)
+    if expected == actual
+      @@passed_tests += 1
+    else
+      @@failed_tests += 1
+      puts "Assertion of equality failed:"
+      puts "Expected: #{expected}"
+      puts "Actual: #{actual}"
+    end
+  end
+
+  def self.assert_unequal(expected, actual)
+    if expected != actual
+      @@passed_tests += 1
+    else
+      @@failed_tests += 1
+      puts "Assertion of inequality failed:"
+      puts "Expected: #{expected}"
+      puts "Actual: #{actual}"
+    end
+  end
+end
+
+at_exit do
+  puts "#{Test.passed_tests} tests passed."
+  puts "#{Test.failed_tests} tests failed."
+  exit(1) if Test.failed_tests.positive?
+end
+

data/test/string.rb

@@ -0,0 +1,20 @@
+require_relative 'harness'
+
+Test.assert_equal 'foo', "foo"
+Test.assert_equal 'foo'"bar", "foobar"
+Test.assert_equal "foobar", "foo" + 'bar'
+
+foo = 'bar'
+Test.assert_equal '#{foo}', '#{foo}'
+Test.assert_equal 'bar', "#{foo}"
+
+Test.assert_unequal 'bar', '#{foo}'
+Test.assert_unequal "#{foo}", '#{foo}'
+
+Test.assert_equal '#{foo}'"bar", '#{foo}bar'
+Test.assert_equal "#{foo}""bar", 'bar' + "bar"
+
+
+Test.assert_unequal '#{1 + 1}', '2'
+
+Test.assert_equal '#{foo}'"bar", '#{foo}bar'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-crystal
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Zopolis4
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,20 +16,21 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.65.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.65.1
 description:
 email: creatorsmithmdt@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - CHANGELOG.md
 - LICENSE
@@ -37,10 +38,14 @@ files:
 - config/default.yml
 - lib/rubocop-crystal.rb
 - lib/rubocop/cop/crystal/file_extension.rb
+- lib/rubocop/cop/crystal/interpolation_in_single_quotes.rb
+- lib/rubocop/cop/crystal/require_relative.rb
 - lib/rubocop/cop/crystal_cops.rb
 - lib/rubocop/crystal.rb
 - lib/rubocop/crystal/inject.rb
 - rubocop-crystal.gemspec
+- test/harness.rb
+- test/string.rb
 homepage: https://github.com/Zopolis4/rubocop-crystal
 licenses:
 - GPL-3.0-or-later