confrb 1.7 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8dfa076ab1375b93293ff60476790ab13290dabef9a11fc548bf9ec72de19b3
-  data.tar.gz: 5cb5e6b28791faa5a5b55e20901effeee961f96c1f7e82d628d5ede60725a580
+  metadata.gz: 9165a2a0d73d5f050509c432b20151a6ca29d6f25d271169e61eb74a17dde60b
+  data.tar.gz: '02708d9d9994f7298115067e855a42d6944458e74526713f665739b04d722659'
 SHA512:
-  metadata.gz: e756e3bddb9c8970be8ead63eafd0d499e84b4e5992c216feacf1815260c0e2e529a1b12be64461e17f6f3e7c45ec8706ad89a9bff5247e8110fc8d9f5964ae1
-  data.tar.gz: ed0d486f91a42faed7a2b3d571b8e6c290cd2d2775792477485aa434ebb4e80a0d822e9f6e8bf209dc984d6627a981c4e3783bf1a54f2214e03f6f246e297b45
+  metadata.gz: 0de222c4e4fbb0f3f136645e58550387a1ff496861f7a32e51a60528088ed7b3537520de3444787cf19566a71706794c630f04899442a0523617129586f6fe43
+  data.tar.gz: 47b3c588de6c4372120de9c113b074a60c082844a4e3a00ab00c1f7bcda346dbd91b6dcccd700aa643d74b60d9a5b7f78423c3aefaea01e3ac9aa690eec62d1c

data/lib/confrb.rb

@@ -18,7 +18,7 @@ class Confrb
   end
 
   ##
-  # Access the given database, prepending '.' to given name. Auto-create if doesn't exist.
+  # Access the given database, prepending '.' to given name. Raises an exception if nonexistent.
   # @param [String] db The name of the configuration directory to access
   def self.access(db)
     if Dir.exist? '.' + db
@@ -30,19 +30,26 @@ class Confrb
 
   ##
   # 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
+  # serialize data as yaml or json, or write a string.
+  # @param [String] cfgname Name of config file to write to 
+  # @param [String] content The content to write, defaults to an empty string.
   # @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
+  #   as JSON  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)
+  #   as YAML Default: false (json: true takes precedence)
+  # @option opts [boolean] :newline If true, prepends a newline to the beginning of the content. Default: false
   # @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)
+  def mkcfg(cfgname, content='', opts = {})
+    as_json = opts.fetch(:json, false) 
+    as_yaml = opts.fetch(:yaml, false)
+    pnewline = opts.fetch(:prepend_newline, false)
+    anewline = opts.fetch(:append_newline, false)
+    if pnewline == true
+      content = "\n" + content
+    elsif anewline == true
+      content = content + "\n"
+    end
     dotdir = "." + @db
     cfgpath = File.join(dotdir, cfgname)
     FileUtils.touch(cfgpath)
@@ -78,7 +85,7 @@ class Confrb
   #   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
+  #   if not indicated to treat as JSON or YAML, or a data structure
   #   deserialized from content string
   def readcfg(cfgname, opts = {})
     dotdir = "." + @db
@@ -121,32 +128,38 @@ class Confrb
   end
 
   ##
-  # Create/append to a config file. Can
-  # serialize a hash as yaml or json, or write a string
+  # Create/append to a config file and write data to it. Can
+  # serialize data as yaml or json, or write a string. Writes a newline at the beginning.
   # @param [String] cfgname Name of config file to write to
+  # @param [String] content The content to write, defaults to an empty string.
   # @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
+  #   as JSON  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)
+  #   as YAML Default: false (json: true takes precedence)
+  # @option opts [boolean] :newline If true, prepend a newline to content. Default: true
   # @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)
+    as_json = opts.fetch(:json, false)
+    as_yaml = opts.fetch(:yaml, false) 
+    pnewline = opts.fetch(:prepend_newline, true)
+    anewline = opts.fetch(:append_newline, false)
     dotdir = "." + @db
     cfgpath = File.join(dotdir, cfgname)
     FileUtils.touch(cfgpath)
+    if pnewline == true
+      content = "\n" + content
+    elsif anewline == true
+      content = content + "\n"
+    end
     if as_json == true
       content = content.to_json
-      content = "\n" + content
-      IO.write(cfgpath, "\n" + content, mode: "a")
+      File.write(cfgpath, content, mode: "a")
     elsif as_yaml == true
       content = content.to_yaml
-      IO.write(cfgpath, "\n" + content, mode: "a")
+      File.write(cfgpath, content, mode: "a")
     else
-      IO.write(cfgpath, "\n" + content, mode: "a")
+      File.write(cfgpath, content, mode: "a")
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confrb
 version: !ruby/object:Gem::Version
-  version: '1.7'
+  version: '2.2'
 platform: ruby
 authors:
 - Gurjus Bhasin