batch_manager 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzZiMGY4MzliOTI3MTU4MGJlZjU0NDc1MTliMjJmMTE5ZTU1MzgxNA==
+  data.tar.gz: !binary |-
+    MmMzMjdlNzZhNTI5ZTE0MTA1ODY1NGYwMzc3NDljMThlZTJhMTFiOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDY0ZTE3MmI4NWIyNzZkZmZiYTlkNmM5YmFjY2JjM2Y3N2VhNmE3MjAwNDcy
+    ZTE5MGMwZjdiNWU4YjQyMjMwYmM2ZjMyMGViM2M4YzMyN2FkYmNmY2VkNzNk
+    YmQyNTAzM2U0NDg3NGEyMWIxZWIyMmNlNTZhNmM4ZDcwMzBjZDQ=
+  data.tar.gz: !binary |-
+    NTA1ODk5YjczMTdjNDlmNWM5NzQ3NjVhM2RlNDI2YjRhZmVkMjcyNTA1M2Ey
+    ZDAwNTZkNjBkMDRiNzUwNDQ5ZGMwY2VmNWU5YWFmOWU0ZmQyZjkzODlmZDk4
+    ZjIxODE0ZmE5NjM3MzVlMWVhOGE1M2ZkNmY3MjFjZmYxOGVlNTQ=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,60 @@
+= BatchManager
+
+A rails plugin to manage batch scripts similar to migrations.
+
+== Installation
+
+  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"
+  # TODO: config.batch_manager.save_log = true
+  # TODO: 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 look up 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:  <%= Time.now.strftime "%Y-%m-%d %H:%M:%S" %>
+  # =times_limit: 1
+  # =auto_run:    false
+  # =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
+
+== Rake Tasks
+
+  # TODO: rake batch:list
+
+== TODO
+
+  Save log automatically.
+  Rake tasks to check the status.
+  Admin interface.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+desc 'Default: run specs'
+task :default => :spec  
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+Bundler::GemHelper.install_tasks

data/bin/bm_exec

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'optparse'
+require 'batch_manager'
+
+options = {}
+batch_file = nil
+ARGV.clone.options do |opts|
+  opts.banner = "Usage: batch [options] file_name"
+  opts.on("-f", "--force", "Force to run") { options[:force] = true }
+  opts.on("-w", "--wet", "Wet run") { options[:wet] = true }
+  opts.order! { |o| batch_file ||= o } rescue retry
+end
+ARGV.delete(batch_file)
+
+APP_PATH = File.join('.', 'config', 'application')
+ENV["RAILS_ENV"] = options[:environment] || "development"
+require APP_PATH
+Rails.application.require_environment!
+
+BatchManager::Executor.exec(batch_file, options)

data/lib/batch_manager/batch_status.rb

@@ -0,0 +1,62 @@
+module BatchManager
+  class BatchStatus
+    attr_accessor :name, :created_at, :times_limit, :auto_run, :group_name, :path, :managed
+
+    def initialize(path)
+      @path = path
+      @name = File.basename(path, ".rb")
+      File.open path do |f|
+        f.each_line do |line|
+          parse_batch_content line
+        end
+      end
+    end
+
+    def schema_batch
+      BatchManager::SchemaBatch.find_by_name(@name) if @name
+    end
+
+    def update_schema
+      if managed?
+        if schema_batch
+          schema_batch.increment!(:ran_times)
+        else
+          BatchManager::SchemaBatch.create! do |s|
+            s.name = @name
+            s.ran_times = 1
+            s.last_ran_at = Time.now
+          end
+        end
+      end
+    end
+
+    def to_s
+      # TODO
+    end
+
+    def managed?
+      @managed
+    end
+
+    def can_run?
+      @times_limit.to_i <= 0 || @times_limit > schema_batch.try(:ran_times).to_i
+    end
+
+    def parse_batch_content(line)
+      if line.start_with?("#")
+        @managed = true if line.include?(BatchManager.signal)
+        if managed?
+          if line.include?("=times_limit:")
+            @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
+        end
+      end
+    end
+  end
+end

data/lib/batch_manager/executor.rb

@@ -0,0 +1,21 @@
+module BatchManager
+  class Executor
+    include BatchManager::Utils
+
+    def self.exec(batch_file, options)
+      batch_file_path = batch_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
+        else
+          raise "Cannot run this batch."
+        end
+      else
+        raise "File not exist."
+      end
+    end
+  end
+end

data/lib/batch_manager/monitor.rb

@@ -0,0 +1,15 @@
+module BatchManager
+  class Monitor
+    include BatchManager::Utils
+
+    class << self
+      def list
+        # TODO
+      end
+
+      def status(file_name)
+        # TODO
+      end
+    end
+  end
+end

data/lib/batch_manager/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module BatchManager
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../tasks/*.rake')].each { |f| load f }
+    end
+
+    config.batch_manager = ActiveSupport::OrderedOptions.new
+    config.batch_manager.batch_dir = "script/batch"
+    config.batch_manager.save_log = true
+    config.batch_manager.log_dir = "log/batch"
+  end
+end

data/lib/batch_manager/schema_batch.rb

@@ -0,0 +1,4 @@
+module BatchManager
+  class SchemaBatch < ::ActiveRecord::Base
+  end
+end

data/lib/batch_manager/utils.rb

@@ -0,0 +1,18 @@
+module BatchManager
+  module Utils
+    def self.included(base)
+      base.send :include, OverallMethods
+      base.extend OverallMethods
+    end
+
+    module OverallMethods
+      def batch_path(file)
+        if file.start_with?(::BatchManager.batch_dir)
+          file + ".rb"
+        else
+          File.join(::BatchManager.batch_dir, file) + ".rb"
+        end
+      end
+    end
+  end
+end

data/lib/batch_manager/version.rb

@@ -0,0 +1,3 @@
+module BatchManager
+  VERSION = "0.0.1"
+end

data/lib/batch_manager.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+require 'batch_manager/railtie'
+
+module BatchManager
+  class << self
+    def batch_dir
+      Rails.application.config.batch_manager.batch_dir
+    end
+
+    def signal
+      "=Batch Manager="
+    end
+  end
+end
+
+require 'batch_manager/utils'
+require 'batch_manager/schema_batch'
+require 'batch_manager/batch_status'
+require 'batch_manager/executor'
+require 'batch_manager/monitor'

data/lib/generators/batch/batch_generator.rb

@@ -0,0 +1,20 @@
+module Rails
+  module Generators
+    class BatchGenerator < NamedBase
+
+      desc "Generates batch file"
+
+      def self.orm
+        Rails::Generators.options[:rails][:orm]
+      end
+
+      def self.source_root
+        File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+      end
+
+      def create_batch_file
+        template 'batch.rb', "#{BatchManager.batch_dir}/#{file_name}.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+# =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)
+
+ActiveRecord::Base.connection.with_standby do
+
+  ActiveRecord::Base.transaction do
+
+    if wet_run
+      p "Wet run completed!"
+    else
+      p "Rolling back."
+      raise ActiveRecord::Rollback
+    end
+  end
+
+end

data/lib/generators/batch_manager/migration/migration_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module BatchManager
+  class MigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    desc "Generates migration for SchemaBatch models"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), 'templates', (orm.to_s unless orm.class.eql?(String)) )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/batch_manager_migration'
+      end
+    end
+  end
+end

data/lib/generators/batch_manager/migration/templates/active_record/migration.rb

@@ -0,0 +1,14 @@
+class BatchManagerMigration < ActiveRecord::Migration
+  def self.up
+    create_table :schema_batches do |t|
+      t.string :name
+      t.integer :ran_times, :default => 0
+      t.string :last_ran_at
+    end
+    add_index :schema_batches, :name
+  end
+
+  def self.down
+    drop_table :schema_batches
+  end
+end

data/lib/tasks/batch_manager_tasks.rake

@@ -0,0 +1,6 @@
+desc "Execute batch"
+namespace :batch do
+  task :list do
+    # TODO
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: batch_manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Weihu Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  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: A rails plugin to manage batch scripts similar to migrations.
+email:
+- cctiger36@gmail.com
+executables:
+- bm_exec
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/bm_exec
+- lib/batch_manager/batch_status.rb
+- lib/batch_manager/executor.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
+- lib/batch_manager.rb
+- lib/generators/batch/batch_generator.rb
+- lib/generators/batch/templates/active_record/batch.rb
+- lib/generators/batch_manager/migration/migration_generator.rb
+- lib/generators/batch_manager/migration/templates/active_record/migration.rb
+- lib/tasks/batch_manager_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/cctiger36/batch_manager
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A rails plugin to manage batch scripts similar to migrations.
+test_files: []