hash-access 0.1.0

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2007,2008 Slava Chernobai <chernobai@gmail.com>
+
+This is free software. You may redistribute copies of it under the terms
+of the GNU General Public License.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.
+

data/README

@@ -0,0 +1,17 @@
+== HashAccess 0.1.0
+This library allows access to hash elements by methods.
+
+Install:
+
+ gem ins hash-access
+
+Usage example:
+
+ require 'hash_access'
+ include HashAccess
+
+ h = Hash.new
+ h.access_by_methods
+ h.one.two.three = 'qwe'
+ print(h.inspect, "\n") # => {"one"=>{"two"=>{"three"=>"qwe"}}}=> nil
+

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+require 'lib/hash_access'
+
+task :default => [ :test ]
+
+CLEAN.include(%w[ pkg/* README doc/*])
+
+desc 'Generate README'
+task :readme do
+  %x[erb -T 1 README.erb > README] if File.exists?('README.erb')
+end
+
+desc 'Generate RDoc'
+task :rdoc => [ :readme ]
+Rake::RDocTask.new do |rd|
+  rd.main = 'README'
+  rd.title = 'HashAccess'
+  rd.rdoc_dir = 'doc'
+  rd.template = 'jamis'
+  rd.options = %w[ --line-numbers --inline-source ]
+  rd.rdoc_files.include('README', 'LICENSE', 'lib/*.rb')
+end
+
+desc 'Upload RDoc to site'
+task :rdoc_pub => [:rdoc] do
+  sh 'rsync -ae ssh --delete doc/ slava@slava.cn:/var/www/code/htdocs/hash-access/doc/'
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList[ 'test/test*.rb' ]
+  t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = 'hash-access'
+  s.version = HashAccess::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w[ README LICENSE ]
+  s.rdoc_options = %w[ --main=README --line-numbers --inline-source ]
+  s.summary = 'HashAccess. Allows access to hash elements by methods.'
+  s.description = s.summary
+  s.author = 'Slava Chernobai'
+  s.email = 'chernobai@gmail.com'
+  s.homepage = 'http://code.slava.pp.ru/hash-access/'
+  s.files = %w[ README LICENSE Rakefile ] + Dir.glob("{lib,test}/*")
+  s.require_path = 'lib'
+end
+
+task :gem => [ :readme ]
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+

data/lib/hash_access.rb

@@ -0,0 +1,80 @@
+module HashAccess # :nodoc:
+  VERSION = '0.1.0'
+
+  def self.included(base)
+    Hash.send :include, HashAccess::InstanceMethods
+  end
+
+  # This module contains only one method - instance method access_by_methods,
+  # which is being added to class Hash after inclusion of
+  # HashAccess module in any context (any module or class).
+  # All other methods are being generated by access_by_methods.
+  # Generated methods becomes instance methods, not the class methods as RDoc
+  # thinks :)
+  #
+  # Below, the list of generated methods:
+  # * store, []=
+  # * method_missing
+  # * stringify_keys!
+  module InstanceMethods
+    # Generates singleton instance methods,
+    # which allows access to hash elements with methods.
+    def access_by_methods
+      class << self
+        alias_method :__hash_store, :store
+        alias_method :__hash_assign, :[]=
+
+        # Generated instance method. Assigns the value to key.
+        def store(key, value)
+          key = key.to_s
+          __hash_store(key, value)
+          if value.is_a? Hash
+            value.access_by_methods
+          end
+        end # def store
+
+        # Generated instance method. Assigns the value to key.
+        def []=(key, value)
+          self.store(key, value)
+        end # def []=
+
+        # Generated instance method.
+        # Creates new hash element with the method key.
+        def method_missing(method, *values)
+          method_name = method.to_s
+          super(method, *values) unless method_name =~ /^[a-z0-9]+.*$/
+          if method_name =~ /^.*=$/
+            key = method_name.chop
+            if values.size == 1
+              self[key] = values[0]
+            else
+              self[key] = values
+            end
+          else
+            self[method_name] = Hash.new unless self.keys.include?(method_name)
+            self[method_name]
+          end
+        end # def method_missing
+
+        # Generated instance method. Converts all hash keys to strings.
+        def stringify_keys!
+          keys.each do |key|
+            next if key.is_a? String
+            self[key.to_s] = self[key]
+            delete(key)
+          end
+          self
+        end # def stringify_keys!
+      end # class
+
+      self.stringify_keys!
+
+      self.each do |key, value|
+        if value.is_a? Hash
+          value.access_by_methods
+        end
+      end
+    end # def access_by_methods
+  end # module InstanceMethods
+end # module HashAccess
+

data/test/test_hash_access.rb

@@ -0,0 +1,41 @@
+require 'test/unit'
+require 'hash_access'
+
+class HashAccessTest < Test::Unit::TestCase
+  def setup
+    self.class.send :include, HashAccess
+  end
+
+  def test_001_hash_must_respond_to_access_by_methods
+    hash = {}
+    assert_respond_to(hash, :access_by_methods)
+  end
+
+  def test_002_access_by_methods_generates_methods
+    hash_abm = {}
+    hash_abm.access_by_methods
+    assert_respond_to(hash_abm, :stringify_keys!)
+    assert_respond_to(hash_abm, :__hash_store)
+    assert_respond_to(hash_abm, :__hash_assign)
+  end
+
+  def test_003_changes_existing_hash_instance
+    hash_abm = {}
+    hash_abm['first'] = {}
+    hash_abm['first']['one'] = :first_one
+    hash_abm[:second] = {}
+    hash_abm[:second][:one] = :second_one
+    hash_abm.access_by_methods
+    assert_equal(hash_abm.keys.sort, %w[ first second ])
+    assert_equal(hash_abm.first.one, :first_one)
+    assert_equal(hash_abm.second.one, :second_one)
+  end
+
+  def test_004_creates_new_element_and_parent_hashes
+    hash_abm = {}
+    hash_abm.access_by_methods
+    hash_abm.first.second.third.fourth = :first_second_third_fourth
+    assert_equal(hash_abm['first']['second']['third']['fourth'], hash_abm.first.second.third.fourth)
+  end
+end
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: hash-access
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Slava Chernobai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-10 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: HashAccess. Allows access to hash elements by methods.
+email: chernobai@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- README
+- LICENSE
+- Rakefile
+- lib/hash_access.rb
+- test/test_hash_access.rb
+has_rdoc: true
+homepage: http://code.slava.pp.ru/hash-access/
+post_install_message: 
+rdoc_options: 
+- --main=README
+- --line-numbers
+- --inline-source
+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.0.1
+signing_key: 
+specification_version: 2
+summary: HashAccess. Allows access to hash elements by methods.
+test_files: []
+