bin_script 0.1.5 → 0.1.6

data/.gitignore

@@ -1,3 +1,4 @@
 log
+TODO
 locks
-*.gem
+*.gem

data/Gemfile.lock

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

data/README.markdown

@@ -21,7 +21,7 @@ gem 'bin_script'
 
 Call like:
 
-    $ cd project && ./bin/bla.rb -e production -t -d "2012-04-07" -u "asdf"
+    $ cd project && ./bin/bla.rb -e production --test -d "2012-04-07" -u "asdf"
 
 Features by default:
 
@@ -32,7 +32,6 @@ Features by default:
     $ ./bin/bla.rb -e production --daemonize --pidfile=./tmp/bla.pid
 
 
-
 Example Bin
 -----------
 app/models/bin/bla_script.rb
@@ -40,8 +39,10 @@ app/models/bin/bla_script.rb
 ``` ruby
 class BlaScript < BinScript
   optional :u, "Update string"
-  required :d, "Date in format YYYY-MM-DD or YYYY-MM"
-  noarg    :t, "Test run"
+  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)

data/bin/bin_helper

@@ -3,7 +3,7 @@
 
 APP_ROOT ||= File.expand_path(File.dirname($0)) + "/../"
 
-if defined?(DAEMONIZE) || ARGV.include?('--daemonize') # для демонизации бина
+if defined?(DAEMONIZE) || ARGV.include?('--daemonize') # for daemonize bin
   ARGV.delete('--daemonize')
 
   # Stolen from activesupport

data/bin_script.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.name = %q{bin_script}
   s.version = BinScript::VERSION
 
-  s.authors = ["Lifshits Dmitry", "Makarchev Konstantin"]
+  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)}

data/lib/bin_script/bin_script.rb

@@ -10,14 +10,14 @@ 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
+  class_inheritable_attributes :parameters, :log_level, :enable_locking, :enable_logging, :date_log_postfix, :disable_puts_for_tests, :description
   
   # Default parameters
   @parameters = [
-      {:key => :e, :type => :optional, :description => "Rails environment ID (default - development)"},
+      {:key => :e, :type => :required, :description => "Rails environment ID (default - development)"},
       {:key => :h, :type => :noarg,    :description => "Print usage message", :alias => [:H, :help]},
-      {:key => :l, :type => :optional, :description => "Path to log file (default \#{Rails.root}/log/[script_name].log"},
-      {:key => :L, :type => :optional, :description => "Path to lock file (default \#{Rails.root}/lock/[script_name].lock"}
+      {:key => :l, :type => :required, :description => "Path to log file (default \#{Rails.root}/log/[script_name].log)"},
+      {:key => :L, :type => :required, :description => "Path to lock file (default \#{Rails.root}/locks/[script_name].lock)"}
   ]
 
   # Enable locking by default
@@ -28,16 +28,16 @@ class BinScript
   
   # Default log level INFO or DEBUG for test env
   @log_level = (RailsStub.env == 'development' ? XLogger::DEBUG : XLogger::INFO)
+  
+  # Bin Description
+  @description = nil
 
-  # По умолчанию мы при каждом запуске скрипта продолжаем писать в основной лог. Но можно записать сюда формат, который
-  # можно скормить 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
   @date_log_postfix = ''
 
-  # По умолчанию puts работает как обычно, но BinScript может ничего не выводить если RAILS_ENV=test
-  # Если скрипт что-то выводит, это попадает в лог спеков, что не красиво. Так что для таких скриптов лучше включать эту опцию
+  # BinScript can output with puts, for specs puts is not good, this option disable puts in test env
   @disable_puts_for_tests = false
 
   # Allowed parameter types. Equivalence aliases with GetoptLong constants.
@@ -180,9 +180,17 @@ 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\nAvailible options:\n\n"
+      usage_msg += "Use: ./bin/#{script_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|
-        usage_msg += "  #{prefix_key param[:key]}  #{param[:description]}\n"
+        arg = case param[:type]
+          when :required then " v "
+          when :optional then "[v]"
+          when :noarg    then "   "
+        end
+        usage_msg += "  #{prefix_key param[:key]}#{arg} #{param[:description]}\n"
       end
       usage_msg += "\n"
       usage_msg
@@ -230,6 +238,17 @@ 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])
+        if @params_values[param[:key]].nil?
+          error "Param #{param[:key]} require value, but not present"
+          usage_exit
+        end
+      end
+    end
+  end
 
   # Create lock file, call script code and unlock file even if error happend.
   def run!
@@ -237,6 +256,8 @@ class BinScript
     # Print usage and exit if asked
     usage_exit if params(:h)
     
+    check_required_params
+    
     info "====================="
 
     # Create and check lock file if enabled
@@ -320,7 +341,6 @@ class BinScript
     when :noarg
       return (@overrided_parameters.has_key?(key) && @overrided_parameters[key]) || !@params_values[key].nil?
     when :optional
-      #return nil unless @overrided_parameters.has_key?(key) || @params_values.has_key?(key)
       return @overrided_parameters[key] || @params_values[key] || param[:default]
     when :required
       value = @overrided_parameters[key] || @params_values[key] || param[:default]

data/lib/bin_script/version.rb

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

data/lib/bin_script/xlogger.rb

@@ -48,7 +48,7 @@ class XLogger < Logger
   end
   
   def prod_env?
-    defined?(Rails) && Rails.env.production?
+    defined?(Rails) && Rails.env == 'production'
   end
 end
 

data/spec/bin_script_spec.rb

@@ -111,13 +111,13 @@ Use: ./bin/test_script.rb [OPTIONS]
 
 Availible options:
 
-  -e  Rails environment ID (default - development)
-  -h  Print usage message
-  -l  Path to log file (default \#{Rails.root}/log/[script_name].log
-  -L  Path to lock file (default \#{Rails.root}/lock/[script_name].lock
-  -n  Test parameter that can't have argument
-  -o  Test parameter that can have argument
-  -r  Test parameter that should have argument
+  -e v  Rails environment ID (default - development)
+  -h    Print usage message
+  -l v  Path to log file (default \#{Rails.root}/log/[script_name].log)
+  -L v  Path to lock file (default \#{Rails.root}/locks/[script_name].lock)
+  -n    Test parameter that can't have argument
+  -o[v] Test parameter that can have argument
+  -r v  Test parameter that should have argument
 
 USAGE
       TestScript.usage.should == USAGE

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: bin_script
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 1
-  - 5
-  version: 0.1.5
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
-- Lifshits Dmitry
 - Makarchev Konstantin
+- Lifshits Dmitry
 autorequire: init
 bindir: bin
 cert_chain: []