jsondoc 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f86e271afdb795782a2b537a51ec4328ce9ebf8
-  data.tar.gz: f07965f57bcc460746c469cf7fefc61f8644afd4
+  metadata.gz: 2c654bdf353b981573a429df4c118bd4fd063e94
+  data.tar.gz: bd60cca64677d5810f68975d39de4a65c460cb1e
 SHA512:
-  metadata.gz: d2bee4d62b7e41ccebeb823b57c0dc09d1663a8ecbae8618b9c85199e036f05b45f386cdb14ce8841afcd6cadc35a95a00cd5ffaf69a096a16b5464e232be320
-  data.tar.gz: d83d68b2c3ff8c19aa94c55ea8ae3f87976aa40c27c6acc11bec872cc91483b68a641692971678a191f5c2bbbc08fdd04d0227037b1b9276ce94ce11e780a6b4
+  metadata.gz: e04c5cbde046644d5787950015328a5632fd3c56351ea74fb53a8192bf692439c952b371c4103d9da488d86d430bc33f020869d559adb2aca558eb9a11cb3132
+  data.tar.gz: e041d19abc0ca4c18d18aedba3e9e9a9b6be21a4204275537c2c7657264e48755037944bbe574291c7011d321afe3eaca446a7094c0ad7472bd469534795329f

data/CHANGELOG.md

@@ -1,26 +1,28 @@
 CHANGELOG
 ---------
+- **2016-08-23**: 0.1.3
+  - Remove hard coded `require 'json'`
+- **2016-02-05**: 0.1.2
+  - Add missing test file
+- **2016-02-04**: 0.1.1
+  - Add initialize opts hash
+  - Add `attr_reader :dDocument`
+  - Add `bUseDeepKeys` to make deep key splitting optional
 - **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()
-
+  - 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
   - Added ability to load initial values hash
   - Added key validation for #getProp() in strict mode
-  - Added attr_accessor for bIsStrict
+  - Added `attr_accessor :bIsStrict`
   - #push(Prop\Attr) will now only act on arrays
-
 - **2014-02-12**: 0.0.3
   - Added cpAttr() method
-
 - **2014-01-31**: 0.0.2
-  - README bugfix
-
+  - `README` bugfix
 - **2014-01-28**: 0.0.1
-  - Initial release
+  - Initial release

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake'
 require 'rake/testtask'
 
 desc 'Default: run unit tests.'
-task :default => :test
+task default: :test
 
 desc 'Test the library.'
 Rake::TestTask.new do |t|
@@ -13,7 +13,8 @@ end
 
 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
+  # 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/lib/jsondoc.rb

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

data/lib/jsondoc/document.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 class Symbol
   def split(separator)
     to_s.split(separator).map(&:to_sym)
@@ -17,36 +15,35 @@ module JsonDoc
     def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true,opts={})
       @dSchema        = dSchema || self.getDefaultSchema()
       @bDefaultifyDoc = bDefaultifyDoc ? true : false
-      @bIsStrict      = bIsStrict      ? 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
 
