cocoapods 0.0.8 → 0.1.0

data/README.md

@@ -20,9 +20,6 @@ For more in depth information see the [wiki][wiki], specifically the page about
 [creating a project that uses CocoaPods][wiki-create].
 
 
-**_NOTE: At the moment [only iOS projects are supported][ticket], but this will
-be fixed in the very near future._**
-
 ## Installing CocoaPods
 
 You’ll need MacRuby. CocoaPods itself installs through RubyGems, the Ruby
@@ -81,7 +78,6 @@ for more info.
 [cocoapods]: https://github.com/alloy/cocoapods
 [cocoapods-specs]: https://github.com/alloy/cocoapods-specs
 [tickets]: https://github.com/alloy/cocoapods/issues
-[ticket]: https://github.com/alloy/cocoapods/issues/3
 [example-spec]: https://github.com/alloy/cocoapods/blob/master/examples/PodSpec.podspec
 [dev-setup]: https://github.com/alloy/cocoapods/wiki/Setting-up-for-development-on-CocoaPods
 [wiki-create]: https://github.com/alloy/cocoapods/wiki/Creating-a-project-that-uses-CocoaPods

data/lib/cocoapods.rb

@@ -1,27 +1,30 @@
 module Pod
-  VERSION = '0.0.8'
+  VERSION = '0.1.0'
 
   class Informative < StandardError
   end
 
-  autoload :Command,       'cocoapods/command'
-  autoload :Config,        'cocoapods/config'
-  autoload :Dependency,    'cocoapods/dependency'
-  autoload :Downloader,    'cocoapods/downloader'
-  autoload :Executable,    'cocoapods/executable'
-  autoload :Installer,     'cocoapods/installer'
-  autoload :Resolver,      'cocoapods/resolver'
-  autoload :Source,        'cocoapods/source'
-  autoload :Spec,          'cocoapods/specification'
-  autoload :Specification, 'cocoapods/specification'
-  autoload :Version,       'cocoapods/version'
+  autoload :BridgeSupportGenerator, 'cocoapods/bridge_support_generator'
+  autoload :Command,                'cocoapods/command'
+  autoload :Config,                 'cocoapods/config'
+  autoload :Dependency,             'cocoapods/dependency'
+  autoload :Downloader,             'cocoapods/downloader'
+  autoload :Executable,             'cocoapods/executable'
+  autoload :Installer,              'cocoapods/installer'
+  autoload :Podfile,                'cocoapods/podfile'
+  autoload :Resolver,               'cocoapods/resolver'
+  autoload :Source,                 'cocoapods/source'
+  autoload :Spec,                   'cocoapods/specification'
+  autoload :Specification,          'cocoapods/specification'
+  autoload :Version,                'cocoapods/version'
 
   module Xcode
-    autoload :Config,      'cocoapods/xcode/config'
-    autoload :Project,     'cocoapods/xcode/project'
+    autoload :Config,               'cocoapods/xcode/config'
+    autoload :CopyResourcesScript,  'cocoapods/xcode/copy_resources_script'
+    autoload :Project,              'cocoapods/xcode/project'
   end
 
-  autoload :Pathname,      'pathname'
+  autoload :Pathname,               'pathname'
 end
 
 class Pathname

data/lib/cocoapods/bridge_support_generator.rb

@@ -0,0 +1,25 @@
+module Pod
+  class BridgeSupportGenerator
+    include Config::Mixin
+
+    extend Executable
+    executable :gen_bridge_metadata
+
+    attr_reader :headers
+
+    def initialize(headers)
+      @headers = headers
+    end
+
+    def search_paths
+      @headers.map { |header| "-I '#{header.dirname}'" }.uniq
+    end
+
+    def create_in(root)
+      puts "==> Generating BridgeSupport metadata file" unless config.silent?
+      file = root + "Pods.bridgesupport"
+      gen_bridge_metadata %{-c "#{search_paths.join(' ')}" -o '#{file}' '#{headers.join("' '")}'}
+      file
+    end
+  end
+end

data/lib/cocoapods/command/install.rb

@@ -30,14 +30,12 @@ module Pod
         spec = nil
         if @podspec
           if @podspec.exist?
-            spec = Specification.from_podspec(@podspec)
+            spec = Specification.from_file(@podspec)
           else
             raise Informative, "The specified podspec `#{@podspec}' doesn't exist."
           end
         else
-          if config.project_podfile
-            spec = Specification.from_podfile(config.project_podfile)
-          else
+          unless spec = config.rootspec
             raise Informative, "No `Podfile' or `.podspec' file found in the current working directory."
           end
         end

data/lib/cocoapods/command/spec.rb

@@ -55,7 +55,7 @@ module Pod
 
       def lint
         file = @name ? Pathname.new(@name) : Pathname.pwd.glob('*.podspec').first
-        spec = Specification.from_podspec(file)
+        spec = Specification.from_file(file)
         spec.validate!
       end
     end

data/lib/cocoapods/config.rb

@@ -10,7 +10,7 @@ module Pod
       @instance = instance
     end
 
-    attr_accessor :repos_dir, :project_pods_root, :clean, :verbose, :silent
+    attr_accessor :repos_dir, :project_pods_root, :rootspec, :clean, :verbose, :silent
     alias_method :clean?,   :clean
     alias_method :verbose?, :verbose
     alias_method :silent?,  :silent
@@ -40,6 +40,28 @@ module Pod
       @project_podfile
     end
 
+    # Returns the spec at the pat returned from `project_podfile`.
+    def rootspec
+      unless @rootspec
+        if project_podfile
+          if project_podfile.basename.to_s == 'Podfile'
+            @rootspec = Podfile.from_file(project_podfile)
+          else
+            @rootspec = Specification.from_file(project_podfile)
+          end
+        end
+      end
+      @rootspec
+    end
+
+    def ios?
+      rootspec.platform == :ios
+    end
+
+    def osx?
+      rootspec.platform == :osx
+    end
+
     module Mixin
       def config
         Config.instance

data/lib/cocoapods/downloader.rb

@@ -47,8 +47,14 @@ module Pod
         end
       end
 
-      def clean
+      def clean(clean_paths = [])
         (@pod_root + '.git').rmtree
+        clean_paths.each do |pattern|
+          pattern = @pod_root + pattern
+          pattern.glob.each do |path|
+            path.rmtree
+          end
+        end if clean_paths
       end
     end
   end

data/lib/cocoapods/executable.rb

@@ -3,11 +3,13 @@ module Pod
     def executable(name)
       define_method(name) do |command|
         if Config.instance.verbose?
+          puts "#{name} #{command}"
           `#{name} #{command} 1>&2`
         else
           `#{name} #{command} 2> /dev/null`
         end
       end
+      private name
     end
   end
 end

data/lib/cocoapods/installer.rb

@@ -1,6 +1,4 @@
 module Pod
-  # TODO the static library needs an extra xcconfig which sets the values from issue #1.
-  # Or we could edit the project.pbxproj file, but that seems like more work...
   class Installer
     include Config::Mixin
 
@@ -16,55 +14,44 @@ module Pod
       dependent_specification_sets.reject(&:only_part_of_other_pod?)
     end
 
-    def source_files
-      source_files = {}
-      build_specification_sets.each do |set|
-        spec = set.specification
-        source_files[spec.name] = []
-        spec.source_files.each do |pattern|
-          pattern = spec.pod_destroot + pattern
-          pattern = pattern + '*.{h,m,mm,c,cpp}' if pattern.directory?
-          pattern.glob.each do |file|
-            source_files[spec.name] << file.relative_path_from(config.project_pods_root)
-          end
-        end
-      end
-      source_files
+    def build_specifications
+      build_specification_sets.map(&:specification)
     end
 
     def xcconfig
       @xcconfig ||= Xcode::Config.new({
-        # In a workspace this is where the static library headers should be found
-        # We could also make this recursive, but let's let the user decide on that.
+        # In a workspace this is where the static library headers should be found.
         'USER_HEADER_SEARCH_PATHS' => '"$(BUILT_PRODUCTS_DIR)/Pods"',
-        # search the user headers
         'ALWAYS_SEARCH_USER_PATHS' => 'YES',
+        # This makes categories from static libraries work, which many libraries
+        # require, so we add these by default.
+        'OTHER_LDFLAGS'            => '-ObjC -all_load',
       })
     end
 
     def xcodeproj
