configit 0.1.0

data/.bnsignore

@@ -0,0 +1,16 @@
+# The list of files that should be ignored by Mr Bones.
+# Lines that start with '#' are comments.
+#
+# A .gitignore file can be used instead by setting it as the ignore
+# file in your Rakefile:
+#
+#   PROJ.ignore_file = '.gitignore'
+#
+# For a project with a C extension, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+announcement.txt
+coverage
+doc
+pkg

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2009-08-05
+
+* 1 major enhancement
+  * Birthday!

data/README.txt

@@ -0,0 +1,77 @@
+configit
+    by Kris Rasmussen
+    http://www.aptana.com
+
+== DESCRIPTION:
+
+The purpose of this gem is to make it very easy to consume configuration files
+and define them.
+
+== FEATURES/PROBLEMS:
+
+* Easilly define config attributes directly on the class
+* Provides validation of configs
+* Automatically converts attributes to the correct type
+* Enables you to access attribute values as attributes on the class instance
+* Load config from files, strings, or IO
+* Can turn on or off ERB evaluation before loading from yaml
+* Treats strings / symbol keys as equivalent from yaml config
+
+== SYNOPSIS:
+
+  class MyConfig << Configit::Base
+    attribute :foo, :required => true
+    attribute :bar, "Some description", :type => :integer, :default => 10
+    attribute :log_level, "Set the log level", :default => :debug, :type => :symbol
+  end
+
+  config = MyConfig.load_from_file("/etc/myconfig")
+  
+  config.foo
+  config.bar
+  config.log_level
+
+  config.foo = "new value"
+
+  config.valid # true or false
+  config.errors.each do |error|
+    puts error.message
+    puts error.attribute.name
+  end
+
+== REQUIREMENTS:
+
+== TODO:
+
+* Implement type validation
+* Enable easy printing of errors
+* Add colorization to error messages
+
+== INSTALL:
+
+  sudo gem install krisr-configit --source gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Kris Rasmussen
+
+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/Rakefile

@@ -0,0 +1,31 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'configit'
+
+task :default => 'spec:run'
+
+PROJ.name = 'configit'
+PROJ.authors = 'Kris Rasmussen'
+PROJ.email = 'kris@aptana.com'
+PROJ.url = 'http://www.aptana.com'
+PROJ.version = Configit::VERSION
+PROJ.rubyforge.name = 'configit'
+PROJ.ignore_file = '.gitignore'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/configit

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib configit]))
+
+# Put your code here
+
+# EOF

data/configit.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{configit}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kris Rasmussen"]
+  s.date = %q{2009-10-08}
+  s.default_executable = %q{configit}
+  s.description = %q{The purpose of this gem is to make it very easy to consume configuration files
+and define them.}
+  s.email = %q{kris@aptana.com}
+  s.executables = ["configit"]
+  s.extra_rdoc_files = ["History.txt", "README.txt", "bin/configit"]
+  s.files = [".DS_Store", ".bnsignore", "History.txt", "README.txt", "Rakefile", "bin/configit", "lib/configit.rb", "lib/configit/attribute_definition.rb", "lib/configit/base.rb", "lib/configit/exceptions.rb", "spec/configit/base_spec.rb", "spec/configit_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "test/test_configit.rb"]
+  s.homepage = %q{http://www.aptana.com}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{configit}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{The purpose of this gem is to make it very easy to consume configuration files and define them}
+  s.test_files = ["test/test_configit.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
+    else
+      s.add_dependency(%q<bones>, [">= 2.5.1"])
+    end
+  else
+    s.add_dependency(%q<bones>, [">= 2.5.1"])
+  end
+end

data/lib/configit.rb

@@ -0,0 +1,51 @@
+
+module Configit
+
+  # :stopdoc:
+  VERSION = '0.1.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+end  # module Configit
+
+require Configit.libpath('configit/exceptions')
+require Configit.libpath('configit/attribute_definition')
+require Configit.libpath('configit/base')
+
+# EOF

data/lib/configit/attribute_definition.rb

@@ -0,0 +1,38 @@
+module Configit
+  # The definition of an attribute in a config.
+  class AttributeDefinition
+    attr_reader :name
+    attr_reader :desc
+    attr_reader :default
+    attr_reader :type
+    
+    # See Configit::Base.attribute
+    def initialize(name, desc, options={})
+      # Clone them so we can delete from the hash
+      options = options.clone
+
+      raise ArgumentError, "Name must be a symbol" if not Symbol === name
+
+      @name = name
+      @desc = desc
+      @required = options.delete(:required) || false
+      @type = options.delete(:type) || :string
+      @default = options.delete(:default)
+
+      if options.any?
+        raise ArgumentError, "Invalid options #{options.keys.join(',')}"
+      end
+    end
+
+    def required?
+      @required
+    end
+  
+    # Returns an error string if the value is not valid per this AttributeDefinition
+    def validate(value)
+      return "#{name} is a required attribute" if required? && value == nil || value == ""
+      # TODO: add type validation here
+      nil
+    end
+  end
+end

data/lib/configit/base.rb

@@ -0,0 +1,168 @@
+require 'erb'
+require 'yaml'
+
+module Configit
+  # The base class the custom configuration classes should derive from.
+  # 
+  # === Example
+  #
+  #   class FooConfig < Configit::Base
+  #     attribute :name, "The name of the user", :required => true
+  #     attribute :port, :required => true, :type => :integer, :default => 80
+  #     attribute :log_level, :type => :symbol, :default => :debug
+  #   end
+  class Base
+    @@converters ||= {
+      :string  => lambda {|v| v.to_s},
+      :integer => lambda {|v| v.to_i},
+      :float   => lambda {|v| v.to_f},
+      :symbol  => lambda {|v| v.to_sym}
+    }
+
+    # Returns the attributes defined for this class.
+    def attributes
+      @attributes ||= {}
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    def clear_errors
+      @errors = []
+    end
+
+    def ensure_valid!
+      if !valid?
+        message = "#{self.class.name} config invalid. #{self.errors.first}"
+        raise ArgumentError, message
+      end
+      true
+    end
+
+    # Returns true if there are no errors, false otherwise
+    def valid?
+      clear_errors
+
+      unknown_attributes = attributes.keys - schema.keys
+      unknown_attributes.each do |key|
+        errors << "#{key} is not a valid attribute name"
+      end
+
+      schema.values.each do |attribute|
+        if error = attribute.validate(attributes[attribute.name])
+          errors << error
+        end
+      end
+      
+      errors.empty?
+    end
+
+    def schema
+      self.class.schema
+    end
+
+    class << self
+      # Returns a hash of Configit::AttributeDefinition's keyed by attribute name.
+      def schema
+        @schema ||= {}
+      end
+
+      def evaluate_erb=(value)
+        raise ArgumentError unless value == true || value == false
+        @evaluate_erb = value
+      end
+
+      # Loads the config from a YAML string.
+      # 
+      # Unrecognized attributes are placed into the errors list.
+      def load_from_string(string)
+        config = self.new
+        string = ERB.new(string).result unless @evaluate_erb == false
+        (YAML.load(string) || {}).each do |key,value|
+          key = key.to_sym
+          config.attributes[key] = value
+        end
+        return config
+      end
+
+      # Load the config from a file.
+      def load_from_file(filename)
+        raise ArgumentError, "File #{filename} does not exist"  unless File.exists?(filename)
+        raise ArgumentError, "File #{filename} is not readable" unless File.readable?(filename)
+
+        return load_from_string(IO.read(filename))
+      end
+
+      # Same as load_from_string except it will raise an ArgumentError if the
+      # config is not valid
+      def load_from_string!(string)
+        config = load_from_string(string)
+        config.ensure_valid!
+        config
+      end
+
+      # Same as load_from_file except it will raise an ArgumentError if the
+      # config is not valid.
+      def load_from_file!(filename)
+        config = load_from_file(filename)
+        config.ensure_valid!
+        config
+      end
+
+      # Defines a new attribute on the config.
+      # 
+      # The first argument should be the name of the attribute.
+      # 
+      # If the next argument is a string it will be interpreted as the
+      # description of the argument.
+      #
+      # The last argument should be a valid options hash.
+      #
+      # === Valid options
+      #
+      # [:required]
+      #   Determines if the option is required or not. Should be either
+      #   true or false
+      # [:type]
+      #   The type of the attribute. Should be one of :integer, :string
+      #   :symbol, :float
+      def attribute(name, desc=nil, options={})
+        raise AttributeAlreadyDefined, name if schema.has_key? name
+        
+        if options == {} && Hash === desc
+          options = desc
+          desc = nil
+        end
+
+        attr = AttributeDefinition.new(name, desc, options)
+        schema[name] = attr
+
+
+        @attribute_module ||= begin
+          m = Module.new 
+          include m
+          m
+        end
+
+        @attribute_module.class_eval do
+          define_method name do
+            value = attributes[name]
+            if value != nil
+              @@converters[attr.type].call(value)
+            else
+              value
+            end
+          end
+
+          define_method "#{name}=" do |value| 
+            attributes[name] = value
+            value
+          end
+        end
+
+        return attr
+      end
+    end
+  end
+end