hash_assertions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6e08b8f2329e6d39a20b165eda60a9866a8b973
+  data.tar.gz: 3a78f7206f45e7736d1fab0575fc9d537c4d02c9
+SHA512:
+  metadata.gz: b6b4c506c2dbe5b8db36c50308ed86c65cb371c2b7dffa4f66d566a95065a8b7b46ad77c211a7a026e24a518bd5383eed3a48d2fd70cb8307eeff803b8971d8a
+  data.tar.gz: 67f2718cbd7d40bcb7a655316c10850e6ee7cccf378740bfb525e363321e4edba352a9e021b33ab9f98aad6d5e9b07896ae87399eacb58d2c702c98d9e3a7739

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomek Wałkuski
+
+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,80 @@
+# hash_assertions
+
+Hash assertions: assert required keys, assert keys with values
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem "hash_assertions"
+```
+
+And then execute:
+
+``` sh
+$ bundle
+```
+
+Or install it yourself as:
+
+``` sh
+$ gem install hash_assertions
+```
+
+and require it:
+
+``` ruby
+require "hash_assertions"
+```
+
+## Usage
+
+### assert_required_keys
+
+``` ruby
+require "hash_assertions/assert_required_keys"
+
+# Raises nothing
+{ foo: "bar", baz: "qux" }.assert_required_keys(:foo, :baz)
+
+# Raises ArgumentError, "Missing required key: baz"
+{ foo: "bar" }.assert_required_keys(:foo, :baz)
+
+# Raises ArgumentError, "Missing required key: baz"
+{ foo: "bar", baz: "qux" }.assert_required_keys(:foo, "baz")
+
+# Raises ArgumentError, "Missing required key: [:foo, :baz]"
+# (assert_required_keys doesn't flatten arguments!)
+{ foo: "bar", baz: "qux" }.assert_required_keys([:foo, :baz])
+```
+
+### assert_keys_with_values
+
+``` ruby
+require "hash_assertions/assert_keys_with_values"
+
+# Raises nothing
+{ foo: "bar", baz: "qux" }.assert_keys_with_values(:foo, :baz)
+
+# Raises ArgumentError, "Blank value for key: baz"
+{ foo: "bar", baz: nil }.assert_keys_with_values(:foo, :baz)
+
+# Raises ArgumentError, "Blank value for key: baz"
+{ foo: "bar", baz: "" }.assert_keys_with_values(:foo, :baz)
+
+# Raises ArgumentError, "Blank value for key: baz"
+{ foo: "bar", baz: "qux" }.assert_keys_with_values(:foo, "baz")
+
+# Raises ArgumentError, "Blank value for key: [:foo, :baz]"
+# (assert_keys_with_values doesn't flatten arguments!)
+{ foo: "bar", baz: "qux" }.assert_keys_with_values([:foo, :baz])
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/hash_assertions.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "hash_assertions/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hash_assertions"
+  spec.version       = HashAssertions::VERSION
+  spec.authors       = ["Tomek Wałkuski"]
+  spec.email         = ["ja@jestem.tw"]
+  spec.description   = %q{Hash assertions}
+  spec.summary       = %q{Hash assertions: assert required keys, assert keys with values}
+  spec.homepage      = "https://github.com/tomekw/hash_assertions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/hash_assertions/assert_keys_with_values.rb

@@ -0,0 +1,11 @@
+class Hash
+  def assert_keys_with_values(*keys_with_values)
+    keys_with_values.each do |key_with_value|
+      required_value = fetch(key_with_value, nil)
+
+      if required_value.nil? || required_value.empty?
+        raise ArgumentError, "Blank value for key: #{key_with_value}"
+      end
+    end
+  end
+end

data/lib/hash_assertions/assert_required_keys.rb

@@ -0,0 +1,9 @@
+class Hash
+  def assert_required_keys(*required_keys)
+    required_keys.each do |required_key|
+      unless has_key?(required_key)
+        raise ArgumentError, "Missing required key: #{required_key}"
+      end
+    end
+  end
+end

data/lib/hash_assertions/version.rb

@@ -0,0 +1,3 @@
+module HashAssertions
+  VERSION = "0.0.1"
+end

data/lib/hash_assertions.rb

@@ -0,0 +1,3 @@
+require "hash_assertions/version"
+require "hash_assertions/assert_required_keys"
+require "hash_assertions/assert_keys_with_values"

data/spec/hash_assertions/assert_keys_with_values_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+require "hash_assertions/assert_keys_with_values"
+
+describe "assert_keys_with_values" do
+  let(:hash) { { foo: "bar", baz: "qux", bar: nil, qux: "" } }
+
+  context "when all provided keys have present values" do
+    let(:present_keys?) { [:foo, :baz] }
+
+    it "passes" do
+      expect { hash.assert_keys_with_values(*present_keys?) }.to_not raise_error
+    end
+  end
+
+  context "when some keys with nil values" do
+    let(:present_keys?) { [:baz, :bar] }
+
+    it "fails" do
+      expect do
+        hash.assert_keys_with_values(*present_keys?)
+      end.to raise_error(ArgumentError, "Blank value for key: bar")
+    end
+  end
+
+  context "when some keys with empty values" do
+    let(:present_keys?) { [:baz, :qux] }
+
+    it "fails" do
+      expect do
+        hash.assert_keys_with_values(*present_keys?)
+      end.to raise_error(ArgumentError, "Blank value for key: qux")
+    end
+  end
+
+  context "when using strings for keys" do
+    let(:present_keys?) { ["foo", "baz"] }
+
+    it "fails" do
+      expect do
+        hash.assert_keys_with_values(*present_keys?)
+      end.to raise_error(ArgumentError, "Blank value for key: foo")
+    end
+  end
+
+  context "when not splatting keys array" do
+    let(:present_keys?) { [:baz, :bar] }
+
+    it "fails" do
+      expect do
+        hash.assert_keys_with_values(present_keys?)
+      end.to raise_error(ArgumentError, "Blank value for key: [:baz, :bar]")
+    end
+  end
+end

data/spec/hash_assertions/assert_required_keys_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+require "hash_assertions/assert_required_keys"
+
+describe "assert_required_keys" do
+  let(:hash) { { foo: "bar", baz: "qux" } }
+
+  context "when all required keys in hash" do
+    let(:required_keys) { [:foo, :baz] }
+
+    it "passes" do
+      expect { hash.assert_required_keys(*required_keys) }.to_not raise_error
+    end
+  end
+
+  context "when some keys missing" do
+    let(:required_keys) { [:foo, :baz, :bar] }
+
+    it "fails" do
+      expect do
+        hash.assert_required_keys(*required_keys)
+      end.to raise_error(ArgumentError, "Missing required key: bar")
+    end
+  end
+
+  context "when using strings for required keys" do
+    let(:required_keys) { [:foo, "baz"] }
+
+    it "fails" do
+      expect do
+        hash.assert_required_keys(*required_keys)
+      end.to raise_error(ArgumentError, "Missing required key: baz")
+    end
+  end
+
+  context "when not splatting required keys array" do
+    let(:required_keys) { [:foo, :baz] }
+
+    it "fails" do
+      expect do
+        hash.assert_required_keys(required_keys)
+      end.to raise_error(ArgumentError, "Missing required key: [:foo, :baz]")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "rspec"
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: hash_assertions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomek Wałkuski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-08 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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: Hash assertions
+email:
+- ja@jestem.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hash_assertions.gemspec
+- lib/hash_assertions.rb
+- lib/hash_assertions/assert_keys_with_values.rb
+- lib/hash_assertions/assert_required_keys.rb
+- lib/hash_assertions/version.rb
+- spec/hash_assertions/assert_keys_with_values_spec.rb
+- spec/hash_assertions/assert_required_keys_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tomekw/hash_assertions
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: 'Hash assertions: assert required keys, assert keys with values'
+test_files:
+- spec/hash_assertions/assert_keys_with_values_spec.rb
+- spec/hash_assertions/assert_required_keys_spec.rb
+- spec/spec_helper.rb