-      @xcodeproj ||= Xcode::Project.ios_static_library
+      @xcodeproj ||= Xcode::Project.static_library(@specification.platform)
     end
 
+    # TODO move xcconfig related code into the xcconfig method, like copy_resources_script and generate_bridge_support.
     def generate_project
       puts "==> Generating Xcode project and xcconfig" unless config.silent?
       user_header_search_paths = []
-      build_specification_sets.each do |set|
-        spec = set.specification
+      build_specifications.each do |spec|
         xcconfig.merge!(spec.xcconfig)
-        xcodeproj.add_group(spec.name)
+        group = xcodeproj.add_pod_group(spec.name)
 
         # Only add implementation files to the compile phase
         spec.implementation_files.each do |file|
-          xcodeproj.add_source_file(file, spec.name, nil, spec.compiler_flags)
+          group.add_source_file(file, nil, spec.compiler_flags)
         end
 
         # Add header files to a `copy header build phase` for each destination
         # directory in the pod's header directory.
-        set.specification.copy_header_mappings.each do |header_dir, files|
-          copy_phase_uuid = xcodeproj.add_copy_header_build_phase(spec.name, header_dir)
+        spec.copy_header_mappings.each do |header_dir, files|
+          copy_phase = xcodeproj.add_copy_header_build_phase(spec.name, header_dir)
           files.each do |file|
-            xcodeproj.add_source_file(file, spec.name, copy_phase_uuid)
+            group.add_source_file(file, copy_phase)
           end
         end
 
@@ -74,16 +61,33 @@ module Pod
       xcconfig.merge!('USER_HEADER_SEARCH_PATHS' => user_header_search_paths.sort.uniq.join(" "))
     end
 
-    # TODO we need a spec that tests that all dependencies are first downloaded/installed
-    # before #generate_project is called!
+    def copy_resources_script
+      @copy_resources_script ||= Xcode::CopyResourcesScript.new(build_specifications.map { |spec| spec.expanded_resources }.flatten)
+    end
+
+    def bridge_support_generator
+      BridgeSupportGenerator.new(build_specifications.map do |spec|
+        spec.header_files.map do |header|
+          config.project_pods_root + header
+        end
+      end.flatten)
+    end
+
     def install!
       puts "Installing dependencies of: #{@specification.defined_in_file}" unless config.silent?
-      build_specification_sets.each do |set|
-         set.specification.install!
-      end
+      build_specifications.each(&:install!)
       generate_project
-      xcodeproj.create_in(config.project_pods_root)
-      xcconfig.create_in(config.project_pods_root)
+
+      root = config.project_pods_root
+      xcodeproj.create_in(root)
+      xcconfig.create_in(root)
+      if @specification.generate_bridge_support?
+        path = bridge_support_generator.create_in(root)
+        copy_resources_script.resources << path.relative_path_from(config.project_pods_root)
+      end
+      copy_resources_script.create_in(root)
+
+      build_specifications.each(&:post_install)
     end
   end
 end

data/lib/cocoapods/podfile.rb

