jsondoc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9ae715ba08f04872418899fac3fa5d7b3a23b36
-  data.tar.gz: 6ef1bef9564fb2a12691cd6c9505371b340d8f8b
+  metadata.gz: 83ebca74e6671c4cdfeba514cd26772c8d881486
+  data.tar.gz: 28a88d4a291196859188f5625bf0808b28d1046c
 SHA512:
-  metadata.gz: 979581a45e0904ceb0470926aa791a13ae4d0f35c92d1f4031e8219d7f46f2fe207b07b99dcff2fbb21ed7cc5a7342d2a6ca8da13d64df43d50b930eaf5f3789
-  data.tar.gz: 2f3e6c4c0a8d8bfee3f5d25264b91a6b8be8a7263472fa583bf622f24f116d76901256b60254ca9eab1baa5fd8c93af1ecfe33c130152b7c24dd6c865c96bfd6
+  metadata.gz: c38b03a3c8882a8676d8f9d54f7609d26aa314d27ca36cd1a59b55217d5d52c0ad2479140e0df3b36a4e437ee95469d45a9fcfaeb0086d9a462b80c32f477a0c
+  data.tar.gz: 9c157d451a958e6beec2e835c416869e9cba7c34f28515ed004ad4555ebd54a33901117bba67f59249797eb434e1b938d832b22d8e496ed16096f0f841c86fbc

