newjs 1.0.1 → 1.0.2

data/History.txt

@@ -1,3 +1,10 @@
+== 1.0.2 2008-02-15
+
+* newjs:
+  * rake release VERSION=X.Y.Z to push dist+pkg to rubyforge
+* website:
+  * added 'how to configure website upload'
+
 == 1.0.1 2008-02-15
 
 * 1 major bugfix:

data/Manifest.txt

@@ -16,6 +16,7 @@ app_generators/newjs/templates/script/js_autotest
 app_generators/newjs/templates/script/rstakeout
 app_generators/newjs/templates/src/HEADER.erb
 app_generators/newjs/templates/src/library.js.erb
+app_generators/newjs/templates/tasks/deploy.rake
 app_generators/newjs/templates/tasks/environment.rake
 app_generators/newjs/templates/tasks/javascript_test_autotest_tasks.rake
 app_generators/newjs/templates/test/assets/prototype.js

data/app_generators/newjs/newjs_generator.rb

@@ -37,7 +37,7 @@ class NewjsGenerator < RubiGen::Base
       # m.template "template.rb",  "some_file_after_erb.rb"
       # m.file     "file",         "some_file_copied"
       m.file_copy_each %w[unittest.css unittest.js prototype.js], "test/assets"
-      m.file_copy_each %w[javascript_test_autotest_tasks.rake environment.rake], "tasks"
+      m.file_copy_each %w[javascript_test_autotest_tasks.rake environment.rake deploy.rake], "tasks"
       m.file_copy_each %w[javascript_test_autotest.yml.sample], "config"
       m.file_copy_each %w[protodoc.rb jstest.rb], "lib"
       m.file_copy_each %w[README.txt]

data/app_generators/newjs/templates/Rakefile.erb

@@ -12,11 +12,15 @@ require 'rake/packagetask'
 
 $:.unshift File.dirname(__FILE__) + "/lib"
 
+APP_VERSION  = '<%= version_str %>'
+APP_NAME     = '<%= name %>'
+RUBYFORGE_PROJECT = APP_NAME
+APP_FILE_NAME= "#{APP_NAME}.js"
+
 APP_ROOT     = File.expand_path(File.dirname(__FILE__))
 APP_SRC_DIR  = File.join(APP_ROOT, 'src')
 APP_DIST_DIR = File.join(APP_ROOT, 'dist')
 APP_PKG_DIR  = File.join(APP_ROOT, 'pkg')
-APP_VERSION  = '<%= version_str %>'
 
 
 unless ENV['rakefile_just_config']
@@ -29,21 +33,24 @@ task :dist do
   require 'protodoc'
   require 'fileutils'
   FileUtils.mkdir_p APP_DIST_DIR
-  
+
   Dir.chdir(APP_SRC_DIR) do
-    File.open(File.join(APP_DIST_DIR, '<%= name %>.js'), 'w+') do |dist|
-      dist << Protodoc::Preprocessor.new('<%= name %>.js')
+    File.open(File.join(APP_DIST_DIR, APP_FILE_NAME), 'w+') do |dist|
+      dist << Protodoc::Preprocessor.new(APP_FILE_NAME)
     end
   end
+  Dir.chdir(APP_DIST_DIR) do
+    FileUtils.copy_file APP_FILE_NAME, "#{APP_NAME}-#{APP_VERSION}.js"
+  end
 end
 
