avh4-rbiphonetest 0.3.0

data/History.txt

@@ -0,0 +1,24 @@
+== 0.4.0 2009-03-17 NOT RELEASED
+
+* No more dependency issues between classes being tested: only one bundle created - all ObjC code being tested is compiled into one bundle
+* Upgrade internals to use latest newgem (removed bunch of dev-only files)
+* Behaviour of rbiphonetest covered by Cucumber scenarios
+
+== 0.3.0 2008-07-05
+
+* Support for test/unit AND rspec test frameworks (via install_test_unit and install_rspec generators)
+* model generator: creates test/test_model.rb or spec/model_spec.rb as required
+* story generator added for rspec developers
+* app generator: adds selected test framework to script/generate
+
+== 0.2.0 2008-07-03
+
+* Renamed project from 'iphoneruby' to 'rbiphonetest'
+* iphoneruby app: prints a deprecation message
+* USE: "rbiphonetest ." to install test framework now
+
+== 0.1.0 2008-06-28
+
+* Initial release
+	* rbiphonetest cmd - adds test framework to your Xcode project
+	* script/generate model FooBar - creates Classes/FooBar.h+m and test/test_foo_bar.rb

data/Manifest.txt

@@ -0,0 +1,51 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+app_generators/rbiphonetest/USAGE
+app_generators/rbiphonetest/rbiphonetest_generator.rb
+app_generators/rbiphonetest/templates/Rakefile
+app_generators/rbiphonetest/templates/dot_autotest
+bin/iphoneruby
+bin/rbiphonetest
+features/development.feature
+features/steps/common.rb
+features/steps/env.rb
+lib/rbiphonetest.rb
+lib/rbiphonetest/version.rb
+rbiphonetest_generators/install_rspec/USAGE
+rbiphonetest_generators/install_rspec/install_rspec_generator.rb
+rbiphonetest_generators/install_rspec/templates/spec/spec_helper.rb
+rbiphonetest_generators/install_rspec/templates/tasks/rspec.rake
+rbiphonetest_generators/install_test_unit/USAGE
+rbiphonetest_generators/install_test_unit/install_test_unit_generator.rb
+rbiphonetest_generators/install_test_unit/templates/tasks/test_unit.rake
+rbiphonetest_generators/install_test_unit/templates/test/test_helper.rb
+rbiphonetest_generators/model/USAGE
+rbiphonetest_generators/model/model_generator.rb
+rbiphonetest_generators/model/templates/model.h
+rbiphonetest_generators/model/templates/model.m
+rbiphonetest_generators/model_rspec/model_rspec_generator.rb
+rbiphonetest_generators/model_rspec/templates/spec.rb
+rbiphonetest_generators/model_test_unit/model_test_unit_generator.rb
+rbiphonetest_generators/model_test_unit/templates/test.rb
+rbiphonetest_generators/story/USAGE
+rbiphonetest_generators/story/story_generator.rb
+rbiphonetest_generators/story/templates/steps.rb
+rbiphonetest_generators/story/templates/story
+rbiphonetest_generators/story/templates/story.rb
+rbiphonetest_generators/story/templates/story_helper.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+test/test_generator_helper.rb
+test/test_helper.rb
+test/test_install_rspec_generator.rb
+test/test_install_test_unit_generator.rb
+test/test_model_generator.rb
+test/test_rbiphonetest.rb
+test/test_rbiphonetest_generator.rb
+test/test_story_generator.rb

data/PostInstall.txt

@@ -0,0 +1,21 @@
+
+You can add Ruby-based unit tests to any iPhone/Xcode project by changing to the 
+project's folder in the terminal/console and running:
+
+	rbiphonetest .
+
+This adds the test framework, a Rakefile, and an `autotest` config file.
+
+You can now create testable Objective-C models/classes using the generator:
+	
+	$ script/generate model WidgetMaker
+		  create  Classes/WidgetMaker.h
+		  create  Classes/WidgetMaker.m
+		  create  test/test_widget_maker.rb
+
+To run tests you have several options:
+	
+1. `rake` or `rake test`
+1. `autotest` (after installing the ZenTest gem)
+
+Enjoy iPhone development with Ruby!

data/README.rdoc

