rubyscriptwriter 0.0.1

data/README

@@ -0,0 +1,27 @@
+= RubyScriptWriter
+
+RubyScriptWriter helps programatically create new ruby scripts:
+
+r = RubyScriptWriter.new
+r.put_class "One" do
+  r.put_method "a", "arg1","arg2" do
+    r.puts "return arg1 + arg2"
+  end
+end
+puts r
+
+class One
+  def a(arg1,arg2)
+    return arg1 + arg2
+  end
+
+end
+
+It can be installed as a gem:
+gem install rubyscriptwriter
+
+This software is (c) 2010 Green on Black Ltd and distributed under the open source MIT[http://www.opensource.org/licenses/mit-license.php] licence. (See LICENCE for the wording).
+
+If you like this code, employ us: http://www.greenonblack.com
+
+

data/lib/rubyscriptwriter.rb

@@ -0,0 +1,70 @@
+require 'stringio'
+
+class RubyScriptWriter
+  attr_reader :r
+  
+  def initialize
+    @r = StringIO.new
+    @tab_count = 0
+  end
+  
+  def indent
+    @tab_count += 1
+  end
+  
+  def outdent
+    @tab_count -= 1
+  end
+  
+  def put_class(class_name,superclass_name = nil)
+    puts "class ", class_name, superclass_name && " < ", superclass_name
+    indent
+    yield self
+    outdent
+    puts "end"
+    puts
+  end
+  
+  def put_simple_method(method_name,*method_code)
+    puts "def ", method_name,"; ",*method_code.join,"; end"
+  end
+  
+  def put_method(method_name,*arguments)
+    if arguments.empty?
+      puts "def ", method_name
+    else
+      puts "def ", method_name, "(", arguments.join(','), ")"
+    end
+    indent
+    yield self
+    outdent
+    puts "end"
+    puts
+  end
+  
+  def put_coding(coding = 'utf-8')
+    comment 'coding: ', coding
+  end
+  
+  def comment(*args)
+    puts "# ", *args
+  end
+  
+  def puts(*args)
+    if args.empty?
+      r.puts
+      return self
+    end
+    args.compact!
+    r.puts tabs + args.join unless args.empty?
+    self
+  end
+  
+  def tabs
+    "  " * @tab_count
+  end
+
+  def to_s
+    r.string
+  end
+end

data/lib/rubyspecwriter.rb

@@ -0,0 +1,21 @@
+require 'rubyscriptwriter'
+
+class RubySpecWriter < RubyScriptWriter
+  def put_description(thing_being_described)
+    puts "describe ", thing_being_described, " do"
+    indent
+    yield self
+    outdent
+    puts "end"
+    puts
+  end
+  
+  def put_spec(specficiation_in_words)
+    puts "it '",specficiation_in_words.tr("'",""), "' do"
+    indent
+    yield self
+    outdent
+    puts "end"
+    puts
+  end
+end

data/spec/rubyscriptwriter_spec.rb

@@ -0,0 +1,100 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'rubyscriptwriter'
+
+describe RubyScriptWriter do
+  
+  it "#initialize should create an empty string by default" do
+    r = RubyScriptWriter.new
+    r.to_s.should == ""
+  end
+  
+  it "#puts should allow any text to be put, with newlines added automatically" do
+    r = RubyScriptWriter.new
+    r.puts "# Hello world"
+    r.puts "# again"
+    r.to_s.should == "# Hello world\n# again\n"
+  end
+  
+  it "#puts doesn't put anything if a nil value is supplied" do
+    r = RubyScriptWriter.new
+    r.puts nil
+    r.to_s.should == ""
+  end
+  
+  it "#puts puts a new line if no argument is supplied" do
+    r = RubyScriptWriter.new
+    r.puts
+    r.to_s.should == "\n"
+  end
+  
+  it "#puts should handle several arguments, concatenating them onto the same line" do
+    r = RubyScriptWriter.new
+    r.puts "one", " ", 2, 3.0
+    r.to_s.should == "one 23.0\n"
+  end
+  
+  it "#indent should add two spaces to the start a line for every time indent is called" do
+    r = RubyScriptWriter.new
+    r.puts "no indent"
+    r.indent
+    r.puts "one indent"
+    r.indent
+    r.puts "two indents"
+    r.to_s.should == "no indent\n  one indent\n    two indents\n"
+  end
+  
+  it "#outdent should reverse the effect of an indent every time outdent is called" do
+    r = RubyScriptWriter.new
+    r.puts "no indent"
+    r.indent
+    r.outdent
+    r.puts "still no indent"
+    r.indent
+    r.indent
+    r.outdent
+    r.puts "one indent"
+    r.to_s.should == "no indent\nstill no indent\n  one indent\n"
+  end
+  
+  it "#comment adds a # to the start of the given line" do
+    r = RubyScriptWriter.new
+    r.comment "This is a comment"
+    r.to_s.should == "# This is a comment\n"
+  end
+  
+  it "#put_class generates classes, optionally with a superclass" do
+    r = RubyScriptWriter.new
+    r.put_class "One" do
+      r.comment "part of class One"
+    end
+    r.put_class "Two", "One" do
+      r.comment "part of class Two"
+    end
+    r.to_s.should == "class One\n  # part of class One\nend\n\nclass Two < One\n  # part of class Two\nend\n\n"
+  end
+  
+  it "#put_simple_method generates single line methods" do
+    r = RubyScriptWriter.new
+    r.put_simple_method "a23", "b23 + 10"
+    r.to_s.should == "def a23; b23 + 10; end\n"
+  end
+  
+  it "#put_method for generating multiple line methods, optionally with arguments" do
+    r = RubyScriptWriter.new
+    r.put_method "one" do 
+      r.comment "part of method one"
+    end
+    r.put_method "two","a","b","c" do
+      r.comment "part of method two"
+    end
+    r.to_s.should == "def one\n  # part of method one\nend\n\ndef two(a,b,c)\n  # part of method two\nend\n\n"
+  end
+  
+  it "#put_coding for generating a ruby 1.9 encoding line at the start. Defaults to utf-8" do
+    r = RubyScriptWriter.new
+    r.put_coding
+    r.put_coding 'ascii'
+    r.to_s.should == "# coding: utf-8\n# coding: ascii\n"
+  end
+  
+end

data/spec/rubyspecwriter_spec.rb

@@ -0,0 +1,30 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'rubyspecwriter'
+
+describe RubySpecWriter do
+  
+  it "#put_description for generating rspec describe statements" do
+    r = RubySpecWriter.new
+    r.put_description "Sheet1" do
+      r.puts "Hello"
+    end
+    r.to_s.should == "describe Sheet1 do\n  Hello\nend\n\n"
+  end
+  
+  it "#put_spec for generating rspec it should type statements" do
+    r = RubySpecWriter.new
+    r.put_spec "a1 should be equal to b2" do
+      r.puts "a1.should == b2"
+    end
+    r.to_s.should == "it 'a1 should be equal to b2' do\n  a1.should == b2\nend\n\n"
+  end
+  
+  it "#put_spec for generating rspec it should type statements should deal with single quotes" do
+    r = RubySpecWriter.new
+    r.put_spec %Q{a1 should be equal to "One's own"} do
+      r.puts %Q{a1.should == "One's own"}
+    end
+    r.to_s.should == %Q{it 'a1 should be equal to "Ones own"' do\n  a1.should == "One's own"\nend\n\n}
+  end
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: rubyscriptwriter
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thomas Counsell, Green on Black Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-25 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ruby-script-writer@greenonblack.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- spec/rubyscriptwriter_spec.rb
+- spec/rubyspecwriter_spec.rb
+- lib/rubyscriptwriter.rb
+- lib/rubyspecwriter.rb
+has_rdoc: true
+homepage: http://wiki.github.com/tamc/ruby-script-writer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A small library for programmatically creating well formatted ruby scripts
+test_files: []
+