asetus 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a35c4aaaa3dcbbb3cebc0d3739e0bbea12dbf516
-  data.tar.gz: df049bdce93f3d388e556e82af8bf16babfc2210
+  metadata.gz: ffddca763a36284504ce06cc389c15fb12dfd823
+  data.tar.gz: 47fde4f5d41ceccf13a910d9b13e2f14beaba9f3
 SHA512:
-  metadata.gz: 6826d9593bc2fd0475b476ff2324840641859afab3340c2623e8a5119b96b86bf21173ef222b2a26d5b39735c9eac77a2022e28e5dced6623ce97223a2d539a5
-  data.tar.gz: 9aa66d652a42552230d5f8dd0d0ff076257943e2d17f7d0409f5f02263491b246b328bae0929fb4840b123e4cb6b8e9e814eb76ca792be78e11db78d381896c4
+  metadata.gz: 2992513481cbabfbef49fe4fd3e67413a6292e800c6305d70025c52c5b885d7e54ccef04ed79872301517cd3558e58e83de352ade7a6c2c89ecf0e3632a67bd2
+  data.tar.gz: 4dbe149a790b539b24607003e6b744ba81c0e341dd12eb53296822e3f47f22d8451fe516e6bfc88d4708409c2044fd27ea9bc2a387ed8d862de7dd8dc261c38a

data/README.md

@@ -44,6 +44,14 @@ asetus.system  # system only
 asetus.user    # user only
 ```
 
+## Reserved methods
+
+* each           - iterate all config keys in current level
+* has_key?(arg)  - check if current level has key arg
+* [arg]          - fetch arg (useful for non-literal retrieval, instead of using #send)
+* key?           - all keys have question mark version reserved, checks if key exists+true (true), exists+false (false), not-exists (nil)
++ all object class methods
+
 ## TODO
 
   * should I add feature to raise on unconfigured/unset?

data/asetus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name              = 'asetus'
-  s.version           = '0.0.6'
+  s.version           = '0.0.7'
   s.platform          = Gem::Platform::RUBY
   s.authors           = [ 'Saku Ytti' ]
   s.email             = %w( saku@ytti.fi )

data/lib/asetus.rb

@@ -7,6 +7,20 @@ class AsetusError < StandardError; end
 class NoName < AsetusError; end
 class UnknownOption < AsetusError; end
 
+# @example common use case
+#   CFGS = Asetus.new :name=>'my_sweet_program' :load=>false   # do not load config from filesystem
+#   CFGS.default.ssh.port      = 22
+#   CFGS.default.ssh.hosts     = %w(host1.example.com host2.example.com)
+#   CFGS.default.auth.user     = lana
+#   CFGS.default.auth.password = dangerzone
+#   CFGS.load  # load system config and user config from filesystem and merge with defaults to #cfg
+#   raise StandardError, 'edit ~/.config/my_sweet_program/config' if CFGS.create  # create user config from default config if no system or user config exists
+#   # use the damn thing
+#   CFG = CFGS.cfg
+#   user      = CFG.auth.user
+#   password  = CFG.auth.password
+#   ssh_port  = CFG.ssh.port
+#   ssh_hosts = CFG.ssh.hosts
 class Asetus
   CONFIG_FILE = 'config'
   attr_reader :cfg, :default
@@ -18,6 +32,12 @@ class Asetus
     end
   end
 
+  # When this is called, by default :system and :user are loaded from
+  # filesystem and merged with defefault, so that user overrides system which
+  # overrides default
+  #
+  # @param [Symbol] level which configuration level to load, by defaukt :all
+  # @return [void]
   def load level=:all
     if level == :default or level == :all
       @cfg = merge @cfg, @default
@@ -32,6 +52,8 @@ class Asetus
     end
   end
 
+  # @param [Symbol] level which configuration level to save, by default :user
+  # @return [void]
   def save level=:user
     if level == :user
       save_cfg @usrdir, @user
@@ -40,8 +62,39 @@ class Asetus
     end
   end
 
+  # @example create user config from default config and raise error, if no config was found
+  #   raise StandardError, 'edit ~/.config/name/config' if asetus.create
+  # @param [Hash] opts options for Asetus
+  # @option opts [Symbol]  :source       source to use for settings to save, by defaylt :default
+  # @option opts [Symbol]  :destination  destinatino to use for settings to save, by default :user
+  # @option opts [boolean] :load         load config once saved, by default false
+  # @return [boolean] true if config didn't exist and was created, false if config already exists
+  def create opts={}
+    src   = opts.delete :source
+    src ||= :default
+    dst   = opts.delete :destination
+    dst ||= :user
+    no_config = false
+    no_config = true if @system.empty? and @user.empty?
+    if no_config
+      src = instance_variable_get '@' + src.to_s
+      instance_variable_set('@'+dst.to_s, src.dup)
+      save dst
+      load if opts.delete :load
+    end
+    no_config
+  end
+
   private
 
+  # @param [Hash] opts options for Asetus.new
+  # @option opts [String]  :name     name to use for asetus (/etc/name/, ~/.config/name/) - autodetected if not defined
+  # @option opts [String]  :adapter  adapter to use 'yaml' or 'json' for now
+  # @option opts [String]  :usrdir   directory for storing user config ~/.config/name/ by default
+  # @option opts [String]  :sysdir   directory for storing system config /etc/name/ by default
+  # @option opts [Hash]    :default  default settings to use
+  # @option opts [boolean] :load     automatically load+merge system+user config with defaults in #cfg
+  # @option opts [boolean] :key_to_s convert keys to string by calling #to_s for keys
   def initialize opts={}
     @name     = (opts.delete(:name)    or metaname)
     @adapter  = (opts.delete(:adapter) or 'yaml')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asetus
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Saku Ytti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop