vdf 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 671fed7feb60fe6633dbf7f0e59be7871b6ebcdce21526f4a48a2995f74bab30
-  data.tar.gz: 27d447b2bdaa23854f08b8d39765baec1119e80362e565eceb3c07761144faa8
+  metadata.gz: ea8791384e1412acbaf3adb8e3d6c927b551beffa7ca464d0c13d2afc09f3467
+  data.tar.gz: 31b28036937bf19217f598c7c59614448af11e4f7d70e6c4fb1f72d948252deb
 SHA512:
-  metadata.gz: 52725af93ca37ad09273f16ffc1cad5c1ea90c89703187e915a8c8855806795a33f2378c07a76b7ef81e59de6344338ae8f5ac81104c3621d777283a24e2abca
-  data.tar.gz: 335f96798e24298f69aeda8a8df290bf5245126951c69e556312b53d5b98fe998653d324620c76fbce6ce717de9e96db31b5ddbc9c79ae39a09506ffa1e6e2e5
+  metadata.gz: 961a27599e581e3ce2452a74833ac5b67d89d23d4eb98454602b6c33533c2102468ba80661543ea08468b47de2328de23b1931300c3d013b98e8323debd95038
+  data.tar.gz: 63d5f33713c9ad9f9d32c32f6b3f75ab90661ff48b286e463392390720daf05ad23c078d17b0bdc2e07e57c66b49c31c877d5cdc780819a47749cc73fb80fb32

data/.github/workflows/gempush.yml

@@ -27,7 +27,7 @@ jobs:
         chmod 0600 $HOME/.gem/credentials
         printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
         gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem || true
       env:
         GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
         OWNER: sapphyrus
@@ -39,6 +39,6 @@ jobs:
         chmod 0600 $HOME/.gem/credentials
         printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
         gem build *.gemspec
-        gem push *.gem
+        gem push *.gem || true
       env:
         GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/README.md

@@ -1,9 +1,12 @@
 # VDF
 
-VDF is a gem to convert Valve's KeyValue format to ruby hashes and back, based on the excellent [node-steam/vdf](https://github.com/node-steam/vdf)
-
-[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fsapphyrus%2Fvdf%2Fbadge&style=popout)](https://actions-badge.atrox.dev/sapphyrus/vdf/goto)
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fsapphyrus%2Fvdf%2Fbadge&style=flat)](https://actions-badge.atrox.dev/sapphyrus/vdf/goto)
 [![Gem](https://img.shields.io/gem/v/vdf?color=%23E9573F)](https://rubygems.org/gems/vdf)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/gems/vdf)
+[![GitHub issues](https://img.shields.io/github/issues/sapphyrus/vdf)](https://github.com/sapphyrus/vdf/issues)
+[![License](https://img.shields.io/github/license/sapphyrus/vdf)](https://github.com/sapphyrus/vdf/blob/master/LICENSE.txt)
+
+VDF is a gem to convert Valve's KeyValue format to Ruby hashes and back, based on the excellent [node-steam/vdf](https://github.com/node-steam/vdf)
 
 ## Installation
 
@@ -83,6 +86,16 @@ vdf4r 53.422000   0.016000  53.438000 ( 54.020029)
 
 Compared to the [vdf4r gem](https://github.com/skadistats/vdf4r) using [this script](https://gist.github.com/sapphyrus/3aab81ad06949c3743ad91e20ccf7c65).
 
+## Download
+
+The latest version of this library can be downloaded at
+
+* https://rubygems.org/gems/vdf
+
+Online Documentation should be located at
+
+* https://www.rubydoc.info/gems/vdf
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/sapphyrus/vdf.

data/lib/vdf.rb

@@ -2,7 +2,10 @@ require "vdf/version"
 require "vdf/parse"
 require "vdf/generate"
 
+# Main VDF module
+# @author sapphyrus
 module VDF
+	# Error while parsing a VDF document
 	class ParserError < StandardError
 	end
 end

data/lib/vdf/generate.rb

@@ -1,7 +1,13 @@
 module VDF
+	# The Generator class is responsible for generating VDF documents from input hashes.
+	# @see VDF.generate
 	class Generator
 		class << self
 
+			# Generates a VDF document from a Ruby Hash and returns it
+			#
+			# @param object [Hash] the input object
+			# @return [String] the generated VDF document
 			def generate(object)
 				raise ArgumentError, "Object has to respond to each" unless object.respond_to? :each
 
@@ -27,6 +33,10 @@ module VDF
 		end
 	end
 
+	# Generates a VDF document from a ruby hash.
+	#
+	# @param object [Hash] the input object
+	# @return [String] the generated VDF document
 	def generate(object)
 		Generator.generate(object)
 	end

data/lib/vdf/parse.rb

@@ -1,6 +1,9 @@
 module VDF
+	# The Parser class is responsible for parsing a VDF document into a Ruby Hash
+	# @see VDF.parse
 	class Parser
 		class << self
+			# Regex for splitting up a line in a VDF document into meaningful parts. Taken from {https://github.com/node-steam/vdf/blob/master/src/index.ts#L18-L24}
 			REGEX = Regexp.new(
 				'^("((?:\\\\.|[^\\\\"])+)"|([a-z0-9\\-\\_]+))' +
 				'([ \t]*(' +
@@ -9,7 +12,22 @@ module VDF
 				'))?',
 				Regexp::MULTILINE
 			)
+			private_constant :REGEX
 
+			# Parses a VDF document into a Ruby Hash and returns it
+			#
+			# For large files, it's recommended to pass the File object to VDF.parse instead of reading the whole File contents into memory
+			#
+			# @param input [String, File, #to_str, #each_line] the input object
+			# @return [Hash] the contents of the VDF document, parsed into a Ruby Hash
+			# @raise [ParserError] if the VDF document is invalid
+			# @example Parse the contents of a VDF String
+			#   contents = VDF.parse(string)
+			# @example Parse the contents of a VDF File
+			#   File.open("filename.vdf", "r") do |file|
+			#   	contents = VDF.parse(file)
+			#   	puts contents.inspect
+			#   end
 			def parse(input)
 				raise ArgumentError, "Input has to respond to :each_line or :to_str" unless input.respond_to?(:each_line) || input.respond_to?(:to_str)
 				input = StringIO.new(input) unless input.respond_to? :pos
@@ -91,8 +109,22 @@ module VDF
 		end
 	end
 
-	def parse(text)
-		Parser.parse(text)
+	# Parses a VDF document into a Ruby Hash and returns it
+	#
+	# For large files, it's recommended to pass the File object to VDF.parse instead of reading the whole File contents into memory
+	#
+	# @param input [String, File, #to_str, #each_line] the input object
+	# @return [Hash] the contents of the VDF document, parsed into a Ruby Hash
+	# @raise [ParserError] if the VDF document is invalid
+	# @example Parse the contents of a VDF String
+	#   contents = VDF.parse(string)
+	# @example Parse the contents of a VDF File
+	#   File.open("filename.vdf", "r") do |file|
+	#   	contents = VDF.parse(file)
+	#   	puts contents.inspect
+	#   end
+	def parse(input)
+		Parser.parse(input)
 	end
 	module_function :parse
 end

data/lib/vdf/version.rb

@@ -1,3 +1,4 @@
 module VDF
-  VERSION = "1.0.2"
+	# The current version
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vdf
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - sapphyrus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler