instance_variable_hash 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "ZenTest", "4.5.0"
+  gem "autotest", "4.4.6"
+  gem "autotest-notification", "2.3.1"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-notification (2.3.1)
+      autotest (~> 4.3)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (= 4.5.0)
+  autotest (= 4.4.6)
+  autotest-notification (= 2.3.1)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Marc Rene Arns
+
+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,55 @@
+= InstanceVariableHash
+
+== What is it for?
+You might have attributes (in a plugin for example) that you want
+to use as Hash. But if you want to set these attribute from the outside it
+will be difficult to set parts of this hash at different places.
+
+So it would be better to have all attributes as simple values and have a 
+naming convention that allows conversion into hashes if needed.
+
+Instead of
+  
+  @config = { :a => {:b => 'val_b', :c => ['c1', 'c2']} }
+
+you would do
+  
+  @a_b = 'val_b'
+  @a_c = ['c1', 'c2']
+
+and with this lib you would have a shortcut that allows you to pass a hash:
+
+  instance_variables_set_with_hash({ :a => {:b => 'val_b', :c => ['c1', 'c2']} })
+
+to get them back as a hash
+
+  instance_variables_get_as_hash('a') # => {:b => 'val_b', :c => ['c1', 'c2']} }
+
+To use the lib:
+
+  require 'rubygems'
+  require 'instance_variable_hash'
+  
+  # you might want to use it only for certain classes / objects
+  class Object
+    include InstanceVariableHash
+  end
+
+That's all. A very simple library, tested with ruby 1.8 and 1.9.
+
+
+== Contributing
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Marc Rene Arns. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "instance_variable_hash"
+  gem.homepage = "http://github.com/metakeule/instance_variable_hash"
+  gem.license = "MIT"
+  gem.summary = %Q|get and set @under_scored_instance_variables as recursive Hash|
+  gem.description = %Q{get and set @under_scored_instance_variables as recursive Hash}
+  gem.email = "Base64.decode64('bGludXhAbWFyY3JlbmVhcm5zLmRl\n')"
+  gem.authors = ["Marc Rene Arns"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "instance_variable_hash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/instance_variable_hash.rb

@@ -0,0 +1,42 @@
+# Author::    Marc Rene Arns  (Base64.decode64('bGludXhAbWFyY3JlbmVhcm5zLmRl\n'))
+# Copyright:: Copyright (c) 2011 Marc Rene Arns 
+# License::   Distributes under the same terms as Ruby
+
+# This module has two methods to convert between @under_scored_instance_variables
+# and recursive Hashes, see README and the unit tests for examples
+
+module InstanceVariableHash
+  # get all instance variables that begin with 'key' as a recursive Hash (separated by _) 
+  def instance_variables_get_as_hash(key)
+    response = {} # we need a hash to have an object (id) to attach to
+    self.instance_variables.each do |var|
+      if var =~ /^@#{Regexp.escape(key)}(.*)$/ # we take the exact match and the subkeys
+        keys, hsh, pre = $1.split('_'), response, []
+        keys[0] = key # put the key itself into the result to have it in the loop
+        stop = keys.size 
+        keys.each do |k|
+          pre << k
+          if pre.size == stop # last element
+            hsh[k] = self.instance_variable_get("@#{pre.join('_')}")
+          else
+            hsh[k] ||= {} 
+            hsh = hsh[k]            
+          end
+        end
+      end
+    end
+    return response[key]
+  end
+
+  # set instance variables by a Hash, so that they will end up with underscored names
+  def instance_variables_set_with_hash(hsh)    
+    meth = proc do |pre,h|
+      h.each do |k,v|
+        keys = (pre.dup << k)
+        v.is_a?(Hash) ? meth.call(keys,v) : self.instance_variable_set("@#{keys.join('_')}", v)
+      end
+    end
+
+    meth.call [], hsh
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'instance_variable_hash'
+
+class Test::Unit::TestCase
+end

data/test/test_instance_variable_hash.rb

@@ -0,0 +1,95 @@
+require 'helper'
+
+class Testobject
+  include InstanceVariableHash
+
+  def initialize(hsh={})
+    hsh.each{ |key,val| self["@#{key}"] = val }
+  end
+
+  # shortcuts for testing
+  alias :get :instance_variables_get_as_hash
+  alias :set :instance_variables_set_with_hash
+  alias :[] :instance_variable_get
+  alias :[]= :instance_variable_set
+end
+
+class TestInstanceVarHash < Test::Unit::TestCase
+
+  context "when getting" do
+    context "vars without underscores" do 
+      setup do
+        @obj = Testobject.new :a => 'res_a', 
+                              :b => 'res_b'
+      end
+      
+      should "have several" do
+        assert_equal 'res_a', @obj.get('a')
+        assert_equal 'res_b', @obj.get('b')
+      end
+    end
+  
+  
+    context "vars with one underscore" do 
+      setup do
+        @obj = Testobject.new :a_b => 'res_a_b', 
+                              :a_c => 'res_a_c', 
+                              :b_c => 'res_b_c', 
+                              :b_d => 'res_b_d' 
+      end
+      
+      should "have several grouped" do
+        res1 = {'b' => 'res_a_b', 'c' => 'res_a_c'}
+        assert_equal res1, @obj.get('a')
+        res2 = {'c' => 'res_b_c', 'd' => 'res_b_d'}
+        assert_equal res2, @obj.get('b')
+      end
+    end
+  
+    context "vars with n underscores" do 
+      setup do
+        @obj = Testobject.new :a_c_b => 'res_a_c_b', 
+                              :a_c_d => 'res_a_c_d', 
+                              :b_c_d => 'res_b_c_d', 
+                              :b_d_e_f => 'res_b_d_e_f' 
+      end
+      
+      should "have several recursively grouped" do
+        res1 = {'c' => {'d' => 'res_a_c_d', 'b' => 'res_a_c_b' }}
+        assert_equal res1, @obj.get('a')
+        res2 = {'c' => {'d' => 'res_b_c_d'}, 'd' => {'e' => { 'f' => 'res_b_d_e_f' }}}
+        assert_equal res2, @obj.get('b')
+      end
+    end
+  end
+
+  context "when setting" do
+    setup do
+      @obj = Testobject.new
+    end
+  
+    should "handle a depth of 1" do
+      @obj.set :a => 'res_a', 
+               :b => 'res_b'
+      
+      assert_equal 'res_a',  @obj["@a"]
+      assert_equal 'res_b',  @obj["@b"]
+    end
+    
+    should "handle a depth of 2" do
+      @obj.set :a => { :b =>  'res_a_b', 
+                       :c => 'res_a_c'}
+
+      assert_equal 'res_a_b',  @obj["@a_b"]
+      assert_equal 'res_a_c',  @obj["@a_c"]
+    end
+
+    should "handle a depth of n" do
+      @obj.set :a => { :c => {:d => 'res_a_c_d', 
+                              :e => { :f => { :g => 'res_a_c_e_f_g' } }}}
+
+      assert_equal 'res_a_c_e_f_g',  @obj["@a_c_e_f_g"]
+      assert_equal 'res_a_c_d',  @obj["@a_c_d"]
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: instance_variable_hash
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Marc Rene Arns
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: ZenTest
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 4
+        - 5
+        - 0
+        version: 4.5.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: autotest
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 4
+        - 4
+        - 6
+        version: 4.4.6
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: autotest-notification
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 3
+        - 1
+        version: 2.3.1
+  requirement: *id007
+description: get and set @under_scored_instance_variables as recursive Hash
+email: |-
+  Base64.decode64('bGludXhAbWFyY3JlbmVhcm5zLmRl
+  ')
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/instance_variable_hash.rb
+- test/helper.rb
+- test/test_instance_variable_hash.rb
+has_rdoc: true
+homepage: http://github.com/metakeule/instance_variable_hash
+licenses: 
+- MIT
+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.3.7
+signing_key: 
+specification_version: 3
+summary: get and set @under_scored_instance_variables as recursive Hash
+test_files: 
+- test/helper.rb
+- test/test_instance_variable_hash.rb