Added support for single quoted strings. Tried to get multi-line if statements to work, still some problems.

Author: et

README.textile

@@ -1,14 +1,23 @@
-Please note that this application is a development stage.
+Please note that this application is in a development stage.
 I'm just adding this README, so github will stop complaining to me.
 
 
 h1. Tcsh2Bash
 
 This application will read in a tcsh script and try to output the bash equivalent.
 
+h2. Motivation
+
+Tcsh, an improvement on the C shell, is generally chosen as a default shell for many environments
+because of how it mimics the C language. However, there are many ambiguities and limitations
+with the language. Additionally, documentation on the language is sparse compared to bash.
+
+This application is developed for people trying to migrate from tcsh to bash such as converting
+a cshrc to bashrc or for people who want to support bash on a tcsh driven system.
+
 h2. Requirements
 
-Ruby "1.9.2":http://www.ruby-lang.org/en/downloads/ (an older version may work, not sure)
+Ruby "1.9.2":http://www.ruby-lang.org/en/downloads/ (older versions probably work, this is just the one I use)
 "RubyGems":http://rubygems.org/pages/download
 
 I recommend installing both with "rvm":http://rvm.beginrescueend.com/rvm/install/
@@ -25,3 +34,28 @@ Run it as follows
 
 * Output to standard out: @./tcsh2bash --infile cshrc@
 * Output to a file: @./tcsh2bash --infile cshrc --outfile bashrc@
+
+h3. Sample
+
+Input
+
+pre. alias hello goodbye
+setenv editor vim
+set p=d
+q243aca 0w3
+
+Output
+
+pre. alias hello=goodbye
+export editor=vim
+p=d
+#######################
+# Unable to parse: q243aca 0w3
+#######################
+
+h2. Additional Notes
+
+There are no guarantees that the bash output produces the same logic as the tcsh script so please
+review the changes especially if using this in a production environment.
+Also, this application is not a mind reader. If you feed it a malformed tcsh script,
+it doesn't make any "logical" guess at what you meant.

lib/tcsh2bash/nodes.rb

@@ -1,6 +1,7 @@
 require 'treetop'
 
 require File.dirname(__FILE__) + '/nodes/tcsh'
+require File.dirname(__FILE__) + '/nodes/conditional'
 require File.dirname(__FILE__) + '/nodes/assignment'
 require File.dirname(__FILE__) + '/nodes/boolean'
 require File.dirname(__FILE__) + '/nodes/operators'

lib/tcsh2bash/nodes/conditional.rb

@@ -0,0 +1,20 @@
+module Tcsh2Bash
+  class IfOneLine < Treetop::Runtime::SyntaxNode
+    def to_bash
+      if_opening.to_bash + " ; then " + command.to_bash + " ; fi"
+    end
+  end
+
+  class IfMultiLine < Treetop::Runtime::SyntaxNode
+    def to_bash
+      if_opening.to_bash + "\nthen\n" + commands.to_bash + "\nfi"
+    end
+  end
+
+  class IfOpening < Treetop::Runtime::SyntaxNode
+    def to_bash
+      "if " + paren_bool_expr.to_bash
+    end
+  end
+
+end

lib/tcsh2bash/parsers.rb

@@ -1,5 +1,6 @@
 require 'treetop'
 
+require File.dirname(__FILE__) + '/parsers/tokens'
 require File.dirname(__FILE__) + '/parsers/symbols'
 require File.dirname(__FILE__) + '/parsers/operators'
 require File.dirname(__FILE__) + '/parsers/boolean'

lib/tcsh2bash/parsers/conditional.treetop

@@ -12,10 +12,34 @@ module Tcsh2Bash
     #  if_one_line
     #end
 
+    rule if_statement
+      if_multi_line / if_one_line
+    end
+
+    rule if_multi_line
+      if_opening 'then' newline commands newline 'endif' <IfMultiLine>
+    end
+
     rule if_one_line
-      'if' space* open_paren paren_bool_expr close_paren space* stmt:(assignment / anything) {
+      if_opening command <IfOneLine>
+    end
+
+    rule if_opening
+      'if' space* paren_bool_expr space* <IfOpening>
+    end
+
+    rule commands
+      command (newline command)*
+    end
+
+    rule command
+      assignment / any_command
+    end
+
+    rule any_command
+      (!(newline / eof) .)* {
         def to_bash
-          "if " + paren_bool_expr.to_bash + "\nthen\n  " + stmt.to_bash + "\nfi"
+          text_value
         end
       }
     end

lib/tcsh2bash/parsers/symbols.treetop

@@ -1,68 +1,38 @@
 module Tcsh2Bash
   grammar Symbols
+    include Tokens
 
-    # @todo - this works for double quoted strings,
-    #         should be able to use this with single quoted strings
     rule string
-      '"' (!'"' . / '\"')* '"'
+      single_quoted_string / double_quoted_string
     end
 
-    rule variable_ref
-      dollar variable
+    rule double_quoted_string
+      '"' [^"]* '"'
     end
 
-    rule variable
-      [a-zA-Z_] value*
+    rule single_quoted_string
+      "'" [^']* "'"
     end
 
-    rule value
-      [\w]+
+    rule backtick_string
+      backtick string backtick
     end
 
-    rule open_paren
-      '('
-    end
-
-    rule close_paren
-      ')'
-    end
-
-    rule quote
-      "'" / '"' / '`'
-    end
-
-    rule dollar
-      '$'
-    end
-
-    rule number
-      [0-9] [0-9]*
+    rule variable_ref
+      dollar variable
     end
 
-
-    rule newline
-      [\n]
+    rule variable
+      [a-zA-Z_] value*
     end
 
-    rule space
-      [ \t]
+    rule value
+      [\w]+
     end
 
     rule white
       [ \t\n\r\f]
     end
 
-    rule eof
-      !.
-    end
-
-    rule anything
-      .* {
-        def to_bash
-          text_value
-        end
-      }
-    end
-
   end
 end

lib/tcsh2bash/parsers/tokens.treetop

@@ -0,0 +1,44 @@
+module Tcsh2Bash
+  grammar Tokens
+
+    rule single_quote
+      "'"
+    end
+
+    rule double_quote
+      "\""
+    end
+
+    rule backtick
+      "`"
+    end
+
+    rule open_paren
+      "("
+    end
+
+    rule close_paren
+      ")"
+    end
+
+    rule dollar
+      "$"
+    end
+
+    rule number
+      [0-9] [0-9]*
+    end
+
+    rule newline
+      "\n"
+    end
+
+    rule space
+      [ \t]
+    end
+
+    rule eof
+      !.
+    end
+  end
+end

spec/parsers/conditional_parser_spec.rb

@@ -9,29 +9,40 @@ module Tcsh2Bash
     describe "one line if statement" do
       it "should convert it a one line if statement to bash" do
 
-        output = <<EOF
-if [ $foo == "foo" ]
-then
-  echo "Hello world!"
-fi
-EOF
-        output.strip!
+output = <<IF_ONE_LINE.strip
+if [ $foo == "foo" ] ; then echo "Hello world!" ; fi
+IF_ONE_LINE
 
         convert_to_bash('if ($foo == "foo") echo "Hello world!"').should == output
       end
 
       it "should convert assignments when possible" do
-        output = <<EOF
-if [ $foo -gt 2 ]
-then
-  alias foo=bar
-fi
-EOF
-        output.strip!
+
+output = <<IF_ONE_LINE.strip
+if [ $foo -gt 2 ] ; then alias foo=bar ; fi
+IF_ONE_LINE
 
         convert_to_bash('if ($foo > 2) alias foo bar').should == output
       end
     end
 
+    describe "multi line if statement" do
+      it "should convert a multiline statement to bash" do
+
+      input = <<INPUT.strip
+if ($foo == 'foo') then
+  echo 'Hello world!'
+endif
+INPUT
+
+output = <<OUTPUT.strip
+if [ $foo == 'foo' ]
+then
+  echo 'Hello world!'
+fi
+OUTPUT
+        convert_to_bash(input).should == output
+      end
+    end
   end
 end

spec/parsers/symbols_parser_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Tcsh2Bash
+  describe SymbolsParser do
+
+    before :each do
+      @parser = SymbolsParser.new
+    end
+
+    describe 'strings' do
+      it 'should parse double quoted string' do
+        parse('"hello world"').should_not be_nil
+      end
+
+      it 'should parse single quoted strings' do
+        parse("'hello'").should_not be_nil
+      end
+
+      describe 'mixed quoted string' do
+        it 'should parse single quotes on the outside' do
+
+output = <<MIXED
+'Hello "World"'
+MIXED
+          parse(output).should_not be_nil
+        end
+
+        it 'should parse double quotes on the outside' do
+output = <<MIXED
+"Hello 'World'"
+MIXED
+          parse(output).should_not be_nil
+        end
+      end
+    end
+  end
+end