ios_dev_tools 0.1.3 → 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6583165243e7d6849595618aeb25b5bd5b1256ad
+  data.tar.gz: 94e721d32ac5b1d4d3b6d489cbd6c1a9e7aa6d68
+SHA512:
+  metadata.gz: 5c5ba1b2f24e34e3312c2fed7acde878a77736390952c4eba3ad806cdee64d1fbe8c7d988220456e805e4ffe7a3fa62bbd29c3c6dfee1019f4e10bdd6e001407
+  data.tar.gz: 4bd46e0131e5ee9d1f430e9098c45ebb35292d08998eb5794f1dd1423bc3df05391792a8521a5f889e75041065b2cbac094010d3d54e78d14618b2671f001355

data/bin/ios_tool

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+begin
+  require 'ios_dev_tools'
+rescue LoadError
+  require 'rubygems'
+  require 'ios_dev_tools'
+end
+
+tool=IOSDevTools::Tool.new
+tool.process_cmd_line_args ARGV

data/lib/ios_dev_tools.rb

@@ -1,8 +1,14 @@
 
 module IOSDevTools
 
-  autoload :ApplicationBundle,    'ios_dev_tools/application_bundle'
-  autoload :ProvisioningProfile,  'ios_dev_tools/provisioning_profile'
   autoload :VERSION,              'ios_dev_tools/version'
+  autoload :ApplicationBundle,    'ios_dev_tools/model/application_bundle'
+  autoload :ProvisioningProfile,  'ios_dev_tools/model/provisioning_profile'
+  autoload :InfoPlist,            'ios_dev_tools/model/info_plist'
+  autoload :Pack,                 'ios_dev_tools/commands/pack'
+  autoload :Sign,                 'ios_dev_tools/commands/sign'
+  autoload :Verify,               'ios_dev_tools/commands/verify'
+  autoload :Tool,                 'ios_dev_tools/commands/tool'
+  autoload :Help,                 'ios_dev_tools/commands/help'
 
 end

data/lib/ios_dev_tools/commands/help.rb

@@ -0,0 +1,131 @@
+
+#
+#
+#
+module IOSDevTools
+
+  require 'optparse'
+
+  #
+  #
+  #
+  class Help
+
+    #
+    #
+    #
+    def self.create_with_args cmd_line_arguments
+
+      options=parse_options cmd_line_arguments
+      return Help.new options
+
+    end
+
+    #
+    #
+    #
+    def self.parse_options(args)
+
+      options={}
+      options[:help_option]=args[0]
+
+      return options
+    end
+
+    #
+    #
+    #
+    def initialize options
+
+      @options=options
+
+    end
+
+    #
+    #
+    #
+    def execute
+
+      Help.display_banner
+
+      if not @options[:help_option]
+        # no option give, display generic help
+        display_generic_help
+      elsif @options[:help_option]=="commands"
+        # list of commands requested
+        display_available_commands
+      else
+        # command specific help requested
+        command_name=@options[:help_option]
+        if not Tool.valid_command_name? command_name
+            display_unknown_command command_name
+        else
+          display_command_specific_help command_name
+        end
+      end
+    end
+
+    #
+    #
+    #
+    def display_unknown_command command_name
+      puts "
+ERROR: Unknown command: #{command_name}
+"
+      display_generic_help
+    end
+
+    #
+    #
+    #
+    def self.display_banner
+      puts "iOS Development Tools v.#{VERSION}
+
+"
+    end
+
+    #
+    #
+    #
+    def display_available_commands
+      puts "
+  Available commands:
+
+    sign    - sign application bundle/archive
+    verify  - verify application bundle/archive
+    pack    - pack application bundle into archive
+
+  Execute following command to see command specific help
+
+    ios_tool help [COMMAND NAME]
+           "
+
+    end
+
+    #
+    #
+    #
+    def display_generic_help
+      puts "
+
+  TODO: ios_tool help
+
+
+    help commands       - displays available commands
+    help [COMMAND NAME] - displays command specific help
+
+
+           "
+
+    end
+
+    #
+    #
+    #
+    def display_command_specific_help command_name
+      command_class=Tool.command_name_to_class command_name
+      command_class.display_help
+    end
+
+  end
+end

data/lib/ios_dev_tools/commands/pack.rb

@@ -0,0 +1,22 @@
+
+module IOSDevTools
+
+  class Pack
+
+    def self.create_with_args cmd_line_arguments
+      Pack.new
+    end
+
+    def self.display_help
+
+      puts "
+TODO: 'pack' command help
+          "
+    end
+
+    def execute
+      puts "TODO: execute"
+    end
+  end
+
+end

