batch_manager 0.1.3 → 0.1.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDVkYjIwYTM5NjUxNzliYjE1NDVkNDdmZTg1YmI1ZjRhN2M2NTE5NQ==
+    ZmUxYjIzODRlMmUzZWViNmYyNGZmMjdjMjZlMjZmOGRlYjliMjY1MA==
   data.tar.gz: !binary |-
-    MWZmZWNjM2Q0ZDdjNGU2MGRiMjg4Njc0ODg2ZjI5Njk3ZmRjYmFmOA==
+    YmM2NWMzY2RiN2IyNjRkNTY3ZTg0NDE4ZDExYWQ4Mzc2MzMyYTVjMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NTZlOWM0ZTg2NzcxN2YzZjQ0ODg2ZDM5NjkwNTFmYTRhOTYzNWY1MmE1OTk4
-    NWIzOGQ1NDMyYTkxMGUyOTA2MmJhNjI3YzQ3YTliOTJhY2U2ZWNhYzJmNDYx
-    NmI0YTdmZDQzMzQzM2ZkYTE1NmEyMTQ1NzA5NjMyMDI5MDc4ODE=
+    N2MxMTUyNWJjYjZmYjUzOTRiZTY2MDkxNjEyNzFkODRhM2Q3ZDNlMzU4MTAz
+    ZTRjODMxYTkyOTljMWZlYTA3ZjYwMGUyZWFhZGIwNTIyZjA2MGVlMzg4OTJi
+    ZGRkZjQwNjdlODE0NDgxM2VhZjJjZDQ4ZDUwNTM5ZmMyZjY0YWU=
   data.tar.gz: !binary |-
-    YWQ1Yzk2ODhjMzEwNDQ0YWUxMzcxYzkxNWRiMGIwYjA0OWM0YTdiMTBmMGU3
-    ODZlN2QwNDMzNTExM2IwZmRjOTQ1Zjk1MGYxOTE2ZGE4NDk2NmRhOTAwOGEx
-    M2UxNjI1OTcxYmFmMmIyMjRjY2ZhODBkNTM2MzVlYzk3NDFjMjI=
+    ZjkzNGVlMWVkOGNmYzYzNjExNmVmMTRkNGI5Y2EwMmMyM2M1MDBmNmY2MTg1
+    NTdlNzA2ODQ5YjE3NzIzNTBmNjQ4OGQ1Mjc1MjkxMTUyNjA5MjYzMjViOGM2
+    YTU2MmQ5ZjI5YjliYzBkMWQ4ZjU1NzEzNWVmMGJlZDZlMmVhZjA=

data/README.rdoc

@@ -22,8 +22,8 @@ This will create a table 'schema_batches' like 'schema_migrations' to save the s
 == Configuration
 
   config.batch_manager.batch_dir = "script/batch"
-  # TODO: config.batch_manager.save_log = true
-  # TODO: config.batch_manager.log_dir = "log/batch"
+  config.batch_manager.save_log = true
+  config.batch_manager.log_dir = "log/batch"
 
 You can change the default configuration in config/application.rb
 
@@ -59,6 +59,16 @@ Please use this command instead of 'rails runner' to run batch scripts.
     -f, --force
     -w, --wet
 
+== Logger
+
+Please use Rails.logger in batch scripts to output logs, and then BatchManager will automatically also output logs to the file in the configured log directory.
+
+  Rails.logger.debug
+  Rails.logger.info
+  Rails.logger.warn
+  Rails.logger.error
+  Rails.logger.fatal
+
 == Rake Tasks
 
 show all batches

data/lib/batch_manager/executor.rb

@@ -2,19 +2,31 @@ module BatchManager
   class Executor
     include BatchManager::Utils
 
-    def self.exec(batch_file, options)
-      batch_file_path = batch_full_path(batch_file)
-      if File.exist?(batch_file_path)
-        batch_status = BatchManager::BatchStatus.new(batch_file_path)
-        if options[:force] || batch_status.can_run?
-          @wet = options[:wet]
-          eval File.read(batch_file_path)
-          batch_status.update_schema
+    class << self
+      def exec(batch_file, options = {})
+        batch_file_path = batch_full_path(batch_file)
+        if File.exist?(batch_file_path)
+          batch_status = BatchManager::BatchStatus.new(batch_file_path)
+          if options[:force] || batch_status.can_run?
+            @wet = options[:wet]
+            BatchManager::Logger.new(batch_status.name, @wet)
+            write_log_header(@wet)
+            eval(File.read(batch_file_path))
+            batch_status.update_schema
+            puts "Log saved at: #{Rails.logger.log_file}" if Rails.logger.log_file
+          else
+            raise "Cannot run this batch."
+          end
         else
-          raise "Cannot run this batch."
+          raise "File not exist."
         end
-      else
-        raise "File not exist."
+      end
+
+      def write_log_header(is_wet)
+        Rails.logger.info "=============================="
+        Rails.logger.info "= #{is_wet ? 'WET' : 'DRY'} RUN"
+        Rails.logger.info "= Ran at: #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}"
+        Rails.logger.info "=============================="
       end
     end
   end

data/lib/batch_manager/logger.rb

@@ -0,0 +1,26 @@
+require 'log4r'
+
+module BatchManager
+  class Logger
+    attr_accessor :logger
+    attr_reader :log_file
+    delegate :debug, :info, :warn, :error, :fatal, :add, :to => :logger
+
+    def initialize(batch_name, is_wet)
+      @logger = Log4r::Logger.new(batch_name)
+      @logger.outputters << Log4r::Outputter.stdout
+      if BatchManager.save_log?
+        log_file_name = is_wet ? "#{batch_name}_wet" : batch_name
+        @log_file = log_file_path(log_file_name)
+        @logger.outputters << Log4r::FileOutputter.new(log_file_name, :filename => @log_file)
+      end
+      Rails.logger = self
+    end
+
+    def log_file_path(file_name)
+      file_path = File.join(BatchManager.log_dir, file_name) + ".log"
+      FileUtils.mkdir_p(File.dirname(file_path)) unless File.exist?(file_path)
+      file_path
+    end
+  end
+end

data/lib/batch_manager/monitor.rb

@@ -14,13 +14,13 @@ module BatchManager
       def details
         status_array = []
         Dir.glob(File.join(BatchManager.batch_dir, "**", "*.rb")).sort.each do |f|
-          status_array << BatchManager::BatchStatus.new(f)
+          status_array << self.status(f)
         end
         status_array
       end
 
       def status(file_name)
-        # TODO
+        BatchManager::BatchStatus.new(file_name)
       end
     end
   end

data/lib/batch_manager/version.rb

@@ -1,3 +1,3 @@
 module BatchManager
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/batch_manager.rb

@@ -7,6 +7,16 @@ module BatchManager
       Rails.application.config.batch_manager.batch_dir
     end
 
+    def log_dir
+      path = Rails.application.config.batch_manager.log_dir
+      path = File.join(Rails.root, path) unless path.start_with?("/")
+      path
+    end
+
+    def save_log?
+      Rails.application.config.batch_manager.save_log
+    end
+
     def signal
       "=Batch Manager="
     end
@@ -18,3 +28,4 @@ require 'batch_manager/schema_batch'
 require 'batch_manager/batch_status'
 require 'batch_manager/executor'
 require 'batch_manager/monitor'
+require "batch_manager/logger"

data/lib/generators/batch/templates/active_record/batch.rb

@@ -11,9 +11,9 @@ ActiveRecord::Base.connection.with_standby do
   ActiveRecord::Base.transaction do
 
     if wet_run
-      p "Wet run completed!"
+      Rails.logger.info "Wet run completed!"
     else
-      p "Rolling back."
+      Rails.logger.warn "Rolling back."
       raise ActiveRecord::Rollback
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Weihu Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2013-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +105,7 @@ files:
 - bin/bm_exec
 - lib/batch_manager/batch_status.rb
 - lib/batch_manager/executor.rb
+- lib/batch_manager/logger.rb
 - lib/batch_manager/monitor.rb
 - lib/batch_manager/railtie.rb
 - lib/batch_manager/schema_batch.rb