php-composer 0.4.5 → 1.0.0.pre.alpha11

data/lib/composer/package/dumper/hash_dumper.rb

@@ -1,6 +1,8 @@
 #
 # This file was ported to ruby from Composer php source code.
+#
 # Original Source: Composer\Package\Dumper\ArrayDumper.php
+# Ref SHA: 346133d2a112dbc52163eceeee67814d351efe3f
 #
 # (c) Nils Adermann <naderman@naderman.de>
 #     Jordi Boggiano <j.boggiano@seld.be>
@@ -12,6 +14,7 @@
 module Composer
   module Package
     module Dumper
+
       # Dumps a hash from a package
       #
       # PHP Authors:
@@ -21,148 +24,77 @@ module Composer
       # Ruby Authors:
       # Ioannis Kappas <ikappas@devworks.gr>
       class HashDumper
-        def dump(package)
-          keys = {
-            'binaries' => 'bin',
-            'type' => 'type',
-            'extra' => 'extra',
-            'installation_source' => 'installation-source',
-            'autoload' => 'autoload',
-            'dev_autoload' => 'autoload-dev',
-            'notification_url' => 'notification-url',
-            'include_paths' => 'include-path',
-          }
 
-          data = {}
-          data['name'] = package.pretty_name
-          data['version'] = package.pretty_version
-          data['version_normalized'] = package.version
+        class << self
 
-          if package.target_dir
-            data['target-dir'] = package.target_dir
+          def attr_dumpers
+            @attr_dumpers ||= []
           end
 
-          if package.source_type
-            data['source'] = {}
-            data['source']['type'] = package.source_type
-            data['source']['url'] = package.source_url
-            data['source']['reference'] = package.source_reference
-            if mirrors = package.source_mirrors
-              data['source']['mirrors'] = mirrors
+          def attr_dumper( attr, options = {}, &block)
+            if block_given?
+              attr_dumpers.push({ attr: attr, options: options, callback: block })
+            else
+              attr_dumpers.push({ attr: attr, options: options })
             end
           end
 
-          if package.dist_type
-            data['dist'] = {}
-            data['dist']['type'] = package.dist_type
-            data['dist']['url'] = package.dist_url
-            data['dist']['reference'] = package.dist_reference
-            data['dist']['shasum'] = package.dist_sha1_checksum
-            if mirrors = package.dist_mirrors
-              data['dist']['mirrors'] = mirrors
-            end
-          end
+        end
 
-          unless package.archive_excludes.nil? || package.archive_excludes.empty?
-            data['archive'] = {}
-            data['archive']['exclude'] = package.archive_excludes
-          end
+        def dump(package)
 
-          Composer::Package::BasePackage::SUPPORTED_LINK_TYPES.each do |type, opts|
-            next unless links = package.send(opts['method'])
-            next if links.nil?
-            next if links.is_a?(Array) && links.empty?
-            next if links.is_a?(Hash) && links.empty?
-            data[type] = {} unless data.key?(type)
-            values = links.is_a?(Hash) ? links.values : links
-            values.each do |link|
-              data[type][link.target] = link.pretty_constraint
-            end
-            data[type].keys.sort.each do |k|
-              data[type][k] = data[type].delete k
-            end
+          # verify supplied arguments
+          unless package
+            raise ArgumentError,
+                  'Invalid package configuration supplied.'
           end
 
-          if packages = package.suggests
-            unless packages.nil? || packages.empty?
-              packages.keys.sort.each do |k|
-                packages[k] = packages.delete k
-              end
-              data['suggest'] = packages
-            end
+          unless package.respond_to?(:pretty_name)
+            raise UnexpectedValueError,
+                  'The package specified is missing the "pretty_name" method.'
           end
 
-          if package.release_date && !package.release_date.nil?
-            data['time'] = package.release_date.strftime('%Y-%m-%d %H:%M:%S')
+          unless package.respond_to?(:pretty_version)
+            raise UnexpectedValueError,
+                  'The package specified is missing the "pretty_version" method.'
           end
 
-          data = dump_values(package, keys, data)
-
-          # if data.key?('type') && data['type'] === 'library'
-          #   data.delete('type')
-          # end
-
-          if package.is_a?(Composer::Package::CompletePackage)
-            keys = %w{scripts license authors description homepage keywords repositories support}
-            data = dump_values(package, keys, data)
-
-            if data.key?('keywords') && is_array?(data, 'keywords')
-              data['keywords'].sort!
-            end
-
-            if package.is_abandoned?
-              replacement = package.replacement_package
-              data['abandoned'] = replacement ? replacement : true
-            end
+          unless package.respond_to?(:version)
+            raise UnexpectedValueError,
+                  'The package specified is missing the "version" method.'
           end
 
