features_report 0.1.0

data/History.txt

@@ -0,0 +1,2 @@
+== 0.1.0 2009-01-09
+

data/Manifest.txt

@@ -0,0 +1,23 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/features_report
+lib/features_report.rb
+lib/features_report/cli.rb
+lib/features_report/cucumber/tree/feature.rb
+lib/features_report/generator.rb
+lib/features_report/git.rb
+lib/features_report/reader.rb
+spec/cucumber/tree/feature_spec.rb
+spec/features_report_spec.rb
+spec/fixtures/features.pdf
+spec/fixtures/features/login.feature
+spec/fixtures/features/signup.feature
+spec/fixtures/steps/login_steps.rb
+spec/fixtures/steps/signup_steps.rb
+spec/git_spec.rb
+spec/reader_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,64 @@
+
+= features_report
+
+ * Daniel Lucraft (daniellucraft.com) and Niko Felger
+ * http://features_report.rubyforge.org/
+ * sponsored by Songkick.com. Find live music playing near you!
+
+== DESCRIPTION:
+
+Generates a PDF report of a set of Cucumber features.
+
+== FEATURES/PROBLEMS:
+
+ Features:
+ * Lists features and scenarios
+ * Table of contents
+ * Your logo on the front page
+ * Annotates scenarios with authorship date last changed by comments (git only)
+
+ Problems:
+ - Table of contents is at the back. Can't figure out how to make Prawn do 
+   one at the front.
+ - FIT tables are not included properly (only their title will appear).
+
+== SYNOPSIS:
+
+  features_report features/*/*.features
+
+== REQUIREMENTS:
+ 
+ * Trollop
+ * Cucumber
+ * Prawn
+ * Grit (optional, needed for git only features)
+ * RSpec (optional, needed to run specs)
+
+== INSTALL:
+
+ * sudo gem install features_report
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/features_report'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('features_report', FeaturesReport::VERSION) do |p|
+  p.developer('Daniel Lucraft', 'dan@fluentradical.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = "features_report" # TODO this is default value
+  p.extra_deps           = [
+                            ['trollop','>= 1.10.2'],
+                            ['cucumber', '>= 0.1.14'],
+                            ['prawn', '>= 0.3.0']
+                           ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/bin/features_report

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/features_report")
+
+FeaturesReport::CLI.execute

data/lib/features_report.rb

@@ -0,0 +1,23 @@
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module FeaturesReport
+  VERSION = '0.1.0'
+end
+
+require 'rubygems'
+require 'prawn'
+require 'trollop'
+
+begin
+  require 'grit'
+rescue
+end
+
+require 'features_report/reader'
+require 'features_report/generator'
+require 'features_report/cli'
+require 'features_report/git'
+FeaturesReport::Reader.load_cucumber
+require 'features_report/cucumber/tree/feature'

data/lib/features_report/cli.rb

@@ -0,0 +1,29 @@
+
+module FeaturesReport
+  class CLI
+    def self.execute
+      opts = Trollop.options do 
+        version "features_report 0.1 (c) 2008 Daniel Lucraft & Niko Felger"
+        banner <<-EOS
+features_report turns Cucumber features into a pretty PDF report. Output is put in features.pdf.
+
+Usage:
+       features_report [options] <filenames>+
+
+where [options] are:
+EOS
+
+        opt :logo, "Path to image for the front page", :type => :string
+      end
+      Trollop.die "no features files given" if ARGV.empty?
+      reader = Reader.new(ARGV)
+      if defined?(Grit) and Git.git_repo?(ARGV.first)
+        git = Git.new(ARGV)
+      else
+        git = nil
+      end
+      generator = Generator.new(reader, git, opts)
+      generator.generate
+    end
+  end
+end

data/lib/features_report/cucumber/tree/feature.rb

@@ -0,0 +1,6 @@
+
+class Cucumber::Tree::Feature
+  def title
+    header.split("\n").first.strip.gsub(/^Feature: /, "")
+  end
+end

data/lib/features_report/generator.rb

@@ -0,0 +1,162 @@
+
+module FeaturesReport
+  class Generator
+    def initialize(reader, git, opts)
+      @reader = reader
+      @opts = opts
+      @git = git
+      @feature_pages ||= {}
+      @features = reader.features.map{|f| Feature.new(f, @git)}
+    end
+
+    attr_reader :pdf, :reader, :opts
+
+    def generate
+      @pdf = Prawn::Document.new :page_size => "A4", :top_margin => 60
+
+      pdf.header [pdf.bounds.right, pdf.bounds.bottom + 10] do
+        pdf.text pdf.page_count-1 unless pdf.page_count == 1
+      end
+
+      @original_bottom_left = [pdf.bounds.left, pdf.bounds.bottom - 10]
+
+      generate_front_page
+      
+      sorted_features.each do |feature| 
+        generate_feature(feature)
+      end
+      
+      generate_contents_page
+      pdf.render_file("features.pdf")
+    end
+
+    FEATURE_TITLE_STYLE = {:size => 24}
+    SCENARIO_TITLE_STYLE = {:size => 16}
+    STEP_STYLE = {}
+    FOOTER_STYLE = {:size => 12}
+    DOC_TITLE_STYLE = {:size => 32, :align => :center}
+
+    private
+
+    def generate_front_page
+      pdf.move_down(200)
+
+      if opts[:logo]
+        pdf.image opts[:logo]
+      end
+
+      pdf.text "Features Report", DOC_TITLE_STYLE
+      pdf.move_down(10)
+      pdf.text Time.now.strftime("%e %B %Y"), :align => :center
+      
+      start_new_page
+    end
+
+    class Feature
+      def initialize(feature, git)
+        @feature = feature
+        @git = git
+      end
+
+      def header
+        @feature.header
+      end
+
+      def last_commit
+        @last_commit ||= @git.last_commit(@feature)
+      end
+
+      def last_changed
+        last_commit.date
+      end
+
+      def last_author
+        last_commit.author.name
+      end
+
+      def scenarios
+        @feature.scenarios
+      end
+
+      def title
+        @feature.title
+      end
+
+      def contents_text
+        title + "\n" + header.split("\n")[1..-1].join("\n")
+      end
+    end
+
+    def sorted_features
+      return @sorted_features if @sorted_features
+
+      @sorted_features = @features.sort_by do |feature| 
+        if @git
+          feature.last_changed
+        else
+          feature.title
+        end
+      end
+      
+      @sorted_features = @sorted_features.reverse if @git
+
+      @sorted_features
+    end
+
+    def generate_contents_page
+      clear_footer
+      pdf.text "Contents", :size => 20, :align => :center
+
+      data = []
+      widths, headers = nil, nil
+
+      sorted_features.each_with_index do |feature, index|
+        if @git
+          data << [index + 1, feature.title, feature.last_changed.strftime("%e %b"), feature.last_author.split.map{|word| word[0..0].upcase}.join, @feature_pages[feature]] 
+          widths = {0 => 30, 1 => 340, 2 => 70, 3 => 40, 4 => 40}
+          headers = ["", "Title", "Last Changed", "By", "Page"]
+        else
+          data << [index + 1, feature.title, @feature_pages[feature]] 
+          widths = {0 => 30, 1 => 470, 2 => 30}
+          headers = ["", "", ""]
+        end
+      end
+
+      pdf.move_down 35
+      pdf.table data, :border_width => 0, :widths => widths, :headers => headers
+    end
+
+    def clear_footer
+      pdf.footer(pdf.bounds.bottom_left) {}
+    end
+
+    def generate_feature(feature)
+      pdf.text "Feature: " + feature.title, FEATURE_TITLE_STYLE
+      pdf.text feature.header.split("\n")[1..-1].join("\n")
+
+      pdf.footer @original_bottom_left do 
+        pdf.text feature.title, FOOTER_STYLE
+      end
+
+      pdf.move_down 20
+      @feature_pages[feature] = pdf.page_count-1
+      
+      feature.scenarios.each do |scenario|
+        pdf.text scenario.name, SCENARIO_TITLE_STYLE
+        pdf.move_down 4
+        scenario.steps.each do |step|
+          next if step.is_a?(Cucumber::Tree::RowStep) or step.is_a?(Cucumber::Tree::RowStepOutline) # TODO: deal with these
+          pdf.text step.keyword + " " + step.name, STEP_STYLE
+        end
+        pdf.move_down 10
+      end
+      
+      start_new_page
+    end
+
+    def start_new_page
+      pdf.start_new_page(:bottom_margin => 60)
+    end
+
+  end
+end

data/lib/features_report/git.rb

@@ -0,0 +1,31 @@
+
+module FeaturesReport
+  class Git
+    def self.git_repo?(filename)
+      path = File.expand_path(filename)
+      while path and path != ""
+        if File.exist?(path + "/.git")
+          return path
+        end
+        path = path.split("/")[0..-2].join("/")
+      end
+      false
+    end
+
+    def initialize(files)
+      @repo = Grit::Repo.new(Git.git_repo?(files.first))
+      @files = files
+    end
+
+    def git_dir
+      @repo.path.split("/")[0..-2].join("/")
+    end
+
+    def last_commit(feature)
+      filename = File.expand_path(feature.file, git_dir).gsub(/^#{Regexp.escape(git_dir)}\//, "")
+      commit = @repo.log(@repo.head.name, filename).first
+    end
+
+    attr_reader :files
+  end
+end

data/lib/features_report/reader.rb

@@ -0,0 +1,31 @@
+
+module FeaturesReport
+  class Reader
+    attr_reader :files
+
+    def initialize(files)
+      @files = files
+    end
+
+    def self.load_cucumber
+      require "cucumber"
+      require "cucumber/treetop_parser/feature_en"
+      Cucumber.load_language("en")
+  
+      Cucumber::Tree::Feature.class_eval do
+        attr_reader :scenarios
+      end
+    end
+    
+    def features
+      return @features if @features
+      @features = files.map do |file|
+        parser.parse_feature(file)
+      end
+    end
+
+    def parser
+      @parser ||= Cucumber::TreetopParser::FeatureParser.new
+    end
+  end
+end

data/spec/cucumber/tree/feature_spec.rb

@@ -0,0 +1,13 @@
+
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Cucumber::Tree::Feature do 
+  before(:each) do
+    reader = Reader.new(["spec/fixtures/features/login.feature"])
+    @feature = reader.features.first
+  end
+
+  it "should have a title" do
+    @feature.title.should == "Log in to the site"
+  end
+end

data/spec/features_report_spec.rb

@@ -0,0 +1,6 @@
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "" do
+  
+end

data/spec/fixtures/features/login.feature

@@ -0,0 +1,68 @@
+Feature: Log in to the site
+  As a user,
+  I want to be able to log in to the site
+  So I can access personalized features
+
+  Scenario: Log in
+    Given I have an account
+    When I visit the login page
+    And I enter my login details
+    And I press "Login"
+    Then I should be viewing my user page
+
+  Scenario: Log in with bad password
+    Given I have an account
+    When I visit the login page
+    And I enter my login details with a bad password
+    And I press "Login"
+    Then I should be viewing the login page
+    And I should see the text "Bad username or password"
+
+  Scenario: Log in with bad email
+    Given I have an account
+    When I visit the login page
+    And I enter my login details with a bad email
+    And I press "Login"
+    Then I should be viewing the login page
+    And I should see the text "Bad username or password"
+
+  Scenario: Log in with bad password and then log in
+    Given I have an account
+    When I visit the login page
+    And I enter my login details with a bad email
+    And I press "Login"
+    And I enter my login details
+    And I press "Login"
+    Then I should be viewing my user page
+
+  Scenario: Log in
+    Given I have an account
+    When I visit the login page
+    And I enter my login details
+    And I press "Login"
+    Then I should be viewing my user page
+
+  Scenario: Log in with bad password
+    Given I have an account
+    When I visit the login page
+    And I enter my login details with a bad password
+    And I press "Login"
+    Then I should be viewing the login page
+    And I should see the text "Bad username or password"
+
+  Scenario: Log in with bad email
+    Given I have an account
+    When I visit the login page
+    And I enter my login details with a bad email
+    And I press "Login"
+    Then I should be viewing the login page
+    And I should see the text "Bad username or password"
+
+  Scenario: Log in with bad password and then log in
+    Given I have an account
+    When I visit the login page
+    And I enter my login details with a bad email
+    And I press "Login"
+    And I enter my login details
+    And I press "Login"
+    Then I should be viewing my user page

data/spec/fixtures/features/signup.feature

@@ -0,0 +1,27 @@
+Feature: Sign up to the site
+  As a visitor
+  I want to be able to sign up for a user account
+  So I can gain access to the personalized features of the site
+
+  Scenario: Sign up
+    When I visit the sign up page
+    And I enter my sign up details with username "leoban"
+    And I press "Sign up"
+    Then I should be viewing the user page for user "leoban"
+
+  Scenario: Sign up with missing email
+    When I visit the sign up page
+    And I enter my sign up details with username "leoban"
+    And I forget to enter an email
+    And I press "Sign up"
+    Then I should be viewing the sign up page
+    And I should see the text "email required"
+
+  Scenario: Sign up with duplicate username
+    Given there is a user with username "leoban"
+    When I visit the sign up page
+    And I enter my sign up details with username "leoban"
+    And I press "Sign up"
+    Then I should be viewing the sign up page
+    And I should see the text "that username is already taken"
+

data/spec/fixtures/steps/login_steps.rb

@@ -0,0 +1,26 @@
+Given /^I have an account$/ do
+end
+
+When /^I visit the login page$/ do
+end
+
+When /^I enter my login details$/ do
+end
+
+When /^I press "Login"$/ do
+end
+
+Then /^I should be viewing my user page$/ do
+end
+
+When /^I enter my login details with a bad password$/ do
+end
+
+Then /^I should be viewing the login page$/ do
+end
+
+Then /^I should see the text "Bad username or password"$/ do
+end
+
+When /^I enter my login details with a bad email$/ do
+end

data/spec/fixtures/steps/signup_steps.rb

@@ -0,0 +1,27 @@
+
+When /^I visit the sign up page$/ do
+end
+
+When /^I enter my sign up details with username "leoban"$/ do
+end
+
+When /^I press "Sign up"$/ do
+end
+
+Then /^I should be viewing the user page for user "leoban"$/ do
+end
+
+When /^I forget to enter an email$/ do
+end
+
+Then /^I should be viewing the sign up page$/ do
+end
+
+Then /^I should see the text "email required"$/ do
+end
+
+Given /^there is a user with username "leoban"$/ do
+end
+
+Then /^I should see the text "that username is already taken"$/ do
+end

data/spec/git_spec.rb

@@ -0,0 +1,18 @@
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+include FeaturesReport
+
+describe FeaturesReport::Git do
+  describe ".git_repo?" do
+    it "should be true if in a git repo" do
+      Git.git_repo?("spec/").should_not be_nil
+    end
+
+    it "should be false if not in a git repo" do
+      # linux specific
+      Git.git_repo?("/usr/local").should be_false
+    end
+  end
+end
+

data/spec/reader_spec.rb

@@ -0,0 +1,24 @@
+
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+include FeaturesReport
+
+describe FeaturesReport::Reader do
+  
+  before(:each) do
+    @reader = Reader.new(Dir[FEATURE_FIXTURES_GLOB])
+  end
+
+  it "should load the features" do
+    @reader.features.length.should == 2
+    
+    @reader.features.map {|f| f.title}.sort.should == ["Log in to the site", "Sign up to the site"]
+  end
+
+  it "should load the scenarios" do
+    login_feature = @reader.features.detect {|f| f.title == "Log in to the site"}
+    login_feature.scenarios.length.should == 8
+    login_scenario = login_feature.scenarios.last
+    login_scenario.name.should == "Log in with bad password and then log in"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'features_report'
+
+FEATURE_FIXTURES_GLOB = "spec/fixtures/features/*.feature" unless defined?(FEATURE_FIXTURES_GLOB)

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: features_report
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Daniel Lucraft
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-12 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.14
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Generates a PDF report of a set of Cucumber features.
+email: 
+- dan@fluentradical.com
+executables: 
+- features_report
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/features_report
+- lib/features_report.rb
+- lib/features_report/cli.rb
+- lib/features_report/cucumber/tree/feature.rb
+- lib/features_report/generator.rb
+- lib/features_report/git.rb
+- lib/features_report/reader.rb
+- spec/cucumber/tree/feature_spec.rb
+- spec/features_report_spec.rb
+- spec/fixtures/features.pdf
+- spec/fixtures/features/login.feature
+- spec/fixtures/features/signup.feature
+- spec/fixtures/steps/login_steps.rb
+- spec/fixtures/steps/signup_steps.rb
+- spec/git_spec.rb
+- spec/reader_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: " * Daniel Lucraft (daniellucraft.com) and Niko Felger"
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: features_report
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generates a PDF report of a set of Cucumber features.
+test_files: []
+