git_compound 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06924151a5c14eac3ffebfc3005358de3e85a7e9
-  data.tar.gz: bbb37c1178dea881ad1dbc016fe8047dc028eddd
+  metadata.gz: 5e4d0926ddcd0f190333508583f38a8f2460089d
+  data.tar.gz: 52d2af0cf79c22a69f97b51ba6a090d3debef4dd
 SHA512:
-  metadata.gz: 84227d3ee9e3bb7abd77b61bab4600bd6a3b0d2fbd05a97c6470ac6f2933ea12700772d0a796cc1703254645997e537f000388ea7f0413a4bb6d94ae007a3c5a
-  data.tar.gz: 64797a7958521128971997327b9f23f3ee46fdeafa7e1afe3f45d04b24ec39a9cedec7df20b246abe4a9b7051d67e812722e0e575e5fc3ee7cf784d4dd89c912
+  metadata.gz: 9b357d8c1bbc8b91caf86928fa51415b757614117ec35a4b928650fa39c990969f59a2025de35eb1a00aca7436a6efaa058d884a8fea2080176909a0449d86e7
+  data.tar.gz: 082737730b0039af37388af337798e931e4623f6a363598de1a4bc804f673d3e00e1fa60cbc8d395fe299eec9b23eb5144f4aacfc305d7d404b774af7203418d

data/README.md

@@ -50,7 +50,7 @@ It is particularly useful when you need to develop your project dependencies at
 
 Core features:
 
-*   GitCompound introduces Domain Specific Language desgined for writing manifests.
+*   GitCompound introduces Domain Specific Language designed for writing manifests.
 
 *   Manifest file is used to specify dependencies of your project.
 
@@ -102,6 +102,9 @@ and name constraints
 ## Global options
 
 1.  `--verbose` -- turns debug mode on
+
+    This will show you what happens under the hood. All Git commands, procedure steps and tasks being executed will be printed.
+
 2.  `--disable-colors` -- disables ANSI colors in output
 
 ## Details
@@ -211,13 +214,13 @@ and name constraints
         task :print_component_name, :each do |dir, component|
           puts "Current component name: #{component.name}"
           puts "Current component source: #{component.origin}"
-          puts "Current component destination: #{component.destination_path}"
+          puts "Current component destination: #{component.path}"
 
           puts "Component directory: #{dir}"
         end
         ```
 
-        Note that `dir` here is the same as `component.destination_path`.
+        Note that `dir` here is the same as `component.path`.
 
     *   `:all` type -- run task for all child components of this manifest
 

data/lib/git_compound/command/procedure/build.rb

@@ -11,7 +11,7 @@ module GitCompound
         add_subprocedure :build_lock,     BuildLock
         add_subprocedure :build_manifest, BuildManifest
 
-        def execute
+        step :build do
           if locked?
             subprocedure(:build_lock)
           else

data/lib/git_compound/command/procedure/build_lock.rb

@@ -10,28 +10,21 @@ module GitCompound
 
         add_subprocedure :tasks_runner, Tasks
 
-        def execute
+        step :build_info do
           Logger.info 'Building components from lockfile ...'
-
-          verify_manifest
-          build_locked_components
-          execute_tasks
         end
 
-        private
-
-        def verify_manifest
-          return if @manifest.md5sum == @lock.manifest
-
+        step :verify_manifest do
           raise GitCompoundError,
-                'Manifest md5sum has changed ! Use `update` command.'
+                'Manifest md5sum has changed ! Use `update` command.' unless
+            @manifest.md5sum == @lock.manifest
         end
 
-        def build_locked_components
+        step :build_lock do
           @lock.process(Worker::ComponentDispatcher.new(@lock))
         end
 
-        def execute_tasks
+        step :execute_tasks do
           subprocedure(:tasks_runner)
         end
       end

data/lib/git_compound/command/procedure/build_manifest.rb

@@ -11,30 +11,23 @@ module GitCompound
         add_subprocedure :check_dependencies, Check
         add_subprocedure :tasks_runner,       Tasks
 
-        def execute
+        step :build_info do
           Logger.info 'Building components ...'
-
-          check_dependencies
-          build_manifest
-          execute_tasks
-          lock_manifest
         end
 
-        private
-
-        def check_dependencies
+        step :check do
           subprocedure(:check_dependencies)
         end
 
-        def build_manifest
+        step :build_manifest do
           @manifest.process(Worker::ComponentBuilder.new(@lock))
         end
 
-        def execute_tasks
+        step :execute_tasks do
           subprocedure(:tasks_runner)
         end
 
-        def lock_manifest
+        step :lock_manifest do
           @lock.lock_manifest(@manifest)
           @lock.write
         end

data/lib/git_compound/command/procedure/check.rb

@@ -7,11 +7,11 @@ module GitCompound
         include Element::Manifest
 
         def execute!
-          execute
+          super
           Logger.info 'OK'
         end
 
-        def execute
+        step :check_dependencies do
           Logger.info 'Checking dependencies ...'
 
           @manifest.process(

data/lib/git_compound/command/procedure/help.rb

@@ -4,12 +4,8 @@ module GitCompound
       # Help command procedure
       #
       class Help < Procedure
-        def execute
-          Logger.info(message)
-        end
-
-        def message
-          self.class.message
+        step :print_help do
+          Logger.info(self.class.message)
         end
 
         # rubocop:disable Metrics/AbcSize

data/lib/git_compound/command/procedure/procedure.rb

@@ -16,20 +16,45 @@ module GitCompound
         # Main procedure entry point
         #
         def execute
-          raise NotImplementedError
+          self.class.steps.to_h.keys.each do |name|
+            execute_step(name)
+          end
         end
 
-        # Valid options available for this procedure
-        # see Element::Option
-        #
-        def self.options
-          {}
+        def execute_step(name)
+          step_proc = self.class.steps.to_h[name]
+          instance_eval(&step_proc) if step_proc
         end
 
-        # Name of procedure
-        #
-        def self.to_s
-          name.split('::').last.downcase
+        class << self
+          attr_reader :steps
+
+          # Valid options available for this procedure
+          # see Element::Option
+          #
+          def options
+            {}
+          end
+
+          # Name of procedure
+          #
+          def to_s
+            name.split('::').last
+              .gsub(/::/, '/')
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .tr('-', '_')
+              .downcase
+          end
+
+          private
+
+          def step(name, &block)
+            raise GitCompoundError, 'No block given !' unless block
+
+            @steps = {} unless @steps
+            @steps.store(name, block)
+          end
         end
       end
     end

data/lib/git_compound/command/procedure/show.rb

@@ -8,10 +8,10 @@ module GitCompound
 
         def execute!
           Logger.info 'Processing components list ...'
-          execute
+          super
         end
 
-        def execute
+        step :pretty_print do
           @manifest.process(
             Worker::CircularDependencyChecker.new,
             Worker::PrettyPrint.new)

data/lib/git_compound/command/procedure/tasks.rb

@@ -8,9 +8,8 @@ module GitCompound
         include Element::Option
 
         add_parameter :allow_nested_subtasks, type: :boolean, scope: :global
-        # add_parameter :list, type: Argument::StringBoolean
 
-        def execute
+        step :tasks do
           Logger.info 'Running tasks ...'
 
           if @opts[:allow_nested_subtasks]

data/lib/git_compound/command/procedure/update.rb

@@ -11,44 +11,35 @@ module GitCompound
         add_subprocedure :check_dependencies, Check
         add_subprocedure :tasks_runner,       Tasks
 
-        def execute
+        step :check_lockfile do
           raise GitCompoundError,
                 "Lockfile `#{Lock::FILENAME}` does not exist ! " \
                 'You should use `build` command.' unless locked?
-
-          protect_local_modifications
-          check_dependencies
-          update
-          execute_tasks
-          lock_updated_manifest
-          remove_dormant_components
         end
 
-        private
-
-        def protect_local_modifications
+        step :protect_local_modifications do
           @lock.process(Worker::LocalChangesGuard.new(@lock))
         end
 
-        def check_dependencies
+        step :check_dependencies do
           subprocedure(:check_dependencies)
         end
 
-        def update
+        step :update do
           Logger.info 'Updating components ...'
           @manifest.process(Worker::ComponentDispatcher.new(@lock_new))
         end
 
-        def execute_tasks
+        step :execute_tasks do
           subprocedure(:tasks_runner)
         end
 
-        def lock_updated_manifest
+        step :lock_updated_manifest do
           @lock_new.lock_manifest(@manifest)
           @lock_new.write
         end
 
-        def remove_dormant_components
+        step :remove_dormant_components do
           dormant_components = @lock.components.reject do |component|
             @lock_new.find(component) ? true : false
           end

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

@@ -0,0 +1,15 @@
+module GitCompound
+  module Command
+    module Procedure
+      # Debug cases for Procedure
+      #
+      class Procedure
+        extend Logger::Debugger
+
+        debug_before(:execute_step) do |name|
+          "Executing step `#{name}` in `#{self.class}` procedure"
+        end
+      end
+    end
+  end
+end

data/lib/git_compound/logger.rb

@@ -53,6 +53,7 @@ module GitCompound
       require 'git_compound/logger/debug/command'
       require 'git_compound/logger/debug/repository'
       require 'git_compound/logger/debug/task'
+      require 'git_compound/logger/debug/procedure'
     end
   end
 end

data/lib/git_compound/version.rb

@@ -1,5 +1,5 @@
 # GitCompound
 #
 module GitCompound
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_compound
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Grzegorz Bizon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,7 @@ files:
 - 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/procedure.rb
 - lib/git_compound/logger/debug/repository.rb
 - lib/git_compound/logger/debug/task.rb
 - lib/git_compound/logger/debugger.rb