-Rake::PackageTask.new('<%= name %>', APP_VERSION) do |package|
+Rake::PackageTask.new(APP_NAME, APP_VERSION) do |package|
   package.need_tar_gz = true
   package.package_dir = APP_PKG_DIR
   package.package_files.include(
     '[A-Z]*',
     'config/*.sample',
-    'dist/<%= name %>.js',
+    "dist/#{APP_FILE_NAME}",
     'lib/**',
     'src/**',
     'script/**',
@@ -62,24 +69,24 @@ JavaScriptTestTask.new(:test_units) do |t|
   testcases        = ENV['TESTCASES']
   tests_to_run     = ENV['TESTS']    && ENV['TESTS'].split(',')
   browsers_to_test = ENV['BROWSERS'] && ENV['BROWSERS'].split(',')
-  
+
   t.mount("/dist")
   t.mount("/src")
   t.mount("/test")
-  
+
   Dir["test/*_test.html"].sort.each do |test_file|
     tests = testcases ? { :url => "/#{test_file}", :testcases => testcases } : "/#{test_file}"
     test_filename = test_file[/.*\/(.+?)\.html/, 1]
     t.run(tests) unless tests_to_run && !tests_to_run.include?(test_filename)
   end
-  
+
   %w( safari firefox ie konqueror opera ).each do |browser|
     t.browser(browser.to_sym) unless browsers_to_test && !browsers_to_test.include?(browser)
   end
 end
 
 task :clean_package_source do
-  rm_rf File.join(APP_PKG_DIR, "'<%= name %>'-#{APP_VERSION}")
+  rm_rf File.join(APP_PKG_DIR, "#{APP_NAME}-#{APP_VERSION}")
 end
 
 Dir['tasks/**/*.rake'].each { |rake| load rake }

data/app_generators/newjs/templates/tasks/deploy.rake

@@ -0,0 +1,29 @@
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :dist, :package] do |t|
+  require 'rubyforge'
+  version = APP_VERSION
+  name    = APP_NAME
+  rubyforge_name = RUBYFORGE_PROJECT
+  v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+  abort "Versions don't match #{v} vs #{version}" if v != version
+  pkg = "pkg/#{name}-#{version}"
+
+  if $DEBUG then
+    puts "release_id = rf.add_release #{rubyforge_name.inspect}, #{name.inspect}, #{version.inspect}, \"#{pkg}.tgz\""
+    puts "rf.add_file #{rubyforge_name.inspect}, #{name.inspect}, release_id, \"#{pkg}.gem\""
+  end
+
+  rf = RubyForge.new
+  puts "Logging in"
+  rf.login
+
+  c = rf.userconfig
+  c["release_notes"] = APP_DESCRIPTION if Object.const_defined?("APP_DESCRIPTION")
+  c["release_changes"] = APP_CHANGES   if Object.const_defined?("APP_CHANGES")
+  c["preformatted"] = true
+
+  files = ["#{pkg}.tar.gz", "dist/#{name}-#{version}.js"].compact
+
+  puts "Releasing #{name} v. #{version}"
+  rf.add_release rubyforge_name, name, version, *files
+end

data/lib/newjs/version.rb

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

data/test/test_newjs_generator.rb

@@ -44,6 +44,7 @@ class TestNewjsGenerator < Test::Unit::TestCase
     assert_generated_file   "script/js_autotest"
     assert_generated_file   "tasks/javascript_test_autotest_tasks.rake"
     assert_generated_file   "tasks/environment.rake"
+    assert_generated_file   "tasks/deploy.rake"
     assert_generated_file   "config/javascript_test_autotest.yml.sample"
     assert_generated_file   "src/myproject.js"
     assert_generated_file   "src/HEADER"

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>JavaScript Project Generator</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/newjs"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/newjs" class="numbers">1.0.1</a>
+      <a href="http://rubyforge.org/projects/newjs" class="numbers">1.0.2</a>
     </div>
     <h1>&#x2192; &#8216;newjs&#8217;</h1>
 
@@ -220,15 +220,53 @@ The project&#8217;s version number is automatically inserted into the page
 (change version numbers via <code>APP_VERSION</code> in <code>Rakefile</code>).</p>
 
 
+	<h3>Configuration of website upload</h3>
+
+
+	<p>It is assumed you will upload your website files to rubyforge.org server.
+To push files to an alternate server, modify the <code>tasks/website.rake</code> file.</p>
+
+
+	<p>To configure which rubyforge project to upload to, create <code>config/website.yml</code>.
+There is an example in <code>code/website.yml.sample</code>.</p>
+
+
+	<p>An example might be:</p>
+
+
+<pre>host: nicwilliams@rubyforge.org
+remote_dir: /var/www/gforge-projects/drnicutilities/drnic_js_test_helpers
+</pre>
+
+	<p>Here, the files will be uploaded into the <code>drnicutilities</code> rubyforge
+project, under a sub-directory <code>drnic_js_test_helpers</code>. This site
+would be visible at <a href="http://drnicutilities.rubyforge.org/drnic_js_test_helpers">http://drnicutilities.rubyforge.org/drnic_js_test_helpers</a></p>
+
+
+	<p>If your website lives in its own rubyforge project, then just specify the project
+name, and the website will be uploaded into the root folder.</p>
+
+
+	<p>For example, the website would be available at <a href="http://drnicutilities.rubyforge.org/">http://drnicutilities.rubyforge.org/</a> if your
+configuration was:</p>
+
+
+<pre>host: nicwilliams@rubyforge.org
+remote_dir: /var/www/gforge-projects/drnicutilities
+</pre>
+
+	<h3>Uploading website to server</h3>
+
+
 	<p>To upload the website (and its <span class="caps">CSS</span> etc) run:</p>
 
 
