casted_hash 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 901edabae24fed434f5c0a5c6e83845831ea0163
+  data.tar.gz: 9cc31472995f046c5bbecc736a952a2fdf7b26a4
+SHA512:
+  metadata.gz: b6c011883db3dc8da0212b322be8657d6d4b7c89f3833e955d9a85a16fe3d1cc520f70f7e0b4f8703b53e043409132b600df81d0a2a479cc2cd2034d959393b4
+  data.tar.gz: 63d783be719a14ad5317be58abaa0250850be1d7ddb8a4de5e0e7c8227bde4b7c030651727d6f657ee9a6090e9ea59f6db3a22ae2a7a2843e3095dae130b1bc3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in casted_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stephan Kaag
+
+MIT License
+
+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,17 @@
+[![Build Status](https://travis-ci.org/stephankaag/cached_hash.png?branch=master)](https://travis-ci.org/stephankaag/cached_hash)
+
+# CastedHash
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'casted_hash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install casted_hash

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/casted_hash.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'casted_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "casted_hash"
+  spec.version       = CastedHash::VERSION
+  spec.authors       = ["Stephan Kaag"]
+  spec.email         = ["stephan@ka.ag"]
+  spec.description = spec.summary = "A casted hash"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_dependency "equalizer", ">= 0.0.7"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "coveralls"
+end

data/lib/casted_hash/value.rb

@@ -0,0 +1,27 @@
+class CastedHash
+  class Value
+    include Equalizer.new(:value)
+    attr_reader :value
+
+    def initialize(value, cast_proc)
+      @value = value
+      @cast_proc = cast_proc
+    end
+
+    def casted_value
+      cast!
+      @value
+    end
+
+    def casted?
+      !!@casted
+    end
+
+    def cast!
+      return if casted?
+
+      @value = @cast_proc.call(value)
+      @casted = true
+    end
+  end
+end

data/lib/casted_hash/version.rb

@@ -0,0 +1,3 @@
+class CastedHash
+  VERSION = "0.0.2"
+end

data/lib/casted_hash.rb

@@ -0,0 +1,110 @@
+require "casted_hash/version"
+require "equalizer"
+require "casted_hash/value"
+require "active_support/hash_with_indifferent_access"
+
+class CastedHash
+  include Equalizer.new(:raw, :cast_proc)
+  extend Forwardable
+  attr_reader :cast_proc
+
+  def_delegators :@hash, *[:keys, :inject, :key?, :include?]
+  def_delegators :casted_hash, *[:collect]
+
+  def initialize(constructor = {}, cast_proc = lambda { |x| x })
+    @cast_proc = cast_proc
+    @hash = HashWithIndifferentAccess.new(pack_hash(constructor))
+  end
+
+  def each
+    @hash.each do |key, value|
+      yield key, value.casted_value
+    end
+  end
+  alias_method :each_pair, :each
+
+  def values
+    @hash.values.map(&:casted_value)
+  end
+
+  def fetch(key, *args)
+    val = @hash[key]
+
+    if val.nil?
+      @hash.fetch(key, *args)
+    else
+      cast(key, val).value
+    end
+  end
+
+  def [](key)
+    val = @hash[key]
+    val.casted_value unless val.nil?
+  end
+
+  def []=(key, value)
+    @hash[key] = pack(value)
+  end
+  alias_method :store, :[]=
+
+  def delete(key)
+    @hash.delete(key)
+  end
+
+  def to_hash
+    @hash
+  end
+
+  def merge(other)
+    other = other.to_hash
+    self.class.new(@hash.merge(other), cast_proc)
+  end
+
+  def merge!(other)
+    other = pack_hash(other)
+    @hash.merge!(other)
+  end
+
+  def casted?(key)
+    val = @hash[key]
+    val.casted? if val
+  end
+
+  def inspect
+    "#<#{self.class.name} hash=#{@hash.inject({}){|hash, (k, v)|hash.merge(k => casted?(k) ? v.value : "<#{v.value}>")}}>"
+  end
+
+  def casted_hash
+    cast_all!
+
+    @hash.inject({}) do |hash, (key, value)|
+      hash.merge(key => value.value)
+    end
+  end
+
+private
+
+  def raw
+    @hash
+  end
+
+  def cast_all!
+    @hash.each do |key, value|
+      value.cast!
+    end
+  end
+
+  def pack(value)
+    if value.is_a?(Value)
+      value
+    else
+      Value.new(value, cast_proc)
+    end
+  end
+
+  def pack_hash(hash)
+    hash.inject({}) do |hash, (key, value)|
+      hash.merge key => pack(value)
+    end if hash
+  end
+end

data/test/helper.rb

@@ -0,0 +1,24 @@
+$TESTING = true
+require 'coveralls'
+Coveralls.wear! do
+  add_filter "/test/"
+end
+
+ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test'
+
+if ENV.has_key?("SIMPLECOV")
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter "/test/"
+  end
+end
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'casted_hash'
+
+require 'minitest/autorun'
+require 'minitest/pride'

data/test/test_casted_hash.rb

@@ -0,0 +1,159 @@
+require 'helper'
+
+class TestCastedHash < Minitest::Test
+  describe CastedHash do
+
+    it "should be able to define a cast method" do
+      hash = CastedHash.new({:foo => 1}, lambda { |x| x.to_s })
+
+      hash[:bar] = 1
+      assert_equal "1", hash[:bar]
+
+      hash[:bar] = 2
+      assert_equal "2", hash[:bar]
+
+      hash.store :bar, 3
+      assert_equal "3", hash[:bar]
+    end
+
+    it "should cast when expected" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda {|x| x + 10 })
+      assert !hash.casted?(:a)
+      assert !hash.casted?(:b)
+
+      assert hash[:a]
+
+      assert hash.casted?(:a)
+      assert !hash.casted?(:b)
+    end
+
+    it "should only cast once" do
+      hash = CastedHash.new({:foo => 1}, lambda { |x| x + 1 })
+
+      assert_equal 2, hash[:foo]
+      assert_equal 2, hash[:foo]
+
+      hash[:bar] = 123
+      assert_equal 124, hash[:bar]
+      assert_equal 124, hash[:bar]
+    end
+
+    it "should be able to fetch all casted values" do
+      hash = CastedHash.new({:a => 1, :b => 10, :c => 100}, lambda { |x| x * 10 })
+      assert_equal [10, 100, 1000], hash.values
+    end
+
+    it "should inspect casted values" do
+      hash = CastedHash.new(nil, lambda { |x| "foobar" })
+
+      assert_equal("#<CastedHash hash={}>", hash.inspect)
+
+      hash[:bar] = "foo"
+      assert_equal("#<CastedHash hash={\"bar\"=>\"<foo>\"}>", hash.inspect) # not yet casted
+      assert_equal("foobar", hash[:bar])
+      assert_equal("#<CastedHash hash={\"bar\"=>\"foobar\"}>", hash.inspect)
+
+      hash = CastedHash.new({:foo => "bar"}, lambda { |x| "foobar" })
+      assert_equal("#<CastedHash hash={\"foo\"=>\"<bar>\"}>", hash.inspect) # not yet casted
+      assert_equal("foobar", hash[:foo])
+      assert_equal("#<CastedHash hash={\"foo\"=>\"foobar\"}>", hash.inspect)
+    end
+
+    it "should loop through casted values" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda { |x| "processed: #{x}" })
+      map = []
+
+      hash.each do |key, value|
+        map << value
+      end
+
+      assert_equal ["processed: 1", "processed: 2"], map
+    end
+
+    it "should delete values" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda {|x| x + 10 })
+      hash.delete(:b)
+      assert_equal({"a" => 11}, hash.casted_hash)
+    end
+
+    it "should merge values" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda {|x| x + 10 })
+      assert_equal 11, hash[:a]
+      assert_equal 12, hash[:b]
+
+      hash = hash.merge({:a => 3})
+
+      assert_equal 13, hash[:a]
+      assert_equal 12, hash[:b]
+    end
+
+    it "should merge! values" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda {|x| x + 10 })
+      assert_equal 11, hash[:a]
+      assert_equal 12, hash[:b]
+      
+      hash.merge!({:a => 3})
+
+      assert_equal 13, hash[:a]
+      assert_equal 12, hash[:b]
+    end
+
+    it "should not cast all values when merging hashes" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda {|x| x + 10 })
+      hash = hash.merge :c => 3
+
+      assert !hash.casted?(:a)
+      assert !hash.casted?(:b)
+      assert !hash.casted?(:c)
+
+      hash.merge! :c => 3
+
+      assert !hash.casted?(:a)
+      assert !hash.casted?(:b)
+      assert !hash.casted?(:c)
+
+      other_hash = CastedHash.new({:c => 1, :d => 2}, lambda {|x| x + 10 })
+      hash = hash.merge other_hash
+
+      assert !hash.casted?(:a)
+      assert !hash.casted?(:b)
+      assert !hash.casted?(:c)
+      assert !other_hash.casted?(:c)
+      assert !other_hash.casted?(:d)
+
+      other_hash = CastedHash.new({:c => 1, :d => 2}, lambda {|x| x + 10 })
+      hash.merge! other_hash
+
+      assert !hash.casted?(:a)
+      assert !hash.casted?(:b)
+      assert !hash.casted?(:c)
+      assert !other_hash.casted?(:c)
+      assert !other_hash.casted?(:d)
+    end
+
+    it "should define a hash method" do
+      l = lambda {|x| x + 10 }
+      hash1 = CastedHash.new({:a => 1, :b => 2}, l)
+      hash2 = CastedHash.new({:a => 1, :b => 2}, l)
+      hash3 = CastedHash.new({:a => 1, :b => 2}, lambda {|x| x + 11 })
+
+      assert_equal hash1.hash, hash2.hash
+      assert hash1.hash != hash3.hash
+    end
+
+    it "should not add all requested values" do
+      hash = CastedHash.new({:a => 1, :b => 2}, lambda {|x|x})
+      assert_nil hash[:undefined_key]
+
+      assert_equal ["a", "b"], hash.keys
+
+      assert_raises(KeyError) do
+        hash.fetch('another_undefined_key')
+      end
+
+      assert_equal '123', hash.fetch('another_undefined_key', '123')
+      assert_equal ["a", "b"], hash.keys
+    end
+
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: casted_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stephan Kaag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A casted hash
+email:
+- stephan@ka.ag
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- casted_hash.gemspec
+- lib/casted_hash.rb
+- lib/casted_hash/value.rb
+- lib/casted_hash/version.rb
+- test/helper.rb
+- test/test_casted_hash.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A casted hash
+test_files:
+- test/helper.rb
+- test/test_casted_hash.rb