ruby_scribe 0.0.1 → 0.0.2

data/README.rdoc

@@ -92,6 +92,7 @@ This feature is not developed yet, but is intended on presenting a standard recu
 
 == Known Issues
 
+* Since there are still some holes in the implementation, any s-expression type that is unknown will cause the following to be emitted: "## RubyScribe-UNKNOWN: :type ##".  Once stable any unknown type will instead throw an exception.
 * Anything involving order of operations currently much surround the expression in ( ).  Will probably expand later to omit this when order of operations is implied, but this requires a context stack.
 * Elsif currently does not work as you'd expect and instead embeds another if block inside of the outer one's "else".  This is how if statements are presented via ruby_parser.  
 * Some of the more obscure types are not implemented.

data/bin/rubyscribe

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "ruby_scribe/runner"
+
+RubyScribe::Runner.start

data/lib/ruby_scribe/emitter.rb

@@ -22,6 +22,8 @@ module RubyScribe
         emit_scope(e)
       when :rescue
         emit_rescue(e)
+      when :resbody
+        emit_rescue_body(e)
       when :module
         emit_module_definition(e)
       when :class
@@ -116,15 +118,25 @@ module RubyScribe
     end
     
     def emit_rescue(e)
-      "begin" + indent { nl + emit(e.body[0]) } +
-      nl("rescue ") + indent { nl + emit(e.body[1].body[1]) } + 
+      block = e.body.size == 1 ? nil : e.body[0]
+      resbody = e.body.size == 1 ? e.body[0] : e.body[1]
+      
+      "begin" + indent { nl + emit(block) } +
+      emit(resbody) +
       nl("end")
     end
     
+    def emit_rescue_body(e)
+      nl("rescue ".gsub(/ $/, '')) + 
+      indent { nl + emit(e.body[1]) }
+    end
+    
     def emit_method_rescue(e)
-      emit(e.body[0]) + 
-      indent(-2) { nl("rescue ") } + 
-      nl + emit(e.body[1].body[1])
+      block = e.body.size == 1 ? nil : e.body[0]
+      resbody = e.body.size == 1 ? e.body[0] : e.body[1]
+      
+      emit(block) + 
+      indent(-2) { emit(resbody) }
     end
     
     def emit_class_definition(e)
@@ -251,7 +263,7 @@ module RubyScribe
     
     def determine_if_type(e)
       if e.body[1] && e.body[2] && e.body[0].line == e.body[1].try(:line) && e.line == e.body[2].try(:line)
-        :terinary
+        :ternary
       elsif e.body[1] && !e.body[2] && e.line == e.body[1].line && e.body[1].kind != :block
         :dangling_if
       elsif !e.body[1] && e.body[2] && e.line == e.body[2].line && e.body[2].kind != :block
@@ -265,7 +277,7 @@ module RubyScribe
     
     def emit_conditional_block(e)
       case determine_if_type(e)
-      when :terinary
+      when :ternary
         "#{emit(e.body[0])} ? #{emit(e.body[1] || s(:nil))} : #{emit(e.body[2] || s(:nil))}"
       when :dangling_if
         "#{emit(e.body[1])} if #{emit(e.body[0])}"
@@ -282,7 +294,7 @@ module RubyScribe
     end
     
     def emit_case_statement(e)
-      "case #{emit(e.body.first)}" + e.body[1..-2].map {|c| emit(c) }.join + emit_case_else_statement(e.body[-1]) + nl("end")
+      "case #{emit(e.body[0])}".gsub(/ $/, '') + e.body[1..-2].map {|c| emit(c) }.join + emit_case_else_statement(e.body[-1]) + nl("end")
     end
     
     def emit_case_when_statement(e)
@@ -302,8 +314,8 @@ module RubyScribe
     end
     
     def emit_loop_block(e)
-      "#{e.kind} #{e.body.first}" + 
-      indent { emit(e.body[1]) } + 
+      "#{e.kind} #{emit(e.body[0])}" + 
+      indent { nl + emit(e.body[1]) } + 
       nl("end")
     end
     
@@ -440,7 +452,7 @@ module RubyScribe
     end
     
     def emit_unknown_expression(e)
-      nl("## UNKNOWN: #{e.kind} ##")
+      nl("## RubyScribe-UNKNOWN: #{e.kind} ##")
     end
   end
 end

data/lib/ruby_scribe/runner.rb

@@ -1,4 +1,5 @@
 require "thor"
+require "ruby_scribe"
 
 module RubyScribe
   class Runner < Thor

data/lib/ruby_scribe/version.rb

@@ -1,3 +1,3 @@
 module RubyScribe
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/ruby_scribe.rb

@@ -4,5 +4,5 @@ require "ruby_parser"
 
 require "ruby_scribe/emitter_helpers"
 require "ruby_scribe/emitter"
-require "ruby_scribe/preprocessor"
-require "ruby_scribe/ext/sexp"
+require "ruby_scribe/transformation"
+require "ruby_scribe/ext/sexp"

data/spec/examples/identity.rb

@@ -0,0 +1,17 @@
+require "some_file"
+$:.unshift("directory")
+
+module RubyScribe
+  module Example
+    def module_method
+      add + something
+      subtract - something
+      self.array << "append"
+    end
+  end
+  
+  class MyClass < Subclass
+    attr_accessor :no_parathesis
+    call_method("Apartness")
+  end
+end

data/spec/matchers/should_emit_as.rb

@@ -0,0 +1,23 @@
+RSpec::Matchers.define :emit_as do |expected|
+  match do |actual|
+    @emitted = RubyScribe::Emitter.new.emit(actual)
+    @emitted == expected
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that:\n\n#{actual}\n\n would emit as:\n\n#{with_boundaries(expected)}\n\nbut instead was:\n\n#{with_boundaries(@emitted)}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that:\n\n#{actual}\n\n would not emit as:\n\n#{with_boundaries(expected)}\n\nbut instead was:\n\n#{with_boundaries(@emitted)}"
+  end
+  
+  description do
+    segment = expected.split("\n")[0] + "..."
+    "emit as #{segment}"
+  end
+  
+  def with_boundaries(string)
+    string.split("\n").map {|s| s + "|"}.join("\n")
+  end
+end

data/spec/matchers/should_emit_itself.rb

@@ -0,0 +1,23 @@
+RSpec::Matchers.define :emit_itself do
+  match do |actual|
+    @parsed = RubyParser.new.parse(actual)
+    @emitted = RubyScribe::Emitter.new.emit(@parsed)
+    @emitted == actual
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that the s-expression:\n\n#{@parsed}\n\nrepresenting:\n\n#{with_boundaries(actual)}\n\nwould emit itself, but emitted:\n\n#{with_boundaries(@emitted)}\n\n"
+  end
+  
+  failure_message_for_should_not do |actual|
+    "expected that the s-expression:\n\n#{@parsed}\n\nrepresenting:\n\n#{actual}\n\nwould emit itself, but emitted:\n\n#{@emitted}\n\n"
+  end
+  
+  description do
+    "emit itself"
+  end
+  
+  def with_boundaries(string)
+    string.split("\n").map {|s| s + "|"}.join("\n")
+  end
+end

data/spec/ruby_scribe/emitter_examples_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe RubyScribe::Emitter, "Examples" do
+  before { @emitter = RubyScribe::Emitter.new }
+  
+  Dir[File.join(File.dirname(__FILE__), "../examples/*.rb")].each do |example|
+    describe "#{File.basename(example)} example" do
+      specify("should emit itself") { File.read(example).should emit_itself }
+    end
+  end
+end

data/spec/ruby_scribe/emitter_spec.rb

@@ -0,0 +1,187 @@
+require "spec_helper"
+
+## Relying on RubyParser here to emit what we expect, but much more readable than manually composite s-expressions
+
+describe RubyScribe::Emitter do
+  before { @emitter = RubyScribe::Emitter.new }
+  
+  context "class definition" do
+    specify "simple class should emit itself" do
+      %{class Animal\n  \nend}.should emit_itself
+    end
+    
+    specify "extended class should emit itself" do
+      %{class Animal < Creature\n  \nend}.should emit_itself
+    end
+    
+    specify "namespaced class should emit itself" do
+      pending do
+        %{class Scribe::Animal\n  \nend}.should emit_itself
+      end
+    end
+    
+    specify "eigenclass should emit itself" do
+      pending do
+        %{class << self\n  \nend}.should emit_itself
+      end
+    end
+  end
+  
+  context "module definition" do
+    specify "simple module should emit itself" do
+      %{module Animal\n  \nend}.should emit_itself
+    end
+    
+    specify "namespaced class should emit itself" do
+      pending do
+        %{module Scribe::Animal\n  \nend}.should emit_itself
+      end
+    end
+  end
+  
+  context "rescue definition" do
+    specify "rescue all should emit itself" do
+      %{begin\n  \nrescue\n  \nend}.should emit_itself
+    end
+    
+    specify "method-wide rescue should emit itself" do
+      %{def method\n  \nrescue\n  \nend}.should emit_itself
+    end
+  end
+  
+  context "method definition" do
+    specify "without arguments" do
+      %{def method\n  \nend}.should emit_itself
+    end
+    
+    specify "with one argument" do
+      %{def method(one)\n  \nend}.should emit_itself
+    end
+    
+    specify "with multiple arguments" do
+      %{def method(one, two)\n  \nend}.should emit_itself
+    end
+    
+    specify "with optional arguments" do
+      %{def method(one = 1, two = {})\n  \nend}.should emit_itself
+    end
+    
+    specify "with block argument" do
+      %{def method(one, &two)\n  \nend}.should emit_itself
+    end
+  end
+  
+  context "method call" do
+    specify "without arguments" do
+      %{method}.should emit_itself
+    end
+    
+    specify "with one argument" do
+      %{method("One")}.should emit_itself
+    end
+    
+    specify "with multiple arguments" do
+      %{method("One", 2)}.should emit_itself
+    end
+    
+    specify "with last argument as a hash" do
+      %{method("One", :option => :one)}.should emit_itself
+    end
+    
+    specify "with block" do
+      %{method do\n  \nend}.should emit_itself
+    end
+  end
+  
+  context "case statement" do
+    specify "with argument" do
+      %{case something\nwhen 1\n  \nend}.should emit_itself
+    end
+    
+    specify "without argument" do
+      %{case\nwhen 1 == 1\n  \nend}
+    end
+    
+    specify "with else block" do
+      %{case something\nwhen 1\n  \nelse\n  2\nend}.should emit_itself
+    end
+  end
+  
+  context "attribute assignment" do
+    specify "to simple local variable" do
+      %{variable = 1}.should emit_itself
+    end
+    
+    specify "to instance variable" do
+      %{@variable = 1}.should emit_itself
+    end
+    
+    specify "to multiple variables" do
+      %{variable_1, variable_2 = 1, 2}.should emit_itself
+    end
+    
+    specify "with or" do
+      %{@variable ||= 1}.should emit_itself
+    end
+    
+    specify "with and" do
+      %{@variable &&= 1}.should emit_itself
+    end
+  end
+  
+  context "conditionals" do
+    specify "simple block if" do
+      %{if true\n  something\nend}.should emit_itself
+    end
+    
+    specify "simple block unless" do
+      %{unless true\n  something\nend}.should emit_itself
+    end
+    
+    specify "simple block if else" do
+      %{if true\n  something\nelse\n  something_else\nend}.should emit_itself
+    end
+    
+    specify "dangling if" do
+      %{something if true}.should emit_itself
+    end
+    
+    specify "dangling unless" do
+      %{something unless true}.should emit_itself
+    end
+    
+    specify "ternary if" do
+      %{something ? true : false}.should emit_itself
+    end
+  end
+  
+  context "looping expression definition" do
+    specify "while" do
+      %{while true\n  \nend}.should emit_itself
+    end
+    
+    specify "until" do
+      %{until true\n  \nend}.should emit_itself
+    end
+    
+    specify "for in array" do
+      %{for something in array\n  \nend}.should emit_itself
+    end
+  end
+  
+  context "binary expressions" do
+    specify "||" do
+      %{(one || two)}.should emit_itself
+    end
+    
+    specify "&&" do
+      %{(one && two)}.should emit_itself
+    end
+  end
+  
+  context "unary expressions" do
+    specify "!something" do
+      %{!something}.should emit_itself
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby_scribe
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ben Hughes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-25 00:00:00 +03:00
+date: 2010-10-27 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,8 +66,8 @@ dependencies:
   version_requirements: *id003
 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: []
@@ -76,19 +76,23 @@ files:
 - lib/ruby_scribe/emitter.rb
 - lib/ruby_scribe/emitter_helpers.rb
 - lib/ruby_scribe/ext/sexp.rb
-- lib/ruby_scribe/preprocessor.rb
 - lib/ruby_scribe/runner.rb
+- lib/ruby_scribe/transformation.rb
 - lib/ruby_scribe/version.rb
 - lib/ruby_scribe.rb
 - lib/tasks/scribe.rake
-- spec/examples/simple_class_with_methods.rb
-- spec/proprocessor_spec.rb
+- spec/examples/identity.rb
+- spec/matchers/should_emit_as.rb
+- spec/matchers/should_emit_itself.rb
+- spec/ruby_scribe/emitter_examples_spec.rb
+- spec/ruby_scribe/emitter_spec.rb
+- spec/ruby_scribe/transformation_spec.rb
 - spec/spec_helper.rb
-- spec/strategy_spec.rb
 - LICENSE
 - Rakefile
 - README.rdoc
 - TODO.rdoc
+- bin/rubyscribe
 has_rdoc: true
 homepage: http://github.com/rubiety/ruby_scribe
 licenses: []

data/spec/examples/simple_class_with_methods.rb

@@ -1,14 +0,0 @@
-module RubyScribe
-  
-  
-  # My Comment
-  class Sample  < Base; 
-       def method; do_something_here; end
-    
-   if(new_record?) then
-       puts "Yes"
-    else
-           puts 'No'
-      end
-  end
- end

data/spec/strategy_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-
-describe RubyScribe::Strategy do
-  before do
-    @strategy = RubyScribe::Strategy.new
-  end
-  
-  
-end