jqueryplugingen 0.1.4 → 0.2.0

data/History.txt

@@ -1,3 +1,14 @@
+0.2.0  2009-06-08
+
+* rewrite of js plugin structure/code
+* add rake bootstrap sequence
+* add rake open tasks to browser for testing
+
+== 0.1.5 2009-06-08
+
+* add jsspec library
+* add acceptance tests
+
 == 0.1.4 2009-06-08
 
 * BUG-FIX: plugin name was hardcoded on rake compile

data/Manifest.txt

@@ -169,7 +169,11 @@ lib/jquery_plugin_gen/support/build.rake
 lib/jquery_plugin_gen/support/bundles.rake
 lib/jquery_plugin_gen/support/jquery.rake
 lib/jquery_plugin_gen/support/package.rake
+lib/jquery_plugin_gen/support/test.rake
 lib/jquery_plugin_gen/tasks.rb
+lib/jsspec/JSSpec.css
+lib/jsspec/JSSpec.js
+lib/jsspec/diff_match_patch.js
 lib/packer/Pack.pm
 lib/packer/ParseMaster.pm
 lib/packer/jsPacker.pl
@@ -178,6 +182,7 @@ lib/templates/README.txt.erb
 lib/templates/Rakefile.erb
 lib/templates/example.html.erb
 lib/templates/src/plugin.js.erb
+lib/templates/test/acceptance.html.erb
 lib/templates/test/spec_plugin.js.erb
 lib/templates/test/specs.html.erb
 script/console

data/README.rdoc

@@ -9,10 +9,10 @@ Generate the structure of jquery plugins easily. Manage library dependencies suc
 
 == FEATURES/PROBLEMS:
 
+* CAN't have a '-' or '.' in the project name [need to split plugin name and filename :-)]
+* refactor jquery.rake task like compiletask as it is pretty ugly and has some spaghetti going on
 * be able to use the produced code on linux and windows (need jqp.bat)
-* bundle up jsspec
 * include qunit
-* add acceptance test
 * add hoe-type features for updating plugins to jquery plugin page (as rake tasks)
 * be able to bundle/package library dependencies
 * be able to switch  between local and remote libraries in actual html pages (perhaps this is the release bundle)
@@ -23,28 +23,89 @@ Generate the structure of jquery plugins easily. Manage library dependencies suc
 
   jqp -p myplugin
 
-This will generate:
+jQuery plugin generator to help you kick start your plugin development with the following structure:
+   
+    plugin
+      /src
+        /css
+        /images
+        query.plugin.js
+      /test
+        spec_plugin.js
+        acceptance_plugin.js
+        specs.html
+        acceptance.html
+      /lib
+       /jsspec
+       jquery.min.js
+       jquery-ui.js
+       /themes
+         /base
+      example.html
+      Rakefile
+      History.txt
+      README.txt
+
+It will generate a base plugin of the structure:
+
+;(function($) {
+  
+  $.jquery.test = {
+		VERSION: "0.0.1",
+		defaults: {
+			key: 'value'
+		}
+	};
+
+	$.fn.extend({	  
+	  jquery.test: function(settings) {   
+      settings = $.extend({}, $.jquery.test.defaults, settings);    
+      return this.each( function(){
+        self = this;
+        
+        // NOTE: semicolons are needed more if you are planning on packing your code
+        console.log(this);
+        console.log($(this));
+        console.log($.jquery.test.VERSION);
+        console.log($.jquery.test.defaults.key);
+         // your plugin
+        
+      })
+		}
+	  
+	})
+})(jQuery);
+
+And a base set of jsspec tests all hooked into an html page ready to go:
+
+describe('The tests can load', {
+  
+  'before': function() {  
+   },
+   
+   'after': function(){
+   },
+	
+	'should load': function(){
+    
+	},
+	
+})
+
+Once you have written your code. You have three views of the plugin:
+
+ 1. Acceptance: rake acceptance (compiles and loads tests in browser)
+ 2. Specs: rake specs (loads tests in browser)
+ 3. Example: rake show (compiles and loads the sample page in a browser)
+
+Finally, package your plugin ready for uploading the plugins.jquery.com
+
+  rake package
 
- /src
-  jquery.myplugin.js
- /test
-   spec_myplugin.js
-   specs.html
- example.html
- /lib
- Rakefile
- Makefile
-
-Once you have written your code:
-
-(a) test with jsspec at test/specs.html
-(b) package with make and see the results in /dist
 
 == REQUIREMENTS:
 
