tainted_hash 0.2.0 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea0d328f383629e28c37a106bc53f7f320fdb827
+  data.tar.gz: 2099a31bf32527f818449a86a9b5774cc24fa24a
+SHA512:
+  metadata.gz: 78e0d10bc3b4247e96e172672f1e6f625e7539c298910317ba4ba8bec9f6e88bcf64c2eef690ffe4fa3b025c9e202f819eafa28df1c8a7fcb877ed540288b522
+  data.tar.gz: fd2e58e7e2548c5fc1cdc2c2770219c445f4d4a0663e7e84812e5e0aea7ea02df868b5bfc106d0fa54d307b76805c19ad65a83990e9eb20d5773201e2c9ef89c

data/lib/tainted_hash.rb

@@ -1,7 +1,5 @@
-require 'set'
-
 class TaintedHash < Hash
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 
   class UnexposedError < StandardError
     # Builds an exception when a TaintedHash has some unexposed keys.  Useful
@@ -30,7 +28,9 @@ class TaintedHash < Hash
   # Public: Gets the original hash that is being wrapped.
   #
   # Returns a Hash.
-  attr_reader :original_hash
+  def original_hash
+    untaint_original_hash(@original_hash)
+  end
 
   # A Tainted Hash only exposes expected keys.  You can either expose them
   # manually, or through common Hash methods like #values_at or #slice.  Once
@@ -41,7 +41,7 @@ class TaintedHash < Hash
   #
   def initialize(hash = nil, new_class = nil)
     @new_class = new_class || (hash && hash.class) || self.class.default_hash_class
-    @original_hash = hash || @new_class.new
+    @original_hash = (hash && hash.dup) || @new_class.new
     @exposed_nothing = true
 
     @original_hash.keys.each do |key|
@@ -89,12 +89,22 @@ class TaintedHash < Hash
   # default - A sensible default.
   #
   # Returns the value of the key, or the default.
-  def fetch(key, default = nil)
+  def fetch(key, *default)
+    raise ArgumentError, "wrong number of arguments (#{default.size + 1} for 1..2)" if default.size > 1
+
     key_s = key.to_s
-    @original_hash.fetch key_s, default
+    if @original_hash.key?(key_s)
+      self[key_s]
+    elsif block_given?
+      yield
+    elsif !default.empty?
+      default[0]
+    else
+      raise KeyError, "key not found: #{key}"
+    end
   end
 
-  # Public: Gets the value for the key, and exposes the key for the Hash.
+  # Public: Gets the value for the key but does not expose the key for the Hash.
   #
   # key - A String key to retrieve.
   #
@@ -102,7 +112,6 @@ class TaintedHash < Hash
   def [](key)
     key_s = key.to_s
     return if !@original_hash.key?(key_s)
-
     get_original_hash_value(key_s)
   end
 
@@ -138,6 +147,7 @@ class TaintedHash < Hash
   end
 
   alias key? include?
+  alias has_key? include?
 
   # Public: Returns the values for the given keys, and exposes the keys.
   #
@@ -145,7 +155,17 @@ class TaintedHash < Hash
   #
   # Returns an Array of the values (or nil if there is no value) for the keys.
   def values_at(*keys)
-    @original_hash.values_at *keys.map { |k| k.to_s }
+    keys.map { |k| self[k] }
+  end
+
+  # Public: Produces a copy of the current Hash with the same set of exposed
+  # keys as the original Hash.
+  #
+  # Returns a dup of this TaintedHash.
+  def dup
+    super.tap do |duplicate|
+      duplicate.instance_variable_set :@original_hash, @original_hash.dup
+    end
   end
 
   # Public: Merges the given hash with the internal and a dup of the current
@@ -165,7 +185,7 @@ class TaintedHash < Hash
   # Returns this TaintedHash.
   def update(hash)
     hash.each do |key, value|
-      @original_hash[key.to_s] = value
+      self[key.to_s] = value
     end
     self
   end
@@ -218,6 +238,24 @@ private
     @original_hash[key_s] = value
   end
 
+  # Private: Returns a regular Hash, transforming all embedded TaintedHash
+  # objects into regular Hash objects with all keys exposed.
+  #
+  # original_hash - The @original_hash you want to untaint
+  #
+  #
+  # Returns a Hash
+  def untaint_original_hash(original_hash)
+    hash = @new_class.new
+    original_hash.each do |key, value|
+      hash[key] = case value
+        when TaintedHash then untaint_original_hash(value.instance_variable_get :@original_hash)
+        else value
+        end
+    end
+    hash
+  end
+
   module RailsMethods
     def self.included(base)
       base.send :alias_method, :stringify_keys!, :stringify_keys
