ruby-beautify 0.96.0 → 0.97.0

data/lib/ruby-beautify/version.rb

@@ -1,3 +1,3 @@
 module RubyBeautify
-  VERSION = "0.96.0"
+	VERSION = "0.97.0"
 end

data/spec/bin/ruby-beautify_spec.rb

@@ -1,22 +1,41 @@
-# 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 = Digest::MD5.hexdigest File.read('spec/example_beautified.rb')
-  	@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
+	# This acts as a config block for files and anything else that you may set.
+	before (:all) do
+		# a very quick to parse file, since this isn't to test the function of the parser (but the function of the binary).
+		@small_file = 'spec/binary_scenarios/small_example.rb'
+		# should be the contents of the small file twice.
+		@doubled_file = 'spec/binary_scenarios/doubled_example.rb'
+		# Our file to overwrite (should be ugly to start).
+		@overwrite_file = "spec/binary_scenarios/overwrite.rb"
+		@overwrite_target_file = "tmp/copied.rb"
+		@overwrite_pretty_file = "spec/binary_scenarios/overwrite_pretty.rb"
+	end
+
+	it "will work" do
+		small_md5_sum = Digest::MD5.hexdigest File.read(@small_file)
+		md5_sum = Digest::MD5.hexdigest `bundle exec #{BEAUTIFY_BIN} #{@small_file}`
+		expect(md5_sum).to eq small_md5_sum
+	end
+
+	it "will do multiple files" do
+		md5_sum = Digest::MD5.hexdigest `bundle exec #{BEAUTIFY_BIN} #{@small_file} #{@small_file}`
+		doubled_md5_sum = Digest::MD5.hexdigest File.read(@doubled_file)
+		expect(md5_sum).to eq doubled_md5_sum
+	end
+
+	# I want to make sure the file actually changes, so I do this (I could make yet another file).
+	it "will update files (overwrite) in place" do
+		FileUtils.mkdir_p File.dirname @overwrite_target_file
+		FileUtils.cp @overwrite_file, @overwrite_target_file
+		`bundle exec #{BEAUTIFY_BIN} --overwrite #{@overwrite_target_file}`
+		md5_sum = Digest::MD5.hexdigest File.read @overwrite_target_file
+	 	overwrite_md5_sum = Digest::MD5.hexdigest File.read(@overwrite_pretty_file)
+		expect(md5_sum).to eq overwrite_md5_sum
+		FileUtils.rm @overwrite_target_file
+	end
+
+	it "will honor --tabs vs --spaces"
+	it "will honor the count prefix"
 end

data/spec/binary_scenarios/doubled_example.rb

@@ -0,0 +1,6 @@
+def small
+	puts 'example'
+end
+def small
+	puts 'example'
+end

data/spec/binary_scenarios/overwrite.rb

@@ -0,0 +1,6 @@
+def ugly
+puts 'this'
+if true
+puts 'is ugly enough'
+end
+end

data/spec/binary_scenarios/overwrite_pretty.rb

@@ -0,0 +1,6 @@
+def ugly
+	puts 'this'
+	if true
+		puts 'is ugly enough'
+	end
+end

data/spec/binary_scenarios/small_example.rb

@@ -0,0 +1,3 @@
+def small
+	puts 'example'
+end

data/spec/spec_helper.rb

@@ -1,2 +1,9 @@
+require 'digest/md5'
+
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
+
+require 'ruby-beautify'
+
+
+BEAUTIFY_BIN =  "#{Dir.pwd}/bin/ruby-beautify"

data/spec/usage_scenarios/README.md

@@ -0,0 +1,44 @@
+## This Directory
+
+The examples in this directory are not direct examples but file pairs we want to consume/test to ensure that what we want to see is what we get.
+
+For example, the most basic test would be something like:
+
+```ruby
+def this_is_ugly(nowhere)
+if true
+puts true
+else
+puts false
+end
+end
+```
+
+We would expect this to look like:
+
+```ruby
+def this_is_ugly(nowhere)
+	if true
+		puts true
+	else
+		puts false
+	end
+end
+```
+
+Notice we are testing that we get the *actual* output we want.  Not the  configuratbility of the binary or our output but rather the representation of ugly vs beauty.
+
+We can expect a high level of redundancy in these specific examples, and that is ok.  We want to ensure that as we make changes to the binary, we don't break the possible ways people use Ruby.  I don't care if one file tests something another file does, as long as our ideas of what we want prettied up are throughly tested.
+
+We should avoid testing the binary.  Therefor, the tests will always be run with the binary in *default* mode.  Testing the binary's options can be handled elsewhere.
+
+## File names
+
+Each usage pair of files will need to be in a specific format of:
+
+```
+test_or_whatever.rb
+test_or_whatever_pretty.rb
+```
+
+With the pretty file being what we want it to look like by default.  The spec framework will loop through, consume the pairs, execute the parsing method and print out the results.  This will allow for dynamic testing and migrating from one framework to another if need be.

data/spec/usage_scenarios/case.rb

@@ -0,0 +1,11 @@
+# Test to validate case statements
+def case_test opts=nil
+case test_case
+when 'Passing'
+call(:pass)
+when 'Failing'
+call(:fail)
+when 'Error'
+call(:error)
+end
+end

data/spec/usage_scenarios/case_pretty.rb

@@ -0,0 +1,11 @@
+# Test to validate case statements
+def case_test opts=nil
+	case test_case
+	when 'Passing'
+		call(:pass)
+	when 'Failing'
+		call(:fail)
+	when 'Error'
+		call(:error)
+	end
+end

data/spec/usage_scenarios/from_control.rb

@@ -0,0 +1,17 @@
+# Test for variable assignment from an if statement
+@products = if params[:category]
+Category.find(params[:category]).products
+else
+Product.all
+end
+
+# Test for variable assignment from a block
+response = begin
+if true?
+api_call(test)
+else
+rejected
+end
+rescue
+'FALSE'
+end

data/spec/usage_scenarios/from_control_pretty.rb

@@ -0,0 +1,17 @@
+# Test for variable assignment from an if statement
+@products = if params[:category]
+	Category.find(params[:category]).products
+else
+	Product.all
+end
+
+# Test for variable assignment from a block
+response = begin
+	if true?
+		api_call(test)
+	else
+		rejected
+	end
+rescue
+	'FALSE'
+end

data/spec/usage_scenarios/monolithic_example.rb

@@ -0,0 +1,40 @@
+require 'ripper'
+
+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
+
+# Flattened formatting
+if 1 > 0 then puts 'something'
+else puts 'nothing' end
+puts "This line should stay the same"

data/spec/usage_scenarios/monolithic_example_pretty.rb

@@ -0,0 +1,40 @@
+require 'ripper'
+
+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
+
+# Flattened formatting
+if 1 > 0 then puts 'something'
+else puts 'nothing' end
+puts "This line should stay the same"

data/spec/usage_scenarios/multiline_strings.rb

@@ -0,0 +1,10 @@
+# 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/usage_scenarios/multiline_strings_pretty.rb

@@ -0,0 +1,10 @@
+# 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/usage_scenarios/mutli_level.rb

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

data/spec/usage_scenarios/mutli_level_pretty.rb

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

data/spec/usage_scenarios/or_equals.rb

@@ -0,0 +1,21 @@
+# Test or-equals
+def expensive_value
+@expensive_value ||= begin
+if conn.active?
+expensive_call
+else
+:none
+end
+end
+end
+
+# Test multiple or-equals
+def expensive_value
+@expensive_value ||= @cached_value ||= begin
+if conn.active?
+expensive_call
+else
+:none
+end
+end
+end

data/spec/usage_scenarios/or_equals_pretty.rb

@@ -0,0 +1,21 @@
+# Test or-equals
+def expensive_value
+	@expensive_value ||= begin
+		if conn.active?
+			expensive_call
+		else
+			:none
+		end
+	end
+end
+
+# Test multiple or-equals
+def expensive_value
+	@expensive_value ||= @cached_value ||= begin
+		if conn.active?
+			expensive_call
+		else
+			:none
+		end
+	end
+end

data/spec/usage_scenarios/pre_indented.rb

@@ -0,0 +1,12 @@
+# Test for already indented blocks
+    class There2 < There
+    def m1()
+      puts "m1"
+    end
+def m2()
+          puts "m2"
+  end
+        def m3()
+puts "m3"
+        end
+    end