-    def getDefaultSchema()
-      dSchema       =  {
-        :type       => '',
-        :properties => {
-          :id       => { :default => '', :description => 'Doc Id', :type => 'string' }
+    def getDefaultSchema
+      {
+        type: '',
+        properties: {
+          id: {default: '', description: 'Doc Id', type: 'string'}
         }
       }
-      return dSchema
     end
 
-    def getDefaultDocument()
+    def getDefaultDocument
       dDocument = {}
       if @bDefaultifyDoc && @dSchema.key?(:properties)
         @dSchema[:properties].keys.each do |yKey|
           dProperty = @dSchema[:properties][yKey]
-          xxVal     = dProperty.key?(:default) ? dProperty[:default] : ''
+          xxVal = dProperty.key?(:default) ? dProperty[:default] : ''
           dDocument[yKey] = xxVal
         end
       end
-      return dDocument
+      dDocument
     end
 
-    def loadHash(dValues=nil)
+    def loadHash(dValues = nil)
       if dValues.nil?
         return
       elsif ! dValues.is_a?(Hash)
@@ -55,18 +52,16 @@ module JsonDoc
       dValues.each do |yKey,xxVal|
         self.setProp(yKey,xxVal)
       end
-      return self
+      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)
+    def getProp(yKey = nil)
+      raise ArgumentError, 'E_BAD_KEY__IS_NIL' if yKey.nil?
+
+      yKey = yKey.to_sym if yKey.is_a?(String)
 
       if @bUseDeepKeys
-        aKeys = yKey.split('.')
-        #aKeys = yKey.to_s.split('.').map(&:to_sym)
+        aKeys = yKey.split('.') # = yKey.to_s.split('.').map(&:to_sym)
 
         dDoc  = @dDocument
         xxVal = getPropRecurse(aKeys.clone,dDoc)
@@ -75,7 +70,7 @@ module JsonDoc
       return @dDocument.key?(yKey) ? @dDocument[yKey] : nil
     end
 
-    def getPropRecurse(aKeys=[],dDoc=nil)
+    def getPropRecurse(aKeys = [], dDoc = nil)
       yKey = aKeys.shift
       if ! yKey.is_a?(Symbol) || yKey.length<1 || ! dDoc.key?( yKey )
         return nil
@@ -90,50 +85,44 @@ module JsonDoc
       end
     end
 
-    def getPropSingle(yKey=nil)
-      if yKey.nil?
-        raise ArgumentError, 'E_BAD_KEY__IS_NIL'
-      end
-      yKey  = yKey.to_sym if yKey.kind_of?(String)
+    def getPropSingle(yKey = nil)
+      raise ArgumentError, 'E_BAD_KEY__IS_NIL' if yKey.nil?
+      yKey = yKey.to_sym if yKey.is_a?(String)
       xxVal = @dDocument.key?(yKey) ? @dDocument[yKey] : nil
       if xxVal.nil? && @bIsStrict
         self.validateKey(yKey)
       end
-      return xxVal
+      xxVal
     end
 
-    def validateKey(yKey=nil)
-      if yKey.nil?
-        raise ArgumentError, "E_BAD_KEY__IS_NIL [#{yKey.to_s}]"
-      end
+    def validateKey(yKey = nil)
+      raise ArgumentError, "E_BAD_KEY__IS_NIL [#{yKey.to_s}]" if yKey.nil?
 
       return true unless @bIsStrict
 
-      bKeyExists = @dSchema.key?(:properties) && @dSchema[:properties].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}"
-      end
+      raise ArgumentError, "E_UNKNOWN_KEY__STRICT #{yKey.to_s}" unless bKeyExists
 
       return true
     end
 
-    def setProp(yKey=nil,xxVal=nil)
-      yKey = yKey.to_sym if yKey.kind_of?(String)
+    def setProp(yKey = nil, xxVal = nil)
+      yKey = yKey.to_sym if yKey.is_a?(String)
 
       self.validateKey(yKey)
 
       @dDocument[yKey] = xxVal
     end
 
-    def pushProp(yKey=nil,xxVal=nil)
-      yKey = yKey.to_sym if yKey.kind_of?(String)
-
+    def pushProp(yKey = nil, xxVal = nil)
+      yKey = yKey.to_sym if yKey.is_a?(String)
       self.validateKey(yKey)
 
       if @dDocument.key?(yKey)
-        if @dDocument[yKey].kind_of?(Array)
-          @dDocument[yKey].push(xxVal)
+        if @dDocument[yKey].is_a?(Array)
+          @dDocument[yKey].push xxVal
         else
           raise RuntimeError, 'E_PROPERTY_IS_NOT_ARRAY'
         end
@@ -142,43 +131,42 @@ module JsonDoc
       end
     end
 
-    def cpProp(yKeySrc=nil,yKeyDest=nil)
-      yKeySrc  = yKeySrc.to_sym  if yKeySrc.kind_of?(String)
-      yKeyDest = yKeyDest.to_sym if yKeyDest.kind_of?(String)
+    def cpProp(yKeySrc = nil, yKeyDest = nil)
+      yKeySrc = yKeySrc.to_sym if yKeySrc.is_a?(String)
+      yKeyDest = yKeyDest.to_sym if yKeyDest.is_a?(String)
       self.setAttr(yKeyDest, self.getAttr(yKeySrc))
     end
 
-    def sortKeys()
+    def sortKeys
       @dDocument.keys.sort!
     end
 
-    def fromJson(jDocument=nil)
-      if jDocument.kind_of?(String)
+    def fromJson(jDocument = nil)
+      if jDocument.is_a?(String)
         @dDocument = JSON.load(jDocument)
       end
       return self
     end
 
-    def fromDict(dDocument=nil)
+    def fromDict(dDocument = nil)
       @dDocument = dDocument if dDocument.is_a?(Hash)
     end
 
-    def asHash()
-      return @dDocument
+    def asHash
+      @dDocument
     end
 
