newjs 1.0.0

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+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
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+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/#{PATH}/"
+  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_generator_helper.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "myproject" unless defined?(PROJECT_NAME)
+app_root = File.join(TMP_ROOT, PROJECT_NAME)
+if defined?(APP_ROOT)
+  APP_ROOT.replace(app_root)
+else
+  APP_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/helpers/generator_test_helper'

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/newjs'

data/test/test_install_website_generator.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestInstallWebsiteGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  def test_generator_without_options
+    name = "myapp"
+    run_generator(generator_name, [name], sources)
+    
+    %w[index.txt index.html template.html.erb stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
+      assert_generated_file("website/#{file}")
+    end
+    assert_generated_file("script/txt2html")
+    assert_generated_file("tasks/website.rake")
+  end
+  
+  private
+  def sources
+    [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", generator_path)),
+      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "newjs_theme_generators"))
+    ]
+  end
+  
+  def generator_path
+    "newjs_generators"
+  end
+  
+  def generator_name
+    'install_website'
+  end
+end

data/test/test_javascript_test_generator.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestJavascriptTestGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    name = "library"
+    run_generator('javascript_test', [name], sources)
+    assert_generated_file("test/library_test.html")
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "javascript_test_generators"
+  end
+end

data/test/test_newjs_generator.rb

@@ -0,0 +1,63 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestNewjsGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+  
+  def test_generator_without_options
+    run_generator('newjs', [APP_ROOT], sources)
+    assert_directory_exists "lib"
+    assert_directory_exists "config"
+    assert_directory_exists "src"
+    assert_directory_exists "script"
+    assert_directory_exists "tasks"
+    assert_directory_exists "test/assets"
+    assert_generated_file   "test/assets/unittest.css"
+    assert_generated_file   "test/assets/unittest.js"
+    assert_generated_file   "test/assets/prototype.js"
+    assert_generated_file   "Rakefile"
+    assert_generated_file   "README.txt"
+    assert_generated_file   "License.txt"
+    assert_generated_file   "History.txt"
+    assert_generated_file   "script/rstakeout"
+    assert_generated_file   "script/js_autotest"
+    assert_generated_file   "tasks/javascript_test_autotest_tasks.rake"
+    assert_generated_file   "tasks/environment.rake"
+    assert_generated_file   "config/javascript_test_autotest.yml.sample"
+    assert_generated_file   "src/myproject.js"
+    assert_generated_file   "src/HEADER"
+    assert_generated_file   "lib/protodoc.rb"
+    assert_generated_file   "lib/jstest.rb"
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "app_generators"
+  end
+end

data/test/test_plain_theme_generator.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestPlainThemeGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+  
+  def teardown
+    bare_teardown
+  end
+  
+  def test_generator_without_options
+    run_generator('plain_theme', [], sources)
+    %w[template.html.erb stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
+      assert_generated_file("website/#{file}")
+    end
+  end
+  
+  def test_generator_with_author_and_email
+    run_generator('plain_theme', [], sources, {:author => "AUTHOR", :email => "EMAIL"})
+    %w[template.html.erb stylesheets/screen.css javascripts/rounded_corners_lite.inc.js].each do |file|
+      assert_generated_file("website/#{file}")
+    end
+  end
+  
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+  
+  def generator_path
+    "newjs_theme_generators"
+  end
+end

data/website/index.html

@@ -0,0 +1,271 @@
+<!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>
+      JavaScript Project Generator
+  </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>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.0</a>
+    </div>
+    <h1>&#x2192; &#8216;newjs&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>A simple command-line tool to create the folders and helper files
+for a new JavaScript project/library. As a bonus, you can quickly
+create a website to promote your project.</p>
+
+
+	<p>When you start a new JavaScript library, how do you layout the source files,
+the tests, the distribution files? Do you have support scripts to
+generate distributions from source files? Run your JavaScript unit tests?
+Generators to create new unit test <span class="caps">HTML</span> files?</p>
+
+
+	<p><strong>No? Me neither</strong>, so I created the JavaScript Project Generator.</p>
+
+
+	<p>Once <code>newjs</code> has finished helping you write your source libraries,
+write test <span class="caps">HTML</span> files, providing autotesting scripts to make <span class="caps">TDD</span> a piece of cake,
+it finally helps you bundle all your source files into a single JavaScript file
+for distribution.</p>
+
+
+	<p>What a nice helpful tool it is!</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p>Installation and maintenance of generated JavaScript projects
+requires the installation of <a href="http://www.ruby-lang.org/">Ruby</a> and <a href="http://rubygems.org/">RubyGems</a>.</p>
+
+
+	<p>The command-line application <code>newjs</code> is installed as below, 
+for any operating system (except the &#8216;sudo&#8217; part &#8211; use as necessary):</p>
+
+
+<pre>sudo gem install newjs</pre>
+
+	<h2>Getting started</h2>
+
+
+	<p>To kick-off your new project/library, run the command-line app <code>newjs</code>:</p>
+
+
+<pre>$ newjs mylib
+        create  config
+        create  lib
+        create  src
+        create  script
+        create  tasks
+        create  test/assets
+        create  test/assets/unittest.css
+        create  test/assets/unittest.js
+        create  test/assets/prototype.js
+        create  tasks/javascript_test_autotest_tasks.rake
+        create  tasks/environment.rake
+        create  config/javascript_test_autotest.yml.sample
+        create  lib/protodoc.rb
+        create  README.txt
+        create  Rakefile
+        create  History.txt
+        create  License.txt
+        create  src/HEADER
+        create  src/mylib.js
+        create  script/rstakeout
+        create  script/js_autotest
+    dependency  install_rubigen_scripts
+        exists    script
+        create    script/generate
+        create    script/destroy
+</pre>
+
+	<p>Look at all that!</p>
+
+
+	<p>Unit testing uses the <code>unittest.js</code> library 
+developed within <a href="http://www.prototypejs.org/">prototypejs</a>. It should
+also support JavaScript development using any non-prototype.js libraries.</p>
+
+
+	<p>Your raw, unconcatenated library/source files go in <code>src/</code></p>
+
+
+	<p>Your unit test <span class="caps">HTML</span> files, go in <code>test/</code> (see test generator below).</p>
+
+
+When you&#8217;ve got a new version to release, edit <code>Rakefile</code> and modify the
+<code>APP_VERSION</code> string (see Distribution section below).
+
+	<p>To merge your <code>src/</code> files into a distribution file, see below.</p>
+
+
+	<h2>Generating test <span class="caps">HTML</span> files</h2>
+
+
+	<p>If you are going to have a <code>src/some_lib.js</code> file, then you&#8217;ll want a unit
+test file(s). By default you&#8217;d call it <code>test/some_lib_test.html</code>.</p>
+
+
+	<p>And then what? Personally, I can never remember what basic <span class="caps">HTML</span> + JavaScript
+goes in the test <span class="caps">HTML</span> files. I quite like the <a href="http://drnicwilliams.com/2008/01/04/autotesting-javascript-in-rails/">javascript_test plugin</a> for <a href="http://www.rubyonrails.org/">Ruby 
+on Rails</a>, which allows you to generate a
+test <span class="caps">HTML</span> stub. So I&#8217;ve included a version of it
+here. That is, your JavaScript project comes with a generator to create new
+test <span class="caps">HTML</span> files, ready to rock and roll.</p>
+
+
+<pre>$ script/generate javascript_test some_lib
+  exists  test
+  create  test/some_lib_test.html</pre>
+
+	<p>Now edit <code>test/some_lib_test.html</code> and follow the comments
+that tell you what to do to write your unit tests.</p>
+
+
+	<p>Want to name your test file something different? Specify the target
+library as an additional parameter.</p>
+
+
+<pre>$ script/generate javascript_test my_library_tests some_lib
+  exists  test
+  create  test/my_library_tests_test.html</pre>
+
+	<h2>Running unit tests</h2>
+
+
+	<p>Each test <span class="caps">HTML</span> file should be self-executable: just open it in a target
+browser. That is, to run the <code>test/some_lib_test.html</code> tests
+in Firefox, open the file in Firefox.</p>
+
+
+	<p>It will print out a beautiful log success/error messages for each test.</p>
+
+
+	<p><img src="images/example-unittest-log.jpg" width="647" height="427" alt="Example Unittest Log"></p>
+
+
+	<h2>Distribution of library</h2>
+
+
+	<p>Your project comes with the ability to concatenate all your <code>src/*.js</code>
+files into a single file for distribution, as <code>dist/project_name.js</code>.</p>
+
+
+	<p>First, edit <code>src/HEADER</code> with information that will be included
+at the top of the generated distribution file.</p>
+
+
+	<p>Second, edit <code>src/project_name.js</code> to include the names of
+all the <code>src/</code> files that will be concatenated together
+in your required order.</p>
+
+
+	<p>Finally, run the command:</p>
+
+
+<pre>rake dist</pre>
+
+	<h2>Create a website for your project</h2>
+
+
+	<p>You can quickly create a clean, readable website for your project
+that prominently displays the current version number (which is a 
+clickable link through to the download page), just like this page.</p>
+
+
+<pre>script/generate install_website</pre>
+
+	<p>Now edit the generated <code>website/index.txt</code> file (<a href="http://www.textism.com/tools/textile/">Textile</a> format).</p>
+
+
+	<p>To convert it to <span class="caps">HTML</span>, run:</p>
+
+
+<pre>rake website_generate</pre>
+
+	<p>And open <code>website/index.html</code> in your browser to preview.
+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>
+
+
+	<p>To upload the website (and its <span class="caps">CSS</span>)</p>
+
+
+	<h2>Screencast coming soon</h2>
+
+
+	<p>A hard-core, &#8220;how to do JavaScript unit testing&#8221; screencast will
+soon be published by <a href="http://peepcode.com/">PeepCode</a>. It will cost $9
+and you&#8217;ll love every minute of it.</p>
+
+
+	<p>Subscribe to PeepCode&#8217;s blog for announcement details.</p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/javascript-project-generator">http://groups.google.com/group/javascript-project-generator</a></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 source project is a <a href="http://git.or.cz/">Git</a> repository. See Dr Nic&#8217;s <a href="http://github.com/drnic/newjs/tree/master">master branch</a> for clone/checkout details.</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. Send an email to <a href="mailto:drnicwilliams@gmail.com">Dr Nic Williams</a> via the <a href="http://groups.google.com/group/javascript-project-generator">forum</a></p>
+    <p class="coda">
+      <a href="drnicwilliams@gmail.com">Dr Nic Williams</a>, 15th February 2008<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>