hash-access 0.1.0 → 0.2.1

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007,2008 Slava Chernobai <chernobai@gmail.com>
+Copyright (c) 2007,2008,2011 Svetoslav Chernobay <slava@chernobay.info>
 
 This is free software. You may redistribute copies of it under the terms
 of the GNU General Public License.

data/README.md

@@ -0,0 +1,58 @@
+# HashAccess
+
+[HashAccess](https://github.com/slavach/hash-access) allows access to hash
+elements by calling methods. When using HashAccess you can call a method
+on a hash instance to get the corresponding value of a key.
+
+You can write:
+
+    hash.some_key = 'something'
+
+instead of:
+
+    hash['some_key'] = 'something'
+
+## Installation
+
+Hash access is available as the gem hash-access.
+
+    gem install hash-access
+
+## Usage Example
+
+    require 'hash_access'
+    include HashAccess
+
+    h = {}
+    h.access_by_methods
+    h.first_key = 'First value' # the same as h['first_key'] = 'First value'
+    h.another_key = 'Another value' # the same as h['another_key'] = 'Another value'
+
+## Development
+
+Clone hash-access source from GitGub:
+
+    git clone git://github.com/slavach/hash-access.git
+
+Install bundler if it has not been installed yet:
+
+    gem install bundler
+
+Install additional gems for testing and documentation:
+
+    bundle install
+
+The above command installs gems: rspec, rdoc, yard, BlueCloth.
+
+To invoke tests - run `rake spec` or simply `rake`.
+
+## Author
+
+HashAccess has been written by Svetoslav Chernobay <slava@chernobay.info>.
+Feel free to contact him if you have any questions or comments.
+
+## Notes
+
+HashAccess is a supplement module for UseConfig which is available at
+GutHub [use-config](https://github.com/slavach/use-config) as well as the gem use-config.
+

data/Rakefile

@@ -1,63 +1,38 @@
 require 'rubygems'
 
 require 'rake/clean'
-require 'rake/testtask'
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
 
-require 'lib/hash_access'
+require 'yard'
 
-task :default => [ :test ]
+require 'rspec'
+require 'rspec/core/rake_task'
 
-CLEAN.include(%w[ pkg/* README doc/*])
+require File.dirname(__FILE__) + "/lib/hash_access/version.rb"
 
-desc 'Generate README'
-task :readme do
-  %x[erb -T 1 README.erb > README] if File.exists?('README.erb')
-end
+task :default => [ :spec ]
 
-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
+CLEAN.include(%w[ pkg doc .yardoc hash-access-*.gem ])
 
-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/'
+desc 'Run RSpec examples'
+RSpec::Core::RakeTask.new :spec do |t|
+  t.rspec_opts = "--colour --format documentation"
+  t.pattern = 'spec/*.rb'
 end
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList[ 'test/test*.rb' ]
-  t.verbose = true
+desc "Build the gem"
+task :build do
+  system "gem build hash-access.gemspec"
 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'
+desc "Push the gem to rubygems.org"
+task :push do
+  system "gem push hash-access-#{HashAccess::VERSION}.gem"
 end
 
-task :gem => [ :readme ]
-Rake::GemPackageTask.new(spec) do |p|
-  p.gem_spec = spec
-  p.need_tar = true
-  p.need_zip = true
+desc "Generate documentation"
+YARD::Rake::YardocTask.new :doc do |t|
+  t.files = %w[ README.md, LICENSE, lib/**/*.rb ]
+  t.options = %w[ --title HashAccess ]
 end
 

data/lib/hash_access.rb

@@ -1,45 +1,56 @@
-module HashAccess # :nodoc:
-  VERSION = '0.1.0'
+require 'hash_access/version'
 
+module HashAccess # :nodoc:
+  # Extends the Hash class with the access_by_methods method.
   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 :)
+  # This module contains one method - access_by_methods instance method.
+  # The access_by_methods is added to Hash when the module HashAccess
+  # is being included.
+  # When the access_by_methods is being called it generates a couple of
+  # instance methods of the calling object:
   #
-  # Below, the list of generated methods:
+  # * access_by_methods?
   # * store, []=
   # * method_missing
   # * stringify_keys!
   module InstanceMethods
-    # Generates singleton instance methods,
-    # which allows access to hash elements with methods.
+    # Generates singleton instance methods that allows access to any hash
+    # element using a method with the same name as the key.
+    # Recursively calls itlelf on child hashes.
     def access_by_methods
+      return self if self.respond_to? :access_by_methods? and self.access_by_methods?
       class << self
         alias_method :__hash_store, :store
         alias_method :__hash_assign, :[]=
 
-        # Generated instance method. Assigns the value to key.
+        # Generated instance method.
+        # Hash elements can be accessed using methods.
+        def access_by_methods?
+          true
+        end
+
+        # Generated instance method.
+        # Stores a key-value pair.
         def store(key, value)
-          key = key.to_s
-          __hash_store(key, value)
           if value.is_a? Hash
             value.access_by_methods
           end
+          key = key.to_s
+          __hash_store(key, value)
         end # def store
 
-        # Generated instance method. Assigns the value to key.
+        # Generated instance method.
+        # Stores a key-value pair.
         def []=(key, value)
           self.store(key, value)
         end # def []=
 
         # Generated instance method.
-        # Creates new hash element with the method key.
+        # Creates a new hash element with a key is the same as the passed
+        # method.
         def method_missing(method, *values)
           method_name = method.to_s
           super(method, *values) unless method_name =~ /^[a-z0-9]+.*$/
@@ -51,12 +62,14 @@ module HashAccess # :nodoc:
               self[key] = values
             end
           else
-            self[method_name] = Hash.new unless self.keys.include?(method_name)
+            self[method_name] = Hash.new.access_by_methods \
+              unless self.keys.include?(method_name)
             self[method_name]
           end
         end # def method_missing
 
-        # Generated instance method. Converts all hash keys to strings.
+        # Generated instance method.
+        # Converts all hash keys to strings.
         def stringify_keys!
           keys.each do |key|
             next if key.is_a? String
@@ -69,11 +82,14 @@ module HashAccess # :nodoc:
 
       self.stringify_keys!
 
+      # Recursive calls
       self.each do |key, value|
         if value.is_a? Hash
           value.access_by_methods
         end
       end
+
+      self
     end # def access_by_methods
   end # module InstanceMethods
 end # module HashAccess

data/lib/hash_access/version.rb

@@ -0,0 +1,4 @@
+module HashAccess
+  VERSION = '0.2.1'
+end
+

data/spec/hash_access_spec.rb

@@ -0,0 +1,91 @@
+require 'rspec'
+require File.dirname(__FILE__) + "/../lib/hash_access.rb"
+include HashAccess
+
+describe HashAccess do
+  describe "new empty Hash instance" do
+    it "responds to :access_by_methods" do
+      @hash = Hash.new
+      @hash.respond_to?(:access_by_methods).should == true
+    end
+  end
+
+  describe "new empty Hash instance after the call to access_by_methods" do
+    before :each do
+      @hash = Hash.new
+      @hash.access_by_methods
+    end
+
+    it "responds to :access_by_methods?" do
+      @hash.respond_to?(:access_by_methods?).should == true
+    end
+
+    it "responds to :stringify_keys!" do
+      @hash.respond_to?(:stringify_keys!).should == true
+    end
+  end
+
+  describe "non-empty Hash instance after the call to access_by_methods" do
+    before :each do
+      @hash = Hash.new
+      @hash[:qwe] = 'qwe_value'
+      @hash[:asd] = {}
+      @hash[:asd][:fgh] = :asd_fgh_value
+      @hash['zxc'] = {}
+      @hash['zxc']['vbn'] = 'zxc_vbn_value'
+      @hash.access_by_methods
+    end
+
+    it "changes symbol-type keys to strings" do
+      @hash.keys.sort.should == %w( asd qwe zxc )
+    end
+
+    it "returns a value when being call to a method" do
+      @hash.qwe.should == 'qwe_value'
+      @hash.asd.fgh.should == :asd_fgh_value
+      @hash.zxc.vbn.should == 'zxc_vbn_value'
+    end
+
+    it "changes a value" do
+      @hash.qwe = 'new_qwe_value'
+      @hash.qwe.should == 'new_qwe_value'
+    end
+
+    it "creates a new value when being call to a method" do
+      @hash.qwerty.asdfgh.zxcvbn = 'qwertyuiop'
+      @hash.qwerty.asdfgh.zxcvbn.should == 'qwertyuiop'
+    end
+
+    it "replaces the existing value" do
+      @hash.qwe = 'new_qwe_value'
+      @hash.qwe.should == 'new_qwe_value'
+    end
+
+    it "it replaces the existing parent element" do
+      @hash.qwerty.asdfgh.zxcvbn.qwerty.asdfgh.zxcvbn = 'qwertyuiop'
+      @hash.qwerty.asdfgh.zxcvbn = 'qwerty_asdfgh_zxcvbn'
+    end
+  end
+
+  describe "child hash" do
+    before :each do
+      @hash = {}
+      @hash.access_by_methods
+      @hash.qwe.asd = 'qwe_asd_value'
+      @child = @hash.qwe
+    end
+    it "responds to access_by_methods?" do
+      @child.respond_to?(:access_by_methods?).should == true
+    end
+
+    it "returns a value when being call to a method" do
+      @child.asd.should == 'qwe_asd_value'
+    end
+
+    it "creates a new element when being call to a method" do
+      @child.zxc = 'zxc_value'
+      @child.zxc.should == 'zxc_value'
+    end
+  end
+end
+

metadata

@@ -1,35 +1,39 @@
 --- !ruby/object:Gem::Specification 
 name: hash-access
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: 
+  version: 0.2.1
 platform: ruby
 authors: 
-- Slava Chernobai
+- Svetoslav Chernobay
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-01-10 00:00:00 +03:00
+date: 2011-03-08 00:00:00 +03:00
 default_executable: 
 dependencies: []
 
-description: HashAccess. Allows access to hash elements by methods.
-email: chernobai@gmail.com
+description: HashAccess library allows access to hash elements by calling methods
+email: slava@chernobay.info
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 - LICENSE
 files: 
-- README
+- README.md
 - LICENSE
 - Rakefile
 - lib/hash_access.rb
-- test/test_hash_access.rb
+- lib/hash_access/version.rb
+- spec/hash_access_spec.rb
 has_rdoc: true
-homepage: http://code.slava.pp.ru/hash-access/
+homepage: http://github.com/slavach/hash-access
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main=README
@@ -38,23 +42,23 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.0.1
+rubyforge_project: hash-access
+rubygems_version: 1.5.2
 signing_key: 
-specification_version: 2
-summary: HashAccess. Allows access to hash elements by methods.
+specification_version: 3
+summary: Allows access to hash elements by methods
 test_files: []
 

data/README

@@ -1,17 +0,0 @@
-== 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/test/test_hash_access.rb

@@ -1,41 +0,0 @@
-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
-