asetus 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aabab562229de22b1301e26910b4a000a2086a15
+  data.tar.gz: b7fd09d5490ff4a84a3659cc653c02c4a70910ad
+SHA512:
+  metadata.gz: cbc9b3ab70bd09b13c4d99ef328bebe75c2515b01f41c1074e5180f16878fc221db0e2bcb70f7aafa7d41fbfcbd1398383184954acf357e4932c4a38bb4684aa
+  data.tar.gz: 79c8ece12fa2d9a32bb58a1e67ff7cbc7c838aff04355d661cb2220d6f29b7afe8c416ccc76dcf8bad8628e3c19f3cff5863df72ba870b4a62a54a02f9b55644

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+gems

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,50 @@
+# Asetus
+Configuration library for ruby with YAML/JSON backends with unified object
+access
+
+## Install
+```
+ % gem install asetus
+```
+
+## Use
+### Simple
+```
+require 'asetus'
+cfg  = Asetus.cfg
+port = cfg.server.port
+user = cfg.auth.user
+pw   = cfg.auth.password
+```
+It tried to detect your software name via caller_locations if no ':name'
+argument was given.
+It automatically loads /etc/name/config and ~/.config/name/config and merges
+them together.
+
+### Advanced
+```
+require 'asetus'
+asetus = Asetus.new name:    'mykewlapp',
+                    default: {'poop'=>'xyzzy'},
+                    adapter: 'yaml',
+                    usrdir:  '/home/app/config/',
+                    sysdir:  '/System/config/',
+                    load:    false
+asetus.default.poop2 = [1, 2, 3, 4]
+asetus.default.starship.poopoers = 42
+asetus.load :user
+if asetus.user.empty?
+  asetus.user = asetus.default
+  asetus.save :user
+end
+asetus.load    # load+merges cfg, takes argument :default, :system, :user
+asetus.cfg     # merged default + system + user  (merged on load)
+asetus.default # default only
+asetus.system  # system only
+asetus.user    # user only
+```
+
+## TODO
+
+  * should I add feature to raise on unconfigured/unset?
+  * should I always merge to 'cfg' when default/system/config is set?

data/Rakefile

@@ -0,0 +1,47 @@
+begin
+  require 'rake/testtask'
+  require 'bundler'
+  Bundler.setup
+rescue LoadError
+  warn 'bunler missing'
+  exit 42
+end
+
+gemspec = eval(File.read(Dir['*.gemspec'].first))
+file    = [gemspec.name, gemspec.version].join('-') + '.gem'
+
+desc 'Validate gemspec'
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Run minitest'
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs.push "lib"
+    t.test_files = FileList['spec/*_spec.rb']
+    t.verbose = true
+  end
+end
+
+desc 'Build gem'
+task :build do
+  system "gem build #{gemspec.name}.gemspec"
+  FileUtils.mkdir_p 'gems'
+  FileUtils.mv file, 'gems'
+end
+
+desc 'Install gem'
+task :install => :build do
+  system "sudo -E sh -c \'umask 022; gem install gems/#{file}\'"
+end
+
+desc 'Remove gems'
+task :clean do
+  FileUtils.rm_rf 'gems'
+end
+
+desc 'Push to rubygems'
+task :push do
+  system "gem push gems/#{file}"
+end

data/asetus.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name              = 'asetus'
+  s.version           = '0.0.1'
+  s.platform          = Gem::Platform::RUBY
+  s.authors           = [ 'Saku Ytti' ]
+  s.email             = %w( saku@ytti.fi )
+  s.homepage          = 'http://github.com/ytti/asetus'
+  s.summary           = 'configuration library'
+  s.description       = 'configuration library with object access to YAML/JSON/CSON backends'
+  s.rubyforge_project = s.name
+  s.files             = `git ls-files`.split("\n")
+  s.executables       = %w(  )
+  s.require_path      = 'lib'
+
+  s.add_dependency 'slop'
+end

data/lib/asetus/adapter/json.rb

@@ -0,0 +1,27 @@
+class Asetus
+
+  def to_json config
+    Adapter::JSON.to config._asetus_to_hash
+  end
+
+  def from_json json
+    Adapter::JSON.from json
+  end
+
+  class Adapter
+    class JSON
+      class << self
+        def to hash
+          require 'json'
+          ::JSON.pretty_generate hash
+        end
+
+        def from json
+          require 'json'
+          ::JSON.load json
+        end
+      end
+    end
+  end
+
+end

data/lib/asetus/adapter/yaml.rb

@@ -0,0 +1,27 @@
+class Asetus
+
+  def to_yaml config
+    Adapter::YAML.to config._asetus_to_hash
+  end
+
+  def from_yaml yaml
+    Adapter::YAML.from yaml
+  end
+
+  class Adapter
+    class YAML
+      class << self
+        def to hash
+          require 'yaml'
+          ::YAML.dump hash
+        end
+
+        def from yaml
+          require 'yaml'
+          ::YAML.load yaml
+        end
+      end
+    end
+  end
+
+end

data/lib/asetus/configstruct.rb

@@ -0,0 +1,58 @@
+class Asetus
+  class ConfigStruct
+
+    def _asetus_to_hash
+      hash = {}
+      @cfg.each do |key, value|
+        if value.class == ConfigStruct
+          value = value._asetus_to_hash
+        end
+        hash[key] = value
+      end
+      hash
+    end
+
+    def empty?
+      @cfg.empty?
+    end
+
+    private
+
+    def initialize hash=nil
+      @cfg = hash ? _asetus_from_hash(hash) : {}
+    end
+
+    def method_missing name, *args, &block
+      name = name.to_s
+      arg = args.first
+      if name[-1..-1] == '='
+        _asetus_set name[0..-2], arg
+      else
+        _asetus_get name, arg
+      end
+    end
+
+    def _asetus_set key, value
+      @cfg[key] = value
+    end
+
+    def _asetus_get key, value
+      if @cfg.has_key? key
+        @cfg[key]
+      else
+        @cfg[key] = ConfigStruct.new
+      end
+    end
+
+    def _asetus_from_hash hash
+      cfg = {}
+      hash.each do |key, value|
+        if value.class == Hash
+          value = _asetus_from_hash value
+        end
+        cfg[key] = value
+      end
+    end
+
+  end
+end

data/lib/asetus.rb

@@ -0,0 +1,97 @@
+require_relative 'asetus/configstruct'
+require_relative 'asetus/adapter/yaml'
+require_relative 'asetus/adapter/json'
+require 'fileutils'
+
+class AsetusError < StandardError; end
+class NoName < AsetusError; end
+
+class Asetus
+  CONFIG_FILE = 'config'
+  attr_reader :cfg, :default
+  attr_accessor :system, :user
+
+  class << self
+    def cfg *args
+      new(*args).cfg
+    end
+  end
+
+  def load level=:all
+    if level == :default or level == :all
+      @cfg = merge @cfg, @default
+    end
+    if level == :system or level == :all
+      @system = load_cfg @sysdir
+      @cfg = merge @cfg, @system
+    end
+    if level == :user or level == :all
+      @user = load_cfg @usrdir
+      @cfg = merge @cfg, @user
+    end
+  end
+
+  def save level=:user
+    if level == :user
+      save_cfg @usrdir, @user
+    elsif level == :system
+      save_cfg @sysdir, @system
+    end
+  end
+
+  private
+
+  def initialize opts={}
+    @name     = (opts.delete(:name)    or metaname)
+    @adapter  = (opts.delete(:adapter) or 'yaml')
+    @usrdir   = (opts.delete(:usrdir)  or File.join(Dir.home, '.config', @name))
+    @sysdir   = (opts.delete(:sysdir)  or File.join('/etc', @name))
+    @default  = ConfigStruct.new opts.delete(:default)
+    @system   = ConfigStruct.new
+    @user     = ConfigStruct.new
+    @cfg      = ConfigStruct.new
+    @load     = true
+    @load     = opts.delete(:load) if opts.has_key?(:load)
+    load :all if @load
+  end
+
+  def load_cfg dir
+    file = File.join dir, CONFIG_FILE
+    file = File.read file
+    ConfigStruct.new from(@adapter, file)
+  rescue Errno::ENOENT
+    ConfigStruct.new
+  end
+
+  def save_cfg dir, config
+    config = to(@adapter, config)
+    file   = File.join dir, CONFIG_FILE
+    FileUtils.mkdir_p dir
+    File.write file, config
+  end
+
+  def merge *configs
+    hash = {}
+    configs.each do |config|
+      hash = hash.merge config._asetus_to_hash
+    end
+    ConfigStruct.new hash
+  end
+
+  def from adapter, string
+    name = 'from_' + adapter
+    send name, string
+  end
+
+  def to adapter, config
+    name = 'to_' + adapter
+    send name, config
+  end
+
+  def metaname
+    path = caller_locations[-1].path
+    File.basename path, File.extname(path)
+  rescue
+    raise NoName, "can't figure out name, specify explicitly"
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: asetus
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Saku Ytti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: configuration library with object access to YAML/JSON/CSON backends
+email:
+- saku@ytti.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- asetus.gemspec
+- lib/asetus.rb
+- lib/asetus/adapter/json.rb
+- lib/asetus/adapter/yaml.rb
+- lib/asetus/configstruct.rb
+homepage: http://github.com/ytti/asetus
+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: asetus
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: configuration library
+test_files: []