yew 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2Q2Y2RiZDkxMjg2YTJlNzZhZjJlMzBmMTc0M2NlMTkxODkxZGRlZg==
+    YmM3YzFiOTNmYTAxYzFjODViNTIzOWJmYjlmMjUwOTJmMDNhYWE0Mg==
   data.tar.gz: !binary |-
-    YjMzMWI5MWU0NzAzODYyZmY1ZWZjNDhmZTg3YTAzYjc3Mzk4Y2RmYQ==
+    YTE0MWJlNjQzMTNhYjU2NjE2ZmFiMzEzM2M5Zjc5Zjc3MDM2MzI2Ng==
 SHA512:
   metadata.gz: !binary |-
-    ODA1NWRmZmJiMmYzZTJhNWQzNWUyMzgzOTA1YTQ3MmUzYWI5MGM1MWJkMDU3
-    NjljZDQzZjlkMmNlZjgwYzUyZDQ2ZWYyNzVkNjFhN2UxM2MwMTQ5NzI3MTdi
-    NTExYzYxODFiNjY1Yjk1Mjc4MTgwM2NlZDdlZDJlN2I0MGViMjA=
+    MGI5OWFjZGQyZWU5ZTcwM2M0ZTBhNzViMDk2ODZiOTNjNzIzNDAzNTg0YTMw
+    NzBhN2I2ODE0MjVkZjNmMjFlZmU1Y2M5MGQ0MmRhZjYwMzdjNjQ3YjRkMTg5
+    OGM1OGEwY2E2MzZhNjM2NjhlOTRhZjcyNGJmNTRmMTM4NWVjODc=
   data.tar.gz: !binary |-
-    OThhNjNhMzZhNjNkNDFkZGIzZTliNTgwZTAzMDQ3MWJiYjBkOWJjYjcxOTRi
-    OTliMWYzZWRkNjUzOGI2NWI1OWE5YjhmMTg5MTIzMWQ2NDg3MmNlODZmNmJl
-    YzM2NzIxMzQwOTEzOWNmOTE0ZjM4NzU4Zjk4YmY1MGQzODA2ODg=
+    NTBmZGY1NTY2YzU0ZjRiMTI3OGZkMzBkNjU2NWY4MTFkOGZhNzgyNmI3NTgx
+    N2RjMmQzYjJmNjNhZWE3YjZlMGJmMDMwNTk0ZDAyOTAyZTcxOTI1MjVkNDc4
+    Y2EzNjQ2MTIwMmY3MzQ4YjVlZTNiMzg5NTBhYmRhYjc2YWMzN2I=

data/README.md

@@ -1,9 +1,93 @@
-$YEW_DEBUG = true
-require 'yew'
-
-Env = Yew.load('config/env.yml')
-Env[]
-Env.orientdb[]
-Env.orientdb.url
-Env['orientdb']
-Env['orientdb'].url
+# Yew
+
+Yew allows traversing a Hash structure as if it is an object tree.
+
+
+## Usage
+
+Given the following yml file located at `config/env.yml`:
+
+  ``` yaml
+  orientdb:
+    url: 'remote:localhost/db'
+    user: admin
+    pass: secret
+
+  testing:
+    frameworks:
+      rspec:  true
+      minitest: false
+  ```
+
+
+ - Load the YAML structure.
+
+    ``` ruby
+    Env = Yew.load('config/env.yml')
+    ```
+
+
+ - Traverse the structure contents.
+
+    ``` ruby
+    Env.orientdb.user
+    # => 'admin'
+    ```
+
+ - Obtain the underlying Hash.
+
+    ``` ruby
+    Env.testing.frameworks[]
+    # => {"rspec"=>true, "minitest"=>false}
+    ```
+
+
+ - A tree can also be traversed like a normal Hash.
+
+    ``` ruby
+    Env['orientdb']['user']
+    # => 'admin'
+
+    Env['orientdb'].user
+    # => 'admin'
+    ```
+
+
+ - It raises well formed errors when accessing inexistent paths.
+
+    ``` ruby
+    Env['orientdb'].timeout
+    # => RuntimeError: Attribute timeout not found at /orientdb
+    ```
+
+
+ - Set `$YEW_DEBUG` when need to inspect `Yew::Tree` objects under irb.
+
+
+    ``` ruby
+    irb> $YEW_DEBUG = true
+    irb> require 'yew'
+    ```
+
+## Installation
+
+There are two options for installation: packaged gem and source file.
+
+ 1. Install Yew as a gem.
+
+    ``` shell
+    gem install yew
+    ```
+
+
+ 2. Download raw lib into a project source tree.
+
+    ``` shell
+    curl "https://raw.github.com/snmgian/yew/master/lib/yew.rb" 2>/dev/null -o "yew.rb"
+    ```
+
+## License
+
+This software is licensed under the [LGPL][lgpl] license.
+
+[lgpl]: https://www.gnu.org/licenses/lgpl.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yew
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gianfranco Zas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-12 00:00:00.000000000 Z
 dependencies: []
 description: Reads from .yml files and provides an object for key traversing.
 email: snmgian@gmail.com
@@ -20,8 +20,9 @@ files:
 - COPYING
 - COPYING.LESSER
 - README.md
-homepage: http://rubygems.org/gems/yew
-licenses: []
+homepage: https://github.com/snmgian/yew
+licenses:
+- LGPL
 metadata: {}
 post_install_message: 
 rdoc_options: []