brynary-features2cards 0.1.0 → 0.3.0.0

data/History.txt

@@ -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
 

data/README.rdoc

@@ -9,23 +9,28 @@ off our sprints to create index cards for our task board.
 
 == Usage
 
-  features2cards features/scale.feature
+  features2cards [options] [ [FILE|DIR] ]
 
-== Install
+  Examples:
+    features2cards features2cards.feature
+    features2cards --out italian.pdf--language it examples/i18n/it
+
+=== Options
 
-If you haven't already added GitHub to your gem sources:
+  -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
 
-  sudo gem sources -a http://gems.github.com
-  
-Then:
+== Install
 
-  sudo gem install brynary-features2cards
+  sudo gem install features2cards
 
 == Authors
 
 - 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.

data/Rakefile

@@ -3,37 +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"
-end
-
-Rake::GemPackageTask.new(spec) do |package|
-  package.gem_spec = spec
-end
-
-desc 'Show information about the gem.'
-task :write_gemspec do
-  File.open("features2cards.gemspec", 'w') do |f|
-    f.write spec.to_ruby
-  end
-  puts "Generated: features2cards.gemspec"
-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 --local #{gem}"
-end
+Dir['rake_tasks/**/*.rake'].each { |rake| load rake }
 

data/bin/features2cards

@@ -2,4 +2,4 @@
 
 require File.expand_path(File.dirname(__FILE__) + "/../lib/features2cards")
 
-Features2Cards::CLI.execute
+Features2Cards::CLI.execute(ARGV.dup)

data/lib/features2cards.rb

@@ -1,10 +1,21 @@
 require "rubygems"
-require "prawn"
 
-$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.0'
+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
+

data/lib/features2cards/card.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, "")
-    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)

data/lib/features2cards/cli.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

data/lib/features2cards/platform.rb

@@ -0,0 +1,14 @@
+# Detect the platform we're running on so we can tweak behaviour
+# in various places.
+require 'rbconfig'
+
+module Features2Cards
+  BINARY        = File.expand_path(File.dirname(__FILE__) + '/../../bin/features2cards')
+  JRUBY         = defined?(JRUBY_VERSION)
+  IRONRUBY      = Config::CONFIG['sitedir'] =~ /IronRuby/
+  WINDOWS       = Config::CONFIG['host_os'] =~ /mswin|mingw/
+  WINDOWS_MRI   = WINDOWS && !JRUBY && !IRONRUBY
+  RAILS         = defined?(Rails)
+  RUBY_BINARY   = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
+  RUBY_1_9      = RUBY_VERSION =~ /^1\.9/
+end

data/lib/features2cards/prawn.rb

@@ -1,9 +1,11 @@
+require "prawn"
+
 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
   
@@ -42,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: brynary-features2cards
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.3.0.0
 platform: ruby
 authors: 
 - Bryan Helmkamp
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-08 00:00:00 -08:00
+date: 2009-06-12 00:00:00 -07:00
 default_executable: features2cards
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: prawn
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -38,6 +39,7 @@ files:
 - lib/features2cards
 - lib/features2cards/card.rb
 - lib/features2cards/cli.rb
+- lib/features2cards/platform.rb
 - lib/features2cards/prawn.rb
 - lib/features2cards.rb
 has_rdoc: false
@@ -64,7 +66,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: features2cards. Generate printable PDF index cards from Cucumber feature files
 test_files: []