confoog 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2db750038a9c837b96abd1ac2354511befcc4e3c
+  data.tar.gz: 1ec4068f5ca4dec69f7a44c65efe70c81fabc700
+SHA512:
+  metadata.gz: d83773371f01b4b96c294eca30170e66172ac0fa1d1c0ed56ae225aac0d1717ea227fa06d6e29803277db289bdf9b2f5ff32a839b16928478b1ee44dfda13738
+  data.tar.gz: 7d05a59b962bbc9cfedd100a9626bb2ea8f4a1c2b080aaa22373fa23133269c7419eeb0855e0107ff0fd9d2745ab3f9982d48e5ad56fa641a6d7a311ec88df52

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.token

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in confoog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Seapagan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# Confoog
+[![Build Status](https://travis-ci.org/seapagan/confoog.svg)](https://travis-ci.org/seapagan/confoog)
+[![Dependency Status](https://gemnasium.com/seapagan/confoog.svg)](https://gemnasium.com/seapagan/confoog)
+[![Coverage Status](https://coveralls.io/repos/seapagan/confoog/badge.svg?branch=master&service=github)](https://coveralls.io/github/seapagan/confoog?branch=master)
+[![Code Climate](https://codeclimate.com/github/seapagan/confoog/badges/gpa.svg)](https://codeclimate.com/github/seapagan/confoog)
+[![Inline docs](http://inch-ci.org/github/seapagan/confoog.svg?branch=master)](http://inch-ci.org/github/seapagan/confoog)
+
+A simple Gem to add YAML configuration files to your Ruby script / Gem.
+
+__*A WORK IN PROGRESS, Not really ready for production use. The API may be subject to changes before hitting version 1.0.0*__
+
+This will add a class that takes care of all your configuration needs for Ruby scripts and Gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'confoog'
+```
+
+And then execute:
+
+    $ bundle
+
+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.
+```ruby
+require 'confoog'
+
+settings = Confoog::Settings.new
+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.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
+```
+If these are not specified, Confoog will use the following defaults :
+```ruby
+location: '~/'
+filename: '.confoog'
+create_file: false
+prefix: 'Configuration'
+quiet: false
+```
+
+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_CHANGE = 2 # directory and file can only be specified through `.new()`
+ERR_CANT_CREATE_FILE = 4 # cannot create the requested configuration file
+ERR_NOT_WRITING_EMPTY_FILE = 8 # not attempting to save an empty configuration
+ERR_CANT_SAVE_CONFIGURATION = 16 # Failed to save the configuration file
+ERR_NOT_LOADING_EMPTY_FILE = 32 # not atempting to load an empty config 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.
+
+- Restrict configuration variables to a specified subset, or to only those that already exist in the YAML file.
+- A better way of dealing with multi-level variables - i.e. nested arrays, hashes etc.
+- option to save config file after any config variables are changed, not just explicitly with `Confoog::Settings.save`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests (or simply `rake`). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+    spec.add_dependency 'confoog', '~> 1.0'
+
+Of course, currently we have not even reached version 1, so leave off the version requirement completely. Expect any and all of the API and interface to change!
+
+[semver]: http://semver.org/
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new do |task|
+  task.options << 'lib'
+end
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'confoog'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/confoog.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# rubocop:disable LineLength
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'confoog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'confoog'
+  spec.version       = Confoog::VERSION
+  spec.authors       = ['Seapagan']
+  spec.email         = ['seapagan@gmail.com']
+
+  spec.summary       = 'A simple Gem to add YAML configuration files to your Ruby script / Gem'
+  spec.description   = 'A WORK IN PROGRESS, Nowhere near ready for use, and if fact currently will neither load nor save the configuration to file!'
+  spec.homepage      = 'https://github.com/seapagan/confoog'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+end

data/lib/confoog/version.rb

@@ -0,0 +1,4 @@
+# Define the Gem version string
+module Confoog
+  VERSION = '0.1.1'
+end

data/lib/confoog.rb

@@ -0,0 +1,169 @@
+require 'confoog/version'
+require 'yaml'
+
+# Overall module.
+# Contains Class Confoog::Settings
+module Confoog
+  DEFAULT_CONFIG = '.confoog'
+
+  # Error messages to be returned
+  ERR_NO_ERROR = 0
+  ERR_FILE_NOT_EXIST = 1
+  ERR_CANT_CHANGE = 2
+  ERR_CANT_CREATE_FILE = 4
+  ERR_NOT_WRITING_EMPTY_FILE = 8
+  ERR_CANT_SAVE_CONFIGURATION = 16
+  ERR_NOT_LOADING_EMPTY_FILE = 32
+
+  # Info messages to be returned
+  INFO_FILE_CREATED = 256
+  INFO_FILE_LOADED = 512
+
+  OUTPUT_SEVERITY = {
+    ERR: 'Error',
+    WARN: 'Warning',
+    INFO: 'Information'
+  }
+
+  DEFAULT_OPTIONS = {
+    create_file: false,
+    quiet: false,
+    prefix: 'Configuration',
+    location: '~/',
+    filename: DEFAULT_CONFIG
+  }
+
+  # Class : Settings.
+  # Provide an encapsulated class to access a YAML configuration file.
+  # Readers :
+  # .filename = read the config filename for this instance
+  # .location = read the config directory for this instance
+  # .status = Hash containing assorted status variables, read only.
+  class Settings
+    attr_reader :filename, :location, :status
+
+    def initialize(options = {})
+      # merge default options to avoid ambiguity
+      @options = DEFAULT_OPTIONS.merge(options)
+      # set all other unset options to return false instead of Nul.
+      @options.default = false
+
+      @status = {}
+      @location = @options[:location]
+      @filename = @options[:filename]
+
+      @config = {}
+
+      # clear the error condition as default.
+      status_set(errors: ERR_NO_ERROR)
+      # make sure the file exists or can be created...
+      check_exists(options)
+    end
+
+    def quiet
+      @options[:quiet]
+    end
+
+    def quiet=(quiet)
+      @options[:quiet] = quiet
+    end
+
+    def save
+      if @config.count > 0
+        save_to_yaml
+      else
+        console_output("Not saving empty configuration data to #{config_path}",
+                       OUTPUT_SEVERITY[:WARN])
+        status_set(errors: ERR_NOT_WRITING_EMPTY_FILE)
+      end
+    end
+
+    def load
+      @config = YAML.load_file(config_path)
+      status_set(errors: INFO_FILE_LOADED)
+      if @config == false
+        console_output("Configuration file #{config_path} is empty!",
+                       OUTPUT_SEVERITY[:WARN])
+        status_set(errors: ERR_NOT_LOADING_EMPTY_FILE)
+      end
+    rescue
+      console_output("Cannot load configuration data from #{config_path}",
+                     OUTPUT_SEVERITY[:ERR])
+    end
+
+    def location=(*)
+      # dummy method currently to stop changing location by caller once created,
+      # but not raise error.
+      #  - Return an error flag in the ':status' variable.
+      status_set(errors: ERR_CANT_CHANGE)
+      console_output('Cannot change file location after creation',
+                     OUTPUT_SEVERITY[:WARN])
+    end
+
+    def filename=(*)
+      # dummy method currently to stop changing filename by caller once created,
+      # but not raise error.
+      #  - Return an error flag in the ':status' variable.
+      status_set(errors: ERR_CANT_CHANGE)
+      console_output('Cannot change filename after creation',
+                     OUTPUT_SEVERITY[:WARN])
+    end
+
+    def [](key)
+      @config[key]
+    end
+
+    def []=(key, value)
+      @config[key] = value
+    end
+
+    def config_path
+      File.expand_path(File.join(@location, @filename))
+    end
+
+    private
+
+    def console_output(message, severity)
+      return unless @options[:quiet] == false
+      $stderr.puts "#{@options[:prefix]} : #{severity} - #{message}"
+    end
+
+    def save_to_yaml
+      file = File.open(config_path, 'w')
+      file.write(@config.to_yaml)
+      file.close
+    rescue
+      console_output("Cannot save configuration data to #{config_path}",
+                     OUTPUT_SEVERITY[:ERR])
+    end
+
+    def create_new_file
+      File.new(config_path, 'w').close
+      status_set(config_exists: true, errors: INFO_FILE_CREATED)
+    rescue
+      status_set(config_exists: false, errors: ERR_CANT_CREATE_FILE)
+      console_output('Cannot create the specified Configuration file!',
+                     OUTPUT_SEVERITY[:ERR])
+    end
+
+    def status_set(status)
+      status.each do |key, value|
+        @status[key] = value
+      end
+    end
+
+    def check_exists(options)
+      status_set(config_exists: true)
+      return if File.exist?(config_path)
+
+      # file does not exist so we create if requested otherwise error out
+      if options[:create_file] == true
+        create_new_file
+      else
+        status_set(config_exists: false, errors: ERR_FILE_NOT_EXIST)
+        console_output('The specified Configuration file does not exist.',
+                       OUTPUT_SEVERITY[:ERR])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: confoog
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Seapagan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  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: fakefs
+  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: coveralls
+  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: rubocop
+  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'
+description: A WORK IN PROGRESS, Nowhere near ready for use, and if fact currently
+  will neither load nor save the configuration to file!
+email:
+- seapagan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- confoog.gemspec
+- lib/confoog.rb
+- lib/confoog/version.rb
+homepage: https://github.com/seapagan/confoog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A simple Gem to add YAML configuration files to your Ruby script / Gem
+test_files: []
+has_rdoc: