ruby_scribe 0.1.1 → 0.1.2

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    ruby_scribe (0.1.1)
+      activesupport (~> 3.0.10)
+      i18n (~> 0.6.0)
+      ruby_parser (~> 2.3.1)
+      thor (~> 0.13)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.10)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.7)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 2.0)
+  ruby_scribe!

data/README.rdoc

@@ -1,10 +1,16 @@
 = Ruby Scribe
 
+Generates nicely-formatted ruby source code given a ruby abstract syntax tree (from seattlerb's ruby_parser).
+
 == Introduction
 
-Seattle RB's ruby_parser is a great tool for parsing ruby code into syntax trees.  Ruby Scribe is the reverse of this - a tool for taking an S-expression in Ruby and emitting clean code.
+Ruby Scribe attempts to intelligently format code (from an AST) much as a real developer would, through a series of configurable option.  
+
+== Approach
 
-This project is similar to the ruby2ruby project (also by seattlerb) in that it is a pretty-printer for Ruby s-expressions, but ruby_scribe goes beyond emitting "runnable" Ruby code and attempts to intelligently format code much as a real developer would, through a series of configurable options.  Running this against the Rails codebase (as in, parsing the file and emitting it back out) shows very few differences.
+To approach creating a solid pretty-printer, I used the Rails codebase as "ideal" coding style for the emitter with default parameters.  As I continued to refine ruby_scribe,
+I ran it (with no AST transformations) against every ruby file in the Rails codebase.  The smaller the remaining git diff after each iteration, the better the emitter was.  
+There are even some instances I think ruby_scribe emits more consistent code than what currently exists in the Rails codebase.
 
 == Example
 
@@ -14,13 +20,6 @@ Imagine this crappily-formatted Ruby code:
     # My Comment
     class Sample  < Base; 
          def method; do_something_here; end
-
-     if(new_record?) then
-         puts "Yes"
-      else
-             puts 'No'
-        end
-    end
    end
 
 Parse that with RubyParser:
@@ -39,12 +38,6 @@ And out pops this, nice and clean:
       def method
         do_something_here
       end
-
-      if new_record?
-        puts "Yes"
-      else
-        puts "No"
-      end
     end
   end
 

data/lib/ruby_scribe.rb

@@ -1,5 +1,5 @@
 require "rubygems"
-require "active_support"
+require "bundler/setup"
 require "ruby_parser"
 
 require "ruby_scribe/sexp_helpers"

data/lib/ruby_scribe/emitter.rb

@@ -10,6 +10,7 @@ module RubyScribe
       return "" unless e
       return e if e.is_a?(String)
       return e.to_s if e.is_a?(Symbol)
+      return e unless e.respond_to?(:kind)
       
       case e.kind
       when :block
@@ -86,7 +87,7 @@ module RubyScribe
       return "" if e.body.first == s(:nil)
       
       # Special case for handling rescue blocks around entire methods (excluding the indent):
-      return emit_method_rescue(e.body.first) if e.body.first.rescue? && e.body.size == 1
+      return emit_method_rescue(e.body.first) if e.body.first.try(:rescue?) && e.body.size == 1
       
       e.body.map do |child|
         emit_block_member_prefix(e.body, child) + 
@@ -414,6 +415,8 @@ module RubyScribe
     end
     
     def emit_assignments_as_arguments(e)
+      return nil unless e && e.respond_to?(:kind) && e.body.first
+
       if e.kind == :masgn
         e.body.first.body.map {|c| emit_assignments_as_arguments(c) }.join(", ")
       elsif e.kind == :lasgn
@@ -518,4 +521,4 @@ module RubyScribe
       nl("## RubyScribe-UNKNOWN: #{e.kind} ##")
     end
   end
-end
+end

data/lib/ruby_scribe/runner.rb

@@ -12,12 +12,17 @@ module RubyScribe
     desc :convert, "Takes a single file or multiple files, parses them, then replaces the original file(s) with the scribed version."
     def convert(*paths)
       expand_paths(paths).each do |path|
-        sexp = RubyParser.new.parse(File.read(path))
-        output = RubyScribe::Emitter.new.emit(sexp)
-        
-        File.open(path, "w") do |file|
-          file.write(output)
-          file.flush
+        begin
+          sexp = RubyParser.new.parse(File.read(path))
+          output = RubyScribe::Emitter.new.emit(sexp)
+          
+          File.open(path, "w") do |file|
+            file.write(output)
+            file.flush
+          end
+        rescue Racc::ParseError, SyntaxError => e
+          $stderr.puts "! Failed to parse #{path}:"
+          $stderr.puts e.message
         end
       end
     end
@@ -26,7 +31,7 @@ module RubyScribe
     
     def expand_paths(paths = [])
       paths.map do |path|
-        [path] + Dir[path + "**/*.rb"]
+        [path] + Dir[File.join(path,"**/*.rb")]
       end.flatten.uniq.reject {|f| File.directory?(f) }
     end
   end

data/lib/ruby_scribe/sexp_helpers.rb

@@ -1,3 +1,5 @@
+require "active_support/concern"
+
 module RubyScribe
   
   # Various helpers for matching and constructing S-expressions without having to deal with 

data/lib/ruby_scribe/version.rb

@@ -1,3 +1,3 @@
 module RubyScribe
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.2"
+end

metadata

@@ -1,78 +1,79 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby_scribe
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ben Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-01 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: ruby_parser
+date: 2011-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70221043076100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: *70221043076100
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70221043075480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
+      - !ruby/object:Gem::Version
+        version: 3.0.10
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: thor
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70221043075480
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70221043074880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 0
-        - 13
-        version: "0.13"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70221043074880
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: &70221043074260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: 2.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70221043074260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70221043073680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id003
-description: A ruby formatting tool that takes S-expression as input and intelligently outputs formatted Ruby code.
+  prerelease: false
+  version_requirements: *70221043073680
+description: A ruby formatting tool that takes S-expression as input and intelligently
+  outputs formatted Ruby code.
 email: ben@railsgarden.com
-executables: 
+executables:
 - rubyscribe
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/ruby_scribe/emitter.rb
 - lib/ruby_scribe/emitter_config.rb
 - lib/ruby_scribe/emitter_helpers.rb
@@ -90,45 +91,34 @@ files:
 - spec/ruby_scribe/emitter_spec.rb
 - spec/ruby_scribe/sexp_helpers_spec.rb
 - spec/spec_helper.rb
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - Rakefile
 - README.rdoc
 - bin/rubyscribe
-has_rdoc: true
 homepage: http://github.com/rubiety/ruby_scribe
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 19
-      segments: 
-      - 1
-      - 3
-      - 4
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.4
 requirements: []
-
 rubyforge_project: ruby_scribe
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Generates formatted ruby code from S-expressions (like from ruby_parser).
 test_files: []
-