fat-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a5650524ecb53949a2c471268e675261833e67a
+  data.tar.gz: 01084a031199c786468516f8387614e632e3c53b
+SHA512:
+  metadata.gz: 59f8f95c7cb0a473bf9b1eb48fb482d3a3975ab113bcbea0e3777b380387c312d936bcdd5a378deaa0be974d3b3612e9d9f7c3888f3b51848a826af8950a48ed
+  data.tar.gz: 95af9ae4043f032d976781a55ae1428d0c4895328fe1b4ac69c424d2cda337eb7f71550cfeb00a05a6296fe4a5290913f1f968e3711ff6ba315f7c7ee17c1191

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Lucas Tolchinsky
+
+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/Makefile

@@ -0,0 +1,4 @@
+build:
+	cutest test/**/*_test.rb
+
+.PHONY: build

data/README.md

@@ -0,0 +1,76 @@
+fat
+===
+
+Ruby implementation for [Fat](https://github.com/tonchis/fat), to support non-MRI.
+
+The name is an acronym for "find at". It helps you avoid that nasty `undefined method [] for nil` when looking for values in a hash.
+
+# Use
+
+Say you have the following hash
+
+```ruby
+hash = {
+  "foo" => {
+    "bar" => {
+      "baz" => :value
+    }
+  }
+}
+```
+
+To get your `:value` you usually do `hash["foo"]["bar"]["baz"]`. But what happens if `"bar"` doesn't exist? Yeap, BOOM!
+
+I find more comfortable to ask if I can walk to `:value` using the keys `"foo"`, `"bar"`, `"baz"`. If I can't, tell me where the path ends.
+
+```ruby
+require "fat"
+
+Fat.at(hash, "foo", "bar", "baz")
+# => :value
+
+Fat.at(hash, "foo", "not", "here")
+# => Fat::FatError: No hash found at foo.not
+```
+
+The `Fat::FatError` let's you know that a `Hash` was expected as a value for the key `"not"`. Way more explicit than guessing from a `undefined method [] for nil`.
+
+It's the same with Symbols
+
+```ruby
+hash = {
+  "foo" => {
+    :bar => {
+      "baz" => :value
+    }
+  }
+}
+
+Fat.at(hash, "foo", :bar, "baz")
+# => :value
+```
+
+If you prefer to call `hash.at` you only need to include `Fat` into `Hash`.
+
+```ruby
+Hash.include(Fat)
+
+hash.at("foo", "bar", "baz")
+# => :value
+```
+
+If all your keys are Strings you can *namespace* them with dots.
+
+```ruby
+Hash.include(Fat)
+
+hash.at("foo.bar.baz")
+# => :value
+```
+
+# Install
+
+```bash
+$ gem install fat-rb
+```
+

data/fat-rb.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "fat-rb"
+  s.version = "0.1.0"
+  s.summary = "Ruby implementation of the Fat gem"
+  s.description = s.summary
+  s.authors = ["Lucas Tolchinsky"]
+  s.email = ["lucas.tolchinsky@gmail.com"]
+  s.homepage = "https://github.com/tonchis/fat-rb"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest"
+end
+

data/lib/fat.rb

@@ -0,0 +1,27 @@
+module Fat
+  FatError = Class.new(StandardError)
+
+  @fat ||= ->(hash, *args) do
+    fields = args.length == 1 ? args.first.split(".") : args
+
+    value = hash
+
+    fields[0..-1].each_with_index do |field, index|
+      value = value[field]
+      if index != fields.length - 1 && !value.kind_of?(Hash)
+        raise Fat::FatError, "No hash found at #{fields[0..index].join(".")}"
+      end
+    end
+
+    value
+  end
+
+  def self.at(hash, *args)
+    @fat.(hash, *args)
+  end
+
+  def at(*args)
+    Fat.instance_variable_get(:@fat).(self, *args)
+  end
+end
+

data/test/fat_test.rb

@@ -0,0 +1,90 @@
+require "cutest"
+require_relative "../lib/fat"
+
+scope do
+  setup do
+    {
+      foo: {
+        "bar" => {
+          baz: :found
+        }
+      }
+    }
+  end
+
+  test "honor key type" do |hash|
+    assert_raise(Fat::FatError) { Fat.at(hash, :foo, :not, :found) }
+
+    assert_equal :found, Fat.at(hash, :foo, "bar", :baz)
+  end
+end
+
+scope do
+  setup do
+    {
+      "foo" => {
+        "bar" => {
+          "baz" => :found
+        }
+      }
+    }
+  end
+
+  test "namespaced string keys" do |hash|
+    assert_raise(Fat::FatError) { Fat.at(hash, "foo", :not, :found) }
+
+    assert_equal :found, Fat.at(hash, "foo.bar.baz")
+  end
+end
+
+scope do
+  setup do
+    Hash.include(Fat)
+
+    {
+      "foo" => {
+        "bar" => {
+          "baz" => :found
+        }
+      }
+    }
+  end
+
+  test "include the module" do |hash|
+    assert hash.respond_to?(:at)
+  end
+
+  test "honor Fat interface" do |hash|
+    assert_equal :found, hash.at("foo", "bar", "baz")
+    assert_equal :found, hash.at("foo.bar.baz")
+  end
+end
+
+scope do
+  setup do
+    {
+      "foo" => {
+        "not_a_hash" => :wat,
+        "bar" => {
+          "baz" => :found
+        }
+      }
+    }
+  end
+
+  test "raise error if a value is not a hash" do |hash|
+    assert_raise(Fat::FatError) { Fat.at(hash, "foo.not_a_hash.baz") }
+  end
+end
+
+scope do
+  setup do
+    Hash.include(Fat)
+  end
+
+  test "corner case" do
+    assert_raise(Fat::FatError) { {}.at(:foo, :bar) }
+    assert_raise(Fat::FatError) { Fat.at({}, :foo, :bar) }
+  end
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: fat-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Tolchinsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  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: Ruby implementation of the Fat gem
+email:
+- lucas.tolchinsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- LICENSE
+- Makefile
+- README.md
+- fat-rb.gemspec
+- lib/fat.rb
+- test/fat_test.rb
+homepage: https://github.com/tonchis/fat-rb
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of the Fat gem
+test_files: []