bin_script 0.1.6 → 0.1.7

data/.gitignore

@@ -2,3 +2,4 @@ log
 TODO
 locks
 *.gem
+Gemfile.lock

data/Gemfile

@@ -1,11 +1,3 @@
-source "http://rubygems.org"
+source :rubygems
 
-# Will automatically pull in this gem and all its
-# dependencies specified in the gemspec
-gem "bin_script", :path => File.expand_path("..", __FILE__)
-
-gem 'rails'
-gem 'activesupport'
-# These are development dependencies 
-gem "rspec"
-gem 'rake'
+gemspec

data/{README.markdown → README.md}

@@ -16,25 +16,24 @@ Rails 2.3 and 3 compatible
 gem 'bin_script'
 ```
 
-    rails g bin:bin bla
-    (for 2.3 copy generator into lib/generators and run: ./script/generate bin bla)
+    rails generate bin:bin bla
 
 Call like:
 
-    $ cd project && ./bin/bla.rb -e production --test -d "2012-04-07" -u "asdf"
+    $ cd project && ./bin/bla -e production --test -d "2012-04-07" -u "asdf"
 
 Features by default:
 
-    $ ./bin/bla.rb -h
-    $ ./bin/bla.rb -e production 
-    $ ./bin/bla.rb -e production -L ./locks/bla.lock
-    $ ./bin/bla.rb -e production -l ./log/bla.log
-    $ ./bin/bla.rb -e production --daemonize --pidfile=./tmp/bla.pid
+    $ ./bin/bla -h
+    $ ./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
 
 
 Example Bin
 -----------
-app/models/bin/bla_script.rb
+app/bins/bla_script.rb
 
 ``` ruby
 class BlaScript < BinScript
@@ -58,36 +57,24 @@ class BlaScript < BinScript
 end
 ```
 
-### Custom exception notifier (create initializer with:)
+### Options
 
 ``` ruby
-class BinScript
-  def notify_about_error(exception)
-    Mailter.some_notification(exception)...
-  end
+class BlaScript < BinScript
+  self.log_level = Logger::DEBUG
+  self.enable_locking = false
+  self.enable_logging = false
 end
 ```
 
-  
-### Create bin script without loading Rails Environment
-add into file ./bin/bla.rb 
-
-    NO_RAILS=true
-
-example:
+### Custom exception notifier (create initializer with:)
 
 ``` ruby
