git_compound 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 612c6d116fee9bcaaee021484a7679932bb3e675
-  data.tar.gz: cdd8dc429c4481348cbbea8a98f9faeb103c463c
+  metadata.gz: 9364d9375f8d63441e365cf7ddcdbd841de74be3
+  data.tar.gz: 1f7d07c9aabc1626404e73dc6995749c952d48bc
 SHA512:
-  metadata.gz: e7dbe4c61f12ccd94571ef2e44c55fce8b35f7c32ac0e9a05bc586d68708728a43157f7441c1d47bfb713e1c19cac367f1229a0177454495ad1a8619749d5fa5
-  data.tar.gz: 8ba2126a8ea301f628bab615f0af411b4b13a1cecc1951cf321eb906d95e8a1ce556ba7175a19a674470641be8635e6fc35acb90b24b28ab92f43907963117d6
+  metadata.gz: f9455c25a7672dd3cff14035bddef0c697695a1378ce6e8f72bc40b4f6582113e9407a815b750d72bd09904bf18578191a39ffede8adeac79903ee84972980f3
+  data.tar.gz: 0911ffa0e74ec12bd5a1d97215eed5936d1e18a1ec3630fb9850ce171fba690a6cc101b7d869db146e6afbe85680b601528669811c8f9b8d751ebda1de5d6321

data/README.md

@@ -1,6 +1,8 @@
-# Git Compound
+# GitCompound
 
-Compose your project using git repositories and ruby tasks
+Compose your project using git repositories and Ruby tasks.
+
+GitCompound combines features of Git submodules and common dependency managers like Bundler or Composer.
 
 ## Status
 
@@ -36,14 +38,16 @@ Create `Compoundfile` or `.gitcompound` manifest:
   end
 ```
 
-GitCompound will also process similar manifests found in required components in hierarchical way.
-
 Then run `gitcompound build`.
 
+GitCompound will also process manifests found in dependencies.
+
+
 
 ## Core features 
 
-`GitCompound` is more a distributed packaging system than alternative to Git submodules. 
+GitCompound is more a distributed packaging system (dependency manager) than alternative to Git submodules,
+however it has common features of both Git submodules and dependency managers like Bundler or Composer.
 
 `GitCompound` makes sure your project composition is the same on all machines,
 but you can have different composition depending on manifest you are using.
@@ -57,9 +61,6 @@ Core features:
 *   It is possible to create multiple manifest files (`Compoundfile`, `.gitcompound` or something else)
     and build them when necessary.
 
-*   Building manifest create lockfile (locking components on specific commit SHA). When lockfile is present if will
-    be used each time `build` command is invoked.
-
 *   Manifests can declare dependencies on different versions of components using different version strategies
     (Rubygems-like version, tag, branch or explicit SHA).
 
@@ -67,7 +68,7 @@ Core features:
     is root manifest. `GitCompound` processes all subsequent manifests found in dependencies using depth-first
     search of dependency graph.
 
-*   Root manifest and manifest of each subsequent component can declare Ruby tasks that will be executed
+*   Root manifest and manifests of each subsequent component can declare Ruby tasks that will be executed
     when component is built or updated.
 
 *   It is possible to install dependencies in root directory (`Dir.pwd` where `gitcompound` command is invoked).
@@ -75,6 +76,10 @@ Core features:
 
 *   Build process creates lockfile in `.gitcompound.lock`. It locks components on specific commit SHAs.
     It is then possible to build components directly, depending on versions (SHAs) from lockfile.
+    When lockfile is present if will be used each time `build` command is invoked.
+
+*   It is possible to use repositories, that has been used as dependencies, for development (like in Git submodules).
+
 
 ## Commands
 

data/lib/git_compound.rb

@@ -47,7 +47,8 @@ module GitCompound
   # GitCompound Logger
   #
   module Logger
-    autoload :Colors,  'git_compound/logger/colors'
+    autoload :Colors,   'git_compound/logger/colors'
+    autoload :Debugger, 'git_compound/logger/debugger'
     require 'git_compound/logger/core_ext/string'
   end
 

data/lib/git_compound/builder.rb

@@ -53,7 +53,9 @@ module GitCompound
       if @opts.include?(:allow_nested_subtasks)
         @manifest.process(Worker::TaskRunner.new)
       else
-        @manifest.tasks.each_value(&:execute)
+        @manifest.tasks.each_value do |task|
+          Worker::TaskRunner.new.visit_task(task)
+        end
       end
       self
     end
@@ -84,7 +86,7 @@ module GitCompound
 
       dormant_components.each do |component|
         Logger.warn "Removing dormant component `#{component.name}` " \
