wikk_configuration 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d42847eb805d60cdf0fb9ac2db0ab1f7a24c2a39
-  data.tar.gz: 551238c64c629ffcf4c7fa3db80e25bf554de3e6
+  metadata.gz: 787c6bbe19f13b0cf0408094dcee74c3e294be25
+  data.tar.gz: 7ef971f09fbcc75da50230d76b554fa26842465e
 SHA512:
-  metadata.gz: 6fd33de2da796b31db252c123ea34b65f507d63bf13ef45a216bada06d4cca7ed3cc9c8e8bc675f6c6384eb08abf50b4bfa939abb01f80a12d43072b04ed2b7e
-  data.tar.gz: 428247fa5c65afdc61c1798b960416fd13f6b2cf5b5c01845e2f81d6dfa9390890640b1fdc7ed19290718536944b1316cc95dfd3cedbf4d59d1732485372735a
+  metadata.gz: 440bc4b32e6e439db0c608b04272229a3f7b6f89a50815b2d8a9eda0c9bdc22e4a4af2ad0603acbc493eeb8166147dcbd04f746f2c3df1ff46b62abdfca683bf
+  data.tar.gz: 5a3b08024476a983125783e85e89cb0bc7419066650a1ef5bd668da2594dd4447bf887312f8ea2cea26d328b984d60b0e9017a8cd810453c3ec404dcd8dc2fca

data/History.txt

@@ -1,3 +1,11 @@
+robertburrowes	Sun Jun 19 13:33:36 2016 +1200
+	encapsualted in module WIKK
+robertburrowes	Sat Jun 18 17:11:10 2016 +1200
+	Added 2nd and 3rd level examples.
+robertburrowes	Sat Jun 18 17:10:42 2016 +1200
+	Better Synopsis
+robertburrowes	Sat Jun 18 16:57:38 2016 +1200
+	Turned configuration into wikk_configuration gem
 robertburrowes	Sun May 8 22:43:56 2016 +1200
 	Changed makefile into install.sh
 robertburrowes	Sun Jan 10 19:33:55 2016 +1300

data/README.md

@@ -1,4 +1,4 @@
-# configuration
+# wikk_configuration
 
 * http://rbur004.github.com/configuration/
 * Source https://github.com/wikarekare/configuration
@@ -15,6 +15,28 @@ Ruby class to read json configuration files, and present the top level values as
 ## SYNOPSIS:
 
 	require 'configuration'
+	include WIKK
+  @config = Configuration.new(config_file) #Where config_file is a json file.
+    
+  eg. config_file with json types
+  {
+    "array": [ 0, 1, 2, 3 , 4 ],
+    "hash": { "0": 0, "1": 1, "2": 2 },
+    "boolean": true,
+    "string": "string",
+    "numeric": 1.2345
+  }
+  
+  Results in Ruby variables of classes:
+  
+  @config.array.class => Array
+  @config.hash.class => Hash
+  @config.boolean.class => TrueClass
+  @config.string.class => String
+  @config.numeric.class => Float
+  
+  Only top level hash names are converted to methods. 
+  Be careful not to use a hash key that would conflict with a local method in Class.
 	
 ## REQUIREMENTS:
 

data/Rakefile

@@ -6,6 +6,7 @@ require 'hoe'
 Hoe.plugin :yard
 
 Hoe.spec 'wikk_configuration' do 
+  self.readme_file = "README.md"
   self.developer( "Rob Burrowes","r.burrowes@auckland.ac.nz")
   remote_rdoc_dir = '' # Release to root
   

data/lib/wikk_configuration.rb

@@ -1,45 +1,47 @@
-require 'json'
+module WIKK
+  require 'json'
 
-#Reads json configuration and provides access to the configuration data
-#as method calls.
-class Configuration
-  VERSION = '0.1.0'
+  #Reads json configuration and provides access to the configuration data
+  #as method calls.
+  class Configuration
+    VERSION = '0.1.1'
   
