eden 0.1.1

data/test/array_literal_tokenization_test.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+class ArrayLiteralTokenizationTest < Test::Unit::TestCase
+  def setup
+    @sf = Eden::SourceFile.new( "dummy.rb" )
+  end
+
+  def test_array_literal_tokenization
+    @sf.stubs(:source).returns("%w{rah rah rah}\n%w<rah <rah> rah>")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 2, tokens.size
+    assert_equal :array_literal, tokens[0].type
+    assert_equal "%w{rah rah rah}", tokens[0].content
+    tokens = @sf.lines[1].tokens
+    assert_equal :array_literal, tokens[0].type
+    assert_equal "%w<rah <rah> rah>", tokens[0].content
+  end
+
+  def test_should_not_expand_delimited_array_literal
+    @sf.stubs(:source).returns("%w{rah \#{@inst} rah}\n")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 2, tokens.size
+    assert_equal :array_literal, tokens[0].type
+    assert_equal "%w{rah \#{@inst} rah}", tokens[0].content
+  end
+
+  def test_should_tokenize_expanded_array_literal
+    @sf.stubs(:source).returns("%W{rah \#{@inst} rah}\n")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 6, tokens.size
+    assert_equal :array_literal, tokens[0].type
+    assert_equal "%W{rah \#", tokens[0].content
+    assert_equal :lcurly, tokens[1].type
+    assert_equal :instancevar, tokens[2].type
+    assert_equal "@inst", tokens[2].content
+    assert_equal :rcurly, tokens[3].type
+    assert_equal :array_literal, tokens[4].type
+    assert_equal " rah}", tokens[4].content
+  end
+end

data/test/basic_tokenization_test.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + "/test_helper"
+
+class BasicTokenizationTest < Test::Unit::TestCase
+  def setup
+    @sf = Eden::SourceFile.new("dummy.rb")
+  end
+
+  def test_should_tokenize_linebreak_escape
+    @sf.stubs(:source).returns("puts \\\n  'rah'")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 4, tokens.size
+    assert_equal :backslash, tokens[2].type
+    assert_equal :newline, tokens[3].type
+  end
+
+  def test_should_tokenize_question_mark_character_literals
+    @sf.stubs(:source).returns("?a ?} ?\u2332\n")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 6, tokens.size
+    assert_equal :character_literal, tokens[0].type
+    assert_equal "?a", tokens[0].content
+    assert_equal :character_literal, tokens[2].type
+    assert_equal "?}", tokens[2].content
+    assert_equal :character_literal, tokens[4].type
+    assert_equal "?\u2332", tokens[4].content
+  end
+end

data/test/block_formatter_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+require File.dirname(__FILE__) + "/../lib/eden/formatters/block_formatter"
+
+class BlockFormatterTest < Test::Unit::TestCase
+  def setup
+    @sf = Eden::SourceFile.new("dummy.rb")
+  end
+
+  def test_should_add_spaces_in_block
+    @sf.stubs(:source).returns("things.map {|th|th+1}\n")
+    @sf.tokenize!
+    BlockFormatter.format( @sf )
+    assert_equal @sf.lines[0].joined_tokens, "things.map { |th|th+1 }\n"
+  end
+
+  def test_should_not_change_block_when_disabled
+    BlockFormatter.configure do |b|
+      b.adjust_blocks false
+    end
+
+    @sf.stubs(:source).returns("things.map {|th|th+1}\n")
+    @sf.tokenize!
+    BlockFormatter.format( @sf )
+    assert_equal @sf.lines[0].joined_tokens, "things.map {|th|th+1}\n"
+
+    BlockFormatter.configure do |b|
+      b.adjust_blocks true
+    end
+  end
+
+  def test_should_use_correct_number_of_correct_characters
+    BlockFormatter.configure do |b|
+      b.padding_character "t"
+      b.padding_character_count 2
+    end
+
+    @sf.stubs(:source).returns("things.map {|th|th+1}\n")
+    @sf.tokenize!
+    BlockFormatter.format( @sf )
+    assert_equal @sf.lines[0].joined_tokens, "things.map {tt|th|th+1tt}\n"
+
+    BlockFormatter.configure do |b|
+      b.padding_character " "
+      b.padding_character_count 1
+    end
+  end
+end

data/test/class_var_token_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+class IdentifierTokenTest < Test::Unit::TestCase
+  def setup
+    @sf = Eden::SourceFile.new( "dummy.rb" )
+  end
+
+  def test_instance_var__tokenization
+    @sf.stubs(:source).returns("@@token @@_token @@token2")
+    @sf.tokenize!
+    line = @sf.lines[0]
+    assert_equal 5, line.tokens.size
+    assert_equal "@@token", line.tokens[0].content
+    assert_equal :classvar, line.tokens[0].type
+    assert_equal "@@_token", line.tokens[2].content
+    assert_equal :classvar, line.tokens[2].type
+    assert_equal "@@token2", line.tokens[4].content
+    assert_equal :classvar, line.tokens[4].type
+  end
+
+end

data/test/identifier_token_test.rb

@@ -0,0 +1,140 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+class IdentifierTokenTest < Test::Unit::TestCase
+  def setup
+    @sf = Eden::SourceFile.new( "dummy.rb" )
+  end
+
+  def test_leading_underscore_identifier_tokenization
+    @sf.stubs(:source).returns("    _token")
+    @sf.tokenize!
+    line = @sf.lines[0]
+    assert_equal 2, line.tokens.size
+    assert_equal "_token", line.tokens[1].content
+    assert_equal :identifier, line.tokens[1].type
+  end
+
+  def test_multiple_token_tokenization
+    @sf.stubs(:source).returns("token other_token")
+    @sf.tokenize!
+    line = @sf.lines[0]
+    assert_equal 3, line.tokens.size
+    assert_equal "token", line.tokens[0].content
+    assert_equal :identifier, line.tokens[0].type
+    assert_equal "other_token", line.tokens[2].content
+    assert_equal :identifier, line.tokens[2].type
+  end
+
+  def test_keyword_tokenization_1
+    @sf.stubs(:source).returns("__FILE__ __ENCODING__ __LINE__ BEGIN END")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 9, tokens.size
+    assert_equal :__file__, tokens[0].type
+    assert_equal "__FILE__", tokens[0].content
+    assert_equal :__encoding__, tokens[2].type
+    assert_equal "__ENCODING__", tokens[2].content
+    assert_equal :__line__, tokens[4].type
+    assert_equal "__LINE__", tokens[4].content
+    assert_equal :begin_global, tokens[6].type
+    assert_equal "BEGIN", tokens[6].content
+    assert_equal :end_global, tokens[8].type
+    assert_equal "END", tokens[8].content
+  end
+
+  def test_keyword_tokenization_2
+    @sf.stubs(:source).returns("alias and begin break case class def do end")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 17, tokens.size
+    assert_equal :alias, tokens[0].type
+    assert_equal "alias", tokens[0].content
+    assert_equal :and, tokens[2].type
+    assert_equal "and", tokens[2].content
+    assert_equal :begin, tokens[4].type
+    assert_equal "begin", tokens[4].content
+    assert_equal :break, tokens[6].type
+    assert_equal "break", tokens[6].content
+    assert_equal :case, tokens[8].type
+    assert_equal "case", tokens[8].content
+    assert_equal :class, tokens[10].type
+    assert_equal "class", tokens[10].content
+    assert_equal :def, tokens[12].type
+    assert_equal "def", tokens[12].content
+    assert_equal :do, tokens[14].type
+    assert_equal "do", tokens[14].content
+    assert_equal :end, tokens[16].type
+    assert_equal "end", tokens[16].content
+  end
+
+  def test_keyword_tokenization_3
+    @sf.stubs(:source).returns("else elsif ensure for false if in module")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 15, tokens.size
+    assert_equal :else, tokens[0].type
+    assert_equal "else", tokens[0].content
+    assert_equal :elsif, tokens[2].type
+    assert_equal "elsif", tokens[2].content
+    assert_equal :ensure, tokens[4].type
+    assert_equal "ensure", tokens[4].content
+    assert_equal :for, tokens[6].type
+    assert_equal "for", tokens[6].content
+    assert_equal :false, tokens[8].type
+    assert_equal "false", tokens[8].content
+    assert_equal :if, tokens[10].type
+    assert_equal "if", tokens[10].content
+    assert_equal :in, tokens[12].type
+    assert_equal "in", tokens[12].content
+    assert_equal :module, tokens[14].type
+    assert_equal "module", tokens[14].content
+  end
+
+  def test_keyword_tokenization_4
+    @sf.stubs(:source).returns("next nil not or redo rescue retry return super")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 17, tokens.size
+    assert_equal :next, tokens[0].type
+    assert_equal "next", tokens[0].content
+    assert_equal :nil, tokens[2].type
+    assert_equal "nil", tokens[2].content
+    assert_equal :not, tokens[4].type
+    assert_equal "not", tokens[4].content
+    assert_equal :or, tokens[6].type
+    assert_equal "or", tokens[6].content
+    assert_equal :redo, tokens[8].type
+    assert_equal "redo", tokens[8].content
+    assert_equal :rescue, tokens[10].type
+    assert_equal "rescue", tokens[10].content
+    assert_equal :retry, tokens[12].type
+    assert_equal "retry", tokens[12].content
+    assert_equal :return, tokens[14].type
+    assert_equal "return", tokens[14].content
+    assert_equal :super, tokens[16].type
+    assert_equal "super", tokens[16].content
+  end
+
+  def test_keyword_tokenization_5
+    @sf.stubs(:source).returns("then true undef unless until when while yield")
+    @sf.tokenize!
+    tokens = @sf.lines[0].tokens
+    assert_equal 15, tokens.size
+    assert_equal :then, tokens[0].type
+    assert_equal "then", tokens[0].content
+    assert_equal :true, tokens[2].type
+    assert_equal "true", tokens[2].content
+    assert_equal :undef, tokens[4].type
+    assert_equal "undef", tokens[4].content
+    assert_equal :unless, tokens[6].type
+    assert_equal "unless", tokens[6].content
+    assert_equal :until, tokens[8].type
+    assert_equal "until", tokens[8].content
+    assert_equal :when, tokens[10].type
+    assert_equal "when", tokens[10].content
+    assert_equal :while, tokens[12].type
+    assert_equal "while", tokens[12].content
+    assert_equal :yield, tokens[14].type
+    assert_equal "yield", tokens[14].content
+  end
+end

data/test/indenter_test.rb

@@ -0,0 +1,314 @@
+require File.dirname(__FILE__) + "/test_helper"
+require File.dirname(__FILE__) + "/../lib/eden/formatters/indenter.rb"
+
+class IndenterTest < Test::Unit::TestCase
+  def setup 
+    @sf = Eden::SourceFile.new( "dummy.rb" )
+  end
+
+  def test_should_not_indent_when_not_configured
+    Indenter.configure do |i|
+      i.adjust_indents false
+    end
+
+    @sf.stubs(:source).returns("def function\nreturn nil\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "def function\n", @sf.lines[0].joined_tokens
+    assert_equal "return nil\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+
+    Indenter.configure do |i|
+      i.adjust_indents true
+    end
+  end
+
+  def test_should_use_correct_indent_character_when_indenting
+    Indenter.configure do |i|
+      i.indent_character "\t"
+      i.indent_characters_per_step 1
+    end
+
+    @sf.stubs(:source).returns("def function\nreturn nil\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "def function\n", @sf.lines[0].joined_tokens
+    assert_equal "\treturn nil\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+
+    Indenter.configure do |i|
+      i.indent_character " "
+      i.indent_characters_per_step 2
+    end
+  end
+
+  def test_should_not_indent_heredoc
+    @sf.stubs(:source).returns(<<-SOURCE)
+class Test
+def function
+rah = <<-HEREDOC
+rah234
+HEREDOC
+end
+end
+SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "class Test\n", @sf.lines[0].joined_tokens
+    assert_equal "  def function\n", @sf.lines[1].joined_tokens
+    assert_equal "    rah = <<-HEREDOC\n", @sf.lines[2].joined_tokens
+    assert_equal "rah234\nHEREDOC\n", @sf.lines[3].joined_tokens
+    assert_equal "  end\n", @sf.lines[4].joined_tokens    
+    assert_equal "end\n", @sf.lines[5].joined_tokens    
+  end
+
+  def test_should_indent_function_body
+    @sf.stubs(:source).returns("def function\nreturn nil\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "def function\n", @sf.lines[0].joined_tokens
+    assert_equal "  return nil\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+  end
+
+  def test_should_indent_class_body
+    @sf.stubs(:source).returns("class Test\ndef blah\nreturn nil\nend\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "class Test\n", @sf.lines[0].joined_tokens
+    assert_equal "  def blah\n", @sf.lines[1].joined_tokens
+    assert_equal "    return nil\n", @sf.lines[2].joined_tokens
+    assert_equal "  end\n", @sf.lines[3].joined_tokens
+    assert_equal "end\n", @sf.lines[4].joined_tokens
+  end
+
+  def test_should_indent_module_body
+    @sf.stubs(:source).returns("module Test\ndef blah\nreturn nil\nend\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "module Test\n", @sf.lines[0].joined_tokens
+    assert_equal "  def blah\n", @sf.lines[1].joined_tokens
+    assert_equal "    return nil\n", @sf.lines[2].joined_tokens
+    assert_equal "  end\n", @sf.lines[3].joined_tokens
+    assert_equal "end\n", @sf.lines[4].joined_tokens
+  end
+
+  def test_should_not_indent_one_line_class
+    @sf.stubs(:source).returns("class Test; end\nclass Test2; end\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "class Test; end\n", @sf.lines[0].joined_tokens
+    assert_equal "class Test2; end\n", @sf.lines[1].joined_tokens
+  end
+
+  def test_should_indent_class_to_self_block
+    # Note: Each line here has six spaces of indent before it, so this
+    # tests the logic in adjust_indent where there is an existing whitespace
+    # token at the start of the line
+    @sf.stubs(:source).returns(<<-SOURCE)
+      class Test
+      class << self
+      def function
+      return nil
+      end
+      end
+      end
+    SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "class Test\n", @sf.lines[0].joined_tokens
+    assert_equal "  class << self\n", @sf.lines[1].joined_tokens
+    assert_equal "    def function\n", @sf.lines[2].joined_tokens
+    assert_equal "      return nil\n", @sf.lines[3].joined_tokens
+    assert_equal "    end\n", @sf.lines[4].joined_tokens
+    assert_equal "  end\n", @sf.lines[5].joined_tokens
+    assert_equal "end\n", @sf.lines[6].joined_tokens
+  end
+
+  def test_should_indent_block
+    @sf.stubs(:source).returns("@item.map do |i|\ni*2\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "@item.map do |i|\n", @sf.lines[0].joined_tokens
+    assert_equal "  i*2\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+  end
+
+  def test_should_indent_begin_rescue_block
+    @sf.stubs(:source).returns("def function\nbegin\nHttp.get\nrescue\nHttp.post\nend\nend\n")
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "def function\n", @sf.lines[0].joined_tokens
+    assert_equal "  begin\n", @sf.lines[1].joined_tokens
+    assert_equal "    Http.get\n", @sf.lines[2].joined_tokens
+    assert_equal "  rescue\n", @sf.lines[3].joined_tokens
+    assert_equal "    Http.post\n", @sf.lines[4].joined_tokens
+    assert_equal "  end\n", @sf.lines[5].joined_tokens
+    assert_equal "end\n", @sf.lines[6].joined_tokens
+  end
+
+  # Control Flow Statements
+  #-----------------------------------------------------------------------------
+
+  def test_should_indent_if_else_block
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /, ''))
+      if @something
+      do_something
+      elsif @something_else
+      do_nothing
+      else
+      do_something_else
+      end
+    SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "if @something\n", @sf.lines[0].joined_tokens
+    assert_equal "  do_something\n", @sf.lines[1].joined_tokens
+    assert_equal "elsif @something_else\n", @sf.lines[2].joined_tokens
+    assert_equal "  do_nothing\n", @sf.lines[3].joined_tokens
+    assert_equal "else\n", @sf.lines[4].joined_tokens
+    assert_equal "  do_something_else\n", @sf.lines[5].joined_tokens
+    assert_equal "end\n", @sf.lines[6].joined_tokens
+  end
+
+  def test_should_indent_case_statement_when_not_set
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /, ''))
+      case @something
+      when :this
+      do_this
+      when :that
+      do_that
+      else
+      do_the_other
+      end
+SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "case @something\n", @sf.lines[0].joined_tokens
+    assert_equal "when :this\n", @sf.lines[1].joined_tokens
+    assert_equal "  do_this\n", @sf.lines[2].joined_tokens
+    assert_equal "when :that\n", @sf.lines[3].joined_tokens
+    assert_equal "  do_that\n", @sf.lines[4].joined_tokens
+    assert_equal "else\n", @sf.lines[5].joined_tokens
+    assert_equal "  do_the_other\n", @sf.lines[6].joined_tokens
+    assert_equal "end\n", @sf.lines[7].joined_tokens
+  end
+
+  # if suffix condition
+  def test_should_not_indent_suffix_conditional
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /,''))
+      def function
+      do_something if some_condition
+      do_something_else
+      end
+SOURCE
+      @sf.tokenize!
+      Indenter.format( @sf )
+      assert_equal "def function\n", @sf.lines[0].joined_tokens
+      assert_equal "  do_something if some_condition\n", @sf.lines[1].joined_tokens
+      assert_equal "  do_something_else\n", @sf.lines[2].joined_tokens
+      assert_equal "end\n", @sf.lines[3].joined_tokens
+  end
+
+  # unless suffix condition
+  def test_should_not_indent_suffix_conditional2
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /,''))
+      def function
+      do_something unless some_condition
+      do_something_else
+      end
+SOURCE
+      @sf.tokenize!
+      Indenter.format( @sf )
+      assert_equal "def function\n", @sf.lines[0].joined_tokens
+      assert_equal "  do_something unless some_condition\n", @sf.lines[1].joined_tokens
+      assert_equal "  do_something_else\n", @sf.lines[2].joined_tokens
+      assert_equal "end\n", @sf.lines[3].joined_tokens
+  end  
+
+  # Loop Statements
+  #-----------------------------------------------------------------------------
+
+  def test_should_indent_while_statement
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /, ''))
+      while @something
+      do_something
+      end
+SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "while @something\n", @sf.lines[0].joined_tokens
+    assert_equal "  do_something\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+  end
+
+  def test_should_not_index_suffix_while_statement
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /,''))
+      def function
+      do_something while some_condition
+      do_something_else
+      end
+SOURCE
+      @sf.tokenize!
+      Indenter.format( @sf )
+      assert_equal "def function\n", @sf.lines[0].joined_tokens
+      assert_equal "  do_something while some_condition\n", @sf.lines[1].joined_tokens
+      assert_equal "  do_something_else\n", @sf.lines[2].joined_tokens
+      assert_equal "end\n", @sf.lines[3].joined_tokens
+  end
+
+  def test_should_indent_while_statement_with_optional_do
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /, ''))
+      while @something do
+      do_something
+      end
+SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "while @something do\n", @sf.lines[0].joined_tokens
+    assert_equal "  do_something\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+  end
+
+  def test_should_indent_until_statement
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /, ''))
+      until @something
+      do_something
+      end
+SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "until @something\n", @sf.lines[0].joined_tokens
+    assert_equal "  do_something\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+  end
+
+  def test_should_not_index_suffix_until_statement
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /,''))
+      def function
+      do_something until some_condition
+      do_something_else
+      end
+SOURCE
+      @sf.tokenize!
+      Indenter.format( @sf )
+      assert_equal "def function\n", @sf.lines[0].joined_tokens
+      assert_equal "  do_something until some_condition\n", @sf.lines[1].joined_tokens
+      assert_equal "  do_something_else\n", @sf.lines[2].joined_tokens
+      assert_equal "end\n", @sf.lines[3].joined_tokens
+  end
+
+  def test_should_indent_until_statement_with_optional_do
+    @sf.stubs(:source).returns(<<-SOURCE.gsub(/^      /, ''))
+      until @something do
+      do_something
+      end
+SOURCE
+    @sf.tokenize!
+    Indenter.format( @sf )
+    assert_equal "until @something do\n", @sf.lines[0].joined_tokens
+    assert_equal "  do_something\n", @sf.lines[1].joined_tokens
+    assert_equal "end\n", @sf.lines[2].joined_tokens
+  end
+
+end