jeckyl 0.2.3 → 0.2.4

data/History.txt

@@ -4,6 +4,12 @@
 
 == History
 
+[jeckyl-0.2.4 25-Oct-2012]
+
+  Deprecate ConfigRoot constant in favour of Jeckyl.config_dir, which will pick up
+  the environment variable JECKYL_CONFIG_DIR if set or use '/etc/jeckyl'. This is a
+  change from the old, quirky default of '/etc/jermine'.
+
 [jeckyl-0.2.3 21-Sep-2012]
 
   Add references to online docs etc to usage.

data/README.md

@@ -1,6 +1,6 @@
 #JECKYL 
 
-### (a.k.a. Jumpin' Ermin's Configurator for Kwick and easY Linux services)
+(a.k.a. Jumpin' Ermin's Configurator for Kwick and easY Linux services)
 
 Jeckyl can be used to create a parameters hash from a simple config file written in Ruby, having run whatever checks you want
 on the file to ensure the values passed in are valid. All you need to do is define a class inheriting from Jeckyl, methods for
@@ -16,7 +16,11 @@ Jeckyl comes as a gem. It can be installed in the usual way:
 
     gem install jeckyl
     
-That is all you need to do.
+That is all you need to do. Type 'jeckyl' to see usage and references to documentation.
+
+Jeckyl can be used to set the default location for the config files it processes. This will
+be '/etc/jeckyl' unless you set the environment varibale 'JECKYL_CONFIG_DIR' to something else.
+This could be done on a system-wide basis by include a file with this variable in /etc/env.d.
     
 ## Getting Started
 
@@ -71,12 +75,12 @@ And then, to use this config file to create the options hash:
 
 ### Example Parameter Methods
 
-Some examples of different parameters are given here, taken from the Jelly::Config class, Jelly being
-a jazzed-up ruby logger:
+Some examples of different parameters are given here, taken from the Jellog::Config class, [Jellog](https://github.com/osburn-sharp/jellog)
+being a jazzed-up ruby logger:
 
     def configure_log_level(lvl)
       default :system
-      comment "Controls the amount of logging done by Jelly",
+      comment "Controls the amount of logging done by Jellog",
         "",
         " * :system - standard message, plus log to syslog",
         " * :verbose - more generous logging to help resolve problems",
@@ -208,12 +212,12 @@ all of the parameters from a hash that belong to a given Jeckyl class, use Class
 {Jeckyl::Config.intersection}). And to remove all of the parameters from one config hash in another, 
 use conf.complement(hash) ({Jeckyl::Config#complement}).
 
-For example, the Jelly logger defines a set of logging parameters in Jelly::Config. These may be inherited
+For example, the Jellog logger defines a set of logging parameters in Jellog::Config. These may be inherited
 by another service that adds its own parameters (such as Jerbil):
 
     options = Jerbil::Config.new(my_conf)
     
-    log_opts = Jelly::Config.intersection(options)
+    log_opts = Jellog::Config.intersection(options)
     
     jerb_opts = options.complement(log_opts)
     

data/bin/jeckyl

@@ -197,7 +197,7 @@ EOTXT
         puts "The following parameters are defined in {#{my_class.name}} and should be used"
         puts "in a configuration file. A default config file can be generated using:"
         puts ""
-        puts "    jeckyl config #{File.expand_path(cfile)}"
+        puts "    jeckyl config #{cfile}"
       else
         puts "## Additional Parameters from #{my_class.name}"
         puts ""

data/lib/jeckyl.rb

@@ -20,7 +20,15 @@ require 'jeckyl/errors'
 module Jeckyl
 
   #default location for all config files
-  ConfigRoot = '/etc/jermine'
+  # @deprecated Use {Jeckyl.config_dir} instead
+  ConfigRoot = '/etc/jeckyl'
+  
+  # the default system location for jeckyl config file
+  # 
+  # This location can be set with the environment variable JECKYL_CONFIG_DIR
+  def Jeckyl.config_dir
+    ENV['JECKYL_CONFIG_DIR'] || '/etc/jeckyl'
+  end
 
   # This is the main Jeckyl class from which to create specific application
   # classes. For example, to create a new set of parameters, define a class as
@@ -178,7 +186,7 @@ module Jeckyl
   #  and it can be an instance of Jeckyl::Config or a hash 
   # @return [Hash] containing all of the intersecting parameters
   #
-  # Note this returns a plain hash and not an instance of Jeckyl::Config
+  # @note this returns a plain hash and not an instance of Jeckyl::Config
   #
   def self.intersection(full_config)
     me = self.new # create the defaults for this class
@@ -236,7 +244,7 @@ module Jeckyl
     
     self[:config_files] << conf_file
     
-    # and finally get the values from the config file itself
+    # get the values from the config file itself
     self.instance_eval(File.read(conf_file), conf_file)
 
   rescue SyntaxError => err

data/lib/jeckyl/version.rb

@@ -1,13 +1,15 @@
 # Created by Jevoom
 #
-# 21-Sep-2012
-#   Add references to online docs etc to usage.
+# 25-Oct-2012
+#   Deprecate ConfigRoot constant in favour of Jeckyl.config_dir, which will pick up
+#   the environment variable JECKYL_CONFIG_DIR if set or use '/etc/jeckyl'. This is a
+#   change from the old, quirky default of '/etc/jermine'.
 
 module Jeckyl
-  # version set to 0.2.3
-  Version = '0.2.3'
-  # date set to 21-Sep-2012
-  Version_Date = '21-Sep-2012'
-  #ident string set to: jeckyl-0.2.3 21-Sep-2012
-  Ident = 'jeckyl-0.2.3 21-Sep-2012'
+  # version set to 0.2.4
+  Version = '0.2.4'
+  # date set to 25-Oct-2012
+  Version_Date = '25-Oct-2012'
+  #ident string set to: jeckyl-0.2.4 25-Oct-2012
+  Ident = 'jeckyl-0.2.4 25-Oct-2012'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jeckyl
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Dr Robert
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-21 00:00:00 Z
+date: 2012-10-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime