yaconfig 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWVjZmY5NGMzNGE2NjhmNjk1NDQ3NzJhNTJjMzhjYzYxODZkMjE2OA==
+  data.tar.gz: !binary |-
+    MTdiYzI5ZTU2MGFlZGQwMTcxNmNlMWE4OWJjNTAyZDYzYmJjNmE2MQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MGMxOGVmMmJiZGI1NzQxNmJkZDM2ODcwNDhlMGUzNThhMTcxMzNjOGM0Nzhl
+    MGM4OTg5MmVlMTNiOTZkMzhiMWZlZjIwNTY5YjAyNWRmOTVmYWU1MjkxYjMz
+    MjA2ODNlYjk0YzdhOTdjYWU0NjVlZjA3N2YzMTBlYzdjOWMyMTk=
+  data.tar.gz: !binary |-
+    NTRhODQ5NTRkZDQzMjU2MTZiNWJhN2UyMGRjYzNjNmRjNDNjOGEyNDk0YWFk
+    NjZlMGE1ODc2YmVjMDYzOGY1YjMyZWEzN2U1NzJkZTQ4MTc4MTZmMDFiZGFm
+    YjU4ZjlkOWZlM2Y3YzgxODFmMmE1OTZhMjE4MzVjYjk4MzM4MTA=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Torkelson
+
+MIT License
+
+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,204 @@
+# Yet Another Configuration Gem (yaconfig)
+
+Why another one? I wanted a config gem for my little utilities I write for people that was both simple,
+but still provided a file loading interface that would merge configuration files.
+
+The config store is mostly a [SymbolTable](https://github.com/mjijackson/symboltable) wrapped with some utilities.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yaconfig'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaconfig
+
+And require it:
+
+    require 'yaconfig'
+
+## Usage
+
+In it's most basic useage it's simply a class that acts as a hash
+with some magic to both convert the hash keys into symbols, and to
+dynamically create accessors.
+    
+    conf = Yaconfig::Configuration.new
+    conf.something = 'my configuration value'
+    conf.email = 'so-and-so@stupid-spammers.com'
+    
+### New
+
+The new accepts both a hash as an argument to be converted into the
+configuration, and the block style as well.
+
+    conf = Yaconfig::Configuration.new({:email => 'so-and-so@stupid-spammers.com',
+        :otherthing => 'other value'})
+
+    conf = Yaconfig::Configuration.new { |c|
+        c.something = 'my configuration value'
+        c.email = 'so-and-so@stupid-spammers.com'
+    }
+
+### Access to Data
+
+You can use various forms to access the data, both the \[\] hash notation, and the
+quicker dot notation. This is for both setting and reading.
+
+    puts conf.email
+    puts conf[:email]
+
+#### Nesting
+
+The class allows nesting, so you can do the following:
+
+    conf.datacenter = {}
+    conf.datacenter.address = '555 Wheee Street'
+    conf.datacenter.phone_number = '555-555-5555'
+
+Note the first line. I experimented with auti-creating the middle elements of these, such 
+as the datacenter here, but that caused non-existant elements to no longer return `nil`. 
+So as a limitation before you can assign to a sub container, you must initialize it.
+
+### Loading Files
+
+One of the important features of the gem is the ability to load and merge configurations. 
+It supports two formats: ruby and json.
+
+#### Ruby
+
+Ruby configuration files are simply evaluated with a `config` object accessable to the file.
+It is not really sandboxed at all. So don't use this if you don't trust the source of your
+config files.
+
+In your program:
+
+    conf.load_config(
+        "./%basename%.conf",
+        "%basedir%/../etc/%basename%.conf",
+        "%basedir%/../etc/%basename%/%basename%.conf", # debian style
+        "/etc/%basename%.conf",
+        "/etc/%basename%/%basename%.conf",
+        "~/.%basename%.rc"
+        )
+
+Substitutions:
+* %basename% - This is the command the user called, minus the extension .rb if it exists.
+* %basedir% - This is the directory the command was in.
+* ~ - User's home directory.
+
+This will attempt to load each of the files in order, and the results get merged. So if you
+want ~/.myapp.rc to have final say, you list it last.
+
+The config file can do anything ruby can do, for better or worse. An example:
+
+    config.movie = 'The Sound of Music'
+    config.list = 1..10
+
+If the config file does not exist, it's skipped, so it's ok to list anything you might want.
+
+#### JSON
+
+Good for automatically generated configs, or if you don't trust the ruby someone might stick in
+their config.
+
+From raw JSON in a string:
+
+    conf.configure_json(json_data)
+
+From files:
+
+    conf.load_config_json(
+        "./%basename%.json",
+        "%basedir%/../etc/%basename%.json",
+        "%basedir%/../etc/%basename%/%basename%.json", # debian style
+        "/etc/%basename%.json",
+        "/etc/%basename%/%basename%.json",
+        "~/.%basename%.rc"
+        )
+
+#### Blocks
+
+If you want to pass it another block to merge in, you can use:
+
+    conf.configure {
+        # ...
+    }
+    
+Just like with new. See above.
+
+#### Hases
+
+You can feed it additional hashes with `merge!`
+
+    conf.merge!({:whatever => 'something'})
+
+### Other stuff
+
+I included a short cut to pretty-print in json format the config for debugging
+use. You can use it with:
+
+    puts conf.to_json_pretty
+
+If you don't like the way I come up with the base-name, you can set it manually with:
+
+    conf.basename = 'myProgram'
+
+Naturally you can check to see what it generated on it's own with:
+
+    puts conf.basename
+
+You can set the verbosity of the gem with:
+
+    conf.verbose = 1
+
+It expects `nil`, `false`, or a integer. 1 causes it to tell you what config files it
+loaded. 2 causes it to also tell you which ones it could not load.
+
+### Suggested Usage
+
+Not that I want to tell you how to code, but this is how I use it:
+
+    # I like to assign it to a constant to make it stand out, and accessable
+    CFG = Yaconfig::Configuration.new { |c|
+        # Create any sub containers that you expect your users to use.
+        c.datacenter = {}
+        c.user_info = {}
+        
+        # Set any defaults.
+        c.email = 'no-reply@no-such-domain.com'
+    }
+
+Then load your user's configs as shown above.
+
+If you are parsing options with something like Slop or whatever floats your boat, it
+becomes trivial to add a config switch:
+
+    CFG.load_config(opts[:config]) if opts[:config]
+
+## Todo
+
+* Fix any bugs that are found.
+* Do proper in-line documentation in the code.
+
+## Contributing
+I'm not scared of feedback. Usually. I only bite a little. :)
+
+### By Suggesting Improvments and Reporting Bugs
+
+Use the github issue tracker. No promises on how fast I'll deal with either. I have
+a job and all that. :)
+
+### By Writing Code
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/version_task"
+Rake::VersionTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/lib/yaconfig.rb