-          if package.is_a?(Composer::Package::RootPackage)
-            minimum_stability = package.minimum_stability
-            unless minimum_stability.nil? || minimum_stability.empty?
-              data['minimum-stability'] = minimum_stability
-            end
-          end
+          data = {}
+          data['name'] = package.pretty_name
+          data['version'] = package.pretty_version
+          data['version_normalized'] = package.version
 
-          if !package.transport_options.nil? && package.transport_options.length > 0
-            data['transport-options'] = package.transport_options
+          # load class specific attributes
+          HashDumper.attr_dumpers.each do |dumper|
+            if package.respond_to? dumper[:attr]
+              if dumper[:callback]
+                instance_exec package, data, &dumper[:callback]
+              else
+                attr_value = package.send dumper[:attr]
+                unless attr_value.nil? || attr_value.empty?
+                  if dumper[:options][:to]
+                    attr_key = dumper[:options][:to]
+                  else
+                    attr_key = dumper[:attr].to_s.tr('_', '-')
+                  end
+                  data[attr_key] = attr_value
+                end
+              end
+            end
           end
 
           data
         end
 
-        private
+        require_relative 'hash_dumper/package_attribute_dumpers'
+        require_relative 'hash_dumper/complete_package_attribute_dumpers'
+        require_relative 'hash_dumper/root_package_attribute_dumpers'
 
-        def dump_values(package, keys, data)
-          keys.each do |method, key|
-            key = method unless key
-            next unless  value  = package.send(method)
-            next if value.nil?
-            next if value.is_a?(Array) && value.empty?
-            next if value.is_a?(Hash) && value.empty?
-            data[key] = value
-          end
-          data
-        end
-
-        def is_numeric?(value)
-          true if Float(value) rescue false
-        end
-
-        def is_empty?(config, key)
-          config.key?(key) ? config[key].empty? : true
-        end
-
-        def is_hash?(config, key)
-          config.key?(key) ? config[key].is_a?(Hash) : false
-        end
-
-        def is_array?(config, key)
-          config.key?(key) ? config[key].is_a?(Array) : false
-        end
-
-        def is_string?(config, key)
-          config.key?(key) ? config[key].is_a?(String) : false
-        end
       end
     end
   end

data/lib/composer/package/dumper/hash_dumper/complete_package_attribute_dumpers.rb

@@ -0,0 +1,47 @@
+#
+# 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 Dumper
+      class HashDumper
+
+        attr_dumper :scripts
+        attr_dumper :license
+        attr_dumper :authors
+        attr_dumper :description
+        attr_dumper :homepage
+        attr_dumper :repositories
+        attr_dumper :support
+
+        attr_dumper :keywords do |package, data|
+          keywords = package.keywords
+          unless keywords.nil? || keywords.empty?
+            data['keywords'] = keywords.is_a?(Array) ? keywords.sort! : keywords
+          end
+        end
+
+        attr_dumper :abandoned? do |package, data|
+          if package.abandoned?
+            replacement = true
+            if package.respond_to?(:replacement_package)
+              replacement = package.replacement_package
+            end
+            data['abandoned'] = replacement ? replacement : true
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/composer/package/dumper/hash_dumper/package_attribute_dumpers.rb

