cwyckoff-hash_builder 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008-2009 David Brady github@shinybit.com
+ 
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,106 @@
+= Hash Builder
+
+Are you tired of ugly, cumbersome hashes cluttering up your Rails models and controllers.  Well, Hash Builder is a simple tool for building hashes that allows you define hashes separate from your code, keeping your code clean and focused on its core responsibilities.  The hashes themselves are then easy to organize and manipulate.
+
+
+== Author
+
+* Chris Wyckoff -- cwyckoff@leadmediapartners.com
+
+
+== Examples
+
+
+=== Definitions
+
+Let's say you want to build a hash of user contact information.  In a separate file, set up a hash definition:
+
+  HashBuilder.define(:contact_info) do |b|
+
+    bldr.build_hash(:name) do
+      bldr[:title] = "Dr."
+      bldr[:f_name] = "Hawkeye"
+      bldr[:l_name] = "Pierce"
+    end 
+
+    bldr.build_hash(:address) do
+      bldr[:street] = "123 Main St."
+      bldr[:city] = "Crabapple Cove"
+      bldr[:state] = "ME"
+      bldr[:zip] = "04656"
+    end 
+
+  end 
+
+
+=== Building
+
+Each definition requires a key -- in this case :contact_info.  Moreover, within the contact definition, you may set up namespaces (:name and :address) to further organize your hash content.
+
+In order to build your hash, simply call
+
+  HashBuilder.build(:contact_info)
+
+which will return 
+
+  { 
+    :title => "Dr.",
+    :f_name => "Hawkeye",
+    :l_name => "Pierce",
+    :street => "123 Main St.",
+    :city => "Crabapple Cove",
+    :state => "ME",
+    :zip => "04656",
+  }
+
+If you want to build an individual namespace, call
+
+  HashBuilder.build_namespace(:contact_info, :address)
+
+which will return only 
+
+  { 
+    :street => "123 Main St.",
+    :city => "Crabapple Cove",
+    :state => "ME",
+    :zip => "04656",
+  }
+
+To select multiple namespaces, set them in a block:
+
+  HashBuilder.build(:contact_info) do |b|
+    b.using :name
+    b.using :address
+  end
+
+
+=== Additional Variables
+
+You may pass additional variables to your hash definition when you build it.  Simply pass them after the definition key.
+
+  HashBuilder.build(:contact_info, user)
+
+For namespaces, pass them after the namespace key
+
+  HashBuilder.build(:contact_info, :address, user)
+
+All of this assumes that you will now yield the additional variables in the hash definition:
+
+  HashBuilder.define(:contact_info) do |b|
+
+    bldr.build_hash(:name) do |user|
+      bldr[:title] = user.title
+      bldr[:f_name] = user.first_name
+      bldr[:l_name] = user.last_name
+    end 
+
+    bldr.build_hash(:address) do |user|
+      bldr[:street] = user.street
+      bldr[:city] = user.city
+      bldr[:state] = user.state
+      bldr[:zip] = user.zip
+    end 
+
+  end 
+  
+

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "hash_builder")

data/lib/hash_builder/hash_builder.rb

@@ -0,0 +1,91 @@
+module HashBuilderExtensions
+  def with(key, *args)
+    self.update(HashBuilder.build(key, *args))
+  end 
+end 
+
+class Hash; include HashBuilderExtensions; end
+class HashBuilderError < Exception; end
+
+class HashBuilder
+
+  class << self
+
+    def define(key=nil)
+      raise HashBuilderError, "You need to pass in a hash builder key (e.g., HashBuilder.define(:foo))" if key.nil?
+#      raise HashBuilderError, "The hash builder key ':#{key}' is already being used." if builders[key.to_sym]
+
+      builders[key.to_sym] = self.new
+      yield builders[key.to_sym]
+    end 
+
+    def build(key=nil, *args)
+      raise HashBuilderError, "You need to pass in a hash builder key (e.g., HashBuilder.build(:foo))" if key.nil?
+      raise HashBuilderError, "Unable to find hash builder definition for key #{key}" unless (builder = builders[key.to_sym])
+
+      yield builder if block_given?
+      builder.call(*args)
+    end 
+
+    def build_namespace(key, namespace, *args)
+      raise HashBuilderError, "Unable to find hash builder definition for key #{key}" unless (builder = builders[key.to_sym])
+      builder.call_namespace(namespace.to_sym, *args)
+    end 
+
+    def builders
+      @builders ||= {}
+    end 
+
+    def reset(*keys)
+      keys.each do |key| 
+        @builders[key.to_sym].builder_hash = {} if @builders[key.to_sym]
+      end 
+    end 
+
+  end 
+
+  attr_reader :hash_blocks
+  attr_accessor :builder_hash
+
+  def []=(key, value)
+    hash[key] = value
+  end
+
+  def build_hash(key=nil, &block)
+    @hash_blocks ||= {}
+    if(key)
+      @hash_blocks[key.to_sym] = block
+    else
+      @hash_blocks[:namespace] = block
+    end 
+  end 
+
+  def call(*args)
+    if(included_namespace_keys.size > 0)
+      included_namespace_keys.each do |key|
+        @hash_blocks[key].call(*args)
+      end 
+    else 
+      @hash_blocks.each { |k,v| v.call(*args) }
+    end 
+    hash
+  end 
+
+  def call_namespace(key, *args)
+    @hash_blocks[key].call(*args)
+    hash
+  end 
+
+  def hash
+    @builder_hash ||= Hash.new
+  end
+
+  def included_namespace_keys
+    @included_namespace_keys ||= []
+  end
+
+  def using(key)
+    included_namespace_keys << key unless included_namespace_keys.include?(key)
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: cwyckoff-hash_builder
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Chris Wyckoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Hash Builder is a simple tool for offloading the building of hashes.
+email: github@cwyckoff.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- init.rb
+- lib/hash_builder/hash_builder.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/cwyckoff/hash_builder
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --main
+- README.rdoc
+- --title
+- HashBuilder - A Hash Building Tool for the Ages
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Hash Builder is a simple tool for offloading the building of hashes.
+test_files: []
+