data/lib/ios_dev_tools/commands/sign.rb

@@ -0,0 +1,139 @@
+
+module IOSDevTools
+
+  require 'optparse'
+
+  class Sign
+
+    def self.create_with_args cmd_line_arguments
+
+      options=parse_options cmd_line_arguments
+
+      return Sign.new options
+    end
+
+    def initialize options
+
+      @options=options
+      @be_verbose=(options[:verbose]!=nil)
+
+    end
+
+    def self.display_help
+
+      Sign.parse_options ["-h"]
+
+    end
+
+    def verbose_msg message
+
+      puts message if @be_verbose
+
+    end
+
+    def error_msg message
+
+      puts "\nERROR:\t#{message}\n"
+
+    end
+
+    def execute
+
+      verbose_msg "Passed options:\n#{@options.inspect}"
+
+      begin
+        provisioning_profile=IOSDevTools::ProvisioningProfile.new @options[:profile_location]
+        application_bundle=IOSDevTools::ApplicationBundle.new @options[:input_file] do |ab|
+          ab.temp_folder=options[:temp_folder]
+        end
+      rescue => error
+        error_msg error
+        exit 1
+      end
+
+      new_bundle_id = @options[:bundle_id]
+      new_bundle_id ||= application_bundle.bundle_id
+
+      if not provisioning_profile.is_compatible_with_bundle_id new_bundle_id
+        error_msg "Provisioning profile identifier [#{provisioning_profile.application_identifier}] is not compatible with bundle identifier [#{new_bundle_id}]\n \
+        \tMaybe you should use -b switch to overwrite the bundle identifier?"
+        exit 1
+      end
+
+      application_bundle.bundle_id = new_bundle_id
+      application_bundle.set_provisioning_profile provisioning_profile.profile_location
+      application_bundle.sign_with_identity @options[:identity]
+      application_bundle.package_to_ipa @options[:output_ipa]
+
+      puts "\nApplication archive created and signed: #{options[:output_ipa]}"
+
+    end
+
+    def self.parse_options(args)
+
+      options = Hash.new
+      OptionParser.new do |opts|
+
+        opts.banner = "Usage:
+  ios_tool sign -i \"iPhone Distribution: Name\" -p path/to/profile -o output/ipa/file [options] inputIpa"
+
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on("-p", "--profile PATH_TO_PROFILE", "Path to profile") do |profile_location|
+          options[:profile_location] = profile_location
+        end
+
+        opts.on("-b", "--bundle-id [BUNDLE_IDENTIFIER]", "Bundle identifier") do |bundle_id|
+          options[:bundle_id] = bundle_id
+        end
+
+        opts.on("-o", "--output OUTPUT_IPA_FILE", "Output ipa archive") do |output_ipa|
+          options[:output_ipa] = output_ipa
+        end
+
+        opts.on("-i", "--identity IDENTITY", "Identity") do |identity|
+          options[:identity] = identity
+        end
+
+        opts.on("-t", "--temp [TEMP_FOLDER]", "Temporary folder location") do |temp_folder|
+          options[:temp_folder] = temp_folder
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on("-v", "--verbose", "Run verbosely") do |v|
+          options[:verbose] = v
+        end
+
+        opts.on("--version", "Show version and exit") do |v|
+          puts "Version: #{IOSDevTools::VERSION}"
+          exit
+        end
+
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+      end.parse!(args)
+
+      options[:input_file]=ARGV[0]
+      mandatory=[options[:profile_location],options[:identity],options[:output_ipa],options[:input_file]]
+      expected_number=mandatory.count
+      real_number=mandatory.compact.count
+      if expected_number != real_number
+        # one of mandatory switches is missing
+        # display help and exit
+        parse_options ["-h"]
+      end
+
+      return options
+    end
+
+  end
+
+end

data/lib/ios_dev_tools/commands/tool.rb

@@ -0,0 +1,122 @@
+
+module IOSDevTools
+
+  require 'optparse'
+
+  class Tool
+
+    def process_cmd_line_args cmd_line_arguments
+
+      command_name=cmd_line_arguments[0]
+
+      if not command_name or command_name=="-h" or command_name=="--help"
+        command_name="help"
+      end
+
+      if not Tool.valid_command_name? command_name
+          puts "Unknown command"
+          exit
+      end
+
+      # create class definition
+      command_class=Tool.command_name_to_class command_name
+
+      # NOTE:shift argument array to loose first element which is command name
+      # the command is already recognised and is not needed any more
+      # this simplifies options parsing inside commands
+      ARGV.shift
+
+      # use common factory method to create the command
+      command=command_class.create_with_args ARGV
+      # execute the command if created
+      command.execute if command
+
+    end
+
+    def self.valid_command_name? command_name
+
+      valid_commands=["sign", "pack", "verify", "help"]
+      return valid_commands.include? command_name
+
+    end
+
+    def self.command_name_to_class command_name
+      # convert snake case to camel case
+      c=command_name.gsub(/(?<=_|^)(\w)/){$1.upcase}.gsub(/(?:_)(\w)/,'\1')
+      # create class definition
+      command_class=nil
+      begin
+        command_class=Object.const_get("IOSDevTools::#{c}")
+      rescue NameError,e
+      end
+      return command_class
+    end
+
+    def self.parse_options(args)
+
+      options = Hash.new
+      OptionParser.new do |opts|
+
+        opts.banner = "Usage:
+ios_tool sign -i \"iPhone Distribution: Name\" -p path/to/profile -o output/ipa/file [options] inputIpa"
+
+        opts.separator ""
+        opts.separator "Options:"
+
+        opts.on("-p", "--profile PATH_TO_PROFILE", "Path to profile") do |profile_location|
+          options[:profile_location] = profile_location
+        end
+
+        opts.on("-b", "--bundle-id [BUNDLE_IDENTIFIER]", "Bundle identifier") do |bundle_id|
+          options[:bundle_id] = bundle_id
+        end
+
+        opts.on("-o", "--output OUTPUT_IPA_FILE", "Output ipa archive") do |output_ipa|
+          options[:output_ipa] = output_ipa
+        end
+
+        opts.on("-i", "--identity IDENTITY", "Identity") do |identity|
+          options[:identity] = identity
+        end
+
+        opts.on("-t", "--temp [TEMP_FOLDER]", "Temporary folder location") do |temp_folder|
+          options[:temp_folder] = temp_folder
+        end
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on("-v", "--verbose", "Run verbosely") do |v|
+          options[:verbose] = v
+        end
+
+        opts.on("--version", "Show version and exit") do |v|
+          puts "Version: #{IOSDevTools::VERSION}"
+          exit
+        end
+
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+
+      end.parse!(args)
+
+      options[:input_file]=ARGV[0]
+      mandatory=[options[:profile_location],options[:identity],options[:output_ipa],options[:input_file]]
+      expected_number=mandatory.count
+      real_number=mandatory.compact.count
+      if expected_number != real_number
+        # one of mandatory switches is missing
+        # display help and exit
+        parse_options ["-h"]
+      end
+
+      return options
+    end
+
+  end
+
+end

data/lib/ios_dev_tools/commands/verify.rb

@@ -0,0 +1,22 @@
+
+module IOSDevTools
+
+  class Verify
+
+    def self.create_with_args cmd_line_arguments
+      Verify.new
+    end
+
+    def self.display_help
+
+      puts "
+TODO: 'verify' command help
+          "
+    end
+
+    def execute
+      puts "TODO: execute"
+    end
+  end
+
+end

data/lib/ios_dev_tools/{application_bundle.rb → model/application_bundle.rb}

@@ -15,6 +15,7 @@ module IOSDevTools
     attr_accessor :temp_folder
     attr_accessor :plist_buddy_cmd
     attr_accessor :application_name
+    attr_accessor :info_plist
 
     def initialize file_or_folder_location
 
@@ -30,7 +31,6 @@ module IOSDevTools
 
       @src_location=file_or_folder_location
       @temp_folder||="temp"
-      @plist_buddy_cmd||="/usr/libexec/PlistBuddy"
 
       if not @is_application_folder
         # wipe out temp folder
@@ -44,26 +44,11 @@ module IOSDevTools
       end
 
       @application_name=Pathname.new(@location).basename
+      @info_plist=InfoPlist.new "#{@location}/Info.plist"
 
     end
 
-    def display_name
-      `#{@plist_buddy_cmd} -c "Print :CFBundleDisplayName" "#{@location}/Info.plist"`.strip
-    end
-
-    def display_name= new_name
-      return if not new_name
-      `#{@plist_buddy_cmd} -c "Set :CFBundleDisplayName #{new_name}" "#{@location}/Info.plist"`
-    end
 
