ruby_crystal_codemod 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7986ec4b8202ba075699a41427f7fbcdd98b468dc08d03cdce440b9677479520
+  data.tar.gz: 10353a8c14d346e7dec11f6848b88ab3463f93ddb203283c245f47338676e53f
+SHA512:
+  metadata.gz: 101ae069a8d1f6805ef80c7d5140240eb968f8e4633ef8e1ee361bf3cbb4c89c1ea695b4a3b4b524e0c579014f79747a28c86d0cc2f428bff017407e4634b504
+  data.tar.gz: e5578aefa628eabe37f6cf9ffc2445571bec4466031435ea97c45166cdbac3a06ae6d41651bcc459f8f5f569f28f2b9cd31a054d62c43186ff036939c8534a21

data/.circleci/config.yml

@@ -0,0 +1,103 @@
+"-": &dockerbuild
+  steps:
+    - checkout
+
+    # Which version of ruby?
+    - run:
+        name: Which ruby?
+        command: ruby --version | tee ruby-version-for-ci.txt
+
+    # Which version of bundler?
+    - run:
+        name: Which bundler?
+        command: bundle -v
+
+    - run:
+        name: Install Crystal
+        command: >-
+          sudo apt-get update &&
+          sudo apt-get install apt-transport-https ca-certificates &&
+          curl -sSL https://dist.crystal-lang.org/apt/setup.sh | sudo bash &&
+          curl -sL "https://keybase.io/crystal/pgp_keys.asc" | sudo apt-key add - &&
+          echo "deb https://dist.crystal-lang.org/apt crystal main" | sudo tee /etc/apt/sources.list.d/crystal.list &&
+          sudo apt-get update &&
+          sudo apt-get -y install crystal &&
+          crystal --version
+
+    # Restore bundle cache
+    - restore_cache:
+        keys:
+          - bundler-packages-v2-{{ checksum "ruby-version-for-ci.txt" }}-{{ checksum "ruby_crystal_codemod.gemspec" }}
+
+    - run:
+        name: Bundle Install
+        command: bundle check || bundle install
+
+    # Restore crystal cache
+    - restore_cache:
+        keys:
+          - crystal-shards-{{ checksum "util/post_process_crystal/shard.lock" }}
+
+    - run:
+        name: Compile ./util/post_process tool
+        command: ./bin/compile_post_process
+
+    - run:
+        name: Run rspec
+        command: |
+          bundle exec rspec --profile 10 \
+                            --format RspecJunitFormatter \
+                            --out test_results/rspec.xml \
+                            --format progress
+    - run:
+        name: Run RuboCop
+        command: |
+          bundle exec rake rubocop
+    - run:
+        name: Run Rufo
+        command: |
+          bundle exec rufo -c lib/ spec/lib/
+
+    # Store crystal cache
+    - save_cache:
+        key: crystal-shards-{{ checksum "util/post_process_crystal/shard.lock" }}
+        paths:
+          - util/post_process_crystal/lib/
+          - util/post_process_crystal/shard.lock
+
+    # Store bundle cache
+    - save_cache:
+        key: bundler-packages-v2-{{ checksum "ruby-version-for-ci.txt" }}-{{ checksum "ruby_crystal_codemod.gemspec" }}
+        paths:
+          - vendor/bundle
+          - Gemfile.lock
+
+    # Save test results for timing analysis
+    - store_test_results:
+        path: test_results
+
+
+version: 2
+jobs:
+  build-2-6-5:
+    <<: *dockerbuild
+    docker:
+      - image: circleci/ruby:2.6.5
+        environment:
+          BUNDLE_JOBS: "3"
+          BUNDLE_RETRY: "3"
+          BUNDLE_PATH: /home/circleci/project/vendor/bundle
+  build-2-4-5:
+    <<: *dockerbuild
+    docker:
+      - image: circleci/ruby:2.4.5
+        environment:
+          BUNDLE_JOBS: "3"
+          BUNDLE_RETRY: "3"
+          BUNDLE_PATH: vendor/bundle
+workflows:
+  version: 2
+  test:
+    jobs:
+      - build-2-6-5
+      - build-2-4-5

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,4 @@
+<!--
+  Thank you for contributing to ruby_crystal_codemod!
+  Please remember to update the CHANGELOG with the contents of this PR.
+-->

data/.gitignore

@@ -0,0 +1,24 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/*.gem
+
+# rspec failure tracking
+.rspec_status
+sample_code
+
+.byebug_history
+# *.cr
+
+test.rb
+test.cr
+
+util/post_process
+util/post_process_crystal/lib/
+*.dwarf

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - "spec/**/*"
+    - "vendor/**/*"
+  TargetRubyVersion: 2.4
+
+Layout:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Style:
+  Enabled: false
+

data/.rufo

@@ -0,0 +1,2 @@
+align_case_when             true
+align_chained_calls         true

data/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "ruby.rubocop.onSave": false,
+  "python.linting.lintOnSave": false
+}

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby_crystal_codemod.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ary Borenszweig
+
+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,141 @@
+[![CircleCI](https://circleci.com/gh/DocSpring/ruby_crystal_codemod.svg?style=svg)](https://circleci.com/gh/DocSpring/ruby_crystal_codemod)
+
+# Ruby => Crystal Codemod
+
+This project is a fork of [Rufo](https://github.com/ruby-formatter/rufo). (Rufo and Crystal were both created by [Ary Borenszweig](https://github.com/asterite)!)
+
+> Rufo is as an _opinionated_ ruby formatter, intended to be used via the command line as a text-editor plugin, to autoformat files on save or on demand.
+
+The formatting rules have been modified in an attempt to produce some semi-valid Crystal code. Then you need to add some type annotations and fix any other issues manually. See the [Crystal for Rubyists](https://github.com/crystal-lang/crystal/wiki/Crystal-for-Rubyists) wiki page to learn more about the syntax differences.
+
+> Ruby => Crystal Codemod / Rufo supports all Ruby versions >= 2.4.**5**, due to a bug in Ruby's Ripper parser.
+
+## Installation
+
+Install the gem with:
+
+```
+$ gem install ruby_crystal_codemod
+```
+
+## Usage
+
+Go to the directory where you want to convert Ruby files into Crystal. Then run:
+
+```
+ruby_crystal_codemod .
+```
+
+This command will create new `*.cr` files and attempt to fix any simple errors. Then it will
+run `crystal tool format` to format the generated code.
+
+## Next Steps:
+
+* Once you've fixed all of the syntax and type errors, run `crystal tool format` to autoformat your code.
+* Run [Ameba](https://github.com/crystal-ameba/ameba) for static code analysis (similar to RuboCop), and fix all of the errors.
+  * *(Unfortunately Ameba doesn't have a --fix option yet.)*
+
+## Writing Ruby / Crystal in the same file
+
+If you want to write both Ruby and Crystal in a Ruby file, you can use some
+special `#~# BEGIN <language>` and `#~# END <language>` comments.
+Code between `#~# BEGIN ruby` and `#~# END ruby` should be uncommented,
+and code between `#~# BEGIN crystal` and `#~# END crystal` should be commented.
+When transpiling a Ruby file into Crystal, the transpiler will remove all of the Ruby lines between these comments, and it will uncomment all of the Crystal lines.
+
+The `BEGIN` / `END` comments can start with either `#~#` or `# ~#`. (Code formatters / linters often enforce a space after the `#` character for comments.)
+
+> This comment post-processing step is done by a Crystal program in `./util/post_process_crystal`. Run `./bin/compile_post_process` to compile the binary at `./util/post_process`.
+
+For example, here's how you can define a class that works for both Ruby and Crystal:
+(Crystal requires type annotations here.)
+
+```
+class Foo
+  attr_accessor :foo
+
+  #~# BEGIN ruby
+  def initialize(foo)
+    @foo = foo
+  end
+  #~# END ruby
+  #~# BEGIN crystal
+  # @foo : Int32
+  # def initialize(@foo : Int32); end
+  #~# END crystal
+end
+```
+
+When this file is executed by Ruby, Ruby will ignore all of the commented lines. When the file is run through the Ruby => Crystal transpiler, it will be transformed into the following Crystal code:
+
+```
+class Foo
+  property :foo
+
+  @foo : Int32
+  def initialize(@foo : Int32); end
+end
+```
+
+(The transpiler automatically renames `attr_accessor` to `property`.)
+
+> See [`spec/fixtures/crystal_codemod_test/example.rb:87`](https://github.com/DocSpring/ruby_crystal_codemod/blob/master/spec/fixtures/crystal_codemod_test/example.rb#L87-L114) for a real-world example that is used in our acceptance specs.
+
+## Status
+
+- [x] Rename all file extensions from `.rb` to `.cr`
+- [x] Replace single quoted strings with double quotes
+- [x] `require_relative "foo"` -> `require "./foo"`
+- [x] `$:`, `LOAD_PATH` => Show error and link to docs about CRYSTAL_PATH (for compiler)
+- [x] Translate methods / keywords / operators:
+  - [x] `include?` -> `includes?`
+  - [x] `key?` -> `has_key?`
+  - [x] `detect` -> `find`
+  - [x] `collect` -> `map`
+  - [x] `respond_to?` -> `responds_to?`
+  - [x] `length`, `count` -> `size`
+  - [x] `__dir__` -> `__DIR__`
+  - [x] `and` -> `&&`
+  - [x] `or` -> `||`
+  - [x] `not` -> `!`
+  - [x] `foo.each(&:method)` -> `foo.each(&.method)`
+  - [x] `foo.map &:method` -> `foo.map &.method`
+- [x] `attr_accessor` => `property`
+- [x] `attr_reader` => `getter`
+- [x] `attr_writer` => `setter`
+- [ ] `private` / `protected` methods
+- [ ] `class << self` => `def self.foo` (?)
+- [ ] `YAML.load_file("./foo.yml")` => `YAML.parse(File.read("./foo.yml"))`
+- [ ] .each returns nil - Try to warn if it looks like the return value of `.each` is being used
+- [ ] for loops - Show a warning or link to the docs
+- [ ] Consistent dot notation - `File::exists?` => `File.exists?`
+
+## Future
+
+* Sorbet Type Annotations -> Crystal type annotations
+* Instrument a Ruby program to track of all the variable assignments at run-time. Store all of the classes that are detected in each variable (including the maximum values of integers, etc.) Convert this run-time type information into Sorbet/Crystal type annotations.
+
+## Testing
+
+Run `rspec` to run all the specs and integration tests. I've kept all of the original rufo specs, because they're all really fast, it doesn't hurt to produce nicely formatted Crystal code (before the crystal format pass.)
+
+Crystal-specific formatting specs can be found in `spec/lib/ruby_crystal_codemod/formatter_crystal_specs/*`.
+
+There's also a Crystal acceptance spec at `spec/lib/ruby_crystal_codemod/crystal_codemod_acceptance_spec.rb`.
+This transpiles the example Ruby code in `spec/fixtures/crystal_codemod_test`, and makes sure that Ruby
+and Crystal produce the same output when they both run the respective code.
+
+## Developing
+
+Before submitting a PR, please run:
+
+* `bundle exec rake rubocop -a`
+* `bundle exec rufo lib/ spec/lib/`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DocSpring/ruby_crystal_codemod.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task :default => :spec

data/bin/compile_post_process

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+(cd util/post_process_crystal && shards install)
+crystal build --release util/post_process_crystal/src/command.cr -o util/post_process

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby_crystal_codemod"
+
+# 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/docs/developing-ruby-crystal-codemod.md

@@ -0,0 +1,3 @@
+# ruby_crystal_codemod Development
+
+Thanks for your help!

data/docs/releasing-a-gem.md

@@ -0,0 +1,17 @@
+# Releasing a gem
+
+1. Ensure that the tests pass and everything is working!
+
+2. Add missing release notes to `CHANGELOG.md`
+
+3. Bump version in
+  * `lib/ruby_crystal_codemod/version.rb`
+  * `CHANGELOG.md`
+
+4. Commit version bump via
+  * `git commit -v "Version X.Y.Z"`
+
+5. Release gem to RubyGems via
+  * `rake release`
+
+6. :tada:

data/exe/ruby_crystal_codemod

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative "../lib/ruby_crystal_codemod"
+
+RubyCrystalCodemod::Command.run(ARGV)

data/lib/ruby_crystal_codemod.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubyCrystalCodemod
+  class Bug < StandardError; end
+
+  class SyntaxError < StandardError; end
+
+  def self.format(code, filename, dir, **options)
+    Formatter.format(code, filename, dir, **options)
+  end
+end
+
+require_relative "ruby_crystal_codemod/command"
+require_relative "ruby_crystal_codemod/logger"
+require_relative "ruby_crystal_codemod/dot_file"
+require_relative "ruby_crystal_codemod/settings"
+require_relative "ruby_crystal_codemod/formatter"
+require_relative "ruby_crystal_codemod/version"
+require_relative "ruby_crystal_codemod/file_finder"