-* jquery
-* jspec
-* a packer (currently linux or cygwin)
+* jquery (installed with rake:jquery:add)
 
 == INSTALL:
 

data/lib/jqp/cli.rb

@@ -4,13 +4,11 @@ module Jqp
   class CLI
     def self.execute(stdout, arguments=[])
 
-      # NOTE: the option -p/--path= is given as an example, and should be replaced in your application.
-
       options = {
-        :project     => '~jq-plugin',
+        :project     => 'jqplugin',
         :version     => '0.0.1'
       }
-      mandatory_options = %w(  )
+      mandatory_options = %w(project)
 
       parser = OptionParser.new do |opts|
         opts.banner = <<-BANNER.gsub(/^          /,'')
@@ -23,8 +21,16 @@ module Jqp
                query.plugin.js
              /test
                spec_plugin.js
-             /dist
-             Makefile
+               acceptance_plugin.js
+               specs.html
+               acceptance.html
+             /lib
+              /jsspec
+              jquery.min.js
+              jquery-ui.js
+              /themes
+                /base
+             example.html
              Rakefile
              History.txt
              README.txt
@@ -51,7 +57,31 @@ module Jqp
 
       JqueryPluginGen::Generator.execute(options)
       
-      stdout.puts "To update this executable, look in lib/jqp/cli.rb"
+      stdout.puts <<-MSG
+      
+**********************************************************
+
+Now include the jQuery libraries with:
+
+  cd <jq-plugin>
+  rake first_time
+
+First time will:
+ - add jquery core, ui and base themes
+ - compile js to a packed version (see build directory)
+ - load three html files in your browser to demon
+    1. Acceptance tests
+    2. Spec tests
+    3. Example page
+    
+Note: you don't have to add jquery core, ui and themes.
+However, if you don't you will need to update the html 
+pages (example.html, test/spec.html). To see other options
+use rake -T
+
+**********************************************************
+
+MSG
     end
   end
 end

data/lib/jquery_plugin_gen/compiletask.rb

@@ -100,7 +100,6 @@ module Rake
     def define
       fail "Name required (or :noversion)" if @name.nil?
       @name = nil if :noname == @name
-      
 
       desc "Build all the packages"
       task :compile => :pack do
@@ -120,6 +119,7 @@ module Rake
       
       desc "Merge js files into one"
       task :merge do
+        FileUtils.mkdir(package_dir_path) rescue nil
         `#{sed_command}`
       end
       

data/lib/jquery_plugin_gen/generator.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'rake'
 
 module JqueryPluginGen
   class Generator
@@ -6,7 +7,11 @@ module JqueryPluginGen
     def self.base_dirs
       %w(src lib test src/images src/css test/data tasks)
     end
-       
+    
+    def self.copy_jsspec
+      FileUtils.cp_r(File.join(File.dirname(__FILE__), "../jsspec"), 'lib')
+    end
+    
     def self.execute(args)
       
       project = args[:project]
@@ -30,18 +35,23 @@ module JqueryPluginGen
           puts "creating: #{path}"
           Dir.mkdir path
         end
+        
+        copy_jsspec
 
-       details = args
+        details = args
         files = {
+          "Rakefile" => QuickTemplate.erb('Rakefile', details),
           "History.txt" => QuickTemplate.erb('History.txt', details),
           "README.txt" => QuickTemplate.erb('README.txt', details),
+          "example.html" => QuickTemplate.erb('example.html', details),
           "src/#{file_name}.js" => QuickTemplate.erb('src/plugin.js', details),
-          "test/spec_#{file_name}.js" => QuickTemplate.erb('test/spec_plugin.js', details),
-          "Rakefile" => QuickTemplate.erb('Rakefile', details),
           "src/css/screen.#{file_name}.css" => "",
           "test/specs.html" => QuickTemplate.erb('test/specs.html', details),
+          "test/spec_#{file_name}.js" => QuickTemplate.erb('test/spec_plugin.js', details),
           "test/data/#{file_name}_01.json" => "",
           "test/data/#{file_name}_01.js" => "",
+          "test/acceptance.html" => QuickTemplate.erb('test/acceptance.html', details),
+          "test/acceptance_#{file_name}.js" => QuickTemplate.erb('test/spec_plugin.js', details),
          }
 
         files["Manifest.txt"] = files.keys.sort.join("\n")
@@ -52,7 +62,8 @@ module JqueryPluginGen
             f.write content
           end
         end
-      end
+        
+       end
     end    
     
   end

data/lib/jquery_plugin_gen/support/build.rake

@@ -10,4 +10,4 @@ CLEAN.include %w( build )
 require 'jquery_plugin_gen/compiletask'
 
 desc "Compile tasks"
-Rake::CompileTask.new(PLUGIN)
+Rake::CompileTask.new(JQUERY_PLUGIN)

data/lib/jquery_plugin_gen/support/jquery.rake

@@ -1,76 +1,75 @@
 begin
-  %w[rake fileutils simple-rss open-uri].each { |f| require f }
+  %w[rake tmpdir fileutils simple-rss open-uri].each { |f| require f }
 rescue LoadError
   require 'rubygems' unless ENV['NO_RUBYGEMS']
   %w[rake tmpdir fileutils simple-rss open-uri].each { |f| require f }
 end
 
 lib_dir = 'lib'
+tmp_dir = Dir.tmpdir
 
 namespace :jquery do
   
   desc "Add latest jquery core, ui and themes to #{lib_dir}"
-  task :all => ['core:add', 'ui:add', 'themes:add']
+  task :add => [:add_core, :add_ui, :add_themes]
 
-  namespace :core do
-   
-    desc "List versions of released packages"
-     task :packages do
-       versions(jquery_atom){ |e| e.title }
-     end
-   
-    desc "List jQuery packages available"
-    task :versions do
-      versions(jquery_atom){ |e| e.title.gsub(/jquery-(\d\.\d\.\d|\d\.\d).*/, '\1') }
-    end
+  desc "Add latest jQuery to library"
+  task :add_core do
+    uri = first(jquery_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') if e.title.include?('.min.js') }
+    get_and_install(uri, lib_dir, 'jquery.min.js')  
+  end
   
-    desc "Add latest jQuery to library"
-    task :add do
-      uri = first(jquery_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') if e.title.include?('.min.js') }
-      get_and_install(uri, lib_dir, 'jquery.min.js')  
-    end
-    
-    desc "Add specific version of jQuery library: see with VERSION=X.X.X on command line"
-    task :add_version do
-      version = ENV['VERSION']
-      return puts('No version specified - add VERSION=X.X.X to rake command') if version.nil?
-      uri = first(jquery_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') if e.title.include?(version) }
-      return puts("Specified version #{version} not found in repository - use rake jquery:core:versions to determine available versions") if uri.nil?
-      get_and_install(uri, lib_dir, "jquery-#{version}.min.js") 
-    end
+  desc "Add latest jQueryUI (without theme) to library"
+  task :add_ui do
+    uri =  first(jqueryui_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') unless e.title.include?('themes') }  
+    file = uri.gsub(/.*files\/(.*)(\d.\drc\d.\d|\d.\drc\d|\d\.\d\.\d|\d\.\d)(.*)/, '\1\2\3') 
+    get_and_install(uri, tmp_dir, file)
+    unzip_and_install(lib_dir, tmp_dir, file)
   end
 
-  namespace :ui do
-  
-    desc "List versions of released packages"
-    task :packages do   
-      versions(jqueryui_atom){ |e| e.title }
-    end
-  
-    desc "List jQuery UI packages available"
-    task :versions do
-      versions(jqueryui_atom){ |e| e.title.gsub(/.*-(\d.\drc\d.\d|\d.\drc\d|\d\.\d\.\d|\d\.\d).*/, '\1') }
-    end  
-  
-    desc "Add latest jQueryUI (without theme) to library"
-    task :add do
-      uri =  first(jqueryui_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') unless e.title.include?('themes') }  
-      file = uri.gsub(/.*files\/(.*)(\d.\drc\d.\d|\d.\drc\d|\d\.\d\.\d|\d\.\d)(.*)/, '\1\2\3') 
-      get_and_install(uri, lib_dir, file)
-      unzip_and_install(lib_dir, file)
-    end
+  desc "Add all themes to libary"
+  task :add_themes do
+    uri =  first(jqueryui_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') if e.title.include?('themes') }  
+    file = uri.gsub(/.*files\/(.*)(\d.\drc\d.\d|\d.\drc\d|\d\.\d\.\d|\d\.\d)(.*)/, '\1\2\3') 
+    get_and_install(uri, tmp_dir, file)
+    unzip_and_install(lib_dir, tmp_dir, file)      
+  end
+
+  desc "Add specific version of jQuery library: see with VERSION=X.X.X on command line"
+  task :add_version do
+    version = ENV['VERSION']
+    return puts('No version specified - add VERSION=X.X.X to rake command') if version.nil?
+    uri = first(jquery_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') if e.title.include?(version) }
+    return puts("Specified version #{version} not found in repository - use rake jquery:core:versions to determine available versions") if uri.nil?
+    get_and_install(uri, lib_dir, "jquery-#{version}.min.js") 
+  end
+
+  desc "List all versions for core and ui "
+  task :versions => [:versions_core, :versions_ui]
+ 
+  desc "List jQuery packages available"
+  task :versions_core do
+    versions(jquery_atom){ |e| e.title.gsub(/jquery-(\d\.\d\.\d|\d\.\d).*/, '\1') }
   end
   
-  namespace :themes do
-   
-    desc "Add all themes to libary"
-    task :add do
-      uri =  first(jqueryui_atom){ |e| e.content.gsub(/.*a href="(.*)".*/m, '\1') if e.title.include?('themes') }  
-      file = uri.gsub(/.*files\/(.*)(\d.\drc\d.\d|\d.\drc\d|\d\.\d\.\d|\d\.\d)(.*)/, '\1\2\3') 
-      get_and_install(uri, lib_dir, file)
-      unzip_and_install(lib_dir, file)      
+  desc "List jQuery UI packages available"
+  task :versions_ui do
+    versions(jqueryui_atom){ |e| e.title.gsub(/.*-(\d.\drc\d.\d|\d.\drc\d|\d\.\d\.\d|\d\.\d).*/, '\1') }
+  end  
+
+  desc "List all packages for core and ui"
+  task :packages => [:packages_core, :packages_ui]
+
+  desc "List versions of released packages"
+    task :packages_core do
+      versions(jquery_atom){ |e| e.title }
     end
-  end       
+
+  desc "List versions of released packages"
+  task :packages_ui do   
+    versions(jqueryui_atom){ |e| e.title }
+  end
+          
 end
 
   
@@ -115,29 +114,39 @@ def get_and_install(uri, path, file)
   
   File.open(new_file, 'w') do |file|
     download.open { |jq| jq.each_line {|line| file.puts line} }    
-  end
+  end unless File.exists?(new_file)
   new_file
 end
 
-def unzip_and_install(path, file)
+def unzip_and_install(dest, tmp_dir, file)
   
-  path = File.join(File.dirname(__FILE__), path)
-  extracted_folder = File.join(Dir.tmpdir, file.gsub(/(.*)\.zip/, '\1'))
+  puts tmp_dir
+  # dest = File.join(dest)
+  extracted_folder = File.join(tmp_dir, file.gsub(/(.*)\.zip/, '\1'))
 
   if /mswin|mingw/ =~ RUBY_PLATFORM then
     zip = ENV['ZIP'] || '7z'
     puts "Extracting using #{zip} - this should be on your path or set the ZIP=path/to/zip/cmd on rake command"
-    `#{zip} #{file} -o #{Dir.tmpdir}`
+    `#{zip} #{tmp_dir}/#{file} -o #{tmp_dir}`
   else
-    puts 'Extracting files'
-    `unzip -o #{path}/#{file} -d #{Dir.tmpdir}`
+    puts "Extracting files #{tmp_dir}/#{file} to #{tmp_dir}"
+    `unzip -o #{tmp_dir}/#{file} -d #{tmp_dir}`
   end
    
-   puts 'Copying ui and themes'
-   FileUtils.cp Dir.glob("#{extracted_folder}/ui/jquery*.js") , path
-   FileUtils.cp_r "#{extracted_folder}/themes", path
+   puts "Copying ui and themes in #{extracted_folder} to #{dest}"
+   FileUtils.cp(Dir.glob("#{extracted_folder}/ui/jquery*.js"), dest) rescue nil
+   
+   begin
+     FileUtils.cp_r("#{patch_themes_path(extracted_folder)}/themes", dest)
+   rescue LoadError
+     puts "Error in the way JQuery Themes was packaged please contact gem owner for patch"
+   end
    
    puts 'Cleaning extracted files'
-   FileUtils.rm "#{path}/#{file}"
+   # FileUtils.rm "#{tmp_dir}/#{file}"  # I'm allowing for caching
    FileUtils.rm_rf extracted_folder
 end
+
+def patch_themes_path(extracted_path)
+  extracted_path.gsub(/1.7.2.0/, '1.7.2')
+end