configit 0.1.0

data/lib/configit/exceptions.rb

@@ -0,0 +1,5 @@
+module Configit
+  class ConfigitException < Exception; end
+  class AttributeAlreadyDefined < ConfigitException; end
+  class ArgumentError < ::ArgumentError; end
+end

data/spec/configit/base_spec.rb

@@ -0,0 +1,222 @@
+require File.join(File.dirname(__FILE__), %w[.. spec_helper])
+
+require 'tempfile'
+
+describe Configit::Base do
+  before :each do
+    Object.send(:remove_const, :FooConfig) if Object.const_defined? :FooConfig
+    class FooConfig < Configit::Base; end
+  end
+
+  describe "class.attribute" do
+    before do
+      @foo = FooConfig.attribute :foo, "Foo description",
+                                  :required => true, 
+                                  :type => :integer
+      @bar = FooConfig.attribute :bar
+    end
+
+    it "should add the attribute to the schema of the class" do
+      FooConfig.schema[:foo].should == @foo
+    end
+
+    it "should define the attribute successfully" do
+      @foo.should_not be_nil
+      @foo.should be_a Configit::AttributeDefinition
+    end
+
+    it "should set the name of the attribute" do
+      @foo.name.should == :foo
+    end
+
+    it "should set the desc of the attribute" do
+      @foo.desc.should == "Foo description"
+    end
+
+    it "should set the required state of the attribute" do
+      @foo.required?.should == true
+    end
+    
+    it "should set the type of the attribute" do
+      @foo.type.should == :integer
+    end
+
+    it "should add an attribute accessor to the class for the attribute" do
+      config = FooConfig.new
+      config.respond_to?(:foo).should be_true
+      config.respond_to?(:foo=).should be_true
+    end
+
+    it "should properly convert the type of attribute on read and set" do
+      FooConfig.attribute :integer, :type => :integer
+      FooConfig.attribute :string,  :type => :string
+      FooConfig.attribute :symbol,  :type => :symbol
+      FooConfig.attribute :float,   :type => :float
+
+      config = FooConfig.new
+
+      config.integer = "3"
+      config.attributes[:integer].should == "3"
+      config.integer.should == 3
+      config.integer = 3
+      config.integer.should == 3
+      config.integer = 3.3
+      config.integer.should == 3
+      config.integer = "foo"
+      config.integer.should == 0
+
+      # Need to test rest of conversions
+      pending
+    end
+
+    it "should set type to :string by default" do
+      @bar.type.should == :string
+    end
+
+    it "should set required to false by default" do
+      @bar.required?.should == false
+    end
+
+    it "should raise an AttributeAlreadyDefined exception when an attribute is
+        defined twice" do
+      lambda {
+        FooConfig.attribute :foo
+      }.should raise_error(Configit::AttributeAlreadyDefined)
+    end
+  end
+  
+  it "should enforce that required attributes are present" do
+    FooConfig.attribute :foo, :required => true
+    config = FooConfig.load_from_string("")
+    config.valid?.should be_false
+  end
+
+  it "should be valid when non required attributes are abset" do
+    FooConfig.attribute :foo, :required => false
+    config = FooConfig.load_from_string("")
+    config.valid?.should be_true
+  end
+
+  describe ".load_from_string!" do
+    it "should raise an ArgumentError if the config is not valid" do
+      lambda {
+        FooConfig.load_from_string! "asdfasdf: adf"
+      }.should raise_error(ArgumentError, /asdfasdf/)
+    end
+  end
+  
+  describe ".load_from_file!" do
+    it "should raise an ArgumentError if the config is not valid" do
+      file = Tempfile.new("config")
+      file.write "foo1: bar"
+      file.flush
+      file.close
+      lambda {
+        config = FooConfig.load_from_file!(file.path)
+      }.should raise_error(ArgumentError, /foo1/)
+    end
+  end
+
+  describe ".load_from_string" do
+    before do
+      FooConfig.attribute :foo, :type => :integer
+      FooConfig.attribute :bar, :type => :string
+    end
+
+    it "should load a valid yaml config from a string successfully" do
+      config = FooConfig.load_from_string %q{
+                  foo: 3
+                  bar: bar value
+                  }
+
+      config.foo.should == 3
+      config.bar.should == "bar value"
+      config.valid?.should be_true
+    end
+
+    it "should create errors when it sees unknown schema" do
+      config = FooConfig.load_from_string %q{
+                  something: 3
+                  bar: bar value
+                  }
+
+      config.valid?.should == false
+      config.errors.first.should =~ /something/
+    end
+
+    it "should evaluate erb successfully" do
+      config = FooConfig.load_from_string %q{
+                  bar: <%= "foo " + "bar" %>
+                  }
+      config.bar.should == "foo bar"
+    end
+
+    it "should not evaluate erb if .evaluate_erb is set to false" do
+      FooConfig.evaluate_erb = false
+      config = FooConfig.load_from_string %q{
+                  bar: <%= 3 %>
+                  }
+      config.bar.should == "<%= 3 %>"
+    end
+  end
+
+  describe ".load_from_file" do
+    before do
+      FooConfig.attribute :foo
+      FooConfig.attribute :bar
+    end
+
+    it "should load from a file successfully" do
+      file = Tempfile.new("config")
+      file.write "foo: bar"
+      file.flush
+      file.close
+      config = FooConfig.load_from_file(file.path)
+      config.foo.should == 'bar'
+    end
+    
+    it "should raise an ArgumentError when the file does not exist" do
+      lambda {
+        FooConfig.load_from_file("/etc/kajdf33sdf")
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should raise an ArgumentError if the file is not readable" do
+      file = Tempfile.new("config")
+      file.write "foo: bar"
+      file.flush
+      file.close
+      File.chmod(0000, file.path)
+      lambda {
+        config = FooConfig.load_from_file(file.path)
+      }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe ".clear_errors" do
+    it "should clear the errors on the config" do
+      config = FooConfig.new
+      config.attributes['foo'] = 3
+      config.valid?.should == false
+      config.clear_errors
+      config.errors.should == []
+    end
+  end
+
+  it "should enable you to override attribute methods and use super" do
+    FooConfig.attribute :foo, :type => :symbol
+    FooConfig.attribute :bar, :type => :symbol
+    FooConfig.class_eval do
+      def foo
+        super || bar
+      end
+    end
+    config = FooConfig.new
+    config.bar = :bar
+    config.foo.should == :bar
+    config.foo = :foo
+    config.foo.should == :foo
+  end
+end
+
+# EOF

data/spec/configit_spec.rb

@@ -0,0 +1,7 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Configit do
+end
+
+# EOF

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib configit]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,20 @@
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF