jsondoc 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a67112a09bdcadf7b01a4da9f764afcc2b997718
-  data.tar.gz: c16488cb845e829d9d40b1bce7ebc7ee136219dc
+  metadata.gz: d9ae715ba08f04872418899fac3fa5d7b3a23b36
+  data.tar.gz: 6ef1bef9564fb2a12691cd6c9505371b340d8f8b
 SHA512:
-  metadata.gz: 8f81b7d01dd4ae7d0b9eb27913fcd726ef1ed09b1283673dccda60858a348e5caa60fdee3cb9a960f6cda8755f4f47246f31b84815d76399986b721111f2cb67
-  data.tar.gz: 5a6fef198638b13bfedceb507f33459aed78353179763f928f171be7429358f8625b058d03a08d5ea11ca9ac6a6ca868d35569cd48b4b11af8647dcce64da8a2
+  metadata.gz: 979581a45e0904ceb0470926aa791a13ae4d0f35c92d1f4031e8219d7f46f2fe207b07b99dcff2fbb21ed7cc5a7342d2a6ca8da13d64df43d50b930eaf5f3789
+  data.tar.gz: 2f3e6c4c0a8d8bfee3f5d25264b91a6b8be8a7263472fa583bf622f24f116d76901256b60254ca9eab1baa5fd8c93af1ecfe33c130152b7c24dd6c865c96bfd6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 CHANGELOG
 ---------
+- **2014-08-14**: 0.1.0
+  - Support retrieval of properties from nested objects using period delmiter
+
+- **2014-06-05**: 0.0.6
+  - Return self from loadHash()
+
+- **2014-04-17**: 0.0.5
+
 - **2014-03-16**: 0.0.4
   - Changed Attr methods to Prop methods to represent JSON schema property
   - Added Attr methods as aliases

data/README.md

@@ -0,0 +1,98 @@
+JsonDoc
+=======
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+Generic JSON document base class to set/get document attributes based on JSON Schema, dump as JSON and support building of CSV and Excel workbooks. Subclasses can be built with additional functionality, e.g. using the setAttr method. Primary use cases include being used with parsers to create JSON documents and to create CSV/Excel reports.
+
+## Installation
+
+### Gem Installation
+
+Download and install jsondoc with the following:
+
+```sh
+$ gem install jsondoc
+```
+
+## Usage
+
+```ruby
+require 'jsondoc'
+
+mySchema      =  {
+  :type       => 'My Document Type',
+  :properties => {
+    :first_name      => { :type => 'string', :description => 'First Name', :default => '' },
+    :last_name       => { :type => 'string', :description => 'Last Name',  :default => '' },
+    :email_addresses => { :type => 'array' , :description => 'Email Addresses', :default => [] }
+  }
+}
+
+thisUser = JsonDoc::Document.new( mySchema )
+thisUser.setAttr( :first_name, 'John' )
+thisUser.setAttr( :last_name,  'Doe'  )
+
+first_name = thisUser.getAttr( :first_name )
+
+thisUserHash = thisUser.asHash
+thisUserJson = thisUser.asJson
+
+descs  = thisUser.getDescArrayForProperties( [:first_name,:last_name] )
+values = thisUser.getValArrayForProperties(  [:first_name,:last_name] )
+
+thisUser.pushAttr( :email_addresses, 'john@example.com' )
+thisUser.pushAttr( :email_addresses, 'john.doe@example.com' )
+
+thisUser.cpAttr( :first_name, :last_name )
+```
+
+## Notes
+
+### Schema Validation
+
+Schema validation is not provided in this version.
+
+## Links
+
+1. JSON
+  * http://www.json.org/
+2. JSON Schema
+  * http://json-schema.org/
+
+### Problems, Comments, Suggestions?
+
+All of the above are most welcome. mailto:johncwang@gmail.com
+
+## Credits
+
+John Wang - http://johnwang.com
+
+## License
+
+JsonDoc is available under an MIT-style license.
+
+:include: MIT-LICENSE 
+
+## Warranty
+
+This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.
+
+ [gem-version-svg]: https://badge.fury.io/rb/jsondoc.svg
+ [gem-version-link]: http://badge.fury.io/rb/jsondoc
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/jsondoc
+ [downloads-link]: https://rubygems.org/gems/jsondoc
+ [dependency-status-svg]: https://gemnasium.com/grokify/jsondoc-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/jsondoc-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/jsondoc-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/jsondoc-ruby/?branch=master
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/jsondoc/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/jsondoc-ruby/blob/master/LICENSE.txt
+

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/jsondoc.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'jsondoc'
-  s.version     = '0.0.4'
-  s.date        = '2014-03-16'
+  s.version     = '0.1.0'
+  s.date        = '2014-08-14'
   s.summary     = 'JsonDoc'
   s.description = 'A base document object'
   s.authors     = ['John Wang']
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.files       = [
     'CHANGELOG.md',
     'LICENSE',
-    'README.rdoc',
+    'README.md',
     'Rakefile',
     'VERSION',
     'jsondoc.gemspec',
@@ -19,4 +19,4 @@ Gem::Specification.new do |s|
   ]
   s.homepage    = 'http://johnwang.com/'
   s.license     = 'MIT'
-end
+end

data/lib/jsondoc/document.rb

@@ -1,16 +1,24 @@
 require 'json'
 
+class Symbol
+  def split(separator)
+    to_s.split(separator).map(&:to_sym)
+  end
+end
+
 module JsonDoc
   class Document
 
     attr_accessor :bIsStrict
+    attr_accessor :bUseKeyAsDesc
 
     def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true)
       @dSchema        = dSchema || self.getDefaultSchema()
       @bDefaultifyDoc = bDefaultifyDoc ? true : false
       @bIsStrict      = bIsStrict      ? true : false
+      @bUseKeyAsDesc  = false
       @dDocument      = self.getDefaultDocument()
-      self.loadInitialValues(dValues)
+      self.loadHash(dValues) if dValues.is_a?(Hash)
     end
 
     def getDefaultSchema()
@@ -35,7 +43,7 @@ module JsonDoc
       return dDocument
     end
 
-    def loadInitialValues(dValues=nil)
+    def loadHash(dValues=nil)
       if dValues.nil?
         return
       elsif ! dValues.is_a?(Hash)
@@ -44,9 +52,38 @@ module JsonDoc
       dValues.each do |yKey,xxVal|
         self.setProp(yKey,xxVal)
       end
+      return self
     end
 
     def getProp(yKey=nil)
+      if yKey.nil?
+        raise ArgumentError, 'E_BAD_KEY__IS_NIL'
+      end
+      yKey  = yKey.to_sym if yKey.kind_of?(String)
+      aKeys = yKey.split('.')
+      #aKeys = yKey.to_s.split('.').map(&:to_sym)
+
+      dDoc  = @dDocument
+      xxVal = getPropRecurse(aKeys.clone,dDoc)
+      return xxVal
+    end
+
+    def getPropRecurse(aKeys=[],dDoc=nil)
+      yKey = aKeys.shift
+      if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.has_key?( yKey )
+        return nil
+      end
+      xxVal = dDoc[ yKey ]
+      if aKeys.length == 0
+        return xxVal
+      elsif dDoc.is_a?(Hash)
+        return getPropRecurse( aKeys, xxVal )
+      else
+        raise ArgumentError, "E_BAD_VAL__IS_NOT_HASH"
+      end
+    end
+
+    def getPropSingle(yKey=nil)
       if yKey.nil?
         raise ArgumentError, 'E_BAD_KEY__IS_NIL'
       end
@@ -134,15 +171,22 @@ module JsonDoc
       return sVals
     end
 
-    def getValArrayForProperties(aCols=nil)
+    def getValArrayForProperties(aCols=nil,xxNil='')
       aVals = []
       return aVals if aCols.nil?
+
+      if @bUseKeyAsDesc
+        asVals = aCols.map {|x| x.to_s }
+      end
+
       aCols.each do |yKey|
 
-        yKey = yKey.to_sym if yKey.kind_of?(String)
-        xVal = @dDocument.has_key?(yKey) ? @dDocument[yKey] : nil
+        yKey  = yKey.to_sym if yKey.kind_of?(String)
+        xxVal = getProp( yKey )
+        #xVal = @dDocument.has_key?(yKey) ? @dDocument[yKey] : nil
+        xxVal = xxNil if xxVal.nil?
+        aVals.push( xxVal )
 
-        aVals.push( xVal )
       end
       return aVals
     end
@@ -160,8 +204,15 @@ module JsonDoc
       aCols.each do |yKey|
 
         yKey  = yKey.to_sym if yKey.kind_of?(String)
-        xxVal = ( @dSchema[:properties].has_key?(yKey) && @dSchema[:properties][yKey].has_key?(:description) && @dSchema[:properties][yKey][:description].length > 0 ) \
-              ? @dSchema[:properties][yKey][:description] : yKey.to_s
+        xxVal = (
+          @dSchema.has_key?(:properties)                          \
+          && @dSchema[:properties].has_key?(yKey)                 \
+          && @dSchema[:properties][yKey].has_key?(:description)   \
+          && @dSchema[:properties][yKey][:description].length > 0
+        ) \
+          ? @dSchema[:properties][yKey][:description] : yKey.to_s
+
+        xxVal = xxVal.to_s unless xxVal.is_a?(String)
 
         aVals.push( xxVal )
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsondoc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-08-14 00:00:00.000000000 Z
 dependencies: []
 description: A base document object
 email: john@johnwang.com
@@ -18,7 +18,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - jsondoc.gemspec
@@ -45,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: JsonDoc

data/README.rdoc

@@ -1,75 +0,0 @@
-= JsonDoc
-
-Generic JSON document base class to set/get document attributes based on JSON Schema, dump as JSON and support building of CSV and Excel workbooks. Subclasses can be built with additional functionality, e.g. using the setAttr method. Primary use cases include being used with parsers to create JSON documents and to create CSV/Excel reports.
-
-== Installation
-
-=== Gem Installation
-
-Download and install jsondoc with the following:
-
-  gem install jsondoc
-
-== Usage
-
-  require 'jsondoc'
-
-  mySchema      =  {
-    :type       => 'My Document Type',
-    :properties => {
-      :first_name      => { :type => 'string', :description => 'First Name', :default => '' },
-      :last_name       => { :type => 'string', :description => 'Last Name',  :default => '' },
-      :email_addresses => { :type => 'array' , :description => 'Email Addresses', :default => [] }
-    }
-  }
-
-  thisUser = JsonDoc::Document.new( mySchema )
-  thisUser.setAttr( :first_name, 'John' )
-  thisUser.setAttr( :last_name,  'Doe'  )
-
-  first_name = thisUser.getAttr( :first_name )
-
-  thisUserHash = thisUser.asHash
-  thisUserJson = thisUser.asJson
-
-  descs  = thisUser.getDescArrayForProperties( [:first_name,:last_name] )
-  values = thisUser.getValArrayForProperties(  [:first_name,:last_name] )
-
-  thisUser.pushAttr( :email_addresses, 'john@example.com' )
-  thisUser.pushAttr( :email_addresses, 'john.doe@example.com' )
-
-  thisUser.cpAttr( :first_name, :last_name )
-
-== Notes
-
-=== Schema Validation
-
-Schema validation is not provided in this version.
-
-== Links
-
-JSON
-
-http://www.json.org/
-
-JSON Schema
-
-http://json-schema.org/
-
-== Problems, Comments, Suggestions?
-
-All of the above are most welcome. mailto:johncwang@gmail.com
-
-== Credits
-
-John Wang - http://johnwang.com
-
-== License
-
-JsonDoc is available under an MIT-style license.
-
-:include: MIT-LICENSE 
-
-== Warranty
-
-This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.