iphoneruby 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 2008-06-28
+
+* Initial release
+	* iphoneruby 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,34 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+app_generators/iphoneruby/USAGE
+app_generators/iphoneruby/iphoneruby_generator.rb
+app_generators/iphoneruby/templates/Rakefile
+app_generators/iphoneruby/templates/dot_autotest
+app_generators/iphoneruby/templates/test/test_helper.rb
+bin/iphoneruby
+config/hoe.rb
+config/requirements.rb
+iphoneruby_generators/model/USAGE
+iphoneruby_generators/model/model_generator.rb
+iphoneruby_generators/model/templates/model.h
+iphoneruby_generators/model/templates/model.m
+iphoneruby_generators/model/templates/test.rb
+lib/iphoneruby.rb
+lib/iphoneruby/version.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_iphoneruby.rb
+test/test_iphoneruby_generator.rb
+test/test_model_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:
+
+	iphoneruby .
+
+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,83 @@
+= iphoneruby
+
+* http://iphoneruby.rubyforge.org
+
+== DESCRIPTION:
+
+Want to write iPhone apps with unit tests? Want to write them in Ruby? 
+
+== 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
+
+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.
+
+== SYNOPSIS:
+
+* Create a new iPhone project using Xcode templates
+* Open the terminal
+* Change to project folder
+* `iphoneruby .`
+
+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 iphoneruby (COMING SOON)
+
+From source:
+	
+	git clone git://github.com/drnic/iphoneruby.git
+	cd iphoneruby
+	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/iphoneruby/USAGE

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

data/app_generators/iphoneruby/iphoneruby_generator.rb

@@ -0,0 +1,68 @@
+class IphonerubyGenerator < RubiGen::Base
+
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  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"
+      m.file_copy_each ["test/test_helper.rb"]
+
+      m.dependency "install_rubigen_scripts", [destination_root, 'iphoneruby'],
+        :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("-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
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      Classes
+      test
+    )
+end

data/app_generators/iphoneruby/templates/Rakefile

@@ -0,0 +1,49 @@
+require "rubygems"
+require "rake"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "test" << "test/bundles"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+namespace :objc do
+  desc "Compiles all Objective-C bundles for testing"
+  task :compile
+end
+
+task :compile => "objc:compile"
+
+task :test => :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" 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/iphoneruby/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|
+    ["test/test_#{m[1].underscore}.rb"]
+  end
+end
+
+Autotest.add_hook :run_command do |at|
+  system "rake compile"
+end

data/app_generators/iphoneruby/templates/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+
+require "rubygems"
+require "Shoulda"
+
+require "osx/cocoa"
+
+$:.unshift File.dirname(__FILE__) + "/../build/bundles"

data/bin/iphoneruby

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

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'iphoneruby/version'
+
+AUTHOR = 'Dr Nic Williams'
+EMAIL = "drnicwilliams@gmail.com"
+DESCRIPTION = "Want to write iPhone unit tests? Want to write them in Ruby?"
+GEM_NAME = 'iphoneruby' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'iphoneruby' # The unix name for your project
+HOMEPATH = "http://github.com/drnic/iphoneruby"
+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 = IPhoneRuby::VERSION::STRING
+RDOC_OPTS = ['--quiet', '--title', 'iphoneruby 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 ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/iphoneruby_generators/model/USAGE

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

data/iphoneruby_generators/model/model_generator.rb

@@ -0,0 +1,54 @@
+class ModelGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name, :class_name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift.underscore
+    @class_name = @name.camelcase
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'Classes'
+      m.directory 'test'
+
+      # Create stubs
+      m.template "model.h",  "Classes/#{class_name}.h"
+      m.template "model.m",  "Classes/#{class_name}.m"
+      m.template "test.rb",  "test/test_#{name}.rb"
+    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

data/iphoneruby_generators/model/templates/model.h

@@ -0,0 +1,15 @@
+//
+//  <%= class_name %>.h
+//  <%= class_name %>
+//
+//  Created by FIXME on <%= Date.today %>.
+//  Copyright <%= Date.today.year %> FIXME. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface <%= class_name %> : NSObject {
+
+}
+
+@end

data/iphoneruby_generators/model/templates/model.m

@@ -0,0 +1,22 @@
+//
+//  <%= class_name %>.h
+//  <%= class_name %>
+//
+//  Created by FIXME on <%= Date.today %>.
+//  Copyright <%= Date.today.year %> FIXME. All rights reserved.
+//
+
+#import "<%= class_name %>.h"
+
+
+@implementation <%= class_name %>
+
+@end
+
+// This initialization function gets called when we import the Ruby module.
+// It doesn't need to do anything because the RubyCocoa bridge will do
+// all the initialization work.
+// The iphoneruby test framework automatically generates bundles for 
+// each objective-c class containing the following line. These
+// can be used by your tests.
+void Init_<%= class_name %>() { }

data/iphoneruby_generators/model/templates/test.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+require "<%= class_name %>.bundle"
+OSX::ns_import :<%= class_name %>
+
+class Test<%= class_name %> < Test::Unit::TestCase
+  def test_<%= name %>_class_exists
+    OSX::<%= class_name %>
+  end
+end

data/lib/iphoneruby/version.rb

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

data/lib/iphoneruby.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module IPhoneRuby
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/iphoneruby.rb'}"
+puts "Loading iphoneruby gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)