bin_script 0.1.2 → 0.1.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bin_script (0.1.2)
+    bin_script (0.1.3)
       activesupport (>= 2.3.2)
 
 GEM

data/README.markdown

@@ -21,10 +21,11 @@ gem 'bin_script'
 
 Call like:
 
-    $ cd project && ./bin/bla.rb -e production -a -b -c -d "asdf"
+    $ cd project && ./bin/bla.rb -e production -t -d "2012-04-07" -u "asdf"
 
-Examples (default features):
+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
@@ -34,10 +35,10 @@ Examples (default features):
 
 Example Bin
 -----------
-app/models/bin/stuff_script.rb
+app/models/bin/bla_script.rb
 
 ``` ruby
-class StuffScript < BinScript
+class BlaScript < BinScript
   optional :u, "Update string"
   required :d, "Date in format YYYY-MM-DD or YYYY-MM"
   noarg    :t, "Test run"
@@ -65,4 +66,27 @@ class BinScript
   end
 end
 ```
-  
+
+  
+### Create bin script without loading Rails Environment
+add into file ./bin/bla.rb 
+
+    NO_RAILS=true
+
+example:
+
+``` ruby
+NO_RAILS = true
+load Gem.bin_path('bin_script', 'bin_helper')  
+```
+
+
+### Disable lock or log
+
+``` ruby
+class Bla < BinScript
+  self.log_level = Logger::DEBUG
+  self.enable_locking = false
+  self.enable_logging = false
+end
+```

data/lib/bin_script/bin_script.rb

@@ -1,7 +1,8 @@
 # -*- encoding: utf-8 -*-
 require 'getoptlong'
 require 'pathname'
-require 'rails' unless defined?(Rails)
+
+require File.dirname(__FILE__) + '/rails_stub'
 require File.dirname(__FILE__) + '/lock_file'
 require File.dirname(__FILE__) + '/xlogger'
 require File.dirname(__FILE__) + '/class_inheritable_attributes'
@@ -19,14 +20,14 @@ class BinScript
       {:key => :L, :type => :optional, :description => "Path to lock file (default \#{Rails.root}/lock/[script_name].lock"}
   ]
 
-  # Default log level INFO or DEBUG for test env
-  @log_level = (Rails.env == 'development' ? XLogger::DEBUG : XLogger::INFO)
-
   # Enable locking by default
   @enable_locking = true
 
   # 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)
 
   # По умолчанию мы при каждом запуске скрипта продолжаем писать в основной лог. Но можно записать сюда формат, который
   # можно скормить time.strftime(format) и результат подставится в конец имени файла лога. Таким образом можно делать
@@ -60,8 +61,8 @@ class BinScript
     # Define class level helper method
     singleton.class_eval do
       define_method :info do |message|
-        return unless Rails.logger
-        Rails.logger.send(method,message)
+        return unless RailsStub.logger
+        RailsStub.logger.send(method,message)
       end
     end
 
@@ -71,7 +72,7 @@ class BinScript
       @logger.send(method,message)
     end
   end
-
+  
   class << self
     # Get parameter by key
     def get_parameter(key)
@@ -131,7 +132,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(rails_root, f) }
+      cfg[:files].each { |f| require File.join(RailsStub.root, f) }
 
       # Create instance and call run! for script class
       klass = cfg[:class].constantize
@@ -165,14 +166,7 @@ class BinScript
       @parameters.each { |p| new << p if p[:key] != key }
       @parameters = new
     end
-
-    # RAILS_ROOT is not availible if rails environment was not loaded. So detect application root in this case from current file path
-    def rails_root
-      path = Rails.root
-      path ||= defined?(APP_ROOT) ? APP_ROOT : '.'
-      Pathname.new(path).realpath.to_s
-    end
-
+    
     # Prepare ARGV parameters as hash
     def get_argv_values
       values = {}
@@ -215,7 +209,7 @@ class BinScript
   end
 
   def puts(*arg)
-    return if self.class.disable_puts_for_tests && Rails.env == 'test'
+    return if self.class.disable_puts_for_tests && RailsStub.env == 'test'
     Kernel.puts(*arg)
   end
 
@@ -224,11 +218,11 @@ class BinScript
     begin
       @source_argv = ARGV.dup
       @overrided_parameters = {}
-      @params_values = (Rails.env == 'test' ? {} : self.class.get_argv_values)
+      @params_values = (RailsStub.env == 'test' ? {} : self.class.get_argv_values)
 
       # Create logger if logging enabled
       if self.class.enable_logging
-        @logger = XLogger.new(:file => log_filename, :dont_touch_rails_logger => (Rails.env == 'test'))
+        @logger = XLogger.new(:file => log_filename, :dont_touch_rails_logger => (RailsStub.env == 'test'))
         @logger.level = self.class.log_level
       end
 
@@ -257,7 +251,7 @@ class BinScript
     begin
       # Log important info and call script job
       info "Log level = #{@logger.level}" if self.class.enable_logging
