instrument 0.1.2 → 0.1.3

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.1.3
+
+* registered type blocks now take a Hash as the second parameter
+* template filenames now show up in backtraces
+
 == 0.1.2
 
 * controls may now accept a delegate object, which methods will be relayed to

data/Rakefile

@@ -37,7 +37,12 @@ PKG_FILES = FileList[
     "[A-Z]*", "Rakefile"
 ].exclude(/database\.yml/).exclude(/[_\.]git$/)
 
-task :default => "spec:verify"
+RCOV_ENABLED = (RUBY_PLATFORM != "java" && RUBY_VERSION =~ /^1\.8/)
+if RCOV_ENABLED
+  task :default => "spec:verify"
+else
+  task :default => "spec"
+end
 
 WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
 SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])

data/lib/instrument/control.rb

@@ -1,6 +1,6 @@
 # ++
 # Instrument, Copyright (c) 2008 Day Automation Systems, Inc.
-# 
+#
 # 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
@@ -8,10 +8,10 @@
 # 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
@@ -52,15 +52,20 @@ module Instrument
     # execution context and returns the rendered template output as a
     # String.  The block should ensure that all necessary libraries are
     # loaded.
-    # 
-    #  @param [Array] type_list the template types being registered
-    #  @yield the block generates the template output
-    #  @yieldparam [String] the template input
-    #  @yieldparam [Object] the execution context for the template
+    #
+    #  @param [Array] type_list The template types being registered.
+    #  @yield The block generates the template output.
+    #  @yieldparam [String] input
+    #    The template input.
+    #  @yieldparam [Hash] options
+    #    Additional parameters.
+    #    :context - The execution context for the template, which will be set
+    #      to the control object.
+    #    :filename - The filename of the template being rendered.
     def self.register_type(*type_list, &block)
       # Ensure the @@type_map is initialized.
       self.types
-      
+
       for type in type_list
         # Normalize to symbol
         type = type.to_s.to_sym
@@ -68,7 +73,7 @@ module Instrument
       end
       return nil
     end
-    
+
     ##
     # Returns a list of registered template types.
     #
@@ -107,14 +112,12 @@ module Instrument
     #
     #  @param [Class] klass the subclass that is extending Control
     def self.inherited(klass)
-      if !defined?(@@control_subclasses) || @@control_subclasses == nil
-        @@control_subclasses = []
-      end
+      @@control_subclasses ||= []
       @@control_subclasses << klass
       @@control_subclasses.uniq!
       super
     end
-    
+
     ##
     # Looks up a Control by name.
     #
@@ -122,14 +125,15 @@ module Instrument
     #  @return [Instrument::Control, NilClass] the desired control or nil
     #  @see Instrument::Control.control_name
     def self.lookup(control_name)
-      for control_subclass in (@@control_subclasses || [])
+      @@control_subclasses ||= []
+      for control_subclass in @@control_subclasses
         if control_subclass.control_name == control_name
           return control_subclass
         end
       end
       return nil
     end
-    
+
     ##
     # Creates a new Control object.  Subclasses should not override this.
     #
@@ -140,19 +144,19 @@ module Instrument
       @options = options
       @block = block
     end
-    
+
     ##
     # Returns the options that were used to create the Control.
     #
     #  @return [Hash] a set of options required by the control
     attr_reader :options
-    
+
     ##
     # Returns the block that was supplied when the Control was created.
     #
     #  @return [Proc] the block used to create the Control
     attr_reader :block
-    
+
     ##
     # Returns the Control's name.  By default, this is the control's class
     # name, tranformed into   This method may be overridden by a Control.
@@ -167,7 +171,7 @@ module Instrument
         tr("-", "_").
         downcase
     end
-    
+
     ##
     # Returns a list of formats that this control may be rendered as.
     #
@@ -244,7 +248,7 @@ module Instrument
         end
       end
     end
-    
+
     ##
     # Renders a control in a specific format.
     #
@@ -264,7 +268,7 @@ module Instrument
         next if full_name.index(File.expand_path(load_path)) != 0
 
         templates = Dir.glob(full_name + ".#{format}.*")
-        
+
         # Select the first template matched.  If there's more than one,
         # the extras will be ignored.
         template = templates.first
@@ -295,7 +299,9 @@ module Instrument
       end
 
       begin
-        return self.class.processor(type).call(raw_content, self)
+        return self.class.processor(type).call(
+          raw_content, {:context => self, :filename => path}
+        )
       rescue Exception => e
         e.message <<
           "\nError occurred while rendering " +
@@ -307,23 +313,36 @@ module Instrument
 end
 
 # Register the default types.
-Instrument::Control.register_type(:haml) do |input, context|
+Instrument::Control.register_type(:haml) do |input, options|
   require "haml"
-  Haml::Engine.new(input, {:attr_wrapper => "\""}).render(context)
+  context = options[:context]
+  filename = options[:filename]
+  Haml::Engine.new(
+    input, :attr_wrapper => "\"", :filename => filename
+  ).render(context)
 end
-Instrument::Control.register_type(:erb, :rhtml) do |input, context|
+Instrument::Control.register_type(:erb, :rhtml) do |input, options|
   begin; require "erubis"; rescue LoadError; require "erb"; end
+  context = options[:context]
+  filename = options[:filename]
+  binding = context.instance_eval { (lambda {}).binding }
   erb = Erubis::Eruby.new(input) rescue ERB.new(input)
-  erb.result(context.send(:binding))
+  if erb.respond_to?(:filename=)
+    erb.filename = filename
+  end
+  erb.result(binding)
 end
-Instrument::Control.register_type(:mab) do |input, context|
+Instrument::Control.register_type(:mab) do |input, options|
   require "markaby"
+  context = options[:context]
   Markaby::Builder.new({}, context).capture do
     eval(input)
   end
 end
-Instrument::Control.register_type(:rxml) do |input, context|
+Instrument::Control.register_type(:rxml) do |input, options|
   require "builder"
+  context = options[:context]
   xml = Builder::XmlMarkup.new(:indent => 2)
-  eval(input, context.send(:binding))
+  binding = context.instance_eval { (lambda {}).binding }
+  eval(input, binding)
 end

data/lib/instrument/control_builder.rb

@@ -1,6 +1,6 @@
 # ++
 # Instrument, Copyright (c) 2008 Day Automation Systems, Inc.
-# 
+#
 # 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
@@ -8,10 +8,10 @@
 # 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
@@ -31,13 +31,13 @@ module Instrument
   # == Example
   #
   #   include Instrument::ControlBuilder
-  #   
+  #
   #   select_control(:name => "base", :selections => [
   #     {:label => "One", :value => "1"},
   #     {:label => "Two", :value => "2"},
   #     {:label => "Three", :value => "3"},
   #     {:label => "Four", :value => "4"}
-  #   ]).to_xhtml  
+  #   ]).to_xhtml
   module ControlBuilder
     ##
     # Prevents Kernel#select from being accidentally called.
@@ -59,9 +59,9 @@ module Instrument
       super
     end
 
-    ## 
+    ##
     # Initializes Instrument::Control subclasses by name.
-    # 
+    #
     #  @param [Symbol] method the method being called
     #  @param [Array] params the method's parameters
     #  @param [Proc] block the block being passed to the method
@@ -76,6 +76,6 @@ module Instrument
           "undefined method `#{method}' for " +
           "#{self.inspect}:#{self.class.name}"
       end
-    end    
+    end
   end
 end

data/lib/instrument/version.rb

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

data/spec/control_templates/select_control.atom.rxml

@@ -1,6 +1,6 @@
 require "uuidtools"
 require "time"
-xml.instruct! :xml, :version=>"1.0" 
+xml.instruct! :xml, :version=>"1.0"
 xml.feed("xmlns" => "http://www.w3.org/2005/Atom", "xml:lang" => "en_US") do
   xml.id("urn:uuid:4a11e26e-239c-11dd-adf9-001ec2186a45")
   xml.title("Select Control")

data/spec/instrument/control_builder_spec.rb

@@ -19,34 +19,34 @@ describe Instrument::ControlBuilder, "extending another object" do
   class ExtendedObject
     include Instrument::ControlBuilder
   end
-  
+
   before :all do
     @extended_object = ExtendedObject.new
   end
-  
+
   it "should enable mixins to function" do
     @extended_object.image_control.class.should == ImageControl
     @extended_object.select.class.should == Select
   end
