ruby-beautify 0.96.0 → 0.97.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13168e4681dafb98dab93fbde6ed6df28bf935fe
-  data.tar.gz: 905e6c45a87f5a0c64d6d959fb01095e35196386
+  metadata.gz: 45c73195863804f127d9481a07ec33676821e4d1
+  data.tar.gz: c1eaef1e3e7b2736d6f9a6272cd428636d0ef28a
 SHA512:
-  metadata.gz: 5d8c76c28509bf4da9c6e3078039a707a3f4a5c9acba859ac877bb604877dbaeb73292fed65dfc83f89e0d51168570d20d65458e8c03f5a66e91730d2020a91e
-  data.tar.gz: 01ff2b88dcd164966f9d3778653e009a8a08cdc51f6f51612efbdea6be7bf763c0171f1c70212d9a8d97620d7c06e25e79e3096e5e7e4fdda92485525f12920a
+  metadata.gz: 9370b94027a54f3b6911f818e8847b0c49c957cadfe2b6c73b049f493a24ab90dd1de91a61f48da952acc1001216fbcf8aa2721ef467c6478dfea8273d7713c7
+  data.tar.gz: 98f2d051bebff05ae8dce225ce5e44f3a2cef4dacf89dab2327ae094bae6cea7417062e0a476e91eb3d707a845a5aa527dc9e9d555251ce9e21c29045015bb4d

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 pkg/*
+tmp/*

data/.travis.yml

@@ -7,3 +7,6 @@ branches:
     - master
     - dev
 script: bundle exec rspec spec
+addons:
+  code_climate:
+    repo_token: 596a4a033e7deae1bfd5e84da4c803ef81134158764a48b02279fe97eb83fcf4

data/CONTRIB.md

@@ -6,7 +6,14 @@ How to contribute to this project.
 * Pull requests should be named something related to PR, `hotfix-XXX` or `feature-YYY`.
 * Do not edit the `version.rb` or the `gemspec`.
 * All pull requests have to pass tests on `travis-ci` before I'll consider merging them.
+* for tests of the actual parser, make sure you include a new `usage_scenario`, not update an existing one.  I'll merge stuff as it gets cluttered.
 
 ## Formatting and style
 
 Run all your code through `ruby-beautify` with default settings before committing.
+
+This should work (and if it doesn't, please let me know)
+
+`ruby-beautify --overwrite lib/**/*.rb  bin/ruby-beautify spec/**/*_spec.rb spec/**/*_helper.rb`
+
+Which should pretty up only the code files, and not our test files.  This will help insure pretty commits and that they will be accepted.

data/README.md

@@ -1,6 +1,7 @@
 # Ruby Beautify
 **Master** [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/erniebrodeur/ruby-beautify) [![Build Status](https://travis-ci.org/erniebrodeur/ruby-beautify.png?branch=master)](https://travis-ci.org/erniebrodeur/ruby-beautify) [![Dependency Status](https://gemnasium.com/erniebrodeur/ruby-beautify.png)](https://gemnasium.com/erniebrodeur/ruby-beautify)
-**Development** [![Build Status](https://travis-ci.org/erniebrodeur/ruby-beautify.png?branch=development)](https://travis-ci.org/erniebrodeur/ruby-beautify)
+
+**Development** [![Build Status](https://travis-ci.org/erniebrodeur/ruby-beautify.png?branch=dev)](https://travis-ci.org/erniebrodeur/ruby-beautify)
 
 [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/erniebrodeur/ruby-beautify?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
@@ -10,64 +11,62 @@ Currenty, 'rbeautify' is included for backwards compatibility but will likely be
 
 ## Installation
 
-  % gem install ruby-beautify
+  `gem install ruby-beautify`
 
 ## Usage
 
 To Pretty up a file:
 
-  % ruby-beautify filename
+  `ruby-beautify filename`
 
 Without a filename it reads from STDIN, suitable for piping:
 
-  % curl 'http://example.org/ugly-file.rb' | ruby-beautify
+  `curl https://raw.githubusercontent.com/erniebrodeur/ruby-beautify/master/spec/monolithic_example.rb | ruby-beautify`
 
 It has help:
 
-  % ruby-beautify --help
+  `ruby-beautify --help`
 
 You can pick your indent character:
 
-  % ruby-beautify --(t)abs
+  `ruby-beautify --(t)abs`
 
-  % ruby-beautify --(s)paces
+  `ruby-beautify --(s)paces`
 
 You can also pick the count of characters:
 
-  % ruby-beautify --indent_(c)ount 1
+  `ruby-beautify --indent_(c)ount 1`
 
 Examples:
 
-  % ruby-beautify -c 2 -s filename
+  `ruby-beautify -c 2 -s filename`
 
-  % ruby-beautify filename
+  `ruby-beautify filename`
 
-  % ruby-beautify -t -c 2 filename
+  `ruby-beautify -t -c 2 filename`
 
-## Bugs
+## Advanced Usage
+
+You can over write files in place, this is useful for doing an entire directory of files at once.  This will not over write any files that fail syntax check.
 
-I don't have every ruby style tested against, so I expect some gaps.  Feel free to submit issues (please include an example) and I'll figure out how to 'beautify' it.
+  `ruby-beautify --overwrite **/*.rb`
+
+## Bugs
 
 Please feel free to open issues, I am actively working on this project again, thanks entirely to the ripper gem.
 
+The gaps are getting smaller.  I think we have most of the basic ruby use cases in place.  I don't use rails/dsl's too often so I haven't tested those.  I suspect it should 'just work' since the way we do syntax matching is really agnostic to what a DSL can change.
+
 ## Todo
 
 * Add vim style comment hinting.
-* Add overwrite in place to files.
-* Add 'best guest' for files that fail syntax checking.
-* Add syntax checking to files rendered via STDIN.
-* Seperate the content of the main bin into a proper namespace/library (so it doesn't pollute by default).
-* Split up the spec into multiple specs.
 * remove the link to rbeautify (by 1.0).
 
 Longer term I'd like to do some more to assignment, line wrapping, and spacing in/around keywords.
 
 ## Contributing
 
-* fork it.
-* create it.
-* push it.
-* pull it.
+Please see the [Contribution Guide](CONTRIB.md) file for specifics on how to contribute to this project.
 
 # History
 

data/WHATSNEW.md

@@ -1,3 +1,10 @@
+## 0.97.0
+* Split up the spec into usage scenarios, easier to contribut too.
+* Lots of refactoring.
+* Some documentation.
+* Added multiple file support back so that overwrite files is more interesting.
+* Added an overwrite files flag, useful for fixing up a directory of files at once.
+
 ## 0.96.0
 * Rewrote the syntax checker so that it pipes a string through stdout, doesn't need a temp file.
 * Moved everything into the module to clean up the bin.

data/bin/rbeautify

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-require 'ruby-beautify'
-require 'ripper'
 require 'optparse'
+require 'ruby-beautify'
 
 include RubyBeautify
 
@@ -10,6 +9,7 @@ Options = OptionParser.new do |opts|
 	opts.on("-c", "--indent_count [COUNT]", Integer, "Count of characters to use for indenting. (default: 1)") { |count| @indent_count = count}
 	opts.on("-t", "--tabs", "Use tabs for the indent character (default)") { @indent_token = "\t" }
 	opts.on("-s", "--spaces", "Use spaces for the indent character") { @indent_token = " " }
+	opts.on("--overwrite", "Overwrite files as you go (won't touch files that faile a syntax check).") { @overwrite = true }
 	opts.banner = "Usage: print ruby into a pretty format, or break trying."
 end
 Options.parse!
@@ -17,25 +17,44 @@ Options.parse!
 @indent_token = "\t" unless @indent_token
 @indent_count = 1 unless @indent_count
 
+def print_or_die(content)
+	if content
+		if syntax_ok? content
+			puts pretty_string content, indent_token: @indent_token, indent_count: @indent_count
+		else
+			puts content
+			exit 127
+		end
+	end
+end
+
 # no argument, assume we want to open STDIN.
 if ARGV.empty?
 	content = $stdin.read
+	print_or_die content
 else
-	file = ARGV[0]
-
-	if File.exist? file
-		content = open(file).read
-	else
-		puts "No such file: #{file}"
-		exit
-	end
-end
+	ARGV.each do |file|
+		if File.exist? file
+			fh = open(file)
+			content = fh.read
+			fh.sync
+			fh.close
+		else
+			puts "No such file: #{file}"
+			exit
+		end
 
-if content
-	if syntax_ok? content
-		pretty_string content, indent_token: @indent_token, indent_count: @indent_count
-	else
-		puts content
-		exit 127
+		if @overwrite
+			if syntax_ok? content
+				fh = open(file, 'w')
+				fh.write pretty_string content
+				fh.sync
+				fh.close
+			else
+				next
+			end
+		else
+			print_or_die content
+		end
 	end
 end

data/bin/ruby-beautify

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-require 'ruby-beautify'
-require 'ripper'
 require 'optparse'
+require 'ruby-beautify'
 
 include RubyBeautify
 
@@ -10,6 +9,7 @@ Options = OptionParser.new do |opts|
 	opts.on("-c", "--indent_count [COUNT]", Integer, "Count of characters to use for indenting. (default: 1)") { |count| @indent_count = count}
 	opts.on("-t", "--tabs", "Use tabs for the indent character (default)") { @indent_token = "\t" }
 	opts.on("-s", "--spaces", "Use spaces for the indent character") { @indent_token = " " }
+	opts.on("--overwrite", "Overwrite files as you go (won't touch files that faile a syntax check).") { @overwrite = true }
 	opts.banner = "Usage: print ruby into a pretty format, or break trying."
 end
 Options.parse!
@@ -17,25 +17,44 @@ Options.parse!
 @indent_token = "\t" unless @indent_token
 @indent_count = 1 unless @indent_count
 
+def print_or_die(content)
+	if content
+		if syntax_ok? content
+			puts pretty_string content, indent_token: @indent_token, indent_count: @indent_count
+		else
+			puts content
+			exit 127
+		end
+	end
+end
+
 # no argument, assume we want to open STDIN.
 if ARGV.empty?
 	content = $stdin.read
+	print_or_die content
 else
-	file = ARGV[0]
-
-	if File.exist? file
-		content = open(file).read
-	else
-		puts "No such file: #{file}"
-		exit
-	end
-end
+	ARGV.each do |file|
+		if File.exist? file
+			fh = open(file)
+			content = fh.read
+			fh.sync
+			fh.close
+		else
+			puts "No such file: #{file}"
+			exit
+		end
 
-if content
-	if syntax_ok? content
-		pretty_string content, indent_token: @indent_token, indent_count: @indent_count
-	else
-		puts content
-		exit 127
+		if @overwrite
+			if syntax_ok? content
+				fh = open(file, 'w')
+				fh.write pretty_string content
+				fh.sync
+				fh.close
+			else
+				next
+			end
+		else
+			print_or_die content
+		end
 	end
 end

data/lib/ruby-beautify.rb

@@ -1,157 +1,159 @@
 require 'open3'
+require 'ripper'
 require 'ruby-beautify/version'
 
 module RubyBeautify
 	extend self
 
-  OPEN_BLOCK_START = ["module", "class", "begin", "def", 'if', 'while', 'unless', 'case']
-  BOTH_BLOCK = ["else", "elsif", 'rescue', 'when']
-  OPEN_BLOCK_DO  = ['do', '{']
-  CLOSE_BLOCK = ['end', '}']
-
-  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]
-
-  # print an indented line. Requires the leve, token, count, and string.
-  def puts_indented_line(level, token = "\t", count = 1, string)
-    if string =~ /^\n$/
-      puts
-    else
-      indent = (token * count) * level
-      puts "#{indent}#{string.lstrip}"
-    end
-  end
-
-  def pretty_string(content, indent_token: "\t", indent_count: 1)
-    begin
-      lex = Ripper.lex(content)
-    rescue
-      exit 255
-    end
-
-    indent_level = 0
-    line_lex = []
-
-    # 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
-
-        # print our line, in place.
-        line_string = line_lex.map {|l| l.last}.join
-        puts_indented_line(indent_level, indent_token, indent_count, 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
-
-        line_lex.clear
-      end
-    end
-
-    return nil
-  end
-
-  # how many times do we open in this line?
-  def opening_block_count(line_lex)
-    line_lex.select {|l| l[1] == :on_kw && OPEN_BLOCK_DO.include?(l[2])}.count
-  end
-
-  # how many times do we close?
-  def closing_block_count(line_lex)
-    line_lex.select {|l| l[1] == :on_kw && CLOSE_BLOCK.include?(l[2])}.count
-  end
-
-  # count the amount of opening assignments.
-  def opening_assignment_count(line_lex)
-    line_lex.select {|l| OPEN_BRACKETS.include? l[1]}.count
-  end
-
-  # count the amount of closing assignments.
-  def closing_assignment_count(line_lex)
-    line_lex.select {|l| CLOSE_BRACKETS.include? l[1]}.count
-  end
-
-  # check the syntax of a string, will pipe it through the ruby bin to see if
-  # it has a valid syntax.
+	OPEN_BLOCK_START = ["module", "class", "begin", "def", 'if', 'while', 'unless', 'case']
+	BOTH_BLOCK = ["else", "elsif", 'rescue', 'when']
+	OPEN_BLOCK_DO  = ['do', '{']
+	CLOSE_BLOCK = ['end', '}']
+
+	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]
+
+
+	def pretty_string(content, indent_token: "\t", indent_count: 1)
+		output_string = ""
+		raise "Bad Syntax" unless syntax_ok? content
+		lex = ::Ripper.lex(content)
+
+		indent_level = 0
+		line_lex = []
+
+		# 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
+
+				# print our line, in place.
+				line_string = line_lex.map {|l| l.last}.join
+				output_string += indented_line(indent_level, indent_token, indent_count, 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
+
+				line_lex.clear
+			end
+		end
+
+		return output_string
+	end
+
+	# check the syntax of a string, will pipe it through the ruby bin to see if
+	# it has a valid syntax.
 	def syntax_ok?(string)
 		out, err, status = Open3.capture3("ruby -c -", stdin_data:string )
 		return false unless err.empty?
 		return true
 	end
 
-  # same trick as opening_block
-  def opening_assignment?(line_lex)
-    opens = opening_assignment_count line_lex
-    closes = closing_assignment_count line_lex
-    return false if opens == closes
-    return true if opens > closes
-  end
-
-  # ...
-  def closing_assignment?(line_lex)
-    opens = opening_assignment_count line_lex
-    closes = closing_assignment_count line_lex
-    return false if opens == closes
-    return true if closes > opens
-  end
-
-  # test for assignment from a block
-  def contains_block_assignment?(line_lex)
-    compacted_line = line_lex.reject{|x| x[1] == :on_sp} #remove spaces
-    idx = compacted_line.rindex{|x| ['=', '||='].include? x[2]} #find last equal
-    if idx
-      return OPEN_BLOCK_START.include?(compacted_line[idx+1][2]) #check for if/begin block
-    end
-    return false
-  end
-
-  # is the first word a key word?
-  def starts_block?(line_lex)
-    return true if contains_block_assignment? line_lex
-    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)
-    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
-  # hanging line.   Always true if it's a both_block.
-  def opening_block?(line_lex)
-    opens = (starts_block?(line_lex) || both_block?(line_lex)) ? 1 : 0
-    opens += opening_block_count line_lex
-    closes = closing_block_count line_lex
-    return false if opens == closes
-    return true if opens > closes
-  end
-
-  # kinda complex, we count open/close to determine if we ultimately have close a
-  # hanging line.   Always true if it's a both_block.
-  def closing_block?(line_lex)
-    return true if both_block? line_lex
-    opens = starts_block?(line_lex) ? 1 : 0
-    opens += opening_block_count line_lex
-    closes = closing_block_count line_lex
-    return false if opens == closes
-    return true if opens < closes
-  end
+	# same trick as opening_block
+	def opening_assignment?(line_lex)
+		opens = opening_assignment_count line_lex
+		closes = closing_assignment_count line_lex
+		return false if opens == closes
+		return true if opens > closes
+	end
+
+	# ...
+	def closing_assignment?(line_lex)
+		opens = opening_assignment_count line_lex
+		closes = closing_assignment_count line_lex
+		return false if opens == closes
+		return true if closes > opens
+	end
+
+	# test for assignment from a block
+	def contains_block_assignment?(line_lex)
+		compacted_line = line_lex.reject{|x| x[1] == :on_sp} #remove spaces
+		idx = compacted_line.rindex{|x| ['=', '||='].include? x[2]} #find last equal
+		if idx
+			return OPEN_BLOCK_START.include?(compacted_line[idx+1][2]) #check for if/begin block
+		end
+		return false
+	end
+
+	# is the first word a key word?
+	def starts_block?(line_lex)
+		return true if contains_block_assignment? line_lex
+		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)
+		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
+	# hanging line.   Always true if it's a both_block.
+	def opening_block?(line_lex)
+		opens = (starts_block?(line_lex) || both_block?(line_lex)) ? 1 : 0
+		opens += opening_block_count line_lex
+		closes = closing_block_count line_lex
+		return false if opens == closes
+		return true if opens > closes
+	end
+
+	# kinda complex, we count open/close to determine if we ultimately have close a
+	# hanging line.   Always true if it's a both_block.
+	def closing_block?(line_lex)
+		return true if both_block? line_lex
+		opens = starts_block?(line_lex) ? 1 : 0
+		opens += opening_block_count line_lex
+		closes = closing_block_count line_lex
+		return false if opens == closes
+		return true if opens < closes
+	end
+
+	private
+	# how many times do we open in this line?
+	def opening_block_count(line_lex)
+		line_lex.select {|l| l[1] == :on_kw && OPEN_BLOCK_DO.include?(l[2])}.count
+	end
+
+	# how many times do we close?
+	def closing_block_count(line_lex)
+		line_lex.select {|l| l[1] == :on_kw && CLOSE_BLOCK.include?(l[2])}.count
+	end
+
+	# count the amount of opening assignments.
+	def opening_assignment_count(line_lex)
+		line_lex.select {|l| OPEN_BRACKETS.include? l[1]}.count
+	end
+
+	# count the amount of closing assignments.
+	def closing_assignment_count(line_lex)
+		line_lex.select {|l| CLOSE_BRACKETS.include? l[1]}.count
+	end
+
+	# print an indented line. Requires the leve, token, count, and string.
+	def indented_line(level, token = "\t", count = 1, string)
+		output_string = ""
+		if string =~ /^\n$/
+			output_string += "\n"
+		else
+			indent = (token * count) * level
+			output_string += "#{indent}#{string.lstrip}"
+		end
+	end
 end