lookup-hash 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+  gem "hash-utils", ">= 0.11.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "riot", ">= 0.12.1"
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    hash-utils (0.11.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    riot (0.12.1)
+      rr
+      term-ansicolor
+    rr (1.0.2)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  hash-utils (>= 0.11.0)
+  jeweler (~> 1.5.2)
+  riot (>= 0.12.1)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák
+
+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.md

@@ -0,0 +1,42 @@
+Lookup Hash
+===========
+
+**lookup-hash** is intended for using as fast lookup table for simply 
+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:
+
+    require "lookup-hash"
+    allowed = LookupHash[:alfa, :beta]
+
+…than:
+
+    require "lookup-hash"
+    allowed = Hash[:alfa, true, :beta, true]
+   
+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)
+
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright &copy; 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[1]: http://ruby-doc.org/core/classes/Hash.html
+[2]: http://github.com/martinkozak/lookup-hash/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+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 = "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.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # 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/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hash-utils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/lookup-hash.rb

@@ -0,0 +1,121 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "hash-utils/hash" # 0.11.0
+require "hash-utils/object"
+
+##
+# 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 write:
+#   allowed = LookupHash[:alfa, :beta]
+#
+# than:
+#   allowed = Hash[:alfa, true, :beta, true]
+#
+
+class LookupHash < Hash
+    ##
+    # 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)
+        if args.first.kind_of? Array
+            args = args.first
+        end
+        
+        new = [ ]
+        args.each do |i|
+            new << [i, true]
+        end
+        
+        result = super(new)
+        result.default = false
+        
+        return result
+    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(false)
+        self.map_values! { |v| v.to_b }
+    end
+
+    ##
+    # Element Assignment—Associates the value given by value with the 
+    # key given by key. key should not have its value changed while it 
+    # is in use as a key (a +String+ passed as a key will be duplicated 
+    # and frozen).
+    #
+    # @note Value will be converted using +hash-utils+ Hash#to_b 
+    #   to Boolean in the {LookupHash}.
+    # @see http://ruby-doc.org/core/classes/Hash.html#M000729
+    #
+    
+    def []=(key, value)
+        super(key, value.to_b)
+    end
+    
+    ##
+    # Replaces the contents of Hash with the contents of +other_hash+.
+    #
+    # @note Value will be converted using +hash-utils+ Hash#to_b 
+    #   to Boolean in the {LookupHash}.
+    # @see http://ruby-doc.org/core/classes/Hash.html#M000757
+    #
+    
+    def replace(other_hash)
+        super(other_hash.map_values { |v| v.to_b })
+    end
+    
+    ##
+    # Adds key to lookup hash.
+    # @param [Object] key key for add
+    #
+    
+    def <<(key)
+        self[key] = true
+    end
+    
+    alias :add :<<
+    
+    ##
+    # Bans set the default value.
+    #
+    
+    def default=
+    end
+    
+    ##
+    # Bans set the default value.
+    #
+    
+    def default=(value)
+        super(false)
+    end
+    
+    ##
+    # Bans set the default block.
+    #
+    
+    def default_proc=(value)
+    end
+end

data/test

@@ -0,0 +1,43 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+$:.push("./lib")
+require "lookup-hash"
+require "riot"
+
+context "LookupHash" do
+    setup do 
+        LookupHash[:alfa, :beta]
+    end
+    
+    asserts("#[] (static)") do
+        topic == {:alfa => true, :beta => true} 
+    end
+    asserts("#<<") do
+        hash = topic.dup
+        hash << :gama
+        hash == {:alfa => true, :beta => true, :gama => true}
+    end
+    asserts("#[]=") do
+        hash = topic.dup
+        hash[:gama] = "something"
+        hash == {:alfa => true, :beta => true, :gama => true}
+    end
+    asserts("#default=") do
+        topic.default = "something"
+        topic.default == false
+    end
+    asserts("#default_proc=") do
+        topic.default_proc = "something"
+        topic.default_proc.nil?
+    end        
+    asserts("#replace") do
+        hash = topic.dup
+        hash.replace(:alfa => "alfa", :beta => nil)
+        hash == {:alfa => true, :beta => false}
+    end
+    asserts("default value") do
+        topic[:gama] == false
+    end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: lookup-hash
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hash-utils
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: riot
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.12.1
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/lookup-hash.rb
+- test
+has_rdoc: true
+homepage: http://github.com/martinkozak/lookup-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: 950339550497495953
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+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.
+test_files: []
+