ruby-beautify2 0.98.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f4b2b3c54b65eabf04399a42340e9638cc2786397cfbc9ac23e355690f6749d
+  data.tar.gz: 601028349dfbc1ae52c2183518a7ce552929e692fbbc4dc44de889860fa6a162
+SHA512:
+  metadata.gz: 8c9139803964451848c0505332c0957007e7a02f6ffe4d28ba7c8ccc5eb8c5d410f08d4b9ed78cfb2bfc6cbd77049cedd7dd23be1a8b24e55e2ba4b5445d5f7e
+  data.tar.gz: 32c8b44c138b96ab5b4909d2dade0b2cd00aa1c735c8af593e9f2c41f81a63c4953a555b383286c111de38f8d99b8473df9f5fec4b1b6f9e029ebf469de9fc05

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2012-2016 Ernie Brodeur.
+Copyright (c) 2017-2018 Jakub Jirutka <jakub@jirutka.cz>.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# Ruby Beautify
+
+[![Build Status](https://travis-ci.org/jirutka/ruby-beautify2.png?branch=master)](https://travis-ci.org/jirutka/ruby-beautify2) 
+
+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-beautify2`
+
+## Usage
+
+To Pretty up a file:
+
+  `ruby-beautify filename`
+
+Without a filename it reads from STDIN, suitable for piping:
+
+  `curl https://raw.githubusercontent.com/jirutka/ruby-beautify2/master/spec/monolithic_example.rb | ruby-beautify`
+
+It has help:
+
+  `ruby-beautify --help`
+
+You can pick your indent character:
+
+  `ruby-beautify --(t)abs`
+
+  `ruby-beautify --(s)paces`
+
+You can also pick the count of characters:
+
+  `ruby-beautify --indent_(c)ount 1`
+
+Examples:
+
+  `ruby-beautify -c 2 -s filename`
+
+  `ruby-beautify filename`
+
+  `ruby-beautify -t -c 2 filename`
+
+## 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.
+
+  `ruby-beautify --overwrite **/*.rb`
+
+## Configuration file
+
+It can use a configuration file like some of the other ruby projects out there.  The config file consists of each argument on a new line.  Something like this:
+
+```
+--spaces
+--indent_count=2
+```
+
+Note, you'll have to add the equal sign between value and argument (tricky bit, that).
+
+Placing this into a `.ruby-beautify` anywhere in your tree (like git) will work.  This allows you to put it at the root of a project and have it change the defaults anywhere in the project.
+
+## 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 specs/pipe testing (epic).
+* 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.
+
+# History
+
+ruby-beautify2 is a fork of [ruby-beautify](https://github.com/erniebrodeur/ruby-beautify) written by [Ernie Brodeur](https://github.com/erniebrodeur), which is currently unmaintained.
+
+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

@@ -0,0 +1 @@
+bin/ruby-beautify

data/bin/ruby-beautify

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'ruby-beautify'
+
+include RubyBeautify
+my_argv = config_argv
+
+Options = OptionParser.new do |opts|
+	opts.on("-V", "--version", "Print version") { |version| puts RubyBeautify::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.on("--overwrite", "Overwrite files as you go (won't touch files that failed a syntax check).") { @overwrite = true }
+	opts.banner = "Usage: print ruby into a pretty format, or break trying."
+end
+Options.parse!(my_argv)
+
+@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
+
+if my_argv.empty?
+	content = $stdin.read
+	print_or_die content
+else
+	my_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 @overwrite
+			if syntax_ok? content
+				fh = open(file, 'w')
+				fh.write pretty_string content, indent_token: @indent_token, indent_count: @indent_count
+				fh.sync
+				fh.close
+			else
+				next
+			end
+		else
+			print_or_die content
+		end
+	end
+end

data/lib/ruby-beautify.rb

@@ -0,0 +1,184 @@
+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, :on_tlambeg]
+	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[2]}.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
+	# see https://www.ruby-forum.com/topic/4419079#1130079
+	def syntax_ok?(string)
+		begin
+			# eval will parse the code, raising a SyntaxError if something is
+			# syntactically wrong, then start executing it.  first thing is the
+			# throw, so it throws, skipping all the rest.
+			catch(:good) do
+				eval("BEGIN { throw :good }; #{string}")
+			end
+			return true
+		rescue SyntaxError
+			return false
+		end
+	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
+
+	# prepare an indented line. Requires the level, 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
+
+	# try to find a config and return a modified argv, walks all the way to root
+	# looking for '.ruby-beautify' and then returns an argv with our new options.
+	def config_argv
+		target_dirs = Dir.pwd.split("/")
+
+		# sloppy walk method, not well tested but shouldn't get in the way.
+		while (target_dirs.any?)
+			target = "#{target_dirs.join("/")}/.ruby-beautify"
+			break if File.exist?(target)
+			target_dirs.pop
+			target = nil
+		end
+
+		return ARGV unless target
+		lines = open(target).readlines
+		return ARGV + lines.map {|l| l.chomp}
+	end
+end

data/lib/ruby-beautify/version.rb

@@ -0,0 +1,3 @@
+module RubyBeautify
+	VERSION = '0.98.0'
+end

data/ruby-beautify2.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/ruby-beautify/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby-beautify2'
+  s.version     = RubyBeautify::VERSION
+  s.authors     = ['Jakub Jirutka', 'Ernie Brodeur']
+  s.email       = 'jakub@jirutka.cz'
+  s.homepage    = 'https://github.com/jirutka/ruby-beautify2'
+  s.license     = 'MIT'
+
+  s.summary     = 'A CLI tool (and module) to beautify Ruby code'
+  s.description = "#{s.summary}. This is a maintained fork of the original ruby-beautify."
+
+  s.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+  s.executables   = Dir['bin/*'].map { |f| File.basename(f) }
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_development_dependency 'bundler', '~> 1.16'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_development_dependency 'rspec', '~> 3.7'
+  s.add_development_dependency 'simplecov', '~> 0.15'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: ruby-beautify2
+version: !ruby/object:Gem::Version
+  version: 0.98.0
+platform: ruby
+authors:
+- Jakub Jirutka
+- Ernie Brodeur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: A CLI tool (and module) to beautify Ruby code. This is a maintained fork
+  of the original ruby-beautify.
+email: jakub@jirutka.cz
+executables:
+- rbeautify
+- ruby-beautify
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/rbeautify
+- bin/ruby-beautify
+- lib/ruby-beautify.rb
+- lib/ruby-beautify/version.rb
+- ruby-beautify2.gemspec
+homepage: https://github.com/jirutka/ruby-beautify2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A CLI tool (and module) to beautify Ruby code
+test_files: []