ride 0.1.1

data/spec/generator_spec_helper.rb

@@ -0,0 +1,136 @@
+module RubiGen
+  module GeneratorSpecHelper
+    # Runs the create command (like the command line does)
+    def run_generator(name, params, sources, options = {})
+      generator = build_generator(name, params, sources, options)
+      silence_generator do
+        generator.command(:create).invoke!
+      end
+      generator
+    end
+
+    # Instatiates the Generator
+    def build_generator(name, params, sources, options)
+      options.merge!(:collision => :force)  # so no questions are prompted
+      if sources.is_a?(Symbol)
+        if sources == :app
+          RubiGen::Base.use_application_sources!
+        else
+          RubiGen::Base.use_component_sources!
+        end
+      else
+        RubiGen::Base.reset_sources
+        RubiGen::Base.prepend_sources(*sources) unless sources.blank?
+      end
+      RubiGen::Base.instance(name, params, options)
+    end
+
+    # Silences the logger temporarily and returns the output as a String
+    def silence_generator
+      logger_original=RubiGen::Base.logger
+      myout=StringIO.new
+      RubiGen::Base.logger=RubiGen::SimpleLogger.new(myout)
+      # TODO redirect $stdout to myout
+      yield if block_given?
+      RubiGen::Base.logger=logger_original
+      # TODO fix $stdout again
+      myout.string
+    end
+
+    # asserts that the given file was generated.
+    # the contents of the file is passed to a block.
+    def generated_file?(path)
+      file_exists?(path)
+      File.open("#{APP_ROOT}/#{path}") do |f|
+        yield f.read if block_given?
+      end
+    end
+
+    # asserts that the given file exists
+    def file_exists?(path)
+      File.exists?("#{APP_ROOT}/#{path}").should eql(true)
+    end
+
+    # asserts that the given directory exists
+    def directory_exists?(path)
+      File.directory?("#{APP_ROOT}/#{path}").should eql(true)
+    end
+
+    # asserts that the given class source file was generated.
+    # It takes a path without the <tt>.rb</tt> part and an optional super class.
+    # the contents of the class source file is passed to a block.
+    def generated_class?(path,parent=nil)
+      path=~/\/?(\d+_)?(\w+)$/
+      class_name=$2.camelize
+      generated_file?("#{path}.rb") do |body|
+        it "should define #{class_name} in #{path}.rb" do
+          body.should match(/class #{class_name}#{parent.nil? ? '':" < #{parent}"}/)
+        end
+        yield body if block_given?
+      end
+    end
+
+    # asserts that the given module source file was generated.
+    # It takes a path without the <tt>.rb</tt> part.
+    # the contents of the class source file is passed to a block.
+    def generated_module?(path)
+      path=~/\/?(\w+)$/
+      module_name=$1.camelize
+      generated_file?("#{path}.rb") do |body|
+        it "should define #{module_name} in #{path}.rb" do
+          body.should match(/module #{module_name}/)
+        end
+        yield body if block_given?
+      end
+    end
+
+    # asserts that the given unit test was generated.
+    # It takes a name or symbol without the <tt>test_</tt> part and an optional super class.
+    # the contents of the class source file is passed to a block.
+    def generated_test_for?(name, parent="Test::Unit::TestCase")
+      generated_class? "test/test_#{name.to_s.underscore}", parent do |body|
+        yield body if block_given?
+      end
+    end
+
+    # asserts that the given methods are defined in the body.
+    # This does assume standard rails code conventions with regards to the source code.
+    # The body of each individual method is passed to a block.
+    def has_method?(body,*methods)
+      methods.each do |name|
+        it "should define the method #{name.to_s}" do
+          body.should match(/^  def #{name.to_s}\n((\n|   .*\n)*)  end/)
+        end
+        yield( name, $1 ) if block_given?
+      end
+    end
+    
+    def app_root_files
+      Dir[APP_ROOT + '/**/*']
+    end
+
+    def rubygem_folders
+      %w[bin examples lib test]
+    end
+  
+    def rubygems_setup
+      bare_setup
+      rubygem_folders.each do |folder|
+        Dir.mkdir("#{APP_ROOT}/#{folder}") unless File.exists?("#{APP_ROOT}/#{folder}")
+      end
+    end
+  
+    def rubygems_teardown
+      bare_teardown
+    end
+  
+    def bare_setup
+      FileUtils.mkdir_p(APP_ROOT)
+    end
+  
+    def bare_teardown
+      FileUtils.rm_rf TMP_ROOT || APP_ROOT
+    end
+  
+  end
+end

data/spec/ride_generator_spec.rb

@@ -0,0 +1,81 @@
+require File.join(File.dirname(__FILE__), '/spec_generator_helper.rb')
+
+module RideGeneratorSpecHelper
+  include RubiGen::GeneratorSpecHelper
+  def generator_path
+    "app_generators"
+  end
+
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def full_path(some_path)
+    File.join(APP_ROOT, some_path)
+  end
+end
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Ride Generator", "when application is generated" do
+  include RideGeneratorSpecHelper
+  before(:all) do  
+    bare_setup
+    run_generator('ride', [APP_ROOT], sources, {:console_debugger => 'irb', :template => 'rails', :shell => 'bash', :editor => 'vim'})
+  end
+
+  RideGenerator::BASEDIRS.each do |dir|
+    it "should create #{dir}" do
+      File.directory?(full_path(dir)).should == true
+    end
+  end
+
+  %w{Rakefile History.txt License.txt README.txt}.each do |file|
+    it "should create #{file}" do
+      File.exists?(full_path(file)).should == true
+    end
+  end
+
+  it "should put our rake tasks in place" do
+    file_path = File.join("tasks", "ride.rake")
+    File.exists?(full_path(file_path)).should == true
+    file_path = File.join("tasks", "rspec.rake")
+    File.exists?(full_path(file_path)).should == true
+  end
+
+  %w{destroy generate}.each do |file|
+    it "should create #{script_path = File.join("script", file)}" do
+      File.exists?(full_path(script_path)).should == true
+      FileTest.executable?(full_path(script_path)).should == true
+    end
+  end
+
+  it "should create the config/.screenrc.code.erb file" do
+    file_path = File.join("config", ".screenrc.code.erb")
+    File.exists?(full_path(file_path)).should == true
+  end
+
+  it "should create the config/code_template.erb file" do
+    file_path = File.join("config", "code_template.erb")
+    File.exists?(full_path(file_path)).should == true
+  end
+
+  it "should create the script/ride file" do
+    file_path = File.join("script", "ride")
+    File.exists?(full_path(file_path)).should == true
+    FileTest.executable?(full_path(file_path)).should == true
+  end
+
+  [%w{ftplugin ruby ruby.vim}, %w{plugin taglist.vim}, %w{syntax eruby.vim}, %w{ftdetect ruby.vim}].each do |vimfile|
+    it "Should create #{vim_path = File.join(".vim", *vimfile)}" do
+      File.exists?(full_path(vim_path)).should == true
+    end
+  end
+
+  after(:all) do
+#    bare_teardown
+  end
+  
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_generator_helper.rb

@@ -0,0 +1,35 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+
+require 'fileutils'
+
+# Must set before requiring generator libs.
+TMP_ROOT = File.dirname(__FILE__) + "/tmp" unless defined?(TMP_ROOT)
+PROJECT_NAME = "ride" 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
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_ROOT = app_root
+end
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require File.join(File.dirname(__FILE__), 'generator_spec_helper')
+$:.unshift(File.dirname(__FILE__) + '/../app_generators/ride')
+require 'ride_generator'

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'ride'

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/ride.rake

@@ -0,0 +1,6 @@
+namespace :ride do
+  desc "about"
+  task :about do
+    puts "Ruby Interactive Development Interface"
+  end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+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,29 @@
+begin
+  require File.dirname(__FILE__) + '/test_helper'
+rescue LoadError
+  require 'test/unit'
+end
+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
+if defined?(RAILS_ROOT)
+  RAILS_ROOT.replace(app_root)
+else
+  RAILS_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,2 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/ride'

data/test/test_ride.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRide < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_ride_generator.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestRideGenerator < 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('ride', [APP_ROOT], sources)
+    assert_directory_exists "path/to/included/folder"
+    assert_generated_file   "path/to/included/folder/some_file"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "app_generators"
+  end
+end

data/website/index.html

@@ -0,0 +1,11 @@
+<html>
+	<head>
+		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
+		<title>ride</title>
+		
+	</head>
+	<body id="body">
+		<p>This page has not yet been created for RubyGem <code>ride</code></p>
+		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
+	</body>
+</html>

data/website/index.txt

@@ -0,0 +1,83 @@
+h1. ride
+
+h1. → 'ride'
+
+
+h2. What
+
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install ride</pre>
+
+h2. The basics
+
+
+h2. Demonstration of usage
+
+
+
+h2. Forum
+
+"http://groups.google.com/group/ride":http://groups.google.com/group/ride
+
+TODO - create Google Group - ride
+
+h2. How to submit patches
+
+Read the "8 steps for fixing other people's code":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/ and for section "8b: Submit patch to Google Groups":http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups, use the Google Group above.
+
+TODO - pick SVN or Git instructions
+
+The trunk repository is <code>svn://rubyforge.org/var/svn/ride/trunk</code> for anonymous access.
+
+OOOORRRR
+
+You can fetch the source from either:
+
+<% if rubyforge_project_id %>
+
+* rubyforge: "http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>":http://rubyforge.org/scm/?group_id=<%= rubyforge_project_id %>
+
+<pre>git clone git://rubyforge.org/ride.git</pre>
+
+<% else %>
+
+* rubyforge: MISSING IN ACTION
+
+TODO - You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects' id information.
+
+When you do this, this message will magically disappear!
+
+Or you can hack website/index.txt and make it all go away!!
+
+<% end %>
+
+* github: "http://github.com/GITHUB_USERNAME/ride/tree/master":http://github.com/GITHUB_USERNAME/ride/tree/master
+
+<pre>git clone git://github.com/GITHUB_USERNAME/ride.git</pre>
+
+
+TODO - add "github_username: username" to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.
+
+
+* gitorious: "git://gitorious.org/ride/mainline.git":git://gitorious.org/ride/mainline.git
+
+<pre>git clone git://gitorious.org/ride/mainline.git</pre>
+
+h3. Build and test instructions
+
+<pre>cd ride
+rake test
+rake install_gem</pre>
+
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Comments are welcome. Send an email to "FIXME full name":mailto:FIXME email via the "forum":http://groups.google.com/group/ride
+