@@ -0,0 +1,145 @@
+#
+# 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 Dumper
+      class HashDumper
+
+        attr_dumper :target_dir
+
+        attr_dumper :source_type do |package, data|
+          source_type = package.source_type
+          unless source_type.nil? || source_type.empty?
+
+            data['source'] = {}
+            data['source']['type'] = package.source_type
+
+            if package.respond_to? :source_url
+              source_url = package.source_url
+              unless source_url.nil? || source_url.empty?
+                data['source']['url'] = package.source_url
+              end
+            end
+
+            if package.respond_to? :source_reference
+              source_reference = package.source_reference
+              unless source_reference.nil? || source_reference.empty?
+                data['source']['reference'] = source_reference
+              end
+            end
+
+            if package.respond_to? :source_mirrors
+              source_mirrors = package.source_mirrors
+              unless source_mirrors.nil? || source_mirrors.empty?
+                data['source']['mirrors'] = source_mirrors
+              end
+            end
+
+          end
+        end
+
+        attr_dumper :dist_type do |package, data|
+          dist_type = package.dist_type
+          unless dist_type.nil? || dist_type.empty?
+
+            data['dist'] = {}
+            data['dist']['type'] = package.dist_type
+
+            if package.respond_to? :dist_url
+              dist_url = package.dist_url
+              unless dist_url.nil? || dist_url.empty?
+                data['dist']['url'] = package.dist_url
+              end
+            end
+
+            if package.respond_to? :dist_reference
+              dist_reference = package.dist_reference
+              unless dist_reference.nil? || dist_reference.empty?
+                data['dist']['reference'] = dist_reference
+              end
+            end
+
+            if package.respond_to? :dist_sha1_checksum
+              dist_sha1_checksum = package.dist_sha1_checksum
+              unless dist_sha1_checksum.nil? || dist_sha1_checksum.empty?
+                data['dist']['shasum'] = dist_sha1_checksum
+              end
+            end
+
+            if package.respond_to? :dist_mirrors
+              dist_mirrors = package.dist_mirrors
+              unless dist_mirrors.nil? || dist_mirrors.empty?
+                data['dist']['mirrors'] = dist_mirrors
+              end
+            end
+
+          end
+        end
+
+        attr_dumper :archive_excludes do |package, data|
+          archive_excludes = package.archive_excludes
+          unless archive_excludes.nil? || archive_excludes.empty?
+            data['archive'] = {}
+            data['archive']['exclude'] = archive_excludes
+          end
+        end
+
+        ::Composer::Package::SUPPORTED_LINK_TYPES.each do |type, opts|
+          attr_dumper opts[:method] do |package, data|
+            links = package.send(opts[:method])
+            next if links.nil?
+            next if links.is_a?(Array) && links.empty?
+            next if links.is_a?(Hash) && links.empty?
+            values = links.is_a?(Hash) ? links.values : links
+            values.each do |link|
+              data[type] = {} unless data.key?(type)
+              data[type][link.target] = link.pretty_constraint
+            end
+            data[type].keys.sort.each do |k|
+              data[type][k] = data[type].delete k
+            end
+          end
+        end
+
+        attr_dumper :suggests do |package, data|
+          packages = package.suggests
+          unless packages.nil? || packages.empty?
+            packages.keys.sort.each do |k|
+              packages[k] = packages.delete k
+            end
+            data['suggest'] = packages
+          end
+        end
+
+        attr_dumper :release_date do |package, data|
+          release_date = package.release_date
+          unless release_date.nil?
+            data['time'] = release_date.strftime('%Y-%m-%d %H:%M:%S')
+          end
+        end
+
+        attr_dumper :binaries, to: 'bin'
+        attr_dumper :type
+        attr_dumper :extra
+        attr_dumper :installation_source
+        attr_dumper :autoload
+        attr_dumper :dev_autoload, to: 'autoload-dev'
+        attr_dumper :notification_url
+        attr_dumper :include_paths, to: 'include-path'
+        attr_dumper :transport_options
+
+      end
+    end
+  end
+end

data/lib/composer/package/dumper/hash_dumper/root_package_attribute_dumpers.rb

@@ -0,0 +1,24 @@
+#
+# 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 Dumper
+      class HashDumper
+
+        attr_dumper :minimum_stability
+
+      end
+    end
+  end
+end

data/lib/composer/package/link.rb

@@ -18,11 +18,12 @@ module Composer
       attr_reader :source, :target, :constraint
 
       # Creates a new package link.
-      # @param string                  source
-      # @param string                  target
-      # @param LinkConstraintInterface constraint       Constraint applying to the target of this link
-      # @param string                  description      Used to create a descriptive string representation
-      # @param string                  prettyConstraint
+      #
+      # @param source string
+      # @param target string
+      # @param constraint LinkConstraintInterface Constraint applying to the target of this link
+      # @param description string Used to create a descriptive string representation
+      # @param pretty_constraint string
       def initialize(source, target, constraint = nil, description = 'relates to', pretty_constraint = nil)
         @source = source.downcase
         @target = target.downcase
@@ -31,6 +32,9 @@ module Composer
         @pretty_constraint = pretty_constraint
       end
 
+      # Get the link's pretty constraint.
+      #
+      # @return string
       def pretty_constraint
         unless @pretty_constraint
           raise UnexpectedValueError, "Link #{self} has been misconfigured and had no pretty constraint given."
@@ -38,10 +42,16 @@ module Composer
         @pretty_constraint
       end
 
+      # Get the link's pretty string.
+      #
+      # @return string
       def pretty_string(source_package)
         "#{source_package.pretty_string} #{@description} #{@target} #{@constraint.pretty_string}"
       end
 
+      # Get the link's string representation.
+      #
+      # @return string
       def to_s
         "#{@source} #{@description} #{@target} (#{@constraint})"
       end