-      info "Parameters: #{@source_argv.join(', ')}"
+      info "Parameters: #{@params_values.inspect}"
       info "Starting script #{self.class.script_name}..."
       start = Time.now
 
@@ -277,7 +271,7 @@ class BinScript
       log_benchmarker_data
     rescue Exception => e
       # Print error info if it's not test env or exit
-      if Rails.env != 'test' && e.class != SystemExit && e.class != Interrupt 
+      if RailsStub.env != 'test' && e.class != SystemExit && e.class != Interrupt 
         msg = self.class.prepare_exception_message(e)
         puts "\n" + msg
         fatal msg
@@ -334,12 +328,12 @@ class BinScript
 
   # Prepare filename of log file
   def lock_filename
-    params(:L).blank? ? File.join(self.class.rails_root, 'locks', "#{self.class.script_name}.lock") : params(:L)
+    params(:L).blank? ? File.join(RailsStub.root, 'locks', "#{self.class.script_name}.lock") : params(:L)
   end
 
   # Prepare filename of log file
   def log_filename
-    params(:l).blank? ? File.join(self.class.rails_root, 'log', "#{self.class.script_name}#{log_filename_time_part}.log") : params(:l)
+    params(:l).blank? ? File.join(RailsStub.root, 'log', "#{self.class.script_name}#{log_filename_time_part}.log") : params(:l)
   end
 
   private

data/lib/bin_script/rails_stub.rb

@@ -0,0 +1,22 @@
+begin
+  require 'rails' unless defined?(Rails)
+rescue LoadError => e
+end
+
+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 : '.'
+    Pathname.new(path).realpath.to_s
+  end
+
+end

data/lib/bin_script/version.rb

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

data/lib/bin_script/xlogger.rb

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-
 require 'logger'
 
 class XLogger < Logger
@@ -18,14 +17,14 @@ 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
-
-      # This raise warning to STDOUT
-      #Object.const_set "RAILS_DEFAULT_LOGGER", self
+      
+      def Rails.logger
+        ActiveRecord::Base.logger
+      end
     end
 
     self.level = hint[:log_level] || rails_env_log_level
-    log_sql if hint[:log_sql] || !Rails.env.production?
+    log_sql if hint[:log_sql] || !prod_env?
   end
 
   class Formatter < Logger::Formatter
@@ -45,16 +44,22 @@ class XLogger < Logger
   end
 
   def rails_env_log_level
-    Rails.env.production? ? Logger::INFO : Logger::DEBUG
+    prod_env? ? Logger::INFO : Logger::DEBUG
+  end
+  
+  def prod_env?
+    defined?(Rails) && Rails.env.production?
   end
 end
 
-module ActiveRecord
-  module ConnectionAdapters
-    class AbstractAdapter
-      def logger=(val)
-        @logger = val
+if defined?(ActiveRecord)
+  module ActiveRecord
+    module ConnectionAdapters
+      class AbstractAdapter
+        def logger=(val)
+          @logger = val
+        end
       end
     end
   end
-end
+end

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

@@ -28,15 +28,14 @@ class <%= class_name %>Script < BinScript
   #   FATAL	=	4
   #   UNKNOWN	=	5
   #
-  # По умолчанию мы при каждом запуске скрипта продолжаем писать в основной лог. Но можно записать сюда формат, который
-  # можно скормить time.strftime(format) и результат подставится в конец имени файла лога. Таким образом можно делать
-  # отдельные лог-файлы для каждого запуска, для каждого дня/месяца/года/часа и т.д...
-  # Например "_%Y-%m-%d_%H-%M-%S" - каждый запуск новый лог
-  #          "_%Y-%m-%d"          - каждый день новый лог
+  # By default, each bin logging into main log. Possible to specify log name for date.
+  # Examples: "_%Y-%m-%d_%H-%M-%S" - each execute, new log
+  #           "_%Y-%m-%d"          - each day, new log
   # self.date_log_postfix = "_%Y-%m-%d"
 
-  # Do script job!
+  # Execute
   def do!
     logger.info "Script <%= class_name %> works!"
   end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bin_script
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &72761780 !ruby/object:Gem::Requirement
+  requirement: &75985330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 2.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *72761780
+  version_requirements: *75985330
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &72761580 !ruby/object:Gem::Requirement
+  requirement: &75985130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *72761580
+  version_requirements: *75985130
 description: Easy writing and executing bins (espesually for crontab or god) in Rails
   project
 email: kostya27@gmail.com
@@ -55,6 +55,7 @@ files:
 - lib/bin_script/bin_script.rb
 - lib/bin_script/class_inheritable_attributes.rb
 - lib/bin_script/lock_file.rb
+- lib/bin_script/rails_stub.rb
 - lib/bin_script/version.rb
 - lib/bin_script/xlogger.rb
 - lib/generators/bin/bin_generator.rb