brynary-features2cards 0.1.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.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,32 @@
+= 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 features/scale.feature
+
+== Install
+
+If you haven't already added GitHub to your gem sources:
+
+  sudo gem sources -a http://gems.github.com
+  
+Then:
+
+  sudo gem install brynary-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.
+See MIT-LICENSE.txt in this directory.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+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
+

data/bin/features2cards

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

data/lib/features2cards.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "prawn"
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "features2cards/cli"
+
+module Features2Cards
+  VERSION = '0.1.0'
+end

data/lib/features2cards/card.rb

@@ -0,0 +1,23 @@
+module Features2Cards
+  class Card
+  
+    attr_reader :type
+    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)
+    end
+    
+    def initialize(type, body, footer = nil)
+      @type = type
+      @body = body
+      @footer = footer
+    end
+  
+  end
+end

data/lib/features2cards/cli.rb

@@ -0,0 +1,70 @@
+require "features2cards/card"
+require "features2cards/prawn"
+
+module Features2Cards
+  class CLI
+    
+    def self.execute
+      load_cucumber
+      new.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
+    end
+
+    def execute
+      if files.empty?
+        usage
+        exit
+      end
+      
+      generate_pdf(cards)
+    end
+    
+    def cards
+      features_to_cards(features)
+    end
+    
+    def features
+      files.map do |file|
+        parser.parse_feature(file)
+      end
+    end
+    
+    def files
+      ARGV
+    end
+    
+    def parser
+      @parser ||= Cucumber::TreetopParser::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
+      end.flatten
+    end
+
+    def generate_pdf(cards)
+      Prawn::Document.generate_cards(cards)
+    end
+    
+    def usage
+      $stderr.puts "ERROR: No feature files given"
+      $stderr.puts "usage: features2cards <feature files>"
+    end
+    
+  end
+end

data/lib/features2cards/prawn.rb

@@ -0,0 +1,61 @@
+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
+      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 18 do
+        text card.type + ": ", :size => 14
+        
+        margin_box 36 do
+          text card.body, :size => 16, :align => :center
+        end
+        
+        unless card.footer.nil?
+          bounding_box [bounds.left, bounds.bottom + 18], :width => bounds.width, :height => 18 do
+            text card.footer, :align => :right
+          end
+        end
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: brynary-features2cards
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bryan Helmkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-08 00:00:00 -08:00
+default_executable: features2cards
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: prawn
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    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/prawn.rb
+- lib/features2cards.rb
+has_rdoc: false
+homepage: http://github.com/brynary/features2cards
+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.2.0
+signing_key: 
+specification_version: 2
+summary: features2cards. Generate printable PDF index cards from Cucumber feature files
+test_files: []
+