@@ -0,0 +1,90 @@
+= rbiphonetest - Unit Test iPhone apps with Ruby
+
+* http://rbiphonetest.rubyforge.org
+
+== DESCRIPTION:
+
+Want to write iPhone apps with unit tests? Want to write them in Ruby?
+
+* Blog introduction: http://drnicwilliams.com/2008/07/04/unit-testing-iphone-apps-with-ruby-rbiphonetest/
+* Video introduction: http://www.vimeo.com/1262916
+* Google Group: http://groups.google.com/group/rbiphonetest
+* Bugs/Features: http://drnic.lighthouseapp.com/projects/13763-rbiphonetest
+
+== FEATURES/PROBLEMS:
+
+* Installs a Ruby-based unit testing framework into an iPhone/Objective-C/Xcode project
+* Provides generators to create Objective-C classes with associated Ruby tests
+* Uses RubyCocoa to bridge between Ruby tests and Objective-C via Loadable Bundles
+
+Known issues:
+	
+* Currently only test/unit tests created; rspec etc coming soon
+* Currently only supports Foundation framework, since its common between OS X and iPhone
+* The plan is to mock out all the UIKit.framework classes so they can exist in RubyCocoa land.
+* MacRuby (instead of RubyCocoa) is not yet tested
+
+== SYNOPSIS:
+
+* Create a new iPhone project using Xcode templates
+* Open the terminal
+* Change to project folder
+* `rbiphonetest .`
+
+This adds the test framework, a Rakefile, and an `autotest` config file.
+
+You can now create testable Objective-C models/classes using the generator:
+	
+	$ script/generate model WidgetMaker
+		  create  Classes/WidgetMaker.h
+		  create  Classes/WidgetMaker.m
+		  create  test/test_widget_maker.rb
+
+To run tests you have several options:
+	
+1. `rake` or `rake test`
+1. `autotest` (after installing the ZenTest gem)
+
+All options will re-build the Objective-C code (if necessary) before running the tests.
+
+If using autotest, your tests will be re-run if the test files or the Objective-C files are modified.
+
+== REQUIREMENTS:
+
+* RubyCocoa (installed on OS X Leopard; latest version at http://rubycocoa.com)
+* XCode 3.1 (containing the iPhone SDK)
+
+== INSTALL:
+
+	sudo gem install rbiphonetest
+
+From source:
+	
+	git clone git://github.com/drnic/rbiphonetest.git
+	cd rbiphonetest
+	rake install_gem
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008-9 Dr Nic Williams
+
+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/Rakefile

@@ -0,0 +1,24 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rbiphonetest'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('rbiphonetest', RbIphoneTest::VERSION) do |p|
+  p.developer('Dr Nic Williams', 'drnicwilliams@gmail.com')
+  p.changes              = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt'
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => [:features]

data/app_generators/rbiphonetest/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/app_generators/rbiphonetest/rbiphonetest_generator.rb

@@ -0,0 +1,79 @@
+class RbIphoneTestGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :author => nil,
+                  :test_framework => 'test_unit'
+
+  attr_reader :name, :module_name
+  attr_reader :test_framework
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name             = base_name.gsub("-", "_")
+    @module_name      = name.camelize
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Create stubs
+      m.template_copy_each ["Rakefile"]
+      m.file           "dot_autotest", ".autotest"
+      
+      # Selecting a test framework
+      case test_framework
+      when "test_unit"
+        m.dependency "install_test_unit", [name], :destination => destination_root, :collision => :force
+      when "rspec"
+        m.dependency "install_rspec", [name], :destination => destination_root, :collision => :force
+      end
+      
+      m.dependency "install_rubigen_scripts", [destination_root, 'rbiphonetest', 'iphone', test_framework],
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Want to write iPhone unit tests? Want to write them in Ruby? 
+Run this generator in the root folder of your Xcode project for your iPhone app.
+
+USAGE: #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      opts.on("-s", "--test-with=TEST_FRAMEWORK", String,
+              "Select your preferred testing framework.",
+              "Options: test_unit (default), rspec.") { |x| options[:test_framework] = x }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+      @test_framework    = options[:test_framework] || "test_unit"
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      Classes
+      tasks
+    )
+end

