fat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a2a4f02825c7b90cc3693f53b6d54c0762e3065
-  data.tar.gz: 6641e03bd1a109a5b65528da792e2c4e6df90406
+  metadata.gz: b8c0e66c3046460eab9b11b0722c51e9641b081c
+  data.tar.gz: b5855fc95174b566607dc8a0b17c374d3b1a7da6
 SHA512:
-  metadata.gz: 76bffdd370590a7acad70d29dfdcc3c08b2c56cafc88439ce47c6aab4b7e090e5b46f3af4932021a087a9f88780e21d48a443e5bbf8c19488d0fb2d83f46d4e2
-  data.tar.gz: 54b76753d47a02ee615d41a0f604b6fb0e4e6ad164c5b45565f8e2b815da434c3df1ebde86d6b2ee1848422cceb6cc8b624a493476652b379e087973ce809a9a
+  metadata.gz: 3829b79d698b14644b50e8728bc03d596b856fe2e95836b00039975a8a9a908211c7062a4079400ce5508a73db698f8713d9702ada4a15e0c9cb8e7d9f984d78
+  data.tar.gz: 74f292a0719f7784e572477052d0810f9fe67f606b6d31f8401f372acc5eaacfabd2bddbfdbc1191017e377fbbee27af792e12b8488b7ebbd686f335460ab177

data/README.md

@@ -5,3 +5,70 @@ C extension to find values in nested hashes without pain
 
 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, give me some `nil`.
+
+```ruby
+require "fat"
+
+Fat.at(hash, "foo", "bar", "baz")
+# => :value
+
+Fat.at(hash, "foo", "not", "here")
+# => 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
+```
+
+And the last one! 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
+```
+

data/ext/fat/fat.c

@@ -46,6 +46,10 @@ static VALUE fat(VALUE hash, VALUE fields) {
     if (value == Qnil) {
       return Qnil;
     }
+
+    if (TYPE(value) != T_HASH) {
+      return value;
+    }
   }
 
   return value;

data/fat.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "fat"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.summary = "C extension to find values in nested hashes without pain"
   s.description = s.summary
   s.authors = ["Lucas Tolchinsky"]

data/test/fat_test.rb

@@ -60,3 +60,20 @@ scope do
   end
 end
 
+scope do
+  setup do
+    {
+      "foo" => {
+        "not_a_hash" => :wat,
+        "bar" => {
+          "baz" => :found
+        }
+      }
+    }
+  end
+
+  test "break if a key doesn't hold a hash" do |hash|
+    assert_equal :wat, Fat.at(hash, "foo.not_a_hash.baz")
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lucas Tolchinsky