ruby_crystal_codemod 0.1.0

data/lib/ruby_crystal_codemod/logger.rb

@@ -0,0 +1,39 @@
+module RubyCrystalCodemod
+  class Logger
+    LEVELS = {
+      silent: 0,
+      error: 1,
+      warn: 2,
+      log: 3,
+      debug: 4,
+    }
+
+    def initialize(level)
+      @level = LEVELS.fetch(level)
+    end
+
+    def debug(*args)
+      $stdout.puts(*args) if should_output?(:debug)
+    end
+
+    def log(*args)
+      $stdout.puts(*args) if should_output?(:log)
+    end
+
+    def warn(*args)
+      $stderr.puts(*args) if should_output?(:warn)
+    end
+
+    def error(*args)
+      $stderr.puts(*args) if should_output?(:error)
+    end
+
+    private
+
+    attr_reader :level
+
+    def should_output?(level_to_check)
+      LEVELS.fetch(level_to_check) <= level
+    end
+  end
+end

data/lib/ruby_crystal_codemod/settings.rb

@@ -0,0 +1,29 @@
+module RubyCrystalCodemod::Settings
+  OPTIONS = {
+    parens_in_def: [:yes, :dynamic],
+    align_case_when: [false, true],
+    align_chained_calls: [false, true],
+    trailing_commas: [true, false],
+    quote_style: [:double, :single],
+    store_logs: [false, true],
+  }
+
+  attr_accessor(*OPTIONS.keys)
+
+  def init_settings(options)
+    OPTIONS.each do |name, valid_options|
+      default = valid_options.first
+      value = options.fetch(name, default)
+      unless valid_options.include?(value)
+        $stderr.puts "Invalid value for #{name}: #{value.inspect}. Valid " \
+                     "values are: #{valid_options.map(&:inspect).join(", ")}"
+        value = default
+      end
+      self.public_send("#{name}=", value)
+    end
+    diff = options.keys - OPTIONS.keys
+    diff.each do |key|
+      $stderr.puts "Invalid config option=#{key}"
+    end
+  end
+end

data/lib/ruby_crystal_codemod/version.rb

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

data/rakelib/ruby_crystal_codemod.rake

@@ -0,0 +1,22 @@
+# desc "Alias for `rake rufo:run`"
+# task :rufo => ["rufo:run"]
+
+# namespace :rufo do
+#   require "rufo"
+
+#   def rufo_command(*switches, rake_args)
+#     files_or_dirs = rake_args[:files_or_dirs] || "."
+#     args = switches + files_or_dirs.split(" ")
+#     RubyCrystalCodemod::Command.run(args)
+#   end
+
+#   desc "Format Ruby code in current directory"
+#   task :run, [:files_or_dirs] do |_task, rake_args|
+#     rufo_command(rake_args)
+#   end
+
+#   desc "Check that no formatting changes are produced"
+#   task :check, [:files_or_dirs] do |_task, rake_args|
+#     rufo_command("--check", rake_args)
+#   end
+# end

data/ruby_crystal_codemod.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_crystal_codemod/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ruby_crystal_codemod"
+  spec.version = RubyCrystalCodemod::VERSION
+  spec.authors = ["Ary Borenszweig", "Nathan Broadbent"]
+  spec.email = ["asterite@gmail.com", "nathan@docspring.com"]
+
+  spec.summary = %q{Ruby => Crystal codemod}
+  spec.description = %q{Attempts to transpile Ruby code into Crystal code}
+  spec.homepage = "https://github.com/docspring/ruby_crystal_codemod"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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.required_ruby_version = ">= 2.4.5"
+
+  spec.add_development_dependency "awesome_print", "~> 1.8.0"
+  spec.add_development_dependency "bundler", ">= 1.15"
+  spec.add_development_dependency "byebug", "~> 10.0.2"
+  spec.add_development_dependency "guard-rspec", "~> 4.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
+  spec.add_development_dependency "rubocop", "~> 0.63.1"
+  spec.add_development_dependency "rufo", "~> 0.7.0"
+end

data/run_test

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -eo pipefail
+
+# For testing things
+./exe/ruby_crystal_codemod --simple-exit test.rb && crystal run test.cr

data/util/post_process_crystal/shard.lock

@@ -0,0 +1,14 @@
+version: 1.0
+shards:
+  mocks:
+    github: DocSpring/mocks.cr
+    commit: b098c6ae8a34509df88baf4d3664471cd223bdfe
+
+  singleton:
+    github: waterlink/singleton.cr
+    version: 1.0.0
+
+  spectator:
+    gitlab: arctic-fox/spectator
+    version: 0.8.3
+

data/util/post_process_crystal/shard.yml

@@ -0,0 +1,11 @@
+name: process_comments
+version: 0.1.0
+
+development_dependencies:
+  spectator:
+    gitlab: arctic-fox/spectator
+  mocks:
+    github: DocSpring/mocks.cr
+    branch: updates_for_0.31.1
+
+license: MIT

data/util/post_process_crystal/spec/fixtures/example.rb

@@ -0,0 +1,13 @@
+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

data/util/post_process_crystal/spec/post_process_crystal_spec.cr

@@ -0,0 +1,124 @@
+require "./spec_helper"
+
+Mocks.create_mock PostProcessCrystal do
+  mock self.file_read_lines(filename)
+end
+
+Spectator.describe PostProcessCrystal do
+  it "mocks the call to File.read_lines" do
+    allow(PostProcessCrystal).to receive(self.file_read_lines("example_file")).and_return([
+      "hey, world!",
+      "how's it hanging"
+    ])
+
+    ppc = PostProcessCrystal.new("example_file")
+    ppc.post_process_crystal
+    expect(ppc.contents).to eq("hey, world!\nhow's it hanging\n")
+  end
+
+  it "removes any content between #~# BEGIN ruby and #~# END ruby" do
+    allow(PostProcessCrystal).to receive(self.file_read_lines("example_file")).and_return(
+      <<-CODE.lines
+      def foo
+        #~# BEGIN ruby
+        return 234
+        #~# END ruby
+        123
+      end
+      #~# BEGIN ruby
+      puts "Code called from Ruby!"
+      # comment should be removed
+      #~# END ruby
+
+      puts foo
+      CODE
+    )
+
+    ppc = PostProcessCrystal.new("example_file")
+    ppc.post_process_crystal
+    expect(ppc.contents).to eq(
+      <<-CODE
+      def foo
+        123
+      end
+
+      puts foo
+
+      CODE
+    )
+  end
+
+  it "uncomments any content between #~# BEGIN crystal and #~# END crystal" do
+    allow(PostProcessCrystal).to receive(self.file_read_lines("example_file")).and_return(
+      <<-CODE.lines
+      def foo
+        123
+        #~# BEGIN crystal
+        # return 456
+        #~# END crystal
+      end
+      #~# BEGIN crystal
+      # puts "Code called from Crystal!"
+      # # comment should be present
+      #~# END crystal
+      puts foo
+      CODE
+    )
+
+    ppc = PostProcessCrystal.new("example_file")
+    ppc.post_process_crystal
+    expect(ppc.contents).to eq(
+      <<-CODE
+      def foo
+        123
+        return 456
+      end
+      puts "Code called from Crystal!"
+      # comment should be present
+      puts foo
+
+      CODE
+    )
+  end
+
+  it "removes all Ruby lines and uncomments all Crystal lines" do
+    allow(PostProcessCrystal).to receive(self.file_read_lines("example_file")).and_return(
+      <<-CODE.lines
+      class Foo
+        property :foo, :bar
+
+        #~# BEGIN ruby
+        def initialize(foo, bar)
+          @foo = foo
+          @bar = bar
+        end
+        #~# END ruby
+        #~# BEGIN crystal
+        # @foo : Int32
+        # @bar : Int32
+        # def initialize(@foo: Int32, @bar : Int32)
+        # end
+        #~# END crystal
+      end
+      CODE
+    )
+
+    ppc = PostProcessCrystal.new("example_file")
+    ppc.post_process_crystal
+    # NOTE: This is a post-processing step. The rufo formatting code
+    # must run before this, and will translate attr_accessor into property, etc.
+    expect(ppc.contents).to eq(
+      <<-CODE
+      class Foo
+        property :foo, :bar
+
+        @foo : Int32
+        @bar : Int32
+        def initialize(@foo: Int32, @bar : Int32)
+        end
+      end
+
+      CODE
+    )
+  end
+end

data/util/post_process_crystal/spec/spec_helper.cr

@@ -0,0 +1,4 @@
+require "../src/post_process_crystal"
+require "spec"
+require "spectator"
+require "mocks/spec"

data/util/post_process_crystal/src/command.cr

@@ -0,0 +1,16 @@
+require "./post_process_crystal"
+
+if ARGV.size == 0
+  STDERR.puts "Usage: #{PROGRAM_NAME} <files>"
+  exit 1
+end
+
+ppc = PostProcessCrystal.new
+puts "Processing #~# BEGIN and #~# END comments..."
+
+ARGV.each_with_index do |arg, i|
+  puts "=> Processing file: #{arg}"
+  ppc.filename = arg
+  ppc.post_process_crystal
+  File.write(arg, ppc.contents)
+end

data/util/post_process_crystal/src/post_process_crystal.cr

@@ -0,0 +1,48 @@
+class PostProcessCrystal
+  getter :filename, :contents
+  @filename : String
+  @contents : String
+
+  def self.file_read_lines(path)
+    File.read_lines(path)
+  end
+
+  def initialize(filename : String = "")
+    @filename = filename
+    @contents = ""
+  end
+
+  def filename=(filename)
+    self.initialize(filename)
+  end
+
+  def post_process_crystal
+    @contents = String.build do |io|
+      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
+
+        io << line << "\n"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: ruby_crystal_codemod
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ary Borenszweig
+- Nathan Broadbent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.2
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Attempts to transpile Ruby code into Crystal code
+email:
+- asterite@gmail.com
+- nathan@docspring.com
+executables:
+- ruby_crystal_codemod
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rufo"
+- ".vscode/settings.json"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/compile_post_process
+- bin/console
+- bin/setup
+- docs/developing-ruby-crystal-codemod.md
+- docs/releasing-a-gem.md
+- exe/ruby_crystal_codemod
+- lib/ruby_crystal_codemod.rb
+- lib/ruby_crystal_codemod/command.rb
+- lib/ruby_crystal_codemod/dot_file.rb
+- lib/ruby_crystal_codemod/file_finder.rb
+- lib/ruby_crystal_codemod/formatter.rb
+- lib/ruby_crystal_codemod/logger.rb
+- lib/ruby_crystal_codemod/settings.rb
+- lib/ruby_crystal_codemod/version.rb
+- rakelib/ruby_crystal_codemod.rake
+- ruby_crystal_codemod.gemspec
+- run_test
+- util/post_process_crystal/shard.lock
+- util/post_process_crystal/shard.yml
+- util/post_process_crystal/spec/fixtures/example.rb
+- util/post_process_crystal/spec/post_process_crystal_spec.cr
+- util/post_process_crystal/spec/spec_helper.cr
+- util/post_process_crystal/src/command.cr
+- util/post_process_crystal/src/post_process_crystal.cr
+homepage: https://github.com/docspring/ruby_crystal_codemod
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby => Crystal codemod
+test_files: []