.loadpath .project examples/i18n/.gitignore examples/i18n/README.textile examples/i18n/Rakefile examples/i18n/ar/addition.feature examples/i18n/bg/addition.feature examples/i18n/bg/consecutive_calculations.feature examples/i18n/bg/division.feature examples/i18n/cat/suma.feature examples/i18n/da/summering.feature examples/i18n/de/addition.feature examples/i18n/de/division.feature examples/i18n/en-lol/stuffing.feature examples/i18n/en/addition.feature examples/i18n/en/division.feature examples/i18n/es/adicion.feature examples/i18n/et/jagamine.feature examples/i18n/et/liitmine.feature examples/i18n/fi/jakolasku.feature examples/i18n/fi/yhteenlasku.feature examples/i18n/fr/addition.feature examples/i18n/he/addition.feature examples/i18n/he/division.feature examples/i18n/hu/addition.feature examples/i18n/hu/division.feature examples/i18n/id/addition.feature examples/i18n/id/division.feature examples/i18n/it/somma.feature examples/i18n/ja/addition.feature examples/i18n/ja/division.feature examples/i18n/ko/addition.feature examples/i18n/ko/division.feature examples/i18n/lt/addition.feature examples/i18n/lt/division.feature examples/i18n/lv/addition.feature examples/i18n/lv/division.feature examples/i18n/no/summering.feature examples/i18n/pt/adicao.feature examples/i18n/ro/suma.feature examples/i18n/ru/addition.feature examples/i18n/ru/consecutive_calculations.feature examples/i18n/ru/division.feature examples/i18n/se/summering.feature examples/i18n/sk/addition.feature examples/i18n/sk/division.feature examples/i18n/zh-CN/addition.feature examples/i18n/zh-TW/addition.feature examples/i18n/zh-TW/division.feature examples/self_test/.gitignore examples/self_test/features/features2cards.feature features/features2cards_cli.feature features/step_definitions/features2cards_steps.rb features/support/env.rb features2cards.gemspec geminstaller.yml lib/features2cards/platform.rb rake_tasks/features.rake rake_tasks/fix_cr_lf.rake rake_tasks/rspec.rake rake_tasks/rubygems.rake spec/features2cards/card_spec.rb spec/features2cards/cli_spec.rb spec/features2cards/prawn_spec.rb spec/spec.opts spec/spec_helper.rb @@ -1 +1,2 @@ pkg +*.pdf .gitignore @@ -1,4 +1,11 @@ -=== 1.0.0 / 2008-10-26 +=== 0.3.0.0 / 2009-05-28 + +* Upgraded to Cucumber > 0.3.x +* Added language option to use the different languages cucumber supports. +* Added out option to specify pdf file name. +* Can handle directories and files + +=== 0.1.0 / 2008-10-26 * 1 major enhancement History.txt @@ -9,11 +9,18 @@ off our sprints to create index cards for our task board. == Usage -Example: + features2cards [options] [ [FILE|DIR] ] - features2cards features/scale.feature - -This will generate a file called cards.pdf in the current directory. + Examples: + features2cards features2cards.feature + features2cards --out italian.pdf--language it examples/i18n/it + +=== Options + + -l [LANG], --language [LANG] Specify language for features (Default: en) + -o, --out [FILE] Specify pdf output file (Default: cards.pdf). + --version Show version + -h, --help Show help == Install @@ -23,7 +30,7 @@ This will generate a file called cards.pdf in the current directory. - Maintained by {Bryan Helmkamp}[mailto:bryan@brynary.com] - Inspired by Luke Melia (http://www.lukemelia.com/blog/archives/2007/12/29/pdf-storycards-001-released-my-first-gem) - + == License Copyright (c) 2008 Bryan Helmkamp. README.rdoc @@ -3,29 +3,5 @@ require "rake/gempackagetask" require "rake/clean" require './lib/features2cards.rb' -spec = Gem::Specification.new do |s| - s.name = "features2cards" - s.version = Features2Cards::VERSION - s.author = "Bryan Helmkamp" - s.email = "bryan" + "@" + "brynary.com" - s.homepage = "http://github.com/brynary/features2cards" - s.summary = "features2cards. Generate printable PDF index cards from Cucumber feature files" - s.description = s.summary - s.executables = "features2cards" - s.files = %w[History.txt MIT-LICENSE.txt README.rdoc Rakefile] + Dir["bin/*"] + Dir["lib/**/*"] + Dir["vendor/**/*"] - - s.add_dependency "prawn", ">= 0.1.2" -end - -Rake::GemPackageTask.new(spec) do |package| - package.gem_spec = spec -end - -CLEAN.include ["pkg", "*.gem", "doc", "ri", "coverage"] - -desc 'Install the package as a gem.' -task :install_gem => [:clean, :package] do - gem = Dir['pkg/*.gem'].first - sh "sudo gem install --no-ri --no-rdoc --local #{gem}" -end +Dir['rake_tasks/**/*.rake'].each { |rake| load rake } Rakefile @@ -2,4 +2,4 @@ require File.expand_path(File.dirname(__FILE__) + "/../lib/features2cards") -Features2Cards::CLI.execute \ No newline at end of file +Features2Cards::CLI.execute(ARGV.dup) \ No newline at end of file bin/features2cards @@ -1,9 +1,21 @@ require "rubygems" -$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__))) +unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__))) + $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) +end +require "features2cards/platform" require "features2cards/cli" -module Features2Cards - VERSION = '0.1.1' +module Features2Cards#:nodoc: + class VERSION #:nodoc: + MAJOR = 0 + MINOR = 3 + TINY = 0 + PATCH = 0 # Set to nil for official release + + STRING = [MAJOR, MINOR, TINY, PATCH].compact.join('.') + STABLE_STRING = [MAJOR, MINOR, TINY].join('.') + end end + lib/features2cards.rb @@ -5,12 +5,38 @@ module Features2Cards attr_reader :body attr_reader :footer - def self.for_feature(feature) - new("Feature", feature.header.split("\n").first.gsub(/^\s*Feature:/, '').strip, "") - end - - def self.for_scenario(scenario) - new("Scenario", scenario.name, scenario.feature.header.split("\n").first) + def self.for_feature(feature, lang) + actual_feature = feature.to_sexp() + actual_feature.shift + actual_feature.shift + title = actual_feature[0].split("\n").first + footer = title + body = actual_feature[0].gsub(/^\s*#{title}\n/, '') + card = [new(title, body, "")] + footer = title + + actual_feature.shift + scenarios = actual_feature + + scenarios.map do |scenario| + case(scenario[0]) + when :scenario_outline + scenario.shift + when :scenario + scenario.shift + scenario.shift + end + title = scenario[0] + " " + scenario[1] + scenario.shift + scenario.shift + body = "" + scenario.map do |step| + body += step[2] + " " + step[3] + "\n" if step[0] == :step or step[0] == :step_invocation + end + card.push(new(title, body, footer)) + end + + return card end def initialize(type, body, footer = nil) lib/features2cards/card.rb @@ -1,28 +1,29 @@ +require "cucumber" require "features2cards/card" require "features2cards/prawn" module Features2Cards class CLI - def self.execute - load_cucumber - new.execute + attr_reader :paths + attr_reader :options + + def self.execute(args) + new(args).execute! end - - def self.load_cucumber - $LOAD_PATH.unshift(File.expand_path("./vendor/plugins/cucumber/lib")) - - require "cucumber" - require "cucumber/treetop_parser/feature_en" - Cucumber.load_language("en") - - Cucumber::Tree::Feature.class_eval do - attr_reader :scenarios - end + + def initialize(args, out_stream = STDOUT, error_stream = STDERR) + @args = args + @out_stream = out_stream + @error_stream = error_stream + @paths = [] + @options = default_options end - def execute - if files.empty? + def execute! + parse!(@args) + load_cucumber(@options[:lang]) + if feature_files.empty? usage exit end @@ -30,40 +31,89 @@ module Features2Cards generate_pdf(cards) end + def parse!(args) + @args = args + @args.extend(::OptionParser::Arguable) + @args.options do |opts| + opts.banner = ["Usage: features2cards [options] [ [FILE|DIR] ]+", "", + "Examples:", + "features2cards features2cards.feature", + "features2cards --language it examples/i18n/it", + ].join("\n") + opts.on("-l [LANG]", "--language [LANG]", + "Specify language for features (Default: #{@options[:lang]})") do |v| + @options[:lang] = v + end + opts.on("-o", "--out [FILE]", + "Specify pdf output file (Default: #{@options[:pdf_file]}).") do |v| + @options[:pdf_file] = v + end + opts.on_tail("--version", "Show version.") do + @out_stream.puts VERSION::STRING + Kernel.exit + end + opts.on_tail("-h", "--help", "You're looking at it.") do + @out_stream.puts opts.help + Kernel.exit + end + end.parse! + + # Whatever is left after option parsing is the FILE arguments + @paths += args + end + + def load_cucumber(lang) + Cucumber.load_language(lang) + + Cucumber::Ast::Feature.class_eval do + attr_reader :scenarios + end + end + def cards features_to_cards(features) end def features - files.map do |file| - parser.parse_feature(file) + feature_files.map do |file| + parser.parse_file(file, {}) end end - def files - ARGV + def feature_files + potential_feature_files = @paths.map do |path| + path = path.gsub(/\\/, '/') # In case we're on windows. Globs don't work with backslashes. + path = path.chomp('/') + File.directory?(path) ? Dir["#{path}/**/*.feature"] : path + end.flatten.uniq + potential_feature_files end + def parser - @parser ||= Cucumber::TreetopParser::FeatureParser.new + @parser ||= Cucumber::Parser::FeatureParser.new end def features_to_cards(features) features.map do |feature| - [Card.for_feature(feature)] + - feature.scenarios.map do |scenario| - Card.for_scenario(scenario) - end + [Card.for_feature(feature, @options[:lang])] end.flatten end def generate_pdf(cards) - Prawn::Document.generate_cards(cards) + Prawn::Document.generate_cards(@options[:pdf_file], cards) end def usage - $stderr.puts "ERROR: No feature files given" - $stderr.puts "usage: features2cards <feature files>" + @error_stream.puts "ERROR: No feature files given" + @error_stream.puts "Type 'features2cards --help' for usage." + end + + def default_options + { + :lang => "en", + :pdf_file => "cards.pdf" + } end end lib/features2cards/cli.rb @@ -4,8 +4,8 @@ class Prawn::Document CARD_WIDTH = 72 * 5 # 5 inches CARD_HEIGHT = 72 * 3 # 3 inches - def self.generate_cards(cards) - generate("cards.pdf", :page_layout => :landscape) do + def self.generate_cards(outfile, cards) + generate(outfile, :page_layout => :landscape) do row = 2 col = 0 @@ -44,16 +44,16 @@ class Prawn::Document outline_box - margin_box 18 do - text card.type + ": ", :size => 14 + margin_box 8 do + text card.type, :size => 12 - margin_box 36 do - text card.body, :size => 16, :align => :center + margin_box 16 do + text card.body, :size => 10, :align => :left end unless card.footer.nil? - bounding_box [bounds.left, bounds.bottom + 18], :width => bounds.width, :height => 18 do - text card.footer, :align => :right + bounding_box [bounds.left, bounds.bottom + 10], :width => bounds.width, :height => 10 do + text card.footer, :size => 8, :align => :right end end end lib/features2cards/prawn.rb examples/features2cards.feature a47499eb5c6c1faebec92160e65aabc7eb34c179 Bryan Helmkamp bryan@brynary.com http://github.com/brynary/features2cards/commit/179f36401c153d0117f697daf2d77d72e6e4e42e 179f36401c153d0117f697daf2d77d72e6e4e42e 2009-06-12T13:10:58-07:00 2009-06-12T13:10:58-07:00 Merge kosmas58/master Conflicts: README.rdoc Rakefile features2cards.gemspec lib/features2cards.rb 910a73b4df3c37d98ce39514b62a3f950d61319b Bryan Helmkamp bryan@brynary.com