wikk_configuration 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d42847eb805d60cdf0fb9ac2db0ab1f7a24c2a39
+  data.tar.gz: 551238c64c629ffcf4c7fa3db80e25bf554de3e6
+SHA512:
+  metadata.gz: 6fd33de2da796b31db252c123ea34b65f507d63bf13ef45a216bada06d4cca7ed3cc9c8e8bc675f6c6384eb08abf50b4bfa939abb01f80a12d43072b04ed2b7e
+  data.tar.gz: 428247fa5c65afdc61c1798b960416fd13f6b2cf5b5c01845e2f81d6dfa9390890640b1fdc7ed19290718536944b1316cc95dfd3cedbf4d59d1732485372735a

data/History.txt

@@ -0,0 +1,8 @@
+robertburrowes	Sun May 8 22:43:56 2016 +1200
+	Changed makefile into install.sh
+robertburrowes	Sun Jan 10 19:33:55 2016 +1300
+	Install only
+robertburrowes	Sun Jan 10 19:33:46 2016 +1300
+	Reads json configuration and provides access to the configuration data
+Rob Burrowes	Sun Jan 10 19:26:05 2016 +1300
+	Initial commit

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.md
+Rakefile
+lib/wikk_configuration.rb
+test/manualtest.rb
+test/conf.json

data/README.md

@@ -0,0 +1,54 @@
+# configuration
+
+* http://rbur004.github.com/configuration/
+* Source https://github.com/wikarekare/configuration
+* Gem https://rubygems.org/gems/wikk_configuration
+
+## DESCRIPTION:
+
+Ruby class to read json configuration files, and present the top level values as method calls
+
+## FEATURES/PROBLEMS:
+
+
+
+## SYNOPSIS:
+
+	require 'configuration'
+	
+## REQUIREMENTS:
+
+
+## INSTALL:
+
+* sudo gem install wikk_configuration
+
+## LICENSE:
+
+Copyright (c) 2016, wikarekare
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of configuration nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/local/bin/ruby
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+Hoe.plugin :yard
+
+Hoe.spec 'wikk_configuration' do 
+  self.developer( "Rob Burrowes","r.burrowes@auckland.ac.nz")
+  remote_rdoc_dir = '' # Release to root
+  
+  self.yard_title = 'wikk_configuration'
+  self.yard_options = ['--markup', 'markdown', '--protected']
+end
+
+
+#Validate manfest.txt
+#rake check_manifest
+
+#Local checking. Creates pkg/
+#rake gem
+
+#create doc/
+#rake docs  
+#In directory docs/
+#scp -r . rbur004@rubyforge.org:/var/www/gforge-projects/versioncheck/
+
+#Copy up to rubygem.org
+#rake release VERSION=1.0.1

data/lib/wikk_configuration.rb

@@ -0,0 +1,45 @@
+require 'json'
+
+#Reads json configuration and provides access to the configuration data
+#as method calls.
+class Configuration
+  VERSION = '0.1.0'
+  
+  #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
+
+  #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
+  
+end

data/test/conf.json

@@ -0,0 +1,8 @@
+{
+  "base_directory": "/usr/local/random",
+  "hello": [ 0, 1, 2, 3 , 4 ],
+  "world": { "0": 0, "1": 1, "2": 2 },
+  "boolean": true,
+  "string": "string",
+  "numeric": 1.2345
+}

data/test/manualtest.rb

@@ -0,0 +1,45 @@
+#!/usr/local/bin/ruby
+#require_relative '../lib/wikk_configuration.rb' #For preinstall testing
+require 'wikk_configuration.rb' #For post install testing
+require 'pp'
+
+#Provides a self test of this class, by reading the test configuration file.
+#  and attempting to access configuration items as methods. 
+def test(config_file)
+  puts "creating config from '#{config_file}'"
+  config = Configuration.new(config_file)
+  
+  puts "******Should be there*********"
+  puts "base_directories is defined? #{config.respond_to?(:base_directory)}"
+  puts "base_directories is: '#{config.base_directory}'"
+  puts "******Should NOT be there*********"
+  puts "not_there is defined? #{config.respond_to?(:not_there)}"
+  puts "******Array*********"
+  puts "hello is of class: #{config.hello.class}"
+  puts "config.hello[0] => #{config.hello[0]}"
+  puts "******Hash*********"
+  puts "world is of class: #{config.world.class}"
+  puts "config.world['1'] => #{config.world['1']}"
+  puts "******Boolean*********"
+  puts "boolean is of class: #{config.boolean.class}"
+  puts "config.boolean => #{config.boolean}"
+  puts "******String*********"
+  puts "string is of class: #{config.string.class}"
+  puts "config.string => #{config.string}"
+  puts "******Numeric*********"
+  puts "numeric is of class: #{config.numeric.class}"
+  puts "config.numeric => #{config.numeric}"
+  puts "****** Dump config using to_s *********"
+  pp config
+end
+
+puts "Start"
+begin
+  test('conf.json')
+rescue Exception => error
+  puts "Error: error"
+end
+puts "End"
+
+
+

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: wikk_configuration
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Burrowes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.15'
+description: Ruby class to read json configuration files, and present the top level
+  values as method calls
+email:
+- r.burrowes@auckland.ac.nz
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.md
+files:
+- History.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/wikk_configuration.rb
+- test/conf.json
+- test/manualtest.rb
+homepage: http://rbur004.github.com/configuration/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--markup"
+- markdown
+- "--protected"
+- "--title"
+- wikk_configuration
+- "--quiet"
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby class to read json configuration files, and present the top level values
+  as method calls
+test_files: []