-    def bundle_id
-      `#{@plist_buddy_cmd} -c "Print :CFBundleIdentifier" "#{@location}/Info.plist"`.strip
-    end
-
-    def bundle_id= new_bundle_id
-      return if not new_bundle_id
-      `#{@plist_buddy_cmd} -c "Set :CFBundleIdentifier #{new_bundle_id}" "#{@location}/Info.plist"`
-    end
 
     def set_provisioning_profile new_provisioning_profile_location
       return if not new_provisioning_profile_location

data/lib/ios_dev_tools/model/info_plist.rb

@@ -0,0 +1,50 @@
+module IOSDevTools
+
+  #
+  #
+  #
+  class InfoPlist
+
+    attr_accessor :info_plist_file_path
+    attr_accessor :plist_buddy_cmd
+
+    def initialize info_plist_file_path
+
+      @info_plist_file_path=info_plist_file_path
+
+      yield self if block_given?
+
+      @plist_buddy_cmd||="/usr/libexec/PlistBuddy"
+
+      raise "Property list file \"#{info_plist_file_path}\" doesn't exist" if not File.exists? @info_plist_file_path
+      raise "Plist editor \"#{info_plist_file_path}\" doesn't exist" if not File.exists? @plist_buddy_cmd
+
+    end
+
+    def set_property property_id, property_value
+      return if not property_id or not property_value
+      `#{@plist_buddy_cmd} -c "Set :#{property_id} #{new_name}" "#{@info_plist_file_path}"`
+    end
+
+    def get_property property_id
+      `#{@plist_buddy_cmd} -c "Print :#{property_id}" "#{@info_plist_file_path}"`.strip
+    end
+
+    def display_name
+      get_property "CFBundleDisplayName"
+    end
+
+    def display_name= new_name
+      set_property "CFBundleDisplayName", new_name
+    end
+
+    def bundle_id
+      get_property "CFBundleIdentifier"
+    end
+
+    def bundle_id= new_bundle_id
+      set_property "CFBundleIdentifier", new_bundle_id
+    end
+
+  end
+end

data/lib/ios_dev_tools/version.rb

@@ -1,5 +1,5 @@
 module IOSDevTools
 
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 
 end

data/test/test_application_bundle.rb

@@ -3,6 +3,18 @@ require 'ios_dev_tools'
 
 class ApplicationBundleTest < Test::Unit::TestCase
 
+  def test_create_with_app_folder
+
+      app_bundle=IOSDevTools::ApplicationBundle.new "test_resources/DummyApp.app"
+
+      assert_not_nil app_bundle
+      info_plist=app_bundle.info_plist
+      assert_not_nil info_plist
+      assert_equal "Dummy Bundle", app_bundle.info_plist.display_name
+      assert_equal "com.csquirrel.dummy.bundle", app_bundle.info_plist.bundle_id
+
+  end
+
   def test_create_with_not_existing_folder
 
     assert_raise RuntimeError do

data/test/test_info_plist.rb

@@ -0,0 +1,23 @@
+require 'test/unit'
+require 'ios_dev_tools'
+
+class ApplicationBundleTest < Test::Unit::TestCase
+
+  def test_create_with_file
+
+      info_plist=IOSDevTools::InfoPlist.new "test_resources/DummyApp.app/Info.plist"
+
+      assert_equal "Dummy Bundle", info_plist.display_name
+      assert_equal "com.csquirrel.dummy.bundle", info_plist.bundle_id
+
+  end
+
+  def test_create_with_not_existing_file
+
+    assert_raise RuntimeError do
+      IOSDevTools::ApplicationBundle.new "dummy.file.plist"
+    end
+
+  end
+
+end

metadata

@@ -1,66 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ios_dev_tools
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.1.4
 platform: ruby
-authors: 
+authors:
 - Marcin Maciukiewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-12-28 00:00:00 +00:00
-default_executable: 
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies: []
-
 description: Set of ruby wrappers around iOS dev tasks
 email: mm@csquirrel.com
-executables: 
-- ios_sign
+executables:
+- ios_tool
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/ios_dev_tools.rb
-- lib/ios_dev_tools/application_bundle.rb
-- lib/ios_dev_tools/provisioning_profile.rb
+- lib/ios_dev_tools/commands/help.rb
+- lib/ios_dev_tools/commands/pack.rb
+- lib/ios_dev_tools/commands/sign.rb
+- lib/ios_dev_tools/commands/tool.rb
+- lib/ios_dev_tools/commands/verify.rb
+- lib/ios_dev_tools/model/application_bundle.rb
+- lib/ios_dev_tools/model/info_plist.rb
+- lib/ios_dev_tools/model/provisioning_profile.rb
 - lib/ios_dev_tools/version.rb
