batch_manager 0.1.4 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmUxYjIzODRlMmUzZWViNmYyNGZmMjdjMjZlMjZmOGRlYjliMjY1MA==
+    MTc0ZWI3YzZkZWQ0Nzk3ZDMzMmYzNDFhNjNkMWIxZjgyM2JhN2YxNw==
   data.tar.gz: !binary |-
-    YmM2NWMzY2RiN2IyNjRkNTY3ZTg0NDE4ZDExYWQ4Mzc2MzMyYTVjMQ==
+    MTU5MTVlMTQ5OTMwODM4ZWJlYTk5OWZlMzM3NGQxN2QzOTRhNDUyNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    N2MxMTUyNWJjYjZmYjUzOTRiZTY2MDkxNjEyNzFkODRhM2Q3ZDNlMzU4MTAz
-    ZTRjODMxYTkyOTljMWZlYTA3ZjYwMGUyZWFhZGIwNTIyZjA2MGVlMzg4OTJi
-    ZGRkZjQwNjdlODE0NDgxM2VhZjJjZDQ4ZDUwNTM5ZmMyZjY0YWU=
+    MTcyZTg1ZGFhMTIyODFlY2M5MzdiYmYxMmVlYjYyMDViMWI2MjY2NmJkYzli
+    ZDI1NzlkNDIwMGNjNjcxMmI1M2EyYmFmZjUzOTgzNzgwM2VlMmRmNDY0NTg1
+    ZmZlYmFlNmFkODlmZjdmZjE2NWVkOWQxNTZiZGU3ODU2NzIwY2E=
   data.tar.gz: !binary |-
-    ZjkzNGVlMWVkOGNmYzYzNjExNmVmMTRkNGI5Y2EwMmMyM2M1MDBmNmY2MTg1
-    NTdlNzA2ODQ5YjE3NzIzNTBmNjQ4OGQ1Mjc1MjkxMTUyNjA5MjYzMjViOGM2
-    YTU2MmQ5ZjI5YjliYzBkMWQ4ZjU1NzEzNWVmMGJlZDZlMmVhZjA=
+    NTU3NjA5M2E3OWRhMTk1ZGU2NTcwMWVjM2NjYjhlYjYxYWYxMDdiMWNkMjBh
+    MTk3ZWE3ODg2M2Q0ZDc2YmYwNGY2ZjkxN2ExOGQyNDAwYWQwNjdlM2ZjMDJl
+    OTUxYzg5Yjk3OThlNzlkOWUxMjBmNjNiNDMyMjI3NGI4MjMwNTY=

data/README.rdoc

