php-composer 0.4.5 → 1.0.0.pre.alpha11

data/lib/composer/package/version/version_selector.rb

@@ -1,17 +1,21 @@
-#
+##
 # This file was ported to ruby from Composer php source code file.
-# Original Source: Composer\Package\Version\VersionParser.php
+#
+# Original Source: Composer\Package\Version\VersionSelector.php
+# Ref SHA: 966a9827382b59064255579f524e3904527abdbe
 #
 # (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 Version
+
+      ##
       # Selects the best possible version for a package
       #
       # PHP Authors:
@@ -19,87 +23,142 @@ module Composer
       #
       # Ruby Authors:
       # Ioannis Kappas <ikappas@devworks.gr>
+      ##
       class VersionSelector
 
-          def initialize(pool)
-            @pool = pool
-          end
+        def initialize(pool)
+          @pool = pool
+        end
+
+        ##
+        # Given a package name and optional version, returns the latest PackageInterface
+        # that matches.
+        #
+        # @param _package_name string
+        # @param _target_pkg_version string
+        # @param _target_php_version string
+        # @param _preferred_stability string
+        #
+        # @return Package|bool
+        ##
+        def find_best_candidate(_package_name, _target_pkg_version = nil, _target_php_version = nil, _preferred_stability = 'stable')
 
+          raise NotImplementedError
 
-          # Given a concrete version, this returns a ~ constraint (when possible)
-          # that should be used, for example, in composer.json.
+          # constraint = target_pkg_version ? parser.parse_constraints(target_pkg_version) : nil
+          # candidates = @pool.what_provides(package_name.downcase, constraint, true)
           #
-          # For example:
-          #  * 1.2.1         -> ~1.2
-          #  * 1.2           -> ~1.2
-          #  * v3.2.1        -> ~3.2
-          #  * 2.0-beta.1    -> ~2.0@beta
-          #  * dev-master    -> ~2.1@dev      (dev version with alias)
-          #  * dev-master    -> dev-master    (dev versions are untouched)
+          # if target_php_version
+          #   php_constraint = ::Composer::Semver::Constraint::Constraint.new('==', parser.normalize(target_php_version))
+          #   candidates = candidates.select do |pkg|
+          #     requires = pkg.requires
+          #     return ! requires['php'].nil? || requires['php'].constraint.matches(php_constraint)
+          #   end
+          # end
           #
-          # @param  Package package
-          # @return string
-          def find_recommended_require_version(package)
-            version = package.version
-            if !package.is_dev
-              return transform_version(version, package.pretty_version, package.stability)
-            end
+          # return false unless candidates
+          #
+          # # select highest version if we have many
+          # package = reset(candidates)
+          # min_priority = ::Composer::Package::Package::stabilities[preferred_stability]
+          # candidates.each do |candidate|
+          #   candidate_priority = candidate.stability_priority
+          #   current_priority = package.stability_priority
+          #
+          #   # candidate is less stable than our preferred stability, and we have a package that is more stable than it, so we skip it
+          #   if min_priority < candidate_priority && current_priority < candidate_priority
+          #     continue
+          #   end
+          #   # candidate is more stable than our preferred stability, and current package is less stable than preferred stability, then we select the candidate always
+          #   if min_priority >= candidate_priority && min_priority < current_priority
+          #     package = candidate
+          #     continue
+          #   end
+          #
+          #   # select highest version of the two
+          #   if version_compare(package.version, candidate.version, '<')
+          #     package = candidate
+          #   end
+          # end
+          #
+          # package
+        end
 
-            loader = Composer::Package::Loader::HashLoader.new(parser)
-            dumper = Composer::Package::Dumper::HashDumper.new
+        ##
+        # Given a concrete version, this returns a ~ constraint (when possible)
+        # that should be used, for example, in composer.json.
+        #
+        # For example:
+        #  * 1.2.1         -> ~1.2
+        #  * 1.2           -> ~1.2
+        #  * v3.2.1        -> ~3.2
+        #  * 2.0-beta.1    -> ~2.0@beta
+        #  * dev-master    -> ~2.1@dev      (dev version with alias)
+        #  * dev-master    -> dev-master    (dev versions are untouched)
+        #
+        # @param package Package
+        # @return string
+        ##
+        def find_recommended_require_version(package)
+          version = package.version
+          unless package.is_dev?
+            return transform_version(version, package.pretty_version, package.stability)
+          end
 
-            if (extra = loader.get_branch_alias(dumper.dump(package)))
-              if match = /^(\d+\.\d+\.\d+)(\.9999999)-dev$/.match(extra)
-                extra = "#{match[1]}.0"
-                extra.gsub!('.9999999', '.0')
-                return transform_version(extra, extra, 'dev')
-              end
-            end
+          loader = ::Composer::Package::Loader::HashLoader.new(parser)
+          dumper = ::Composer::Package::Dumper::HashDumper.new
 
-            package.pretty_version
+          extra = loader.get_branch_alias(dumper.dump(package))
+          if extra =~ /^(\d+\.\d+\.\d+)(\.9999999)-dev$/
+            extra = "#{$1}.0"
+            extra.gsub!('.9999999', '.0')
+            return transform_version(extra, extra, 'dev')
           end
 
-          private
-
-          def transform_version(version, pretty_version, stability)
-            # attempt to transform 2.1.1 to 2.1
-            # this allows you to upgrade through minor versions
-            semantic_version_parts = version.split('.')
-            op = '~'
-
-              # check to see if we have a semver-looking version
-              if semantic_version_parts.length == 4 && /^0\D?/.match(semantic_version_parts[3])
-                # remove the last parts (i.e. the patch version number and any extra)
-                if semantic_version_parts[0] === '0'
-                  if semantic_version_parts[1] === '0'
-                    semantic_version_parts[3] = '*'
-                  else
-                    semantic_version_parts[2] = '*'
-                    semantic_version_parts.delete_at(3)
-                  end
-                  op = ''
-                else
-                  semantic_version_parts.delete_at(3)
-                  semantic_version_parts.delete_at(2)
-                end
-                version = semantic_version_parts.join('.')
-              else
-                return pretty_version
-              end
+          package.pretty_version
+        end
 
-              # append stability flag if not default
-              if stability != 'stable'
-                version <<  "@#{stability}"
-              end
+        private
+
+        def transform_version(version, pretty_version, stability)
+          # attempt to transform 2.1.1 to 2.1
+          # this allows you to upgrade through minor versions
+          semantic_version_parts = version.split('.')
+          op = '~'
 
-              # 2.1 -> ~2.1
-              op + version
+          # check to see if we have a semver-looking version
+          if semantic_version_parts.length == 4 && /^0\D?/.match(semantic_version_parts[3])
+            # remove the last parts (i.e. the patch version number and any extra)
+            if semantic_version_parts[0] === '0'
+              if semantic_version_parts[1] === '0'
+                semantic_version_parts[3] = '*'
+              else
+                semantic_version_parts[2] = '*'
+                semantic_version_parts.delete_at(3)
+              end
+              op = ''
+            else
+              semantic_version_parts.delete_at(3)
+              semantic_version_parts.delete_at(2)
+            end
+            version = semantic_version_parts.join('.')
+          else
+            return pretty_version
           end
 
-          def parser
-            @parser ||= Composer::Package::Version::VersionParser.new
-            @parser
+          # append stability flag if not default
+          if stability != 'stable'
+            version << "@#{stability}"
           end
+
+          # 2.1 -> ~2.1
+          op + version
+        end
+
+        def parser
+          @parser ||= ::Composer::Semver::VersionParser.new
+        end
+
       end
     end
   end

data/lib/composer/repository/base_repository.rb

@@ -24,22 +24,65 @@ module Composer
       SEARCH_FULLTEXT = 0
       SEARCH_NAME = 1
 
-      def package?
+      ##
+      # Determine whether the specified package is registered (installed).
+      #
+      # @param package ::Composer::Package::Package
+      #  The package to check for.
+      # @return bool
+      #  True if the package is registered; Otherwise false.
+      #
+      def package?(package)
         # implement inside child
       end
 
-      def find_package(name, version)
+      ##
+      # Searches for the first match of a package by name and version.
+      #
+      # @param name string
+      #   The package name.
+      # @param constraint string|::Composer::Semver::Constraint::Constraint
+      #   The package version or version constraint to match against
+      #
+      # @return PackageInterface|nil
+      #
+      def find_package(name, constraint)
         # implement inside child
       end
 
-      def find_packages(name, version = nil)
+      ##
+      # Searches for all packages matching a name and optionally a version.
+      #
+      # @param name string
+      #   The package name.
+      # @param constraint string|::Composer::Semver::Constraint::Constraint
+      #   Optional. The package version or version constraint to match against.
+      #
+      # @return ::Composer::Package::Package[]
+      ##
+      def find_packages(name, constraint = nil)
         # implement inside child
       end
 
+      ##
+      # Returns list of registered packages.
+      #
+      # @return ::Composer::Package::Package[]
+      ##
       def packages
         # implement inside child
       end
 
+      ##
+      # Searches the repository for packages containing the query
+      #
+      # @param query string
+      #   The search query
+      # @param mode integer
+      #   A set of SEARCH_* constants to search on, implementations should do a best effort only.
+      #
+      # @return hash[] an array of hash { 'name' => '...', 'description' => '...')
+      #
       def search(query, mode = 0)
         # implement inside child
       end

data/lib/composer/repository/composite_repository.rb

@@ -18,7 +18,7 @@ module Composer
     #
     # Ruby Authors:
     # Ioannis Kappas <ikappas@devworks.gr>
-    class CompositeRepository < Composer::Repository::BaseRepository
+    class CompositeRepository < ::Composer::Repository::BaseRepository
       # Initializes filesystem repository.
       # @param [Array] repositories An array of repositories.
       def initialize(repositories)
@@ -114,17 +114,17 @@ module Composer
           raise ArgumentError,
                 'repository must be specified'
         end
-        unless repository.is_a?(Composer::Repository::BaseRepository)
+        unless repository.is_a?(::Composer::Repository::BaseRepository)
           raise TypeError,
                 'repository type must be a \
                 Composer::Repository::BaseRepository or superclass'
         end
-        if repository.instance_of?(Composer::Repository::CompositeRepository)
+        if repository.instance_of?(::Composer::Repository::CompositeRepository)
           repository.repositories.each do |repo|
             add_repository(repo)
           end
         else
-            @repositories.push(repository)
+          @repositories.push(repository)
         end
       end
     end

data/lib/composer/repository/filesystem_repository.rb

@@ -11,6 +11,8 @@
 
 module Composer
   module Repository
+
+    ##
     # Filesystem repository.
     #
     # PHP Authors:
@@ -19,19 +21,24 @@ module Composer
     #
     # Ruby Authors:
     # Ioannis Kappas <ikappas@devworks.gr>
-    class FilesystemRepository < Composer::Repository::WritableHashRepository
+    ##
+    class FilesystemRepository < ::Composer::Repository::WritableHashRepository
 
+      ##
       # Initializes filesystem repository.
-      # @param [Composer::Json::JsonFile] repository_file repository json file
+      #
+      # @param repository_file Composer::Json::JsonFile
+      #   The repository json file
+      ##
       def initialize(repository_file)
         unless repository_file
           raise ArgumentError,
                 'repository_file must be specified'
         end
-        unless repository_file.is_a?(Composer::Json::JsonFile)
+        unless repository_file.is_a?(::Composer::Json::JsonFile)
           raise TypeError,
-                'repository_file type must be a \
-                Composer::Json::JsonFile or superclass'
+                'repository_file type must be a' \
+                'Composer::Json::JsonFile or superclass'
         end
         super([])
         @file = repository_file
@@ -45,7 +52,7 @@ module Composer
       # Writes writable repository.
       def write
         data = []
-        dumper = Composer::Package::Dumper::HashDumper.new
+        dumper = ::Composer::Package::Dumper::HashDumper.new
 
         canonical_packages.each { |package| data << dumper.dump(package) }
 
@@ -72,7 +79,7 @@ module Composer
                 [#{e.class}] #{e.message}"
         end
 
-        loader = Composer::Package::Loader::HashLoader.new(nil, true)
+        loader = ::Composer::Package::Loader::HashLoader.new(nil, true)
         packages_data.each do |package_data|
           package = loader.load(package_data)
           add_package(package)
@@ -82,4 +89,4 @@ module Composer
 
     end
   end
-end
+end

data/lib/composer/repository/hash_repository.rb

@@ -9,22 +9,23 @@
 # file that was distributed with this source code.
 #
 
+require 'composer/semver'
+
 module Composer
   module Repository
-    class HashRepository < Composer::Repository::BaseRepository
+    class HashRepository < ::Composer::Repository::BaseRepository
+
       def initialize(packages = [])
-        packages.each do |package|
-          add_package(package)
-        end
+        packages.each {|p| add_package p } if packages.instance_of? Array
       end
 
       def find_package(name, version = nil)
         # normalize name
-        name = name.downcase
+        name.downcase! unless name.nil?
 
         # normalize version
-        if !version.nil?
-          version_parser = Composer::Package::Version::VersionParser.new
+        unless version.nil?
+          version_parser = ::Composer::Semver::VersionParser.new
           version = version_parser.normalize(version)
         end
 
@@ -41,47 +42,57 @@ module Composer
       end
 
       def find_packages(name, version = nil)
-          # normalize name
-          name = name.downcase
+        # normalize name
+        name.downcase! unless name.nil?
 
-          # normalize version
-          if version != nil
-            version_parser = Composer::Package::Version::VersionParser.new
-            version = version_parser.normalize(version)
-          end
+        # normalize version
+        unless version.nil?
+          version_parser = ::Composer::Semver::VersionParser.new
+          version = version_parser.normalize(version)
+        end
 
-          matches = []
-          packages.each do |package|
-            if package.name === name && (nil === version || version === package.version)
-              matches.push(package)
-            end
+        matches = []
+        packages.each do |package|
+          if package.name === name && (version.nil? || version === package.version)
+            matches.push package
           end
-          matches
+        end
+        matches
       end
 
+      ##
+      # Searches the repository for packages containing the query
+      #
+      # @param query string
+      #   The search query
+      # @param mode int
+      #   A set of SEARCH_* constants to search on, implementations should do a best effort only
+      #
+      # @return array[] an array of array('name' => '...', 'description' => '...')
+      ##
       def search(query, mode = 0)
+
         regex = /(?:#{query.split(/\s+/).join('|')})/i
+
         matches = {}
         packages.each do |package|
+
           name = package.name
 
-          # already matched
+          # skip if already matched
           next if matches[name]
 
           # search
-          unless regex.match(name)
-            unless mode === Composer::Repository::BaseRepository::SEARCH_FULLTEXT &&
-                package.instance_of?(Composer::Package::CompletePackage) &&
-                regex.match("#{package.keywords ? package.keywords.join(' ') : ''} #{package.description ? package.description : ''}")
-              next
-            end
+          if regex.match(name) ||
+              mode === ::Composer::Repository::BaseRepository::SEARCH_FULLTEXT &&
+              package.kind_of?(::Composer::Package::CompletePackage) &&
+              regex.match("#{package.keywords ? package.keywords.join(' ') : ''} #{package.description ? package.description : ''}")
+
+            matches[name] = {
+                'name' => package.pretty_name,
+                'description' => package.send('description'),
+            }
           end
-
-          matches[name] = {
-            'name' => package.pretty_name,
-            'description' => package.description,
-          }
-
         end
         matches.values
       end
@@ -91,7 +102,7 @@ module Composer
           raise ArgumentError,
                 'package must be specified'
         end
-        unless package.is_a?(Composer::Package::BasePackage)
+        unless package.is_a?(::Composer::Package::Package)
           raise TypeError,
                 'package must be a class or superclass of \
                 Composer::Package::Package'
@@ -105,16 +116,18 @@ module Composer
         false
       end
 
+      ##
       # Adds a new package to the repository
       #
-      # Params:
-      # +package+ Package The package to add
+      # @param package Composer::Package::Package
+      #   The package to add
+      ##
       def add_package(package)
         unless package
           raise ArgumentError,
                 'package must be specified'
         end
-        unless package.is_a?(Composer::Package::BasePackage)
+        unless package.is_a?(::Composer::Package::Package)
           raise TypeError,
                 'package must be a class or superclass of \
                 Composer::Package::Package'
@@ -126,7 +139,7 @@ module Composer
 
         @packages << package
 
-        if package.instance_of?(Composer::Package::AliasPackage)
+        if package.instance_of?(::Composer::Package::AliasPackage)
           aliased_package = package.alias_of
           if aliased_package.repository === nil
             add_package(aliased_package)
@@ -134,16 +147,18 @@ module Composer
         end
       end
 
+      ##
       # Removes package from repository.
       #
-      # Params:
-      # +package+ package instance to remove
+      # @param package Composer::Package::Package
+      #   The package instance to remove
+      ##
       def remove_package(package)
         unless package
           raise ArgumentError,
                 'package must be specified'
         end
-        unless package.is_a?(Composer::Package::BasePackage)
+        unless package.is_a?(::Composer::Package::Package)
           raise TypeError,
                 'package must be a class or superclass of \
                 Composer::Package::Package'
@@ -155,7 +170,7 @@ module Composer
         packages.each do |repo_package|
           if repo_package.unique_name === package_id
             @packages.delete_at(index)
-            return
+            break
           end
           index = index + 1
         end
@@ -167,24 +182,26 @@ module Composer
       end
 
       def count
-        @packages.length
+        packages.length
       end
 
       protected
 
+      ##
       # Initializes the packages array.
       # Mostly meant as an extension point.
+      ##
       def initialize_repository
         @packages = []
       end
 
       def create_alias_package(package, version, pretty_version)
-        if package.instance_of?(Composer::Package::AliasPackage)
+        if package.instance_of?(::Composer::Package::AliasPackage)
           alias_of = package.alias_of
         else
           alias_of = package
         end
-        Composer::Package::AliasPackage.new(
+        ::Composer::Package::AliasPackage.new(
           alias_of,
           version,
           pretty_version