-has_rdoc: true
+- test/test_application_bundle.rb
+- test/test_info_plist.rb
+- test/test_provisioning_profile.rb
+- bin/ios_tool
 homepage: https://github.com/cSquirrel/ios-dev-tools
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: nowarning
-rubygems_version: 1.3.6
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: iOS Dev Tools
-test_files: 
+test_files:
 - test/test_application_bundle.rb
+- test/test_info_plist.rb
 - test/test_provisioning_profile.rb

data/bin/ios_sign

@@ -1,126 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'optparse'
-
-begin
-  require 'ios_dev_tools'
-rescue LoadError
-  require 'rubygems'
-  require 'ios_dev_tools'
-end
-
-$be_verbose=false
-
-def verbose_msg message
-
-  puts message if $be_verbose
-
-end
-
-def error_msg message
-
-  puts "\nERROR:\t#{message}\n"
-
-end
-
-def parse_options(args)
-
-  options = Hash.new
-  OptionParser.new do |opts|
-
-    opts.banner = "Usage: ios_sign -i \"iPhone Distribution: Name\" -p path/to/profile -o output/ipa/file [options] inputIpa"
-
-    opts.separator ""
-    opts.separator "Options:"
-
-    opts.on("-p", "--profile PATH_TO_PROFILE", "Path to profile") do |profile_location|
-      options[:profile_location] = profile_location
-    end
-
-    opts.on("-b", "--bundle-id [BUNDLE_IDENTIFIER]", "Bundle identifier") do |bundle_id|
-      options[:bundle_id] = bundle_id
-    end
-
-    opts.on("-o", "--output OUTPUT_IPA_FILE", "Output ipa archive") do |output_ipa|
-      options[:output_ipa] = output_ipa
-    end
-
-    opts.on("-i", "--identity IDENTITY", "Identity") do |identity|
-      options[:identity] = identity
-    end
-
-    opts.on("-t", "--temp [TEMP_FOLDER]", "Temporary folder location") do |temp_folder|
-      options[:temp_folder] = temp_folder
-    end
-
-    opts.separator ""
-    opts.separator "Common options:"
-
-    opts.on("-v", "--verbose", "Run verbosely") do |v|
-      options[:verbose] = v
-    end
-
-    opts.on("--version", "Show version and exit") do |v|
-      puts "Version: #{IOSDevTools::VERSION}"
-      exit
-    end
-
-    # No argument, shows at tail.  This will print an options summary.
-    # Try it and see!
-    opts.on_tail("-h", "--help", "Show this message") do
-      puts opts
-      exit
-    end
-
-  end.parse!(args)
-
-  options[:input_file]=ARGV[0]
-  mandatory=[options[:profile_location],options[:identity],options[:output_ipa],options[:input_file]]
-  expected_number=mandatory.count
-  real_number=mandatory.compact.count
-  if expected_number != real_number
-    # one of mandatory switches is missing
-    # display help and exit
-    parse_options ["-h"]
-  end
-
-  $be_verbose=(options[:verbose]!=nil)
-
-  return options
-end
-
-def main
-
-  options=parse_options ARGV
-
-  verbose_msg "Passed options:\n#{options.inspect}"
-
-  begin
-    provisioning_profile=IOSDevTools::ProvisioningProfile.new options[:profile_location]
-    application_bundle=IOSDevTools::ApplicationBundle.new options[:input_file] do |ab|
-      ab.temp_folder=options[:temp_folder]
-    end
-  rescue => error
-    error_msg error
-    exit 1
-  end
-
-  new_bundle_id = options[:bundle_id]
-  new_bundle_id ||= application_bundle.bundle_id
-
-  if not provisioning_profile.is_compatible_with_bundle_id new_bundle_id
-    error_msg "Provisioning profile identifier [#{provisioning_profile.application_identifier}] is not compatible with bundle identifier [#{new_bundle_id}]\n \
-    \tMaybe you should use -b switch to overwrite the bundle identifier?"
-    exit 1
-  end
-
-  application_bundle.bundle_id = new_bundle_id
-  application_bundle.set_provisioning_profile provisioning_profile.profile_location
-  application_bundle.sign_with_identity options[:identity]
-  application_bundle.package_to_ipa options[:output_ipa]
-
-  puts "\nApplication archive created and signed: #{options[:output_ipa]}"
-
-end
-
-main