Empact-rbiphonetest 0.3.0

data/History.txt

@@ -0,0 +1,18 @@
+== 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/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 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/Manifest.txt

@@ -0,0 +1,54 @@
+History.txt
+License.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
+config/hoe.rb
+config/requirements.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
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+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 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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/app_generators/rbiphonetest/USAGE

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

data/app_generators/rbiphonetest/rbiphonetest_generator.rb

@@ -0,0 +1,78 @@
+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
+  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
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Create stubs
+      m.file_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,40 @@
+require "rubygems"
+require "rake"
+
+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"
+
+namespace :objc do
+  # look for Classes/*.m files containing a line "void Init_ClassName"
+  # These are the primary classes for bundles; make a bundle for each
+  model_file_paths = `find Classes/*.m -exec grep -l "^void Init_" {} \\;`.split("\n")
+  model_file_paths.each do |path|
+    path =~ /Classes\/(.*)\.m/
+    model_name = $1
+
+    task :compile => model_name do
+      if Dir.glob("**/#{model_name}.bundle").length == 0
+        STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+        STDERR.puts "Bundle actually failed to build."
+        STDERR.puts "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
+        exit(1)
+      end
+    end
+
+    task model_name.to_sym => "build/bundles/#{model_name}.bundle"
+
+    file "build/bundles/#{model_name}.bundle" => ["Classes/#{model_name}.m", "Classes/#{model_name}.h"] do |t|
+      FileUtils.mkdir_p "build/bundles"
+      FileUtils.rm Dir["build/bundles/#{model_name}.bundle"]
+      sh "gcc -o build/bundles/#{model_name}.bundle -bundle -framework Foundation Classes/#{model_name}.m"
+    end
+  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/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'rbiphonetest/version'
+
+AUTHOR = 'Dr Nic Williams'
+EMAIL = "drnicwilliams@gmail.com"
+DESCRIPTION = "Want to write iPhone unit tests? Want to write them in Ruby?"
+GEM_NAME = 'rbiphonetest' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rbiphonetest' # The unix name for your project
+HOMEPATH = "http://github.com/drnic/rbiphonetest"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+ ['rubigen', '>= 1.3.2']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+VERS = RbIphoneTest::VERSION::STRING
+RDOC_OPTS = ['--quiet', '--title', 'rbiphonetest documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""