-                    "from `#{component.destination_path}` !"
+                    "from `#{component.path}` !"
 
         component.remove!
       end

data/lib/git_compound/command.rb

@@ -46,19 +46,16 @@ module GitCompound
 
     def run(command, args)
       abort(usage) unless methods.include?(command.to_sym)
-
-      Logger.debug("GitCompound v#{GitCompound::VERSION}")
-      Logger.debug("Running command '#{command}'")
-
       public_send(command, *args)
     rescue GitCompoundError => e
-      abort Logger.error("Error: #{e.message}", :quiet)
+      abort Logger.parse("Error: #{e.message}".on_red.white.bold)
     end
 
     private
 
     def builder(args)
-      Builder.new(manifest(args.first), Lock.new, args)
+      filename = args.find { |arg| arg.is_a? String }
+      Builder.new(manifest(filename), Lock.new, args)
     end
 
     def manifest(filename)
@@ -74,39 +71,41 @@ module GitCompound
 
     # rubocop:disable Metrics/AbcSize
     def usage
-      <<-EOS
-      #{'GitCompound version'.bold.yellow} #{GitCompound::VERSION.bold}
+      msg = <<-EOS
+  #{'GitCompound version'.bold.yellow} #{GitCompound::VERSION.bold}
 
-      Usage: #{'gitcompound'.bold.green} #{
-        '[options]'.green} #{'command'.bold} #{'[manifest_file]'.green}
+  Usage: #{'gitcompound'.bold.green} #{
+    '[options]'.green} #{'command'.bold} #{'[manifest_file]'.green}
 
-      Commands:
-        #{'build'.bold}
-            builds project from manifest (or lockfile if present)
+  Commands:
+    #{'build'.bold}
+        builds project from manifest (or lockfile if present)
 
-            If manifest is not specified it uses one of
-            #{Manifest::FILENAMES.inspect}
+        If manifest is not specified it uses one of
+        #{Manifest::FILENAMES.inspect}
 
-        #{'update'.bold}
-            updates project
+    #{'update'.bold}
+        updates project
 
-        #{'check'.bold}
-            detects circular depenencies, conflicting dependencies
-            and checks for name contraints
+    #{'check'.bold}
+        detects circular depenencies, conflicting dependencies
+        and checks for name contraints
 
-        #{'show'.bold}
-            prints structure of project
+    #{'show'.bold}
+        prints structure of project
 
-        #{'help'.bold}
-            prints this help
+    #{'help'.bold}
+        prints this help
 
-      Options:'
-        #{'--verbose'.bold}
-            prints verbose log info
+  Options:'
+    #{'--verbose'.bold}
+        prints verbose log info
 
-        #{'--disable-colors'.bold}
-            disable ANSI colors in output
+    #{'--disable-colors'.bold}
+        disable ANSI colors in output
       EOS
+
+      Logger.parse(msg)
     end
     # rubocop:enable Metrics/AbcSize
   end

data/lib/git_compound/command/options.rb

@@ -8,6 +8,7 @@ module GitCompound
       def initialize(args)
         @command, @args = parse_options(args)
 
+        self.class.disable_colors = false
         set_global_options
       end
 
@@ -32,7 +33,7 @@ module GitCompound
       end
 
       def self.disable_colors=(mode)
-        String.disable_colors = mode
+        GitCompound::Logger.colors = !mode
       end
 
       private

data/lib/git_compound/component.rb

@@ -6,6 +6,8 @@ module GitCompound
   #
   class Component < Node
     extend Forwardable
+    delegate [:sha, :ref, :origin, :repository, :version] => :@source
+    delegate [:path, :exists?, :repository] => :@destination
 
     attr_reader :name
     attr_accessor :source, :destination
@@ -31,14 +33,14 @@ module GitCompound
       @manifest ||= @source.manifest
     end
 
-    def build
-      @source.clone(destination_path)
+    def build!
+      @source.clone(path)
       @destination.repository do |repo|
         repo.checkout(@source.ref)
       end
     end
 
-    def update
+    def update!
       @destination.repository do |repo|
         repo.fetch
         repo.checkout(@source.ref)
@@ -47,7 +49,6 @@ module GitCompound
     end
 
     def remove!
