configural 0.0.1

data/lib/configural.rb

@@ -0,0 +1,41 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+
+module Configural
+
+  autoload :App,      'configural/app'
+  autoload :User,     'configural/user'
+  autoload :Config,   'configural/config'
+  autoload :Data,     'configural/data'
+  autoload :Cache,    'configural/data'
+  autoload :Platform, 'configural/platform'
+  autoload :Autosave, 'configural/autosave'
+
+end

data/lib/configural/app.rb

@@ -0,0 +1,97 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+
+module Configural
+
+  class App
+    attr_accessor :name, :path
+    attr_writer :config_path, :cache_path, :data_path
+    attr_reader :user
+
+    def initialize( name )
+      @name = name
+      @user = Configural::User.new(self)
+    end
+
+
+    def cache
+      @cache ||=
+        begin
+          unless @cache_path
+            raise 'you must set cache_path or path first'
+          end
+          Configural::Cache.new(self)
+        end
+    end
+
+    def cache_path
+      @cache_path || (@path and File.join(@path, 'cache'))
+    end
+
+
+    def config
+      @config ||=
+        begin
+          unless @config_path
+            raise 'you must set config_path or path first'
+          end
+          Configural::Config.new(self)
+        end
+    end
+
+    def config_path
+      @config_path || (@path and File.join(@path, 'config'))
+    end
+
+
+    def data
+      @data ||=
+        begin
+          unless @data_path
+            raise 'you must set data_path or path first'
+          end
+          Configural::Data.new(self)
+        end
+    end
+
+    def data_path
+      @data_path || (@path and File.join(@path, 'data'))
+    end
+
+
+    def save_all
+      @config.save_all if @config
+      @user.save_all if @user
+      self
+    end
+
+  end
+
+end

data/lib/configural/autosave.rb

@@ -0,0 +1,100 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+
+module Configural
+
+  class Autosave
+
+    def self.instance
+      @instance ||= new()
+    end
+
+    # Shorthand for Autosave.instance.register
+    def self.register(*args)
+      instance.register(*args)
+    end
+
+    # Shorthand for Autosave.instance.unregister
+    def self.unregister(*args)
+      instance.unregister(*args)
+    end
+
+
+    def initialize
+      @weakrefs = {}
+      @enabled = true
+      at_exit{ self.save_all }
+    end
+
+
+    def register(object, method=:save)
+      require 'weakref'
+      weakref = WeakRef.new(object)
+      @weakrefs[weakref] = method
+      self
+    end
+
+    def unregister(object)
+      @weakrefs.delete_if{ |k,v| k.__id__ == object.object_id }
+      self
+    end
+
+    def unregister_all
+      @weakrefs = {}
+      self
+    end
+
+
+    attr_reader :enabled
+    alias :enabled? :enabled
+
+    def enable
+      @enabled = true
+      self
+    end
+
+    def disable
+      @enabled = false
+      self
+    end
+
+
+    def save_all
+      return self unless @enabled
+      @weakrefs.each do |weakref, method|
+        if weakref.weakref_alive? and weakref.respond_to?(method)
+          weakref.send(method)
+        end
+      end
+      self
+    end
+
+  end
+end

data/lib/configural/config.rb

@@ -0,0 +1,93 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+
+module Configural
+
+  class Config
+
+    attr_accessor :owner, :options
+
+    def initialize( owner )
+      @owner = owner
+      @files = {}
+      @options = {
+        :default_format => 'yaml',
+        :lazy_loading => false,
+      }
+    end
+
+    def path
+      @owner.config_path
+    end
+
+    def [](name)
+      @files[name.to_s] ||= make_file(name.to_s)
+    end
+ 
+   def []=(name, value)
+      @files[name.to_s] = value
+    end
+
+    def save_all
+      @files.each_value{ |file| file.save }
+      self
+    end
+
+    private
+
+    def make_file(name)
+      if File.extname(name).empty?
+        # No file extension, so use the default format.
+        format = FileBase.get_format_by_name(@options[:default_format])
+        # Check all possible extensions, choose the first file that
+        # exists, or use the first file extension if no files exist.
+        paths = format.extnames.collect{ |extname|
+          File.join( self.path, name ) + extname
+        }
+        path = paths.find{ |p| File.exists?(p) } || paths.first
+      else
+        # Has a file extension, so try to find a matching format.
+        format = FileBase.get_format_by_extname(File.extname(name))
+        # Just use the name with already-specified extension.
+        path = File.join(self.path, name)
+      end
+      format.new( path, @options )
+    end
+
+  end
+
+end
+
+
+require 'configural/config/file_base'
+require 'configural/config/json_file'
+require 'configural/config/plist_file'
+require 'configural/config/sdl_file'
+require 'configural/config/yaml_file'

data/lib/configural/config/file_base.rb

@@ -0,0 +1,161 @@
+#--
+#
+# This file is one part of:
+#
+# Configural - Easy configuration file management
+#
+# Copyright (c) 2011  John Croisant
+#
+# 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.
+#
+#++
+
+
+module Configural
+
+  # Base class for abstracting configuration file access. You
+  # shouldn't use this class directly. Use one of the subclasses (e.g.
+  # YAMLFile) instead.
+  # 
+  class Config::FileBase
+
+    def self.inherited(subclass)
+      @subclasses ||= []
+      @subclasses << subclass
+    end
+
+
+    def self.get_format_by_name( format )
+      @subclasses.reverse.find { |subclass|
+        subclass.format == format
+      } or raise "Unrecognized file format: #{format}"
+    end
+
+    def self.get_format_by_extname( extname )
+      @subclasses.reverse.find { |subclass|
+        subclass.extnames.include?(extname)
+      } or raise "Unrecognized file extension: #{extname}"
+    end
+
+
+    def self.format
+      raise 'Method not implemented for base class.'
+    end
+
+    def self.extnames
+      raise 'Method not implemented for base class.'
+    end
+
+
+    require 'enumerator'
+    include Enumerable
+
+    attr_reader :path
+
+    def initialize( path, options )
+      @path = path
+      @options = options
+      @data = {}
+      @loaded = false
+      load unless @options[:lazy_loading]
+    end
+
+
+    def clear
+      @data = {}
+      @loaded = true
+      self
+    end
+
+    def close
+      @data = {}
+      @loaded = false
+      self
+    end
+
+    def delete
+      File.rm(path, :force => true)
+      self
+    end
+
+    def exists?
+      File.exists?(path)
+    end
+    alias :exist? :exists?
+
+    def each(&block)
+      load unless @loaded
+      @data.each(&block)
+    end
+
+    def keys
+      load unless @loaded
+      @data.keys
+    end
+
+    def [](key)
+      load unless @loaded
+      @data[key.to_s]
+    end
+
+    def []=(key, value)
+      load unless @loaded
+      @data[key.to_s] = value
+    end
+
+    def to_hash
+      load unless @loaded
+      @data.dup
+    end
+
+    def load
+      load! unless @loaded
+      self
+    end
+
+    def load!
+      _load
+      @loaded = true
+      self
+    end
+
+    def save
+      _save unless not @loaded
+      self
+    end
+
+    def save!
+      _save
+      self
+    end
+
+    private
+
+    def _load
+      raise 'Method not implemented for base class.'
+    end
+
+    def _save
+      raise 'Method not implemented for base class.'
+    end
+
+  end
+
+end