yew 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Yjg0MjQ2N2FkYjMyYTkyMWE4YWYxZDI3ZTQ2YWRhY2Q2ZTc0MDliOQ==
+    MDgyM2U4N2M0NTNkZmU3MzUyZmY0MzRjYzEwMmZkZmZhZjgzYzg4NQ==
   data.tar.gz: !binary |-
-    ODJlOTEyODk0MmQ5OTlmNTU1MTk5Y2QwMWQ5MDYxMmRjZTYzNGViZQ==
+    MDMyNzA0ZGNlNWY3NTJlMTI1YzA2NTEwOWUzMjA4YTBmOTJjYmVhZg==
 SHA512:
   metadata.gz: !binary |-
-    ZTc5ODU2M2Y4ZmIyOGFhYTgxNzllNmQzMTg3M2ViNjY1MjVkYTM0NTk3YmYw
-    NTc1OTRiYjI3MGY4NTgxZDMxZjExNGVhYjY2NmUxNTA3NTY3ODVlNWRmMzlj
-    YzkyNmY1MjdlYzA4NmY4ZWE5YTVhOTY3Y2JiNGMxY2Q4YjM0MWM=
+    YzZkMWJkYjA5N2YwYTEwZjhlYTA5YmNmY2Q3NGNjYWIyMmU4ZTlkMzhlOTM5
+    YmY4MTg1OTBjNWNmYWZlZDkxYTNlYzUyZDU1M2UyNDFhYmJhYWY4YTMyOTIx
+    MmQ0YTEyNjAzYjRlOTVlOGY2ZmRlMzcwNTM5ODBiOTE3ZTdiM2E=
   data.tar.gz: !binary |-
-    OTc3MDQxNDBlOWM2MWNkOWM1MTQ3YmIzMGMyOWI3ZmU2NjNiZmJmNjk0YmFj
-    NmMyMmU4NjUwZjI3OWI2MTU3ZDMxMjg2YjY4YTRlOTQ1ZTkzMjNlZTcyMWU5
-    Zjg2YzI0YzUzN2VmMmIzOGJhNTA4MjIyOWUyYTQ1NGJlZGQ1OTE=
+    YmRiNzdjNjM0MjFmNTE2MjZhMzI3OTEwMmZjMWU0OWYyNjQyMDY2YTAwNGY1
+    NDIxNWNhZmE0YjI0YTc2NmRkNzI4M2I4NmFlNWFiMTg3NjI2NzlkNzBlN2Zi
+    ODBmMjBjYjZjNjc2NzRkMTQ2NjA3MTE2ZWZkOGVjZTE1YWYyZjQ=

data/README.md

@@ -86,8 +86,61 @@ There are two options for installation: packaged gem and source file.
     curl "https://raw.github.com/snmgian/yew/master/lib/yew.rb" 2>/dev/null -o "yew.rb"
     ```
 
+## Running tests
+
+Tests are written in MiniTest. To run them all just execute the following from your command line:
+
+  ``` shell
+  ruby -I. test/ts_yew.rb
+  ```
+
+## Badges
+
+[![Build Status](https://travis-ci.org/snmgian/yew.svg?branch=master)](https://travis-ci.org/snmgian/yew) [![Code Climate](https://codeclimate.com/github/snmgian/yew.png)](https://codeclimate.com/github/snmgian/yew)
+
 ## License
 
 This software is licensed under the [LGPL][lgpl] license.
 
 [lgpl]: https://www.gnu.org/licenses/lgpl.html
+
+## Art
+
+``` markdown
+
+                                  .:   ,~ :
+                                  +7Z?~+$Z$.    .
+                                 ~$ZZZZ7$OZ$.,::~:~.
+                             .::IZ$$O8Z$ZZZ$$$7OOO7.
+                            7$$$$Z$$OZZOZZZOOZOOZ$$$:.+,~
+                       .. . $Z$ZZZ$$$OZZOZ$O88$OOO8OO8ZZ~
+                        :,?$ZOOZZ88$OOZ$OOOO8OZOOOOO88OZ~+~,
+                       .=ZZOOOOZOO8OOZOZOO8Z8OZO8OOOOO888ZZ::.
+                       ~7ZOZOOZOO8O8O8O8D8OOZOOZDDD8ZO8O888O?I
+                   . +..$OZOOO8O88D8Z88OOD8ZOOO8OZOO8$O88OOZ$O:~. .
+              .   .?.?+7ZZOOO8888D888DDO88888O8ZO88Z88Z888888OZ~.:.
+              ?~7$ZZZOZOZOOO88D888ZDD888D8888888OOOOODZ8OO8OZ88OZ7$+
+              IZOO$OZO8ZZOOD$ZO8DZ8D88888ZD8D8OD88OO8OZOO$OOOOOO8O+:
+             .,.$OZOZOZZZZ88O88O88OO888ON88DO888ZD8O88~7ZOO$$Z88OOO+
+            ~ZZ?ZZZZOZO8O8ZOZOZO888888888O8O8888D88D8~8888O88O8ZO8$.=
+            ?ZZZ8OZOO8O8OOO8OOO8888888DD8O8O88ODO8D88DD88DZ8888O88$ZI ..
+        .. ?$?O8OOO8OZ8D8OZ8ZOODOOO8888D8ODZDDD8ONDO888OO8O88D8OOZOZZ7.~..
+        ,+.7ZO8O8888O88O888888OO7?DD888888D88O8888OOOD88OZD8Z88888OOOZ+: ,
+      ?.I$ZOO8OO8OZ88D8OO8OOO8DDZ7?88NO88O88DD888DO88888DO8888888888O8ZZO~
+      .I=8OOO$8$7.I$888888888D88DDDO8DO8DD8D8D8DD8DD8D88OODZD8DO88O8888O.
+     .$7O888888888O8888D8DOO878D88$O78888D8888?ZOO87O8888D8DD888$O8OO8OI=.
+    =~O8OO87O88OIDDZ7Z=?D88DZN8D8OO8O88DD88DO88O8D8ODDZDD888DO+OZ8O8O88$=:.
+    .:OZO7OO88$D8Z+8~8ZD$88DDNO8$8ODO,OD8DODNOZO8D8DOOO88D8OO8888888Z8ZZO.
+     :Z7888DD88D8DODD$D~~,Z?OONDNI?ZDDDNDD8D8D+7Z~:DD8I8888888888DO88OOO$.
+     .~8O8D8O88D8ZO8Z$8Z:OZO$=88DDDDDDDDOOD8DDDDDNN~~,~DD88O88DD88OZ$O+,.
+       .=DDNNDD88O+ZDDI88OO,,88DDDDDNDDDNN?7Z:ZDNNDN7+$+Z?8888OZO$$,.~ .
+          .DND+7+,,I~~=7$:Z=IO=?Z$DONDDD88OZ.:?ZNNNNDDDD8888Z7=7+I+ ,
+            .+=,    .:=~:.II....Z8DD88DOOO:.,=+::+~8OD88OZ~=ZZ+.
+                          .I,/ZO?7O8OZD$$Z:$:       +I7+$\\7+8ZI.
+                           //~,.==7Z?$Z$=$             ~,$ \\~.
+                         /:    ~=.7Z?OO?$$,
+ .-+--$-?--?--..++::=~,          +7I7ZO7I7$,
+,,. .,:,,=~+..??.:I?,.?+-,,-.,,../7I7ZO7I7$.,,,,..,,,..=.+~..7:7,.7.,-~.+,
+                              ../7Z+=ZZ077Z$~,,..,.,,.  ,:,???+?+.:+.,.+.=I=.=:.
+                                   ....   .    ..  .
+

