Skip to content

Ruby Blender

  • Blog
  • About
  • Archives
  • Log in
 
Less
More
Trim
Untrim
« Older
Home
Loading
Newer »
Archive for August, 2009
21Aug09 Arguments with Trollop
ruby rubygems
0 Comments

At various points in my life, I’ve used many methods of parsing command line options, from rolling my own, to using getopt or other libraries.  Recently I came across a new one which has its own view of how to parse commandline arguments.

Trollop is, as they put it, “Yet Another Fine CommandLine Argument Parsing Library” (YAFCLAP).  It’s goal is to be as easy as possible.  You can install it as a single file in lib, or use it as a gem.  Trollop doesn’t care.  To install, you can download it from rubyforge, or use the ever popular:

gem install trollop

(you may need to prepend sudo, or run it as root).

Let’s take a look at a simple example:

require 'rubygems'
require 'trollop'
opts = Trollop::options do
opt :host, "Host to connect to", :default => "localhost"
opt :port, "jmx remote port", :default => 4444
opt :interval, "How often do we poll (in seconds)", :default => 10
opt :count, "How many intervals, 0 == infinite, use ^C (SIGINT) to exit and write output", :default => 0
end
p opts

 

The first argument to opt is the name of the option.  We don’t have to specify a switch; it’s smart enough to figure out a mapping for them.  The second is a description of the argument.  You can specify a default value and/or a type.  In this example, we’ve specified defaults.  And here it is in use:

$ ruby trollop_simple.rb
{:interval=>10, :count=>0, :help=>false, :host=>"localhost", :port=>4444}
$ ruby trollop_simple.rb -h
Error: option '-h' needs a parameter.
Try --help for help.
$ ruby trollop_simple.rb --help
Options:
--host, -h : Host to connect to (default: localhost)
--port, -p : jmx remote port (default: 4444)
--interval, -i : How often do we poll (in seconds) (default: 10)
--count, -c : How many intervals, 0 == infinite, use ^C (SIGINT) to
exit and write output (default: 0)
--help, -e: Show this message

Notice that it has set up mappings for us as well as created a nicely formatted help — though it’s a default, without a lot of information.   Let’s add a version and usage:

require 'rubygems'
require 'trollop'
opts = Trollop::options do
version < "localhost"
opt :port, "jmx remote port", :default => 4444
opt :interval, "How often do we poll (in seconds)", :default => 10
opt :count, "How many intervals, 0 == infinite, use ^C (SIGINT) to exit and write output", :default => 0
end
p opts

Now let’s see what we have:

$ ruby trollop_simple.rb --help
jmx_mon is a program to monitor a jmx bean's value over time.
It can output the data as a csv, a graph in a pdf, or both.

Usage jmx_mon [options]
where [options] are:
--host, -h : Host to connect to (default: localhost)
--port, -p : jmx remote port (default: 4444)
--interval, -i : How often do we poll (in seconds) (default: 10)
--count, -c : How many intervals, 0 == infinite, use ^C (SIGINT) to
exit and write output (default: 0)
--version, -v: Print version and exit
--help, -e: Show this message

$ ruby trollop_simple.rb -v
jmx_mon -- we be jammin' with version zz9-za aka Arthur Dent
Don't forget your towel!

We now have a nicer usage, as well as version.  Also, it will stop automagickally if we ask for help or the version.

All of the options are placed in the opts hash; let’s see what we can do with it:

require 'rubygems'
require 'trollop'

aliases = {
:MEMORY_HEAP => "Heap memory usage, multiple values",
:MEMORY_HEAP_USED => "Used heap memory"
}

opts = Trollop::options do
version < "localhost"
opt :port, "jmx remote port", :default => 4444
opt :interval, "How often do we poll (in seconds)", :default => 10
opt :count, "How many intervals, 0 == infinite, use ^C (SIGINT) to exit and write output", :default => 0
opt :aliases, "Print defined bean aliases & exit.", :default => false
opt :towel, "Don't forget this!", :default => false
end

if opts[:aliases_given]
aliases.each_pair do |key, value|
puts "#{key}: #{value}"
end
exit
end

Trollop::die :towel, "You forgot your towel. You've been eaten by a Ravenous Bugblatter Beast of Traal" unless opts[:towel]

p opts

We’ve added two more options, one for printing out aliases, and another indicating whether or not you have your towel — with deadly results should you forget.

$ ruby trollop_simple.rb -a
MEMORY_HEAP: Heap memory usage, multiple values
MEMORY_HEAP_USED: Used heap memory

$ ruby trollop_simple.rb
Error: argument --towel You forgot your towel. You've been eaten by a Ravenous Bugblatter Beast of Traal.
Try --help for help.

There’s more that you can do with trollop; the website and documentation gives more examples.  However, I’d suggest considering trollop the next time you need to parse the command line.

 

 

Enhanced by Zemanta
20Aug09 Database Paranoia — ActiveRecord Callbacks
rails ruby
1 Comment

On a particular, nameless, heterogenous project using ruby on rails, ant, and shell scripts, there was an instance where data was not being properly cleaned before going into the database (primarily due to user errors in property files which were used by ant to feed the database).   As a result, the database was filled with extraneous spaces which were causing many issues.  A perfect illustration of GIGO.

One problem was that there were multiple databases, each with their own data.   By the time the issue was discovered, a fix was needed soonest, so the solution was less than elegant, but it does illustrate the use of callbacks in ActiveRecord:

module DbParanoia
# This is a really stupid thing to have to back-fit; it is making
# sure, however, that the users enter good data. We ensure that
# strings are stripped on read and write.

def trim_space
self.attributes.each do |attr|
attr.strip! if attr.instance_of? String
end
end

alias_method :after_find, :trim_space
alias_method :before_save, :trim_space
end

 

The above module is using the after_find and before_save callbacks to make sure that:

  1. Any spaces coming back from the database are trimmed.
  2. Any new records and/or updates will have the spaces trimmed.

You can use this method to perform pretty much any sort of validation or data manipulation of the data of an ActiveRecord class.  Other callbacks include:

  • after_create
  • after_destroy
  • after_save
  • after_update
  • after_validation
  • after_validation_on_create
  • after_validation_on_update
  • before_create
  • before_destroy
  • before_save
  • before_update
  • before_validation
  • before_validation_on_create
  • before_validation_on_update

You can read more about ActiveRecord::Callbacks at http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html.

Enhanced by Zemanta
19Aug09 Ruby Bindings and Scope
ruby
1 Comment

One of the features of Ruby’s Kernel module (which is imported into Object, so it’s available in every class) is the binding.  The binding allows you to keep a pointer to the scope at a particular location in your application and then later evaluate code from that location.

For example (and this came up as the result of a question on the ruby talk  mailing list), one of the things you can do is obtain a list of the local variables of a method:

def my_vars(a)
b=a
c=b+a
puts local_variables
end

 

returns the three variables, a, b, and c.  That’s fine, we’re still within the scope of the method.  But how about outside of our method?  This is where #binding and the Binding class come into play:

def outside(b)
puts eval("local_variables", b)
end

def my_vars(a)
b=a
c=b+a
outside(binding)
end

 

One thing to note: in order to work with the binding, we have to #eval code within its scope.  Thus the call to #eval with the method we are invoking and the binding.  This leads to the question from the mailing list:

we already have #has_block? to see if a block was passed. So how about
a #has_arguments? to query if _any_ arguments have been passed — Intransition

So how would we go about writing a #has_arguments? — here is a first stab:

class Object
def has_arguments?(b)
vars = eval("local_variables",b)
return false if vars.length == 0
vars.each do |v|
return false if eval("#{v}.nil?",b)
end
return true
end
end

class Foo
def initialize(first=nil)
if (has_arguments? binding)
puts "We're defined"
else
puts "Not!"
end
end
end

The only real drawback here is that we’ve got to pass in the binding itself.  Let’s try again:

class Object
def has_arguments?(&b)
vars = eval("local_variables",b.binding)
return false if vars.length == 0
vars.each do |v|
return false if eval("#{v}.nil?",b)
end
return true
end
end

class Foo
def initialize(first=nil)
if (has_arguments? {}) # note the empty block
puts "We're defined"
else
puts "Not!"
end
end
end

In this case, instead of explicitly calling #binding, we’re passing in an empty block — the block has it’s own scope, but it happens to contain the scope of then enclosing method.  It’s still not perfect, however:

  1. You need to pass in an empty block.
  2. It fails if you have local variables other than those passed in as arguments. (Pointed out by Joel VanderWerf)

Ok, it’s got some serious flaws (Charles Nutter posted a different way of solving the problem, which does work for all cases, and doesn’t use #binding).  But it does give an idea of what you can do with #binding.

Enhanced by Zemanta
18Aug09 What’s #method_missing missing?
ruby
2 Comments

#method_missing is a very useful part of the ruby language.  However, there’s one common mistake that developers make when using it.  They forget to add a call to #super.

Let’s take a look:

$ irb
>> class Foo
>> end
=> nil
>> f=Foo.new
=> #
>> f.i_do_not_exist
NoMethodError: undefined method `i_do_not_exist' for #
from (irb):5
>> class Foo
>> def method_missing(symbol,*args)
>> if (symbol.to_s === "i_do_not_exist")
>> puts "Yes, actually you do"
>> end
>> end
>> end
=> nil
>> f.i_do_not_exist
Yes, actually you do
=> nil
>> f.i_exist
=> nil

Unfortunately, we no longer get the error when we try to invoke a method which does not exist.  When we add an invocation to super, it’ll behave as expected:

>> class Foo
def method_missing(symbol,*args)
if (symbol.to_s === "i_do_not_exist")
puts "Yes, actually you do"
else
super
end
end
end
>> >> >> >> ?> >> >> >> => nil
>> f.i_exist
NoMethodError: undefined method `i_exist' for #
from (irb):31:in `method_missing'
from (irb):35
>> f.i_do_not_exist
Yes, actually you do
=> nil
>>

 

Enhanced by Zemanta
 
Browse Archives »
  • administrivia (2)
  • configuration (1)
  • metaprogramming (1)
  • mini-saga (5)
  • programming (10)
  • rails (1)
  • ruby (15)
  • rubygems (2)
  • Uncategorized (1)
 

Recent Posts

  • Default values for Attributes
  • Arguments with Trollop
  • Database Paranoia — ActiveRecord Callbacks
  • Ruby Bindings and Scope
  • What’s #method_missing missing?

Search

Browse by Category

  • administrivia (2)
  • configuration (1)
  • metaprogramming (1)
  • mini-saga (5)
  • programming (10)
  • rails (1)
  • ruby (15)
  • rubygems (2)
  • Uncategorized (1)

Browse by Tag

  • ActiveRecord
  • binding
  • Command-line interface
  • gotcha
  • irb
  • irbc
  • Languages
  • Library
  • Local variable
  • metaprogramming
  • mini-saga
  • paradigm
  • philosophy
  • programming
  • rails
  • Recursion
  • ruby
  • rubygems
  • Ruby on Rails
  • scope
  • utilities

Browse by Month

  • September 2009 (1)
  • August 2009 (4)
  • April 2009 (1)
  • February 2009 (11)
 
 
  • Blog
  • About
  • Archives
  • Log in
 


Theme Design by Jay Kwong | Powered by WordPress and K2

 

Home Top Archives Entries FeedComments Feed