ruby-beautify 0.93.2 → 0.94.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55536d953a284d9c806cc5bf574a58b47c9dfa0c
-  data.tar.gz: 9f1a5fc6b9521790f1de0bfa73bfcc2689a30cc0
+  metadata.gz: 894e285bf45a3569ff950d814687a9df9fd9ac1f
+  data.tar.gz: 913f62f88fd4e65783adcc71f2193fc3ee65bf1d
 SHA512:
-  metadata.gz: 35a6084fb1a1d779fb7df49cfc476da0bb71561258a9f69aba81c7e4de3f3758dfb62fe0a1bb51ae8ea5bd0f4b75409731bdd0f2f58c620d26c40986424aea4c
-  data.tar.gz: 1e547ca038a2c4552e1cf52f1b802e23b0c8e1a9709f1402792607a9950f514ebfa409d5ffbb99ead1e179c9c7f8396c13fbb641a90561370db5778e1fed5f11
+  metadata.gz: 0769f3ed536d176898707c9fdbd2f46c26ec8a84c84be60f81e01a90b72a78324f4aa81f257e90ba3300eebc5b355ffbf130311983d6c5aff74aea7c993e6871
+  data.tar.gz: f5ee63bf346accda19c6a5337003e0775c3c06d583099b797ef38e57d24901d5f1ba194b7c756176d71b726152b352ecc9a591b4e251160964c7fa94b9ca7ba6

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+branches:
+  only:
+    - master
+    - dev
+script: bundle exec rspec spec

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ruby-beautify.gemspec
 gemspec
+
+group :development do
+  gem 'guard', require:false
+  gem 'guard-rspec', require:false
+  gem 'guard-bundler', require:false
+  gem 'pry', require:false
+  gem "codeclimate-test-reporter", group: :test, require: nil
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,66 +1,70 @@
-# RBeautify
+# 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)
+
 [![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)
 
-This gem provides a cli binary named 'rbeautify' that will pretty up ruby code.
+This gem provides a cli binary named 'ruby-beautify' that will pretty up ruby code.
 
+Currenty, 'rbeautify' is included for backwards compatibility but will likely be phased out at some point.
 
 ## Installation
 
-    % gem install ruby-beautify
+  % gem install ruby-beautify
 
 ## Usage
 
 To Pretty up a file:
 
-    % rbeautify filename
+  % ruby-beautify 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' | ruby-beautify
 
 It has help:
 
-    % rbeautify --help
+  % ruby-beautify --help
 
 You can pick your indent character:
 
-    % rbeautify --(t)abs
+  % ruby-beautify --(t)abs
 
-    % rbeautify --(s)paces
+  % ruby-beautify --(s)paces
 
 You can also pick the count of characters:
 
-    % rbeautify --indent_(c)ount 1
+  % ruby-beautify --indent_(c)ount 1
 
 Examples:
 
-    % rbeautify -c 2 -s filename
+  % ruby-beautify -c 2 -s filename
 
-    % rbeautify filename
+  % ruby-beautify filename
 
-    % rbeautify -t -c 2 filename
+  % ruby-beautify -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.
+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. 
+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.
+* 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
 
-  * fork it.
-  * create it.
-  * push it.
-  * pull it.
+* fork it.
+* create it.
+* push it.
+* pull it.
 
 # History
 

data/{RELEASE.md → WHATSNEW.md}

@@ -1,18 +1,23 @@
-# Release Notes
-#### 0.93.1
+## 0.94.0
+* Added a very basic spec.
+* Added better support for piping and redirection (thanks @veelenga)
+* Renamed the bin to ruby-beautify and added a link for backwards compat.
+* Fixed extra spaces on blank lines (thanks @veelenga)
+
+## 0.93.2
 * Fixed a typo in the help usage (thanks @ronald)
 
-#### 0.93.0
+## 0.93.0
 * Complete rewrite of the lexing engine.
 
-#### 0.92.0
+## 0.92.0
 * Renamed a require in rspec so they would work again.
 * Dropped filemagic since this already has excellent file parsing and is platform agnostic.
 * Dropped the rest of app.rb, since it wasn't adding anything but line count at this point.
 * Added a RELEASE.md to track changes as I go.
 * Dropped the unneeded yajl and sys-proctree deps since it doesn't use them.
 
-#### 0.91.0
+## 0.91.0
 * Stripped out the few bits of my cli stuff that I used and dropped app.rb, cli.rb and filemagic.rb, since all the functionality was present elsewhere.
 * Fixed up the gem related files, generating a proper gemspec, fixed the deps.
 * Fixed up the README.md to give a few usage examples and brief explanation.

data/bin/rbeautify

@@ -38,8 +38,12 @@ def flatten_content(content)
 end
 
 def puts_indented_line(level, string)
-  indent = (@indent_token * @indent_count) * level
-  puts indent + string
+  if string.empty? or string =~ /^\n$/
+    puts
+  else
+    indent = (@indent_token * @indent_count) * level
+    puts indent + string
+  end
 end
 
 def pretty(content)
@@ -162,7 +166,7 @@ end
 
 # no argument, assume we want to open STDIN.
 if ARGV.empty?
-  content = gets
+  content = $stdin.read
   puts pretty content
 else
   file = ARGV[0]

data/bin/ruby-beautify

@@ -0,0 +1,184 @@
+#!/usr/bin/env ruby
+require 'ruby-beautify'
+require 'ripper'
+require 'optparse'
+
+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 spaces for the indent character") { @indent_token = " " }
+  opts.banner = "Usage: print ruby into a pretty format, or break trying."
+end
+Options.parse!
+
+@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)
+  if string.empty? or string =~ /^\n$/
+    puts
+  else
+    indent = (@indent_token * @indent_count) * level
+    puts indent + string
+  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))
+  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 = $stdin.read
+  puts pretty content
+else
+  file = ARGV[0]
+  if File.exist? file
+    if valid_syntax? file
+      content = open(file).read
+      pretty content
+    else
+      puts content
+      exit 127
+    end
+  else
+    puts "No such file: #{file}"
+  end
+end

data/lib/ruby-beautify/version.rb

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

data/ruby-beautify.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |gem|
   gem.email       = 'ebrodeur@ujami.net'
   gem.homepage    = "https://github.com/erniebrodeur/ruby-beautify"
 
-  gem.add_development_dependency "rspec"
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
@@ -16,4 +15,5 @@ Gem::Specification.new do |gem|
   gem.version       = RBeautify::VERSION
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rspec'
 end

data/spec/bin/ruby-beautify_spec.rb

@@ -0,0 +1,22 @@
+# one big spec (for now).
+require 'spec_helper.rb'
+require 'digest/md5'
+
+# this is so simple, it's stupid.  I basically used the 'example.rb' file while
+# testing this indenting method.  So I've visually approved of the output, and
+# I've run that through md5.   Then we just run our build, gather that md5 and
+# compare the two.
+# Eventually, I should break out the code into smaller chunks so I can identify
+# which component is breaking down.
+
+describe "Ruby Beautify" do
+  before (:all) do
+  	@good_md5_sum = 'bd409d320cfe6fd0e2bf405e47cd2f2c'
+  	@bad_file =  'spec/example.rb'
+  	@bin = "#{Dir.pwd}/bin/ruby-beautify"
+  end
+  it 'will work' do
+		md5_sum = Digest::MD5.hexdigest `bundle exec #{@bin} #{@bad_file}`
+    expect(md5_sum).to eq @good_md5_sum
+  end
+end

data/spec/example.rb

@@ -0,0 +1,70 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start

metadata

@@ -1,74 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: ruby-beautify
 version: !ruby/object:Gem::Version
-  version: 0.93.2
+  version: 0.94.0
 platform: ruby
 authors:
 - Ernie Brodeur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-19 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  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: rake
+  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: bundler
+  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.
 email: ebrodeur@ujami.net
 executables:
 - rbeautify
+- ruby-beautify
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
-- RELEASE.md
 - Rakefile
+- WHATSNEW.md
 - bin/rbeautify
+- bin/ruby-beautify
 - lib/ruby-beautify.rb
 - lib/ruby-beautify/version.rb
 - ruby-beautify.gemspec
+- spec/bin/ruby-beautify_spec.rb
+- spec/example.rb
+- spec/spec_helper.rb
 homepage: https://github.com/erniebrodeur/ruby-beautify
 licenses: []
 metadata: {}
@@ -78,18 +86,21 @@ 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.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: a cli tool (and module) to beautify ruby code.
-test_files: []
+test_files:
+- spec/bin/ruby-beautify_spec.rb
+- spec/example.rb
+- spec/spec_helper.rb