youpy-newextension 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,9 @@
+# stubs for the website generation
+# To install the website framework:
+#   script/generate website
+
+task :website_generate
+
+task :website_upload
+
+task :website => :publish_docs

data/templates/Rakefile

@@ -0,0 +1,88 @@
+# based on: http://gravelog.blogspot.com/2007/03/using-rake-to-build-firefox-extensions_04.html
+require 'rexml/document'
+include REXML
+
+EXTENSION_NAME="<%=extension_name%>"
+BUILD_DIR="build/#{EXTENSION_NAME}"
+
+directory "#{BUILD_DIR}/chrome"
+task :create_buildchrome_dir => ["#{BUILD_DIR}/chrome"]
+
+desc "prepare the chrome.manifest file"
+file "#{BUILD_DIR}/chrome.manifest" => [:create_buildchrome_dir] do
+  open("#{BUILD_DIR}/chrome.manifest",'w') do |infile|
+    open("chrome.manifest", "r") do |outfile|
+      while line = outfile.gets
+        infile.puts line.gsub(/chrome\//, "jar:chrome/#{EXTENSION_NAME}.jar!/")
+      end
+    end
+  end
+end
+task :create_chrome_manifest => ["#{BUILD_DIR}/chrome.manifest"]
+
+desc "prepare the install.rdf file"
+file "#{BUILD_DIR}/install.rdf" => [:create_buildchrome_dir] do
+  cp 'install.rdf', "#{BUILD_DIR}/install.rdf"
+end
+task :create_install_rdf => ["#{BUILD_DIR}/install.rdf"]
+
+desc "create the chrome jar file"
+task :create_chrome_jar => [:create_buildchrome_dir] do
+  sh "cd chrome && zip -qr -0 ../#{BUILD_DIR}/chrome/#{EXTENSION_NAME}.jar * -x \*.svn\*"
+end
+
+desc "create the xpi file and use the version number in the file name"
+task :create_extension_xpi => [:create_chrome_jar, :create_chrome_manifest, :create_install_rdf] do
+  install_rdf_file = File.new('install.rdf','r')
+  install_rdf_xmldoc = Document.new(install_rdf_file)
+  version_number = ""
+  install_rdf_xmldoc.elements.each('RDF/Description/em:version') do |element|
+    version_number = element.text
+  end
+
+  sh "cd #{BUILD_DIR} && zip -qr -9 ../../#{EXTENSION_NAME}-#{version_number}-fx.xpi *"
+  rm_rf "build"
+end
+
+desc "install to local profile directory"
+task :install do
+  File.open("#{firefox_profile_dir}/extensions/#{extension_id}", 'w') do |f|
+    f.puts(Dir.pwd)
+  end
+end
+
+desc "uninstall from local profile directory"
+task :uninstall do
+  File.unlink("#{firefox_profile_dir}/extensions/#{extension_id}")
+end
+
+def firefox_profile_dir(name = nil)
+  name = 'default' unless name
+  
+  base = 
+    case RUBY_PLATFORM
+    when /darwin/
+      '~/Library/Application Support/Firefox/profiles'
+    when /win/
+      '~/Application Data/Mozilla/Firefox/Profiles'
+    else
+      '~/.mozilla/firefox'
+    end
+
+  path = Dir.glob("#{File.expand_path(base)}/*.#{name}")
+
+  if path.length == 1
+    path.first
+  else
+    raise
+  end
+end
+
+def extension_id
+  open('install.rdf','r') do |file|
+    install_rdf_xmldoc = Document.new(file)
+    install_rdf_xmldoc.elements.each('RDF/Description/em:id') do |element|
+      return element.text
+    end
+  end
+end

data/templates/chrome/content/__extension__.js

@@ -0,0 +1,2 @@
+var <%=camelize(extension_name)%> = function() {};
+<%=camelize(extension_name)%>.prototype = {};

data/templates/chrome/content/overlay.xul

@@ -0,0 +1,8 @@
+<?xml version="1.0" ?>
+<overlay id="<%=camelize(extension_name)%>Overlay" xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
+  <script type="application/x-javascript"
+	  src="chrome://<%=package_name%>/content/<%=camelize(extension_name)%>.js" />
+  <menupopup id="menu_ToolsPopup">
+    <menuitem label='<%=extension_name%>' oncommand='alert("hello. this is <%=extension_name%>")'/>
+  </menupopup>
+</overlay>

data/templates/chrome.manifest

@@ -0,0 +1,3 @@
+content	<%=package_name%>	chrome/content/
+overlay	chrome://browser/content/browser.xul	chrome://<%=package_name%>/content/overlay.xul
+skin	<%=package_name%>	classic/1.0	chrome/skin/

data/templates/install.rdf

@@ -0,0 +1,19 @@
+<?xml version="1.0"?>
+<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+    xmlns:em="http://www.mozilla.org/2004/em-rdf#">
+    <Description about="urn:mozilla:install-manifest">
+        <em:id>{<%=uuid%>}</em:id>
+        <em:name><%=camelize(extension_name)%></em:name>
+        <em:version><%=version%></em:version>
+        <em:type>2</em:type>
+        <em:description>Description about this extension</em:description>
+        <em:creator><%=author%></em:creator>
+        <em:targetApplication>
+            <Description>
+                <em:id>{ec8030f7-c20a-464f-9b0e-13a3a9e97384}</em:id>
+                <em:minVersion>1.5</em:minVersion>
+                <em:maxVersion>3.0.*</em:maxVersion>
+            </Description>
+        </em:targetApplication>
+    </Description>
+</RDF>

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/newextension'
+
+module Test::Unit::Assertions
+  def assert_file_contains(pattern, filename, message = '')
+    _wrap_assertion do
+      pattern = case(pattern)
+                when String
+                  Regexp.new(Regexp.escape(pattern))
+                else
+                  pattern
+                end
+      full_message = build_message(message, "content of file <?> expected to be =~\n<?>.", filename, pattern)
+      assert_block(full_message) { File.open(filename).read =~ pattern }
+    end
+  end
+end

data/test/test_newextension.rb

@@ -0,0 +1,43 @@
+require 'fileutils'
+require 'pathname'
+
+include FileUtils
+
+class TestNewextension < Test::Unit::TestCase
+  def setup
+    @testdir = Pathname.new(File.dirname(__FILE__) + '/foo_extension')
+    system(Pathname.new(File.dirname(__FILE__)).realpath + '../bin/newextension',
+           '-a youpy',
+           '-V 0.11',
+           @testdir)
+  end
+
+  def teardown
+    rm_rf @testdir
+  end
+
+  def test_create
+    assert File.directory?(@testdir)
+    cd @testdir do
+      assert_equal([
+                    'chrome',
+                    'chrome/content',
+                    'chrome/content/FooExtension.js',
+                    'chrome/content/overlay.xul',
+                    'chrome/skin',
+                    'chrome.manifest',
+                    'install.rdf',
+                    'Rakefile',
+                   ].sort, Dir['**/*'].sort)
+
+      assert_file_contains(/FooExtension/, 'chrome/content/FooExtension.js')
+      assert_file_contains(/FooExtension/, 'chrome/content/FooExtension.js')
+      assert_file_contains(/chrome:\/\/fooextension/, 'chrome/content/overlay.xul')
+      assert_file_contains(/FooExtensionOverlay/, 'chrome/content/overlay.xul')
+      assert_file_contains(/chrome:\/\/fooextension/, 'chrome.manifest')
+      assert_file_contains(/youpy/, 'install.rdf')
+      assert_file_contains(/0\.11/, 'install.rdf')
+      assert_file_contains(/EXTENSION_NAME="foo_extension"/, 'Rakefile')
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: youpy-newextension
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- youpy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-17 00:00:00 -07:00
+default_executable: newextension
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Create a Firefox extension skeleton
+email: youpy@buycheapviagraonlinenow.com
+executables: 
+- newextension
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/newextension
+- config/hoe.rb
+- config/requirements.rb
+- lib/newextension.rb
+- lib/newextension/version.rb
+- script/destroy
+- script/generate
+- setup.rb
+- tasks/deployment.rake
+- tasks/environment.rake
+- tasks/website.rake
+- templates/chrome/content/__extension__.js
+- templates/chrome/content/overlay.xul
+- templates/chrome/skin
+- templates/chrome.manifest
+- templates/install.rdf
+- templates/Rakefile
+- test/test_helper.rb
+- test/test_newextension.rb
+has_rdoc: true
+homepage: http://newextension.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: newextension
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Create a Firefox extension skeleton
+test_files: 
+- test/test_helper.rb
+- test/test_newextension.rb