confrb 1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 59dcfb3a452a7606bb6e576974c1737e5045937ccadacdc5c118877834f30952
+  data.tar.gz: 32c66d6bf4fa2cddc422c7b8ed0c5a3b8de46fdd97ae6acee8183a528bce6515
+SHA512:
+  metadata.gz: 3440bb1335052a4324c6444ae17c248880f30cda32846a10dbb0d87724e7676f86ef9b3cdafaf4f9ed88d2dc55c4f620abb9d2c498363926bd33c05884bfbb1e
+  data.tar.gz: 951e5ac8ff096b37bed1aa9f49116f1d4ea77bcc019845106a1c3494212a8c97af1c7bbe4ab7219b13e7e9f43188d0b17a2bb35292be9ece89862c07443eeb6a

data/lib/confrb.rb

@@ -0,0 +1,120 @@
+# Require everything!
+require 'fileutils'
+require 'json'
+require 'yaml'
+##
+# Main module for BasicCfrb
+# @author gsbhasin84
+module BasicCfrb
+	extend self # Make sure this extends self so it can be used as a module!
+
+  ##
+  # Create config storage directory, appending '.' to
+  # given name. Can create subdirs recursively, but only
+  # root directory gets '.' prepended
+  # @param [String] name The name of the configuration directory to create.
+	def setup(name) 
+		dotname = "." + name
+		FileUtils.mkdir_p(dotname)
+	end
+
+  ##
+  # Create/overwrite a config file and write data to it. Can
+  # serialize a hash as yaml or json, or write a string
+  # @param [String] dir Path to store config file in
+  # @param [String] cfgname Name of config file to write to
+  # @param [Hash] opts Optional param hash
+  # @option opts [boolean] :json If true, serialize content
+  #   as JSON (ignored if content isn't a hash) Default #   
+  #   false
+  # @option opts [boolean] :yaml If true, serialize content
+  #   as YAML (ignored if content isn't a hash) Default #   
+  #   false (json: true takes precedence
+  # @return path to configuration file created.
+	def mkcfg(dir, cfgname, content, opts={})
+		as_json=opts.fetch(:json, false) && content.is_a?(Hash)
+		as_yaml=opts.fetch(:yaml, false) && content.is_a?(Hash)
+		dotdir = "." + dir
+		cfgpath = File.join(dotdir, cfgname)
+		FileUtils.touch(cfgpath)
+		if as_json == true 
+			content = content.to_json
+			File.write(cfgpath, content)
+		elsif as_yaml == true 
+			content = content.to_yaml
+			File.write(cfgpath, content)
+		else
+			File.write(cfgpath, content)
+		end
+	end
+
+  ##
+  # Creates nested dir(s) inside a configuration folder set up with setup(). If no configuration folder has been set up, creates one.
+  # @param [String] dir Setup/base folder; has '.' prepended
+  #   to its name, should be what used in setup() and auto-created if setup() was not run with the specific name passed.
+  # @param [String] nesteddir Nested dir(s) to create in dir
+  #   Make sure path delimiter is OS correct, or use
+  #   File.join
+  # @return [String] path to nested directory created.
+	def mknested(dir, nesteddir)
+		dotdir = "." + dir
+		FileUtils.mkdir_p(File.join(dotdir, nesteddir))
+	end
+
+  ##
+  # Read a config file from disk
+  # @param [String] dir Setup dir name (without '.' prefix)
+  # @param [String] cfgname Config file name to read
+  # @param [Hash] opts Optional param hash
+  # @option opts [boolean] :json If true, deserialize   
+  #   content as JSON (Default false)
+  # @option opts [boolean] :yaml If true, deserialize 
+  #   content as YAML. Default false (json: true takes
+  #   precedence
+  # @return [String|Hash] Loaded contents, either a String
+  #   if not indicated to treat as JSON or YAML, or a hash
+  #   deserialized from content string
+	def readcfg(dir, cfgname, opts={})
+		dotdir = "." + dir
+		as_json=opts.fetch(:json, false)
+		as_yaml=opts.fetch(:yaml, false)
+		if as_json == true 
+			content = JSON::load(File.read(File.join(dotdir, cfgname)))
+			return content
+		elsif as_yaml == true 
+			content = YAML::load(File.read(File.join(dotdir, cfgname)))
+			return content
+		else
+			File.read(File.join(dotdir, cfgname))
+		end
+		
+	end
+	
+	##
+	# Remove a configuration file
+	# @param [String] dir Setup directory name, without the . prefix
+	# @param [String] cfgname Configuration file name, use nested directories here with File.join()
+	# @return [String] path to file deleted.
+	def rmcfg(dir, cfgname)
+		dotdir = "." + dir
+		File.delete(File.join(dotdir, cfgname))
+	end
+
+	##
+	# Remove a whole database
+	# @param [String] dir The configuration directory/database to be deleted, without the '.'
+	# @return [String] Path to deleted database
+	def rmdb(dir)
+		dotdir = "." + dir
+		FileUtils.rm_rf(dotdir)
+	end
+
+	## Remove a nested directory
+	# @param dir Root configuration directory
+	# @param [String] Nested directory path, please use File.join() if it's more than one layer deep.
+	# @return [String] Path to deleted nested directory
+	def rmnested(dir, nested)
+		dotdir = File.join("." + dir, nested)
+		FileUtils.rm_rf(dotdir)
+	end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: confrb
+version: !ruby/object:Gem::Version
+  version: '1.3'
+platform: ruby
+authors:
+- Gurjus Bhasin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-18 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby Gem which allows you to store configuration files using hidden
+  directories. Plaintext, unencrypted. Useful for simple text adventure games, etc.
+  Docs and examples at https://gitlab.com/Gsbhasin84/confrb
+email: gsbhasin84@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/confrb.rb
+homepage: https://gitlab.com/Gsbhasin84/confrb
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Plaintext configuration library for Ruby
+test_files: []