ruby-beautify 0.92.2 → 0.93.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 771591fa2eb43b8a8244394dff9afc39082923bc
+  data.tar.gz: 276d9e48285d905dabec7943f926432c23f573d7
+SHA512:
+  metadata.gz: a29b4dcd745558242d2e14eb22989c02e5731c95aeb28e857a3aaa64fdcc2fca80e94bcfbcfedacc993fd90104c85bc2b19a0151782ef1849c663da104e38db7
+  data.tar.gz: 89cdc67493a723ab777bba6306e07750531b7c8e199461a929ff3ef15135d269dea40789b8725b7d94b9d00b2b9894ecd43ac31a6676dc7c07505eed2e9278ac

data/.gitignore

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

data/README.md

@@ -2,38 +2,69 @@
 
 This gem provides a cli binary named 'rbeautify' that will pretty up ruby code.
 
+
 ## Installation
 
-    $ gem install ruby-beautify
+    % gem install ruby-beautify
 
 ## Usage
 
 To Pretty up a file:
 
-		$ rbeautify filename
-
-It can take mulitple filenames:
-
-		$ rbeautify a b c
+    % rbeautify filename
 
 Without a filename it reads from STDIN, suitable for piping:
 
-		$ curl 'http://example.org/ugly-file.rb' | rbeautify
+    % curl 'http://example.org/ugly-file.rb' | rbeautify
 
 It has help:
 
-		$ rbeautify -h
+    % rbeautify --help
+
+You can pick your indent character:
+
+    % rbeautify --(t)abs
+
+    % rbeautify --(s)paces
+
+You can also pick the count of characters:
+
+    % rbeautify --indent_(c)ount 1
+
+Examples:
+
+    % rbeautify -c 2 -s filename
+
+    % rbeautify filename
+
+    % rbeautify -t -c 2 filename
+
+## Bugs
+
+  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.
+
+Please feel free to open issues, I am actively working on this project again, thanks entirely to the ripper gem. 
+
+## 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.
+
+Longer term I'd like to do some more to assignment, line wrapping, and spacing in/around keywords.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+  * fork it.
+  * create it.
+  * push it.
+  * pull it.
 
 # History
 
 The original analyzer is available at: http://www.arachnoid.com/ruby/rubyBeautifier.html.
 
 My work is based off of this sublime-text2 plugin: https://github.com/CraigWilliams/BeautifyRuby but cleaned up and made suitable for use directly in a shell.
+
+I've recently re-written this to use the stdlib `ripper` gem to do the lexical analyzing.  Consequently I've dropped all of the old legacy code that did this.

data/bin/rbeautify

@@ -1,28 +1,180 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 require 'ruby-beautify'
+require 'ripper'
 require 'optparse'
 
-include RBeautify
-
 Options = OptionParser.new do |opts|
   opts.on("-V", "--version", "Print version") { |version| puts RBeautify::VERSION;exit 0}
+  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 tabs for the indent character") { @indent_token = " " }
   opts.banner = "Usage: print ruby into a pretty format, or break trying."
 end
 Options.parse!
 
-if ARGV.empty?
+@open_block_start = ["module", "class", "begin", "def", 'if', 'while', 'unless']
+@both_block = ["else", "elsif", 'rescue']
+@open_block_do  = ['do', '{']
+@close_block = ['end', '}']
+
+@open_brackets  = [:on_lparen, :on_lbracket, :on_lbrace]
+@close_brackets = [:on_rparen, :on_rbracket, :on_rbrace]
+@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)
+  indent = (@indent_token * @indent_count) * level
+  puts indent + string
+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
-    puts RBeautify.beautify_string :ruby, STDIN
-  rescue Exception => e
-    puts e.message
-    exit
+    lex = Ripper.lex(flatten_content(content))
+  rescue
+    exit 255
   end
+
+  # quick way to get our total lines.
+  total_lines = lex.last[0][0]
+  line_index = 1
+
+  indent_level = 0
+
+  # 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("")
+
+    # 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)
+
+    # 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
+  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
+
+# 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])
+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])
+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)
+  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
+
+# 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
+
+# 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
+
+# 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
+
+# is this ruby file valid syntax?
+def valid_syntax?(file)
+  #ugly but fast, ruby returns stdout if it's ok, and stderr if not.
+  #if we get anything back, we were ok, else we were not.
+  r = `ruby -c #{file} 2> /dev/null`
+  return false if r == ""
+  return true
+end
+
+# no argument, assume we want to open STDIN.
+if ARGV.empty?
+  content = gets
+  puts pretty content
 else
-  ARGV.each do |f|
-    if File.exist? f
-      puts RBeautify.beautify_string :ruby, open(f).read
+  file = ARGV[0]
+  if File.exist? file
+    if valid_syntax? file
+      content = open(file).read
+      pretty content
     else
-      puts "No such file: #{f}"
+      puts content
+      exit 127
     end
+  else
+    puts "No such file: #{file}"
   end
 end

data/lib/ruby-beautify.rb

@@ -1,10 +1,4 @@
 require "ruby-beautify/version"
-require 'ruby-beautify/block_start'
-require 'ruby-beautify/block_end'
-require 'ruby-beautify/block_matcher'
-require 'ruby-beautify/language'
-require 'ruby-beautify/line'
-require 'ruby-beautify/config/ruby'
 
 module RBeautify
   def self.beautify_string(language, source, use_tabs=false)

data/lib/ruby-beautify/version.rb

@@ -1,3 +1,3 @@
 module RBeautify
-  VERSION = "0.92.2"
+  VERSION = "0.93.0"
 end

data/ruby-beautify.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |gem|
   gem.name        = 'ruby-beautify'
   gem.summary     = "a cli tool (and module) to beautify ruby code."
   gem.description = gem.summary
-  gem.authors     = ["Ernie Brodeur", "Craig Williams", "Joel Chippindale", "Paul Lutus"]
+  gem.authors     = ["Ernie Brodeur"]
   gem.email       = 'ebrodeur@ujami.net'
   gem.homepage    = "https://github.com/erniebrodeur/ruby-beautify"
 

metadata

@@ -1,33 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: ruby-beautify
 version: !ruby/object:Gem::Version
-  version: 0.92.2
-  prerelease: 
+  version: 0.93.0
 platform: ruby
 authors:
 - Ernie Brodeur
-- Craig Williams
-- Joel Chippindale
-- Paul Lutus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: a cli tool (and module) to beautify ruby code.
@@ -37,60 +31,37 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
 - RELEASE.md
 - Rakefile
 - bin/rbeautify
-- lib/beautifier.rb
 - lib/ruby-beautify.rb
-- lib/ruby-beautify/block_end.rb
-- lib/ruby-beautify/block_matcher.rb
-- lib/ruby-beautify/block_start.rb
-- lib/ruby-beautify/config/ruby.rb
-- lib/ruby-beautify/language.rb
-- lib/ruby-beautify/line.rb
 - lib/ruby-beautify/version.rb
 - ruby-beautify.gemspec
-- spec/fixtures/ruby.yml
-- spec/rbeautify/block_matcher_spec.rb
-- spec/rbeautify/block_start_spec.rb
-- spec/rbeautify/config/ruby_spec.rb
-- spec/rbeautify/line_spec.rb
-- spec/rbeautify_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/erniebrodeur/ruby-beautify
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a cli tool (and module) to beautify ruby code.
-test_files:
-- spec/fixtures/ruby.yml
-- spec/rbeautify/block_matcher_spec.rb
-- spec/rbeautify/block_start_spec.rb
-- spec/rbeautify/config/ruby_spec.rb
-- spec/rbeautify/line_spec.rb
-- spec/rbeautify_spec.rb
-- spec/spec_helper.rb
-has_rdoc: 
+test_files: []

data/lib/beautifier.rb

@@ -1,168 +0,0 @@
-#!/usr/bin/env ruby
-
-# Ruby beautifier, version 2.1, 09/11/2006
-# Copyright (c) 2006, P. Lutus
-# Released under the GPL
-
-# Changes
-# Craig Williams
-# 12/26/2011
-# Modified (very minor) to work with a Sublime Text 2 plugin
-
-# indent regexp tests
-
-@indentExp = [
-  /^module\b/,
-  /^if\b/,
-  /^\@{0,2}[\w\.]*[\s\t]*\=[\s\t]*if\b/,
-  /(=\s*|^)until\b/,
-  /(=\s*|^)for\b/,
-  /^unless\b/,
-  /^\@{0,2}[\w\.]*[\s\t]*\=[\s\t]*unless\b/,
-  /(=\s*|^)while\b/,
-  /(=\s*|^)begin\b/,
-  /(^| )case\b/,
-  /\bthen\b/,
-  /^class\b/,
-  /^rescue\b/,
-  /^def\b/,
-  /\bdo\b/,
-  /^else\b/,
-  /^elsif\b/,
-  /^ensure\b/,
-  /\bwhen\b/,
-  /\{[^\}]*$/,
-  /\[[^\]]*$/,
-  /\([^\)]*$/
-]
-
-# outdent regexp tests
-
-@outdentExp = [
-  /^rescue\b/,
-  /^ensure\b/,
-  /^elsif\b/,
-  /^end\b/,
-  /^else\b/,
-  /\bwhen\b/,
-  /^[^\{]*\}/,
-  /^[^\[]*\]/,
-  /^[^\(]*\)/
-]
-
-def makeTab(tab)
-  (tab < 0) ? "" : @tabStr * @tabSize * tab
-end
-
-def addLine(line,tab)
-  line.strip!
-  line = makeTab(tab)+line if line.length > 0
-  line + "\n"
-end
-
-def beautifyRuby(contents)
-  commentBlock = false
-  programEnd = false
-  multiLineArray = Array.new
-  multiLineStr = ""
-  tab = 0
-  source = contents
-  dest = ""
-  source.split("\n").each do |line|
-    if(!programEnd)
-      # detect program end mark
-      if(line =~ /^__END__$/)
-        programEnd = true
-      else
-        # combine continuing lines
-        if(!(line =~ /^\s*#/) && line =~ /[^\\]\\\s*$/)
-          multiLineArray.push line
-          multiLineStr += line.sub(/^(.*)\\\s*$/,"\\1")
-          next
-        end
-
-        # add final line
-        if(multiLineStr.length > 0)
-          multiLineArray.push line
-          multiLineStr += line.sub(/^(.*)\\\s*$/,"\\1")
-        end
-
-        tline = ((multiLineStr.length > 0)?multiLineStr:line).strip
-        if(tline =~ /^=begin/)
-          commentBlock = true
-        end
-      end
-    end
-    if(commentBlock || programEnd)
-      # add the line unchanged
-      dest += line + "\n"
-    else
-      commentLine = (tline =~ /^#/)
-      if(!commentLine)
-        # throw out sequences that will
-        # only sow confusion
-        while tline.gsub!(/'.*?'/,"")
-        end
-        while tline.gsub!(/".*?"/,"")
-        end
-        while tline.gsub!(/\`.*?\`/,"")
-        end
-        while tline.gsub!(/\{[^\{]*?\}/,"")
-        end
-        while tline.gsub!(/\([^\(]*?\)/,"")
-        end
-        while tline.gsub!(/\/.*?\//,"")
-        end
-        while tline.gsub!(/%r(.).*?\1/,"")
-        end
-        tline.gsub!(/\\\"/,"'")
-        @outdentExp.each do |re|
-          if(tline =~ re)
-            tab -= 1
-            break
-          end
-        end
-      end
-      if (multiLineArray.length > 0)
-        multiLineArray.each do |ml|
-          dest += addLine(ml,tab)
-        end
-        multiLineArray.clear
-        multiLineStr = ""
-      else
-        dest += addLine(line,tab)
-      end
-      if(!commentLine)
-        @indentExp.each do |re|
-          if(tline =~ re && !(tline =~ /\s+end\s*$/))
-            tab += 1
-            break
-          end
-        end
-      end
-    end
-    if(tline =~ /^=end/)
-      commentBlock = false
-    end
-  end
-  STDOUT.write(dest)
-  # uncomment this to complain about mismatched blocks
-  # if(tab != 0)
-  #   STDERR.puts "#{path}: Indentation error: #{tab}"
-  # end
-end
-
-tab_or_space = ARGV.first
-path         = ARGV.last
-path.gsub!("\\", "/") if RUBY_PLATFORM =~ /mswin/
-contents     = IO.read(path)
-
-if tab_or_space == 'space'
-  @tabSize = 2
-  @tabStr = " "
-else
-  @tabSize = 1
-  @tabStr = "\t"
-end
-
-beautifyRuby(contents)