data/app_generators/rbiphonetest/templates/Rakefile

@@ -0,0 +1,55 @@
+require "rubygems"
+require "rake"
+
+bundle_name    = '<%= module_name %>'
+src_paths      = %w[Classes] # any included projects, add folders here
+src_files      = FileList['Classes/**/*.m'] # any included projects, add files here
+req_frameworks = %w[Foundation] # use only frameworks available to both Cocoa + iPhone SDKs
+req_libraries  = %w[] # e.g. add sqlite3 for libsqlite3 to be used by linking step
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
+
+namespace :objc do
+  desc "Compiles all Objective-C bundles for testing"
+  task :compile
+end
+
+task :compile => "objc:compile"
+
+# Converts ('-I', ['foo', 'bar'])
+# Into: -Ifoo -Ibar
+def make_options(flag, items)
+  items.map { |item| "#{flag}#{item}" }.join(" ")
+end
+
+src_files.each do |file|
+  FileUtils.mkdir_p "build"
+  base = file.gsub(/\.m$/,'')
+  dot_o = "build/#{File.basename base}.o"
+  file dot_o => ["#{base}.m", "#{base}.h"] do
+    sh "gcc -c #{base}.m -o #{dot_o} #{make_options '-I', src_paths}"
+  end
+end
+
+dot_o_files = src_files.map { |file| "build/" + File.basename(file).gsub(/\.m$/,'') + ".o" }
+
+namespace :objc do
+  task :compile => "build/bundles/#{bundle_name}.bundle" do
+    if Dir.glob("**/#{bundle_name}.bundle").length == 0
+      STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      STDERR.puts "Bundle actually failed to build."
+      STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+      exit(1)
+    end
+  end
+
+  file "build/bundles/#{bundle_name}.bundle" => dot_o_files do |t|
+    FileUtils.mkdir_p "build/bundles"
+    FileUtils.rm Dir["build/bundles/#{bundle_name}.bundle"]
+    sh "gcc -o build/bundles/#{bundle_name}.bundle #{dot_o_files.join(" ")} -bundle " +
+      "#{make_options '-framework ', req_frameworks} " +
+      "#{make_options '-l', req_libraries} " +
+      "#{make_options '-I', src_paths}"
+  end
+end
+

data/app_generators/rbiphonetest/templates/dot_autotest

@@ -0,0 +1,18 @@
+class String
+  def underscore
+    gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    downcase
+  end
+end
+
+Autotest.add_hook :initialize do |at|
+  at.add_mapping(/Classes\/(.*)\.[mh]/) do |_, m|
+    ["spec/#{m[1].underscore}_spec.rb", "test/test_#{m[1].underscore}.rb"]
+  end
+end
+
+Autotest.add_hook :run_command do |at|
+  system "rake compile"
+end

data/bin/iphoneruby

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+puts <<-EOS
+DEPRECATION: this project has been renamed to 'rbiphonetest'
+
+Please use the new executable:
+
+  rbiphonetest .
+
+EOS

data/bin/rbiphonetest

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'rbiphonetest/version'
+  puts "#{File.basename($0)} #{Iphoneruby::VERSION::STRING}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+RubiGen::Base.reset_sources
+source = RubiGen::PathSource.new(:application, File.join(File.dirname(__FILE__), "../app_generators"))
+RubiGen::Base.append_sources source
+source = RubiGen::PathSource.new(:application, File.join(File.dirname(__FILE__), "../rbiphonetest_generators"))
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'rbiphonetest')

data/lib/rbiphonetest.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module RbIphoneTest
+  VERSION = '0.4.0'
+end

data/lib/rbiphonetest/version.rb

@@ -0,0 +1,9 @@
+module RbIphoneTest
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 4
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rbiphonetest_generators/install_rspec/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/rbiphonetest_generators/install_rspec/install_rspec_generator.rb

@@ -0,0 +1,52 @@
+class InstallRspecGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name, :module_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    @module_name = File.basename(destination_root).gsub("-", "_").camelize
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'spec'
+      m.directory 'tasks'
+
+      m.template_copy_each ["spec/spec_helper.rb"]
+      m.file_copy_each ["tasks/rspec.rake"]
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end