cocoapods-core 0.17.0.rc1

data/lib/cocoapods-core/podfile.rb

@@ -0,0 +1,345 @@
+require 'cocoapods-core/podfile/dsl'
+require 'cocoapods-core/podfile/target_definition'
+
+module Pod
+
+  # The Podfile is a specification that describes the dependencies of the
+  # targets of an Xcode project.
+  #
+  # It supports its own DSL and generally is stored in files named
+  # `CocoaPods.podfile` or `Podfile`.
+  #
+  # The Podfile creates a hierarchy of target definitions that that store the
+  # information of necessary to generate the CocoaPods libraries.
+  #
+  class Podfile
+
+    # @!group DSL support
+
+    include Pod::Podfile::DSL
+
+    #-------------------------------------------------------------------------#
+
+    class Pod::Podfile::StandardError < StandardError; end
+
+    #-------------------------------------------------------------------------#
+
+    # @return [Pathname] the path where the podfile was loaded from. It is nil
+    #         if the podfile was generated programmatically.
+    #
+    attr_accessor :defined_in_file
+
+    # @param    [Pathname] defined_in_file
+    #           the path of the podfile.
+    #
+    # @param    [Proc] block
+    #           an optional block that configures the podfile through the DSL.
+    #
+    # @example  Creating a Podfile.
+    #
+    #           platform :ios, "6.0"
+    #           target :my_app do
+    #             pod "AFNetworking", "~> 1.0"
+    #           end
+    #
+    def initialize(defined_in_file = nil, internal_hash = {}, &block)
+      self.defined_in_file = defined_in_file
+      @internal_hash = internal_hash
+      if block
+        default_target_def = TargetDefinition.new(:default, self)
+        @root_target_definitions = [default_target_def]
+        @current_target_definition = default_target_def
+        instance_eval(&block)
+      else
+        @root_target_definitions = []
+      end
+    end
+
+    # @return [String] a string useful to represent the Podfile in a message
+    #         presented to the user.
+    #
+    def to_s
+      "Podfile"
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Working with a podfile
+
+    # @return [Hash{Symbol,String => TargetDefinition}] the target definitions
+    #         of the podfile stored by their name.
+    #
+    def target_definitions
+      Hash[target_definition_list.map { |td| [td.name, td] }]
+    end
+
+    def target_definition_list
+      root_target_definitions.map { |td| [td, td.recursive_children] }.flatten
+    end
+
+    # @return [Array<TargetDefinition>] The root target definition.
+    #
+    attr_accessor :root_target_definitions
+
+    # @return [Array<Dependency>] the dependencies of the all the target
+    #         definitions.
+    #
+    def dependencies
+      target_definition_list.map(&:dependencies).flatten.uniq
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Attributes
+
+    # @return [String] the path of the workspace if specified by the user.
+    #
+    def workspace_path
+      path = get_hash_value('workspace')
+      if path
+        if File.extname(path) == '.xcworkspace'
+          path
+        else
+          "#{path}.xcworkspace"
+        end
+      end
+    end
+
+    # @return [Bool] whether the podfile should generate a BridgeSupport
+    #         metadata document.
+    #
+    def generate_bridge_support?
+      get_hash_value('generate_bridge_support')
+    end
+
+    # @return [Bool] whether the -fobjc-arc flag should be added to the
+    #         OTHER_LD_FLAGS.
+    #
+    def set_arc_compatibility_flag?
+      get_hash_value('set_arc_compatibility_flag')
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Hooks
+
+    # Calls the pre install callback if defined.
+    #
+    # @param  [Pod::Installer] installer
+    #         the installer that is performing the installation.
+    #
+    # @return [Bool] whether a pre install callback was specified and it was
+    #         called.
+    #
+    def pre_install!(installer)
+      if @pre_install_callback
+        @pre_install_callback.call(installer)
+        true
+      else
+        false
+      end
+    end
+
+    # Calls the post install callback if defined.
+    #
+    # @param  [Pod::Installer] installer
+    #         the installer that is performing the installation.
+    #
+    # @return [Bool] whether a post install callback was specified and it was
+    #         called.
+    #
+    def post_install!(installer)
+      if @post_install_callback
+        @post_install_callback.call(installer)
+        true
+      else
+        false
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Representations
+
+    # @return [Array] The keys used by the hash representation of the Podfile.
+    #
+    HASH_KEYS = [
+      'target_definitions',
+      'workspace',
+      'generate_bridge_support',
+      'set_arc_compatibility_flag',
+    ].freeze
+
+    # @return [Hash] The hash representation of the Podfile.
+    #
+    def to_hash
+      hash = {}
+      hash['target_definitions'] = Hash[root_target_definitions.map { |child| [child.name, child.to_hash] }]
+      hash.merge!(internal_hash)
+      hash
+    end
+
+    # @return [String] The YAML representation of the Podfile.
+    #
+    def to_yaml
+      to_hash.to_yaml
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Class methods
+
+    # Initializes a podfile from the file with the given path.
+    #
+    # @param  [Pathname] path
+    #         the path from where the podfile should be loaded.
+    #
+    # @return [Podfile] the generated podfile.
+    #
+    def self.from_file(path)
+      path = Pathname.new(path)
+      unless path.exist?
+        raise StandardError, "No Podfile exists at path `#{path}`."
+      end
+      string = File.open(path, 'r:utf-8')  { |f| f.read }
+      # Work around for Rubinius incomplete encoding in 1.9 mode
+      if string.respond_to?(:encoding) && string.encoding.name != "UTF-8"
+        string.encode!('UTF-8')
+      end
+
+      case path.extname
+      when ''
+        Podfile.from_ruby(string, path)
+      when '.yaml', '.cocoapods'
+        Podfile.from_yaml(string, path)
+      else
+        raise StandardError, "Unsupported Podfile format `#{path}`."
+      end
+    end
+
+    # Configures a new Podfile from the given ruby string.
+    #
+    # @param  [String] string
+    #         The ruby string which will configure the podfile with the DSL.
+    #
+    # @param  [Pathname] path
+    #         The path from which the Podfile is loaded.
+    #
+    # @return [Podfile] the new Podfile
+    #
+    def self.from_ruby(string, path = nil)
+      podfile = Podfile.new(path) do
+        begin
+          eval(string, nil, path.to_s)
+        rescue Exception => e
+          raise DSLError.new("Invalid `#{path.basename}` file: #{e.message}", path, e.backtrace)
+        end
+      end
+      podfile
+    end
+
+    # Configures a new Podfile from the given hash.
+    #
+    # @param  [Hash] hash
+    #         The hash which contains the information of the Podfile.
+    #
+    # @param  [Pathname] path
+    #         The path from which the Podfile is loaded.
+    #
+    # @return [Podfile] the new Podfile
+    #
+    def self.from_hash(hash, path = nil)
+      internal_hash = hash.dup
+      target_definitions = internal_hash.delete('target_definitions') || []
+      podfile = Podfile.new(path,internal_hash)
+      target_definitions.each do |name, definition_hash|
+        definition = TargetDefinition.from_hash(name, definition_hash, podfile)
+        podfile.root_target_definitions << definition
+      end
+      podfile
+    end
+
+    # Configures a new Podfile from the given YAML representation.
+    #
+    # @param  [String] yaml
+    #         The YAML encoded hash which contains the information of the
+    #         Podfile.
+    #
+    # @param  [Pathname] path
+    #         The path from which the Podfile is loaded.
+    #
+    # @return [Podfile] the new Podfile
+    #
+    def self.from_yaml(yaml, path = nil)
+      hash = YAML.load(yaml)
+      from_hash(hash)
+    end
+
+    #-------------------------------------------------------------------------#
+
+    private
+
+    # @!group Private helpers
+
+    # @return [Hash] The hash which store the attributes of the Podfile.
+    #
+    attr_accessor :internal_hash
+
+    # Set a value in the internal hash of the Podfile for the given key.
+    #
+    # @param  [String] key
+    #         The key for which to store the value.
+    #
+    # @param  [Object] value
+    #         The value to store.
+    #
+    # @raise  If the key is not recognized.
+    #
+    # @return [void]
+    #
+    def set_hash_value(key, value)
+      raise StandardError, "Unsupported hash key `#{key}`" unless HASH_KEYS.include?(key)
+      internal_hash[key] = value
+    end
+
+    # Returns the value for the given key in the internal hash of the Podfile.
+    #
+    # @param  [String] key
+    #         The key for which the value is needed.
+    #
+    # @raise  If the key is not recognized.
+    #
+    # @return [Object] The value for the key.
+    #
+    def get_hash_value(key)
+      raise StandardError, "Unsupported hash key `#{key}`" unless HASH_KEYS.include?(key)
+      internal_hash[key]
+    end
+
+    # @return [TargetDefinition] The current target definition to which the DSL
+    #         commands apply.
+    #
+    attr_accessor :current_target_definition
+
+    #-------------------------------------------------------------------------#
+
+    # @deprecated Deprecated in favour of the more succinct {#pod}. Remove for
+    #             CocoaPods 1.0.
+    #
+    def dependency(name = nil, *requirements, &block)
+      warn "[DEPRECATED] `dependency' is deprecated (use `pod')"
+      pod(name, *requirements, &block)
+    end
+
+  end
+end

data/lib/cocoapods-core/requirement.rb

@@ -0,0 +1,15 @@
+module Pod
+
+  # A Requirement is a set of one or more version restrictions of a
+  # {Dependency}.
+  #
+  # It is based on the RubyGems class adapted to support CocoaPods specific
+  # information.
+  #
+  # @todo Move support about external sources and head information here from
+  #       the Dependency class.
+  #
+  class Requirement < Pod::Vendor::Gem::Requirement
+  end
+
+end

data/lib/cocoapods-core/source/validator.rb

@@ -0,0 +1,183 @@
+module Pod
+  class Source
+
+    # TODO: THIS CLASS IS A STUB
+
+    # Checks whether a podspec can be accepted by a source.
+    #
+    # This class can work on Travis but some checks are lost as the repo is
+    # already merged during the test.
+    #
+    class Validator
+
+      # @return [Source] the source where the podspec should be added.
+      #
+      attr_reader :source
+
+      # @param  [Pathname] repo @see Source#repo.
+      #
+      def initialize(repo)
+        @source = Source.new(repo)
+        @errors = {}
+        @linter_results = {}
+      end
+
+      # @param  [Array<Pathname>] spec_paths
+      #         a list of path that should be checked for being accepted in
+      #         specs repo.
+      #
+      # @return [Bool] whether to podspec can be accepted by the source.
+      #
+      def check(spec_paths)
+        spec_paths = [ spec_paths ] unless spec_paths.is_a?(Array)
+        @errors = {}
+        spec_paths.each do |path|
+          @spec_path = Pathname.new(path)
+          lint
+          next unless spec
+          # check_spec_path
+          check_spec_source_change
+          check_if_untagged_version_is_acceptable
+          check_commit_change_for_untagged_version
+          check_dependencies
+        end
+        errors.values.empty?
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Validation results
+
+      public
+
+
+      # @return [Hash{Pathname=>Array<String>}] the errors generated by the
+      #         validation. If there is any error the podspec cannot be
+      #         accepted.
+      #
+      attr_reader :errors
+
+      # @return [Hash{Pathname=>Array<Specification::Linter::Result>}] the
+      #         result generated by the linter for not approved specifications.
+      #
+      attr_reader :linter_results
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Validation helpers
+
+      private
+
+      # @return [Pathname] The path of the current specification that should be
+      #         checked.
+      #
+      attr_reader :spec_path
+
+      # @return [Specification] The current specification that should be
+      #         checked.
+      #
+      # @note   The specification is generated by the linter that catches any
+      #         exception.
+      #
+      attr_reader :spec
+
+
+      #
+      #
+      def error(message)
+        @errors[spec_path] ||= []
+        @errors[spec_path] << message
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Check steps
+
+      private
+
+      def lint
+        linter = Specification::Linter.new(spec_path)
+        if linter.lint
+          @spec = linter.spec
+        else
+          error 'Linter failed validation.'
+        end
+      end
+
+      # TODO: this check cannot be performed before a merge.
+      def check_spec_path
+        expected = "#{spec.name}/#{spec.version}/#{spec.name}.podspec"
+        relative_path = spec_path.relative_path_from(source.repo).to_s
+        unless relative_path == expected
+          error "Incorrect path, the path is `#{relative_path}` and should be `#{expected}`."
+        end
+      end
+
+      def check_spec_source_change
+        return unless spec
+        return unless reference_spec
+        keys = Spec::DSL::SOURCE_KEYS.keys
+        source = spec.source.values_at(*keys).compact.first
+        old_source = reference_spec.source.values_at(*keys).compact.first
+        unless source == old_source
+          error "Attempt to change the source of the specification. " \
+            "Source: `#{source}`. Previous: `#{old_source}`.\n " \
+            "Contact specs repos maintainers if the library changed location."
+        end
+      end
+
+      def check_if_untagged_version_is_acceptable
+        return unless spec
+        return if !spec.source[:git] || spec.source[:tag]
+
+        # Allow to fix a 0.0.1 podspec
+        if !related_specifications.any? { |s| s.version == '0.0.1' }
+          error "There is already versioned specifications so " \
+            "untagged versions cannot be added."
+        elsif spec.version != Version.new('0.0.1')
+          error "Untagged Git repositories should be versioned as 0.0.1"
+        end
+      end
+
+      # TODO: this cannot be tested on Travis with the current setup
+      def check_commit_change_for_untagged_version
+        return unless spec
+        return unless spec.version == Version.new('0.0.1')
+        ref_spec = related_specifications.find { |s| s.version != '0.0.1' }
+        return unless ref_spec
+        unless ref_spec.source[:commit] == spec.source[:commit]
+          error "Attempt to rewrite the commit of 0.0.1 version."
+        end
+      end
+
+      def check_dependencies
+        return unless spec
+        spec.external_dependencies(true).each do |dep|
+          set = source.search(dep)
+          unless set && set.specification
+            error "Unable to find a specification for the `#{dep}` dependency."
+          end
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group Source helpers
+
+      private
+
+      def related_specifications
+        versions = source.versions(spec.name)
+        return unless versions
+        specs = versions.sort.map { |v| source.specification(spec.name, v) }
+        specs.reject { |s| s.defined_in_file == spec_path }
+      end
+
+      def reference_spec
+        specs = related_specifications
+        specs.last if specs
+      end
+
+    end
+  end
+end