@@ -0,0 +1,99 @@
+module Pod
+  class Podfile
+    def self.from_file(path)
+      podfile = Podfile.new do
+        eval(path.read, nil, path.to_s)
+      end
+      podfile.defined_in_file = path
+      podfile.validate!
+      podfile
+    end
+
+    def initialize(&block)
+      @dependencies = []
+      instance_eval(&block)
+    end
+
+    # Specifies the platform for which a static library should be build.
+    #
+    # This can be either `:osx` for Mac OS X applications, or `:ios` for iOS
+    # applications.
+    def platform(platform = nil)
+      platform ? @platform = platform : @platform
+    end
+
+    # Specifies a dependency of the project.
+    #
+    # A dependency requirement is defined by the name of the Pod and _optionally_
+    # a list of version requirements.
+    #
+    #
+    # When starting out with a project it is likely that you will want to use the
+    # latest version of a Pod. If this is the case, simply omit the version
+    # requirements.
+    #
+    #   dependency 'SSZipArchive'
+    #
+    #
+    # Later on in the project you may want to freeze to a specific version of a
+    # Pod, in which case you can specify that version number.
+    #
+    #   dependency 'Objection', '0.9'
+    #
+    #
+    # Besides no version, or a specific one, it is also possible to use operators:
+    #
+    # * `> 0.1`    Any version higher than 0.1
+    # * `>= 0.1`   Version 0.1 and any higher version
+    # * `< 0.1`    Any version lower than 0.1
+    # * `<= 0.1`   Version 0.1 and any lower version
+    # * `~> 0.1.2` Version 0.1.2 and the versions upto 0.2, not including 0.2
+    #
+    #
+    # Finally, a list of version requirements can be specified for even more fine
+    # grained control.
+    #
+    # For more information, regarding versioning policy, see:
+    #
+    # * http://semver.org
+    # * http://docs.rubygems.org/read/chapter/7
+    def dependency(name, *version_requirements)
+      @dependencies << Dependency.new(name, *version_requirements)
+    end
+
+    attr_reader :dependencies
+
+    # Specifies that a BridgeSupport metadata should be generated from the
+    # headers of all installed Pods.
+    #
+    # This is for scripting languages such as MacRuby, Nu, and JSCocoa, which use
+    # it to bridge types, functions, etc better.
+    def generate_bridge_support!
+      @generate_bridge_support = true
+    end
+
+    # This is to be compatible with a Specification for use in the Installer and
+    # Resolver.
+
+    def podfile?
+      true
+    end
+
+    attr_accessor :defined_in_file
+
+    def generate_bridge_support?
+      @generate_bridge_support
+    end
+
+    def dependency_by_name(name)
+      @dependencies.find { |d| d.name == name }
+    end
+
+    def validate!
+      lines = []
+      lines << "* the `platform` attribute should be either `:osx` or `:ios`" unless [:osx, :ios].include?(@platform)
+      lines << "* no dependencies were specified, which is, well, kinda pointless" if @dependencies.empty?
+      raise(Informative, (["The Podfile at `#{@defined_in_file}' is invalid:"] + lines).join("\n")) unless lines.empty?
+    end
+  end
+end

data/lib/cocoapods/resolver.rb

@@ -12,13 +12,26 @@ module Pod
 
     def find_dependency_sets(specification)
       specification.dependencies.each do |dependency|
-        set = Source.search(dependency)
+        set = find_dependency_set(dependency)
         set.required_by(specification)
         unless @sets.include?(set)
+          validate_platform!(set)
           @sets << set
           find_dependency_sets(set.specification)
         end
       end
     end
+
+    def find_dependency_set(dependency)
+      Source.search(dependency)
+    end
+
+    def validate_platform!(set)
+      spec = set.specification
+      unless spec.platform.nil? || spec.platform == @specification.platform
+        raise Informative, "The platform required by the Podfile (:#{@specification.platform}) " \
+                           "does not match that of #{spec} (:#{spec.platform})"
+      end
+    end
   end
 end

data/lib/cocoapods/specification.rb

@@ -1,21 +1,15 @@
 module Pod
+  extend Config::Mixin
+
   def self._eval_podspec(path)
     eval(path.read, nil, path.to_s)
   end
 
- class Specification
+  class Specification
     autoload :Set, 'cocoapods/specification/set'
 
