juretta-ipt 1.0.7 → 1.0.8

data/README.md

@@ -16,7 +16,7 @@ Installation
  2. Adde the following lines to your Rakefile:
 
 		require 'rubygems'
-		gem 'ipt'
+		gem 'juretta-ipt'
 		load 'iphone_tools.rake'
 
 CLANG
@@ -52,10 +52,7 @@ to show the available tasks:
 		rake ipt:clean            # Clean build artifacts
 		rake ipt:dist:info        # Info
 		rake ipt:dist:show        # Show all bundle identifier
-		rake ipt:git:changelog    # Create a changelog (doc/changelog.html and doc/changelog.xml) based on your git commits.
-		rake ipt:optimize_images  # Reduce image filesize using pngcrush
-		rake ipt:readme           # Create README.html from existing README.* text file (markdown, textile, rdoc support).
-		rake ipt:todo             # List TODO|FIXME|IMPROVE tags
+        [...]
 
 
 Static code analysis
@@ -100,7 +97,7 @@ Unit testing with rbiphonetest
 ------------------------------
 
 This is not included in this Rakefile. Have a look at [rbiphonetest][6] if you want to easily test your Foundation classes.
-The rbiphonetest git repository lives here: (http://github.com/drnic/rbiphonetest/tree/master)
+The rbiphonetest git repository lives here: [http://github.com/drnic/rbiphonetest/tree/master](http://github.com/drnic/rbiphonetest/tree/master)
 
 [6]: http://drnicwilliams.com/2008/07/04/unit-testing-iphone-apps-with-ruby-rbiphonetest/
 
@@ -151,7 +148,7 @@ I use the following workflow to set version numbers for my Xcode project:
 
   1. tag the current release snapshot using
 
-		git tag 1.0.1
+		git tag -a -m "Tagging current version as 1.0.1" 1.0.1
 		
 	You can list all you tags using:
 	
@@ -159,14 +156,12 @@ I use the following workflow to set version numbers for my Xcode project:
 		
 	To check which tag is going to be used as you version numer use:
 	
-		git describe --tags
-  2. run Xcode build with the script that follows (which basically uses 'git describe --tags' to determine the most recent tag that is reachable from a commit)
+		git describe --tags --always
+  2. run Xcode build with the script that follows (which basically uses 'git describe --tags --always' to determine the most recent tag that is reachable from a commit)
   3. check CFBundleVersion value in all build artifacts using the rake task 'dist:show'
 
 		rake ipt:dist:show 
 
-
-
 In Xcode add a new script build phase:
  Targets > Add > New Build Phase > New Run Script Build Phase
 
@@ -193,7 +188,7 @@ executable.
 	if File.file?(PLIST_FILE)
 	  pl = Plist::parse_xml(PLIST_FILE)
 	  if pl
-	    pl["CFBundleVersion"] = `#{GIT} git describe --tags`.to_s
+	    pl["CFBundleVersion"] = `#{GIT} describe --tags --always`.to_s
 	    pl.save_plist(PLIST_FILE)
 	  end
 	end

data/lib/ipt/plist.rb

@@ -0,0 +1,18 @@
+module IPT
+
+  module Plist
+    class Parser
+      def initialize(path)
+        if File.file?(path)
+          type = `file '#{path}'`
+          @xml = type =~ /Apple binary property list/ ? `plutil -convert xml1  -o - '#{path}'` : path
+        end
+      end
+      
+      def parse
+        Plist::parse_xml(@xml) if @xml
+      end
+    end
+  end
+  
+end

data/lib/ipt/rake_helper.rb

@@ -0,0 +1,30 @@
+
+
+module RakeHelper
+  # Tries to determine the absolute path to the given binary.
+  def find_binary(name)
+    ENV["PATH"].split(":").each do |dir| # we are on a mac anyway
+      path = File.join(dir, name)
+      if File.executable?(path)
+        puts "Found '#{name}' in #{dir}" if $DEBUG
+        return File.expand_path(path)
+      end
+    end
+    raise "Unable to find #{name} in the system PATH. Add /path/to/#{name} to your $PATH"
+  end
+
+  def find_current_project_name
+    # Run xcodebuile in the current directory
+    info = `xcodebuild -list`
+    if info =~ /Targets:(.*?)Build Configurations/m
+      return $1.dup.gsub(/\(Active\)/, '').strip
+    end
+    nil
+  end
+  
+  def resolve_tag
+    last_tag = `#{GIT} describe --tags --always`
+    last_tag = last_tag.split('-').first if last_tag =~ /-/  
+    IPT::Version.parse(last_tag)
+  end
+end

data/lib/ipt/readme.rb

@@ -0,0 +1,110 @@
+module IPT
+
+
+  module README
+  
+    class AbstractFormatter
+      def self.supports(ext)
+        return supported_formats.include?(ext)
+      end
+    end
+    
+    class PlainFormatter < AbstractFormatter
+      def self.supported_formats
+        %w(txt)
+      end
+      
+      def to_html(input)
+        input
+      end      
+    end    
+    
+    class MarkdownFormatter < AbstractFormatter
+      def self.supported_formats
+        %w(md markdown)
+      end
+      
+      def initialize
+        begin
+          require 'bluecloth'
+        rescue LoadError => e
+          puts "The bluecloth gem is required if you want to create HTML Readme files."
+          puts "Install using: sudo gem install BlueCloth"
+        end      
+      end
+      
+      def to_html(input)
+        BlueCloth.new(input).to_html
+      end
+    end
+  
+    class TextileFormatter < AbstractFormatter
+      def self.supported_formats
+        %w(text textile)
+      end
+      
+      def initialize
+        begin
+          require 'RedCloth'
+        rescue LoadError => e
+          puts "The RedCloth gem is required if you want to create HTML Readme files."
+          puts "Install using: sudo gem install RedCloth"
+        end      
+      end      
+      
+      def to_html(input)
+        RedCloth.new(input).to_html
+      end      
+    end
+
+    class RdocFormatter < AbstractFormatter
+      def self.supported_formats
+        %w(rdoc)
+      end
+      
+      def initialize
+        require 'rdoc/markup/simple_markup'
+        require 'rdoc/markup/simple_markup/to_html'
+      end
+      
+      def to_html(input)
+        p = SM::SimpleMarkup.new
+        h = SM::ToHtml.new
+        p.convert(input, h)
+      end      
+    end
+  
+    class Formatter
+      PATTERN = "README.{text,textile,rdoc,md,markdown}"
+      FORMATTER = [MarkdownFormatter, TextileFormatter, RdocFormatter]
+      def initialize(root_dir)
+        @dir = root_dir
+      end
+    
+      def find_readme
+        Dir["#{@dir}/#{PATTERN}"].first
+      end
+
+      def find_formatter(file)
+        ext = file.split(/\./).last
+        FORMATTER.each do |f|
+          if f.supports(ext)
+            return f
+          end 
+        end
+        PlainFormatter # Default formatter
+      end
+
+      def to_html
+        readme_file = find_readme
+        if readme_file && File.file?(readme_file)
+          File.open("readme.html", "w") do |f|
+            f << find_formatter(readme_file).new.to_html(IO.readlines(readme_file).join)
+          end
+        else
+          puts "No #{PATTERN}s file could be found."
+        end
+      end
+    end # class Formatter
+  end # module README
+end # module IPT

data/lib/ipt/tag_extraction.rb

@@ -0,0 +1,60 @@
+module IPT
+
+  class TagExtraction
+    def grep(pattern, ignore = /Auto-generated/)
+      output = []
+      formatter = Formatter.new
+      traverse do |file|
+        count, match, buffer = 0, false, []
+        open(file) do |f|
+          while line = f.gets
+            count += 1
+            if line =~ pattern && line !~ ignore
+              match = true
+              buffer << "#{count.to_s.rjust(8)}:  #{line.strip}"
+            end
+          end
+          if match
+            output << "\n#{formatter.yellow(file)}"
+            output << buffer.join("\n")
+            output << "\n"
+            formatter.reset!
+          end
+          match = false
+        end
+      end
+      output.join("\n")      
+    end
+    
+    def traverse
+      Dir['**/*.{m,h,txt,md,markdown,rdoc,text}'].each do |fn|
+        yield fn
+      end
+    end
+  end # TagExtraction
+  
+  class Formatter
+    def initialize
+      reset!
+    end
+    
+    def yellow(txt)
+      @buffer << "\033[33m#{txt}\033[0m"
+      self
+    end
+    
+    def clear(txt)
+      @buffer << txt
+      self
+    end
+    
+    def reset!
+      @buffer = []
+    end
+    
+    def to_s
+      @buffer.join('')
+    end
+  end
+  
+end

data/lib/ipt/version.rb

@@ -0,0 +1,59 @@
+module IPT
+  # Basic version implementation
+  # 
+  # A version has one of the following forms:
+  # 
+  #  * MAJOR
+  #  * MAJOR.MINOR
+  #  * MAJOR.MINOR.PATCH
+  #  * MAJOR.MINOR.PATCH.BUILD
+  #
+  # = Usage
+  # 
+  #  version = Version.parse("2.3.9")
+  #  version.major # => 2
+  #
+  #  puts version # => "2.3.9"
+  class Version
+    class << self
+      def parse(str)
+        raise ArgumentError.new("Invalid version string: #{str}") unless str && str =~ /[0-9]+(\.[0-9]+)?/
+        Version.new(*str.split("."))
+      end
+    end
+    
+    PARTS = [:major, :minor, :patch, :build]
+    
+    PARTS.each {|p| attr_accessor p}
+    
+    def initialize(major, minor = nil, patch = nil, build = nil)
+      @major, @minor, @patch, @build = major.to_i, minor ? minor.to_i : nil, patch ? patch.to_i : nil, build ? build.to_i : nil
+    end
+    
+    def increase!(what = nil)
+      change(what){|old| old + 1}
+    end
+    
+    def decrease!(what = nil)
+      change(what){|old| old - 1}
+    end
+    
+    def to_s
+      PARTS.map{|part| self.send(part)}.join('.')
+    end
+    
+    private
+      def change(what, &op)
+        unless what
+          what = :major if @major
+          what = :minor if @minor
+          what = :patch if @patch
+          what = :build if @build
+        end
+        raise ArgumentError("Invalid version part") unless PARTS.include?(what)
+        self.send("#{what}=", yield(self.send(what))) 
+        self
+      end
+  end
+
+end

data/lib/ipt.rb

@@ -0,0 +1,9 @@
+#--
+# Copyright (C) 2005, 2009 by Stefan Saasen <stefan@coravy.com>
+# == Usage
+#:include:README.md
+
+Dir[File.join(File.dirname(__FILE__), 'ipt/**/*.rb')].sort.each { |lib| require lib }
+module IPT
+
+end

data/tasks/iphone_tools.rake

@@ -1,22 +1,20 @@
 # Author Stefan Saasen (coravy.com)
 
 require 'fileutils'
+require 'rubygems'
+require 'ipt'
 include FileUtils
 
 BUILD_DIR = "./build"
+API_DOC_DIR = "./docs"
 
+# Name of the AdHoc configuration in Xcode
+ADHOC_CONFIGURATION_NAME = 'Distribution (AdHoc)'
 
-# Tries to determine the absolute path to the given binary.
-def find_binary(name)
-  ENV["PATH"].split(":").each do |dir| # we are on a mac anyway
-    path = File.join(dir, name)
-    if File.executable?(path)
-      puts "Found '#{name}' in #{dir}" if $DEBUG
-      return File.expand_path(path)
-    end
-  end
-  raise "Unable to find #{name} in the system PATH. Add /path/to/#{name} to your $PATH"
-end
+# Directory for release archive files (tar.gz)
+RELEASES_DIR = "../releases"
+
+ADHOC_PROVISION_FILE = "fail"
 
 module Kernel
   def with(binary)
@@ -28,191 +26,90 @@ module Kernel
   end
 end
 
-module IPT
+include RakeHelper
 
-  module Plist
-    class Parser
-      def initialize(path)
-        if File.file?(path)
-          type = `file '#{path}'`
-          @xml = type =~ /Apple binary property list/ ? `plutil -convert xml1  -o - '#{path}'` : path
-        end
-      end
-      
-      def parse
-        Plist::parse_xml(@xml) if @xml
-      end
+namespace :ipt do
+  
+  namespace :doc do
+    desc "Generate api docs (using headerdoc) in #{API_DOC_DIR}"
+    task :app do
+      sh "headerdoc2html -u -t -o #{API_DOC_DIR} ./Classes"
+      sh "gatherheaderdoc #{API_DOC_DIR} index.html"
     end
   end
-
-  module README
   
-    class AbstractFormatter
-      def self.supports(ext)
-        return supported_formats.include?(ext)
-      end
+  namespace :adhoc do
+    #desc "Create an AdHoc distriution build"
+    task :build => :prepare do
+      rm_r BUILD_DIR if File.directory?(BUILD_DIR)
+      target = find_current_project_name
+      sh "xcodebuild -target '#{target}' -configuration '#{ADHOC_CONFIGURATION_NAME}'"
     end
     
-    class PlainFormatter < AbstractFormatter
-      def self.supported_formats
-        %w(txt)
-      end
-      
-      def to_html(input)
-        input
-      end      
-    end    
-    
-    class MarkdownFormatter < AbstractFormatter
-      def self.supported_formats
-        %w(md markdown)
-      end
-      
-      def initialize
-        begin
-          require 'bluecloth'
-        rescue LoadError => e
-          puts "The bluecloth gem is required if you want to create HTML Readme files."
-          puts "Install using: sudo gem install BlueCloth"
-        end      
-      end
-      
-      def to_html(input)
-        BlueCloth.new(input).to_html
-      end
-    end
-  
-    class TextileFormatter < AbstractFormatter
-      def self.supported_formats
-        %w(text textile)
-      end
-      
-      def initialize
-        begin
-          require 'RedCloth'
-        rescue LoadError => e
-          puts "The RedCloth gem is required if you want to create HTML Readme files."
-          puts "Install using: sudo gem install RedCloth"
-        end      
-      end      
-      
-      def to_html(input)
-        RedCloth.new(input).to_html
-      end      
+    #desc "Inject version into source"
+    task :inject do
+      # NOOP - can be overriden
     end
+    
+    # The Adhoc build depends on git
+    with('git') do
+      #desc "Prepare a release"
+      task :prepare => :inject do
+        last_tag = resolve_tag
+        puts "Previous tag: #{last_tag}"
+        NEW_TAG = last_tag.increase!.to_s
+        puts "New tag/version: #{NEW_TAG}"
+
+        # Info.plist
+        PLIST_FILE = File.join(Dir.pwd, "Info.plist")
+        if File.file?(PLIST_FILE)
+          pl = Plist::parse_xml(PLIST_FILE)
+          if pl
+            pl["CFBundleVersion"] = NEW_TAG
+            pl.save_plist(PLIST_FILE)
+          end
+        end
 
-    class RdocFormatter < AbstractFormatter
-      def self.supported_formats
-        %w(rdoc)
-      end
-      
-      def initialize
-        require 'rdoc/markup/simple_markup'
-        require 'rdoc/markup/simple_markup/to_html'
+        # Commit changes
+        `#{GIT} add #{PLIST_FILE}`
+        `#{GIT} commit -m "Preparing release for version '#{NEW_TAG}'."`
+
+        # Tag new release
+        `#{GIT} tag -a -m "Preparing release for version '#{NEW_TAG}'." #{NEW_TAG}`
       end
       
-      def to_html(input)
-        p = SM::SimpleMarkup.new
-        h = SM::ToHtml.new
-        p.convert(input, h)
-      end      
-    end
-  
-    class Formatter
-      PATTERN = "README.{text,textile,rdoc,md,markdown}"
-      FORMATTER = [MarkdownFormatter, TextileFormatter, RdocFormatter]
-      def initialize(root_dir)
-        @dir = root_dir
-      end
-    
-      def find_readme
-        Dir["#{@dir}/#{PATTERN}"].first
-      end
+      desc "Create an Ad-Hoc bundle in #{RELEASES_DIR} based on the current git tag"
+      task :release => :build do
+        target = find_current_project_name
+        src = File.join(BUILD_DIR, "#{ADHOC_CONFIGURATION_NAME}-iphoneos", "#{target}.app")
+        raise "Release build does not exist" unless File.directory?(src)
+        raise "Invalid provision file" unless File.file?(ADHOC_PROVISION_FILE)
+        dir_name = `#{GIT} describe --tags --always`.strip
+        path = File.expand_path(File.join(RELEASES_DIR, "#{dir_name}-adhoc"))
+        rm_r path if File.directory?(path)
+        mkdir_p path
+        
+        current_tag = resolve_tag
+        previous_tag = current_tag.dup.decrease!
 
-      def find_formatter(file)
-        ext = file.split(/\./).last
-        FORMATTER.each do |f|
-          if f.supports(ext)
-            return f
-          end 
-        end
-        PlainFormatter # Default formatter
-      end
+        puts "Creating changelog.txt (#{previous_tag} -> #{current_tag})"
 
-      def to_html
-        readme_file = find_readme
-        if readme_file && File.file?(readme_file)
-          File.open("readme.html", "w") do |f|
-            f << find_formatter(readme_file).new.to_html(IO.readlines(readme_file).join)
-          end
-        else
-          puts "No #{PATTERN}s file could be found."
-        end
-      end
-    end # class Formatter
-  end # module Formatter
+        `echo 'Changelog: #{previous_tag} -> #{current_tag}\n' > #{path}/changelog.txt`  
+        `#{GIT} log --abbrev-commit --pretty=medium #{previous_tag}..#{current_tag} >> #{path}/changelog.txt`
 
-  class TagExtraction
-    def grep(pattern, ignore = /Auto-generated/)
-      formatter = Formatter.new
-      traverse do |file|
-        count, match, buffer = 0, false, []
-        open(file) do |f|
-          while line = f.gets
-            count += 1
-            if line =~ pattern && line !~ ignore
-              match = true
-              buffer << "#{count.to_s.rjust(8)}:  #{line.strip}"
-            end
-          end
-          if match
-            puts "\n#{formatter.yellow(file)}"
-            puts buffer.join("\n")
-            puts "\n"
-            formatter.reset!
-          end
-          match = false
-        end
+        puts "Copying provision file..."
+        cp ADHOC_PROVISION_FILE, path
+
+        puts "Copying application"
+        cp_r src, path
+        puts 'Creating tar.gz'
+        `tar czf #{RELEASES_DIR}/#{dir_name}.tgz -C #{path} .`
       end
     end
     
-    def traverse
-      Dir['**/*.{m,h,txt,md,markdown,rdoc,text}'].each do |fn|
-        yield fn
-      end
-    end
-  end # TagExtraction
-  
-  class Formatter
-    def initialize
-      reset!
-    end
-    
-    def yellow(txt)
-      @buffer << "\033[33m#{txt}\033[0m"
-      self
-    end
-    
-    def clear(txt)
-      @buffer << txt
-      self
-    end
-    
-    def reset!
-      @buffer = []
-    end
-    
-    def to_s
-      @buffer.join('')
-    end
   end
   
-end
-
-namespace :ipt do
-  
-  namespace :dist do
-        
+  namespace :dist do    
     desc "Show all bundle identifier"
     task :show do
       puts "No build artifacts" unless File.directory?(BUILD_DIR)
@@ -245,12 +142,12 @@ namespace :ipt do
 
   desc "Reduce image filesize using pngcrush"
   task :optimize_images do
-    puts "PNG image optimization is not necessary as Xcode will optimize PNG files during the build phase.\nThis target is deprecated and will be released in future releases."
+    puts "PNG image optimization is not necessary as Xcode will optimize PNG files during the build phase.\nThis target is deprecated and will be removed in future releases."
   end
 
   desc "List TODO|FIXME|IMPROVE tags"
   task :todo do
-    IPT::TagExtraction.new.grep(/TODO|FIXME|IMPROVE/i)
+    print IPT::TagExtraction.new.grep(/TODO|FIXME|IMPROVE/i)
   end
 
   desc "Create README.html from existing README.* text file (markdown, textile, rdoc support)."
@@ -280,6 +177,11 @@ namespace :ipt do
   
   with('git') do
     namespace :git do
+      desc "Create a .gitignore file or add XCode related ignore pattern to your existing .gitignore file."
+      task :ignore do
+        raise "Implement"
+      end
+    
       desc "Create a changelog (doc/changelog.html and doc/changelog.xml) based on your git commits."
       task :changelog do
         require 'time'

data/{Rakefile → tasks/rakefile.tmpl}

@@ -1,9 +1,8 @@
 # 
-# Author Stefan Saasen (coravy.com)
 #
 # ============== Load rake tasks ================
 Dir['tasks/**/*.rake'].each { |rake| load rake }
-
+ 
 # or (if you've installed the ipt gem)
 # require 'rubygems'
 # gem 'ipt'
@@ -11,6 +10,3 @@ Dir['tasks/**/*.rake'].each { |rake| load rake }
 
 # =========== Your custom rake tasks ============
 
-
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: juretta-ipt
 version: !ruby/object:Gem::Version 
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors: 
 - Stefan Saasen
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-21 00:00:00 -08:00
+date: 2009-03-02 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Useful rake tasks and scripts for iPhone development using Xcode.
-email: s@juretta.com
+description: Useful rake tasks and scripts for iPhone development using Xcode. Some tasks rely on external software. Please read the installation instructions.  The scm related tasks assume that you are using git. You can just ignore those tasks  and scripts if you are using a different scm.
+email: stefan@coravy.com
 executables: []
 
 extensions: []
@@ -22,17 +22,25 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
-- README.md
-- Rakefile
-- ipt.gemspec
+- lib/ipt
+- lib/ipt/plist.rb
+- lib/ipt/rake_helper.rb
+- lib/ipt/readme.rb
+- lib/ipt/tag_extraction.rb
+- lib/ipt/version.rb
+- lib/ipt.rb
 - tasks/changelog.tmpl
 - tasks/iphone_tools.rake
-has_rdoc: false
+- tasks/rakefile.tmpl
+- README.md
+has_rdoc: true
 homepage: http://github.com/juretta/iphone-project-tools
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
+- lib
 - tasks
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
@@ -52,6 +60,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: iPhone Project Tools
+summary: Useful rake tasks and scripts for iPhone development using Xcode.
 test_files: []
 

data/ipt.gemspec

@@ -1,19 +0,0 @@
-Gem::Specification.new do |s|
-  s.name     = "ipt"
-  s.version  = "1.0.7"
-  s.date	= "2008-11-21"
-  s.summary  = "iPhone Project Tools"
-  s.email    = "s@juretta.com"
-  s.homepage = "http://github.com/juretta/iphone-project-tools"
-  s.description = "Useful rake tasks and scripts for iPhone development using Xcode."
-  s.has_rdoc = false
-  s.require_path = 'tasks'
-  s.authors  = ["Stefan Saasen"]
-  s.files    = [
-		"README.md", 
-		"Rakefile", 
-		"ipt.gemspec", 
-		"tasks/changelog.tmpl", 
-		"tasks/iphone_tools.rake"]
-  s.extra_rdoc_files = ["README.md"]
-end