instrument 0.1.0

data/lib/instrument/control_builder.rb

@@ -0,0 +1,71 @@
+# ++
+# 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
+# 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.
+# --
+
+require "instrument/control"
+
+module Instrument
+  ##
+  # A module which you can mixin to allow for abbreviated control
+  # creation.
+  #
+  # == 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  
+  module ControlBuilder
+    ##
+    # Prevents Kernel#select from being accidentally called.
+    #
+    #  @param [Array] params the method's parameters
+    #  @param [Proc] block the block being passed to the method
+    #  @return [Instrument::Control] the control being created
+    def select(*params, &block) # :nodoc:
+      return self.method_missing(:select, *params, &block)
+    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
+    #  @return [Instrument::Control] the control being created
+    #  @raise NoMethodError if the method wasn't handled
+    def method_missing(method, *params, &block)
+      control_class = ::Instrument::Control.lookup(method.to_s)
+      if control_class != nil
+        return control_class.new(*params, &block)
+      else
+        raise NoMethodError,
+          "undefined method `#{method}' for " +
+          "#{self.inspect}:#{self.class.name}"
+      end
+    end    
+  end
+end

data/lib/instrument/errors.rb

@@ -0,0 +1,35 @@
+# ++
+# 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
+# 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.
+# --
+
+module Instrument
+  ##
+  # Exception raised when a template cannot be found.
+  class ResourceNotFoundError < StandardError
+  end
+
+  ##
+  # Exception raised when a template is found, but it uses an unknown
+  # template engine.
+  class InvalidTemplateEngineError < StandardError
+  end
+end

data/lib/instrument/version.rb

@@ -0,0 +1,35 @@
+# ++
+# 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
+# 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.
+# --
+
+# Used to prevent the class/module from being loaded more than once
+unless defined? Instrument::VERSION
+  module Instrument #:nodoc:
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 1
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+  end
+end

data/spec/control_templates/image_control.xhtml.haml

@@ -0,0 +1 @@
+%img{:src => source, :alt => alternate_text}

data/spec/control_templates/select_control.atom.rxml

@@ -0,0 +1,19 @@
+require "uuidtools"
+require "time"
+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")
+  xml.subtitle("Yes, this is silly, but you get the idea.")
+  xml.updated(Time.now.iso8601)
+  for selection in selections
+    xml.entry do
+      xml.id(
+        UUID.sha1_create(UUID_URL_NAMESPACE, "#" + selection.value).to_uri
+      )
+      xml.title(selection.label)
+      xml.link("#" + selection.value)
+      xml.updated(Time.now.iso8601)
+    end
+  end
+end

data/spec/control_templates/select_control.directory.haml/explanation.txt

@@ -0,0 +1,2 @@
+# This directory exists to test that a directory cannot be loaded
+# accidentally as if it were a template.

data/spec/control_templates/select_control.html.mab

@@ -0,0 +1,5 @@
+select :id => element_id, :name => element_name do
+  for selection in selections
+    option selection.label, :value => selection.value
+  end
+end

data/spec/control_templates/select_control.json.erb

@@ -0,0 +1,14 @@
+{
+  "select": {
+    "id": "<%= element_id %>",
+    "name": "<%= element_name %>",
+    "options": [
+    <% for selection in selections %>
+      {
+        "label": "<%= selection.label %>",
+        "value": "<%= selection.value %>"
+      }
+    <% end %>
+    ]
+  }
+}

data/spec/control_templates/select_control.txt.bogus

@@ -0,0 +1,2 @@
+# This is a bogus format.
+# No handler will be registered to handle it.

data/spec/control_templates/select_control.xhtml.haml

@@ -0,0 +1,4 @@
+%select{:id => element_id, :name => element_name}
+  - for selection in selections
+    %option{:value => selection.value}
+      = selection.label

data/spec/control_templates/select_control.xml.haml

@@ -0,0 +1,2 @@
+%divide_by_zero_test
+  = 0 / 0

data/spec/instrument/control_builder_spec.rb

@@ -0,0 +1,37 @@
+spec_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+require File.join(spec_dir, "spec_helper")
+
+class ImageControl < Instrument::Control
+  def source
+    return self.options[:source] || self.options[:src]
+  end
+
+  def alternate_text
+    return self.options[:alternate_text] || self.options[:alt]
+  end
+end
+
+# Verifies that Kernel#select isn't accidentally being called.
+class Select < Instrument::Control
+end
+
+describe Instrument::ControlBuilder 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
+end

data/spec/instrument/control_spec.rb