-      path = destination_path
       raise GitCompoundError, 'Risky directory !' if
         path.start_with?('/') || path.include?('..')
       raise GitCompoundError, 'Not a directory !' unless
@@ -64,15 +65,8 @@ module GitCompound
       { name: @name,
         sha:  @source.sha,
         source: @source.origin,
-        destination: @destination.expanded_path
+        destination: @destination.path
       }
     end
-
-    # delegators
-
-    delegate [:sha, :origin, :repository, :version] => :@source
-    def_delegator :@destination, :expanded_path, :destination_path
-    def_delegator :@destination, :exists?,       :destination_exists?
-    def_delegator :@destination, :repository,    :destination_repository
   end
 end

data/lib/git_compound/component/destination.rb

@@ -7,39 +7,41 @@ module GitCompound
     class Destination
       attr_reader :path
 
-      def initialize(path, component)
+      def initialize(component_path, component)
         raise CompoundSyntaxError, 'Destination cannot be empty' if
-          path.nil? || path.empty?
+          component_path.nil? || component_path.empty?
 
         raise CompoundSyntaxError,
               'Destination should contain at least one directory' unless
-          Pathname.new(path).each_filename.count > 0
+          Pathname.new(component_path).each_filename.count > 0
 
-        @path      = path
         @component = component
-      end
-
-      def expanded_path
-        pathname = Pathname.new(@path)
-
-        unless pathname.absolute?
-          ancestor_paths = @component.ancestors.map(&:destination_path)
-          pathname = Pathname.new('.').join(*ancestor_paths) + pathname
-        end
-
-        Pathname.new("./#{pathname}").cleanpath.to_s + '/'
+        @path      = expand_path(component_path)
       end
 
       def exists?
-        FileTest.exist?(expanded_path)
+        FileTest.exist?(@path)
       end
 
       def repository
         destination_repository =
-          Repository::RepositoryLocal.new(expanded_path)
+          Repository::RepositoryLocal.new(@path)
         yield destination_repository if block_given?
         destination_repository
       end
+
+      private
+
+      def expand_path(component_path)
+        pathname = Pathname.new(component_path)
+
+        unless pathname.absolute?
+          ancestor_paths = @component.ancestors.map(&:path)
+          pathname = Pathname.new('.').join(*ancestor_paths) + pathname
+        end
+
+        Pathname.new("./#{pathname}").cleanpath.to_s + '/'
+      end
     end
   end
 end

data/lib/git_compound/lock.rb

@@ -49,7 +49,7 @@ module GitCompound
 
     def find(component)
       components.find do |locked_component|
-        locked_component.destination_path == component.destination_path
+        locked_component.path == component.path
       end
     end
 

data/lib/git_compound/logger.rb

@@ -5,6 +5,7 @@ module GitCompound
     extend self
 
     def verbose=(value)
+      load_debug_messages if value
       @verbose = value && true
     end
 
@@ -12,32 +13,50 @@ module GitCompound
       @verbose ||= false
     end
 
+    def colors=(value)
+      String.disable_colors = !(@colors = value)
+    end
+
+    def colors
+      @colors ||= true
+    end
+
     def inline(inline_message)
       print inline_message
       inline_message
     end
 
-    def debug(debug_message, *params)
-      log(debug_message.cyan, *params) if verbose
+    def debug(debug_message)
+      log debug_message.cyan
     end
 
-    def info(information_message, *params)
-      log(information_message, *params)
+    def info(information_message)
+      log information_message
     end
 
-    def warn(warning_message, *params)
-      log(warning_message.red.bold, *params)
+    def warn(warning_message)
+      log warning_message.red.bold
     end
 
-    def error(error_message, *params)
-      log(error_message.on_red.white.bold, *params)
+    def error(error_message)
+      log error_message.on_red.white.bold
+    end
+
+    def parse(message)
+      message
     end
 
     private
 
-    def log(message, *params)
-      puts message unless params.include?(:quiet)
+    def log(message)
+      puts message
       message
     end
+
+    def load_debug_messages
+      require 'git_compound/logger/debug/command'
+      require 'git_compound/logger/debug/repository'
+      require 'git_compound/logger/debug/task'
+    end
   end
 end

data/lib/git_compound/logger/debug/command.rb

@@ -0,0 +1,12 @@
+module GitCompound
+  # Debug cases for Command
+  #
+  module Command
+    extend Logger::Debugger
+
+    debug_before(:run) do |command|
+      "GitCompound v#{GitCompound::VERSION}\n" \
+      "Running command `#{command}`"
+    end
+  end
+end

data/lib/git_compound/logger/debug/repository.rb

@@ -0,0 +1,10 @@
+module GitCompound
+  module Repository
+    # Debug messages for GitCommand
+    #
+    class GitCommand
+      extend Logger::Debugger
+      debug_before(:execute!) { "Running Git command `#{@command}`" }
+    end
+  end
+end

data/lib/git_compound/logger/debug/task.rb

@@ -0,0 +1,16 @@
+module GitCompound
+  module Task
+    # Debug messages for Task
+    #
+    class Task
+      extend Logger::Debugger
+
+      debug_before(:execute_on) do |directory|
+        "Executing task `#{@name}` "                 \
+        "defined in manifest `#{@manifest.name}`, "  \
+        "in line `#{@block.source_location.last}`, " \
+        "with directory arg `#{directory}`"
+      end
+    end
+  end
+end

data/lib/git_compound/logger/debugger.rb

@@ -0,0 +1,33 @@
+module GitCompound
+  module Logger
+    # Debugger mixin
+    #
+    module Debugger
+      def debug_before(method, &block)
+        debug(method, :before, &block)
+      end
+
+      def debug_after(method, &block)
+        debug(method, :after, &block)
+      end
+
+      private
+
+      def debug(method, moment, &block)
+        raise GitCompoundError, 'No block given !' unless block
+
+        method_old = "#{method}_old_debugged".to_sym
+        alias_method(method_old, method)
+        private method_old
+
+        define_method(method) do |*args|
+          Logger.debug(instance_exec(*args, &block)) if moment == :before
+          args.insert(0, send(method_old, *args))
+          Logger.debug(instance_exec(*args, &block)) if moment == :after
+
+          args.first
+        end
+      end
+    end
+  end
+end

data/lib/git_compound/repository/git_command.rb

@@ -8,7 +8,7 @@ module GitCompound
       attr_reader :output, :status, :command
 
       def initialize(cmd, args, workdir = nil)
-        @command = "git #{cmd} #{args} 2>&1"
+        @command = "(git #{cmd} #{args}) 2>&1"
         @workdir = workdir
       end
 

data/lib/git_compound/task/task.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module GitCompound
   module Task
     # Base abstract class for task
@@ -21,7 +23,8 @@ module GitCompound
       private
 
       def execute_on(directory, component)
-        @block.call(directory, component)
+        path = Pathname.new(directory).expand_path.to_s
+        @block.call(path, component)
       end
     end
   end

data/lib/git_compound/task/task_all.rb

@@ -10,7 +10,7 @@ module GitCompound
 
       def execute
         @components.each_value do |component|
-          execute_on(component.destination_path, component)
+          execute_on(component.path, component)
         end
       end
 

data/lib/git_compound/task/task_each.rb

@@ -10,7 +10,7 @@ module GitCompound
 
       def execute
         @components.each_value do |component|
-          execute_on(component.destination_path, component)
+          execute_on(component.path, component)
         end
       end
     end

data/lib/git_compound/task/task_single.rb

@@ -10,7 +10,7 @@ module GitCompound
 
       def execute
         if @component
-          execute_on(@component.destination_path, @component.manifest)
+          execute_on(@component.path, @component.manifest)
         else
           # Root manifest without parent
           execute_on(Dir.pwd, @manifest)

data/lib/git_compound/version.rb

@@ -1,5 +1,5 @@
 # GitCompound
 #
 module GitCompound
-  VERSION = '0.0.9'
+  VERSION = '0.0.10'
 end

data/lib/git_compound/worker/component_builder.rb

@@ -10,17 +10,17 @@ module GitCompound
 
       def visit_component(component)
         raise GitCompoundError,
-              "Destination directory `#{component.destination_path}` " \
-              'already exists !' if component.destination_exists?
+              "Destination directory `#{component.path}` " \
+              'already exists !' if component.exists?
 
         Logger.inline 'Building:  '
         @print.visit_component(component)
 
-        component.build
+        component.build!
 
         raise GitCompoundError,
-              "Destination  `#{component.destination_path}` " \
-              'verification failed !' unless component.destination_exists?
+              "Destination  `#{component.path}` " \
+              'verification failed !' unless component.exists?
 
         return unless @lock
         @lock.lock_component(component) unless @lock.find(component)

data/lib/git_compound/worker/component_replacer.rb

@@ -10,13 +10,13 @@ module GitCompound
 
       def visit_component(component)
         raise "Component `#{component.name}` is not built !" unless
-          component.destination_exists?
+          component.exists?
 
         Logger.inline 'Replacing: '
         @print.visit_component(component)
 
         component.remove!
-        component.build
+        component.build!
 
         @lock.lock_component(component)
       end

data/lib/git_compound/worker/component_update_dispatcher.rb

@@ -13,10 +13,8 @@ module GitCompound
       end
 
       def visit_component(component)
-        @component = component
-        @component_exists = component.destination_exists?
-        @repository = component.destination_repository if
-          @component_exists
+        @component  = component
+        @repository = component.repository if component.exists?
 
         case
         when component_needs_building?  then strategy = @build
@@ -38,14 +36,14 @@ module GitCompound
       # does not exist
       #
       def component_needs_building?
-        !@component_exists
+        !@component.exists?
       end
 
       # Component needs updating if it exists, remote origin matches
       # new component origin and HEAD sha has changed
       #
       def component_needs_updating?
-        return false unless @component_exists
+        return false unless @component.exists?
 
         @repository.origin_remote =~ /#{@component.origin}$/ &&
           @repository.head_sha != @component.sha
@@ -55,7 +53,7 @@ module GitCompound
       # remote origin  does not match new component origin
       #
       def component_needs_replacing?
-        return false unless @component_exists
+        return false unless @component.exists?
 
         !(@repository.origin_remote =~ /#{@component.origin}$/)
       end

data/lib/git_compound/worker/component_updater.rb

@@ -10,12 +10,12 @@ module GitCompound
 
       def visit_component(component)
         raise "Component `#{component.name}` is not built !" unless
-          component.destination_exists?
+          component.exists?
 
         Logger.inline 'Updating:  '
         @print.visit_component(component)
 
-        component.update
+        component.update!
 
         @lock.lock_component(component)
       end

data/lib/git_compound/worker/conflicting_dependency_checker.rb

@@ -3,9 +3,6 @@ module GitCompound
     # Worker that detects conflicting dependencies
     #
     class ConflictingDependencyChecker < Worker
-      # TODO: this should collect all components first
-      #       using ComponentsCollector worker
-      #
       def initialize
         @components = []
       end
@@ -22,8 +19,8 @@ module GitCompound
 
       def conflict_exists?(component)
         @components.any? do |other|
-          component.destination_path == other.destination_path &&
-            !(component == other && component.version == other.version)
+          !(component == other && component.version == other.version) &&
+            component.path == other.path
         end
       end
     end

data/lib/git_compound/worker/local_changes_guard.rb

@@ -10,7 +10,7 @@ module GitCompound
 
       def visit_component(component)
         @component  = component
-        @repository = component.destination_repository
+        @repository = component.repository
 
         check_uncommited_changes!
         check_untracked_files!
@@ -33,13 +33,13 @@ module GitCompound
       end
 
       def subcomponents_dirs
-        locked_dirs = @lock.components.map { |locked| "#{locked.destination_path}".chop }
+        locked_dirs = @lock.components.map { |locked| "#{locked.path}".chop }
         component_subdirs = locked_dirs.select do |locked_dir|
-          locked_dir.start_with?(@component.destination_path)
+          locked_dir.start_with?(@component.path)
         end
 
         component_subdirs.collect do |subdir|
-          subdir.sub(/^#{@component.destination_path}/, '').split(File::SEPARATOR).first
+          subdir.sub(/^#{@component.path}/, '').split(File::SEPARATOR).first
         end
       end
     end

data/lib/git_compound/worker/task_runner.rb

@@ -5,6 +5,7 @@ module GitCompound
     #
     class TaskRunner < Worker
       def visit_task(task)
+        Logger.info "Running: `#{task.name}` task"
         task.execute
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_compound
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,10 @@ files:
 - lib/git_compound/logger.rb
 - lib/git_compound/logger/colors.rb
 - lib/git_compound/logger/core_ext/string.rb
+- lib/git_compound/logger/debug/command.rb
+- lib/git_compound/logger/debug/repository.rb
+- lib/git_compound/logger/debug/task.rb
+- lib/git_compound/logger/debugger.rb
 - lib/git_compound/manifest.rb
 - lib/git_compound/node.rb
 - lib/git_compound/repository.rb