kitcat 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6c930e9f26d08132fc15fa533107ebd5d8f9c43
-  data.tar.gz: 898f7a3fa58d3b38cf85692aee414b0b9dab82d3
+  metadata.gz: f897bc2d5d9d7171d62f024338a59076cda9cd4e
+  data.tar.gz: b2a8c4e3a483b5e82dd46a5d45dad08feb28f3b8
 SHA512:
-  metadata.gz: 16cec3058a3b816289dfc6b2cf7adc8bea0b210a07103596c4096e66b436012056cfee8d8ae55d5019a27966d1e7951510d7f764e557a5bfc952235d5a21f1db
-  data.tar.gz: d3af7d89498d41509cd026c0ee3f72c1294584d28a2f18e5e8daf19fafa1834ff8777b8ee775072bae413499dcf61b5c4336942a87aa6a3fb5bbcf7a08ac5a16
+  metadata.gz: 42ffa3a76b786a4c30e940f9fc397641d568f297df6398295e8696d66b18c245b84b102fe3e9bfd4b7abeeef4da67652c32e3c0947cdca503afc47b585837519
+  data.tar.gz: 41fad141fa2dbecfb79ebd1d17b8beacdba3dbf17d2632b79ee4742e368121f160d945640fe739b2d5d533bf42f0a3461dc7f28724ce723f8b49bf7c30cba079

data/lib/kitcat/framework.rb

@@ -1,13 +1,20 @@
 require 'ruby-progressbar'
 require 'active_model'
 require 'active_support/core_ext'
+require 'kitcat/logging'
 
 module KitCat
   class Framework
     attr_reader :last_item_processed,
-                :migration_name,
                 :number_of_items_processed,
-                :migration_strategy
+                :migration_strategy,
+                :logging
+
+    delegate :log_file_path,
+             :start_logging, :end_logging,
+             :log_success, :log_failure,
+             :log_interrupt_callback_start,
+             :log_interrupt_callback_finish, to: :logging
 
     # @params migration_strategy {Object}
     #           Instance implementing the methods of +KitCat::Callbacks+
@@ -34,42 +41,24 @@ module KitCat
                    progress_bar: true,
                    progress_bar_output: STDOUT)
       @migration_strategy         = migration_strategy
-      @migration_name             = build_migration_name(migration_name)
       @number_of_items_to_process = number_of_items_to_process
       @last_item_processed        = nil
       @progress_bar               = initialize_progress_bar(progress_bar, progress_bar_output)
+      @logging                    = KitCat::Logging.new(migration_strategy, migration_name)
     end
 
     def execute
-      @interrupted = false
-      Signal.trap('TERM') { @interrupted = true }
-      Signal.trap('INT') { @interrupted = true }
+      trap_signals
+
       start_logging
 
       @number_of_items_processed = 0
 
       items.each do |item|
-        if migration_strategy.process(item)
-
-          log_success(item)
-
-          @number_of_items_processed += 1
-
-          increment_progress_bar
-
-          @last_item_processed = item
-
-          break unless process_more?
-        else
-          log_failure(item)
-
-          break
-        end
-        if @interrupted
-          handle_user_interrupt
-          break
-        end
+        break unless execute_for(item)
       end
+
+    ensure
       end_logging
     end
 
@@ -77,10 +66,6 @@ module KitCat
       @number_of_items_to_process ||= migration_strategy.criteria.count
     end
 
-    def log_file_path
-      @log_file_path ||= File.join(log_dir, build_log_file_name)
-    end
-
     def progress_bar?
       !@progress_bar.nil?
     end
@@ -92,31 +77,58 @@ module KitCat
 
     private
 
-    def items
-      return enum_for(:items) unless block_given?
+    def execute_for(item)
+      begin
+        if migration_strategy.process(item)
 
-      enum = migration_strategy.criteria.each
+          commit_success(item)
 
-      loop do
-        yield enum.next
+          return false unless process_more?
+        else
+          commit_failure(item)
+
+          return false
+        end
+        if @interrupted
+          handle_user_interrupt
+          return false
+        end
+      rescue StandardError
+        commit_failure(item)
+        raise
       end
+
+      true
     end
 
-    def log_dir
-      @log_dir ||= FileUtils.mkdir_p(File.join(Dir.pwd, 'log'))
+    def commit_success(item)
+      log_success(item)
+
+      @number_of_items_processed += 1
+
+      increment_progress_bar
+
+      @last_item_processed = item
     end
 
-    def build_log_file_name
-      "migration-#{migration_name}-#{timestamp}.log"
+    def commit_failure(item)
+      log_failure(item)
     end
 
-    def timestamp
-      Time.now.to_s(:number)
+    def trap_signals
+      @interrupted = false
+      Signal.trap('TERM') { @interrupted = true }
+      Signal.trap('INT') { @interrupted = true }
     end
 
-    def build_migration_name(migration_name)
-      result = migration_name || migration_strategy.class.name.delete(':').underscore.upcase
-      result.gsub(/\W/, '').upcase
+    def items
+      return enum_for(:items) unless block_given?
+
+      enum = migration_strategy.criteria.each
+
+      loop do
+        yield enum.next
+      end
     end
 
     def initialize_progress_bar(progress_bar_flag, output)
@@ -132,39 +144,6 @@ module KitCat
                                          format: "%a %bᗧ%i %p%% %e")
     end
 
-    def start_logging
-      logger.info 'Start Processing...'
-    end
-
-    def end_logging
-      logger.info '...end of processing'
-    end
-
-    def logger
-      @logger ||= Logger.new(log_file_path)
-    end
-
-    def log_success(item)
-      log_line(item) { |method| logger.info "...successfully processed item: #{item.try(method)}" }
-    end
-
-    def log_failure(item)
-      log_line(item) { |method| logger.error "...error while processing item: #{item.try(method)}" }
-    end
-
-    def log_line(item)
-      method = item.respond_to?(:to_log) ? :to_log : :to_s
-      yield method
-    end
-
-    def log_interrupt_callback_start
-      logger.info '...user interrupted, calling interrupt callback on migration strategy...'
-    end
-
-    def log_interrupt_callback_finish
-      logger.info '......end of interrupt callback after user interruption'
-    end
-
     def process_more?
       @number_of_items_to_process.nil? || @number_of_items_processed < @number_of_items_to_process
     end

data/lib/kitcat/logging.rb

@@ -0,0 +1,71 @@
+module KitCat
+  # +KitCat::Logging+ is used to encapsulate the functionality of +Framework+ related to
+  # logging.
+  #
+  # It needs to be initialized with the +migration_name+ because this is used to build the
+  # relevant log filename.
+  #
+  class Logging
+    attr_reader :migration_name, :migration_strategy
+
+    def initialize(migration_strategy, migration_name)
+      @migration_name = build_migration_name(migration_name, migration_strategy)
+    end
+
+    def log_file_path
+      @log_file_path ||= File.join(log_dir, build_log_file_name)
+    end
+
+    def start_logging
+      logger.info 'Start Processing...'
+    end
+
+    def end_logging
+      logger.info '...end of processing'
+    end
+
+    def log_success(item)
+      log_line(item) { |method| logger.info "...successfully processed item: #{item.try(method)}" }
+    end
+
+    def log_failure(item)
+      log_line(item) { |method| logger.error "...error while processing item: #{item.try(method)}" }
+    end
+
+    def log_interrupt_callback_start
+      logger.info '...user interrupted, calling interrupt callback on migration strategy...'
+    end
+
+    def log_interrupt_callback_finish
+      logger.info '......end of interrupt callback after user interruption'
+    end
+
+    private
+
+    def build_migration_name(migration_name, migration_strategy)
+      result = migration_name || migration_strategy.class.name.delete(':').underscore.upcase
+      result.gsub(/\W/, '').upcase
+    end
+
+    def log_dir
+      @log_dir ||= FileUtils.mkdir_p(File.join(Dir.pwd, 'log'))
+    end
+
+    def build_log_file_name
+      "migration-#{migration_name}-#{timestamp}.log"
+    end
+
+    def timestamp
+      Time.now.to_s(:number)
+    end
+
+    def logger
+      @logger ||= Logger.new(log_file_path)
+    end
+
+    def log_line(item)
+      method = item.respond_to?(:to_log) ? :to_log : :to_s
+      yield method
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitcat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-04 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - lib/kitcat/framework.rb
+- lib/kitcat/logging.rb
 - lib/kitcat/terminal_width_calculator.rb
 - lib/kitcat.rb
 - LICENSE