jsondoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d667ff1f9ee92a1c9423f8c3b53df0693b30c19
+  data.tar.gz: e43d87d1e0bcc58910994324eec90b83e6837318
+SHA512:
+  metadata.gz: d37da726b1e38bc70ed25faedb63a30de58ab92cffffdd38200f69fb8907d3d6e146a6cf1c51935854f1e427aa9bd9da2dfc92ccfe7da6f54ef6a9838f68413c
+  data.tar.gz: c07f374ba8c987565f4d707070b829173370c08ed18aafb50c62d892bb7211de51f817f2658082ef67cd23add042c65e53ae25065157dfecb0d1cd2a3ebe24ff

data/CHANGELOG

@@ -0,0 +1,2 @@
+= 0.0.1
+- Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,73 @@
+= 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 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.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' )
+
+== 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.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the JsonDoc 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')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/jsondoc.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'jsondoc'
+  s.version     = '0.0.1'
+  s.date        = '2014-01-28'
+  s.summary     = 'JsonDoc'
+  s.description = 'A base document object'
+  s.authors     = ['John Wang']
+  s.email       = 'john@johnwang.com'
+  s.files       = [
+    'CHANGELOG',
+    'MIT-LICENSE',
+    'README.rdoc',
+    '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

@@ -0,0 +1,3 @@
+module JsonDoc
+  autoload :Document, 'jsondoc/document'
+end

data/lib/jsondoc/document.rb

@@ -0,0 +1,140 @@
+require 'json'
+
+module JsonDoc
+  class Document
+
+    def initialize(dSchema=nil,bDefaultifyDoc=false,bIsStrict=true)
+      @dSchema        = dSchema || self.getDefaultSchema()
+      @bDefaultifyDoc = bDefaultifyDoc ? true : false
+      @bIsStrict      = bIsStrict      ? true : false
+      @dDocument      = self.getDefaultDocument()
+    end
+
+    def getDefaultSchema()
+      dSchema       =  {
+        :type       => '',
+        :properties => {
+          :id       => { :default => '', :description => 'Doc Id', :type => 'string' }
+        }
+      }
+      return dSchema
+    end
+
+    def getDefaultDocument()
+      dDocument = {}
+      if @bDefaultifyDoc && @dSchema.has_key?(:properties)
+        @dSchema[:properties].keys.each do |yKey|
+          dProperty = @dSchema[:properties][yKey]
+          xxVal     = dProperty.has_key?(:default) ? dProperty[:default] : ''
+          dDocument[yKey] = xxVal
+        end
+      end
+      return dDocument
+    end
+
+    def getAttr(yKey=nil)
+      yKey  = yKey.to_sym if yKey.kind_of?(String)
+      xxVal = @dDocument.has_key?(yKey) ? @dDocument[yKey] : nil
+      return xxVal
+    end
+
+    def validateKey(yKey=nil)
+      if yKey.nil?
+        raise ArgumentError, "E_BAD_KEY__IS_NIL [#{yKey.to_s}]"
+      end
+
+      bKeyExists = @dSchema.has_key?(:properties) && @dSchema[:properties].has_key?(yKey) ? true : false
+
+      if @bIsStrict && ! bKeyExists
+        raise ArgumentError, "E_UNKNOWN_KEY__STRICT #{yKey.to_s}"
+      end
+
+      return true
+    end
+
+    def setAttr(yKey=nil,xxVal=nil)
+      yKey = yKey.to_sym if yKey.kind_of?(String)
+
+      self.validateKey(yKey)
+
+      @dDocument[yKey] = xxVal
+    end
+
+    def pushAttr(yKey=nil,xxVal=nil)
+      yKey = yKey.to_sym if yKey.kind_of?(String)
+
+      self.validateKey(yKey)
+
+      sType = @dSchema[:properties][yKey].has_key?(:type) ? @dSchema[:properties][yKey][:type] : nil
+
+      if sType == 'array'
+        if @dDocument.has_key?(yKey)
+          @dDocument[yKey].push(xxVal)
+        else
+          @dDocument[yKey] = [xxVal]
+        end
+      else
+        @dDocument[yKey] = xxVal
+      end
+    end
+
+    def fromJson(jDocument=nil)
+      if jDocument.kind_of?(String)
+        @dDocument = JSON.load(jDocument)
+      end
+      return self
+    end
+
+    def fromDict(dDocument=nil)
+      @dDocument = dDocument if dDocument.is_a?(Hash)
+    end
+
+    def asHash()
+      return @dDocument
+    end
+
+    def asJson()
+      return JSON.dump( self.asHash() )
+    end
+
+    def getValStringForProperties(aCols=nil)
+      aVals = self.getValArrayForProperties(aCols)
+      sVals = aVals.join("\t")
+      return sVals
+    end
+
+    def getValArrayForProperties(aCols=nil)
+      aVals = []
+      return aVals if aCols.nil?
+      aCols.each do |yKey|
+
+        yKey = yKey.to_sym if yKey.kind_of?(String)
+        xVal = @dDocument.has_key?(yKey) ? @dDocument[yKey] : nil
+
+        aVals.push( xVal )
+      end
+      return aVals
+    end
+
+    def getDescStringForProperties(aCols=nil)
+      aVals = self.getDescArrayForProperties(aCols)
+      sVals = aVals.join("\t")
+      return sVals
+    end
+
+    def getDescArrayForProperties(aCols=nil)
+      aVals = []
+      return aVals if aCols.nil?
+      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
+
+        aVals.push( xxVal )
+      end
+      return aVals
+    end
+
+  end
+end

data/test/test_setup.rb

@@ -0,0 +1,39 @@
+require 'test/unit'
+require 'jsondoc'
+
+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' }
+      }
+    }
+
+    jDoc = JsonDoc::Document.new(schemaTest,true,true)
+
+    assert_equal 'abc'          , jDoc.getAttr(:id)
+    assert_equal "abc\tbar"     , jDoc.getValStringForProperties([:id,:foo])
+    assert_equal ['bar','world'], jDoc.getValArrayForProperties([:foo,:hello])
+    assert_equal "Id\tFoo"      , jDoc.getDescStringForProperties([:id,:foo])
+    assert_equal ['Foo','Hello'], jDoc.getDescArrayForProperties([:foo,:hello])
+
+    jDoc.setAttr(:foo,'baz')
+    assert_equal 'baz'          , jDoc.getAttr(:foo)
+    assert_equal "abc\tbaz"     , jDoc.getValStringForProperties([:id,:foo])
+    assert_equal ['abc','baz']  , jDoc.getValArrayForProperties([:id,:foo])
+
+    assert_equal ['foo'], jDoc.getAttr(:array)
+    jDoc.pushAttr(:array,'bar')
+    assert_equal ['foo','bar'], jDoc.getAttr(:array)
+    jDoc.pushAttr(:array,'baz')
+    assert_equal ['foo','bar','baz'], jDoc.getAttr(:array)
+    jDoc.setAttr(:array,['qux'])
+    assert_equal ['qux'], jDoc.getAttr(:array)
+
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: jsondoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-28 00:00:00.000000000 Z
+dependencies: []
+description: A base document object
+email: john@johnwang.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- jsondoc.gemspec
+- lib/jsondoc.rb
+- lib/jsondoc/document.rb
+- test/test_setup.rb
+homepage: http://johnwang.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: JsonDoc
+test_files: []