Contents

Rails BinScript
===============

Easy writing and executing bins (espesually for crontab or god) in Rails project.
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

``` ruby
gem 'bin_script'
```

    rails g bin:bin bla
    (for 2.3 copy generator into lib/generators and run: ./script/generate bin bla)

Call like:

    $ cd project && ./bin/bla.rb -e production -t -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



Example Bin
-----------
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"
  
  def test?
    params(:t)
  end

  def do!
    if test?
      logger.info "update string #{params(:u)}"        
    else  
      logger.info "data #{params(:d)}"
    end
  end
end
```

### Custom exception notifier (create initializer with:)

``` ruby
class BinScript
  def notify_about_error(exception)
    Mailter.some_notification(exception)...
  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
```

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
bin_script-0.1.3	README.markdown