@@ -1,4 +1,4 @@
-= BatchManager {<img src="https://travis-ci.org/cctiger36/batch_manager.png?branch=master" alt="Build Status" />}[https://travis-ci.org/cctiger36/batch_manager] {<img src="https://badge.fury.io/rb/batch_manager.png" alt="Gem Version" />}[http://badge.fury.io/rb/batch_manager]
+= BatchManager {<img src="https://travis-ci.org/cctiger36/batch_manager.png?branch=master" alt="Build Status" />}[https://travis-ci.org/cctiger36/batch_manager] {<img src="https://badge.fury.io/rb/batch_manager.png" alt="Gem Version" />}[http://badge.fury.io/rb/batch_manager] {<img src="https://coveralls.io/repos/cctiger36/batch_manager/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/cctiger36/batch_manager?branch=master]
 
 A rails plugin to manage batch scripts similar to migrations.
 
@@ -42,7 +42,6 @@ The generated batch files will have the header like:
   # =Batch Manager=
   # =created_at:  2013-05-24 13:10:25
   # =times_limit: 1
-  # =auto_run:    false
   # =group_name:  GroupName
 
 Add the "=Batch Manager=" to tell BatchManager to manage this batch file.
@@ -61,13 +60,19 @@ Please use this command instead of 'rails runner' to run batch scripts.
 
 == 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.
+Please use BatchManager.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
+  BatchManager.logger.debug
+  BatchManager.logger.info
+  BatchManager.logger.warn
+  BatchManager.logger.error
+  BatchManager.logger.fatal
+
+When batches executed without BatchManager, it will write log to $stdout as default.
+
+== Web interface
+
+The web interface will at http://localhost:3000/batch_manager, you can also execute batches there.
 
 == Rake Tasks
 
@@ -78,9 +83,3 @@ show all batches
 show the details of batches
 
   bundle exec rake batch:details
-
-== TODO
-
-  Save log automatically.
-  Rake tasks to check the status.
-  Admin interface.

data/bin/bm_exec

@@ -16,8 +16,8 @@ end
 ARGV.delete(batch_file)
 
 APP_PATH = File.join('.', 'config', 'application')
-ENV["RAILS_ENV"] = options[:environment] || "development"
 require APP_PATH
+#ENV["RAILS_ENV"] = options[:environment] || "development"
 Rails.application.require_environment!
 
 BatchManager::Executor.exec(batch_file, options)

data/lib/batch_manager/batch_status.rb

@@ -1,7 +1,7 @@
 module BatchManager
   class BatchStatus
     include BatchManager::Utils
-    attr_accessor :name, :created_at, :times_limit, :auto_run, :group_name, :managed
+    attr_accessor :name, :created_at, :times_limit, :group_name, :managed
 
     def initialize(path)
       @name = batch_name(path)
@@ -46,8 +46,6 @@ module BatchManager
             @times_limit = line.sub(/#\s*=times_limit:/, "").strip.to_i
           elsif line.include?("=created_at:")
             @created_at = Time.parse(line.sub(/#\s*=created_at:/, "").strip)
-          elsif line.include?("=auto_run:")
-            @auto_run = line.sub(/#\s*=auto_run:/, "").strip.downcase == "true"
           elsif line.include?("=group_name:")
             @group_name = line.sub(/#\s*=group_name:/, "").strip
           end

data/lib/batch_manager/{railtie.rb → engine.rb}

@@ -1,7 +1,5 @@
-require 'rails'
-
 module BatchManager
-  class Railtie < ::Rails::Railtie
+  class Engine < ::Rails::Engine
     rake_tasks do
       Dir[File.join(File.dirname(__FILE__), '../tasks/*.rake')].each { |f| load f }
     end

data/lib/batch_manager/executor.rb

@@ -7,13 +7,20 @@ module BatchManager
         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)
+          @wet = options[:wet]
+          if !@wet || options[:force] || batch_status.can_run?
+            logger = 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
+            begin
+              eval(File.read(batch_file_path))
+              batch_status.update_schema if @wet
+            rescue => e
+              logger.error e
+              raise e
+            ensure
+              puts "Log saved at: #{BatchManager.logger.log_file}" if logger.log_file
+              logger.close
+            end
           else
             raise "Cannot run this batch."
           end
@@ -23,10 +30,10 @@ module BatchManager
       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 "=============================="
+        BatchManager.logger.info "=============================="
+        BatchManager.logger.info "= #{is_wet ? 'WET' : 'DRY'} RUN"
+        BatchManager.logger.info "= Ran at: #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}"
+        BatchManager.logger.info "=============================="
       end
     end
   end

data/lib/batch_manager/logger.rb

@@ -6,21 +6,31 @@ module BatchManager
     attr_reader :log_file
     delegate :debug, :info, :warn, :error, :fatal, :add, :to => :logger
 
+    class << self
+      def log_file_path(batch_name, is_wet = false)
+        log_file_name = is_wet ? "#{batch_name}_wet" : batch_name
+        File.join(BatchManager.log_dir, log_file_name) + ".log"
+      end
+    end
+
     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)
+        @log_file = prepare_log_file(batch_name, is_wet)
+        @logger.outputters << Log4r::FileOutputter.new(File.basename(@log_file, ".log"), :filename => @log_file)
       end
-      Rails.logger = self
+      BatchManager.logger = self
     end
 
-    def log_file_path(file_name)
-      file_path = File.join(BatchManager.log_dir, file_name) + ".log"
+    def prepare_log_file(batch_name, is_wet)
+      file_path = self.class.log_file_path(batch_name, is_wet)
       FileUtils.mkdir_p(File.dirname(file_path)) unless File.exist?(file_path)
       file_path
     end
+
+    def close
+      BatchManager.logger = nil
+    end
   end
 end

data/lib/batch_manager/version.rb

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

data/lib/batch_manager.rb

@@ -1,7 +1,10 @@
+require 'rails'
 require 'active_record'
-require 'batch_manager/railtie'
+require 'batch_manager/engine'
 
 module BatchManager
+  mattr_accessor :logger
+
   class << self
     def batch_dir
       Rails.application.config.batch_manager.batch_dir
@@ -20,6 +23,10 @@ module BatchManager
     def signal
       "=Batch Manager="
     end
+
+    def logger
+      @@logger ||= ::Logger.new(STDOUT)
+    end
   end
 end
 

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

@@ -2,7 +2,6 @@
 # =Batch Manager=
 # =created_at:  <%= Time.now.strftime "%Y-%m-%d %H:%M:%S" %>
 # =times_limit: 1
-# =auto_run:    false
 
 wet_run = (ARGV[0] == "wet" || @wet)
 
@@ -11,9 +10,9 @@ ActiveRecord::Base.connection.with_standby do
   ActiveRecord::Base.transaction do
 
     if wet_run
-      Rails.logger.info "Wet run completed!"
+      BatchManager.logger.info "Wet run completed!"
     else
-      Rails.logger.warn "Rolling back."
+      BatchManager.logger.warn "Rolling back."
       raise ActiveRecord::Rollback
     end
   end

data/lib/tasks/batch_manager_tasks.rake

@@ -21,7 +21,7 @@ namespace :batch do
       else
         str << "%25s" % ""
       end
-      str << "%25s" % status.created_at.strftime('%Y-%m-%d %H:%M:%S')
+      str << "%25s" % status.created_at.strftime('%Y-%m-%d %H:%M:%S') if status.created_at
       puts str
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: batch_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Weihu Chen
@@ -104,10 +104,10 @@ extra_rdoc_files: []
 files:
 - bin/bm_exec
 - lib/batch_manager/batch_status.rb
+- lib/batch_manager/engine.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
 - lib/batch_manager/utils.rb
 - lib/batch_manager/version.rb