data/lib/yew.rb

@@ -1,24 +1,43 @@
 require 'yaml'
 
 module Yew
+
+  # Creates an object tree based on a given list of yml files.
+  #
+  # @param [*String] Yaml source files
+  #
+  # @return [Yew::Tree]
   def self.load(*yml_files)
     env_hash = yml_files.inject({}) do |memo, yml|
-      memo.merge! YAML.load(File.read(yml))
+      memo.merge!(YAML.load(File.read(yml)))
     end
 
     Tree.new(env_hash)
   end
 
+  # The object tree. Allows root-to-leave navigation in the form of ordinary method calls.
   class Tree < BasicObject
+
+    # @param [Hash] env
+    # @param root Tree's root. Used for notifying a not found entry at an exact path point.
     def initialize(env, root = nil)
       @env = env
       @root = root
     end
 
+    # Fetches a branch or leaf.
+    #
+    # If no key is received, returns the underlying Hash.
+    #
+    # @param key Node's name.
+    #
+    # @return [Yew::Tree] When the request node is still a tree.
+    # @return [Hash] Underlying Hash.
+    # @return [Object] When the requested node is a leaf.
     def [](*key)
       if key.any?
         key = key.first
-        Utils.fetch_as_tree(key, @env, @root)
+        Utils.fetch(key, @env, @root)
 
       else
         @env
@@ -26,9 +45,10 @@ module Yew
     end
 
     def method_missing(m, *attrs, &block)
-      Utils.fetch_as_tree(m, @env, @root)
+      Utils.fetch(m, @env, @root)
     end
 
+    # Define methods for printing inspection.
     if $YEW_DEBUG
       def inspect
         "<Envy::Env:#{__id__} -> #@env>"
@@ -41,12 +61,15 @@ module Yew
   end
 
   module Utils
-    def self.fetch_as_tree(key, env, root)
-      value = env.fetch(key) do
-        env.fetch(key.to_s) do
-          raise "Attribute #{key} not found at /#{root}"
-        end
-      end
+
+    # Fetches the key's value.
+    #
+    # Returns a tree if the value is a hash. Otherwise it returns the raw value.
+    #
+    # @return [Yew::Tree]
+    # @return [Object]
+    def self.fetch(key, env, root)
+      value = raw_fetch(key, env, root)
 
       if value.is_a?(Hash)
         path = key
@@ -57,5 +80,16 @@ module Yew
         value
       end
     end
+
+    # Fetches a value from the env.
+    #
+    # @raise [RuntimeError] When key not found.
+    def self.raw_fetch(key, env, root)
+      env.fetch(key) do
+        env.fetch(key.to_s) do
+          raise "Attribute #{key} not found at /#{root}"
+        end
+      end
+    end
   end
 end

data/test/test_yew_tree.rb

@@ -70,7 +70,7 @@ class TestYew < Test::Unit::TestCase
 
     begin
       @tree.orientdb.timeout
-    rescue StandardError => e; end
+    rescue RuntimeError => e; end
 
     assert_match(/timeout not found at \/orientdb/, e.message)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yew
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Gianfranco Zas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies: []
 description: Reads from .yml files and provides an object for key traversing.
 email: snmgian@gmail.com