@@ -229,16 +267,16 @@ private
     #
     # Returns a Hash of the requested keys and values.
     def slice(*keys)
-      str_keys = @original_hash.keys & keys.map { |k| k.to_s }
-      hash = self.class.new
-      str_keys.each do |key|
-        hash[key] = @original_hash[key]
+      keys.each_with_object(self.class.new) do |key, hash|
+        key_s = key.to_s
+        hash[key_s] = @original_hash[key_s] if @original_hash.key?(key_s)
       end
-      hash
     end
 
     def slice!(*keys)
-      raise NotImplementedError
+      str_keys = keys.map { |k| k.to_s }
+      (@original_hash.keys - str_keys).each { |key| delete(key) }
+      expose(*str_keys)
     end
 
     def stringify_keys

data/tainted_hash.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'tainted_hash'
-  s.version           = '0.2.0'
-  s.date              = '2013-07-16'
+  s.version           = '0.3.0'
+  s.date              = '2013-10-09'
   s.rubyforge_project = 'tainted_hash'
 
   ## Make sure your summary is short. The description may be as long

data/test/tainted_hash_test.rb

@@ -29,12 +29,36 @@ class TaintedHashTest < Test::Unit::TestCase
     assert @hash.include?('c')
   end
 
+  def test_merge
+    @tainted.expose(:a)
+    merged = @tainted.merge('d' => 3)
+    assert_equal %w(a), @tainted.keys.sort
+    assert_equal %w(a d), merged.keys.sort
+    assert_equal %w(a b c), @tainted.original_hash.keys.sort
+    assert_equal %w(a b c d), merged.original_hash.keys.sort
+  end
+
   def test_dup
-    @tainted[:c].expose :name
     @tainted.expose :a
-    dup = @tainted.dup.expose :b
+    dup = @tainted.dup
+    dup.expose :b
     assert_equal %w(a), @tainted.keys.sort
     assert_equal %w(a b), dup.keys.sort
+    @tainted[:d] = 3
+    dup[:e] = 4
+    assert_equal %w(a d), @tainted.keys.sort
+    assert_equal %w(a b e), dup.keys.sort
+  end
+
+  def test_expose_all
+    @tainted.expose_all
+    assert_equal %w(a b c), @tainted.keys.sort
+  end
+
+  def test_original_hash
+    assert_equal @hash, @tainted.original_hash
+    assert_equal @hash.merge('d' => 3), @tainted.merge('d' => 3).original_hash
+    assert_equal @hash, @tainted.expose_all.original_hash
   end
 
   def test_expose_keys
@@ -50,6 +74,10 @@ class TaintedHashTest < Test::Unit::TestCase
     assert !@tainted.include?(:d)
     assert_equal 1, @tainted.fetch(:a, :default)
     assert_equal :default, @tainted.fetch(:d, :default)
+    assert_raises KeyError do
+      @tainted.fetch(:d)
+    end
+    assert_equal :default, @tainted.fetch(:d) { :default }
     assert !@tainted.include?(:a)
     assert !@tainted.include?(:d)
   end
@@ -137,8 +165,8 @@ class TaintedHashTest < Test::Unit::TestCase
     assert !@tainted.include?(:a)
     assert !@tainted.include?(:d)
     @tainted.update :a => 2, :d => 1
-    assert !@tainted.include?(:a)
-    assert !@tainted.include?(:d)
+    assert @tainted.include?(:a)
+    assert @tainted.include?(:d)
     assert_equal 2, @tainted[:a]
     assert_equal 1, @tainted[:d]
   end
@@ -188,4 +216,19 @@ class TaintedHashTest < Test::Unit::TestCase
     slice = @tainted.slice :a, :d
     assert_equal({'a' => 1}, slice.to_hash)
   end
+
+  def test_slice_bang_modifies_self
+    @tainted.slice! :a, :d
+    assert_equal({'a' => 1}, @tainted.to_hash)
+  end
+
+  def test_include_aliases
+    assert !@tainted.include?(:a)
+    assert !@tainted.has_key?(:a)
+    assert !@tainted.key?(:a)
+    @tainted[:a] = 2
+    assert @tainted.include?(:a)
+    assert @tainted.has_key?(:a)
+    assert @tainted.key?(:a)
+  end
 end

metadata

@@ -1,30 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: tainted_hash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Rick Olson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Hash wrapper.
@@ -42,25 +39,24 @@ files:
 - test/tainted_hash_test.rb
 homepage: https://github.com/technoweenie/tainted_hash
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: tainted_hash
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 2
 summary: Hash wrapper.