inspectorgadget 0.0.1

data/tasks/deployment.rake

@@ -0,0 +1,27 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/test/test_dsl_attribute_accessor.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class DslAttributeAccessorTest < Test::Unit::TestCase
+  include InspectorGadget
+  
+  def test_dsl_attr_accessor_creates_methods
+    object = create_class_with_dsl_accessor
+    assert_respond_to(object, :foo)
+    assert_respond_to(object, :foo=)
+  end
+  
+  def test_creates_traditional_and_dsl_writers
+    object = create_class_with_dsl_accessor
+    object.foo 'baz'
+    assert object.instance_variables.include?("@foo")
+
+    object = create_class_with_dsl_accessor
+    object.foo = 'bar'
+    assert object.instance_variables.include?("@foo")
+  end
+  
+  def test_creates_traditional_reader
+    object = create_class_with_dsl_accessor
+    object.instance_variable_set "@foo", 'baz'
+    assert_equal 'baz', object.foo
+  end
+  
+  def create_class_with_dsl_accessor
+    klass = Class.new
+    klass.extend DslAttrAccessor
+    klass.send(:dsl_attr_accessor, :foo)
+    klass.new
+  end
+  private :create_class_with_dsl_accessor
+  
+end

data/test/test_google_gadget_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'rexml/document'
+
+class GoogleGadgetSpecTest < Test::Unit::TestCase
+  include InspectorGadget
+  include REXML
+  
+  def test_create_google_gadget_spec
+    gadget = GoogleGadgetSpec.new
+
+    mp = gadget.module_prefs
+    assert_instance_of ModulePreferences, gadget.module_prefs
+    assert_equal [], gadget.user_prefs
+    assert_equal :html, gadget.content_type
+    assert_nil gadget.content_href
+    assert_nil gadget.content
+  end
+  
+  def test_setting_module_preferences
+    gadget = GoogleGadgetSpec.new
+    
+    module_prefs = gadget.module_prefs do |mp|
+      assert_same gadget.module_prefs, mp
+    end
+    
+    assert_same gadget.module_prefs, module_prefs
+  end
+  
+  def test_add_user_preferences
+    gadget = GoogleGadgetSpec.new
+    new_user_pref = nil
+    gadget.user_pref do |up|
+      new_user_pref = up
+    end
+    assert_equal [new_user_pref], gadget.user_prefs
+  end
+  
+  def test_forwards_NoMethodMethodError_to_super_after_method_missing_chain
+    assert_raise NoMethodError do
+      GoogleGadgetSpec.new do
+        hello
+      end
+    end
+  end
+  
+  def test_to_xml_file_using_string_content
+    gadget = GoogleGadgetSpec.new
+    gadget.user_pref :name => 'mycolor'
+    gadget.content = "hello world"
+    
+    gadget.module_prefs.expects(:to_xml)
+    gadget.user_prefs.each{|up| up.expects(:to_xml)}
+    xml = gadget.to_xml
+    
+    doc = Document.new(xml)
+    assert_xpath doc, "/Module"
+    assert_xpath doc, "/Module/Content"
+    assert_equal "hello world", cdata_value(doc, "/Module/Content")
+  end
+  
+  def test_to_xml_file_using_IO_content
+    gadget = GoogleGadgetSpec.new
+    gadget.user_pref :name => 'mycolor'
+    gadget.content = IO.new(0)
+    gadget.module_prefs.expects(:to_xml)
+    gadget.user_prefs.each{|up| up.expects(:to_xml)}
+    gadget.content.expects(:readlines).returns(['mocked','content'])
+
+    xml = gadget.to_xml
+    
+    doc = Document.new(xml)
+    assert_xpath doc, "/Module"
+    assert_xpath doc, "/Module/Content"
+    assert_equal "mockedcontent", cdata_value(doc, "/Module/Content")
+  end
+  
+  def test_to_xml_writes_url_content_type_attributes
+    gadget = GoogleGadgetSpec.new do
+      content_type :url
+      content_href 'www.google.com'
+    end
+    doc = Document.new gadget.to_xml
+    assert_xpath(doc, "/Module/Content", :type => :url, :href => 'www.google.com')
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/inspectorgadget'
+
+#asserts number of elements returned by an xpath (executed on a ReXML doc)
+def assert_xpath(doc, path, attributes = {}, expected_matches = 1)
+  xpath = path + "[" + attributes.collect{|k,v| "@#{k}='#{v}'"}.join(' and ') + "]"
+  assert_equal expected_matches, doc.get_elements(xpath).length
+end
+
+#first matching element's first cdata
+def cdata_value(doc, xpath)
+  doc.root.get_elements(xpath)[0].cdatas[0].value
+end

