bin_script 0.1.7 → 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b2ee1ee087b3240b53907521e8f6c97c2c708b6
+  data.tar.gz: 377c4055de2c116da0215a4a79a36f4abca0f0b0
+SHA512:
+  metadata.gz: 6f2c8cfd1e6df3a5456320fb99bcf7deaf8b32dcca082290400e559346302cfbae3d17a273ec435d3e6533d5d5df523454cd67eb5200a28a6297acba3dbb66bc
+  data.tar.gz: d8c538593c4e25472e13f4c673f9078cdefdcf400cba67701564caaa136aac6353ec999bb61a69d7a15864413da96ce8cc9edae8efedfc624d25410cd414a95f

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
-gemspec
+gemspec

data/README.md

@@ -1,16 +1,17 @@
 Rails BinScript
 ===============
 
-Easy writing and executing bins(executable scripts) in Rails Application (especially for crontab or god).
-For my purposes much better than Rake, Thor and Rails Runner.
+Gem for easy writing and executing scripts in Rails Application. For my purposes much better than Rake, Thor and Rails Runner.
 
 Features:
 
 1. Each bin is a class
 2. Easy writing tests
-3. Bin use lock file and logger with formatter when executing
-  
-Rails 2.3 and 3 compatible
+3. Custom lock file
+4. Custom logger with formatter for each script
+5. Can be daemonized
+
+Tested on Rails 2.3 and 3.2
 
 ``` ruby
 gem 'bin_script'
@@ -22,10 +23,10 @@ Call like:
 
     $ cd project && ./bin/bla -e production --test -d "2012-04-07" -u "asdf"
 
-Features by default:
+Call examples:
 
     $ ./bin/bla -h
-    $ ./bin/bla -e production 
+    $ ./bin/bla -e production
     $ ./bin/bla -e production -L ./locks/bla.lock
     $ ./bin/bla -e production -l ./log/bla.log
     $ ./bin/bla -e production --daemonize --pidfile ./tmp/bla.pid
@@ -40,17 +41,17 @@ class BlaScript < BinScript
   optional :u, "Update string"
   required :d, :description => "Date in format YYYY-MM-DD or YYYY-MM", :default => "2012-04-01"
   noarg    :t, :decription => "Test run", :alias => 'test'
-  
+
   self.description = "Super Bla script"
-  
+
   def test?
     params(:t)
   end
 
   def do!
     if test?
-      logger.info "update string #{params(:u)}"        
-    else  
+      logger.info "update string #{params(:u)}"
+    else
       logger.info "data #{params(:d)}"
     end
   end
@@ -72,9 +73,9 @@ end
 ``` ruby
 class BinScript
   def notify_about_error(exception)
-      Mailter.some_notification(exception)...
+    Mailter.some_notification(exception)...
   end
 end
 ```
 
-        
+

data/bin_script.gemspec

@@ -7,14 +7,13 @@ Gem::Specification.new do |s|
 
   s.authors = ["Makarchev Konstantin", "Lifshits Dmitry"]
   s.autorequire = %q{init}
-  
-  s.description = %q{Easy writing and executing bins(executable scripts) in Rails Application (especially for crontab or god)}
-  
-  s.summary = %q{Easy writing and executing bins(executable scripts) in Rails Application (especially for crontab or god).
-For my purposes much better than Rake, Thor and Rails Runner.}
+
+  s.description = s.summary = \
+    %q{Gem for easy writing and executing scripts in Rails Application. For my purposes much better than Rake, Thor and Rails Runner.}
 
   s.email = %q{kostya27@gmail.com}
   s.homepage = %q{http://github.com/kostya/bin_script}
+  s.license = "MIT"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
@@ -23,7 +22,8 @@ For my purposes much better than Rake, Thor and Rails Runner.}
 
   s.add_dependency 'activesupport'
   s.add_dependency 'rails'
+
   s.add_development_dependency "rspec"
   s.add_development_dependency "rake"
-   
-end
+
+end

data/lib/bin_script/bin_script.rb

@@ -11,7 +11,7 @@ require File.dirname(__FILE__) + '/class_inheritable_attributes'
 class BinScript
   include ClassLevelInheritableAttributes
   class_inheritable_attributes :parameters, :log_level, :enable_locking, :enable_logging, :date_log_postfix, :disable_puts_for_tests, :description
-  
+
   # Default parameters
   @parameters = [
       {:key => :e, :type => :required, :description => "Rails environment ID (default - development)"},
@@ -25,10 +25,10 @@ class BinScript
 
   # Enable logging by default
   @enable_logging = true
-  
+
   # Default log level INFO or DEBUG for test env
   @log_level = (RailsStub.env == 'development' ? XLogger::DEBUG : XLogger::INFO)
-  
+
   # Bin Description
   @description = nil
 
@@ -72,7 +72,7 @@ class BinScript
       @logger.send(method,message)
     end
   end
-  
+
   class << self
     # Get parameter by key
     def get_parameter(key)
@@ -85,7 +85,7 @@ class BinScript
     def script_name
       self.to_s.underscore.gsub('/','__')
     end
-    
+
     def bin_name
       script_name.gsub('_script', '')
     end
@@ -121,14 +121,14 @@ class BinScript
     def calculate_script_class_filename(parts)
       files = []
 
-      # Calculate and add to list file with script class itself
-      class_file = File.join(%w{app bins}, parts)
-      class_file += '_nagios' if(parts.length > 1)
-      class_file += '_script.rb'
-      files << class_file
+      # Collect from disk, needed class files
+      parts.each do |p|
+        off = "app/{bin,bins,models,script,scripts}/**/#{p}_script.rb"
+        files += Dir[File.join(RailsStub.root, off)]
 
-      # Add intermediate classes
-      parts[0..-2].each { |p| files << "app/models/#{p}_script.rb" }
+        off = "script/**/#{p}_script.rb"
+        files += Dir[File.join(RailsStub.root, off)]
+      end
 
       files.reverse
     end
@@ -136,7 +136,7 @@ class BinScript
     # Run script detected by the filename of source script file
     def run_script(filename = $0)
       cfg = parse_script_file_name(Pathname.new(filename).realpath.to_s)
-      cfg[:files].each { |f| require File.join(RailsStub.root, f) }
+      cfg[:files].each { |f| require f }
 
       # Create instance and call run! for script class
       klass = cfg[:class].constantize
@@ -170,7 +170,7 @@ class BinScript
       @parameters.each { |p| new << p if p[:key] != key }
       @parameters = new
     end
-    
+
     # Prepare ARGV parameters as hash
     def get_argv_values
       values = {}
@@ -187,7 +187,7 @@ class BinScript
       usage_msg += "Use: ./bin/#{bin_name}.rb [OPTIONS]\n\n"
       usage_msg += "\"#{self.description}\"\n\n" if message.nil? && self.description.present?
       usage_msg += "Availible options:\n\n"
-      
+
       @parameters.each do |param|
         arg = case param[:type]
           when :required then " v "
@@ -200,7 +200,8 @@ class BinScript
       usage_msg
     end
 
-    private
+  private
+
     # Prepare parameters in Getoptlong lib format
     def get_getoptlong_params
       result = []
@@ -242,7 +243,7 @@ class BinScript
       usage_exit e.message
     end
   end
-  
+
   def check_required_params
     self.class.parameters.each do |param|
       if param[:type] == :required && @params_values.has_key?(param[:key])
@@ -259,14 +260,14 @@ class BinScript
 
     # Print usage and exit if asked
     usage_exit if params(:h)
-    
+
     check_required_params
-    
+
     # Create and check lock file if enabled
     if self.class.enable_locking
       @lock = LockFile.new(lock_filename)
       @lock.quiet = true # Don't write errors to STDERR
-      
+
       if(@lock.lock)
         msg = "--- Try start. Buy lock file '#{@lock.path}' already open in exclusive mode. Exit! ---"
         # puts msg # puts is not good idea, because cron will mail it, but this is not error
@@ -274,16 +275,16 @@ class BinScript
         exit
       end
     end
-    
+
     begin
       # Log important info and call script job
       info ""
-      
+
       log_params = {:env => RailsStub.env, :log_level => (self.class.enable_logging ? @logger.level : nil), :lock_file => (self.class.enable_locking ? @lock.path : nil)}
-      
+
       info "> Script #{self.class.script_name} started! (#{log_params.inspect})"
       info "- Parameters: #{@params_values.inspect}"
-      
+
       start = Time.now
 
       # Инкрементируем счетчик запусков этого скрипта
@@ -301,11 +302,15 @@ class BinScript
       log_benchmarker_data
     rescue Exception => e
       # Print error info if it's not test env or exit
-      if RailsStub.env != 'test' && e.class != SystemExit && e.class != Interrupt 
+
+      exit_mes = (e.class == SystemExit) || (e.class == Interrupt) || (e.class == SignalException) || (RailsStub.env == 'test')
+      unless exit_mes
         msg = self.class.prepare_exception_message(e)
         puts "\n" + msg
         fatal msg
         notify_about_error(e)
+      else
+        error "Get exit message! #{e.message}"
       end
 
       # Инкрементируем счетчик ошибок этого скрипта
@@ -365,7 +370,7 @@ class BinScript
     params(:l).blank? ? File.join(RailsStub.root, 'log', "#{self.class.script_name}#{log_filename_time_part}.log") : params(:l)
   end
 
-  private
+private
 
   # Current time logname part.
   def log_filename_time_part
@@ -404,11 +409,11 @@ EXCEPTION
   end
 
   def inc_counter(id, counter = 1)
-    # stub    
+    # stub
   end
-  
+
   def notify_about_error(ex)
     # stub
   end
-  
-end
+
+end

data/lib/bin_script/rails_stub.rb

@@ -8,11 +8,11 @@ module RailsStub
   def self.env
     defined?(Rails) ? Rails.env : ENV['RAILS_ENV']
   end
-  
+
   def self.logger
     defined?(Rails) ? Rails.logger : nil
   end
-  
+
   def self.root
     path = defined?(Rails) ? Rails.root : nil
     path ||= defined?(APP_ROOT) ? APP_ROOT : '.'

data/lib/bin_script/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding: utf-8 -*-
 class BinScript
-  VERSION = "0.1.7"
-end
+  VERSION = "0.1.8"
+end

data/lib/bin_script/xlogger.rb

@@ -17,7 +17,7 @@ class XLogger < Logger
     # Don't change default logger if asked
     if hint[:dont_touch_rails_logger].blank? && defined?(ActiveRecord::Base)
       ActiveRecord::Base.logger = self
-      
+
       def Rails.logger
         ActiveRecord::Base.logger
       end
@@ -46,7 +46,7 @@ class XLogger < Logger
   def rails_env_log_level
     prod_env? ? Logger::INFO : Logger::DEBUG
   end
-  
+
   def prod_env?
     defined?(Rails) && Rails.env == 'production'
   end

data/lib/generators/bin/bin_generator.rb

@@ -6,6 +6,7 @@ if Rails::VERSION::MAJOR >= 3
       source_root File.expand_path("../templates", __FILE__)
 
       def add_files
+        file_name.sub!('_script', '')
         template "script.rb", "bin/#{file_path}"
         template "script_class.rb", "app/bins/#{file_path}_script.rb"
         template "spec.rb", "spec/bins/#{file_path}_script_spec.rb"
@@ -22,6 +23,7 @@ if Rails::VERSION::MAJOR == 2
   class BinGenerator < Rails::Generator::NamedBase
     def manifest
       record do |m|
+        file_name.sub!('_script', '')
         m.template "script.rb", "bin/#{file_path}", :chmod => 0755
         m.template "script_class.rb", "app/bins/#{file_path}_script.rb"
         m.directory "spec/bins"

data/lib/generators/bin/templates/script_class.rb

@@ -37,5 +37,5 @@ class <%= class_name %>Script < BinScript
   def do!
     logger.info "Script <%= class_name %> works!"
   end
-  
+
 end

data/lib/generators/bin/templates/spec.rb

@@ -1,12 +1,12 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../spec_helper'
 
 describe <%= class_name %>Script do
   before :each do
     @bin = <%= class_name %>Script.new
-    
+
     # if want to point some params into bin => @bin.override_parameters({:i => 10, :a => '20'})
   end
-  
+
   it 'should do! and not raise' do
     @bin.do!
   end

data/spec/bin_script_spec.rb

@@ -2,10 +2,10 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 describe BinScript do
   before :each do
-    root = Pathname.new(File.dirname(__FILE__) + '/../').realpath.to_s
-    Rails.stub!(:root).and_return(root)
+    root = Pathname.new(File.dirname(__FILE__) + '/test_dir/').realpath.to_s
+    Rails.stub(:root).and_return(root)
   end
-  
+
   class TestScript < BinScript
     noarg    :n, "Test parameter that can't have argument"
     optional :o, :description => "Test parameter that can have argument", :alias => :oo
@@ -13,10 +13,14 @@ describe BinScript do
   end
 
   describe "class name detection" do
-    before(:all) do
+    before(:each) do
       @test_date = [
-        {:filename => "/prj/bin/nagios/some.rb", :parts => ['nagios','some'], :class => "Nagios::SomeNagiosScript", :files => ["app/models/nagios_script.rb", "app/bins/nagios/some_nagios_script.rb"]},
-        {:filename => "/prj/bin/another.rb", :parts => ['another'], :class => "AnotherScript", :files => ["app/bins/another_script.rb"]}
+        {:filename => "/prj/bin/bluh", :parts => ['bluh'], :class => "BluhScript", :files => [File.join(Rails.root, "/app/models/bluh_script.rb")]},
+        {:filename => "/prj/bin/blah", :parts => ['blah'], :class => "BlahScript", :files => [File.join(Rails.root, "/app/bins/blah_script.rb")]},
+        {:filename => "/prj/bin/bleh", :parts => ['bleh'], :class => "BlehScript", :files => [File.join(Rails.root, "/app/models/bin/bleh_script.rb")]},
+        {:filename => "/prj/bin/bloh", :parts => ['bloh'], :class => "BlohScript", :files => [File.join(Rails.root, "/app/bins/1/bloh_script.rb")]},
+        {:filename => "/prj/bin/blih", :parts => ['blih'], :class => "BlihScript", :files => [File.join(Rails.root, "/script/blih_script.rb")]},
+        {:filename => "/prj/bin/bljh", :parts => ['bljh'], :class => "BljhScript", :files => [File.join(Rails.root, "/app/scripts/66/bljh_script.rb")]},
       ]
       @test_keys = [:parts, :class, :files]
     end

data/spec/test_dir/app/bins/1/bloh_script.rb

@@ -0,0 +1,6 @@
+class BlohScript < BinScript
+
+  def do!
+  end
+
+end

data/spec/test_dir/app/bins/blah_script.rb

@@ -0,0 +1,6 @@
+class BlahScript < BinScript
+
+  def do!
+  end
+
+end

data/spec/test_dir/app/models/bin/bleh_script.rb

@@ -0,0 +1,6 @@
+class BlehScript < BinScript
+
+  def do!
+  end
+
+end

data/spec/test_dir/app/models/bluh_script.rb

@@ -0,0 +1,6 @@
+class BluhScript < BinScript
+
+  def do!
+  end
+
+end

data/spec/test_dir/app/scripts/66/bljh_script.rb

@@ -0,0 +1,6 @@
+class BljhScript < BinScript
+
+  def do!
+  end
+
+end

data/spec/test_dir/script/blih_script.rb

@@ -0,0 +1,6 @@
+class BlihScript < BinScript
+
+  def do!
+  end
+
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bin_script
 version: !ruby/object:Gem::Version
-  version: 0.1.7
-  prerelease: 
+  version: 0.1.8
 platform: ruby
 authors:
 - Makarchev Konstantin
@@ -10,74 +9,66 @@ authors:
 autorequire: init
 bindir: bin
 cert_chain: []
-date: 2012-08-25 00:00:00.000000000 Z
+date: 2013-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Easy writing and executing bins(executable scripts) in Rails Application
-  (especially for crontab or god)
+description: Gem for easy writing and executing scripts in Rails Application. For
+  my purposes much better than Rake, Thor and Rails Runner.
 email: kostya27@gmail.com
 executables:
 - bin_helper
@@ -105,36 +96,35 @@ files:
 - lib/generators/bin/templates/spec.rb
 - spec/bin_script_spec.rb
 - spec/spec_helper.rb
+- spec/test_dir/app/bins/1/bloh_script.rb
+- spec/test_dir/app/bins/blah_script.rb
+- spec/test_dir/app/models/bin/bleh_script.rb
+- spec/test_dir/app/models/bluh_script.rb
+- spec/test_dir/app/scripts/66/bljh_script.rb
+- spec/test_dir/script/blih_script.rb
 homepage: http://github.com/kostya/bin_script
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 319463119
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 319463119
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
-summary: Easy writing and executing bins(executable scripts) in Rails Application
-  (especially for crontab or god). For my purposes much better than Rake, Thor and
-  Rails Runner.
+specification_version: 4
+summary: Gem for easy writing and executing scripts in Rails Application. For my purposes
+  much better than Rake, Thor and Rails Runner.
 test_files: []