-    def asJson()
-      return JSON.dump( self.asHash() )
+    def asJson
+      JSON.dump( self.asHash() )
     end
 
-    def getValStringForProperties(aCols=nil,sDelimiter="\t")
-      sDelimiter = "\t" unless sDelimiter.kind_of?(String) && sDelimiter.length>0
+    def getValStringForProperties(aCols = nil, sDelimiter = "\t")
+      sDelimiter = "\t" unless sDelimiter.is_a?(String) && sDelimiter.length>0
       aVals = self.getValArrayForProperties(aCols)
-      sVals = aVals.join(sDelimiter)
-      return sVals
+      return aVals.join(sDelimiter)
     end
 
-    def getValArrayForProperties(aCols=nil,xxNil='')
+    def getValArrayForProperties(aCols = nil, xxNil = '')
       aVals = []
       return aVals if aCols.nil?
 
@@ -187,30 +175,26 @@ module JsonDoc
       end
 
       aCols.each do |yKey|
-
-        yKey  = yKey.to_sym if yKey.kind_of?(String)
+        yKey  = yKey.to_sym if yKey.is_a? String
         xxVal = getProp( yKey )
         #xVal = @dDocument.key?(yKey) ? @dDocument[yKey] : nil
         xxVal = xxNil if xxVal.nil?
-        aVals.push( xxVal )
-
+        aVals.push xxVal
       end
-      return aVals
+      aVals
     end
 
-    def getDescStringForProperties(aCols=nil,sDelimiter="\t")
-      sDelimiter = "\t" unless sDelimiter.kind_of?(String) && sDelimiter.length>0
+    def getDescStringForProperties(aCols = nil,sDelimiter = "\t")
+      sDelimiter = "\t" unless sDelimiter.is_a?(String) && sDelimiter.length>0
       aVals = self.getDescArrayForProperties(aCols)
-      sVals = aVals.join(sDelimiter)
-      return sVals
+      aVals.join(sDelimiter)
     end
 
-    def getDescArrayForProperties(aCols=nil)
+    def getDescArrayForProperties(aCols = nil)
       aVals = []
       return aVals if aCols.nil?
       aCols.each do |yKey|
-
-        yKey  = yKey.to_sym if yKey.kind_of?(String)
+        yKey = yKey.to_sym if yKey.is_a? String
         xxVal = (
           @dSchema.key?(:properties)                          \
           && @dSchema[:properties].key?(yKey)                 \
@@ -219,11 +203,11 @@ module JsonDoc
         ) \
           ? @dSchema[:properties][yKey][:description] : yKey.to_s
 
-        xxVal = xxVal.to_s unless xxVal.is_a?(String)
+        xxVal = xxVal.to_s unless xxVal.is_a? String
 
-        aVals.push( xxVal )
+        aVals.push xxVal
       end
-      return aVals
+      aVals
     end
 
     alias_method :setAttr , :setProp
@@ -231,4 +215,4 @@ module JsonDoc
     alias_method :pushAttr, :pushProp
     alias_method :cpAttr  , :cpProp
   end
-end
+end

data/test/test_base.rb

@@ -4,4 +4,4 @@ Coveralls.wear!
 require 'test/unit'
 require 'jsondoc'
 
-doc = JsonDoc::Document.new({},{},true,true)
+JsonDoc::Document.new({},{},true,true)

data/test/test_setup.rb

@@ -3,13 +3,13 @@ require './test/test_base.rb'
 class JsonDocTest < Test::Unit::TestCase
   def testSetup
 
-    schemaTest    =  {
-      :type       => 'TestDocument',
-      :properties => {
-        :id       => { :default => 'abc',   :type => 'string', :description => 'Id'    },
-        :foo      => { :default => 'bar',   :type => 'string', :description => 'Foo'   },
-        :hello    => { :default => 'world', :type => 'string', :description => 'Hello' },
-        :array    => { :default => ['foo'], :type => 'array',  :description => 'Array' }
+    schemaTest =  {
+      type: 'TestDocument',
+      properties: {
+        id: { default: 'abc',   type: 'string', description: 'Id'    },
+        foo: { default: 'bar',   type: 'string', description: 'Foo'   },
+        hello: { default: 'world', type: 'string', description: 'Hello' },
+        array: { default: ['foo'], type: 'array',  description: 'Array' }
       }
     }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsondoc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies: []
 description: A base document object
 email: johncwang@gmail.com
@@ -45,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: JsonDoc