@@ -0,0 +1,107 @@
+require "yaconfig/version"
+
+require 'symboltable'
+require 'json'
+
+module Yaconfig
+  class Configuration < SymbolTable 
+
+    # Legacy module to recieve constants
+    attr_accessor :base_name, :verbose
+
+    # Setup @data. Accept an optional hash of config.
+    def initialize(data=nil, &block)
+      # Base name of the program, minus .rb if any.
+      @base_name = File::basename($0)
+      @base_name = @base_name[0..-4] if @base_name =~ /\.rb$/
+
+      # Off by default
+      @verbose = false
+
+      # List of loaded config files
+      @configs = []
+
+      # Install any passed data into the SymbolTable
+      r = super(data)
+
+      # Do a block style config, if any
+      block.call(self) if block_given?
+
+      # Return what super gave us.
+      return r
+    end
+
+    # On the fly creation of sub containers.
+    #
+    # downside is it kills config.x.y #=> nil
+    # so I have left this out until I can magically figure out I'm on the
+    # left side of the expression.
+
+    # def method_missing(method, *args, &block)
+    #   rv = super
+    #   if !rv
+    #     store(method, {})
+    #     super
+    #   end
+    # end
+
+    # Use a block-style configure setup. 
+    #
+    # config.configure do |c|
+    #   c.whatever = a_value
+    # end
+    def configure(&block)
+        raise "No block given to configure." if !block_given?
+
+        block.call(self)
+    end
+
+    # Search a list of files, and load any that exist. Provides
+    # the object as 'config'
+    def load_config(*args)
+      args.flatten.each{ |f| load_config_file(f) }
+    end
+
+    # JSON support
+    def configure_json(json_text)
+      self.merge!(JSON.parse(json_text))
+    end
+
+    def to_json_pretty()
+      JSON.pretty_generate(self)
+    end
+
+    def load_config_json(*args)
+      args.flatten.each{ |f| 
+        configure_json(File.new(f, 'r').read) if File.exists?(f) 
+      }
+    end
+
+    private # ----------------------------------
+
+    # expand path
+    def expand_path(file)
+      file.gsub!(/\%basedir\%/, File.dirname(File.expand_path($0)))
+      file.gsub!(/\%basename\%/, @base_name)
+      File.expand_path(file)
+    end
+
+    # Used by load_config
+    def load_config_file(filename)
+      config = self
+
+      filename = expand_path(filename)
+
+      return if @configs.include?(filename) 
+
+      if File.exists?(filename)
+        puts "Loading config from: #{filename}" if @verbose
+        eval File.new(filename, "r").read
+        @configs << filename
+      else
+        puts "Config file does not exist: #{filename}" if @verbose && @verbose >= 2
+      end
+    end
+
+  end
+end

data/lib/yaconfig/version.rb

@@ -0,0 +1,6 @@
+require 'version'
+
+module Yaconfig
+  is_versioned
+  #VERSION = '0.0.1'
+end

data/yaconfig.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yaconfig/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Peter Torkelson"]
+  gem.email         = ["peter.torkelson@gmail.com"]
+  gem.description   = %q{Yet Another Configuration gem.}
+  gem.summary       = %q{Handles both configuration storage and loading.}
+  gem.homepage      = "https://github.com/WhiteFire-Sondergaard/yaconfig"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "yaconfig"
+  gem.require_paths = ["lib"]
+  gem.version       = Yaconfig::VERSION
+
+  gem.add_dependency('symboltable', '>= 1.0.2')
+  gem.add_dependency('version', '>= 1.0.0')
+  gem.add_dependency('json', '>= 1.7.5')
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: yaconfig
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Peter Torkelson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: symboltable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
+description: Yet Another Configuration gem.
+email:
+- peter.torkelson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/yaconfig.rb
+- lib/yaconfig/version.rb
+- yaconfig.gemspec
+homepage: https://github.com/WhiteFire-Sondergaard/yaconfig
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Handles both configuration storage and loading.
+test_files: []