ruby-beautify 0.94.0 → 0.94.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 894e285bf45a3569ff950d814687a9df9fd9ac1f
-  data.tar.gz: 913f62f88fd4e65783adcc71f2193fc3ee65bf1d
+  metadata.gz: c0d8f2666a10cd5f951233487ef5bcbc18226747
+  data.tar.gz: a43bca59db59c2aa94b1ea8538c7aa29ba0a19f8
 SHA512:
-  metadata.gz: 0769f3ed536d176898707c9fdbd2f46c26ec8a84c84be60f81e01a90b72a78324f4aa81f257e90ba3300eebc5b355ffbf130311983d6c5aff74aea7c993e6871
-  data.tar.gz: f5ee63bf346accda19c6a5337003e0775c3c06d583099b797ef38e57d24901d5f1ba194b7c756176d71b726152b352ecc9a591b4e251160964c7fa94b9ca7ba6
+  metadata.gz: 87e379a981c675498389680e58e60cc398d3709c2572bd4eef4cd39120a41679bb992663c86dae23ad02f2c06d0c3fcdba6fc28cfe7a115069f46c3356bc6a3a
+  data.tar.gz: 5a6dbf3aa9c9f2ab1e92e6d7c00006f0e92bc598093512d4e4d36ec882b464cebe4b776d2abd4854f24d5eca2463a36d7a31e0a217d9085cae05e532591cd562

data/WHATSNEW.md

@@ -1,3 +1,6 @@
+## 0.94.1 
+* Multiline string and embedded doc support thanks to @veelenga.
+
 ## 0.94.0
 * Added a very basic spec.
 * Added better support for piping and redirection (thanks @veelenga)

data/bin/rbeautify

@@ -17,71 +17,53 @@ Options.parse!
 @open_block_do  = ['do', '{']
 @close_block = ['end', '}']
 
-@open_brackets  = [:on_lparen, :on_lbracket, :on_lbrace]
-@close_brackets = [:on_rparen, :on_rbracket, :on_rbrace]
+@open_brackets  = [:on_lparen, :on_lbracket, :on_lbrace, :on_embexpr_beg]
+@close_brackets = [:on_rparen, :on_rbracket, :on_rbrace, :on_embexpr_end]
+@new_lines = [:on_nl, :on_ignored_nl, :on_comment, :on_embdoc_end]
+
 @indent_token = "\t" unless @indent_token
 @indent_count = 1 unless @indent_count
 
-def flatten_content(content)
-  # I realize this is slow, todo, make it not slow.
-  flat_content = []
-  content.split("\n").each do |l|
-    w = l.split(/\s*(?<line>.*)/).last
-    if w
-      flat_content.push w
-    else
-      flat_content.push l
-    end
-  end
-
-  return flat_content.join("\n")
-end
-
 def puts_indented_line(level, string)
-  if string.empty? or string =~ /^\n$/
+  if string =~ /^\n$/
     puts
   else
     indent = (@indent_token * @indent_count) * level
-    puts indent + string
+    puts "#{indent}#{string.lstrip}"
   end
 end
 
 def pretty(content)
-  # it's far easier if the content is 'flat', we don't have to worry about
-  # pre-existing indent levels.  So lets lex that.
   begin
-    lex = Ripper.lex(flatten_content(content))
+    lex = Ripper.lex(content)
   rescue
     exit 255
   end
 
-  # quick way to get our total lines.
-  total_lines = lex.last[0][0]
-  line_index = 1
-
   indent_level = 0
+  line_lex = []
 
-  # walk through our lines.
-  while (line_index <= total_lines)
-    # a 'lex' copy of our line.
-    line_lex = lex.select {|l| l[0][0] == line_index}
-    # a string version.
-    line_string = line_lex.map {|l| l.last}.join("")
+  # walk through line tokens
+  lex.each do |token|
+    line_lex << token
+    if @new_lines.include? token[1] # if type of this token is a new line
 
-    # did we just close something?  if so, lets bring it down a level.
-    if closing_block?(line_lex) || closing_assignment?(line_lex)
-      indent_level -=1 if indent_level > 0
-    end
+      # did we just close something?  if so, lets bring it down a level.
+      if closing_block?(line_lex) || closing_assignment?(line_lex)
+        indent_level -= 1 if indent_level > 0
+      end
 
-    # print our line, in place.
-    puts_indented_line(indent_level, line_string)
+      # print our line, in place.
+      line_string = line_lex.map {|l| l.last}.join
+      puts_indented_line(indent_level, line_string)
 
-    # oh, we opened something did we?  lets indent for the next run.
-    if opening_block?(line_lex) || opening_assignment?(line_lex)
-      indent_level +=1
-    end
+      # oh, we opened something did we?  lets indent for the next run.
+      if opening_block?(line_lex) || opening_assignment?(line_lex)
+        indent_level += 1
+      end
 
-    line_index += 1
+      line_lex.clear
+    end
   end
 
   return nil
@@ -99,12 +81,22 @@ end
 
 # is the first word a key word?
 def starts_block?(line_lex)
-  line_lex.first[1] == :on_kw && @open_block_start.include?(line_lex.first[2])
+  line_lex.each do |x|
+    # search for a first non-space token
+    if not x[1] == :on_sp
+      return x[1] == :on_kw && @open_block_start.include?(x[2])
+    end
+  end
 end
 
 # is the first word one of our 'both' keywords?
 def both_block?(line_lex)
-  return line_lex.first[1] == :on_kw && @both_block.include?(line_lex.first[2])
+  line_lex.each do |x|
+    # search for a first non-space token
+    if not x[1] == :on_sp
+      return x[1] == :on_kw && @both_block.include?(x[2])
+    end
+  end
 end
 
 # kinda complex, we count open/close to determine if we ultimately have a

data/bin/ruby-beautify

@@ -17,71 +17,53 @@ Options.parse!
 @open_block_do  = ['do', '{']
 @close_block = ['end', '}']
 
-@open_brackets  = [:on_lparen, :on_lbracket, :on_lbrace]
-@close_brackets = [:on_rparen, :on_rbracket, :on_rbrace]
+@open_brackets  = [:on_lparen, :on_lbracket, :on_lbrace, :on_embexpr_beg]
+@close_brackets = [:on_rparen, :on_rbracket, :on_rbrace, :on_embexpr_end]
+@new_lines = [:on_nl, :on_ignored_nl, :on_comment, :on_embdoc_end]
+
 @indent_token = "\t" unless @indent_token
 @indent_count = 1 unless @indent_count
 
-def flatten_content(content)
-  # I realize this is slow, todo, make it not slow.
-  flat_content = []
-  content.split("\n").each do |l|
-    w = l.split(/\s*(?<line>.*)/).last
-    if w
-      flat_content.push w
-    else
-      flat_content.push l
-    end
-  end
-
-  return flat_content.join("\n")
-end
-
 def puts_indented_line(level, string)
-  if string.empty? or string =~ /^\n$/
+  if string =~ /^\n$/
     puts
   else
     indent = (@indent_token * @indent_count) * level
-    puts indent + string
+    puts "#{indent}#{string.lstrip}"
   end
 end
 
 def pretty(content)
-  # it's far easier if the content is 'flat', we don't have to worry about
-  # pre-existing indent levels.  So lets lex that.
   begin
-    lex = Ripper.lex(flatten_content(content))
+    lex = Ripper.lex(content)
   rescue
     exit 255
   end
 
-  # quick way to get our total lines.
-  total_lines = lex.last[0][0]
-  line_index = 1
-
   indent_level = 0
+  line_lex = []
 
-  # walk through our lines.
-  while (line_index <= total_lines)
-    # a 'lex' copy of our line.
-    line_lex = lex.select {|l| l[0][0] == line_index}
-    # a string version.
-    line_string = line_lex.map {|l| l.last}.join("")
+  # walk through line tokens
+  lex.each do |token|
+    line_lex << token
+    if @new_lines.include? token[1] # if type of this token is a new line
 
-    # did we just close something?  if so, lets bring it down a level.
-    if closing_block?(line_lex) || closing_assignment?(line_lex)
-      indent_level -=1 if indent_level > 0
-    end
+      # did we just close something?  if so, lets bring it down a level.
+      if closing_block?(line_lex) || closing_assignment?(line_lex)
+        indent_level -= 1 if indent_level > 0
+      end
 
-    # print our line, in place.
-    puts_indented_line(indent_level, line_string)
+      # print our line, in place.
+      line_string = line_lex.map {|l| l.last}.join
+      puts_indented_line(indent_level, line_string)
 
-    # oh, we opened something did we?  lets indent for the next run.
-    if opening_block?(line_lex) || opening_assignment?(line_lex)
-      indent_level +=1
-    end
+      # oh, we opened something did we?  lets indent for the next run.
+      if opening_block?(line_lex) || opening_assignment?(line_lex)
+        indent_level += 1
+      end
 
-    line_index += 1
+      line_lex.clear
+    end
   end
 
   return nil
@@ -99,12 +81,22 @@ end
 
 # is the first word a key word?
 def starts_block?(line_lex)
-  line_lex.first[1] == :on_kw && @open_block_start.include?(line_lex.first[2])
+  line_lex.each do |x|
+    # search for a first non-space token
+    if not x[1] == :on_sp
+      return x[1] == :on_kw && @open_block_start.include?(x[2])
+    end
+  end
 end
 
 # is the first word one of our 'both' keywords?
 def both_block?(line_lex)
-  return line_lex.first[1] == :on_kw && @both_block.include?(line_lex.first[2])
+  line_lex.each do |x|
+    # search for a first non-space token
+    if not x[1] == :on_sp
+      return x[1] == :on_kw && @both_block.include?(x[2])
+    end
+  end
 end
 
 # kinda complex, we count open/close to determine if we ultimately have a

data/lib/ruby-beautify/version.rb

@@ -1,3 +1,3 @@
 module RBeautify
-  VERSION = "0.94.0"
+  VERSION = "0.94.1"
 end

data/spec/bin/ruby-beautify_spec.rb

@@ -11,7 +11,7 @@ require 'digest/md5'
 
 describe "Ruby Beautify" do
   before (:all) do
-  	@good_md5_sum = 'bd409d320cfe6fd0e2bf405e47cd2f2c'
+    @good_md5_sum = Digest::MD5.hexdigest File.read('spec/example_beautified.rb')
   	@bad_file =  'spec/example.rb'
   	@bin = "#{Dir.pwd}/bin/ruby-beautify"
   end

data/spec/example.rb

@@ -68,3 +68,27 @@ puts 'never!'
 else
 puts 'not likely.'
 end
+
+# Test for already indented blocks
+    class There2 < There
+    def m1()
+      puts "m1"
+    end
+def m2()
+          puts "m2"
+  end
+        def m3()
+puts "m3"
+        end
+    end
+
+# Test for multiline string
+def m (x)
+puts "This is multi-line string. It's line1 \
+ It's line 2\
+              And this is\n line3
+     This line should not be mutated"
+puts "This is multi line interpolated string #{
+x
+}"
+end

data/spec/example_beautified.rb

@@ -0,0 +1,94 @@
+require 'ripper'
+
+module Here
+	class There
+		def why?(argument = nil)
+			@array = [
+				1,
+				2,
+				3
+			]
+			hash = {
+				one:1,
+				two:2,
+				three:3
+			}
+		end
+
+		# a comment
+		def why_not?(argument: {})
+			@array = [4,5,6]
+			hash = {four:4, five:5, six:6}
+			s = "a #{"complex"} string."
+		end
+
+		def complex_method(one, two, three, four)
+			regex = /regex/
+		end
+
+		def with_block
+			run = Proc.new { |argument| puts arugment }
+			run do |arugment|
+				puts argument
+			end
+		end
+	end
+end
+
+h = Here::There.new
+
+h.why?({
+	here: 'there',
+	there: 'here'
+})
+
+h.with_block {
+	puts 'yahooie'
+}
+
+
+h.complex_method('asdkjasflkjdglksjglksfgjlfkgjdf',
+	'alfkjsdlkfjsflgkjfglk',
+	'alfkjsdlkfjsflgkjfglk',
+	'alfkjsdlkfjsflgkjfglk'
+)
+
+h.complex_method('asdkjasflkjdglksjglksfgjlfkgjdf',
+	'alfkjsdlkfjsflgkjfglk',
+	'alfkjsdlkfjsflgkjfglk',
+	'alfkjsdlkfjsflgkjfglk'
+).map do |i|
+	i
+end.map! { |i| i }
+
+if 1 > 0
+	puts 'something'
+elsif 1 < 0
+	puts 'never!'
+else
+	puts 'not likely.'
+end
+
+# Test for already indented blocks
+class There2 < There
+	def m1()
+		puts "m1"
+	end
+	def m2()
+		puts "m2"
+	end
+	def m3()
+		puts "m3"
+	end
+end
+
+# Test for multiline string
+def m (x)
+	puts "This is multi-line string. It's line1 \
+ It's line 2\
+              And this is\n line3
+     This line should not be mutated"
+	puts "This is multi line interpolated string #{
+		x
+	}"
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ruby-beautify
 version: !ruby/object:Gem::Version
-  version: 0.94.0
+  version: 0.94.1
 platform: ruby
 authors:
 - Ernie Brodeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: a cli tool (and module) to beautify ruby code.
@@ -60,9 +60,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -76,6 +76,7 @@ files:
 - ruby-beautify.gemspec
 - spec/bin/ruby-beautify_spec.rb
 - spec/example.rb
+- spec/example_beautified.rb
 - spec/spec_helper.rb
 homepage: https://github.com/erniebrodeur/ruby-beautify
 licenses: []
@@ -86,21 +87,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: a cli tool (and module) to beautify ruby code.
 test_files:
 - spec/bin/ruby-beautify_spec.rb
 - spec/example.rb
+- spec/example_beautified.rb
 - spec/spec_helper.rb