data/{LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 John Wang
+Copyright (c) 2014-2016 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -2,19 +2,29 @@ JsonDoc
 =======
 
 [![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
 [![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-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.
+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
+### Via Bundler
 
-Download and install jsondoc with the following:
+Add `jsondoc` to `Gemfile` and then run `bundle`:
+
+```sh
+$ echo "gem 'jsondoc'" >> Gemfile
+$ bundle
+```
+
+### Via RubyGems
 
 ```sh
 $ gem install jsondoc
@@ -25,20 +35,22 @@ $ gem install jsondoc
 ```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 => [] }
+my_data = {}
+
+my_schema = {
+  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'  )
+thisUser = JsonDoc::Document.new(my_data, my_schema)
+thisUser.setAttr(:first_name, 'John')
+thisUser.setAttr(:last_name,  'Doe')
 
-first_name = thisUser.getAttr( :first_name )
+first_name = thisUser.getAttr(:first_name)
 
 thisUserHash = thisUser.asHash
 thisUserJson = thisUser.asJson
@@ -46,10 +58,10 @@ 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.pushAttr(:email_addresses, 'john@example.com')
+thisUser.pushAttr(:email_addresses, 'john.doe@example.com')
 
-thisUser.cpAttr( :first_name, :last_name )
+thisUser.cpAttr(:first_name, :last_name)
 ```
 
 ## Notes
@@ -65,34 +77,27 @@ Schema validation is not provided in this version.
 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 
+JsonDoc is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.
 
-## 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.
+JsonDoc © 2014-2016 by John Wang
 
  [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
+ [build-status-svg]: https://api.travis-ci.org/grokify/jsondoc-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/jsondoc-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/jsondoc-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/jsondoc-ruby?branch=master
  [dependency-status-svg]: https://gemnasium.com/grokify/jsondoc-ruby.svg
  [dependency-status-link]: https://gemnasium.com/grokify/jsondoc-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/jsondoc-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/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
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/jsondoc
+ [downloads-link]: https://rubygems.org/gems/jsondoc
  [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/Rakefile

@@ -1,22 +1,19 @@
 require 'rake'
 require 'rake/testtask'
-require 'rdoc/task'
 
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the JsonDoc library.'
+desc 'Test the library.'
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.pattern = 'test/**/test_*.rb'
   t.verbose = false
 end
 
-desc 'Generate RDoc documentation.'
-RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'jsondoc'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc 'Generate YARD documentation.'
+task :gendoc do
+  #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+    system "yardoc"
+    system "yard stats --list-undoc"
 end

data/jsondoc.gemspec

@@ -1,22 +1,26 @@
+lib = 'jsondoc'
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+
 Gem::Specification.new do |s|
   s.name        = 'jsondoc'
-  s.version     = '0.1.0'
-  s.date        = '2014-08-14'
+  s.version     = version
+  s.date        = '2016-02-04'
   s.summary     = 'JsonDoc'
   s.description = 'A base document object'
   s.authors     = ['John Wang']
-  s.email       = 'john@johnwang.com'
+  s.email       = 'johncwang@gmail.com'
+  s.homepage    = 'https://github.com/grokify/'
+  s.licenses    = ['MIT']
   s.files       = [
     'CHANGELOG.md',
-    'LICENSE',
+    'LICENSE.txt',
     'README.md',
     'Rakefile',
-    'VERSION',
     'jsondoc.gemspec',
     'lib/jsondoc.rb',
     'lib/jsondoc/document.rb',
     'test/test_setup.rb'
-  ]
-  s.homepage    = 'http://johnwang.com/'
-  s.license     = 'MIT'
+  ] 
 end

data/lib/jsondoc.rb

@@ -1,3 +1,5 @@
 module JsonDoc
+  VERSION = '0.1.1'
+
   autoload :Document, 'jsondoc/document'
 end

data/lib/jsondoc/document.rb

@@ -8,15 +8,18 @@ end
 
 module JsonDoc
   class Document
+    attr_reader :dDocument
 
     attr_accessor :bIsStrict
     attr_accessor :bUseKeyAsDesc
+    attr_accessor :bUseDeepKeys
 
-    def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true)
+    def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true,opts={})
       @dSchema        = dSchema || self.getDefaultSchema()
       @bDefaultifyDoc = bDefaultifyDoc ? true : false
       @bIsStrict      = bIsStrict      ? true : false
       @bUseKeyAsDesc  = false
+      @bUseDeepKeys   = opts.key?(:bUseDeepKeys) ? opts[:bUseDeepKeys] : true
       @dDocument      = self.getDefaultDocument()
       self.loadHash(dValues) if dValues.is_a?(Hash)
     end
@@ -33,10 +36,10 @@ module JsonDoc
 
     def getDefaultDocument()
       dDocument = {}
-      if @bDefaultifyDoc && @dSchema.has_key?(:properties)
+      if @bDefaultifyDoc && @dSchema.key?(:properties)
         @dSchema[:properties].keys.each do |yKey|
           dProperty = @dSchema[:properties][yKey]
-          xxVal     = dProperty.has_key?(:default) ? dProperty[:default] : ''
+          xxVal     = dProperty.key?(:default) ? dProperty[:default] : ''
           dDocument[yKey] = xxVal
         end
       end
@@ -60,17 +63,21 @@ module JsonDoc
         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
+      if @bUseDeepKeys
+        aKeys = yKey.split('.')
+        #aKeys = yKey.to_s.split('.').map(&:to_sym)
+
+        dDoc  = @dDocument
+        xxVal = getPropRecurse(aKeys.clone,dDoc)
+        return xxVal
+      end
+      return @dDocument.key?(yKey) ? @dDocument[yKey] : nil
     end
 
     def getPropRecurse(aKeys=[],dDoc=nil)
       yKey = aKeys.shift
-      if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.has_key?( yKey )
+      if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.key?( yKey )
         return nil
       end
       xxVal = dDoc[ yKey ]
@@ -88,7 +95,7 @@ module JsonDoc
         raise ArgumentError, 'E_BAD_KEY__IS_NIL'
       end
       yKey  = yKey.to_sym if yKey.kind_of?(String)
-      xxVal = @dDocument.has_key?(yKey) ? @dDocument[yKey] : nil
+      xxVal = @dDocument.key?(yKey) ? @dDocument[yKey] : nil
       if xxVal.nil? && @bIsStrict
         self.validateKey(yKey)
       end
@@ -102,7 +109,7 @@ module JsonDoc
 
       return true unless @bIsStrict
 
-      bKeyExists = @dSchema.has_key?(:properties) && @dSchema[:properties].has_key?(yKey) ? true : false
+      bKeyExists = @dSchema.key?(:properties) && @dSchema[:properties].key?(yKey) ? true : false
 
       unless bKeyExists
         raise ArgumentError, "E_UNKNOWN_KEY__STRICT #{yKey.to_s}"
@@ -124,7 +131,7 @@ module JsonDoc
 
       self.validateKey(yKey)
 
-      if @dDocument.has_key?(yKey)
+      if @dDocument.key?(yKey)
         if @dDocument[yKey].kind_of?(Array)
           @dDocument[yKey].push(xxVal)
         else
@@ -183,7 +190,7 @@ module JsonDoc
 
         yKey  = yKey.to_sym if yKey.kind_of?(String)
         xxVal = getProp( yKey )
-        #xVal = @dDocument.has_key?(yKey) ? @dDocument[yKey] : nil
+        #xVal = @dDocument.key?(yKey) ? @dDocument[yKey] : nil
         xxVal = xxNil if xxVal.nil?
         aVals.push( xxVal )
 
@@ -205,9 +212,9 @@ module JsonDoc
 
         yKey  = yKey.to_sym if yKey.kind_of?(String)
         xxVal = (
-          @dSchema.has_key?(:properties)                          \
-          && @dSchema[:properties].has_key?(yKey)                 \
-          && @dSchema[:properties][yKey].has_key?(:description)   \
+          @dSchema.key?(:properties)                          \
+          && @dSchema[:properties].key?(yKey)                 \
+          && @dSchema[:properties][yKey].key?(:description)   \
           && @dSchema[:properties][yKey][:description].length > 0
         ) \
           ? @dSchema[:properties][yKey][:description] : yKey.to_s
@@ -223,6 +230,5 @@ module JsonDoc
     alias_method :getAttr , :getProp
     alias_method :pushAttr, :pushProp
     alias_method :cpAttr  , :cpProp
-
   end
 end

data/test/test_setup.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'jsondoc'
+require './test/test_base.rb'
 
 class JsonDocTest < Test::Unit::TestCase
   def testSetup
@@ -14,7 +13,7 @@ class JsonDocTest < Test::Unit::TestCase
       }
     }
 
-    jDoc = JsonDoc::Document.new(schemaTest,true,true)
+    jDoc = JsonDoc::Document.new({},schemaTest,true,true)
 
     assert_equal 'abc'          , jDoc.getAttr(:id)
     assert_equal "abc\tbar"     , jDoc.getValStringForProperties([:id,:foo])
@@ -41,4 +40,22 @@ class JsonDocTest < Test::Unit::TestCase
     assert_equal jDoc.getAttr(:id), jDoc.getAttr(:foo)
 
   end
-end
+
+  def testNested()
+    data = {
+      foo: {
+        bar: { baz: 10 }
+      }
+    }
+    doc = JsonDoc::Document.new(data,{},false,false)
+    assert_equal 10, doc.getAttr('foo.bar.baz')
+  end
+
+  def testNotNested()
+    doc2 = JsonDoc::Document.new({},{},false,false)
+    doc2.bUseDeepKeys = false
+    doc2.setAttr('foo.bar.baz', 'deadbeef')
+
+    assert_equal 'deadbeef', doc2.dDocument[:'foo.bar.baz']
+  end
+end

metadata

@@ -1,31 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: jsondoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies: []
 description: A base document object
-email: john@johnwang.com
+email: johncwang@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - jsondoc.gemspec
 - lib/jsondoc.rb
 - lib/jsondoc/document.rb
 - test/test_setup.rb
-homepage: http://johnwang.com/
+homepage: https://github.com/grokify/
 licenses:
 - MIT
 metadata: {}

data/VERSION

@@ -1 +0,0 @@
-0.1.0