yolo 1.0.0.pre → 1.0.0

data/README.md

@@ -1,4 +1,59 @@
 yolo
 ====
 
-Continuous Integration
+yolo is a RubyGem which provides a Ruby interface to Continuous Integration build tools. yolo is currently geared towards the Xcode toolchain and iOS development.  
+
+yolo allows you to run a number of continuous integration tasks and is best implemented with an installation of [Jenkins](http://jenkins-ci.org/). 
+
+Examples of tasks yolo can complete for you are:
+* Building Xcode projects
+* Running OCUnit & Kiwi unit tests and generating reports
+* Running Calabash integration tests and generating reports
+* Packaging iOS IPA files and deploying them to external services
+* Sending notification emails
+* Running tasks on each new git tag or commit
+
+Hat tip to [Luke Redpath](https://github.com/lukeredpath) and his [xcodebuild-rb](https://github.com/lukeredpath/xcodebuild-rb) gem which is the foundation of this project.
+
+## Installing yolo
+
+It is recommended that you have [rvm](https://rvm.io/) installed and do not install yolo on system ruby as you may find a number of permissions issues.
+
+    gem install yolo
+
+## Getting Started
+
+* [Quick Start](https://github.com/alexefish/yolo/wiki/Quick-Start)
+* [Configuration](https://github.gcom/alexefish/yolo/wiki/Configuration)
+
+## Release Builds
+
+* [Generating IPAs](https://github.com/alexefish/yolo/wiki/Generating-IPAs)
+* [Deployment](https://github.com/alexefish/yolo/wiki/Deployment)
+
+## Running Tests
+
+* [OCUnit & Kiwi](https://github.com/alexefish/yolo/wiki/OCUnit-&-Kiwi)
+* [Calabash](https://github.com/alexefish/yolo/wiki/Calabash)
+
+## License 
+
+    Copyright (C) 2013 by Alex Fish
+
+    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/lib/yolo.rb

@@ -1,5 +1,5 @@
 #
-# The master Yolo module wrapper which contains all of yolo's classes
+# The master Yolo module wrapper which contains all of yolo's classes and modules
 #
 # @author Alex Fish
 module Yolo

data/lib/yolo/config.rb

@@ -1 +1,11 @@
+module Yolo
+  #
+  # The Config module provides settings and configuration
+  #
+  # @author [Alex Fish]
+  #
+  module Config
+  end
+end
+
 require 'yolo/config/settings'

data/lib/yolo/config/settings.rb

@@ -4,10 +4,18 @@ require 'fileutils'
 
 module Yolo
   module Config
+    #
+    # The Settings Singleton class provides yolo with a number of configurable settings using a config.yml file written to the users home directory
+    #
+    # @author [Alex Fish]
+    #
     class Settings
 
       include Singleton
 
+      #
+      # Creates a new Settings instance with default settings, also checks for the presence of a settings file in the users home directory
+      #
       def initialize
         @formatter = Yolo::Formatters::ProgressFormatter.new
         @error = Yolo::Formatters::ErrorFormatter.new
@@ -15,6 +23,9 @@ module Yolo
         @yaml = YAML::load_file yaml_path
       end
 
+      #
+      # Moves the config.yml settings file into the usrs home directory
+      #
       def load_config
         create_yolo_dir
         unless File.exist?(yaml_path)
@@ -23,41 +34,67 @@ module Yolo
         end
       end
 
+      #
+      # The bundle_directory option is the directory which applications are bundled too
+      #
+      # @return [String] The bundle_directory path defined in config.yml
       def bundle_directory
         @yaml["paths"]["bundle_directory"]
       end
 
+      #
+      # The deploy_url is the target url used when deploying
+      #
+      # @return [String] The deployment url defined in config.yml
       def deploy_url
         @yaml["deployment"]["url"] if @yaml["deployment"]["url"] and @yaml["deployment"]["url"] != "http://example.com"
       end
 
-      # email
+      #
+      # The mail account is the account used when sending SMTP mail
+      #
+      # @return [String] The mail account defined in config.yml
       def mail_account
         @yaml["mail"]["account"] if @yaml["mail"]["account"] and @yaml["mail"]["account"] != "example@example.com"
       end
 
+      #
+      # The mail password is the password used when sending SMTP mail
+      #
+      # @return [String] The mail password defined in config.yml
       def mail_password
         @yaml["mail"]["password"] if @yaml["mail"]["password"]  and @yaml["mail"]["password"]  != "example"
       end
 
+      #
+      # The mail port used when sending SMTP mail
+      #
+      # @return [Number] The mail port defined in config.yml
       def mail_port
         @yaml["mail"]["port"] if @yaml["mail"]["port"] and @yaml["mail"]["port"] != 0
       end
 
+      #
+      # The mail host used when sending SMTP mail
+      #
+      # @return [String] The mail host defined in config.yml
       def mail_host
         @yaml["mail"]["host"] if @yaml["mail"]["host"] and @yaml["mail"]["host"] != "your.server.ip"
       end
 
-      def mail_to
-        @yaml["mail"]["to"] if @yaml["mail"]["to"] and @yaml["mail"]["to"] != "example@example.com"
-      end
-
+      #
+      # The email address that SMTP mails are sent from
+      #
+      # @return [String] The from address defined in config.yml
       def mail_from
         @yaml["mail"]["from"] if @yaml["mail"]["from"] and @yaml["mail"]["from"] != "example@example.com"
       end
 
       private
 
+      #
+      # Checks for the existance of the config directory in the users home directory and creates it if not present
+      #
       def check_config
         unless File.directory?(yolo_dir) and File.exist?(yaml_path)
           @error.run_setup
@@ -66,18 +103,33 @@ module Yolo
         end
       end
 
+      #
+      # The path to the users home directory, same as ~
+      #
+      # @return [String] The full path to the current users home directory
       def user_directory
         File.expand_path('~')
       end
 
+      #
+      # The path to the users config.yml
+      #
+      # @return [String] The full path to the users config.yml file in their home directory
       def yaml_path
         "#{user_directory}/.yolo/config.yml"
       end
 
+      #
+      # The path to the users .yolo directory, this is directory which contains config.yml
+      #
+      # @return [String] The full path to the users .yolo directory
       def yolo_dir
         "#{user_directory}/.yolo"
       end
 
+      #
+      # Creates the .yolo directory in the users home directory (~)
+      #
       def create_yolo_dir
         unless File.directory?(yolo_dir)
           FileUtils.mkdir_p(yolo_dir)

data/lib/yolo/deployment.rb

@@ -1,2 +1,12 @@
+module Yolo
+  #
+  # The Deployment module manages application deployment to external services
+  #
+  # @author [Alex]
+  #
+  module Deployment
+  end
+end
+
 require 'yolo/deployment/base_deployer'
 require 'yolo/deployment/ota'

data/lib/yolo/deployment/base_deployer.rb

@@ -1,14 +1,33 @@
 module Yolo
   module Deployment
-    class BaseDeployer
 
+    #
+    # The Deployment super class
+    #
+    # @author [Alex Fish]
+    #
+    class BaseDeployer
+      # The deployer's url
       attr_accessor :url
-      attr_accessor :ipa_path
+      # The path to the [packge to deploy]
+      attr_accessor :package_path
 
+      #
+      # Returns a new Deployer instance
+      #
+      # @return [BaseDeployer] A new BaseDeployer instance
       def initialize
         self.url = Yolo::Config::Settings.instance.deploy_url
       end
 
+      #
+      # Deploys the package, all deployer subclasses must implement this method
+      # @param  package_path [String] A full path to the package to deploy
+      # @param  block [Block] Block fired on completing
+      #
+      def deploy(package_path, &block)
+      end
+
     end
   end
 end

data/lib/yolo/deployment/ota.rb

@@ -2,16 +2,32 @@ require 'json'
 
 module Yolo
   module Deployment
+
+    #
+    # Deploys IPA's using ustwo's OTA
+    #
+    # @author [Alex Fish]
+    #
     class OTA < Yolo::Deployment::BaseDeployer
 
+      #
+      # Creates a new OTA instance
+      #
+      # @return [OTA] A new OTA deployer instance
       def initialize
         @error_formatter = Yolo::Formatters::ErrorFormatter.new
         @progress_formatter = Yolo::Formatters::ProgressFormatter.new
         super
       end
 
-      def deploy(ipa_path, &block)
-        self.ipa_path = ipa_path
+
+      #
+      # Overides the super deploy method
+      # @param  package_path [String] A full path to the package to deploy
+      # @param  block [Block] Block fired on completing
+      #
+      def deploy(package_path, &block)
+        self.package_path = package_path
         @complete_block = block
 
         unless self.url
@@ -19,19 +35,26 @@ module Yolo
           return
         end
 
-        @progress_formatter.deploying_ipa(self.ipa_path)
+        @progress_formatter.deploying_ipa(self.package_path)
 
         upload
       end
 
+      #
+      # Creates a json package for the OTA uploader params
+      #
+      # @return [String] A JSON string package
       def package
-        filename = self.ipa_path.split("/").last
+        filename = self.package_path.split("/").last
         "{\"fileName\": \"#{filename}\", \"password\": \"\", \"validUntil\": \"2000000000\"}"
       end
 
+      #
+      # Uploades the package using CURL
+      #
       def upload
         response = ""
-        IO.popen("curl -s #{self.url} -X POST -F fileContent=@\"#{self.ipa_path}\" -F params='#{package}'") do |io|
+        IO.popen("curl -s #{self.url} -X POST -F fileContent=@\"#{self.package_path}\" -F params='#{package}'") do |io|
           begin
             while line = io.readline
               begin
@@ -47,6 +70,10 @@ module Yolo
         upload_complete(response)
       end
 
+      #
+      # Method called when the upload is complete, parses the json response form OTA which contains the package url and password
+      # @param  response [String] The OTA servers response
+      #
       def upload_complete(response)
         json = nil
         begin

data/lib/yolo/formatters.rb

@@ -1,2 +1,12 @@
+module Yolo
+  #
+  # The Formatters module provides formatted feedback
+  #
+  # @author [Alex Fish]
+  #
+  module Formatters
+  end
+end
+
 require 'yolo/formatters/progress_formatter'
 require 'yolo/formatters/error_formatter'

data/lib/yolo/formatters/error_formatter.rb

@@ -2,32 +2,65 @@ require 'xcodebuild'
 
 module Yolo
   module Formatters
+    #
+    # Outputs formatted error messages to the console
+    #
+    # @author [Alex Fish]
+    #
     class ErrorFormatter < XcodeBuild::Formatters::ProgressFormatter
 
+      #
+      # Outputs a red string stating that the info.plist file could not be found
+      #
       def info_plist_not_found
         puts red("Can't locate Info.plist")
       end
 
+      #
+      # Outputs a red string stating that setup is required
+      #
       def run_setup
         puts red("Setup required, running rake yolo:setup")
       end
 
+      #
+      # Outputs a red string stating the the deployment class is invalid
+      # @param  klass [String] The deployment class name
+      #
       def deployment_class_error(klass)
         puts red("#{klass} is not a valid Class in the Deployment module")
       end
 
+      #
+      # Outputs a red string stating that there was an issue deploying the ipa
+      # @param  error [String] The error string
+      #
       def deploy_failed(error)
         puts red("There was a problem deploying the ipa: #{error}")
       end
 
+      #
+      # Outputs a red string stating that no deploy URL was found in the config file
+      #
       def no_deploy_url
         puts red("No deploy url found, please specify one in ~/.yolo/config.yml")
       end
 
+      #
+      # Outputs a red string stating that email notification failed because of missing details
+      #
       def missing_email_details
         puts red("Can't send mail notification, missing details")
       end
 
+      #
+      # Outputs a red string stating that a release notes file could not be found
+      # @param  notes [String] The path which should contain a notes file
+      #
+      def no_notes(notes)
+        puts red("No release notes found in the current directory: #{notes}")
+      end
+
     end
   end
 end

data/lib/yolo/formatters/progress_formatter.rb

@@ -2,16 +2,31 @@ require 'xcodebuild'
 
 module Yolo
   module Formatters
+    #
+    # Outputs formatted progress messages to the console
+    #
+    # @author [Alex Fish]
+    #
     class ProgressFormatter < XcodeBuild::Formatters::ProgressFormatter
 
+      #
+      # Outputs a green string stating that the config file was created
+      # @param  config [String] The path to the config file
+      #
       def config_created(config)
         puts green("Config file created in: #{config}")
       end
 
+      #
+      # Outputs a green string stating that setup is complete
+      #
       def setup_complete
         puts green("Setup complete")
       end
 
+      #
+      # Outputs an underlined bold string stating that the ipa is being generated
+      #
       def generating_ipa
         puts
         generating = "Generating IPA"
@@ -20,6 +35,10 @@ module Yolo
         puts
       end
 
+      #
+      # Outputs an underlined bold string stating the ipa is being deployed and it's file size
+      # @param  ipa [String] The path to the ipa being deployred
+      #
       def deploying_ipa(ipa)
         puts
         deploying = "Deploying IPA"
@@ -30,10 +49,17 @@ module Yolo
         puts
       end
 
+      #
+      # Outputs a green string stating that the ipa was deployed
+      # @param  ipa [String] The path to the ipa
+      #
       def ipa_generated(ipa)
         puts green("IPA saved to: #{ipa}")
       end
 
+      #
+      # Outputs an underlined bold string stating that the release notes are being generated
+      #
       def generating_notes
         puts
         notes = "Generating release notes"
@@ -42,26 +68,47 @@ module Yolo
         puts
       end
 
+      #
+      # Outputs a green string stating that the release notes have been generated
+      # @param  notes [String] The path to the release notes
+      #
       def notes_generated(notes)
-        puts green("Release notes generated")
+        puts green("Release notes generated: #{notes}")
       end
 
+      #
+      # Outputs a cyan string stating that a new tag has been found
+      # @param  tag [String] The tag
+      #
       def new_tag(tag)
         puts cyan("Found new tag: #{tag}")
       end
 
+      #
+      # Outputs a cyan string stating that a new commit has been found
+      # @param  commit [String] The commit hash
+      #
       def new_commit(commit)
         puts cyan("Found new commit: #{commit}")
       end
 
+      #
+      # Outputs a red string stating that no new commit was found
+      #
       def no_new_commit
         puts red("No new commit found")
       end
 
+      #
+      # Outputs a red string stating that no new tag was found
+      #
       def no_new_tag
         puts red("No new tag found")
       end
 
+      #
+      # Outputs an underlined bold string stating that the notification email is being sent
+      #
       def sending_email
         puts
         email = "Sending notification email"
@@ -70,10 +117,19 @@ module Yolo
         puts
       end
 
+      #
+      # Outputs a green string stating the email was sent
+      # @param  to [Array] the users the email was sent to
+      #
       def email_sent(to)
         puts green("Notification sent to: #{to}")
       end
 
+      #
+      # Outputs a formatted string stating that the OTA deploy is complete
+      # @param  url [String] The URL to the deployed Application
+      # @param  password [String] The password for the deployed application
+      #
       def deploy_complete(url,password)
         puts
         deployed = "IPA deployed"
@@ -88,6 +144,11 @@ module Yolo
         puts
       end
 
+      #
+      # Calculates the size of a file
+      # @param  file [String] The full path to the file
+      #
+      # @return [Number] The size of the file in MBs
       def filesize(file)
         '%.2f' % (File.size(file).to_f / 2**20)
       end

data/lib/yolo/notify.rb

@@ -1,2 +1,12 @@
+module Yolo
+  #
+  # The notify module provides notifications on completion of tasks
+  #
+  # @author [Alex Fish]
+  #
+  module Notify
+  end
+end
+
 require 'yolo/notify/email'
-require 'yolo/notify/ios/ota_email'
+require 'yolo/notify/ios'

data/lib/yolo/notify/email.rb

@@ -2,19 +2,33 @@ require 'net/smtp'
 
 module Yolo
   module Notify
+    #
+    # Sends emails via SMTP
+    #
+    # @author [Alex Fish]
+    #
     class Email
 
+      # An array of email addresses used in the to field
       attr_accessor :to
+      # The email address used in the from feild
       attr_accessor :from
+      # An SMTP server
       attr_accessor :server
+      # The port to use when sending mail
       attr_accessor :port
+      # The email account to use when sending mail
       attr_accessor :account
+      # The account password to use when sending mail
       attr_accessor :password
 
+      #
+      # Initilizes an instance of the class with default settings
+      # Loads defaults from Yolo::Config::Settings
+      #
       def initialize
         self.server = Yolo::Config::Settings.instance.mail_host
         self.from = Yolo::Config::Settings.instance.mail_from
-        self.to = Yolo::Config::Settings.instance.mail_to
         self.port = Yolo::Config::Settings.instance.mail_port
         self.account = Yolo::Config::Settings.instance.mail_account
         self.password = Yolo::Config::Settings.instance.mail_password
@@ -23,11 +37,16 @@ module Yolo
         @progress_formatter = Yolo::Formatters::ProgressFormatter.new
       end
 
+      #
+      # Sends a nofification email using SMTP
+      # @param  opts [Hash] An options hash, options are: server, from, subject, title, body, password, account, port, to
+      #
       def send(opts={})
 
         opts[:server]      ||= self.server
         opts[:from]        ||= self.from
         opts[:subject]     ||= "New Build!"
+        opts[:title]       ||= "New Build!"
         opts[:body]        ||= body(opts)
         opts[:password]    ||= self.password
         opts[:account]     ||= self.account
@@ -55,6 +74,11 @@ module Yolo
         end
       end
 
+      #
+      # The body of them notification email, this method should be overwritten in subclasses
+      # to provide custom content
+      # @param  opts [Hash] A populated options hash, allows the use of options when generating email content
+      #
       def body(opts)
         ""
       end

data/lib/yolo/notify/ios.rb

@@ -0,0 +1,13 @@
+module Yolo
+  module Notify
+    #
+    # The Ios Notify module contains all Ios specific notifcation classes
+    #
+    # @author [Alex Fish]
+    #
+    module Ios
+    end
+  end
+end
+
+require 'yolo/notify/ios/ota_email'

data/lib/yolo/notify/ios/email.html

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
     <head>
         <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-        <title>*|MC:SUBJECT|*</title>
+        <title></title>
     <style type="text/css">
       /* Reset Styles */
       body{margin:0; padding:0;}
@@ -450,25 +450,7 @@
                         <!-- END PREHEADER \\ -->
                       <!-- // BEGIN CONTAINER -->
                         <table border="0" cellpadding="0" cellspacing="0" width="100%" id="templateContainer">
-                          <tr>
-                              <td align="center" valign="top">
-                                  <!-- // BEGIN HEADER -->
-                                  <table border="0" cellpadding="0" cellspacing="0" width="100%" id="templateHeader">
-                                      <tr>
-                                          <td align="center" valign="top">
-                                              <table border="0" cellpadding="0" cellspacing="0" width="320">
-                                                  <tr>
-                                                        <td class="headerContent">
-                                                            <img src="http://gallery.mailchimp.com/27aac8a65e64c994c4416d6b8/images/yoga_logo.png" style="max-width:320px;" id="headerImage campaign-icon" mc:label="header_image" mc:edit="header_image" mc:allowdesigner mc:allowtext />
-                                                        </td>
-                                                    </tr>
-                                                </table>
-                                            </td>
-                                        </tr>
-                                    </table>
-                                    <!-- END HEADER \\ -->
-                                </td>
-                            </tr>
+
                           <tr>
                               <td align="center" valign="top">
                                   <!-- // BEGIN BODY -->
@@ -481,25 +463,9 @@
                                                             <table border="0" cellpadding="0" cellspacing="0" width="100%">
                                                                 <tr>
                                                                     <td valign="top" class="bodyContent" mc:edit="body_content">
-                                                                        <h1>Honk 1.2.9.develop (123)</h1>
-                                                                        <h3>Change log</h3>
-                                                                        <p>
-                                                                        <ul>
-                                                                          <li>Trac-55 - Welcome screen - Showing on logout & not setting shown until close hit</li>
-                                                                        </ul>
-                                                                        </p>
-                                                                        <h3>Fixes</h3>
-                                                                        <p>
-                                                                        <ul>
-                                                                          <li>No Fixes</li>
-                                                                        </ul>
-                                                                        </p>
-                                                                        <h3>Notes</h3>
-                                                                        <p>No Notes</p>
-                                                                        <h3>Known issues</h3>
-                                                                        <p>No Known issues</p>
-                                                                        <h3>Password</h3>
-                                                                        <p>iasjdiasjdf</p>
+                                                                        <h1>YOLO.TITLE</h1>
+                                                                        YOLO.CONTENT
+                                                                        YOLO.PASSWORD
                                                                     </td>
                                                                 </tr>
                                                                 <tr>
@@ -507,7 +473,7 @@
                                                                         <table border="0" cellpadding="20" cellspacing="0" width="100%" class="templateButton" mc:hideable>
                                                                           <tr>
                                                                               <td align="center" valign="middle" class="templateButtonContent" mc:edit="button_content00">
-                                                                                  <a href="http://www.mailchimp.com" target="_blank">Install</a>
+                                                                                  <a href="YOLO.LINK" target="_blank">Install</a>
                                                                                 </td>
                                                                             </tr>
                                                                         </table>
@@ -532,22 +498,7 @@
                                               <table border="0" cellpadding="0" cellspacing="0" width="320">
                                                   <tr>
                                                         <td valign="top" class="footerContent" mc:edit="footer_content">
-                                                            <em>Copyright &copy; *|CURRENT_YEAR|* *|LIST:COMPANY|*, All rights reserved.</em>
-                                                            <br />
-                                                            *|IFNOT:ARCHIVE_PAGE|* *|LIST:DESCRIPTION|*
-                                                            <br />
-                                                            <br />
-                                                            <strong>Our mailing address is:</strong>
-                                                            <br />
-                                                            *|HTML:LIST_ADDRESS_HTML|**|END:IF|*
-                                                            <br />
-                                                            <br />
-                                                          *|IF:REWARDS|* *|HTML:REWARDS|* *|END:IF|*
-                                                        </td>
-                                                    </tr>
-                                                    <tr>
-                                                      <td colspan="3" valign="top" class="footerContent" style="padding-top:20px;" mc:edit="footer_utility">
-                                                          <a href="*|UNSUB|*">unsubscribe from this list</a> | <a href="*|UPDATE_PROFILE|*">update subscription preferences</a>&nbsp;
+                                                            <p><em>This is an automated message sent by <a href="https://github.com/alexefish/yolo">yolo</a> A build tools gem by <a href="http://alexefish.com/">Alex Fish</a></em></p>
                                                         </td>
                                                     </tr>
                                                 </table>

data/lib/yolo/notify/ios/ota_email.rb

@@ -3,21 +3,47 @@ require 'net/smtp'
 module Yolo
   module Notify
     module Ios
+      #
+      # OTAEmail generates an HTML email for OTA build notifications
+      #
+      # @author [Alex Fish]
+      #
       class OTAEmail < Yolo::Notify::Email
 
+        #
+        # The OTA Email body content, this content is generated using release_notes.md
+        # and an HTML email template in the same directory (email.html)
+        # @param  opts [Hash] The options hash from super
+        #
         def body(opts)
-          file = File.open(File.dirname(__FILE__) + "/email.html", "r")
-          content = file.read
-
           message = <<MESSAGE_END
 To: A Test User <test@todomain.com>
 MIME-Version: 1.0
 Content-type: text/html
 Subject: #{opts[:subject]}
 
-#{content}
+#{parsed_body(opts)}
 MESSAGE_END
         end
+
+        #
+        # Returns HTML ready to be used in the email body, HTML is generated by
+        # parsing the email.html template and applying realease_notes.md content
+        # @param  opts [Hash] The options hash from super
+        #
+        # @return [String] HTML body content for emailing
+        def parsed_body(opts)
+          file = File.open(File.dirname(__FILE__) + "/email.html", "r")
+          content = file.read
+          markdown = Yolo::Tools::Ios::ReleaseNotes.html
+
+          content = content.gsub("YOLO.TITLE",opts[:title])
+          content = content.gsub("YOLO.CONTENT",markdown)
+          content = content.gsub("YOLO.PASSWORD","<h3>Password</h3><hr><p>#{opts[:ota_password]}</p>")
+          content = content.gsub("YOLO.LINK",opts[:ota_url])
+          content
+        end
+
       end
     end
   end

data/lib/yolo/tasks.rb

@@ -1,5 +1,12 @@
+module Yolo
+  #
+  # The tasks module contains classes which run tasks such as build, release & test
+  #
+  # @author [Alex Fish]
+  #
+  module Tasks
+  end
+end
+
 require 'yolo/tasks/base_task'
-require 'yolo/tasks/ios/build'
-require 'yolo/tasks/ios/release'
-require 'yolo/tasks/ios/ocunit'
-require 'yolo/tasks/ios/calabash'
+require 'yolo/tasks/ios'

data/lib/yolo/tasks/base_task.rb

@@ -3,6 +3,11 @@ require 'rake/tasklib'
 
 module Yolo
   module Tasks
+    #
+    # A base task class to subclass from when creating tasks
+    #
+    # @author [Alex Fish]
+    #
     class BaseTask < XcodeBuild::Tasks::BuildTask
       #
       # Defines available rake tasks

data/lib/yolo/tasks/ios.rb

@@ -0,0 +1,16 @@
+module Yolo
+  module Tasks
+    #
+    # The Ios Tasks module contains all Ios specific tasks
+    #
+    # @author [author]
+    #
+    module Ios
+    end
+  end
+end
+
+require 'yolo/tasks/ios/build'
+require 'yolo/tasks/ios/release'
+require 'yolo/tasks/ios/ocunit'
+require 'yolo/tasks/ios/calabash'

data/lib/yolo/tasks/ios/build.rb

@@ -1,6 +1,11 @@
 module Yolo
   module Tasks
     module Ios
+      #
+      # Executes all build related tasks
+      #
+      # @author [Alex Fish]
+      #
       class Build < Yolo::Tasks::BaseTask
         #
         # Defines rake tasks available to the Build class
@@ -8,17 +13,17 @@ module Yolo
         def define
           super
           namespace :yolo do
-            desc "Builds the specified target(s)."
+            desc "Builds the specified scheme(s)."
             task :build do
               xcodebuild :build
             end
 
-            desc "Cleans the specified target(s)."
+            desc "Cleans the specified scheme(s)."
             task :clean do
               xcodebuild :clean
             end
 
-            desc "Builds the specified target(s) from a clean slate."
+            desc "Builds the specified scheme(s) from a clean slate."
             task :cleanbuild => [:clean, :build]
           end
         end

data/lib/yolo/tasks/ios/calabash.rb

@@ -1,6 +1,11 @@
 module Yolo
   module Tasks
     module Ios
+      #
+      # Executes all calabash related tasks
+      #
+      # @author [Alex Fish]
+      #
       class Calabash < Yolo::Tasks::BaseTask
 
         # The test report output format
@@ -25,17 +30,17 @@ module Yolo
           super
           namespace :yolo do
             namespace :calabash do
-              desc "Runs the specified target(s) calabash tests."
+              desc "Runs the specified scheme(s) calabash tests."
               task :test do
                 Yolo::Tools::Ios::Calabash.run(format, output_dir)
               end
 
-              desc "Cleans the specified target(s)."
+              desc "Cleans the specified scheme(s)."
               task :clean do
                 xcodebuild :clean
               end
 
-              desc "Runs the specified target(s) calabash tests from a clean slate."
+              desc "Runs the specified scheme(s) calabash tests from a clean slate."
               task :cleantest => [:clean, :test]
             end
           end

data/lib/yolo/tasks/ios/ocunit.rb

@@ -1,6 +1,11 @@
 module Yolo
   module Tasks
     module Ios
+      #
+      # Executes all OCunit related tasks
+      #
+      # @author [Alex Fish]
+      #
       class OCUnit < Yolo::Tasks::BaseTask
 
         # the test_output type used when running tests, currently only supports
@@ -20,7 +25,7 @@ module Yolo
         # Overrides the superclass build_opts_string method and appends a pipe
         # if test_ouput is defined
         #
-        # @param  *additional_opts [Array] an array of additional options for the build command
+        # @param  additional_opts [Array] an array of additional options for the build command
         #
         # @return [String] the option string with additional options and test output
         # pipe appended if defined
@@ -37,17 +42,17 @@ module Yolo
           super
           namespace :yolo do
             namespace :ocunit do
-              desc "Runs the specified target(s) OCUnit tests."
+              desc "Runs the specified scheme(s) OCUnit tests."
               task :test do
                 xcodebuild :build
               end
 
-              desc "Cleans the specified target(s)."
+              desc "Cleans the specified scheme(s)."
               task :clean do
                 xcodebuild :clean
               end
 
-              desc "Runs the specified target(s) OCUnit tests from a clean slate."
+              desc "Runs the specified scheme(s) OCUnit tests from a clean slate."
               task :cleantest => [:clean, :test]
             end
           end

data/lib/yolo/tasks/ios/release.rb

@@ -3,6 +3,11 @@ require 'find'
 module Yolo
   module Tasks
     module Ios
+      #
+      # Executes all release related tasks
+      #
+      # @author [Alex Fish]
+      #
       class Release < Yolo::Tasks::BaseTask
 
         # The email addresses used when notifying
@@ -129,7 +134,8 @@ module Yolo
               :to => self.mail_to,
               :ota_url => url,
               :ota_password => password,
-              :subject => "New #{name} build: #{version}"
+              :subject => "New #{name} build: #{version}",
+              :title => name
             )
           end
         end

data/lib/yolo/tools.rb

@@ -1,5 +1,12 @@
+module Yolo
+  #
+  # The tools module contains tools such as git, calabash, xcode
+  #
+  # @author [Alex Fish]
+  #
+  module Tools
+  end
+end
+
 require 'yolo/tools/git'
-require 'yolo/tools/ios/calabash'
-require 'yolo/tools/ios/xcode'
-require 'yolo/tools/ios/ipa'
-require 'yolo/tools/ios/release_notes'
+require 'yolo/tools/ios'

data/lib/yolo/tools/git.rb

@@ -2,6 +2,11 @@ require 'yaml'
 
 module Yolo
   module Tools
+    #
+    # Runs git commands
+    #
+    # @author [Alex Fish]
+    #
     class Git
 
       # A unique name used to identify the project and its history

data/lib/yolo/tools/ios.rb

@@ -0,0 +1,16 @@
+module Yolo
+  module Tools
+    #
+    # The Ios Tools module contains all iOS specific tools
+    #
+    # @author [Alex Fish]
+    #
+    module Ios
+    end
+  end
+end
+
+require 'yolo/tools/ios/calabash'
+require 'yolo/tools/ios/xcode'
+require 'yolo/tools/ios/ipa'
+require 'yolo/tools/ios/release_notes'

data/lib/yolo/tools/ios/calabash.rb

@@ -3,7 +3,18 @@ require "calabash-cucumber"
 module Yolo
   module Tools
     module Ios
+      #
+      # Runs calabash tests and outputs reports
+      #
+      # @author [Alex Fish]
+      #
       module Calabash
+        #
+        # Runs cucumber calabash tests and outputs reports to a defined location
+        # @param  format = :junit [Symbol] The test output type, defaults to junit for Jenkins, see the cucumber docs for more options
+        # @param  output_dir = "test-reports/cucumber" [String] Folder destination to output the test reports to
+        #
+        # @return [type] [description]
         def self.run(format = :junit, output_dir = "test-reports/cucumber")
           IO.popen("cucumber --format #{format.to_s} --out #{output_dir}") do |io|
             begin

data/lib/yolo/tools/ios/ipa.rb

@@ -1,9 +1,19 @@
-require 'CFPropertyList'
-
 module Yolo
   module Tools
     module Ios
+      #
+      # Generates iOS IPA packages using xcrun
+      #
+      # @author [Alex Fish]
+      #
       class IPA
+        #
+        # Generates an ipa package
+        # @param  app_path [String] The full path to the .app file
+        # @param  dsym_path [String] The full path to the dSYM folder
+        # @param  output_directory [String] The full path to the ipa save destination
+        # @param  block [Block] Block called on completion
+        #
         def self.generate(app_path,dsym_path,output_directory, &block)
           formatter = Yolo::Formatters::ProgressFormatter.new
           formatter.generating_ipa

data/lib/yolo/tools/ios/release_notes.rb

@@ -1,7 +1,18 @@
+require 'Redcarpet'
+
 module Yolo
   module Tools
     module Ios
+      #
+      # Generates and parses release notes for application releases
+      #
+      # @author [Alex Fish]
+      #
       module ReleaseNotes
+        #
+        # Generates a release notes markdown file in the current directory
+        # @param  plist_path [String] The full path to the applications info.plist
+        #
         def self.generate(plist_path)
           xcode = Yolo::Tools::Ios::Xcode.new
           xcode.info_plist_path = plist_path
@@ -28,6 +39,27 @@ module Yolo
 
           `open #{directory}/release_notes.md`
         end
+
+        #
+        # Uses Redcarpet to parse the release notes markdown file into html.
+        #
+        # @return [String] An html string representation of the current release_notes.md file
+        def self.html
+          notes = "#{Dir.pwd}/release_notes.md"
+          unless File.exist?(notes)
+            error_formatter = Yolo::Formatters::ErrorFormatter.new
+            error_formatter.no_notes(notes)
+            return ""
+          end
+
+          file = File.open(notes, "r")
+          file_content = file.read
+          markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML,
+          :autolink => true, :space_after_headers => true)
+          content = markdown.render(file_content)
+          content.gsub("\n","")
+          content
+        end
       end
     end
   end

data/lib/yolo/tools/ios/xcode.rb

@@ -3,30 +3,56 @@ require 'CFPropertyList'
 module Yolo
   module Tools
     module Ios
+      #
+      # Provides an interface to Xcode
+      #
+      # @author [Alex Fish]
+      #
       class Xcode
-
+        # The path to The Xcode preferences file
         attr_accessor :prefs_plist_path
+        # The path to an applications info plist
         attr_accessor :info_plist_path
 
+        #
+        # Creates a new instance of Xcode with the default preferences p list location loaded
+        #
+        # @return [Xcode] An Xcode instance
         def initialize
           self.prefs_plist_path = "#{user_directory}/Library/Preferences/com.apple.dt.Xcode.plist"
         end
 
+        #
+        # The current users home directory path
+        #
+        # @return [String] The path to the current users home directory, same as ~
         def user_directory
           File.expand_path('~')
         end
 
+        #
+        # Returns a hash representation of Xcode's preferences
+        #
+        # @return [Hash] A hash containing all of Xcode's preferences
         def prefs
           plist = CFPropertyList::List.new(:file => prefs_plist_path)
           CFPropertyList.native_types(plist.value)
         end
 
+        #
+        # Querys Xcode's preferences to find it's build folder location
+        #
+        # @return [String] The full path to Xcode's build location
         def build_path
           path = prefs["IDECustomDerivedDataLocation"]
           path = "#{user_directory}/Library/Developer/Xcode/DerivedData" unless path
           path
         end
 
+        #
+        # Creates a Hash representation of an applications info.plist
+        #
+        # @return [Hash] A hash representation of the instances info.plist
         def info_plist
           if info_plist_path
             plist = CFPropertyList::List.new(:file => info_plist_path)
@@ -37,10 +63,18 @@ module Yolo
           end
         end
 
+        #
+        # Queries the instances info_plist hash to return the CFBundleVersion
+        #
+        # @return [String] The current instances info.plist CFBundleVersion
         def build_number
           info_plist["CFBundleVersion"]
         end
 
+        #
+        # Queries the instances info_plist hash to return the CFBundleShortVersionString
+        #
+        # @return [String] The current instances info.plist CFBundleShortVersionString
         def version_number
           info_plist["CFBundleShortVersionString"]
         end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: yolo
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Alex Fish
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodebuild-rb
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: calabash-cucumber
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: calabash-cucumber
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -75,7 +75,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: TBD...
+description: A ruby interface to Continuous integration
 email: alex@alexefish.com
 executables: []
 extensions: []
@@ -95,18 +95,21 @@ files:
 - lib/yolo/notify/email.rb
 - lib/yolo/notify/ios/email.html
 - lib/yolo/notify/ios/ota_email.rb
+- lib/yolo/notify/ios.rb
 - lib/yolo/notify.rb
 - lib/yolo/tasks/base_task.rb
 - lib/yolo/tasks/ios/build.rb
 - lib/yolo/tasks/ios/calabash.rb
 - lib/yolo/tasks/ios/ocunit.rb
 - lib/yolo/tasks/ios/release.rb
+- lib/yolo/tasks/ios.rb
 - lib/yolo/tasks.rb
 - lib/yolo/tools/git.rb
 - lib/yolo/tools/ios/calabash.rb
 - lib/yolo/tools/ios/ipa.rb
 - lib/yolo/tools/ios/release_notes.rb
 - lib/yolo/tools/ios/xcode.rb
+- lib/yolo/tools/ios.rb
 - lib/yolo/tools.rb
 - lib/yolo.rb
 - README.md
@@ -125,9 +128,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24