ruby_crystal_codemod 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7986ec4b8202ba075699a41427f7fbcdd98b468dc08d03cdce440b9677479520
-  data.tar.gz: 10353a8c14d346e7dec11f6848b88ab3463f93ddb203283c245f47338676e53f
+  metadata.gz: 5bdee5c536c92fee24314a9164c4284bf95434d0420aef21fb43cc16a838bce3
+  data.tar.gz: f408e7e716bc30bbec7fc22af88755f44831f3e01bf1e1fd314485b08706d491
 SHA512:
-  metadata.gz: 101ae069a8d1f6805ef80c7d5140240eb968f8e4633ef8e1ee361bf3cbb4c89c1ea695b4a3b4b524e0c579014f79747a28c86d0cc2f428bff017407e4634b504
-  data.tar.gz: e5578aefa628eabe37f6cf9ffc2445571bec4466031435ea97c45166cdbac3a06ae6d41651bcc459f8f5f569f28f2b9cd31a054d62c43186ff036939c8534a21
+  metadata.gz: 1271dce196b637376838ab7a498cddf460ebcc4282b631dcb3c0b745ed7fc712424d17d6c38e7968fc65bad7b0b35d566c839f6c9cb882e11719fcbc4ed882fb
+  data.tar.gz: dbf1c4d4b43162a6f93391aeb7d3d63a84c1566ba9d5b203374359b4967b69a7d0bc8e421df896b8ebc723d0460a99531519a06cf79109f03d6be0954f8873e9

data/.circleci/config.yml

@@ -33,15 +33,6 @@
         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: |
@@ -58,13 +49,6 @@
         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" }}

data/README.md

@@ -8,7 +8,12 @@ This project is a fork of [Rufo](https://github.com/ruby-formatter/rufo). (Rufo
 
 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.
+> Ruby => Crystal Codemod / Rufo supports all Ruby versions >= 2.4.5, due to a bug in Ruby's Ripper parser.
+
+## Requirements
+
+* Ruby >= `2.4.5`
+* [Crystal](https://crystal-lang.org/install/) >= `0.31.1`
 
 ## Installation
 
@@ -45,8 +50,6 @@ When transpiling a Ruby file into Crystal, the transpiler will remove all of the
 
 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.)
 

data/lib/ruby_crystal_codemod.rb

@@ -17,3 +17,4 @@ 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"
+require_relative "ruby_crystal_codemod/post_process_crystal"

data/lib/ruby_crystal_codemod/command.rb

@@ -20,6 +20,7 @@ class RubyCrystalCodemod::Command
     @dot_file = RubyCrystalCodemod::DotFile.new
     @squiggly_warning_files = []
     @logger = RubyCrystalCodemod::Logger.new(loglevel)
+    @post_processor = PostProcessCrystal.new
   end
 
   def exit_code(status_code)
@@ -113,18 +114,24 @@ class RubyCrystalCodemod::Command
       logger.log("Format: #{filename} => #{crystal_filename}")
     end
 
-    # Run the post-processing command to handle BEGIN and END comments for Ruby / Crystal.
-    post_process_cmd = File.expand_path(File.join(__dir__, "../../util/post_process"))
-    unless File.exist?(post_process_cmd)
-      raise "Please run ./bin/compile_post_process to compile the post-processing command " \
-            "at: #{post_process_cmd}"
-    end
-    stdout, stderr, status = Open3.capture3(post_process_cmd, crystal_filename)
-    unless status.success?
-      warn "'./util/post_process' failed with status: #{status.exitstatus}\n\n" \
-           "stdout: #{stdout}\n\n" \
-           "stderr: #{stderr}"
-    end
+    # Run the post-processing step to remove Ruby code and uncomment Crystal.
+    @post_processor.filename = crystal_filename
+    @post_processor.post_process_crystal
+    File.write(crystal_filename, @post_processor.contents)
+
+    # UPDATE: It's difficult to package/compile the Crystal binary in a Ruby gem.
+    # But it was really easy to port it to Ruby!
+    # post_process_cmd = File.expand_path(File.join(__dir__, "../../util/post_process"))
+    # unless File.exist?(post_process_cmd)
+    #   raise "Please run ./bin/compile_post_process to compile the post-processing command " \
+    #         "at: #{post_process_cmd}"
+    # end
+    # stdout, stderr, status = Open3.capture3(post_process_cmd, crystal_filename)
+    # unless status.success?
+    #   warn "'./util/post_process' failed with status: #{status.exitstatus}\n\n" \
+    #        "stdout: #{stdout}\n\n" \
+    #        "stderr: #{stderr}"
+    # end
 
     # Format the Crystal file with the Crystal code formatter
     stdout, stderr, status = Open3.capture3("crystal", "tool", "format", crystal_filename)

data/lib/ruby_crystal_codemod/post_process_crystal.rb

@@ -0,0 +1,46 @@
+class PostProcessCrystal
+  attr_reader :filename, :contents
+
+  def self.file_read_lines(path)
+    File.read(path).lines.map(&:chomp)
+  end
+
+  def initialize(filename = "")
+    @filename = filename
+    @contents = ""
+  end
+
+  def filename=(filename)
+    @filename = filename
+    @contents = ""
+  end
+
+  def post_process_crystal
+    @contents = +""
+    lines = self.class.file_read_lines(@filename)
+
+    current_lang = nil
+    regex = /^\s*# ?~# (?<action>(BEGIN|END)) (?<lang>(ruby|crystal))/
+    uncomment_regex = /^(?<indent>\s*)# ?/
+    lines.each do |line|
+      matches = regex.match(line)
+      if matches
+        case matches["action"]
+        when "BEGIN"
+          current_lang = matches["lang"]
+        when "END"
+          current_lang = nil
+        end
+        next
+      end
+      case current_lang
+      when "ruby"
+        next
+      when "crystal"
+        line = line.sub(uncomment_regex, "\\k<indent>")
+      end
+
+      @contents << line << "\n"
+    end
+  end
+end

data/lib/ruby_crystal_codemod/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCrystalCodemod
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_crystal_codemod
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ary Borenszweig
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2019-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -170,6 +170,7 @@ files:
 - lib/ruby_crystal_codemod/file_finder.rb
 - lib/ruby_crystal_codemod/formatter.rb
 - lib/ruby_crystal_codemod/logger.rb
+- lib/ruby_crystal_codemod/post_process_crystal.rb
 - lib/ruby_crystal_codemod/settings.rb
 - lib/ruby_crystal_codemod/version.rb
 - rakelib/ruby_crystal_codemod.rake