Merge pull request #34 from DannyBen/escape-quotes

Sanitize usage strings for quotes

Author: DannyBen

lib/bashly/extensions/string.rb

@@ -1,6 +1,6 @@
 class String
-  def escape_newlines
-    gsub "\n", "\\n"
+  def sanitize_for_print
+    gsub("\n", "\\n").gsub("\"", "\\\"")
   end
 
   def indent(offset)

lib/bashly/views/argument/usage.erb

@@ -1,4 +1,4 @@
 # :argument.usage
 echo "  <%= name.upcase %>"
-echo -e "<%= help.wrap(76).indent(4).escape_newlines %>"
+echo -e "<%= help.wrap(76).indent(4).sanitize_for_print %>"
 echo

lib/bashly/views/command/usage.erb

@@ -7,7 +7,7 @@
     <%- else -%>
     echo -e "<%= full_name %>"
     echo 
-    echo -e "<%= help.wrap(78).indent(2).escape_newlines %>"
+    echo -e "<%= help.wrap(78).indent(2).sanitize_for_print %>"
     echo 
     <%- end -%>
   else

lib/bashly/views/command/usage_environment_variables.erb

@@ -2,6 +2,6 @@
 echo -e "<%= strings[:environment_variables] %>"
 <%- environment_variables.each do |name, description| -%>
 echo "  <%= name %>"
-echo -e "<%= description.wrap(76).indent(4).escape_newlines %>"
+echo -e "<%= description.wrap(76).indent(4).sanitize_for_print %>"
 <%- end -%>
 echo

lib/bashly/views/command/usage_examples.erb

@@ -2,6 +2,6 @@
 echo -e "<%= strings[:examples] %>"
 
 <%- examples.each do |example| -%>
-echo -e "<%= example.wrap(78).indent(2).escape_newlines %>"
+echo -e "<%= example.wrap(78).indent(2).sanitize_for_print %>"
 <%- end -%>
 echo

lib/bashly/views/flag/usage.erb

@@ -1,4 +1,4 @@
 # :flag.usage
 echo "  <%= usage_string extended: true %>"
-echo -e "<%= help.wrap(76).indent(4).escape_newlines %>"
+echo -e "<%= help.wrap(76).indent(4).sanitize_for_print %>"
 echo

spec/bashly/extensions/string_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
 describe Array do
-  describe '#escape_newlines' do
-    subject { "hello\nworld" }
-    it "escapes newlines" do
-      expect(subject.escape_newlines).to eq "hello\\nworld"
+  describe '#sanitize_for_print' do
+    subject { %Q[this is\na "new line"] }
+    it "escapes newlines and quotes" do
+      expect(subject.sanitize_for_print).to eq "this is\\na \\\"new line\\\""
     end
   end