-NO_RAILS = true
-load Gem.bin_path('bin_script', 'bin_helper')  
+class BinScript
+  def notify_about_error(exception)
+      Mailter.some_notification(exception)...
+  end
+end
 ```
 
-
-### Options
-
-``` ruby
-class BlaScript < BinScript
-  self.log_level = Logger::DEBUG
-  self.enable_locking = false
-  self.enable_logging = false
-end
-```
+        

data/Rakefile

@@ -1,17 +1,8 @@
 require 'rubygems'
-require "bundler"
-Bundler.setup
+require 'bundler/setup'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
-
 task :default => :spec
 RSpec::Core::RakeTask.new(:spec)
-
-require 'rubygems/package_task'
-require 'rubygems/specification'
-
-spec = eval(File.read('bin_script.gemspec'))
-
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end

data/bin_script.gemspec

@@ -21,7 +21,9 @@ For my purposes much better than Rake, Thor and Rails Runner.}
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency 'activesupport', ">=2.3.2"  
+  s.add_dependency 'activesupport'
+  s.add_dependency 'rails'
   s.add_development_dependency "rspec"
-  
+  s.add_development_dependency "rake"
+   
 end

data/lib/bin_script/bin_script.rb

@@ -85,6 +85,10 @@ class BinScript
     def script_name
       self.to_s.underscore.gsub('/','__')
     end
+    
+    def bin_name
+      script_name.gsub('_script', '')
+    end
 
     # Parse script filename. Extract important path parts
     def parse_script_file_name(filename)
@@ -118,7 +122,7 @@ class BinScript
       files = []
 
       # Calculate and add to list file with script class itself
-      class_file = File.join(%w{app models bin}, parts)
+      class_file = File.join(%w{app bins}, parts)
       class_file += '_nagios' if(parts.length > 1)
       class_file += '_script.rb'
       files << class_file
@@ -180,7 +184,7 @@ class BinScript
     def usage(message = nil)
       usage_msg = ''
       usage_msg += "Error: #{message}\n\n" unless message.nil?
-      usage_msg += "Use: ./bin/#{script_name}.rb [OPTIONS]\n\n"
+      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"
       
@@ -258,24 +262,28 @@ class BinScript
     
     check_required_params
     
-    info "====================="
-
     # 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
-      info "Use lock file: #{@lock.path}"
+      
       if(@lock.lock)
-        warn "Lock file '#{@lock.path}' already open in exclusive mode. Exit!"
+        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
+        warn msg
         exit
       end
     end
-
+    
     begin
       # Log important info and call script job
-      info "Log level = #{@logger.level}" if self.class.enable_logging
-      info "Parameters: #{@params_values.inspect}"
-      info "Starting script #{self.class.script_name}..."
+      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
 
       # Инкрементируем счетчик запусков этого скрипта
@@ -283,8 +291,7 @@ class BinScript
 
       do!
       duration = Time.now - start
-      info "Script #{self.class.script_name} finished!"
-      info "Script job duration: #{duration}"
+      info "< Script #{self.class.script_name} finished! (#{"%.4f" % duration.to_f} sec)"
       info "Exit status: #{@exit_status}" if @exit_status
 
       # Инкрементируем время работы э
@@ -311,7 +318,7 @@ class BinScript
 
   # Print usage message and exit
   def usage_exit(message = nil)
-    error "Exit with error message: #{message}"
+    error "Exit with error message: #{message}" if message.present?
     Kernel.puts(self.class.usage(message))
     exit
   end

data/lib/bin_script/version.rb

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

data/lib/generators/bin/bin_generator.rb

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

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

@@ -1,4 +1,9 @@
 #!/usr/bin/env ruby
+#
+# This file was generated by BinScript gem.
+#
+# This bin '<%= file_path %>' is a runner for app/bins/<%= file_path %>_script.rb
+#
 
 require 'pathname'
 path = File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)

data/spec/bin_script_spec.rb

@@ -15,8 +15,8 @@ describe BinScript do
   describe "class name detection" do
     before(:all) do
       @test_date = [
-        {:filename => "/prj/bin/nagios/some.rb", :parts => ['nagios','some'], :class => "Nagios::SomeNagiosScript", :files => ["app/models/nagios_script.rb", "app/models/bin/nagios/some_nagios_script.rb"]},
-        {:filename => "/prj/bin/another.rb", :parts => ['another'], :class => "AnotherScript", :files => ["app/models/bin/another_script.rb"]}
+        {: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"]}
       ]
       @test_keys = [:parts, :class, :files]
     end
@@ -107,7 +107,7 @@ describe BinScript do
   describe "usage" do
     it "should generate usage message" do
       USAGE = <<USAGE
-Use: ./bin/test_script.rb [OPTIONS]
+Use: ./bin/test.rb [OPTIONS]
 
 Availible options:
 
@@ -181,4 +181,4 @@ USAGE
     end
   end
 
-end
+end

metadata

@@ -1,68 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bin_script
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 6
-  version: 0.1.6
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Makarchev Konstantin
 - Lifshits Dmitry
 autorequire: init
 bindir: bin
 cert_chain: []
-
-date: 2012-04-08 00:00:00 +04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-25 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
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 3
-        - 2
-        version: 2.3.2
+    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
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  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
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  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 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Easy writing and executing bins(executable scripts) in Rails Application (especially for crontab or god)
+  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)
 email: kostya27@gmail.com
-executables: 
+executables:
 - bin_helper
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - bin/bin_helper
 - bin_script.gemspec
@@ -80,39 +105,36 @@ files:
 - lib/generators/bin/templates/spec.rb
 - spec/bin_script_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/kostya/bin_script
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 319463119
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 319463119
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 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.
+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.
 test_files: []
-

data/Gemfile.lock

@@ -1,104 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bin_script (0.1.6)
-      activesupport (>= 2.3.2)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.3)
-      actionpack (= 3.2.3)
-      mail (~> 2.4.4)
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
-      builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-    activesupport (3.2.3)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    diff-lcs (1.1.3)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.3)
-    json (1.6.6)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.2.0)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.3)
-      actionmailer (= 3.2.3)
-      actionpack (= 3.2.3)
-      activerecord (= 3.2.3)
-      activeresource (= 3.2.3)
-      activesupport (= 3.2.3)
-      bundler (~> 1.0)
-      railties (= 3.2.3)
-    railties (3.2.3)
-      actionpack (= 3.2.3)
-      activesupport (= 3.2.3)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
-    sprockets (2.1.2)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.32)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  bin_script!
-  rails
-  rake
-  rspec