-<pre>rake website</pre>
+<pre>rake website_upload</pre>
+
+	<p>More commonly, to generate and upload the website:</p>
 
-	<p>The default <code>tasks/website.rake</code> file pushes the files
-to a <a href="http://rubyforge.org">rubyforge.org</a> project account. Modify it
-to rsync files elsewhere.</p>
 
+<pre>rake website</pre>
 
 	<h2>Screencast coming soon</h2>
 
@@ -241,6 +279,17 @@ and you&#8217;ll love every minute of it.</p>
 	<p>Subscribe to PeepCode&#8217;s blog for announcement details.</p>
 
 
+	<h2>Examples</h2>
+
+
+	<p>The development of <code>newjs</code> was done in parallel with
+<a href="http://drnicutilities.rubyforge.org/drnic_js_test_helpers/">Dr Nic&#8217;s JavaScript Test Helpers</a>
+(source: <a href="http://github.com/drnic/drnic_js_test_helpers/tree/master">git</a>).</p>
+
+
+	<p>Checkout this project to see examples of unit tests, configuration etc.</p>
+
+
 	<h2>Forum</h2>
 
 

data/website/index.txt

@@ -150,13 +150,43 @@ And open <code>website/index.html</code> in your browser to preview.
 The project's version number is automatically inserted into the page
 (change version numbers via <code>APP_VERSION</code> in <code>Rakefile</code>).
 
+h3. Configuration of website upload
+
+It is assumed you will upload your website files to rubyforge.org server.
+To push files to an alternate server, modify the <code>tasks/website.rake</code> file.
+
+To configure which rubyforge project to upload to, create <code>config/website.yml</code>.
+There is an example in <code>code/website.yml.sample</code>.
+
+An example might be:
+
+<pre>host: nicwilliams@rubyforge.org
+remote_dir: /var/www/gforge-projects/drnicutilities/drnic_js_test_helpers
+</pre>
+
+Here, the files will be uploaded into the <code>drnicutilities</code> rubyforge
+project, under a sub-directory <code>drnic_js_test_helpers</code>. This site
+would be visible at "http://drnicutilities.rubyforge.org/drnic_js_test_helpers":http://drnicutilities.rubyforge.org/drnic_js_test_helpers
+  
+If your website lives in its own rubyforge project, then just specify the project
+name, and the website will be uploaded into the root folder.
+
+For example, the website would be available at "http://drnicutilities.rubyforge.org/":http://drnicutilities.rubyforge.org/ if your
+configuration was:
+
+<pre>host: nicwilliams@rubyforge.org
+remote_dir: /var/www/gforge-projects/drnicutilities
+</pre>
+
+h3. Uploading website to server
+
 To upload the website (and its CSS etc) run:
 
-<pre>rake website</pre>
+<pre>rake website_upload</pre>
 
-The default <code>tasks/website.rake</code> file pushes the files
-to a "rubyforge.org":http://rubyforge.org project account. Modify it
-to rsync files elsewhere.
+More commonly, to generate and upload the website:
+
+<pre>rake website</pre>
 
 h2. Screencast coming soon
 
@@ -166,6 +196,14 @@ and you'll love every minute of it.
 
 Subscribe to PeepCode's blog for announcement details.
 
+h2. Examples
+
+The development of <code>newjs</code> was done in parallel with
+"Dr Nic's JavaScript Test Helpers":http://drnicutilities.rubyforge.org/drnic_js_test_helpers/
+(source: "git":http://github.com/drnic/drnic_js_test_helpers/tree/master).
+
+Checkout this project to see examples of unit tests, configuration etc.
+
 h2. Forum
 
 "http://groups.google.com/group/javascript-project-generator":http://groups.google.com/group/javascript-project-generator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: newjs
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Dr Nic Williams
@@ -82,6 +82,7 @@ files:
 - app_generators/newjs/templates/script/rstakeout
 - app_generators/newjs/templates/src/HEADER.erb
 - app_generators/newjs/templates/src/library.js.erb
+- app_generators/newjs/templates/tasks/deploy.rake
 - app_generators/newjs/templates/tasks/environment.rake
 - app_generators/newjs/templates/tasks/javascript_test_autotest_tasks.rake
 - app_generators/newjs/templates/test/assets/prototype.js