clafamatt 1.0.0

data/spec/clafamatt_spec.rb

@@ -0,0 +1,269 @@
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Clafamatt::MacroModule do
+  before :each do
+    @class = Clafamatt::MacroModule
+  end
+
+  specify { @class.should be_a_kind_of(Module) }
+
+  describe "given a class to decorate" do
+    before :each do
+      @decorated_class = Class.new
+      @decorated_class_singleton = class << @decorated_class; self; end
+      @it = @class.find_or_create_for(@decorated_class)
+    end
+
+    it "should know its decorated class" do
+      @it.decorated_class.should equal(@decorated_class)
+    end
+
+    it "should be a singleton ancestor of its decorated class" do
+      @decorated_class_singleton.ancestors.should include(@it)
+    end
+
+    it "should match another MacroModule decorating the same class" do
+      @it.should == @class.new(@decorated_class)
+    end
+
+    it "should only decorate a given class once" do
+      macro_module = @class.find_or_create_for(@decorated_class)
+      macro_module.should equal(@it)
+    end
+  end
+
+  describe "decorating a child of a decorated class" do
+    before :each do
+      @parent_class = Class.new
+      @child_class  = Class.new(@parent_class)
+      @parent_class_singleton = class << @parent_class; self; end
+      @child_class_singleton = class << @child_class; self; end
+      @parent_macro_module = @class.find_or_create_for(@parent_class)
+      @it = @class.find_or_create_for(@child_class)
+    end
+
+    it "should decorate the child with a new macro module" do
+      @it.should_not equal(@parent_macro_module)
+    end
+
+    it "should decorate the child with itself" do
+      @child_class_singleton.ancestors.should include(@it)
+    end
+
+    it "should decorate the child with the parent macro module" do
+      @child_class_singleton.ancestors.should include(@parent_macro_module)
+    end
+  end
+
+  describe "decorating a module" do
+    before :each do
+      @decorated_module = Module.new
+      @module_singleton = class << @decorated_module; self; end
+      @it = @class.find_or_create_for(@decorated_module)
+    end
+
+    it "should be one of the module's singleton ancestors" do
+      @module_singleton.ancestors.should include(@it)
+    end
+  end
+
+  describe "decorating a module included in a class" do
+    before :each do
+      @decorated_module = decorated_module = Module.new
+      @module_singleton = class << @decorated_module; self; end
+      @it = @class.find_or_create_for(@decorated_module)
+      @host_class = Class.new do
+        include decorated_module
+      end
+      @host_class_singleton = class << @host_class; self; end
+      @host_class_macro_module = @class.find_or_create_for(@host_class)
+    end
+
+    it "should be one of the class's singleton ancestors" do
+      @host_class_singleton.ancestors.should include(@it)
+    end
+
+    it "should not be the class's own macro module" do
+      @host_class_macro_module.should_not equal(@it)
+    end
+  end
+
+  describe "decorating a child class whose parent includes a decorated module" do
+    before :each do
+      @decorated_module = decorated_module = Module.new
+      @module_singleton = class << @decorated_module; self; end
+      @module_macro_module = @class.find_or_create_for(@decorated_module)
+      @host_class = Class.new do
+        include decorated_module
+      end
+      @host_class_singleton = class << @host_class; self; end
+      @host_class_macro_module = @class.find_or_create_for(@host_class)
+      @child_class = Class.new(@host_class)
+      @it = @class.find_or_create_for(@child_class)
+      @child_class_singleton = class << @child_class; self; end
+      @child_class_singleton_ancestors = @child_class_singleton.ancestors
+    end
+
+    it "should decorate the child with its own macro module" do
+      @it.should_not equal(@module_macro_module)
+      @it.should_not equal(@host_class_macro_module)
+    end
+
+    it "should decorate the child in the expected order" do
+      @child_class_singleton_ancestors.index(@it).should == 0
+      @child_class_singleton_ancestors.index(@host_class_macro_module).
+        should == 1
+      @child_class_singleton_ancestors.index(@module_macro_module).
+        should == 2
+    end
+  end
+end
+
+describe "Class Family Attributes:" do
+  before :each do
+    @shared = shared = Module.new do
+      include Clafamatt::Macros
+      def self.name; "Shared"; end
+      class_family_reader   :mro    # Module Read-Only
+      class_family_writer   :mwo    # Module Write-Only
+      class_family_accessor :mrw    # Module Read/Write
+    end
+
+    @parent = Class.new do
+      include shared
+      def self.name; "Parent"; end
+      class_family_reader   :ro1, :ro2 # Read-Only
+      class_family_writer   :wo1, :wo2 # Write-Only
+      class_family_accessor :rw1, :rw2 # Read/Write
+    end
+
+    @child = Class.new(@parent) do
+      def self.name; "Child"; end
+      class_family_reader   :cro      # Child Read-Only
+      class_family_writer   :cwo      # Child Write-Only
+      class_family_accessor :crw      # Child Read/Write
+    end
+  end
+
+  describe "a module with CFAs" do
+    before :each do
+    end
+
+    it "should have reader methods for all readable attributes" do
+      @shared.methods.should include("mro", "mrw")
+    end
+    it "should not have reader methods for write-only attributes" do
+      @shared.methods.should_not include("mwo")
+    end
+    it "should have writer methods for writable attributes" do
+      @shared.methods.should include("mwo=", "mrw=")
+    end
+    it "should not have writer methods for read-only attributes" do
+      @shared.methods.should_not include("mro=")
+    end
+
+    it "should default readable attributes to nil" do
+      @shared.mrw.should be_nil
+      @shared.mro.should be_nil
+    end
+
+    it "should be able to write to writable attributes" do
+      @shared.mrw = "klaatu"
+      @shared.mrw.should == "klaatu"
+      @shared.mwo = "nikto"
+      @shared.instance_variable_get(:@mwo).should == "nikto"
+    end
+
+    it "should be able to read readable attributes" do
+      @shared.instance_variable_set(:@mro, "klaatu")
+      @shared.mro.should == "klaatu"
+      @shared.instance_variable_set(:@mrw, "nikto")
+      @shared.mrw.should == "nikto"
+    end
+
+  end
+  describe "defined in a class" do
+    before :each do
+    end
+
+    it "should be able to write to included writable attributes" do
+      @parent.mrw = "klaatu"
+      @parent.mrw.should == "klaatu"
+      @parent.mwo = "nikto"
+      @parent.instance_variable_get(:@mwo).should == "nikto"
+    end
+
+    it "should not interfere with values in included module" do
+      @shared.mrw = "barada"
+      @parent.mrw = "klaatu"
+      @shared.mrw.should == "barada"
+      @parent.mrw.should == "klaatu"
+    end
+
+    it "should be able to read included readable attributes" do
+      @parent.instance_variable_set(:@mro, "klaatu")
+      @parent.mro.should == "klaatu"
+      @parent.instance_variable_set(:@mrw, "nikto")
+      @parent.mrw.should == "nikto"
+    end
+
+    it "should be able to read the class readable attributes" do
+      @parent.instance_variable_set(:@ro1, "oompah")
+      @parent.instance_variable_set(:@ro2, "loompah")
+      @parent.instance_variable_set(:@rw1, "doopidy")
+      @parent.instance_variable_set(:@rw2, "doo")
+      @parent.ro1.should == "oompah"
+      @parent.ro2.should == "loompah"
+      @parent.rw1.should == "doopidy"
+      @parent.rw2.should == "doo"
+    end
+
+    it "should be able to write the class writable attributes" do
+      @parent.wo1 = "oompah"
+      @parent.wo2 = "loompah"
+      @parent.rw1 = "doopidy"
+      @parent.rw2 = "doo"
+      @parent.instance_variable_get(:@wo1).should == "oompah"
+      @parent.instance_variable_get(:@wo2).should == "loompah"
+      @parent.instance_variable_get(:@rw1).should == "doopidy"
+      @parent.instance_variable_get(:@rw2).should == "doo"
+    end
+  end
+  describe "defined in a child class" do
+    it "should be able to read and write module-defined attributes" do
+      @child.mrw = "klaatu"
+      @child.mrw.should == "klaatu"
+      @shared.mrw.should be_nil
+    end
+    it "should be able to read and write parent-defined attributes" do
+      @child.rw1 = "barada"
+      @child.rw1.should == "barada"
+      @parent.rw1.should be_nil
+    end
+    it "should be able to read and write child-defined attributes" do
+      @child.crw = "nikto"
+      @child.crw.should == "nikto"
+    end
+    it "should not define child attributes on parent or module" do
+      lambda do
+        @shared.crw = "foo"
+      end.should raise_error(NoMethodError)
+      lambda do
+        @parent.crw = "foo"
+      end.should raise_error(NoMethodError)
+    end
+
+    it "should inherit values from module-defined attributes" do
+      @shared.mrw = "foo"
+      @parent.mrw.should == "foo"
+      @child.mrw.should == "foo"
+    end
+
+    it "should inherit values from parent-defined attributes" do
+      @parent.rw1 = "bar"
+      @child.rw1.should == "bar"
+    end
+  end
+end
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib clafamatt]))
+
+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] || 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,192 @@
+
+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}
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+    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
+      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 '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