-  
+
   it "should still raise an Exception for non-existent methods" do
     (lambda 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

data/spec/instrument/control_spec.rb

@@ -6,11 +6,11 @@ class SelectControl < Instrument::Control
     def initialize(label, value)
       @label, @value = label, value
     end
-    
+
     attr_accessor :label
     attr_accessor :value
   end
-  
+
   def element_id
     return self.options[:id] || self.options[:name]
   end
@@ -18,7 +18,7 @@ class SelectControl < Instrument::Control
   def element_name
     return self.options[:name]
   end
-  
+
   def selections
     if !defined?(@selections) || @selections == nil
       @selections = []
@@ -70,7 +70,7 @@ describe Instrument::Control do
     control = Instrument::Control.new(&proc)
     control.block.should eql(proc)
   end
-  
+
   it "should still raise an Exception for non-existent methods" do
     (lambda do
       Instrument::Control.new.bogus
@@ -100,25 +100,25 @@ 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
@@ -127,25 +127,25 @@ describe Instrument::Control 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
@@ -162,7 +162,7 @@ describe Instrument::Control, "when rendered as XHTML with Haml" do
   it "should have the correct id and name" do
     @xhtml.should match(/<select id="base" name="base">/)
   end
-  
+
   it "should have options for all of the given selections" do
     @xhtml.should match(/<option value="First"/)
     @xhtml.should match(/<option value="Second"/)
@@ -185,7 +185,7 @@ describe Instrument::Control, "when rendered as HTML with Markaby" do
     @html.should match(/id="base"/)
     @html.should match(/name="base"/)
   end
-  
+
   it "should have options for all of the given selections" do
     @html.should match(/<option value="First"/)
     @html.should match(/<option value="Second"/)
@@ -205,7 +205,7 @@ describe Instrument::Control, "when rendered as Atom with XML Builder" do
   it "should have the correct id and name" do
     @atom.should match(/<title>Select Control<\/title>/)
   end
-  
+
   it "should have options for all of the given selections" do
     @atom.should match(/<title>First<\/title>/)
     @atom.should match(/<title>Second<\/title>/)
@@ -226,7 +226,7 @@ describe Instrument::Control, "when rendered as JSON with Erubis" do
     @atom.should match(/"id": "base"/)
     @atom.should match(/"name": "base"/)
   end
-  
+
   it "should have options for all of the given selections" do
     @atom.should match(/"label": "First"/)
     @atom.should match(/"value": "First"/)

data/tasks/gem.rake

@@ -29,7 +29,7 @@ namespace :gem do
     p.need_tar = true
     p.need_zip = true
   end
-  
+
   desc "Show information about the gem"
   task :debug do
     puts GEM_SPEC.to_ruby

data/tasks/git.rake

@@ -22,16 +22,16 @@ namespace :git do
       tag = "#{PKG_NAME}-#{PKG_VERSION}"
       msg = "Release #{PKG_NAME}-#{PKG_VERSION}"
 
-      existing_tags = `git tag -l instrument-*`.split("\n")
+      existing_tags = `git tag -l #{PKG_NAME}-*`.split("\n")
       if existing_tags.include?(tag)
         warn("Tag already exists, deleting...")
         unless system "git tag -d #{tag}"
-          abort "Tag deletion failed." 
+          abort "Tag deletion failed."
         end
       end
       puts "Creating git tag '#{tag}'..."
       unless system "git tag -a -m \"#{msg}\" #{tag}"
-        abort "Tag creation failed." 
+        abort "Tag creation failed."
       end
     end
   end

data/tasks/metrics.rake

@@ -13,7 +13,7 @@ namespace :metrics do
         "LOC #{sprintf("%4d", codelines)} | #{file_name}"
       total_lines     += lines
       total_codelines += codelines
-    
+
       lines, codelines = 0, 0
     end
 

data/tasks/rdoc.rake

@@ -16,7 +16,7 @@ namespace :doc do
   task :ri do
     sh "rdoc --ri -o ri ."
   end
-  
+
   desc "Remove ri products"
   task :clobber_ri do
     rm_r "ri" rescue nil

data/tasks/rubyforge.rake

@@ -1,9 +1,8 @@
-require 'rubyforge'
-require 'rake/contrib/sshpublisher'
-
 namespace :gem do
   desc 'Package and upload to RubyForge'
   task :release => ["gem:package"] do |t|
+    require 'rubyforge'
+
     v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
     abort "Versions don't match #{v} vs #{PROJ.version}" if v != PKG_VERSION
     pkg = "pkg/#{GEM_SPEC.full_name}"
@@ -28,6 +27,9 @@ end
 namespace :doc do
   desc "Publish RDoc to RubyForge"
   task :release => ["doc:rdoc"] do
+    require "rake/contrib/sshpublisher"
+    require "yaml"
+
     config = YAML.load(
       File.read(File.expand_path('~/.rubyforge/user-config.yml'))
     )
@@ -41,6 +43,9 @@ end
 namespace :spec do
   desc "Publish specdoc to RubyForge"
   task :release => ["spec:specdoc"] do
+    require "rake/contrib/sshpublisher"
+    require "yaml"
+
     config = YAML.load(
       File.read(File.expand_path('~/.rubyforge/user-config.yml'))
     )
@@ -49,10 +54,13 @@ namespace :spec do
     local_dir = "specdoc"
     Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
   end
-  
+
   namespace :rcov do
     desc "Publish coverage report to RubyForge"
     task :release => ["spec:rcov"] do
+      require "rake/contrib/sshpublisher"
+      require "yaml"
+
       config = YAML.load(
         File.read(File.expand_path('~/.rubyforge/user-config.yml'))
       )
@@ -67,6 +75,9 @@ end
 namespace :website do
   desc "Publish website to RubyForge"
   task :release => ["doc:release", "spec:release", "spec:rcov:release"] do
+    require "rake/contrib/sshpublisher"
+    require "yaml"
+
     config = YAML.load(
       File.read(File.expand_path('~/.rubyforge/user-config.yml'))
     )

data/tasks/spec.rake

@@ -4,7 +4,11 @@ namespace :spec do
   Spec::Rake::SpecTask.new(:rcov) do |t|
     t.spec_files = FileList['spec/**/*_spec.rb']
     t.spec_opts = ['--color', '--format', 'specdoc']
-    t.rcov = true
+    if RCOV_ENABLED
+      t.rcov = true
+    else
+      t.rcov = false
+    end
     t.rcov_opts = [
       '--exclude', 'spec',
       '--exclude', '1\\.8\\/gems',
@@ -12,24 +16,32 @@ namespace :spec do
     ]
   end
 
-  RCov::VerifyTask.new(:verify) do |t| 
-    t.threshold = 100.0
-    t.index_html = 'coverage/index.html'
+  Spec::Rake::SpecTask.new(:normal) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color', '--format', 'specdoc']
+    t.rcov = false
   end
 
-  task :verify => :rcov
+  if RCOV_ENABLED
+    RCov::VerifyTask.new(:verify) do |t|
+      t.threshold = 100.0
+      t.index_html = 'coverage/index.html'
+    end
+
+    task :verify => :rcov
+  end
 
   desc "Generate HTML Specdocs for all specs"
   Spec::Rake::SpecTask.new(:specdoc) do |t|
     specdoc_path = File.expand_path(
       File.join(File.dirname(__FILE__), '../specdoc/'))
     Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
-    
+
     output_file = File.join(specdoc_path, 'index.html')
     t.spec_files = FileList['spec/**/*_spec.rb']
     t.spec_opts = ["--format", "\"html:#{output_file}\"", "--diff"]
     t.fail_on_error = false
-  end  
+  end
 
   namespace :rcov do
     desc "Browse the code coverage report."
@@ -39,8 +51,13 @@ namespace :spec do
   end
 end
 
-desc "Alias to spec:verify"
-task "spec" => "spec:verify"
+if RCOV_ENABLED
+  desc "Alias to spec:verify"
+  task "spec" => "spec:verify"
+else
+  desc "Alias to spec:normal"
+  task "spec" => "spec:normal"
+end
 
 task "clobber" => ["spec:clobber_rcov"]
 
@@ -74,12 +91,12 @@ module Rake
         success =
           !(`gnome-open #{filepath} 2>&1` =~ /There is no default action/)
         if !success
-          opened = try_browsers.call() 
+          opened = try_browsers.call()
         else
           opened = true
         end
       else
-        opened = try_browsers.call() 
+        opened = try_browsers.call()
       end
       if !opened
         puts "Don't know how to browse to location."

data/website/index.html

@@ -9,12 +9,12 @@
         margin: 0;
         padding: 0;
       }
-      
+
       body {
         font-family: lucida grande, verdana, sans-serif;
         margin: 1em;
       }
-      
+
       a {
         color: #880000;
       }
@@ -22,18 +22,18 @@
       a:visited {
         color: #333333;
       }
-      
+
       h1 {
         font-size: 2em;
         margin: 0 0 0.8em 0;
         text-align: center;
       }
-      
+
       h2 {
         font-size: 1em;
         margin: 0.8em 0;
       }
-      
+
       p {
         margin: 0.8em 0;
       }
@@ -42,7 +42,7 @@
         font-size: 0.9em;
         margin: 0 0 0 1.5em;
       }
-      
+
       div {
         width: 50%;
         margin: 0 auto;
@@ -55,7 +55,7 @@
         body {
           font-size: 0.9em;
         }
-        
+
         a {
           text-decoration: none;
           color: #000;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: instrument
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Bob Aman
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-05 00:00:00 -04:00
+date: 2008-10-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +24,7 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -95,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: instrument
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Template-based Controls