Release 1.0.1

.gitignore

@@ -3,3 +3,4 @@ doc
 tmp
 coverage
 .bundle
+.yardoc/

Gemfile.lock

@@ -42,7 +42,7 @@ GEM
       multi_json (~> 1.0)
     ansi (1.2.5)
     arel (2.1.1)
-    aruba (0.4.2)
+    aruba (0.4.3)
       bcat (>= 0.6.1)
       childprocess (>= 0.1.9)
       cucumber (>= 0.10.7)
@@ -87,7 +87,7 @@ GEM
     jquery-rails (1.0.12)
       railties (~> 3.0)
       thor (~> 0.14)
-    json (1.5.2)
+    json (1.5.3)
     json_pure (1.5.3)
     mail (2.3.0)
       i18n (>= 0.4.0)
@@ -170,12 +170,14 @@ GEM
       multi_json (>= 1.0.2)
     xpath (0.1.4)
       nokogiri (~> 1.3)
+    yard (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (>= 0.4.1)
+  aruba (>= 0.4.3)
+  bcat (= 0.6.1)
   bson_ext (>= 1.3.1)
   bundler (>= 1.0.15)
   coffee-script (>= 2.2.0)
@@ -186,9 +188,11 @@ DEPENDENCIES
   mongoid (>= 2.0.2)
   rails (>= 3.1.0.rc4)
   rake (>= 0.9.2)
+  rdiscount (= 1.6.8)
   rspec (>= 2.6.0)
   rspec-rails (>= 2.6.1)
   sass (>= 3.1.3)
   sqlite3-ruby (>= 1.3.3)
   turn (>= 0.8.2)
   uglifier (>= 1.0.0)
+  yard (= 0.7.1)

History.md

@@ -2,7 +2,7 @@
 
 ### New Features
 * Added a @no-database-cleaner tag you can add if you don't want to run DatabaseCleaner. Useful for debugging if you want to leave data in the database. Typical use case is to run `rails server --environment test` to look at/try app with data from test. (Aslak Hellesøy)
-* Markdown format in History. (Aslak Hellesøy)
+* History file is now in Markdown format. (Aslak Hellesøy)
 
 ## [v1.0.0](https://github.com/cucumber/cucumber-rails/compare/v0.5.2...v1.0.0)
 

Rakefile

@@ -1,4 +1,5 @@
 # encoding: utf-8
+CUCUMBER_RAILS_VERSION = Gem::Specification.load(File.dirname(__FILE__) + '/cucumber-rails.gemspec').version.version
 require 'rubygems'
 require 'bundler/setup'
 Bundler::GemHelper.install_tasks

cucumber-rails.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rails', '>= 3.1.0.rc4')
   s.add_development_dependency('rake', '>= 0.9.2')
   s.add_development_dependency('bundler', '>= 1.0.15')
-  s.add_development_dependency('aruba', '>= 0.4.1')
+  s.add_development_dependency('aruba', '>= 0.4.3')
   s.add_development_dependency('sqlite3-ruby', '>= 1.3.3')
   s.add_development_dependency('rspec', '>= 2.6.0')
   s.add_development_dependency('rspec-rails', '>= 2.6.1')
@@ -34,11 +34,14 @@ Gem::Specification.new do |s|
   s.add_development_dependency('uglifier', '>= 1.0.0')
   s.add_development_dependency('jquery-rails', '>= 1.0.12')
 
+  # For Documentation:
+  s.add_development_dependency('yard', '= 0.7.1')
+  s.add_development_dependency('rdiscount', '= 1.6.8')
+  s.add_development_dependency('bcat', '= 0.6.1')
+
   s.rubygems_version = ">= 1.6.1"
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
   s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.extra_rdoc_files = ["LICENSE", "README.md", "History.txt"]
-  s.rdoc_options     = ["--charset=UTF-8"]
   s.require_path     = "lib"
 end

dev_tasks/yard.rake

@@ -0,0 +1,17 @@
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+YARD::Templates::Engine.register_template_path(File.expand_path(File.join(File.dirname(__FILE__), 'yard')))
+YARD::Rake::YardocTask.new(:yard) do |t|
+  t.options = %w{--no-private --title Cucumber-Rails}
+  t.files = %w{lib - README.md History.md LICENSE}
+end
+
+desc "Push yardoc to http://cukes.info/cucumber-rails/api/#{CUCUMBER_RAILS_VERSION}"
+task :push_yard => :yard do
+  sh("tar czf tmp/api-#{CUCUMBER_RAILS_VERSION}.tgz -C doc .")
+  sh("scp tmp/api-#{CUCUMBER_RAILS_VERSION}.tgz cukes.info:/var/www/cucumber-rails/cucumber-rails/api")
+  sh("ssh cukes.info 'cd /var/www/cucumber-rails/api && rm -rf #{CUCUMBER_RAILS_VERSION} && mkdir #{CUCUMBER_RAILS_VERSION} && tar xzf api-#{CUCUMBER_RAILS_VERSION}.tgz -C #{CUCUMBER_RAILS_VERSION} && rm -f latest && ln -s #{CUCUMBER_RAILS_VERSION} latest'")
+end
+
+task :release => :push_yard

dev_tasks/yard/default/layout/html/footer.erb

@@ -0,0 +1,5 @@
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
+</div>

dev_tasks/yard/default/layout/html/index.erb

@@ -0,0 +1 @@
+<%= yieldall %>

dev_tasks/yard/default/layout/html/layout.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <%= erb(:headers) %>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <div id="header">
+      <%= erb(:logo) %>
+      <%= erb(:breadcrumb) %>
+      <%= erb(:search) %>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><%= yieldall %></div>
+
+    <%= erb(:footer) %>
+  </body>
+</html>

dev_tasks/yard/default/layout/html/logo.erb

@@ -0,0 +1 @@
+<h3><img src="<%= url_for('images/bubble_32x32.png') %>"></img> Cucumber-Rails <%= CUCUMBER_RAILS_VERSION %></h3>

dev_tasks/yard/default/layout/html/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  options[:serializer].serialize('/images/bubble_32x32.png', IO.read(File.dirname(__FILE__) + '/bubble_32x32.png'))
+end

features/step_definitions/cucumber_rails_steps.rb

@@ -17,6 +17,10 @@
       """
     And I successfully run `bundle exec rails generate cucumber:install`
   }
+  if(ENV['ARUBA_REPORT_DIR'])
+    @aruba_report_start = Time.new
+    sleep(1)
+  end
 end
 
 Given /^a project without ActiveRecord$/ do
@@ -58,6 +62,10 @@ class Application < Rails::Application
       """
     And I remove the file "config/database.yml"
   }
+  if(ENV['ARUBA_REPORT_DIR'])
+    @aruba_report_start = Time.new
+    sleep(1)
+  end
 end
 
 And /^a cukes resource$/ do

features/support/env.rb

@@ -8,3 +8,30 @@
   @aruba_timeout_seconds = 120 # A long time needed some times
   unset_bundler_env_vars
 end
+
+if(ENV['ARUBA_REPORT_DIR'])
+  # Override reporting behaviour so we don't document all files, only the ones
+  # that have been created after @aruba_report_start (a Time object). This is
+  # given a value after the Rails app is generated (see cucumber_rails_steps.rb)
+  module Aruba
+    module Reporting
+      def children(dir)
+        children = Dir["#{dir}/*"].sort
+
+        # include
+        children = children.select do |child|
+          File.directory?(child) || 
+          (@aruba_report_start && File.stat(child).mtime > @aruba_report_start)
+        end
+
+        # exclude
+        children = children.reject do |child|
+          child =~ /Gemfile/ || 
+          child =~ /\.log$/
+        end
+
+        children
+      end
+    end
+  end
+end