instrument 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 0.1.2
+
+* controls may now accept a delegate object, which methods will be relayed to
+* controls and control builders now have a proper respond_to? method
+* controls now have a formats method that lists all available formats
+
 == 0.1.1
 
 * controls may now optionally accept a block during initialization

data/lib/instrument/control.rb

@@ -168,6 +168,53 @@ module Instrument
         downcase
     end
     
+    ##
+    # Returns a list of formats that this control may be rendered as.
+    #
+    #  @return [Array] the available formats
+    def self.formats
+      return [] if self.control_name == nil
+      all_templates = []
+      all_formats = []
+      for load_path in $CONTROL_PATH
+        full_name = File.expand_path(
+          File.join(load_path, self.control_name))
+
+        # Check to make sure the requested template is within the load path
+        # to avoid inadvertent rendering of say, /etc/passwd
+        next if full_name.index(File.expand_path(load_path)) != 0
+
+        all_templates.concat(Dir.glob(full_name + ".*"))
+      end
+      for template in all_templates
+        next if File.directory?(template)
+        all_formats << template[/^.*\.([-_a-zA-Z0-9]+)\..*$/, 1]
+      end
+      return all_formats.uniq.reject { |f| f.nil? }
+    end
+
+    ##
+    # Returns true if the control responds to the given message.
+    #
+    #  @return [Boolean] if the control responds
+    def respond_to?(method, include_private=false)
+      if method.to_s =~ /^to_/
+        format = method.to_s.gsub(/^to_/, "")
+        return self.class.formats.include?(format)
+      else
+        control_class = self.class.lookup(method.to_s)
+        if control_class != nil
+          return true
+        else
+          if options[:delegate] != nil &&
+              options[:delegate].respond_to?(method)
+            return true
+          end
+        end
+      end
+      super
+    end
+
     ##
     # Relays to_format messages to the render method.
     #
@@ -180,15 +227,20 @@ module Instrument
     def method_missing(method, *params, &block)
       if method.to_s =~ /^to_/
         format = method.to_s.gsub(/^to_/, "")
-        self.send(:render, format, *params, &block)
+        self.render(format, *params, &block)
       else
         control_class = self.class.lookup(method.to_s)
         if control_class != nil
           control_class.new(*params, &block)
         else
-          raise NoMethodError,
-            "undefined method `#{method}' for " +
-            "#{self.inspect}:#{self.class.name}"
+          if options[:delegate] != nil &&
+              options[:delegate].respond_to?(method)
+            options[:delegate].send(method, *params, &block)
+          else
+            raise NoMethodError,
+              "undefined method `#{method}' for " +
+              "#{self.inspect}:#{self.class.name}"
+          end
         end
       end
     end

data/lib/instrument/control_builder.rb

@@ -49,6 +49,16 @@ module Instrument
       return self.method_missing(:select, *params, &block)
     end
 
+    ##
+    # Returns true if the control builder responds to the given message.
+    #
+    #  @return [Boolean] if the control builder responds
+    def respond_to?(method, include_private=false)
+      control_class = ::Instrument::Control.lookup(method.to_s)
+      return true if control_class != nil
+      super
+    end
+
     ## 
     # Initializes Instrument::Control subclasses by name.
     # 

data/lib/instrument/version.rb

@@ -27,7 +27,7 @@ unless defined? Instrument::VERSION
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 1
-      TINY  = 1
+      TINY  = 2
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/spec/instrument/control_builder_spec.rb

@@ -15,7 +15,7 @@ end
 class Select < Instrument::Control
 end
 
-describe Instrument::ControlBuilder do
+describe Instrument::ControlBuilder, "extending another object" do
   class ExtendedObject
     include Instrument::ControlBuilder
   end
@@ -34,4 +34,20 @@ describe Instrument::ControlBuilder do
       @extended_object.bogus
     end).should raise_error(NoMethodError)
   end
+  
+  it "should respond to a normal message" do
+    @extended_object.should respond_to(:to_s)
+  end
+  
+  it "should not respond to a bogus message" do
+    @extended_object.should_not respond_to(:bogus)
+  end
+  
+  it "should respond to a valid control name message" do
+    @extended_object.should respond_to(:image_control)
+  end
+  
+  it "should not respond to an invalid control name message" do
+    @extended_object.should_not respond_to(:bogus_control)
+  end
 end

data/spec/instrument/control_spec.rb

@@ -100,6 +100,55 @@ describe Instrument::Control do
       SelectControl.new.to_xml
     end).should raise_error(ZeroDivisionError)
   end
+  
+  it "should correctly delegate messages to the delegate object" do
+    SelectControl.new(:delegate => [1,2,3]).size.should == 3
+  end
+  
+  it "should have the correct list of formats" do
+    SelectControl.formats.sort.should == [
+      "atom", "html", "json", "txt", "xhtml", "xml"
+    ]
+  end
+  
+  it "should have no formats listed for the base class" do
+    Instrument::Control.formats.should == []
+  end
+  
+  it "should respond to a normal message" do
+    SelectControl.new.should respond_to(:render)
+  end
+  
+  it "should not respond to a bogus message" do
+    SelectControl.new.should_not respond_to(:bogus)
+  end
+
+  it "should respond to valid subclass messages" do
+    Instrument::Control.new.should respond_to(:select_control)
+    SelectControl.new.should respond_to(:select_control)
+  end
+  
+  it "should not respond to invalid subclass messages" do
+    SelectControl.new.should_not respond_to(:bogus_control)
+  end
+  
+  it "should respond to a valid format conversion message" do
+    SelectControl.new.should respond_to(:to_atom)
+  end
+  
+  it "should not respond to an invalid format conversion message" do
+    SelectControl.new.should_not respond_to(:to_bogus)
+  end
+  
+  it "should respond to messages available on a delegated object" do
+    SelectControl.new(:delegate => []).should respond_to(:<<)
+    SelectControl.new(:delegate => 42).should respond_to(:>>)
+    SelectControl.new(:delegate => 42).should respond_to(:<<)
+  end
+  
+  it "should not respond to messages unavailable on a delegated object" do
+    SelectControl.new(:delegate => []).should_not respond_to(:>>)
+  end
 end
 
 describe Instrument::Control, "when rendered as XHTML with Haml" do

data/tasks/gem.rake

@@ -20,7 +20,7 @@ namespace :gem do
 
     s.author = "Bob Aman"
     s.email = "bob@sporkmonger.com"
-    s.homepage = "http://sporkmonger.com/"
+    s.homepage = "http://#{PKG_NAME}.rubyforge.org/"
     s.rubyforge_project = RUBY_FORGE_PROJECT
   end
 

data/tasks/git.rake

@@ -10,12 +10,25 @@ namespace :git do
 
     desc "Create a new tag in the Git repository"
     task :create do
+      changelog = File.open("CHANGELOG", "r") { |file| file.read }
+      puts "-" * 80
+      puts changelog
+      puts "-" * 80
+      puts
+
       v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
       abort "Versions don't match #{v} vs #{PKG_VERSION}" if v != PKG_VERSION
 
       tag = "#{PKG_NAME}-#{PKG_VERSION}"
       msg = "Release #{PKG_NAME}-#{PKG_VERSION}"
 
+      existing_tags = `git tag -l instrument-*`.split("\n")
+      if existing_tags.include?(tag)
+        warn("Tag already exists, deleting...")
+        unless system "git tag -d #{tag}"
+          abort "Tag deletion failed." 
+        end
+      end
       puts "Creating git tag '#{tag}'..."
       unless system "git tag -a -m \"#{msg}\" #{tag}"
         abort "Tag creation failed." 

data/tasks/rubyforge.rake

@@ -9,6 +9,7 @@ namespace :gem do
     pkg = "pkg/#{GEM_SPEC.full_name}"
 
     rf = RubyForge.new
+    rf.configure
     puts 'Logging in...'
     rf.login
 

data/tasks/spec.rake

@@ -31,9 +31,11 @@ namespace :spec do
     t.fail_on_error = false
   end  
 
-  desc "Browse the code coverage report."
-  task :rcov_browse => :rcov do
-    Rake.browse("coverage/index.html")
+  namespace :rcov do
+    desc "Browse the code coverage report."
+    task :browse => "spec:rcov" do
+      Rake.browse("coverage/index.html")
+    end
   end
 end
 
@@ -41,3 +43,47 @@ desc "Alias to spec:verify"
 task "spec" => "spec:verify"
 
 task "clobber" => ["spec:clobber_rcov"]
+
+module Rake
+  def self.browse(filepath)
+    if RUBY_PLATFORM =~ /mswin/
+      system(filepath)
+    else
+      try_browsers = lambda do
+        result = true
+        if !(`which firefox 2>&1` =~ /no firefox/)
+          system("firefox #{filepath}")
+        elsif !(`which mozilla 2>&1` =~ /no mozilla/)
+          system("mozilla #{filepath}")
+        elsif !(`which netscape 2>&1` =~ /no netscape/)
+          system("netscape #{filepath}")
+        elsif !(`which links 2>&1` =~ /no links/)
+          system("links #{filepath}")
+        elsif !(`which lynx 2>&1` =~ /no lynx/)
+          system("lynx #{filepath}")
+        else
+          result = false
+        end
+        result
+      end
+      opened = false
+      if RUBY_PLATFORM =~ /darwin/
+        opened = true
+        system("open #{filepath}")
+      elsif !(`which gnome-open 2>&1` =~ /no gnome-open/)
+        success =
+          !(`gnome-open #{filepath} 2>&1` =~ /There is no default action/)
+        if !success
+          opened = try_browsers.call() 
+        else
+          opened = true
+        end
+      else
+        opened = try_browsers.call() 
+      end
+      if !opened
+        puts "Don't know how to browse to location."
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: instrument
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Bob Aman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-27 00:00:00 -04:00
+date: 2008-06-05 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,6 @@ files:
 - spec/instrument/control_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tasks/browse.rake
 - tasks/clobber.rake
 - tasks/gem.rake
 - tasks/git.rake
@@ -74,7 +73,7 @@ files:
 - Rakefile
 - README
 has_rdoc: true
-homepage: http://sporkmonger.com/
+homepage: http://instrument.rubyforge.org/
 post_install_message: 
 rdoc_options: 
 - --main

data/tasks/browse.rake

@@ -1,43 +0,0 @@
-module Rake
-  def self.browse(filepath)
-    if RUBY_PLATFORM =~ /mswin/
-      system(filepath)
-    else
-      try_browsers = lambda do
-        result = true
-        if !(`which firefox 2>&1` =~ /no firefox/)
-          system("firefox #{filepath}")
-        elsif !(`which mozilla 2>&1` =~ /no mozilla/)
-          system("mozilla #{filepath}")
-        elsif !(`which netscape 2>&1` =~ /no netscape/)
-          system("netscape #{filepath}")
-        elsif !(`which links 2>&1` =~ /no links/)
-          system("links #{filepath}")
-        elsif !(`which lynx 2>&1` =~ /no lynx/)
-          system("lynx #{filepath}")
-        else
-          result = false
-        end
-        result
-      end
-      opened = false
-      if RUBY_PLATFORM =~ /darwin/
-        opened = true
-        system("open #{filepath}")
-      elsif !(`which gnome-open 2>&1` =~ /no gnome-open/)
-        success =
-          !(`gnome-open #{filepath} 2>&1` =~ /There is no default action/)
-        if !success
-          opened = try_browsers.call() 
-        else
-          opened = true
-        end
-      else
-        opened = try_browsers.call() 
-      end
-      if !opened
-        puts "Don't know how to browse to location."
-      end
-    end
-  end
-end