Updated support for Ruby

README.md

@@ -66,6 +66,7 @@ are supported (with individual support for each function may vary):
 - Python
 - Java
 - PHP
+- Ruby
 
 ### Refactoring Features<a name="refactoring-features"></a>
 

lua/refactoring/code_generation/init.lua

@@ -7,6 +7,7 @@ local c = require("refactoring.code_generation.langs.c")
 local python = require("refactoring.code_generation.langs.python")
 local php = require("refactoring.code_generation.langs.php")
 local java = require("refactoring.code_generation.langs.java")
+local ruby = require("refactoring.code_generation.langs.ruby")
 
 local M = {
     javascript = javascript,
@@ -18,6 +19,7 @@ local M = {
     python = python,
     php = php,
     java = java,
+    ruby = ruby,
 
     -- TODO: Take this and make all code generation subclassed.
     -- This should just be a function of code generation.

lua/refactoring/code_generation/langs/ruby.lua

@@ -0,0 +1,104 @@
+local code_utils = require("refactoring.code_generation.utils")
+local code_gen_indent = require("refactoring.code_generation.indent")
+
+local function ruby_function_with_params(opts)
+    return string.format(
+        [[
+def %s(%s)
+%s
+end
+
+]],
+        opts.name,
+        table.concat(opts.args, ", "),
+        code_utils.stringify_code(opts.body)
+    )
+end
+
+local function ruby_function_no_params(opts)
+    return string.format(
+        [[
+def %s
+%s
+end
+
+]],
+        opts.name,
+        code_utils.stringify_code(opts.body)
+    )
+end
+
+local function ruby_function(opts)
+    if not next(opts.args) then
+        return ruby_function_no_params(opts)
+    else
+        return ruby_function_with_params(opts)
+    end
+end
+
+local function ruby_class_function(opts)
+    return ruby_function(opts)
+end
+
+local indent_char = " "
+
+local ruby = {
+    comment = function(statement)
+        return string.format("# %s", statement)
+    end,
+    constant = function(opts)
+        return string.format("%s = %s\n", opts.name, opts.value)
+    end,
+    ["function"] = function(opts)
+        return ruby_function(opts)
+    end,
+    function_return = function(opts)
+        return ruby_function(opts)
+    end,
+    ["return"] = function(code)
+        return string.format("%s", code_utils.stringify_code(code))
+    end,
+    call_function = function(opts)
+        return string.format("%s(%s)", opts.name, table.concat(opts.args, ", "))
+    end,
+    class_function = function(opts)
+        return ruby_class_function(opts)
+    end,
+    class_function_return = function(opts)
+        return ruby_class_function(opts)
+    end,
+    call_class_function = function(opts)
+        return string.format("%s(%s)", opts.name, table.concat(opts.args, ", "))
+    end,
+    terminate = function(code)
+        return code
+    end,
+    -- This is for returing multiple arguments from a function
+    -- @param names string|table
+    pack = function(opts)
+        return code_utils.returnify(opts, "%s")
+    end,
+    indent_char_length = function(first_line)
+        return code_gen_indent.indent_char_length(first_line, indent_char)
+    end,
+    indent_char = function()
+        return indent_char
+    end,
+    indent = function(opts)
+        return code_gen_indent.indent(opts, indent_char)
+    end,
+    print = function(opts)
+        return string.format(opts.statement, opts.content)
+    end,
+    default_printf_statement = function()
+        return { 'puts "%s"' }
+    end,
+    default_print_var_statement = function()
+        return { 'puts "%s #{%s}"' }
+    end,
+    print_var = function(opts)
+        return string.format(opts.statement, opts.prefix, opts.var)
+    end,
+}
+
+return ruby

lua/refactoring/config/init.lua

@@ -21,6 +21,8 @@ local default_formatting = {
     -- Python needs tons of work to become correct.
     python = {},
 
+    ruby = {},
+
     default = {
         cmd = nil, -- format.lua checks to see if the command is nil or not
     },

lua/refactoring/tests/debug/cleanup/rb/cleanup.commands

@@ -0,0 +1 @@
+

lua/refactoring/tests/debug/cleanup/rb/cleanup.cursor_position

@@ -0,0 +1,2 @@
+1
+1

lua/refactoring/tests/debug/cleanup/rb/cleanup.expected.rb

@@ -0,0 +1,5 @@
+
+def main
+  puts('ruby is awesome')
+  i = 3
+end

lua/refactoring/tests/debug/cleanup/rb/cleanup.start.rb

@@ -0,0 +1,7 @@
+puts('test')  # __AUTO_GENERATED_PRINTF__
+def main
+  puts('main') # __AUTO_GENERATED_PRINTF__
+  puts('ruby is awesome')
+  i = 3
+  puts(' i: {str(i)}')  # __AUTO_GENERATED_PRINT_VAR__
+end

lua/refactoring/tests/debug/print_var/rb/multiple-statements/print_var.commands

@@ -0,0 +1,2 @@
+:4
+:execute "norm! wve\<Esc>"

lua/refactoring/tests/debug/print_var/rb/multiple-statements/print_var.config

@@ -0,0 +1 @@
+puts "custom print_var %s #{%s}"

lua/refactoring/tests/debug/print_var/rb/multiple-statements/print_var.expected.rb

@@ -0,0 +1,10 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    puts "custom print_var SimpleClass#simple_function test_other: #{test_other}" # __AUTO_GENERATED_PRINT_VAR__
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/print_var/rb/multiple-statements/print_var.start.rb

@@ -0,0 +1,9 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/print_var/rb/simple-function-nor-mode/print_var.commands

@@ -0,0 +1,2 @@
+:4
+:execute "norm! we\<Esc>"

lua/refactoring/tests/debug/print_var/rb/simple-function-nor-mode/print_var.expected.rb

@@ -0,0 +1,10 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    puts "SimpleClass#simple_function test_other: #{test_other}" # __AUTO_GENERATED_PRINT_VAR__
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/print_var/rb/simple-function-nor-mode/print_var.opts

@@ -0,0 +1 @@
+true

lua/refactoring/tests/debug/print_var/rb/simple-function-nor-mode/print_var.start.rb

@@ -0,0 +1,9 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/print_var/rb/simple-function/print_var.commands

@@ -0,0 +1,2 @@
+:4
+:execute "norm! wve\<Esc>"

lua/refactoring/tests/debug/print_var/rb/simple-function/print_var.expected.rb

@@ -0,0 +1,10 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    puts "SimpleClass#simple_function test_other: #{test_other}" # __AUTO_GENERATED_PRINT_VAR__
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/print_var/rb/simple-function/print_var.start.rb

@@ -0,0 +1,9 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/printf/rb/complex-function/printf.commands

@@ -0,0 +1 @@
+:3

lua/refactoring/tests/debug/printf/rb/complex-function/printf.expected.rb

@@ -0,0 +1,12 @@
+module SimpleModule
+  class SimpleClass
+    def simple_function(a)
+    puts "SimpleModule#SimpleClass#simple_function" # __AUTO_GENERATED_PRINTF__
+      test = 1
+      test_other = 11
+      for x in test..test_other do
+        puts x, a
+      end
+    end
+  end
+end

lua/refactoring/tests/debug/printf/rb/complex-function/printf.start.rb

@@ -0,0 +1,11 @@
+module SimpleModule
+  class SimpleClass
+    def simple_function(a)
+      test = 1
+      test_other = 11
+      for x in test..test_other do
+        puts x, a
+      end
+    end
+  end
+end

lua/refactoring/tests/debug/printf/rb/multiple-statements/printf.commands

@@ -0,0 +1 @@
+:1

lua/refactoring/tests/debug/printf/rb/multiple-statements/printf.config

@@ -0,0 +1 @@
+puts "debug path %s"

lua/refactoring/tests/debug/printf/rb/multiple-statements/printf.expected.rb

@@ -0,0 +1,4 @@
+def main
+puts "debug path main" # __AUTO_GENERATED_PRINTF__
+  pass
+end

lua/refactoring/tests/debug/printf/rb/multiple-statements/printf.start.rb

@@ -0,0 +1,3 @@
+def main
+  pass
+end

lua/refactoring/tests/debug/printf/rb/simple-function/printf.commands

@@ -0,0 +1 @@
+:3

lua/refactoring/tests/debug/printf/rb/simple-function/printf.expected.rb

@@ -0,0 +1,10 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    puts "SimpleClass#simple_function" # __AUTO_GENERATED_PRINTF__
+    test_other = 11
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug/printf/rb/simple-function/printf.start.rb

@@ -0,0 +1,9 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+    for x in test..test_other do
+      puts x, a
+    end
+  end
+end

lua/refactoring/tests/debug_spec.lua

@@ -39,6 +39,7 @@ local function set_config_options(filename_prefix, filename_extension)
                 ["ts"] = "typescript",
                 ["js"] = "javascript",
                 ["py"] = "python",
+                ["rb"] = "ruby",
             }
 
             -- get the real filetype from the above table if possible

lua/refactoring/tests/refactor/106/rb/class/extract.commands

@@ -0,0 +1,2 @@
+:6
+:execute "norm! Vjj\<Esc>"

lua/refactoring/tests/refactor/106/rb/class/extract.cursor_position

@@ -0,0 +1,2 @@
+13
+5

lua/refactoring/tests/refactor/106/rb/class/extract.expected.rb

@@ -0,0 +1,15 @@
+class SimpleClass
+def foo_bar(a, test, test_other)
+    [test, test_other].each do |v|
+      puts "#{a} #{v}"
+    end
+end
+
+
+  def simple_function(a)
+    test = 1
+    test_other = 11
+
+    foo_bar(a, test, test_other)
+  end
+end

lua/refactoring/tests/refactor/106/rb/class/extract.inputs

@@ -0,0 +1 @@
+foo_bar

lua/refactoring/tests/refactor/106/rb/class/extract.start.rb

@@ -0,0 +1,10 @@
+class SimpleClass
+  def simple_function(a)
+    test = 1
+    test_other = 11
+
+    [test, test_other].each do |v|
+      puts "#{a} #{v}"
+    end
+  end
+end

lua/refactoring/tests/refactor/106/rb/extract_block-1/extract_block.commands

@@ -0,0 +1 @@
+:5

lua/refactoring/tests/refactor/106/rb/extract_block-1/extract_block.cursor_position

@@ -0,0 +1,2 @@
+10
+0

lua/refactoring/tests/refactor/106/rb/extract_block-1/extract_block.expected.rb

@@ -0,0 +1,13 @@
+
+def foo_bar(a)
+  test = 1
+    test_other = 11
+
+    [test, test_other].each do |v|
+      puts "#{a} #{v}"
+    end
+end
+
+def simple_function(a)
+  foo_bar(a)
+end

lua/refactoring/tests/refactor/106/rb/extract_block-1/extract_block.inputs

@@ -0,0 +1 @@
+foo_bar

lua/refactoring/tests/refactor/106/rb/extract_block-1/extract_block.start.rb

@@ -0,0 +1,8 @@
+def simple_function(a)
+  test = 1
+  test_other = 11
+
+  [test, test_other].each do |v|
+    puts "#{a} #{v}"
+  end
+end

lua/refactoring/tests/refactor/106/rb/extract_block-2/extract_block.commands

@@ -0,0 +1 @@
+:5

lua/refactoring/tests/refactor/106/rb/extract_block-2/extract_block.cursor_position

@@ -0,0 +1,2 @@
+10
+3

lua/refactoring/tests/refactor/106/rb/extract_block-2/extract_block.expected.rb

@@ -0,0 +1,13 @@
+
+def foo_bar(test)
+  test_other = 11
+
+    [test, test_other].each do |v|
+      puts "#{v}"
+    end
+end
+
+def simple_function
+  test = 1
+  foo_bar(test)
+end

lua/refactoring/tests/refactor/106/rb/extract_block-2/extract_block.inputs

@@ -0,0 +1 @@
+foo_bar

lua/refactoring/tests/refactor/106/rb/extract_block-2/extract_block.start.rb

@@ -0,0 +1,8 @@
+def simple_function
+  test = 1
+  test_other = 11
+
+  [test, test_other].each do |v|
+    puts "#{v}"
+  end
+end