inspectorgadget 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2007-09-09
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2007 FIXME full name
+
+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.

data/Manifest.txt

@@ -0,0 +1,38 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/inspectorgadget.rb
+lib/inspectorgadget/version.rb
+lib/inspectorgadget/dsl_attr_accessor.rb
+lib/inspectorgadget/google_gadget_spec.rb
+lib/inspectorgadget/module_preferences.rb
+lib/inspectorgadget/sticky_attributes.rb
+lib/inspectorgadget/user_preference.rb
+log/debug.log
+script/destroy
+script/destroy.cmd
+script/generate
+script/generate.cmd
+script/txt2html
+script/txt2html.cmd
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_inspectorgadget.rb
+test/test_dsl_attribute_accessor.rb
+test/test_google_gadget_spec.rb
+test/test_module_preferences.rb
+test/test_sticky_attributes.rb
+test/test_user_preference.rb
+test/xml_test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1 @@
+README

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'inspectorgadget/version'
+
+AUTHOR = 'Farooq Ali'  # can also be an array of Authors
+EMAIL = "farooq@thoughtworks.com"
+DESCRIPTION = "Universal Google Gadget specification DSL"
+GEM_NAME = 'inspectorgadget' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'inspectorgadget' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Inspectorgadget::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'inspectorgadget documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\\n\\n")
+  p.extra_deps = ['builder']     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'inspectorgadget'

data/lib/inspectorgadget/dsl_attr_accessor.rb

@@ -0,0 +1,15 @@
+module InspectorGadget
+  module DslAttrAccessor
+  
+    def dsl_attr_accessor(*attrs)
+      attrs.each do |attr|
+        attr_writer attr
+        define_method attr do |*args|
+          instance_variable_set("@#{attr}", args.first) unless args.empty?
+          instance_variable_get("@#{attr}")
+        end
+      end
+    end
+    
+  end
+end

data/lib/inspectorgadget/google_gadget_spec.rb

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'builder'
+
+module InspectorGadget
+  
+  class GoogleGadgetSpec
+    extend DslAttrAccessor
+    attr_accessor :user_prefs
+    dsl_attr_accessor :content, :content_type, :content_href
+    
+    def initialize(&block)
+      @module_prefs = ModulePreferences.new
+      @user_prefs = []
+      @content_type = :html
+      instance_eval(&block) if block_given?
+      self
+    end
+      
+    def content(*args)
+      return @content if args.empty?
+      value = args.pop
+      if value.is_a?(Hash) && value.key?(:url)
+        @content_type, @content_href = :url, value[:url]
+      else
+        @content = value
+      end
+    end
+    
+    def module_prefs(&block)
+      yield @module_prefs if block_given?
+      @module_prefs
+    end
+    
+    def user_pref(*args, &block)
+      up = UserPreference.new(*args)
+      up.instance_eval(&block) if block_given?
+      @user_prefs << up
+    end
+  
+    def method_missing(name, *args)
+      begin
+        @module_prefs.send(name, *args)
+      rescue NoMethodError
+        super.send(name, *args)
+      end
+    end
+    
+    def to_xml(target = '')
+      xml = Builder::XmlMarkup.new(:target => target, :indent => 2)
+      xml.instruct!
+      xml.Module do
+        @module_prefs.to_xml(xml)
+        @user_prefs.each {|user_pref| user_pref.to_xml(xml)}
+        puts "Warning: Google will reject your gadget spec's content section because you specified a URL content type" if @content_type == :url && @content
+        content_attrs = {}
+        content_attrs[:type] = @content_type if @content_type
+        content_attrs[:href] = @content_href if @content_href
+        xml.Content content_attrs do
+          xml.cdata! @content.is_a?(IO) ? @content.readlines.join : @content.to_s
+        end
+      end
+      target
+    end
+  end
+  
+end

data/lib/inspectorgadget/module_preferences.rb

@@ -0,0 +1,36 @@
+module InspectorGadget
+
+  class ModulePreferences
+    include StickyAttributes
+    attr_reader :required_features, :may_be_required, :supported_locales
+    
+    def initialize(properties = {})
+      properties.each { |name, value| send name, value } if properties.is_a? Hash
+      @required_features, @may_be_required, @supported_locales = [], [], []
+    end
+    
+    def require_features(*features)
+      @required_features.concat features
+    end
+    
+    def may_require(type, value, optional_params = {})
+      @may_be_required << optional_params.update(:type => type, :value => value)
+    end
+    
+    def supports_locale(options = nil)
+      if options.is_a? Hash
+        raise ArgumentError.new("You must provide the lang and/or country when using supports_locale") unless options.key?(:lang) || options.key?(:country)
+        @supported_locales << options
+      end
+    end
+    
+    def to_xml(xml)
+      xml.ModulePrefs(sticky_attributes) do
+        @required_features.each { |feature| xml.Require :feature => feature }
+        @may_be_required.each { |may_require| xml.MayRequire may_require }
+        @supported_locales.each { |locale| xml.Locale locale }
+      end
+    end
+  end
+
+end

data/lib/inspectorgadget/sticky_attributes.rb

@@ -0,0 +1,26 @@
+module InspectorGadget
+  module StickyAttributes
+    
+    def method_missing(method_name, *args)
+      attr_name = method_name.to_s.split(/=|\?/).first.to_sym
+      unless args.empty?
+        attr_value = args.first
+        eval %(class << self
+                 def #{attr_name}(*attr_args)
+                   @#{attr_name} = attr_args.first unless attr_args.empty?
+                   @#{attr_name}
+                 end
+                 attr_writer :#{attr_name}
+                 alias_method :#{attr_name}?, :#{attr_name}
+               end)
+        sticky_attributes[attr_name] = attr_value
+      end
+      
+      respond_to?(method_name) ? send(method_name, *args) : super
+    end
+    
+    def sticky_attributes
+      @sticky_attributes ||= {}
+    end
+  end
+end

data/lib/inspectorgadget/user_preference.rb

@@ -0,0 +1,40 @@
+module InspectorGadget
+
+  class UserPreference
+    include StickyAttributes
+    
+    def initialize(properties = {})
+      properties.each { |name, value| send name, value } if properties.is_a? Hash
+      @enum_values = []
+    end
+  
+    def enum_values(*values)
+      @enum_values = values.flatten unless values.empty?
+      @enum_values
+    end
+    
+    def is_required
+      self.required = true
+    end
+    
+    def is_optional
+      self.required = false
+    end
+    
+    def to_xml(xml)
+      default_vals = sticky_attributes[:default_value].to_a.flatten
+      if sticky_attributes[:datatype].to_s == 'list' && !default_vals.empty?
+        sticky_attributes[:default_value] = default_vals.join('|')
+      end
+      
+      write_enum_values = proc do
+                            enum_values.each do |enum_value|
+                              xml.EnumValue :value => enum_value
+                            end
+                          end
+                          
+      enum_values.empty?? xml.UserPref(sticky_attributes) : xml.UserPref(sticky_attributes,&write_enum_values)
+    end
+  end
+
+end

data/lib/inspectorgadget/version.rb

@@ -0,0 +1,9 @@
+module Inspectorgadget #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/inspectorgadget.rb

@@ -0,0 +1,15 @@
+$:.unshift File.dirname(__FILE__)
+
+Dir.chdir(File.dirname(__FILE__)+'/inspectorgadget') do
+  require 'version'
+  require 'dsl_attr_accessor'
+  require 'sticky_attributes'
+  require 'user_preference'
+  require 'module_preferences'
+  require 'google_gadget_spec'
+  
+#  Dir['inspectorgadget/**/*.rb'].each { |f| puts f; require f }
+end
+
+module Inspectorgadget
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/destroy.cmd

@@ -0,0 +1 @@
+@ruby script/destroy %*

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.join(File.dirname(__FILE__), '..')
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/generate.cmd

@@ -0,0 +1 @@
+@ruby script/generate %*

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/inspectorgadget/version.rb'
+
+version  = Inspectorgadget::VERSION::STRING
+download = 'http://rubyforge.org/projects/inspectorgadget'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.rhtml')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/script/txt2html.cmd

@@ -0,0 +1 @@
+@ruby script/txt2html %*