confoog 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81ec77ff9a1cd8a233bb54f1efdfc75c71c71484
-  data.tar.gz: 8bcdc84ef266ce9f9bd7cece30d98626ef8a6c34
+  metadata.gz: f7ea32bbb44fdac4553d98301cf1746ad6a93173
+  data.tar.gz: 9d8a92d7ebbcabd06763d027227e6644bb5e1879
 SHA512:
-  metadata.gz: f1b469e7ab0fd62f7ef2b1c64371bacd282ce63ea88eb3e7cba171be0b34326390dcd4c1b8986ee1071e43e7d252abddb54971bbbc3385558f4d1c507ad32c14
-  data.tar.gz: a7bb409ec43d023304c765ae9f069c36e4908bfbaad553a2857ff3bf72c0d4774cfcdee1c30b1f0404783c3e8412d3ccf5d94e14b5e3fc68ab282f56570a9c77
+  metadata.gz: 8e11b394f644facae1798e6225514b5a917efb571afa4a48595fe99093b1aaf3035aeaa6665102c837dff6a1e25ec60994e06265623e3cf09fbf99d25bf5f83a
+  data.tar.gz: acbe142409720d525055959bc01901bf957d704808d4a3b62299830467afe0cdfae38c428bfbe9d39a490bb67104e18aff49a12f207c8b6c831fd6ff0b04352b

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .token
+.remote-sync.json

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.1
   - 2.2.3
 before_install: gem install bundler -v 1.10.6

data/README.md

@@ -29,9 +29,9 @@ Or install it yourself as:
     $ gem install confoog
 
 ## Usage
-Currently Confoog will not allow 'nested' configuration types, however each variable can be an array or hash so multiple settings can be recorded for each variable and accessed (for a hash) by `settings[variable][hash_key]` or array using `settings[array].each`. In other words, treat the return from `settings[var]` as the type it contains. See examples below.
+Very basic usage is as below. For full documentation, see the [Confoog Web Site][confoog]
 
-By default, each time a configuration variable is created or changed the file on disk will be updated with this addition or change. If you intend to make a lot of consecutive changes or do not want the small performance hit of this, pass `autosave: false` as a parameter to #new, or set it false using the #autosave accessor.
+[confoog]: http://confoog.seapagan.net
 
 ```ruby
 require 'confoog'
@@ -41,86 +41,8 @@ settings[:var] = value
 settings[:array] = [1, 2, 3, 4]
 settings[42] = "Meaning of life"
 settings[:urls] = ["https://www.mywebsite.com", "https://www.anothersite.com/a/page.html"]
-
-settings[:urls].each do |url|
-  puts url
-end
-# https://www.mywebsite.com
-# https://www.anothersite.com/a/page.html
-# => ["https://www.mywebsite.com", "https://www.anothersite.com/a/page.html"]
-
-settings[:dont_exist]
-# => nil
-
-a_variable = 50
-settings[a_variable] = {:one => "for the money", :two => "for the show", :three => "to get ready"}
-settings[50]
-# => {:one=>"for the money", :two=>"for the show", :three=>"to get ready"}
-settings[50][:two]
-# => "for the show"
-
-settings.quiet = true # squelch any error or status messages to console
-
-settings.autosave = false # disable autosave if it has been enabled with #new or #autosave
-
-settings.save # save all current parameters to the YAML file
-
-settings.load # load the settings from YAML file.
 ```
 
-Confoog will take several parameters on creation, to specify the default config file and location. For example :
-
-```ruby
-settings = Confoog::Settings.new(location: '/home/myuser', filename: '.foo-settings')
-```
-
-There are other optional flags or variables that can be passed on creation:
-
-```ruby
-# Should a missing configuration file be created or not
-create_file: true | false
-
-# Specify an optional prefix before any error messages
-prefix: 'My Application'
-
-# Should we avoid outputting errors to the console? (ie in a GUI app)
-quiet: true | false
-
-# Should we automatically load the configuration file when the class is created?
-autoload: true | false
-
-# Should we automatically save the configuration file when a variable is created or changed?
-autosave: true | false
-```
-If any of these are not specified, Confoog will use the following defaults :
-
-```ruby
-location: '~/'
-filename: '.confoog'
-create_file: false
-prefix: 'Configuration'
-quiet: false
-autoload: false
-autosave: true
-```
-
-Confoog will set the following error constants which will be returned in the `.status['errors']` variable as needed :
-
-```ruby
-ERR_NO_ERROR = 0 # no error condition, command was succesfull
-ERR_FILE_NOT_EXIST = 1 # specified configuration file does not exist
-ERR_CANT_CREATE_FILE = 2 # cannot create the requested configuration file
-ERR_NOT_WRITING_EMPTY_FILE = 4 # not attempting to save an empty configuration
-ERR_CANT_SAVE_CONFIGURATION = 8 # Failed to save the configuration file
-ERR_NOT_LOADING_EMPTY_FILE = 16 # not atempting to load an empty config file
-ERR_CANT_LOAD = 32 # Cannot load configuration data from file.
-
-INFO_FILE_CREATED = 256 # Information - specified file was created
-INFO_FILE_LOADED = 512 # Information - Config file was loaded successfully
-```
-
-These are generally to do with existence and creation of configuration files.
-
 ## To Do
 
 Thoughts in no particular order.
@@ -131,6 +53,7 @@ Thoughts in no particular order.
 - Check Windows compatibility, certainly at least the tests will fail since there are issue with FakeFS on Window. Should be ok as a production Gem though (TBC)
 - Add other file formats for storing config - XML? (Yuk!)
 - Document properly on a dedicated website with full example usage and help.
+- Add an option to use a config file stored in the script directory, if existing, instead of the specified one. Will make developing of Gems and Apps using this a bit easier.
 
 ## Development
 

data/Rakefile

@@ -28,4 +28,4 @@ else
   end
 end
 
-task default: [:rubocop, :inch, :reek, :spec]
+task default: [:rubocop, :inch, :reek, :spec, :build]

data/confoog.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'inch'
   spec.add_development_dependency 'simplecov', '~> 0.10'
   spec.add_development_dependency 'pullreview-coverage'
+  spec.add_development_dependency 'should_not'
 
   # Depend on Ruby version
   spec.add_development_dependency 'reek', '~> 3.3' if RUBY_VERSION > '2.0'

data/lib/confoog/version.rb

@@ -1,5 +1,5 @@
 # Define the Gem version string
 module Confoog
   # http://semver.org/
-  VERSION = '0.4.5'
+  VERSION = '0.4.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: confoog
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Seapagan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: should_not
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement