juretta-ipt 1.0.5

data/README.md

@@ -0,0 +1,221 @@
+Xcode iPhone Project Tools
+==========================
+
+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. 
+
+Installation
+==================
+
+ 1. Install the iPhone Project Tools (ipt) gem
+
+		sudo gem install juretta-ipt --source http://gems.github.com
+ 2. Adde the following lines to your Rakefile:
+
+		require 'rubygems'
+		gem 'ipt'
+		load 'iphone_tools.rake'
+
+PNGCRUSH
+--------
+If you want to use the image optimization task the "pngcrush" binary needs to be available. Check with:
+	stefan@macbook-pro-2:~$ which pngcrush
+	/opt/local/bin/pngcrush
+
+You can install pngcrush using [Macports](http://www.macports.org/): 
+
+	sudo port install pngcrush
+
+CLANG
+-----
+If you want to use the static code analysis task (highly recommended). You have to download the checker binary.
+
+	stefan@macbook-pro-2:~/temp$ curl -OL http://keeda.stanford.edu/~kremenek/checker/checker-107.tar.bz2
+	stefan@macbook-pro-2:~/temp$ tar xjf checker-107.tar.bz2 -C /Users/stefan/dev/iphone/clang
+
+Add the path to the extracted directory to your PATH environment variable. E.g. in ~/.bash_profile
+
+	export CLANG=/Users/stefan/dev/iphone/clang/checker-107
+	export PATH=$PATH:$CLANG
+	
+Rake tasks
+==========
+
+The Rakefile contains tasks that are valueable for iPhone development.
+It defines tasks to:
+
+ * Minimze PNG image size using [pngcrush][1]
+ * Do static code analysis using the [LLVM/Clang Static Analyzer][2]
+ * Create a XML/HTML changelog using the git commit log.
+ * Generate an HTML README file using an existing markdown, textile or RDoc formatted README.* file
+ * List TODO|FIXME|IMPROVE marker.
+
+[1]: http://pmt.sourceforge.net/pngcrush/
+[2]: http://clang.llvm.org/StaticAnalysis.html
+
+In your Xcode project directory run:
+	rake -T
+to show the available tasks:
+
+		rake ipt:analyze          # Analyze code
+		rake ipt:clean            # Clean build artifacts
+		rake ipt:dist:show        # Show all bundle identifier
+		rake ipt:git:changelog    # Create a changelog (doc/changelog.html and doc/...
+		rake ipt:optimize_images  # Reduce image filesize using pngcrush
+		rake ipt:readme           # Create README.html from existing README.* text ...
+		rake ipt:todo             # List TODO|FIXME|IMPROVE tags
+
+
+Image size optimization
+-----------------------
+pngcrush is an open source, free command line computer program that reduces the size of PNG files. 
+The compression is lossless, meaning that the resulting image will have the same quality as the source image. 
+
+The original files will be saved in a _backup folder inside the project directory.
+
+To optimize the png images in your Xcode project directory run:
+    rake ipt:optimize_images
+
+Static code analysis
+--------------------
+
+ > The LLVM/Clang static analyzer is a standalone tool that find bugs in C and Objective-C programs.
+
+Run 'rake ipt:analyze' to run the clang checker. The output of the analyzer is 
+a set of html files containing bug descriptions and source code location.
+If bugs are found the tool will open a web browser with the bug report.
+If no bugs are found (which doesn't mean there aren't any!) the tool will exit without further action.
+
+Please visit the [LLVM/Clang homepage](http://clang.llvm.org/StaticAnalysis.html) to learn more 
+about the "Clang checker". 
+You should probably read the [Recommended Usage Guidelines](http://clang.llvm.org/StaticAnalysisUsage.html#RecommendedUsageGuidelines).
+
+To run the code analysis run:
+    rake ipt:analyze
+
+
+Generate HTML-Readme files
+--------------------------
+
+If your Xcode project directory contains a README.{md,markdown,text,textile,rdoc} file
+you can run the
+
+    rake ipt:readme
+    
+task to generate HTML Readme files. 
+
+Supported formats:
+
+ * [Markdown][3]: README.md, README.markdown
+ * [Textile][4]: README.text, README.textile
+ * Ruby [RDoc][5]: README.rdoc
+ 
+[3]: http://daringfireball.net/projects/markdown/
+[4]: http://textism.com/tools/textile/
+[5]: http://rdoc.sourceforge.net/doc/
+
+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)
+
+[6]: http://drnicwilliams.com/2008/07/04/unit-testing-iphone-apps-with-ruby-rbiphonetest/
+
+
+Xcode and git
+=============
+
+Xcode does not directly support git as a SCM but git can still be used to manage the source code of an Xcode project. 
+
+git related Rake tasks
+----------------------
+
+Run the 
+    rake ipt:git:changelog
+task to generate an HTML and XMl changelog file in the 'doc' subdirectory in your Xcode project directory.
+The updated changelog files will be added and commited to your local git repository automatically.
+
+Xcode git .gitignore
+--------------------
+Copy the following lines into your PROJECT_DIR/.gitignore file to ignore Xcode build artifacts and
+user specific settings:
+
+    build
+    *.mode1v3
+    *.mode2v3
+    *.nib
+    .DS_Store
+    *.swp
+    *.pbxuser
+    *.perspective
+    *.perspectivev3
+
+Xcode git build number script
+-----------------------------
+
+Inspired by: http://www.cimgf.com/2008/04/13/git-and-xcode-a-git-build-number-script/
+
+[CFBundleVersion](http://developer.apple.com/documentation/MacOSX/Conceptual/BPRuntimeConfig/Articles/PListKeys.html#//apple_ref/doc/uid/20001431-102364)
+
+ > This key specifies the build version number of the bundle, which identifies an iteration 
+ > (released or unreleased) of the bundle. This is a monotonically increased string, 
+ > comprised of one or more period-separated integers. This key is not localizable.
+
+The problem with most "Xcode git versioning scripts" is that they use the git commit id as a CFBundleVersion identifier.
+The Apple App-Store requires an bundle identifier as describe above (e.g. 1.0 or 2.3.1).
+
+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
+		
+	You can list all you tags using:
+	
+		git tag
+		
+	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)
+  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
+
+Messages written to $stdout will end up in the XCode build log (CMD + Shift + B).
+
+Use /path/to/ruby as the 'Shell' parameter. This is usually /usr/bin/ruby but might 
+be different if you have a custom ruby installation (mine is /opt/local/bin/ruby).
+Run 'which ruby' in your terminal to determine the correct path to your Ruby
+executable.
+
+	require 'rubygems'
+	begin
+	  require 'Plist'
+	rescue LoadError => e
+	  puts "You need to install the 'Plist' gem: [sudo] gem install plist"
+	  exit 1
+	end
+	
+	raise "Must be run from Xcode" unless ENV['XCODE_VERSION_ACTUAL']
+	
+	GIT="/opt/local/bin/git"
+	PLIST_FILE = File.join(ENV['BUILT_PRODUCTS_DIR'], ENV['WRAPPER_NAME'], 'Info.plist')
+	
+	if File.file?(PLIST_FILE)
+	  pl = Plist::parse_xml(PLIST_FILE)
+	  if pl
+	    pl["CFBundleVersion"] = `#{GIT} git describe --tags`.to_s
+	    pl.save_plist(PLIST_FILE)
+	  end
+	end
+	

data/Rakefile

@@ -0,0 +1,16 @@
+# 
+# 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'
+# load 'iphone_tools.rake'
+
+# =========== Your custom rake tasks ============
+
+
+
+

data/ipt.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name     = "ipt"
+  s.version  = "1.0.5"
+  s.date	= "2008-11-11"
+  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

data/tasks/changelog.tmpl

@@ -0,0 +1,63 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!-- $Id$ -->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> 
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta http-equiv="imagetoolbar" content="no" />
+    <meta http-equiv="content-language" content="en" />
+    <meta name="MSSmartTagsPreventParsing" content="true" />
+    
+    <style type="text/css" media="screen">
+    /* <![CDATA[ */
+    :link,:visited {text-decoration:none}
+    ul,ol {list-style:none}
+    h1,h2,h3,h4,h5,h6,pre,code {font-size:1em;}
+    h1 {
+      font-size: 1.4em;
+    }
+    ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,body,html,p,blockquote,fieldset,input
+    { margin:0; padding:0 }
+    a img,:link img,:visited img {border:none}
+    address {font-style:normal}
+    
+    body, h2, h1 {
+    		font-family: Monaco,"Courier New",monospace;	
+    }   	
+
+    #wrapper {
+    	width: 80%;
+    	margin: 10%;
+    }
+    
+    div.commit {
+      margin: 1.5em 0;
+      border-bottom: 1px solid silver;
+    }
+    
+    span.author, span.date {
+      display: block;
+      margin: 0.2em 0;
+    }
+
+    pre.msg {
+      margin: 1em 0;
+    }
+
+    pre {
+    	font-family:Monaco,"Courier New",monospace;
+    	font-size:90%;
+    	text-align: left;
+    }
+    
+    /* ]]> */
+    </style>  
+    
+    <title>Changelog</title>
+</head>
+<body>
+  <div id="wrapper">
+  @html@
+  </div>
+</body>
+</html>

data/tasks/iphone_tools.rake

@@ -0,0 +1,304 @@
+# Author Stefan Saasen (coravy.com)
+
+require 'fileutils'
+include FileUtils
+
+BUILD_DIR = "./build"
+
+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 Formatter
+
+  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
+      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
+
+# 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
+
+namespace :ipt do
+  
+  namespace :dist do
+    desc "Show all bundle identifier"
+    task :show do
+      puts "No build artifacts" unless File.directory?(BUILD_DIR)
+      tag = `#{find_binary('git')} describe --tags`.to_s
+      puts "\nCurrent git tag: #{tag}"
+      Dir["#{BUILD_DIR}/**/Info.plist"].each do |path|
+        if File.file?(path)
+          type = `file #{path}`
+          xml = type =~ /Apple binary property list/ ? `plutil -convert xml1  -o - #{path}` : path
+          pl = Plist::parse_xml(xml)
+          if pl
+            puts "File: #{path}"
+            puts "CFBundleVersion: #{pl['CFBundleVersion']}".strip
+            puts ""
+          end
+        end
+      end
+    end
+
+  end
+
+  
+  desc "Reduce image filesize using pngcrush"
+  task :optimize_images do
+    binary = find_binary("pngcrush")
+    backup = "#{Dir.pwd}/_backup"
+    mkdir backup unless File.directory?(backup)
+    mv Dir['*.png'], backup
+    Dir["#{backup}/*.png"].each do |png|
+      sh "#{binary} -d ./ -l 9 -brute -rem gAMA -rem cHRM -rem iCCP -rem sRGB #{png}"
+    end
+  end
+
+  desc "List TODO|FIXME|IMPROVE tags"
+  task :todo do
+    IPT::TagExtraction.new.grep(/TODO|FIXME|IMPROVE/i)
+  end
+
+  desc "Create README.html from existing README.* text file (markdown, textile, rdoc support)."
+  task :readme do
+    f = IPT::README::Formatter.new(".")
+    f.to_html 
+  end
+
+  desc "Analyze code"
+  task :analyze do
+    # Add to Path: /Users/stefan/dev/iphone/checker-75
+    begin
+      binary = find_binary("scan-build")
+      sh "#{binary} -v -V xcodebuild -configuration Debug" do |ok, res|
+        puts "Failed to run the analyze task (status: #{res.exitstatus})" if !ok
+      end
+    rescue => e
+      puts "Please install the LLVM/Clang checker: http://clang.llvm.org/StaticAnalysis.html"
+      puts "and add the directory containing the 'scan-build' binary to your $PATH"
+    end
+  end
+
+  desc "Clean build artifacts"
+  task :clean do
+    sh "xcodebuild clean"
+    rm_rf "readme.html"
+  end
+  
+  namespace :git do
+    desc "Create a changelog (doc/changelog.html and doc/changelog.xml) based on your git commits."
+    task :changelog do
+      require 'time'
+      require 'rexml/document'
+
+      DOC_DIR = "#{Dir.pwd}/doc"
+
+      # Create commit messages xml as part of the documentation in doc/
+      xml_body=`git log --pretty=format:'<commit id="%H">%n<date>%aD</date>%n<author><![CDATA[%an]]></author><author-email><![CDATA[%ae]]></author-email>%n<subject><![CDATA[%s]]></subject><msg>%n<![CDATA[%n%b%n]]>%n</msg>%n</commit>'`
+      xml = "<?xml version=\"1.0\"?>\n<commits created=\"#{Time.now.iso8601}\">\n#{xml_body}\n</commits>"
+
+      mkdir(DOC_DIR) unless File.directory?(DOC_DIR)
+
+      File.open(File.join(DOC_DIR, "changelog.xml"), 'w') do |f|
+        f << xml
+      end
+
+      HTML_ESCAPE = { '&' => '&amp;', '"' => '&quot;', '>' => '&gt;', '<' => '&lt;' }
+  
+      def html_escape(s)
+        s.to_s.gsub(/[&"><]/) { |special| HTML_ESCAPE[special] }
+      end
+
+      # Create a changelog html in public/
+      doc = REXML::Document.new(xml)
+      html = "<h1>Changelog - #{doc.root.attributes['created']}</h1>\n\n"
+      doc.elements.each('commits/commit') do |ci|
+        date = ci.elements["date"].text
+        author = ci.elements["author"].text
+        subject = ci.elements["subject"].text
+        msg = ci.elements["msg"].cdatas
+        html << "<div class=\"commit\" id=\"#{ci.attributes['id']}\">\n"
+        html << "<span class=\"date\">Date: #{date}</span>\n"
+        html << "<span class=\"author\">Author: #{html_escape(author)}</span>\n"
+        html << "<h2>#{html_escape(subject)}</h2>\n"
+        html << "<pre class=\"msg\">#{html_escape(msg)}</pre>\n"
+        html << "</div>\n"
+      end
+
+      File.open(File.join(DOC_DIR, "changelog.html"), 'w') do |f|
+        f << File.open(File.join(File.dirname(__FILE__), "changelog.tmpl")).read.gsub(/@html@/, html)
+      end
+
+      # Changelog commiten
+      `git add #{DOC_DIR}/changelog.html #{DOC_DIR}/changelog.xml`
+      `git commit -m "Update changelog"`
+    end
+    
+  end # end namespace git
+
+end # end namespace

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: juretta-ipt
+version: !ruby/object:Gem::Version 
+  version: 1.0.5
+platform: ruby
+authors: 
+- Stefan Saasen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Useful rake tasks and scripts for iPhone development using Xcode.
+email: s@juretta.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- ipt.gemspec
+- tasks/changelog.tmpl
+- tasks/iphone_tools.rake
+has_rdoc: false
+homepage: http://github.com/juretta/iphone-project-tools
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- tasks
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: iPhone Project Tools
+test_files: []
+