batch_manager 0.2.5 → 0.2.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjVlODRhN2E4NTAyNGM5M2RlYTQzZjJlODdjZDQxNmUzNmJkYzU4MQ==
+    ZGRhOWQ1ZmJhMmU4Nzg3NzJhMmExMWM3ZTZhOWRmYjM0YmFkZTU4NA==
   data.tar.gz: !binary |-
-    ZTNlNWRiYTM0MWU2ZjAwYzQyMDljYTBiNjFhMDQ3YWE5MWYwZjkxNg==
+    Y2U4MGYxY2MwYTI4OGMzNmJiNjJmZTE5Yjg5YjZjOWQzNDcwNjZjZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NTVhYmM4ZDFkZmVlZjExMGFlNTM0MjQ3YzdmYmRmNDQ3YmZiNDI2ODM0NWY4
-    MDM3ODk0ZTM0NTc0ZDZhZmM4ZjkyNjE4YmJhYTJkOTZkMDE2ZTQ4Njg2ZTA2
-    MjM5NDgyZjFhMWI0OGQyZWZlMWVhNzNiNGQ1N2RmOGI1MGVhYTg=
+    Y2YyMDgyNWE3MmYzYTYxMzg3ZTA1Y2Y2NDRhN2M5MjNmMmE4YTE2YWVhYThi
+    OTI1MDVhNzc0OGNlNDk5OTA3MDBlZWJmOTgwNTllYjI3MDVkYjI4NzZhNjRl
+    OTBmZjc1YWIzMThiNGM0ZWMyNWZlYWNhYTk0ZDQxOWI2YWM3MWI=
   data.tar.gz: !binary |-
-    YWQ3ODlkMDQzOWI3ZjkxZDA2ODZhMDVkODdiOTZiOWI4YTYzNWJjMDg5NTJk
-    Mzg5Njg1Yjk2M2UwOTNmODcyMzI4ZmVlYjBiYjg1ZDFjOGRmNWM4ZjkwM2Ni
-    NzM1ZjcyYmM2NDNkODAwNWZjNmEyM2Y1MzlmYjFiMDUxN2E5NTA=
+    MTYzNzhhNWM1ZWE2NTk0MDAwYjk2M2NjZDk2ZTFlMjJjODQ3ZmI3ZTdjNjRm
+    ZGRhNzEwMWVkODFhZmQzMWM1Y2U0NzRhZjE2ZTEzZDY1MjgxZGIyNDIxZjdl
+    YzViOWUzN2U2Y2U5MDJmNTZlZDI0MDlhNGFmNTc0MjkxM2E5MmY=

data/README.md

@@ -0,0 +1,93 @@
+# BatchManager
+
+[![Build Status](https://travis-ci.org/cctiger36/batch_manager.png?branch=master)](https://travis-ci.org/cctiger36/batch_manager) [![Gem Version](https://badge.fury.io/rb/batch_manager.png)](http://badge.fury.io/rb/batch_manager) [![Coverage Status](https://coveralls.io/repos/cctiger36/batch_manager/badge.png?branch=master)](https://coveralls.io/r/cctiger36/batch_manager?branch=master) [![Code Climate](https://codeclimate.com/github/cctiger36/batch_manager.png)](https://codeclimate.com/github/cctiger36/batch_manager)
+
+A rails plugin to manage batch scripts similar to migrations.
+
+## Installation
+
+Add to your Gemfile
+
+    gem 'batch_manager'
+
+and bundle
+
+    bundle
+
+initialize
+
+    bundle exec rails generate batch_manager:migration
+    bundle exec rake db:migrate
+
+This will create a table 'schema_batches' like 'schema_migrations' to save the status of batches in database.
+
+## Configuration
+
+    config.batch_manager.batch_dir = "script/batch"
+    config.batch_manager.save_log = true
+    config.batch_manager.log_dir = "log/batch"
+
+You can change the default configuration in config/application.rb
+
+## Batch Generator
+
+    bundle exec rails g batch test
+
+This will generate the file 'test.rb' in the configured batch_dir with default template.
+
+You can find the template in lib/generators/batch/templates, and modify it for yourself.
+
+## Batch Header
+
+The generated batch files will have the header like:
+
+    # =Batch Manager=
+    # =created_at:  2013-05-24 13:10:25
+    # =times_limit: 1
+    # =group_name:  GroupName
+
+Add the "=Batch Manager=" to tell BatchManager to manage this batch file.
+
+You can also add these headers to the existing batch files.
+
+## Execute Batch
+
+    bundle exec bm_exec [options] BATCH_FILE
+
+Please use this command instead of 'rails runner' to run batch scripts.
+
+    option:
+      -f, --force
+      -w, --wet
+
+## Logger
+
+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.
+
+    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
+
+Mount the web interface in the routes file.
+
+    mount BatchManager::Engine, :at => "batch_manager"
+
+You can also use web interface to execute batches.
+
+If [resque](https://github.com/resque/resque) installed in you application, the batch script can be executed asynchronous. And the log can be checked on real time in the brower.
+
+## Rake Tasks
+
+show all batches
+
+    bundle exec rake batch:list
+
+show the details of batches
+
+    bundle exec rake batch:details

data/app/assets/stylesheets/batch_manager/batches.css

@@ -51,3 +51,8 @@ tr.even.disable {
 tr.odd.disable {
   background-color:#bbbbaa;
 }
+
+#log_box {
+  width: 100%;
+  height:500px;
+}

data/app/controllers/batch_manager/batches_controller.rb

@@ -5,13 +5,41 @@ module BatchManager
     end
 
     def exec
-      BatchManager::Executor.exec(params[:batch_name], :wet => params[:wet])
-      redirect_to(batches_url)
+      @batch_name = params[:batch_name]
+      @wet = params[:wet]
+      if resque_supported?
+        Resque.enqueue(BatchManager::ExecBatchWorker, @batch_name, :wet => @wet)
+        @offset = log_file.size
+      else
+        BatchManager::Executor.exec(@batch_name, :wet => @wet)
+        redirect_to(batches_url)
+      end
+    end
+
+    def async_read_log
+      file = log_file
+      file.seek(params[:offset].to_i) if params[:offset].present?
+      render :json => {:content => file.read, :offset => file.size}
     end
 
     def log
       log_file = BatchManager::Logger.log_file_path(params[:batch_name], params[:wet])
       render :file => log_file, :content_type => Mime::TEXT, :layout => false
     end
+
+    private
+
+    def resque_supported?
+      begin
+        require 'resque'
+        defined?(Resque)
+      rescue
+        false
+      end
+    end
+
+    def log_file
+      File.open(BatchManager::Logger.log_file_path(params[:batch_name], params[:wet]), 'r')
+    end
   end
 end

data/app/views/batch_manager/batches/exec.html.erb

@@ -0,0 +1,22 @@
+<script>
+  function read_log() {
+    offset = $("#offset").val();
+    $.get('<%= async_read_log_batches_url(:batch_name => @batch_name, :wet => @wet) %>' + '&offset=' + offset, function(data) {
+      $("#log_box").val($("#log_box").val() + data.content);
+      $("#offset").val(data.offset);
+      scrollLogBoxDown();
+    });
+  }
+  function scrollLogBoxDown() {
+    var logBox = $('#log_box');
+    logBox.scrollTop(logBox[0].scrollHeight - logBox.height());
+  }
+  $(function() {
+    setInterval(read_log, 1000);
+  });
+</script>
+
+<h2><%= @batch_name %> <%= "WET RUN" if @wet %> Executing!<h2>
+
+<%= text_area_tag :log, nil, :id => "log_box" %>
+<%= hidden_field_tag :offset, @offset, :id => :offset %>

data/app/workers/batch_manager/exec_batch_worker.rb

@@ -0,0 +1,10 @@
+module BatchManager
+  class ExecBatchWorker
+    @queue = "batch_manager"
+
+    def self.perform(batch_name, options = {})
+      BatchManager::Executor.exec(batch_name, :wet => options[:wet])
+    end
+
+  end
+end

data/config/routes.rb

@@ -6,6 +6,7 @@ BatchManager::Engine.routes.draw do
     collection do
       get :exec
       get :log
+      get :async_read_log
     end
   end
 

data/lib/batch_manager/executor.rb

@@ -7,20 +7,8 @@ module BatchManager
         batch_file_path = batch_full_path(batch_file)
         if File.exist?(batch_file_path)
           batch_status = BatchManager::BatchStatus.new(batch_file_path)
-          @wet = options[:wet]
-          if !@wet || options[:force] || batch_status.can_run?
-            logger = BatchManager::Logger.new(batch_status.name, @wet)
-            write_log_header(@wet)
-            begin
-              eval(File.read(batch_file_path))
-              batch_status.update_schema if @wet
-            rescue => e
-              logger.error e
-              logger.error "Failed."
-            ensure
-              puts "Log saved at: #{BatchManager.logger.log_file}" if logger.log_file
-              logger.close
-            end
+          if options[:force] || !options[:wet] || batch_status.can_run?
+            exec_batch_script(batch_file_path, batch_status, options[:wet])
           else
             raise "Cannot run this batch."
           end
@@ -29,6 +17,24 @@ module BatchManager
         end
       end
 
+      protected
+
+      def exec_batch_script(batch_file_path, batch_status, is_wet)
+        logger = BatchManager::Logger.new(batch_status.name, is_wet)
+        write_log_header(is_wet)
+        begin
+          @wet = is_wet
+          eval(File.read(batch_file_path))
+          batch_status.update_schema if is_wet
+        rescue => e
+          logger.error e
+          logger.error "Failed."
+        ensure
+          puts "Log saved at: #{BatchManager.logger.log_file}" if logger.log_file
+          logger.close
+        end
+      end
+
       def write_log_header(is_wet)
         BatchManager.logger.info "=============================="
         BatchManager.logger.info "= #{is_wet ? 'WET' : 'DRY'} RUN"

data/lib/batch_manager/version.rb

@@ -1,3 +1,3 @@
 module BatchManager
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: batch_manager
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Weihu Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A rails plugin to manage batch scripts similar to migrations.
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Manage batches status. Support execute batches from web interface. Automatically
+  save the log to file.
 email:
 - cctiger36@gmail.com
 executables:
@@ -107,8 +122,10 @@ files:
 - app/assets/stylesheets/batch_manager/batches.css
 - app/controllers/batch_manager/application_controller.rb
 - app/controllers/batch_manager/batches_controller.rb
+- app/views/batch_manager/batches/exec.html.erb
 - app/views/batch_manager/batches/index.html.erb
 - app/views/layouts/batch_manager/application.html.erb
+- app/workers/batch_manager/exec_batch_worker.rb
 - config/routes.rb
 - bin/bm_exec
 - lib/batch_manager/batch_status.rb
@@ -127,9 +144,10 @@ files:
 - lib/tasks/batch_manager_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 homepage: https://github.com/cctiger36/batch_manager
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/README.rdoc

@@ -1,89 +0,0 @@
-= 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.
-
-== Installation
-
-Add to your Gemfile
-
-  gem 'batch_manager'
-
-and bundle
-
-  bundle
-
-initialize
-
-  bundle exec rails generate batch_manager:migration
-  bundle exec rake db:migrate
-
-This will create a table 'schema_batches' like 'schema_migrations' to save the status of batches in database.
-
-== Configuration
-
-  config.batch_manager.batch_dir = "script/batch"
-  config.batch_manager.save_log = true
-  config.batch_manager.log_dir = "log/batch"
-
-You can change the default configuration in config/application.rb
-
-== Batch Generator
-
-  bundle exec rails g batch test
-
-This will generate the file 'test.rb' in the configured batch_dir with default template.
-
-You can find the template in lib/generators/batch/templates, and modify it for yourself.
-
-== Batch Header
-
-The generated batch files will have the header like:
-
-  # =Batch Manager=
-  # =created_at:  2013-05-24 13:10:25
-  # =times_limit: 1
-  # =group_name:  GroupName
-
-Add the "=Batch Manager=" to tell BatchManager to manage this batch file.
-
-You can also add these headers to the existing batch files.
-
-== Execute Batch
-
-  bundle exec bm_exec [options] BATCH_FILE
-
-Please use this command instead of 'rails runner' to run batch scripts.
-
-  option:
-    -f, --force
-    -w, --wet
-
-== Logger
-
-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.
-
-  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
-
-Mount the web interface in the routes file.
-
-  mount BatchManager::Engine, :at => "batch_manager"
-
-You can also use web interface to execute batches.
-
-== Rake Tasks
-
-show all batches
-
-  bundle exec rake batch:list
-
-show the details of batches
-
-  bundle exec rake batch:details