data/test/test_inspectorgadget.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestInspectorgadget < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_module_preferences.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'mocha'
+require 'rexml/document'
+require 'rexml/text'
+
+class ModulePreferenceTest < Test::Unit::TestCase
+  include InspectorGadget
+  include REXML
+  
+  def test_instantiating_with_hash_attributes
+    mp = ModulePreferences.new :title => 'hello world example'
+    assert_equal 'hello world example', mp.title
+  end
+
+  def test_require_feature
+    mp = ModulePreferences.new
+    mp.require_features "setprefs", "another1"
+    assert_equal ["setprefs", "another1"], mp.required_features
+  end
+  
+  def test_may_require
+    mp = ModulePreferences.new
+    mp.may_require :browser, 'firefox'
+    mp.may_require :plugin, 'flash', :min_version => '8', :cdata => 'abcd'
+    
+    assert_equal({:type => :browser, :value => 'firefox'}, mp.may_be_required.first)
+    assert_equal({:type => :plugin, :value => 'flash', :min_version => '8', :cdata => 'abcd'}, mp.may_be_required.last)
+  end
+  
+  def test_locale_without_required_params
+    mp = ModulePreferences.new
+    assert_raise(ArgumentError) do
+      mp.supports_locale :messages => 'bundle.xml'
+      mp.supports_locale {}
+    end
+    assert_equal [], mp.supported_locales
+  end
+  
+  def test_locale_with_required_params
+    mp = ModulePreferences.new
+    en_locale = {:lang => :en, :country => :us, :messages => 'bundle.xml'}
+    ar_locale = {:lang => :ar}
+    mp.supports_locale en_locale
+    mp.supports_locale ar_locale
+
+    assert_equal [en_locale, ar_locale], mp.supported_locales
+  end
+  
+  def test_forwards_to_super_after_method_missing_chain
+    assert_raise(NoMethodError) do
+      mp = ModulePreferences.new
+      mp.hello
+    end
+  end
+  
+  def test_to_xml_writes_attributes_hash_as_xml_element_attributes
+    mp = ModulePreferences.new :title => 'farooq'
+    xml = ''
+    builder = Builder::XmlMarkup.new(:target => xml)
+    mp.to_xml(builder)
+    
+    #verify generated xml:
+    doc = Document.new xml
+    assert_xpath doc, "/ModulePrefs", :title => 'farooq'
+  end
+  
+  def test_to_xml_writes_Require_and_MayRequire_and_Locale
+    mp = ModulePreferences.new
+    mp.require_features :setprefs, :hello
+    mp.may_require :plugin, 'flash'
+    mp.may_require :browser, 'firefox'
+    mp.supports_locale :country => :us, :lang => :en
+    
+    xml = ''
+    builder = Builder::XmlMarkup.new(:target => xml)
+    mp.to_xml(builder)
+    
+    #verify generated xml:
+    doc = Document.new xml
+    assert_xpath doc, "/ModulePrefs"
+    assert_xpath doc, "/ModulePrefs/Require", :feature => :setprefs
+    assert_xpath doc, "/ModulePrefs/Require", :feature => :hello
+    assert_xpath doc, "/ModulePrefs/MayRequire", :type => :plugin, :value => 'flash'
+    assert_xpath doc, "/ModulePrefs/MayRequire", :type => :browser, :value => 'firefox'
+    assert_xpath doc, "/ModulePrefs/Locale", :country => :us, :lang => :en
+  end
+end

data/test/test_sticky_attributes.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'date'
+
+class StickyAttributesTest < Test::Unit::TestCase
+  include InspectorGadget
+  
+  def test_calling_setters_and_then_getters
+    super_glue = Object.new.extend StickyAttributes
+    
+    {:brand => "UHU",
+    :strength => 100,
+    :sticks_to => :everything}.each do |attr_name,attr_value|
+      
+      #test w/ and w/o equals operator (e.g. super_glue.brand= and super_glue.brand)
+      ["#{attr_name}=", attr_name].each do |method_name|
+        super_glue.send method_name, attr_value
+        assert_equal attr_value, super_glue.instance_variable_get("@#{attr_name}")
+        assert_equal attr_value, super_glue.send(attr_name)
+        
+        #only needed for explicit sticky attributes:
+        assert_respond_to super_glue, method_name
+      end
+    end
+  end
+
+  def test_forwards_method_missing_to_super_if_the_attribute_is_not_defined
+    assert_raise(NoMethodError) { Object.new.extend(StickyAttributes).title }
+  end
+end

data/test/test_user_preference.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'rexml/document'
+
+class UserPreferenceTest < Test::Unit::TestCase
+  include InspectorGadget
+  include REXML
+  
+  def test_instantiating_with_hash_sets_attributes
+    mp = UserPreference.new :name => 'helloworldexample'
+    assert_equal 'helloworldexample', mp.name
+  end
+  
+  def test_create_user_preference_with_enum
+    up = UserPreference.new
+    up.name = "mycolor"
+    up.display_name "Color"
+    up.default_value "Yellow"
+    up.datatype "enum"
+    up.enum_values "Red", "Green", "Yellow", "Blue", "Pink", "Orange"
+    
+    assert_equal "mycolor", up.name
+    assert_equal "Color", up.display_name
+    assert_equal "Yellow", up.default_value
+    assert_equal "enum", up.datatype
+    assert_equal ["Red", "Green", "Yellow", "Blue", "Pink", "Orange"], up.enum_values
+  end
+  
+  def test_to_xml
+    attributes = { :name => "mycolor", :display_name => "Color" }
+    up = UserPreference.new attributes
+    xml = ""
+    up.to_xml(Builder::XmlMarkup.new(:target => xml))
+    
+    doc = Document.new(xml)
+    assert_xpath(doc, "/UserPref", attributes)
+  end
+  
+  def test_serializes_default_value_for_list_datatypes
+    up = UserPreference.new
+    up.datatype = "list"
+    up.default_value ["zdnet", "pc", "Apple Insider"]
+    xml = ""
+    up.to_xml(Builder::XmlMarkup.new(:target => xml))
+    doc = Document.new(xml)
+    assert_xpath(doc, "/UserPref", :datatype => "list", :default_value => "zdnet|pc|Apple Insider")
+  end
+end

data/test/xml_test_helper.rb

@@ -0,0 +1,12 @@
+module XmlTestHelper
+  #asserts number of elements returned by an xpath (executed on a ReXML doc)
+  def assert_xpath(doc, path, attributes = {}, expected_matches = 1)
+    xpath = path + "[" + attributes.collect{|k,v| "@#{k}='#{v}'"}.join(' and ') + "]"
+    assert_equal expected_matches, doc.get_elements(xpath).length
+  end
+
+  #first matching element's first cdata
+  def cdata_value(doc, xpath)
+    doc.root.get_elements(xpath)[0].cdatas[0].value
+  end
+end

data/website/index.html

@@ -0,0 +1,91 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Inspector Gadget
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Inspector Gadget</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/inspectorgadget"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/inspectorgadget" class="numbers">0.0.1</a>
+    </div>
+    <h1>&#x2192; &#8216;inspectorgadget&#8217;</h1>
+
+
+	<h2>What
+InspectorGadget is a ruby <span class="caps">API</span> to create universal google gadget specifications</h2>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">inspectorgadget</span></pre></p>
+
+
+	<h2>Usage and examples at <a href="http://jroller.com/page/abstractScope/entry/inspector_gadget" title=":ruby">InspectorGadget by got?</a></h2>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/inspectorgadget">http://groups.google.com/group/inspectorgadget</a></p>
+
+
+	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; inspectorgadget</p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/inspectorgadget/trunk</code> for anonymous access.</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Shoot me an email anytime (<a href="mailto:farooq@thoughtworks.com">farooq@thoughtworks.com</a>) or visit my blog at <a href="http://jroller.com/page/abstractScope">got? :ruby</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 9th September 2007<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,35 @@
+h1. Inspector Gadget
+
+h1. → 'inspectorgadget'
+
+
+h2. What
+InspectorGadget is a ruby API to create universal google gadget specifications
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install inspectorgadget</pre>
+
+
+h2. Usage and examples at "InspectorGadget by got?(:ruby)":http://jroller.com/page/abstractScope/entry/inspector_gadget
+
+h2. Forum
+
+"http://groups.google.com/group/inspectorgadget":http://groups.google.com/group/inspectorgadget
+
+TODO - create Google Group - inspectorgadget
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/inspectorgadget/trunk</code> for anonymous access.
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Shoot me an email anytime ("farooq@thoughtworks.com":mailto:farooq@thoughtworks.com) or visit my blog at "got? :ruby":http://jroller.com/page/abstractScope
+