lookup-hash 0.1.0 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 Lookup Hash
 ===========
 
-**lookup-hash** is intended for using as fast lookup table for simply 
+**lookup-hash** is intended for using as fast lookup table for simple
 checking of existency of some item inside. It doesn't bring any 
 additional performance, it's defacto only [Hash][1] with booleans, 
 but it's better and more readable to write:
@@ -14,12 +14,15 @@ but it's better and more readable to write:
     require "lookup-hash"
     allowed = Hash[:alfa, true, :beta, true]
    
-Other methods are equivalent to +Hash+ with exception of data assignment
+Other methods are equivalent to `Hash` with exception of data assignment
 methods which convert all values to booleans. New key it's possible to 
 add also by:
 
     hash << :key    # …or…
     hash.add(:key)
+    
+*Implicitly frozen* lookup hash is available as `Frozen::LookupHash`
+in `lookup-hash/frozen`.
 
 Contributing
 ------------

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   gem.name = "lookup-hash"
   gem.homepage = "http://github.com/martinkozak/lookup-hash"
   gem.license = "MIT"
-  gem.summary = 'Hash intended for using as lookup table only for simply checking of existency of some item (key) inside.'
+  gem.summary = 'Hash intended for using as lookup table only for simple checking of existency of some item (key) inside.'
   gem.email = "martinkozak@martinkozak.net"
   gem.authors = ["Martin Kozák"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/lookup-hash.rb

@@ -15,6 +15,7 @@ require "hash-utils/object"
 #
 
 class LookupHash < Hash
+
     ##
     # Creates lookup hash. Expects key names as input. If array given,
     # treat it as just array of keys.
@@ -118,4 +119,5 @@ class LookupHash < Hash
     
     def default_proc=(value)
     end
+    
 end

data/lib/lookup-hash/frozen.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "lookup-hash"
+
+##
+# Implicitly frozen objects.
+# @since 0.2.0
+#
+
+module Frozen
+
+    ##
+    # Hash intended for using as fast lookup table for simply checking of an 
+    # existency of some item. It doesn't bring any additional performance,
+    # it's defacto only Hash with Booleans, but it's better to write:
+    #
+    #   class Foo
+    #       CONST = Frozen::LookupHash[:alfa, :beta]
+    #   end
+    #
+    # than:
+    #   class Foo
+    #       CONST = Hash[:alfa, true, :beta, true].freeze
+    #   end
+    #
+    # Implicitly frozen for use in class constants.
+    #
+    # @since 0.2.0
+    #
+
+    class LookupHash < ::LookupHash
+    
+        ##
+        # Creates lookup hash. Expects key names as input. If array given,
+        # treat it as just array of keys.
+        #
+        # @return [Hash] new hash
+        #
+        
+        def self.[](*args)
+            result = super(*args)
+            result.freeze
+        end
+        
+        ##
+        # Returns a new, empty hash. If this hash is subsequently accessed 
+        # by a key that doesn‘t correspond to a hash entry, the value 
+        # returned depends on the style of new used to create the hash. In 
+        # the first form, the access returns nil. If obj is specified, 
+        # this single object will be used for all default values. If a block
+        # is specified, it will be called with the hash object and the key, 
+        # and should return the default value. It is the block‘s 
+        # responsibility to store the value in the hash if required.
+        #
+        # @note All values will be converted using +hash-utils+ Hash#to_b 
+        #   to Boolean in the {LookupHash}. Assigning of default value block
+        #   isn't allowed.
+        # @see http://ruby-doc.org/core/classes/Hash.html#M000718
+        #
+
+        def initialize
+            super
+            self.freeze
+        end
+        
+    end
+end

data/lookup-hash.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lookup-hash}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-03-02}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/lookup-hash.rb",
+    "lib/lookup-hash/frozen.rb",
+    "lookup-hash.gemspec",
+    "test"
+  ]
+  s.homepage = %q{http://github.com/martinkozak/lookup-hash}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Hash intended for using as lookup table only for simple checking of existency of some item (key) inside.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hash-utils>, [">= 0.11.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<riot>, [">= 0.12.1"])
+    else
+      s.add_dependency(%q<hash-utils>, [">= 0.11.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<riot>, [">= 0.12.1"])
+    end
+  else
+    s.add_dependency(%q<hash-utils>, [">= 0.11.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<riot>, [">= 0.12.1"])
+  end
+end
+

data/test

@@ -4,6 +4,7 @@
 
 $:.push("./lib")
 require "lookup-hash"
+require "lookup-hash/frozen"
 require "riot"
 
 context "LookupHash" do
@@ -41,3 +42,20 @@ context "LookupHash" do
         topic[:gama] == false
     end
 end
+
+context "Frozen::LookupHash" do
+    setup do 
+        Frozen::LookupHash[:alfa, :beta]
+    end
+   
+    asserts("non-frozen class object equivalence") do
+        topic == LookupHash[:alfa, :beta]
+    end
+    asserts("frozen state") do
+        begin
+            topic.replace({:c => :d})
+        rescue RuntimeError => e
+            true
+        end
+    end
+end

metadata

@@ -2,7 +2,7 @@
 name: lookup-hash
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Martin Koz\xC3\xA1k"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +01:00
+date: 2011-03-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -75,6 +75,8 @@ files:
 - Rakefile
 - VERSION
 - lib/lookup-hash.rb
+- lib/lookup-hash/frozen.rb
+- lookup-hash.gemspec
 - test
 has_rdoc: true
 homepage: http://github.com/martinkozak/lookup-hash
@@ -90,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 950339550497495953
+      hash: 12821966045354292
       segments: 
       - 0
       version: "0"
@@ -106,6 +108,6 @@ rubyforge_project:
 rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
-summary: Hash intended for using as lookup table only for simply checking of existency of some item (key) inside.
+summary: Hash intended for using as lookup table only for simple checking of existency of some item (key) inside.
 test_files: []