php-composer 0.4.5 → 1.0.0.pre.alpha11

data/lib/composer/package/loader/hash_loader/package_attribute_loaders.rb

@@ -0,0 +1,181 @@
+#
+# This file was ported to ruby from Composer php source code.
+#
+# Original Source: Composer\Package\Loader\ArrayLoader.php
+# Ref SHA: a1427d7fd626d4308c190a267dd7a993f87c6a2a
+#
+# (c) Nils Adermann <naderman@naderman.de>
+#     Jordi Boggiano <j.boggiano@seld.be>
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+
+module Composer
+  module Package
+    module Loader
+      class HashLoader
+
+        attr_loader :type do |config, package|
+          if config.key? 'type'
+            package.type = config['type'].downcase
+          else
+            package.type = 'library'
+          end
+        end
+
+        attr_loader :target_dir
+
+        attr_loader :extra do |config, package|
+          if config.key?('extra') && config['extra'].is_a?(Hash)
+            package.extra = config['extra']
+          end
+        end
+
+        attr_loader :binaries do |config, package|
+          if config.key?('bin')
+            unless config['bin'].is_a?(Array)
+              raise UnexpectedValueError,
+                    "Package #{config['name']}'s bin key should be an hash,\n
+                    #{config['bin'].class.name} given."
+            end
+            config['bin'].each do |bin|
+              bin.gsub!(/^\/+/, '')
+            end
+            package.binaries = config['bin']
+          end
+        end
+
+        attr_loader :installation_source
+
+        attr_loader :source do |config, package|
+          if config.key?('source')
+            if [:type, :url, :reference].all? {|k| config['source'].key? k}
+              raise UnexpectedValueError,
+                    "Package #{config['name']}'s source key should be specified as\n
+                    {\"type\": ..., \"url\": ..., \"reference\": ...}, \n
+                    #{config['source'].to_json} given."
+            end
+            package.source_type = config['source']['type']
+            package.source_url = config['source']['url']
+            package.source_reference = config['source']['reference']
+            if config['source'].key?('mirrors')
+              package.source_mirrors = config['source']['mirrors']
+            end
+          end
+        end
+
+        attr_loader :dist do |config, package|
+          if config.key?('dist')
+            if [:type, :url].all? {|k| config['dist'].key? k}
+              raise UnexpectedValueError,
+                    "Package #{config['name']}'s dist key should be specified as\n
+                    {\"type\": ..., \"url\": ..., \"reference\": ..., \"shasum\": ...},\n
+                    #{config['dist'].to_json} given."
+            end
+            package.dist_type = config['dist']['type']
+            package.dist_url = config['dist']['url']
+            package.dist_reference = config['dist'].key?('reference') ? config['dist']['reference'] : nil
+            package.dist_sha1_checksum = config['dist'].key?('shasum') ? config['dist']['shasum'] : nil
+            if config['dist'].key?('mirrors')
+              package.dist_mirrors = config['dist']['mirrors']
+            end
+          end
+        end
+
+        SUPPORTED_LINK_TYPES.each do |type, opts|
+          attr_loader opts[:method] do |config, package|
+            if config.key?(type)
+              package.send(
+                "#{opts[:method]}=",
+                parse_links(
+                  package.name,
+                  package.pretty_version,
+                  opts[:description],
+                  config[type]
+                )
+              )
+            end
+          end
+        end
+
+        attr_loader :suggests do |config, package|
+          if config.key?('suggest') && config['suggest'].is_a?(Hash)
+            config['suggest'].each do |target, reason|
+              if 'self.version' === reason.strip!
+                config['suggest'][target] = package.pretty_version
+              end
+            end
+            package.suggests = config['suggest']
+          end
+        end
+
+        attr_loader :autoload
+
+        attr_loader :dev_autoload, from: 'autoload-dev'
+
+        attr_loader :include_paths, from: 'include-path'
+
+        attr_loader :release_date, from: 'time' do |config, package|
+          if config.key?('time')
+            unless config['time'].empty?
+              time = config['time'] =~ /[[:digit:]]/ ? "@#{config['time']}" : config['time']
+              date = Time.zone.parse(time) rescue false
+              package.release_date = date unless date
+            end
+          end
+        end
+
+        attr_loader :notification_url do |config, package|
+          if config.key?('notification-url')
+            unless config['notification-url'].empty?
+              package.notification_url = config['notification-url']
+            end
+          end
+        end
+
+        attr_loader :archive_excludes do |config, package|
+          if config.key?('archive')
+            if config['archive'].key?('exclude')
+              unless config['archive']['exclude'].empty?
+                package.archive_excludes = config['archive']['exclude']
+              end
+            end
+          end
+        end
+
+        ##
+        # @param  source string
+        #   The source package name
+        # @param  source_version string
+        #   The source package version (pretty version ideally)
+        # @param  description string
+        #   The link description (e.g. requires, replaces, ..)
+        # @param  links hash
+        #   The hash of package name => constraint mappings
+        #
+        # @return Link{}
+        ##
+        def parse_links(source, source_version, description, links)
+          res = {}
+          links.each do |target, constraint|
+            if 'self.version' === constraint
+              parsed_constraint = @version_parser.parse_constraints(source_version)
+            else
+              parsed_constraint = @version_parser.parse_constraints(constraint)
+            end
+            res[target.downcase] = Composer::Package::Link.new(
+              source,
+              target,
+              parsed_constraint,
+              description,
+              constraint
+            )
+          end
+          res
+        end
+
+      end
+    end
+  end
+end

data/lib/composer/package/loader/hash_loader/root_package_attribute_loaders.rb

@@ -0,0 +1,32 @@
+#
+# This file was ported to ruby from Composer php source code.
+#
+# Original Source: Composer\Package\Loader\ArrayLoader.php
+# Ref SHA: a1427d7fd626d4308c190a267dd7a993f87c6a2a
+#
+# (c) Nils Adermann <naderman@naderman.de>
+#     Jordi Boggiano <j.boggiano@seld.be>
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+
+module Composer
+  module Package
+    module Loader
+      class HashLoader
+
+        # on_load ::Composer::Package::RootPackage do |config, package|
+        #
+        #   if config.key?('minimum-stabitily')
+        #     package.minimum_stability = config['minimum-stability']
+        #   end
+        #
+        # end
+
+        attr_loader :minimum_stability
+
+      end
+    end
+  end
+end

data/lib/composer/package/loader/json_loader.rb

@@ -1,6 +1,8 @@
 #
 # This file was ported to ruby from Composer php source code.
+#
 # Original Source: Composer\Package\Loader\JsonLoader.php
+# Ref SHA: ef637c8f1a894157e2f012ad3571183f12fde19f
 #
 # (c) Nils Adermann <naderman@naderman.de>
 #     Jordi Boggiano <j.boggiano@seld.be>
@@ -26,17 +28,13 @@ module Composer
         # Param:  string|JsonFile json A filename, json string or JsonFile instance to load the package from
         # Returns: Composer::Package::Package
         def load(json)
-          if json.instance_of?(Composer::Json::JsonFile)
+          if json.kind_of? ::Composer::Json::JsonFile
             config = json.read
           elsif File.exists?(json)
-            config = Composer::Json::JsonFile.parse_json(
-              File.open(filepath, "r") { |f| f.read },
-              json
-            )
-          elsif json.class === "String"
-            config = Composer::Json::JsonFile.parse_json(
-              json
-            )
+            content = File.open(json, 'r') { |f| f.read }
+            config = ::Composer::Json::JsonFile.parse_json content, json
+          elsif json.is_a? String
+            config = ::Composer::Json::JsonFile.parse_json json
           end
           @loader.load(config)
         end

data/lib/composer/package/package.rb

@@ -9,41 +9,106 @@
 # file that was distributed with this source code.
 #
 
+require 'composer/semver'
+
 module Composer
   module Package
 
-    # Core package definitions that are needed to resolve dependencies
-    # and install packages
-    class Package < Composer::Package::BasePackage
+    SUPPORTED_LINK_TYPES = {
+        'require' => {
+            description: 'requires',
+            method: 'requires'
+        },
+        'conflict' => {
+            description: 'conflicts',
+            method: 'conflicts'
+        },
+        'provide' => {
+            description: 'provides',
+            method: 'provides'
+        },
+        'replace' => {
+            description: 'replaces',
+            method: 'replaces'
+        },
+        'require-dev' => {
+            description: 'requires (for development)',
+            method: 'dev_requires'
+        }
+    }.freeze
 
-      attr_reader :stability
+    STABILITY_STABLE  = 0
+    STABILITY_RC      = 5
+    STABILITY_BETA    = 10
+    STABILITY_ALPHA   = 15
+    STABILITY_DEV     = 20
 
-      attr_accessor :installation_source, :source_type,
-                    :source_url, :source_reference, :source_mirrors, :dist_type,
-                    :dist_url, :dist_reference, :dist_sha1_checksum,
-                    :dist_mirrors, :release_date, :extra, :binaries, :requires,
-                    :conflicts, :provides, :replaces, :dev_requires, :suggests,
-                    :autoload, :dev_autoload, :include_paths, :archive_excludes,
-                    :notification_url
-
-      # complete package attributes
+    STABILITIES = {
+      'stable' => STABILITY_STABLE,
+      'RC'     => STABILITY_RC,
+      'beta'   => STABILITY_BETA,
+      'alpha'  => STABILITY_ALPHA,
+      'dev'    => STABILITY_DEV,
+    }.freeze()
 
+    ##
+    # Core package definitions that are needed to resolve dependencies
+    # and install packages
+    ##
+    class Package
 
+      ##
       # Creates a new in memory package.
-      # Param: string name          The package's name
-      # Param: string version       The package's version
-      # Param: string prettyVersion The package's non-normalized version
+      #
+      # @param name string
+      #   The package's name
+      # @param version string
+      #   The package's version
+      # @param: pretty_version string
+      #   The package's non-normalized version
+      ##
       def initialize(name, version, pretty_version)
-        super(name)
+
+        @pretty_name = name
+        @name = name.downcase
+        @id = -1
+        @transport_options = []
+        @repository = nil
+        @type = nil
 
         # default values
+        @type = nil
+        @target_dir = nil
+        @installation_source = nil
+        @source_type = nil
+        @source_url = nil
+        @source_reference = nil
+        @source_mirrors = nil
+        @dist_type = nil
+        @dist_url = nil
+        @dist_reference = nil
+        @dist_sha1_checksum = nil
+        @dist_mirrors = nil
+        @version = nil
+        @pretty_version = nil
+        @release_date = nil
         @extra = {}
         @binaries = []
+        @dev = nil
+        @stability = nil
+        @notification_url = nil
+
+        # @var Hash of package name => Link
         @requires = {}
+        # @var Hash of package name => Link
         @conflicts = {}
+        # @var Hash of package name => Link
         @provides = {}
+        # @var Hash of package name => Link
         @replaces = {}
+        # @var Hash of package name => Link
         @dev_requires = {}
+
         @suggests = {}
         @autoload = {}
         @dev_autoload = {}
@@ -55,62 +120,565 @@ module Composer
 
       end
 
-      def attributes
-        dumper = Composer::Package::Dumper::HashDumper.new
-        dumper.dump(self)
+      ##
+      # Returns whether the package is a development virtual package or a concrete one
+      # @return bool
+      ##
+      def is_dev?
+        @dev
       end
 
-      # Set package type
-      # Param: string type
-      def type=(type)
-        @type = type
+      ##
+      # Allows the solver to set an id for this package to refer to it.
+      #
+      # @param id integer
+      ##
+      attr_writer :id
+
+      ##
+      # Retrieves the package's id
+      #
+      # @return int The previously set package id
+      ##
+      attr_reader :id
+
+      ##
+      # Get the package name
+      #
+      # @return string
+      ##
+      attr_reader :name
+
+      ##
+      # Get the package pretty name
+      #
+      # @return string
+      ##
+      attr_reader :pretty_name
+
+      ##
+      # Returns a set of names that could refer to this package
+      #
+      # No version or release type information should be included in any of the
+      # names. Provided or replaced package names need to be returned as well.
+      #
+      # @return array An array of strings referring to this package
+      ##
+      def names
+        names = {}
+
+        names[name] = true
+
+        provides.each do |link|
+          names[link.target] = true
+        end
+
+        replaces.each do |link|
+          names[link.target] = true
+        end
+
+        names.keys
       end
 
-      # Get package type
-      # Return: string
+
+      ##
+      # Set the package type.
+      # @param type string
+      ##
+      attr_writer :type
+
+      ##
+      # Get package type.
+      # @return string
       def type
         @type ? @type : 'library'
       end
 
-      def target_dir=(target_dir)
-        @target_dir = target_dir
+      ##
+      # Get the package stability.
+      #
+      # @return string|nil
+      ##
+      attr_reader :stability
+
+      ##
+      # Get the package stability priority.
+      ##
+      def stability_priority
+        ::Composer::Package::STABILITIES[stability]
       end
 
+      ##
+      # Set the target directory
+      # @param target_dir string
+      ##
+      attr_writer :target_dir
+
+      ##
+      # Get target directory
+      # @return string| nil
+      #
       def target_dir
-        return unless @target_dir
+        return if @target_dir.nil?
         regex = '(?:^|[\\\\/]+)\.\.?(?:[\\\\/]+|$)(?:\.\.?(?:[\\\\/]+|$))*'
         @target_dir.gsub(/#{regex}/x, '/').gsub(/^\/+/, '')
       end
 
-      # Returns package unique name, constructed from name, version and
-      # release type.
-      # Return: string
-      def unique_name
-        "#{name}-#{version}"
+      ##
+      # Set the package extra
+      # @param extra Hash
+      ##
+      attr_writer :extra
+
+      ##
+      # Get the package extra
+      # @return Hash
+      ##
+      attr_reader :extra
+
+      ##
+      # Set the package binaries
+      # @param binaries Array
+      ##
+      attr_writer :binaries
+
+      ##
+      # Get the package binaries
+      # @return Hash|nil
+      ##
+      attr_reader :binaries
+
+      ##
+      # Set the package installation source
+      # @param installation_source string
+      ##
+      attr_writer :installation_source
+
+      ##
+      # Get the package installation source
+      # @return string|nil
+      ##
+      attr_reader :installation_source
+
+      ##
+      # Set the package source type
+      # @param source_type string
+      ##
+      attr_writer :source_type
+
+      ##
+      # Get the package source type
+      # @return string|nil
+      ##
+      attr_reader :source_type
+
+      ##
+      # Set the package source url
+      # @param source_url string
+      ##
+      attr_writer :source_url
+
+      ##
+      # Get the package source url
+      # @return string|nil
+      ##
+      attr_reader :source_url
+
+      ##
+      # Set the package source reference
+      # @param source_reference string
+      ##
+      attr_writer :source_reference
+
+      ##
+      # Get the package source reference
+      # @return string|nil
+      ##
+      attr_reader :source_reference
+
+      # Get/Set the package source mirrors
+      # @param source_mirrors array|nil
+      ##
+      attr_writer :source_mirrors
+
+      ##
+      # Get the package source mirrors
+      # @return string|nil
+      ##
+      attr_reader :source_mirrors
+
+      ##
+      # Get the package source urls
+      # @return array
+      ##
+      def source_urls
+        get_urls( source_url, source_mirrors, source_reference, source_type, 'source')
       end
 
-      def pretty_string
-        "#{pretty_name} #{pretty_version}"
+      ##
+      # Set the package distribution type
+      # @param dist_type string
+      ##
+      attr_writer :dist_type
+
+      ##
+      # Get the package distribution type
+      # @return string|nil
+      ##
+      attr_reader :dist_type
+
+      ##
+      # Set the package distribution url
+      # @param dist_url string
+      ##
+      attr_writer :dist_url
+
+      ##
+      # Get the package distribution url
+      # @return string|nil
+      ##
+      attr_reader :dist_url
+
+      ##
+      # Set the package distribution reference
+      # @param dist_reference string
+      ##
+      attr_writer :dist_reference
+
+      ##
+      # Get the package distribution reference
+      # @return string|nil
+      ##
+      attr_reader :dist_reference
+
+      ##
+      # Set the package distribution sha1 checksum
+      # @param dist_sha1_checksum string
+      ##
+      attr_writer :dist_sha1_checksum
+
+      ##
+      # Get the package distribution sha1 checksum
+      # @return string|nil
+      ##
+      attr_reader :dist_sha1_checksum
+
+      ##
+      # Set the package distribution mirrors
+      # @param dist_mirrors string
+      ##
+      attr_writer :dist_mirrors
+
+      ##
+      # Get the package distribution mirrors
+      # @return string|nil
+      ##
+      attr_reader :dist_mirrors
+
+      ##
+      # Get the package distribution urls
+      # @return array
+      ##
+      def dist_urls
+        get_urls( dist_url, dist_mirrors, dist_reference, dist_type, 'dist' )
       end
 
-      # Determine if development package
-      # Return: true if development package; Otherwise false.
-      def is_dev
-        @dev
+      ##
+      # Get the package version
+      # @return string
+      ##
+      attr_reader :version
+
+      ##
+      # Get the package pretty version
+      # @return string
+      ##
+      attr_reader :pretty_version
+
+      ##
+      # Returns the pretty version string plus a git or hg commit hash of this package
+      #
+      # @see pretty_version
+      #
+      # @param truncate bool
+      #   If the source reference is a sha1 hash, truncate it
+      #
+      # @return string
+      ##
+      def full_pretty_version(truncate = true)
+        unless is_dev? || %w{hg git}.include?(source_type)
+          return pretty_version
+        end
+
+        # if source reference is a sha1 hash -- truncate
+        if truncate && source_reference.length === 40
+          return "#{pretty_version} #{source_reference[0..6]}"
+        end
+
+        "#{pretty_version} #{source_reference}"
       end
 
+      ##
       # Replaces current version and pretty version with passed values.
       # It also sets stability.
-      # Param: string version       The package's normalized version
-      # Param: string prettyVersion The package's non-normalized version
+      #
+      # @param version string version
+      #   The package's normalized version
+      # @param pretty_version string
+      #   The package's non-normalized version
+      ##
       def replace_version(version, pretty_version)
         @version = version
         @pretty_version = pretty_version
 
-        @stability = Composer::Package::Version::VersionParser::parse_stability(version)
+        @stability = ::Composer::Semver::VersionParser::parse_stability(version)
         @dev = @stability === 'dev'
       end
 
+      ##
+      # Set the package release date
+      # @param release_date Date
+      ##
+      attr_writer :release_date
+
+      ##
+      # Get the package release date
+      # @return Date|nil
+      ##
+      attr_reader :release_date
+
+      ##
+      # Set the package requires
+      # @param requires Hash of package name => Link
+      ##
+      attr_writer :requires
+
+      ##
+      # Get the package requires
+      # @return Hash of package name => Link
+      ##
+      attr_reader :requires
+
+      ##
+      # Set the package conflicts
+      # @param conflicts Hash of package name => Link
+      ##
+      attr_writer :conflicts
+
+      ##
+      # Get the package conflicts
+      # @return Hash of package name => Link
+      ##
+      attr_reader :conflicts
+
+      ##
+      # Set the package provides
+      # @param provides Hash of package name => Link
+      ##
+      attr_writer :provides
+
+      ##
+      # Get the package provides
+      # @return Hash of package name => Link
+      ##
+      attr_reader :provides
+
+      ##
+      # Set the package replaces
+      # @param replaces Hash of package name => Link
+      ##
+      attr_writer :replaces
+
+      ##
+      # Get the package replaces
+      # @return Hash of package name => Link
+      ##
+      attr_reader :replaces
+
+      ##
+      # Set the package dev requires
+      # @param dev_requires Hash of package name => Link
+      ##
+      attr_writer :dev_requires
+
+      ##
+      # Get the package dev requires
+      # @return Hash of package name => Link
+      ##
+      attr_reader :dev_requires
+
+      ##
+      # Set the package suggests
+      # @param suggests Hash of package name => comments
+      ##
+      attr_writer :suggests
+
+      ##
+      # Get the package suggests
+      # @return Hash of package name => Link
+      ##
+      attr_reader :suggests
+
+      ##
+      # Set the package autoload mapping
+      # @param autoload Hash Mapping of auto-loading rules
+      ##
+      attr_writer :autoload
+
+      ##
+      # Get the package autoload mapping
+      # TODO: This conflicts with kernel method autoload
+      # @return Array
+      ##
+      attr_reader :autoload
+
+      ##
+      # Set the package dev autoload mapping
+      # @param dev_autoload Array Mapping of dev auto-loading rules
+      ##
+      attr_writer :dev_autoload
+
+      ##
+      # Get the package dev autoload mapping
+      # @return Array
+      ##
+      attr_reader :dev_autoload
+
+      ##
+      # Set the list of paths added to PHP's include path.
+      # @param include_paths Array List of directories
+      ##
+      attr_writer :include_paths
+
+      ##
+      # Get the package include_paths mapping
+      # @return Array
+      ##
+      attr_reader :include_paths
+
+      ##
+      # Set the package notification url
+      # @param notification_url string
+      ##
+      attr_writer :notification_url
+
+      ##
+      # Get the package notification url
+      # @return string|nil
+      ##
+      attr_reader :notification_url
+
+      # Set a list of patterns to be excluded from archives
+      # @param archive_excludes Array
+      ##
+      attr_writer :archive_excludes
+
+      ##
+      # Get the package archive_excludes mapping
+      # @return Array
+      ##
+      attr_reader :archive_excludes
+
+      ##
+      # Set the list of options to download package dist files
+      # @param transport_options array
+      ##
+      attr_writer :transport_options
+
+      ##
+      # Returns a list of options to download package dist files
+      # @return array
+      ##
+      attr_reader :transport_options
+
+      ##
+      # Stores a reference to the repository that owns the package
+      # @param repository ::Composer::Repository::Repository
+      ##
+      def repository=(repository)
+        unless @repository.nil? || @repository.equal?(repository)
+          raise LogicError,
+                'A package can only be added to one repository'
+        end
+        @repository = repository
+      end
+
+      ##
+      # Returns a reference to the repository that owns the package
+      # @return RepositoryInterface
+      ##
+      attr_reader :repository
+
+      ##
+      # Returns package unique name, constructed from name and version.
+      # @return string
+      ##
+      def unique_name
+        "#{name}-#{version}"
+      end
+
+      ##
+      # Converts the package into a readable and unique string
+      # @return string
+      ##
+      def to_s
+        unique_name
+      end
+
+      ##
+      # Converts the package into a pretty readable string
+      # @return string
+      ##
+      def pretty_string
+        "#{pretty_name} #{pretty_version}"
+      end
+
+      def is_platform?
+        # repository.instance_of?(PlatformRepository)
+        false
+      end
+
+      ##
+      # Determine whether the specified package is equal to this package.
+      # @param package
+      ##
+      def equal?(package)
+        target = self
+        if self.kind_of? ::Composer::Package::AliasPackage
+          target = alias_of
+        end
+        if package.kind_of? ::Composer::Package::AliasPackage
+          package = package.alias_of
+        end
+        package === target
+      end
+
+      protected
+
+      ##
+      # Helper method to combine urls by type
+      ##
+      def get_urls(url, mirrors, ref, type, url_type)
+        return [] if url.nil?
+        urls = [ url ]
+        if mirrors
+          mirrors.each do |mirror|
+            if url_type === 'dist'
+              mirror_url = ::Composer::Util::ComposerMirror::process_url(mirror['url'], name, version, ref, type)
+            elsif url_type === 'source' && type === 'git'
+              mirror_url = ::Composer::Util::ComposerMirror::process_git_url(mirror['url'], name, url, type)
+            elsif url_type === 'source' && type === 'hg'
+              mirror_url = ::Composer::Util::ComposerMirror::process_hg_url(mirror['url'], name, url, type)
+            end
+            unless urls.include? mirror_url
+              func = mirror['preferred'] ? 'unshift' : 'push'
+              urls.send(func, mirror_url)
+            end
+          end
+        end
+        urls
+      end
+
     end
   end
 end