confrb 1.0 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dce20723dba46522772c29be5d17f8895830c498b151b21e61c1987766fa073e
-  data.tar.gz: bb4c5e003e265873d9b637ffe7e56acf5549fd3a61cd7702ab5edb928fc94d93
+  metadata.gz: 057e6c72fa7f625ee6856c4a8146a002c78318a9cf0e7658c5e58bf548763b25
+  data.tar.gz: ae506af9f374b7d125307f39e0557c38001c4e08cadecbb9df09fae9518b7f0e
 SHA512:
-  metadata.gz: df3255415f4668326196449c68bf71d9ea52c4199ee45e406f7b2a39488b7172e67e61243a1136c22d7e5cf44107b19f4be196ca0df13521a99dce3b9fdfd658
-  data.tar.gz: 763d109b26b7bff6c31c92a114f3402b346232ea4acb3d98412ba9ee89b3d5282d9c60a466c63754195d37a718c3026152a5de90e1119623a72eb893ae593f16
+  metadata.gz: 53aba1502fea37f17a3cdeb933b79ccc0b2661219217fdcf32ca6ac07bef8f8f749bad12cc3a7352ece86e52c12177bec79acff71d61d7660748e3eb3b144dfa
+  data.tar.gz: 59d2762f9d990829e6fc66d2b69560ea9348992646e887a19241cd45b72b7228e1ab33bcc6479329df1204e666af9623e09ef812203e5995de889f394d1e00ce

data/lib/confrb.rb

@@ -1,65 +1,149 @@
 # Require everything!
-require 'fileutils'
-require 'json'
-require 'yaml'
-module BasicCfrb
-	extend self # Make sure this extends self so it can be used as a module!
+require "fileutils"
+require "json"
+require "yaml"
+##
+# Main class for Conf.rb
+# @author gsbhasin84
+class Confrb
+  ##
+  # Auto-create config storage directory, prepending '.' to
+  # given name. Use .new() on this class to run this! Can create subdirs recursively, but only
+  # root directory gets '.' prepended
+  # @param [String] db The name of the configuration directory to create. 
+  def initialize(db)
+    @db = db
+    dotname = "." + @db
+    FileUtils.mkdir_p(dotname)
+  end
 
-	def setup(name) 
-		dotname = "." + name
-		FileUtils.mkdir_p(dotname)
-	end
+  ##
+  # Access the given database, prepending '.' to given name. Auto-create if doesn't exist.
+  # @param [String] db The name of the configuration directory to access
+  def self.access(db)
+    @db = db
+    Confrb.new(db)
+  end
 
-	def mkcfg(dir, cfgname, content, opts={})
-		as_json=opts.fetch(:json, false)
-		as_yaml=opts.fetch(:yaml, false)
-		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
+  ##
+  # Create/overwrite a config file and write data to it. Can
+  # serialize a hash as yaml or json, or write a string
+  # @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(cfgname, content, opts = {})
+    as_json = opts.fetch(:json, false) && content.is_a?(Hash)
+    as_yaml = opts.fetch(:yaml, false) && content.is_a?(Hash)
+    dotdir = "." + @db
+    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
 
-	def mknested(dir, nesteddir)
-		dotdir = "." + dir
-		FileUtils.mkdir_p(File.join(dotdir, nesteddir))
-	end
+  ##
+  # Creates nested dir(s) inside a database.
+  # @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(nesteddir)
+    dotdir = "." + @db
+    FileUtils.mkdir_p(File.join(dotdir, nesteddir))
+  end
 
-	def readcfg(dir, cfgname, opts={})
-		dotdir = "." + dir
-		as_json=opts.fetch(:json, false)
-		as_yaml=opts.fetch(:yaml, false)
-		if as_json == true 
-			content = File.read(File.join(dotdir, cfgname)).to_json
-			return content
-		elsif as_yaml == true 
-			content = File.read(File.join(dotdir, cfgname)).yaml
-			return content
-		else
-			File.read(File.join(dotdir, cfgname))
-		end
-		
-	end
+  ##
+  # Read a config file from disk
+  # @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(cfgname, opts = {})
+    dotdir = "." + @db
+    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
 
-	def rmcfg(dir, cfgname)
-		dotdir = "." + dir
-		File.delete(File.join(dotdir, cfgname))
-	end
+  ##
+  # Remove a configuration file
+  # @param [String] cfgname Configuration file name, use nested directories here with File.join()
+  # @return [String] path to file deleted.
+  def rmcfg(cfgname)
+    dotdir = "." + @db
+    File.delete(File.join(dotdir, cfgname))
+  end
 
-	def rmdb(dir)
-		dotdir = "." + dir
-		FileUtils.rm_rf(dotdir)
-	end
+  ##
+  # Remove a whole database
+  # @return [String] Path to deleted database
+  def rmdb()
+    dotdir = "." + @db
+    FileUtils.rm_rf(dotdir)
+  end
 
-	def rmnested(dir, nested)
-		dotdir = File.join("." + dir, nested)
-		FileUtils.rm_rf(dotdir)
-	end
-end
+  ## Remove a nested 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(nested)
+    dotdir = File.join("." + @db, nested)
+    FileUtils.rm_rf(dotdir)
+  end
+
+  ##
+  # Create/append to a config file. Can
+  # serialize a hash as yaml or json, or write a string
+  # @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 writecfg(cfgname, content, opts = {})
+    as_json = opts.fetch(:json, false) && content.is_a?(Hash)
+    as_yaml = opts.fetch(:yaml, false) && content.is_a?(Hash)
+    dotdir = "." + @db
+    cfgpath = File.join(dotdir, cfgname)
+    FileUtils.touch(cfgpath)
+    if as_json == true
+      content = content.to_json
+      content = "\n" + content
+      IO.write(cfgpath, "\n" + content, mode: "a")
+    elsif as_yaml == true
+      content = content.to_yaml
+      IO.write(cfgpath, "\n" + content, mode: "a")
+    else
+      IO.write(cfgpath, "\n" + content, mode: "a")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confrb
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.6'
 platform: ruby
 authors:
 - Gurjus Bhasin
@@ -11,8 +11,9 @@ 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
+  directories. Supports JSON, YAML, and plaintext. Data is unencrypted, but you can
+  hash/encrypt data yourself before passing it to be written.  Useful for simple text
+  adventure games, etc. Docs and examples at https://gitlab.com/Gsbhasin84/confrb
 email: gsbhasin84@gmail.com
 executables: []
 extensions: []