kosmas58-features2cards 0.3.92

data/History.txt

@@ -0,0 +1,17 @@
+=== 0.3.1 / 2009-06-12
+
+The Kosmas Schütz Release.
+
+* 4 major enhancements
+
+  * Upgraded to Cucumber > 0.3.x (Kosmas Schütz)
+  * Added language option to use the different languages cucumber supports. (Kosmas Schütz)
+  * Added out option to specify pdf file name. (Kosmas Schütz)
+  * Can handle directories and files (Kosmas Schütz)
+
+=== 0.1.0 / 2008-10-26
+
+* 1 major enhancement
+
+  * Birthday!
+

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Bryan Helmkamp
+
+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/README.rdoc

@@ -0,0 +1,36 @@
+= features2cards
+
+* http://github.com/brynary/features2cards
+
+== Description
+
+Create PDF cards from Cucumber features and scenarios for printing. We use it as we kick
+off our sprints to create index cards for our task board.
+
+== Usage
+
+  features2cards [options] [ [FILE|DIR] ]
+
+  Examples:
+    features2cards features2cards.feature
+    features2cards --out italian.pdf examples/i18n/it
+
+=== Options
+
+  -o, --out [FILE]              Specify pdf output file (Default: cards.pdf).
+  --version                     Show version
+  -h, --help                    Show help
+
+== Install
+
+  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-2009 Bryan Helmkamp.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rubygems'
+require "rake/gempackagetask"
+require "rake/clean"
+require './lib/features2cards.rb'
+
+Dir['rake_tasks/**/*.rake'].each { |rake| load rake }
+

data/bin/features2cards

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

data/lib/features2cards.rb

@@ -0,0 +1,21 @@
+require "rubygems"
+
+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#:nodoc:
+  class VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 3
+    TINY  = 92
+    PATCH = nil # 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

@@ -0,0 +1,53 @@
+module Features2Cards
+  class Card
+  
+    attr_reader :type
+    attr_reader :body
+    attr_reader :footer
+
+    def self.for_feature(feature)
+      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
+          when :tag
+            next
+          when :comment
+            next
+        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)
+      @type = type
+      @body = body
+      @footer = footer
+    end
+  
+  end
+end

data/lib/features2cards/cli.rb

@@ -0,0 +1,113 @@
+require "cucumber"
+require "features2cards/card"
+require "features2cards/prawn"
+
+module Features2Cards
+  class CLI
+    
+    attr_reader :paths
+    attr_reader :options 
+      
+    def self.execute(args)
+      new(args).execute!
+    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!    
+      parse!(@args)
+      load_cucumber
+      if feature_files.empty?
+        usage
+        exit
+      end
+      
+      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 examples/i18n/it",  
+        ].join("\n")
+        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  
+      Cucumber::Ast::Feature.class_eval do
+        attr_reader :scenarios
+      end
+    end
+    
+    def cards
+      features_to_cards(features)
+    end
+    
+    def features
+      feature_files.map do |file|
+        Cucumber::FeatureFile.new(file).parse({})
+      end
+    end
+    
+    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::Parser::FeatureParser.new
+    end
+
+    def features_to_cards(features)
+      features.map do |feature|
+        [Card.for_feature(feature)] 
+      end.flatten
+    end
+
+    def generate_pdf(cards)
+      Prawn::Document.generate_cards(@options[:pdf_file], cards)
+    end
+    
+    def usage
+      @error_stream.puts "ERROR: No feature files given"
+      @error_stream.puts "Type 'features2cards --help' for usage."
+    end
+    
+    def default_options
+      {
+        :pdf_file => "cards.pdf"
+      }
+    end
+    
+  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

@@ -0,0 +1,63 @@
+require "prawn"
+
+class Prawn::Document
+  CARD_WIDTH  = 72 * 5 # 5 inches
+  CARD_HEIGHT = 72 * 3 # 3 inches
+  
+  def self.generate_cards(outfile, cards)
+    generate(outfile, :page_layout => :landscape) do
+      row = 2
+      col = 0
+  
+      cards.each do |card|
+        if row == 0
+          start_new_page
+          row = 2
+          col = 0
+        end
+    
+        draw_card(card, row, col)
+    
+        col += 1
+    
+        if col > 1
+          col = 0
+          row -= 1
+        end
+      end
+    end
+  end
+  
+  def margin_box(margin, &block)
+    bounding_box [bounds.left + margin, bounds.top - margin],
+      :width => bounds.width - (margin * 2), :height => bounds.height - (margin * 2),
+      &block
+  end
+  
+  def outline_box
+    stroke_rectangle bounds.top_left, bounds.width, bounds.height
+  end
+
+  def draw_card(card, row, col)
+    bounding_box [CARD_WIDTH * col, CARD_HEIGHT * row + ((bounds.height - (2*CARD_HEIGHT))/2)],
+      :width => CARD_WIDTH, :height => CARD_HEIGHT do
+        
+      outline_box
+    
+      margin_box 8 do
+        text card.type, :size => 12
+        
+        margin_box 16 do
+          text card.body, :size => 10, :align => :left
+        end
+        
+        unless card.footer.nil?
+          bounding_box [bounds.left, bounds.bottom + 10], :width => bounds.width, :height => 10 do
+            text card.footer, :size => 8, :align => :right
+          end
+        end
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: kosmas58-features2cards
+version: !ruby/object:Gem::Version 
+  version: 0.3.92
+platform: ruby
+authors: 
+- Bryan Helmkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-22 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: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.92
+    version: 
+description: features2cards. Generate printable PDF index cards from Cucumber feature files
+email: bryan@brynary.com
+executables: 
+- features2cards
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- MIT-LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/features2cards
+- lib/features2cards
+- lib/features2cards/card.rb
+- lib/features2cards/cli.rb
+- lib/features2cards/platform.rb
+- lib/features2cards/prawn.rb
+- lib/features2cards.rb
+has_rdoc: false
+homepage: http://github.com/brynary/features2cards
+licenses: 
+post_install_message: 
+rdoc_options: []
+
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: features2cards. Generate printable PDF index cards from Cucumber feature files
+test_files: []
+