structformatter 0.0.1

data.tar.gz.sig

@@ -0,0 +1 @@
+�C��|.#��?��/O�gt0�	7�ߦ�K/)#7�3��0뒺�D

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in structformatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 chrislee35
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+# Structformatter
+
+Structformatter extends ruby Structs, Arrays, and Hashes to be outputted as yaml, xml, and json.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structformatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structformatter
+
+## Usage
+
+	require 'structformatter'
+	
+	class TestStruct < Struct.new(:apple,:bottle,:can,:donut); end
+	a = [1,'test',1.0,1e-9]
+	b = {'a'=>1, 'b'=>1.0, 'c'=>1e-9, 'd'=>'test'}
+	c = TestStruct.new(1,1.0,1e-9,'test')
+	a.to_xml
+	a.to_json
+	a.to_s
+	b.to_xml
+	b.to_json
+	b.to_s
+	c.to_xml
+	c.to_json
+	c.to_s(",")
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'lib'
+	t.test_files = FileList['test/test_*.rb']
+	t.verbose = true
+end
+
+task :default => :test

data/lib/structformatter.rb

@@ -0,0 +1,177 @@
+require "structformatter/version"
+# DESCRIPTION: extends ruby Structs, Arrays, and Hashes to be outputted as yaml, xml, and strings. This is meant to be used as a mixin
+require 'json'
+require 'date'
+
+class String
+	def xml_escape
+		self.gsub(/&/,"&amp;").gsub(/"/, "&quot;").gsub(/'/, "&apros;").gsub(/</,"&lt;").gsub(/>/,"&gt;")
+	end
+	def xml_escape!
+		self.gsub!(/&/,"&amp;")
+		self.gsub!(/"/, "&quot;")
+		self.gsub!(/'/, "&apros;")
+		self.gsub!(/</,"&lt;")
+		self.gsub!(/>/,"&gt;")
+	end
+end
+
+class Array
+	def render_xml(element_name, element)
+		str = ""
+		if element.class == Date
+			str = "<#{element_name}>#{element.strftime("%Y-%m-%d")}</#{element_name}>"
+		elsif element.class == Time or element.class == DateTime
+			str = "<#{element_name}>#{element.strftime("%Y-%m-%dT%H:%M:%SZ")}</#{element_name}>"
+		elsif element.kind_of? Struct or element.kind_of? Hash or element.kind_of? Array
+			str = element.to_xml
+		else
+			str = "<#{element_name}>#{element.to_s.xml_escape}</#{element_name}>"
+		end
+	end
+	def to_xml
+		str = "<array>"
+		self.each do |item|
+			str += render_xml("element",item)
+		end
+		str += "</array>"
+	end
+	def to(format)
+		case format
+		when 'xml'
+			self.to_xml
+		when 'json'
+			self.to_json
+		when 'string'
+			self.to_s
+		else
+			raise "invalid format: #{format}, use one of xml, json, or string"
+		end
+	end
+end
+
+class Hash
+	def render_xml(element_name, element)
+		str = ""
+		if element.class == Date
+			str = "<#{element_name}>#{element.strftime("%Y-%m-%d")}</#{element_name}>"
+		elsif element.class == Time or element.class == DateTime
+			str = "<#{element_name}>#{element.strftime("%Y-%m-%dT%H:%M:%SZ")}</#{element_name}>"
+		elsif element.kind_of? Struct or element.kind_of? Hash or element.kind_of? Array
+			str = element.to_xml
+		else
+			str = "<#{element_name}>#{element.to_s.xml_escape}</#{element_name}>"
+		end
+	end
+	def to_xml
+		str = "<hash>"
+		self.each do |key,value|
+			str += "<element><key>#{key}</key>"
+			str += render_xml("value",value)
+			str += "</element>"
+		end
+		str += "</hash>"
+	end
+	def to(format)
+		case format
+		when 'xml'
+			self.to_xml
+		when 'json'
+			self.to_json
+		when 'string'
+			self.to_s
+		else
+			raise "invalid format: #{format}, use one of xml, json, or string"
+		end
+	end
+end
+
+class Struct
+	@@printclass = true
+	def Struct::printclass=(pc)
+		@@printclass = pc
+	end
+	def render_xml(element_name, element)
+		str = ""
+		if element.class == Date
+			str = "<#{element_name}>#{element.strftime("%Y-%m-%d")}</#{element_name}>"
+		elsif element.class == Time or element.class == DateTime
+			str = "<#{element_name}>#{element.strftime("%Y-%m-%dT%H:%M:%SZ")}</#{element_name}>"
+		elsif element.kind_of? Struct
+			str = element.to_xml
+		elsif element.kind_of? Hash or element.kind_of? Array
+			str = "<#{element_name}>"+element.to_xml+"</#{element_name}>"
+		else
+			str = "<#{element_name}>#{element.to_s.xml_escape}</#{element_name}>"
+		end
+	end
+	def to_xml
+		children = []
+		str = "<#{self.class}"
+		self.members.each do |member|
+			if self[member].class == Array or self[member].class == Hash or self[member].kind_of? Struct
+				children << member
+			elsif self[member].class == Date
+				str += " #{member}='#{self[member].strftime("%Y-%m-%d")}'"
+			elsif self[member].class == Time
+				str += " #{member}='#{self[member].strftime("%Y-%m-%dT%H:%M:%SZ")}'"
+			else
+				str += " #{member}='#{self[member].to_s.xml_escape}'"
+			end
+		end
+		if children.length == 0
+			str += ' />'
+		else
+			str += '>'
+			children.each do |member|
+				if self[member].class == Array
+					str += "<#{member}s>"
+					self[member].each do |item|
+						str += render_xml(member,item)
+					end
+					str += "</#{member}s>"
+				elsif self[member].class == Hash
+					str += "<#{member}s>"
+					self[member].each do |key,value|
+						str += "<HashElement><key>#{key}</key><value>"
+						str += render_xml(member,value)
+						str += "</value></HashElement>"
+					end
+					str += "</#{member}s>"
+				elsif self[member].kind_of? Struct
+					str += self[member].to_xml
+				end
+			end
+			str += "</#{self.class}>"
+		end
+	end
+	
+	def to_json(*a)
+		hash = (@@printclass) ? { 'class' => self.class } : {}
+		self.members.sort.each do |member|
+			hash[member] = self[member]
+		end
+		hash.to_json(*a)
+	end
+	
+	def to(format)
+		case format
+		when 'xml'
+			self.to_xml
+		when 'json'
+			self.to_json
+		when 'string'
+			self.to_s
+		else
+			raise "invalid format: #{format}, use one of xml, json, or string"
+		end
+	end
+	
+	def to_s(sep = " ")
+		self.members.map{ |x| self[x].to_s }.join(sep)
+	end
+	
+	def to_s_header(sep = " ")
+		self.members.map{ |x| x.to_s }.join(sep)
+	end
+end

data/lib/structformatter/version.rb

@@ -0,0 +1,3 @@
+module Structformatter
+  VERSION = "0.0.1"
+end

data/structformatter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structformatter/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "structformatter"
+	spec.version       = Structformatter::VERSION
+	spec.authors       = ["chrislee35"]
+	spec.email         = ["rubygems@chrislee.dhs.org"]
+	spec.description   = %q{Extends Structs, Hashes, and Arrays with .to_json, .to_xml, and .to_s.  This handles nested data structures and some oddities that other methods do not.}
+	spec.summary       = %q{Extends Structs, Hashes, and Arrays with .to_json, .to_xml, and .to_s}
+	spec.homepage      = "https://github.com/chrislee35/structformatter"
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_runtime_dependency "json", ">= 1.4.3"
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+
+	spec.signing_key   = "#{File.dirname(__FILE__)}/../gem-private_key.pem"
+	spec.cert_chain    = ["#{File.dirname(__FILE__)}/../gem-public_cert.pem"]
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.expand_path('../../lib/structformatter.rb', __FILE__)

data/test/test_structformatter.rb

@@ -0,0 +1,94 @@
+unless Kernel.respond_to?(:require_relative)
+	module Kernel
+		def require_relative(path)
+			require File.join(File.dirname(caller[0]), path.to_str)
+		end
+	end
+end
+
+require_relative 'helper'
+
+class TestStruct < Struct.new(:apple,:bottle,:can,:donut); end
+	
+class TestStructformatter < Test::Unit::TestCase
+	def test_simple_structures
+		a = [1,'test',1.0,1e-9]
+		assert_equal(
+			"<array><element>1</element><element>test</element><element>1.0</element><element>1.0e-09</element></array>",
+			a.to_xml
+		)
+		assert_equal(
+			'[1,"test",1.0,1.0e-09]',
+			a.to_json
+		)
+		# fails in 1.8
+		assert_equal(
+			'[1, "test", 1.0, 1.0e-09]',
+			a.to_s
+		)
+		# fails in 1.8
+		b = {'a'=>1, 'b'=>1.0, 'c'=>1e-9, 'd'=>'test'}
+		assert_equal(
+			"<hash><element><key>a</key><value>1</value></element><element><key>b</key><value>1.0</value></element><element><key>c</key><value>1.0e-09</value></element><element><key>d</key><value>test</value></element></hash>",
+			b.to_xml
+		)
+		assert_equal(
+			'{"a":1,"b":1.0,"c":1.0e-09,"d":"test"}',
+			b.to_json
+		)
+		assert_equal(
+			'{"a"=>1, "b"=>1.0, "c"=>1.0e-09, "d"=>"test"}',
+			b.to_s
+		)
+		
+		c = TestStruct.new(1,1.0,1e-9,'test')
+		assert_equal(
+			"<TestStruct apple='1' bottle='1.0' can='1.0e-09' donut='test' />",
+			c.to_xml
+		)
+		assert_equal(
+			'{"class":"TestStruct","apple":1,"bottle":1.0,"can":1.0e-09,"donut":"test"}',
+			c.to_json
+		)
+		assert_equal(
+			'1 1.0 1.0e-09 test',
+			c.to_s
+		)
+	end
+	
+	def test_complex_structure
+		a = TestStruct.new(
+			[1,'test',{'a'=>1,'b'=>2.0},Date.parse("2010-10-10")],
+			{'k'=>['j','<bad>']},
+			TestStruct.new(5,4,3,2),
+			true
+		)
+		# all of these will fail in 1.8
+		assert_equal(
+			"<TestStruct donut='true'><apples><apple>1</apple><apple>test</apple><apple><hash><element><key>a</key><value>1</value></element><element><key>b</key><value>2.0</value></element></hash></apple><apple>2010-10-10</apple></apples><bottles><HashElement><key>k</key><value><bottle><array><element>j</element><element>&lt;bad&gt;</element></array></bottle></value></HashElement></bottles><TestStruct apple='5' bottle='4' can='3' donut='2' /></TestStruct>",
+			a.to_xml
+		)
+		assert_equal(
+			'{"class":"TestStruct","apple":[1,"test",{"a":1,"b":2.0},"2010-10-10"],"bottle":{"k":["j","<bad>"]},"can":{"class":"TestStruct","apple":5,"bottle":4,"can":3,"donut":2},"donut":true}',
+			a.to_json
+		)
+		assert_equal(
+			'[1, "test", {"a"=>1, "b"=>2.0}, #<Date: 2010-10-10 ((2455480j,0s,0n),+0s,2299161j)>] {"k"=>["j", "<bad>"]} 5 4 3 2 true',
+			a.to_s
+		)
+	end
+	
+	def test_csv_out
+		a = [
+			TestStruct.new(1,2,3,4),
+			TestStruct.new(5,6,7,8),
+			TestStruct.new(9,10,11,12),
+			TestStruct.new(13,14,15,16)
+		]
+		assert_equal("apple,bottle,can,donut", a[0].to_s_header(","))
+		assert_equal("1,2,3,4", a[0].to_s(","))
+		assert_equal("5,6,7,8", a[1].to_s(","))
+		assert_equal("9,10,11,12", a[2].to_s(","))
+		assert_equal("13,14,15,16", a[3].to_s(","))
+	end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: structformatter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- chrislee35
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURZakNDQWtxZ0F3SUJB
+  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREJYTVJFd0R3WURWUVFEREFoeWRX
+  SjUKWjJWdGN6RVlNQllHQ2dtU0pvbVQ4aXhrQVJrV0NHTm9jbWx6YkdWbE1S
+  TXdFUVlLQ1pJbWlaUHlMR1FCR1JZRApaR2h6TVJNd0VRWUtDWkltaVpQeUxH
+  UUJHUllEYjNKbk1CNFhEVEV6TURVeU1qRXlOVGswTjFvWERURTBNRFV5Ck1q
+  RXlOVGswTjFvd1Z6RVJNQThHQTFVRUF3d0ljblZpZVdkbGJYTXhHREFXQmdv
+  SmtpYUprL0lzWkFFWkZnaGoKYUhKcGMyeGxaVEVUTUJFR0NnbVNKb21UOGl4
+  a0FSa1dBMlJvY3pFVE1CRUdDZ21TSm9tVDhpeGtBUmtXQTI5eQpaekNDQVNJ
+  d0RRWUpLb1pJaHZjTkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFOY1ByeDhC
+  WmlXSVI5eFdXRzhJCnRxUjUzOHRTMXQrVUo0RlpGbCsxdnJ0VTlUaXVXWDNW
+  ajM3VHdVcGEyZkZremlLMG41S3VwVlRoeUVoY2VtNW0KT0dSanZnclJGYldR
+  SlNTc2NJS09wd3FVUkhWS1JwVjlnVnovSG56azhTK3hvdFVSMUJ1bzNVZ3Ir
+  STFqSGV3RApDZ3IreSt6Z1pidGp0SHNKdHN1dWprT2NQaEVqalVpbmo2OEw5
+  Rno5QmRlSlF0K0lhY2p3QXpVTGl4NmpXQ2h0ClVjK2crMHo4RXNyeWNhMkc2
+  STFHc3JnWDZXSHc4ZHlreVFEVDlkQ3RTMmZsQ093U0MxUjBLNVQveEhXNTRm
+  KzUKd2N3OG1tNTNLTE5lK3RtZ1ZDNlpIeU1FK3FKc0JuUDZ1eEYwYVRFbkdB
+  L2pEQlFEaFFOVEYwWlAvYWJ6eVRzTAp6alVDQXdFQUFhTTVNRGN3Q1FZRFZS
+  MFRCQUl3QURBTEJnTlZIUThFQkFNQ0JMQXdIUVlEVlIwT0JCWUVGTzh3Cith
+  ZVA3VDZrVkpibENnNmV1c09JSTlEZk1BMEdDU3FHU0liM0RRRUJCUVVBQTRJ
+  QkFRQkNReVJKTFhzQm8yRnkKOFc2ZS9XNFJlbVFScmxBdzlESzVPNlU3MUp0
+  ZWRWb2Iyb3ErT2Irem1TK1BpZkUyK0wrM1JpSjJINlZUbE96aQp4K0EwNjFN
+  VVhoR3JhcVZxNEoyRkM4a3Q0RVF5d0FEMFAwVGE1R1UyNENHU0YwOFkzR2tK
+  eTFTYTRYcVRDMllDCm81MXM3SlArdGtDQ3RwVllTZHpKaFRsbGllUkFXQnBH
+  VjFkdGFvZVVLRTZ0WVBNQmtvc3hTUmNWR2N6ay9TYzMKN2VRQ3BleFl5OUps
+  VUJJOXUzQnFJWTlFK2wrTVNuOGloWFNQbXlLMERncmhhQ3Urdm9hU0ZWT1g2
+  WStCNXFibwpqTFhNUXUyWmdJU1l3WE5qTmJHVkhlaHV0ODJVN1U5b2lIb1dj
+  ck9HYXphUlVtR085VFhQK2FKTEgwZ3cyZGNLCkFmTWdsWFBpCi0tLS0tRU5E
+  IENFUlRJRklDQVRFLS0tLS0K
+date: 2013-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends Structs, Hashes, and Arrays with .to_json, .to_xml, and .to_s.  This
+  handles nested data structures and some oddities that other methods do not.
+email:
+- rubygems@chrislee.dhs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/structformatter.rb
+- lib/structformatter/version.rb
+- structformatter.gemspec
+- test/helper.rb
+- test/test_structformatter.rb
+homepage: https://github.com/chrislee35/structformatter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Extends Structs, Hashes, and Arrays with .to_json, .to_xml, and .to_s
+test_files:
+- test/helper.rb
+- test/test_structformatter.rb

metadata.gz.sig

@@ -0,0 +1,4 @@
+y��^1µblׅb��sm-Zckٙ�+vùw�6d�;�D߀,cZ�h�p_�Ѕ\#���)t�ɝ�<r(:�x�@Z��-H酇Po�se�e�tF�����nkk
+��K��d�4#
+rd�XT�)�yJ+m���	d����aH�AI��cX
+u�º�=9y�|���}ؠ�R���uZתK�{������y}o���U;P�x:(<�*��j����r䑏��Q�{:'b�SR z�DB�dml7U���