options-arg 0.0.1

data/lib/options_arg.rb

@@ -0,0 +1,74 @@
+#
+# 16 Jul 2012
+#
+
+# Provides a few methods to work with hashes.
+module Kernel
+
+  # Raised if a required option has not been set.
+  class OptionNotSetError < Exception
+  end
+
+  private
+
+  # Get a value from the specified hash.
+  #
+  # @param [Hash] options the hash.
+  # @param [Symbol] key the key whose value is required.
+  # @param [TrueClass, FalseClass] required flag to indicate if it is an error if the key does not exist.
+  # @param [Object] default the default value if the key does not exist. Only used if 'required' is false.
+  # If a block is provided, it is called with the options hash and requested key and the results of the block is
+  # returned.
+  #
+  # @return [Object] the value from the hash, or the default value.
+  def get_option(options, key, required = false, default = nil)
+    if options.has_key?(key)
+      options[key]
+    elsif required
+      raise OptionNotSetError.new("Option '#{key}' has not been set!")
+    elsif block_given?
+      yield(options, key)
+    else
+      default
+    end
+  end
+
+  # Pops (delete) a value from the specified hash.
+  #
+  # @param [Hash] options the hash.
+  # @param [Symbol] key the key whose value is required.
+  # @param [TrueClass, FalseClass] required flag to indicate if it is an error if the key does not exist.
+  # @param [Object] default the default value if the key does not exist. Only used if 'required' is false.
+  # If a block is provided, it is called with the options hash and requested key and the results of the block is
+  # returned.
+  #
+  # @return [Object] the value from the hash, or the default value.
+  def pop_option(options, key, required = false, default = nil)
+    if options.has_key?(key)
+      options.delete(key)
+    elsif required
+      raise OptionNotSetError.new("Option '#{key}' has not been set!")
+    elsif block_given?
+      yield(options, key)
+    else
+      default
+    end
+  end
+
+  # Sets a value in the specified hash.
+  #
+  # @param [Hash] options the hash.
+  # @param [Symbol] key the key whose value is to be set.
+  # @param [Object] value the value to set.
+  # @param [TrueClass, FalseClass] overwrite flag to indicate if existing values should be overwritten.
+  #
+  # @return [Object] the value in the hash at the end of the operation.
+  def set_option(options, key, value, overwrite)
+    if not options.has_key?(key) or overwrite
+      options[key] = value
+    end
+    # Return whatever is in the hash now.
+    options[key]
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: options-arg
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Suraj Vijayakumar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-24 00:00:00 Z
+dependencies: []
+
+description: Gem to add a few methods to the Kernel class to make it easier to work with hashes as arguments in methods.
+email: 
+- vijayakumar.suraj@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/options_arg.rb
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem to make it easier to work with hashes as arguments in methods.
+test_files: []
+