-  #Creates an instance of Configuration from a json file
-  # @param [String] filename The Json file
-  # @return [Configuration]
-  def initialize(filename="#{File.dirname(__FILE__)}/../conf/config.json") 
-    json = File.read(filename)
-    @pjson = JSON.parse(json)
-  end
+    #Creates an instance of Configuration from a json file
+    # @param [String] filename The Json file
+    # @return [Configuration]
+    def initialize(filename="#{File.dirname(__FILE__)}/../conf/config.json") 
+      json = File.read(filename)
+      @pjson = JSON.parse(json)
+    end
   
-  #Provides a test for a method named after a json configuration item exists
-  # @note We need to define respond_to? as well as method_missing to satisfy tests in some libraries.
-  # @param symbol [Symbol,String]  The method name we need to test exists
-  # @param include_private [Boolean]  Extend the test to private methods
-  # @return [Boolean] true if the method exists
-  def respond_to?(symbol, include_private = false)
-    (@pjson[symbol.to_s] != nil) || super(symbol, include_private)
-  end
+    #Provides a test for a method named after a json configuration item exists
+    # @note We need to define respond_to? as well as method_missing to satisfy tests in some libraries.
+    # @param symbol [Symbol,String]  The method name we need to test exists
+    # @param include_private [Boolean]  Extend the test to private methods
+    # @return [Boolean] true if the method exists
+    def respond_to?(symbol, include_private = false)
+      (@pjson[symbol.to_s] != nil) || super(symbol, include_private)
+    end
 
-  #Default handler to map json configuration names to method names
-  # @note Be aware of the possibility of name conflicts between built in class methods an configuration items defined in the json file)
-  # @param symbol [symbol,String] The method name that maps to a json configuration item
-  # @param args [Array] Not used, but would hold arguments to the method call. Should be zero length for our methods.
-  # @param block [Block] Not used, but would be a code block supplied to the method. 
-  # @return [Object] the data associated with the json name, (hence method name) in the configuration file.
-  def method_missing(symbol , *args, &block)
-    s = symbol.to_s
-    if @pjson[s] != nil
-      return @pjson[s]
-    else
-      super
-    end     
-  end
+    #Default handler to map json configuration names to method names
+    # @note Be aware of the possibility of name conflicts between built in class methods an configuration items defined in the json file)
+    # @param symbol [symbol,String] The method name that maps to a json configuration item
+    # @param args [Array] Not used, but would hold arguments to the method call. Should be zero length for our methods.
+    # @param block [Block] Not used, but would be a code block supplied to the method. 
+    # @return [Object] the data associated with the json name, (hence method name) in the configuration file.
+    def method_missing(symbol , *args, &block)
+      s = symbol.to_s
+      if @pjson[s] != nil
+        return @pjson[s]
+      else
+        super
+      end     
+    end
   
-  # @return [String] the configuration
-  def to_s
-    @pjson.to_s
-  end
+    # @return [String] the configuration
+    def to_s
+      @pjson.to_s
+    end
   
+  end
 end

data/test/conf.json

@@ -4,5 +4,7 @@
   "world": { "0": 0, "1": 1, "2": 2 },
   "boolean": true,
   "string": "string",
-  "numeric": 1.2345
+  "numeric": 1.2345,
+  "deep": { "array": [ 0, 1, 2, 3 , 4 ], "hash": { "0": 0, "1": 1, "2": 2 } },
+  "deeper": { "hash": { "array": [ 0, 1, 2, 3 , 4 ] } }
 }

data/test/manualtest.rb

@@ -1,7 +1,8 @@
 #!/usr/local/bin/ruby
-#require_relative '../lib/wikk_configuration.rb' #For preinstall testing
-require 'wikk_configuration.rb' #For post install testing
+require_relative '../lib/wikk_configuration.rb' #For preinstall testing
+#require 'wikk_configuration.rb' #For post install testing
 require 'pp'
+include WIKK
 
 #Provides a self test of this class, by reading the test configuration file.
 #  and attempting to access configuration items as methods. 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikk_configuration
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-18 00:00:00.000000000 Z
+date: 2016-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-yard