-    def self.from_podfile(path)
-      if path.exist?
-        spec = new
-        spec.instance_eval(path.read)
-        spec.defined_in_file = path
-        spec
-      end
-    end
-
-    def self.from_podspec(path)
+    # The file is expected to define and return a Pods::Specification.
+    def self.from_file(path)
       spec = Pod._eval_podspec(path)
       spec.defined_in_file = path
       spec
@@ -70,17 +64,20 @@ module Pod
     end
 
     def source_files=(*patterns)
-      @source_files = patterns.flatten.map { |p| Pathname.new(p) }
+      @source_files = patterns.flatten
     end
     attr_reader :source_files
 
-    def dependency(*name_and_version_requirements)
-      name, *version_requirements = name_and_version_requirements.flatten
-      dep = Dependency.new(name, *version_requirements)
-      @dependencies << dep
-      dep
+    def resources=(*patterns)
+      @resources = patterns.flatten
     end
-    attr_reader :dependencies
+    attr_reader :resources
+    alias_method :resource=, :resources=
+
+    def clean_paths=(*patterns)
+      @clean_paths = patterns.flatten.map { |p| Pathname.new(p) }
+    end
+    attr_reader :clean_paths
 
     def xcconfig=(hash)
       @xcconfig.merge!(hash)
@@ -95,7 +92,7 @@ module Pod
 
     def libraries=(*libraries)
       libraries.unshift('')
-      self.xcconfig = { 'OTHER_LDFLAGS' => libraries.join(' -l ').strip }
+      self.xcconfig = { 'OTHER_LDFLAGS' => libraries.join(' -l').strip }
     end
     alias_method :library=, :libraries=
 
@@ -106,8 +103,6 @@ module Pod
       @header_dir || pod_destroot_name
     end
 
-    attr_accessor :requires_arc
-
     attr_writer :compiler_flags
     def compiler_flags
       flags = "#{@compiler_flags} "
@@ -115,14 +110,31 @@ module Pod
       flags
     end
 
+    # These are attributes which are also on a Podfile
+
+    attr_accessor :platform
+
+    attr_accessor :requires_arc
+
+    attr_accessor :generate_bridge_support
+    alias_method :generate_bridge_support?, :generate_bridge_support
+
+    def dependency(*name_and_version_requirements)
+      name, *version_requirements = name_and_version_requirements.flatten
+      dep = Dependency.new(name, *version_requirements)
+      @dependencies << dep
+      dep
+    end
+    attr_reader :dependencies
+
     # Not attributes
 
     include Config::Mixin
 
     def ==(other)
       self.class === other &&
-        @name && @name == other.name &&
-          @version && @version == other.version
+        name && name == other.name &&
+          version && version == other.version
     end
 
     def dependency_by_name(name)
@@ -130,8 +142,8 @@ module Pod
     end
 
     def part_of_specification_set
-      if @part_of
-        Set.by_specification_name(@part_of.name)
+      if part_of
+        Set.by_specification_name(part_of.name)
       end
     end
 
@@ -141,7 +153,6 @@ module Pod
     end
 
     def pod_destroot
-      return if from_podfile?
       if part_of_other_pod?
         part_of_specification.pod_destroot
       else
@@ -156,17 +167,32 @@ module Pod
     end
 
     def part_of_other_pod?
-      !@part_of.nil?
+      !part_of.nil?
     end
 
-    def from_podfile?
-      @name.nil? && @version.nil?
+    def podfile?
+      false
     end
 
-    # Returns all source files of this pod including header files.
+    # Returns all resource files of this pod, but relative to the
+    # project pods root.
+    def expanded_resources
+      files = []
+      [*resources].each do |pattern|
+        pattern = pod_destroot + pattern
+        pattern = pattern + '*' if pattern.directory?
+        pattern.glob.each do |file|
+          files << file.relative_path_from(config.project_pods_root)
+        end
+      end
+      files
+    end
+
+    # Returns all source files of this pod including header files,
+    # but relative to the project pods root.
     def expanded_source_files
       files = []
-      source_files.each do |pattern|
+      [*source_files].each do |pattern|
         pattern = pod_destroot + pattern
         pattern = pattern + '*.{h,m,mm,c,cpp}' if pattern.directory?
         pattern.glob.each do |file|
@@ -215,11 +241,7 @@ module Pod
     end
 
     def to_s
-      if from_podfile?
-        "podfile at `#{@defined_in_file}'"
-      else
-        "`#{@name}' version `#{@version}'"
-      end
+      "`#{name}' version `#{version}'"
     end
 
     def inspect
@@ -227,18 +249,24 @@ module Pod
     end
 
     def validate!
-      attrs = []
-      attrs << "`name'"                       unless @name
-      attrs << "`version'"                    unless @version
-      attrs << "`summary'"                    unless @summary
-      attrs << "`homepage'"                   unless @homepage
-      attrs << "`author(s)'"                  unless @authors
-      attrs << "either `source' or `part_of'" unless @source || @part_of
-      attrs << "`source_files'"               unless @source_files
-      unless attrs.empty?
-        raise Informative, "The following required " \
-          "#{attrs.size == 1 ? 'attribute is' : 'attributes are'} " \
-          "missing: #{attrs.join(", ")}"
+      missing = []
+      missing << "`name'"                       unless name
+      missing << "`version'"                    unless version
+      missing << "`summary'"                    unless summary
+      missing << "`homepage'"                   unless homepage
+      missing << "`author(s)'"                  unless authors
+      missing << "either `source' or `part_of'" unless source || part_of
+      missing << "`source_files'"               unless source_files
+
+      incorrect = []
+      allowed = [nil, :ios, :osx]
+      incorrect << ["`platform'", allowed] unless allowed.include?(platform)
+
+      unless missing.empty? && incorrect.empty?
+        message = "The following #{(missing + incorrect).size == 1 ? 'attribute is' : 'attributes are'}:\n"
+        message << "* missing: #{missing.join(", ")}" unless missing.empty?
+        message << "* incorrect: #{incorrect.map { |x| "#{x[0]} (#{x[1..-1]})" }.join(", ")}" unless incorrect.empty?
+        raise Informative, message
       end
     end
 
@@ -249,8 +277,8 @@ module Pod
     # Override this if you need to perform work before or after activating the
     # pod. Eg:
     #
-    #   Pod::Spec.new do
-    #     def install!
+    #   Pod::Spec.new do |s|
+    #     def s.install!
     #       # pre-install
     #       super
     #       # post-install
@@ -260,7 +288,7 @@ module Pod
       puts "==> Installing: #{self}" unless config.silent?
       config.project_pods_root.mkpath
       require 'fileutils'
-      FileUtils.cp(@defined_in_file, config.project_pods_root)
+      FileUtils.cp(defined_in_file, config.project_pods_root)
 
       # In case this spec is part of another pod's source, we need to dowload
       # the other pod's source.
@@ -282,17 +310,32 @@ module Pod
     # Override this if you need to perform work before or after downloading the
     # pod, or if you need to implement custom dowloading. Eg:
     #
-    #   Pod::Spec.new do
-    #     def download!
+    #   Pod::Spec.new do |s|
+    #     def s.download!
     #       # pre-download
     #       super # or custom downloading
     #       # post-download
     #     end
     #   end
     def download!
-      downloader = Downloader.for_source(pod_destroot, @source)
+      downloader = Downloader.for_source(pod_destroot, source)
       downloader.download
-      downloader.clean if config.clean
+      downloader.clean(clean_paths) if config.clean
+    end
+
+    # This is a convenience method which gets called after all pods have been
+    # downloaded, installed, and the Xcode project and related files have been
+    # generated. Override this to, for instance, add to the prefix header:
+    #
+    #   Pod::Spec.new do |s|
+    #     def s.post_install
+    #       prefix_header = config.project_pods_root + 'Pods-Prefix.pch'
+    #       prefix_header.open('a') do |file|
+    #         file.puts(%{#ifdef __OBJC__\n#import "SSToolkitDefines.h"\n#endif})
+    #       end
+    #     end
+    #   end
+    def post_install
     end
 
   end