@@ -0,0 +1,179 @@
+spec_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+require File.join(spec_dir, "spec_helper")
+
+class SelectControl < Instrument::Control
+  class Option
+    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
+
+  def element_name
+    return self.options[:name]
+  end
+  
+  def selections
+    if !defined?(@selections) || @selections == nil
+      @selections = []
+      for selection in self.options[:selections]
+        if selection.kind_of?(Hash)
+          @selections << Option.new(selection[:label], selection[:value])
+        else
+          @selections << Option.new(selection, selection)
+        end
+      end
+    end
+    return @selections
+  end
+end
+
+class SuperSelectControl < SelectControl
+end
+
+describe Instrument::Control do
+  it "should be able to look up subclasses by name" do
+    Instrument::Control.lookup("select_control").should ==
+      SelectControl
+    Instrument::Control.lookup("super_select_control").should ==
+      SuperSelectControl
+  end
+
+  it "should have RAILS_ROOT/app/controls in the $CONTROL_PATH" do
+    $CONTROL_PATH.should include(File.join(RAILS_ROOT, "app/controls"))
+  end
+
+  it "should not allow invalid types to be used" do
+    (lambda do
+      Instrument::Control.processor(:bogus)
+    end).should raise_error(ArgumentError)
+  end
+
+  it "should initialize subclasses via method_missing" do
+    Instrument::Control.new.select_control.class.should == SelectControl
+  end
+  
+  it "should still raise an Exception for non-existent methods" do
+    (lambda do
+      Instrument::Control.new.bogus
+    end).should raise_error(NoMethodError)
+  end
+
+  it "should raise an Exception for non-existent formats" do
+    (lambda do
+      SelectControl.new.to_bogus
+    end).should raise_error(Instrument::ResourceNotFoundError)
+  end
+
+  it "should raise an Exception if a directory is found instead of a file" do
+    (lambda do
+      SelectControl.new.to_directory
+    end).should raise_error(Instrument::ResourceNotFoundError)
+  end
+
+  it "should raise an Exception if a directory is found instead of a file" do
+    (lambda do
+      SelectControl.new.to_txt
+    end).should raise_error(Instrument::InvalidTemplateEngineError)
+  end
+
+  it "should raise an Exception if a template raises an Exception" do
+    (lambda do
+      SelectControl.new.to_xml
+    end).should raise_error(ZeroDivisionError)
+  end
+end
+
+describe Instrument::Control, "when rendered as XHTML with Haml" do
+  before :all do
+    @control = SelectControl.new(:name => "base", :selections => [
+      "First", "Second", "Third", "Home"
+    ])
+    @xhtml = @control.to_xhtml
+  end
+
+  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"/)
+    @xhtml.should match(/<option value="Third"/)
+    @xhtml.should match(/<option value="Home"/)
+  end
+end
+
+describe Instrument::Control, "when rendered as HTML with Markaby" do
+  before :all do
+    @control = SelectControl.new(:name => "base", :selections => [
+      "First", "Second", "Third", "Home"
+    ])
+    @html = @control.to_html
+  end
+
+  it "should have the correct id and name" do
+    # Ordering of attributes is indeterminate.
+    @html.should match(/<select/)
+    @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"/)
+    @html.should match(/<option value="Third"/)
+    @html.should match(/<option value="Home"/)
+  end
+end
+
+describe Instrument::Control, "when rendered as Atom with XML Builder" do
+  before :all do
+    @control = SelectControl.new(:name => "base", :selections => [
+      "First", "Second", "Third", "Home"
+    ])
+    @atom = @control.to_atom
+  end
+
+  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>/)
+    @atom.should match(/<title>Third<\/title>/)
+    @atom.should match(/<title>Home<\/title>/)
+  end
+end
+
+describe Instrument::Control, "when rendered as JSON with Erubis" do
+  before :all do
+    @control = SelectControl.new(:name => "base", :selections => [
+      "First", "Second", "Third", "Home"
+    ])
+    @atom = @control.to_json
+  end
+
+  it "should have the correct id and name" 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"/)
+    @atom.should match(/"label": "Second"/)
+    @atom.should match(/"value": "Second"/)
+    @atom.should match(/"label": "Third"/)
+    @atom.should match(/"value": "Third"/)
+    @atom.should match(/"label": "Home"/)
+    @atom.should match(/"value": "Home"/)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# We need to test for the presence of RAILS_ROOT in the $CONTROL_PATH
+if !defined?(RAILS_ROOT)
+  RAILS_ROOT = "somewhere/over/the/rainbow"
+end
+
+spec_dir = File.expand_path(File.dirname(__FILE__))
+lib_dir = File.expand_path(File.join(spec_dir, "../lib"))
+
+$:.unshift(lib_dir)
+$:.uniq!
+
+require "instrument"
+$CONTROL_PATH.unshift(File.join(spec_dir, "control_templates"))

data/tasks/browse.rake

@@ -0,0 +1,43 @@
+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