activejson 0.1.0 → 0.1.1

data/README.md

@@ -8,7 +8,7 @@ Uses yajl to encode the JSON to text for extra speed.
 
 ##Installation
 
-Installation is easy, just add `gem activejson` to your Gemfile and let bundle do the rest.  Alternatively `gem install activejson` will install the gem globally on your system.
+Installation is easy, just add `gem "activejson"` to your Gemfile and let bundle do the rest.  Alternatively `gem install activejson` will install the gem globally on your system.
 
 ##Example
 
@@ -37,7 +37,7 @@ And, assuming your `@user` object has a name, an age and an array of pets, this
                           name : "frank",
                           age : { 
                                   human_years : 14,
-                                  animal_years 2 
+                                  animal_years : 2 
                                 }
                         },
                         {
@@ -52,3 +52,48 @@ And, assuming your `@user` object has a name, an age and an array of pets, this
     }
 
 ...except not-pretty printed (for speed).
+
+##Usage
+
+###Introduction
+
+In its simplest use case, ActiveJSON allows the view code to create JSON labels using (almost) any name, just by calling the label name as a method on an ActiveJSON object.
+
+All data that you want to be added to your JSON should be added to the top-level `json` object, which is created for you by the ActiveJSON framework when the view code is run.
+
+For example, to give a name and a date, use the following:
+
+    json.name "Steve"
+    json.date "12 Oct 2011"
+
+This is sufficient for simple, flat JSON data blocks but will never create arrays or JSON objects within other objects.
+
+###Sub-Objects
+
+To mark a JSON label as being a JSON object, any function called on an ActiveJSON object can be called with a block, taking one parameter.  Within the block, the parameter can be used to add labels to the JSON sub-object.
+
+For example:
+
+    json.object do |obj|
+      obj.name "Widget 1"
+      obj.flavour "Lemon"
+    end
+    json.title "Objects"
+
+Will render:
+
+    { object : { name : "Widget 1", flavour : "Lemon" }, title : "Objects" }
+
+###Arrays
+
+To mark a JSON label as containing an array, pass any object that responds to `map` as an argument to the label's function and supply a block taking two parameters, the first of which will be the ActiveJSON object for the array element and the second of which will be the corresponding element from the argument.
+
+For example, if `@users` contains Steve and Phil, then:
+
+    json.users(@users) do |user_j, user|
+      user_j.name user.name
+    end
+
+Will render to:
+
+    { users : [ { name : "Steve" }, { name : "Phil" } ] }

data/lib/activejson/activejson_core.rb

@@ -6,7 +6,6 @@ MultiJson.engine = :yajl
 module ActiveJson
   class Core
     instance_methods.each {|m| undef_method(m) unless %w(__id__ __send__ to_json instance_eval nil? is_a? class).include?(m.to_s)}
-    attr_accessor :hash
 
     def initialize()
       @hash = {}

data/lib/activejson/version.rb

@@ -1,3 +1,3 @@
 module Activejson
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activejson
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Andy Caldwell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-23 00:00:00 Z
+date: 2011-09-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json