pivotal_to_pdf-formatters 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+test_reports

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.rvmrc.template

@@ -0,0 +1 @@
+rvm 1.9.3@pivotal_to_pdf-formatters

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pivotal_to_pdf-formatters.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'spork' do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch('spec/spec_helper.rb') { :rspec }
+end
+
+guard 'rspec', :all_after_pass => false, :cli => "--color --format documentation --drb" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)/(.+)\.rb$})     { |m| [ "lib/#{m[1]}/#{m[2]}.rb", "spec/#{m[1]}/#{m[2]}_spec.rb" ] }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Yi Wen
+
+MIT License
+
+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.md

@@ -0,0 +1,45 @@
+# PivotalToPdf::Formatters
+
+The gem provides the formatters for the pivotal_to_pdf gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pivotal_to_pdf-formatters'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pivotal_to_pdf-formatters
+
+## Usage
+
+The gem needs to use with pivotal_to_pdf gem. It provides the formatters for the pivotal_to_pdf.
+
+To use an existing formatter, Please see the [pivotal_to_pdf README](https://github.com/ywen/pivotal_to_pdf) **Formatters** section.
+
+To add a formatter, please fork this project, add you own formatter, submit a PR, and I will merge it if I decide no harm can be done and update the version. Once the new version of this gem is released, you can update the gem and your formatter should be ready for use.
+
+### Coding standard
+
+A formatter must have 2 public interfaces for it to work:
+
+- ```initialize``` takes an array of stories
+- ```write_to``` method writes to the your chosen output (PDF, HTML, etc.) in your style.
+
+Your formatter can extends from ```PivotalToPdf::Formatters::Base``` to have ```initialize``` method available.
+
+The ```Default``` formatter is a bad example on how to write code. I expect some tests along with your formatter.
+Design it good, do not afraid adding more help classes when needed.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+Dir["#{File.dirname(__FILE__)}/tasks/**/*.rb"].each {|f| require f}

data/lib/pivotal_to_pdf-formatters/base.rb

@@ -0,0 +1,12 @@
+module PivotalToPdf
+  module Formatters
+    class Base
+      attr_reader :stories
+      private :stories
+      def initialize(stories)
+        @stories = stories
+        p stories.size
+      end
+    end
+  end
+end

data/lib/pivotal_to_pdf-formatters/default.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'prawn'
+require 'rainbow'
+
+module PivotalToPdf
+  module Formatters
+    class Default < Base
+      def write_to(destination)
+        Prawn::Document.generate("#{destination}.pdf",
+                                 :page_layout => :landscape,
+                                 :margin      => [25, 25, 50, 25],
+                                 :page_size   => [302, 432]) do |pdf|
+
+          # pdf.font "#{Prawn::BASEDIR}/data/fonts/DejaVuSans.ttf"
+          # pdf.start_new_page
+
+          stories.each_with_index do |story, index|
+            padding = 10
+            pdf.stroke_color = story.story_color
+            pdf.stroke_bounds
+            width = 370
+            pdf.line_width=6
+            # --- Write content
+            pdf.bounding_box [pdf.bounds.left+padding, pdf.bounds.top-padding], :width => width do
+              pdf.text story.formatted_name, :size => 14, :inline_format => true
+              pdf.fill_color "52D017"
+              pdf.text story.label_text, :size => 8
+              pdf.text "\n", :size => 14
+              pdf.fill_color "444444"
+              pdf.text story.formatted_description || "", :size => 10, :inline_format => true
+              pdf.fill_color "000000"
+            end
+            pdf.line(pdf.bounds.bottom_left, pdf.bounds.bottom_right)
+            pdf.stroke_bounds 
+
+            pdf.text_box story.points, :size => 12, :at => [12, 50], :width => width-18 unless story.points.nil?
+            pdf.text_box "Owner: " + (story.respond_to?(:owned_by) ? story.owned_by : "None"),
+              :size => 8, :at => [12, 18], :width => width-18
+
+            pdf.fill_color "999999"
+            pdf.text_box story.story_type.capitalize,  :size => 8,  :align => :right, :at => [12, 18], :width => width-18
+            pdf.fill_color "000000"
+            pdf.start_new_page unless index == stories.size - 1
+          end
+          # pdf.number_pages "<page>/<total>", {:at => [pdf.bounds.right - 16, -28]}
+
+          puts ">>> Generated PDF file in '#{destination}.pdf'".foreground(:green)
+                                 end
+      rescue Exception
+        puts "[!] There was an error while generating the PDF file... What happened was:".foreground(:red)
+        raise
+      end
+    end
+  end
+end

data/lib/pivotal_to_pdf-formatters/version.rb

@@ -0,0 +1,5 @@
+module PivotalToPdf
+  module Formatters
+    VERSION = "0.0.1"
+  end
+end

data/lib/pivotal_to_pdf-formatters.rb

@@ -0,0 +1,4 @@
+require 'pivotal_to_pdf-formatters/base'
+Dir["#{File.dirname(__FILE__)}/pivotal_to_pdf-formatters/**/*.rb"].each do |f| 
+  require f
+end

data/pivotal_to_pdf-formatters.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pivotal_to_pdf-formatters/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yi Wen"]
+  gem.email         = ["hayafirst@gmail.com"]
+  gem.description   = %q{The gem is a collection of possible formatters for the pivotal_to_pdf gem}
+  gem.summary       = %q{The gem is a collection of possible formatters for the pivotal_to_pdf gem}
+  gem.homepage      = "https://github.com/ywen/pivotal_to_pdf-formatters"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "pivotal_to_pdf-formatters"
+  gem.require_paths = ["lib"]
+  gem.version       = PivotalToPdf::Formatters::VERSION
+  gem.add_development_dependency(%q<rspec>)
+  gem.add_development_dependency(%q<rake>)
+  gem.add_development_dependency(%q<guard-spork>)
+  gem.add_development_dependency(%q<guard-rspec>)
+  gem.add_development_dependency(%q<tailor>, "0.1.5")
+  gem.add_development_dependency(%q<cane>)
+  gem.add_development_dependency(%q<simplecov>)
+  gem.add_development_dependency(%q<growl-rspec>)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'simplecov'
+SimpleCov.start do
+  SimpleCov.at_exit do
+    threshold = 100
+    SimpleCov.result.format!
+    if SimpleCov.result.covered_percent != threshold
+      actual_coverage = SimpleCov.result.covered_percent
+      puts "The coverage is #{actual_coverage}%. It has to be 100%"
+      exit 1
+    end
+  end
+end
+require 'spork'
+require 'guard/spork'
+
+Spork.prefork do
+  require 'rspec/core'
+  Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+  require "#{File.dirname(__FILE__)}/../lib/pivotal_to_pdf-formatters"
+
+  RSpec.configure do |config|
+    config.mock_with :rspec
+  end
+end
+
+Spork.each_run do
+  load "#{File.dirname(__FILE__)}/../lib/pivotal_to_pdf-formatters.rb"
+  Dir["#{File.dirname(__FILE__)}/../lib/pivotal_to_pdf-formatters/*.rb"].each {|f| load f}
+end
+

data/tasks/ci.rb

@@ -0,0 +1,24 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  require 'cane/rake_task'
+  task :ci => [
+    'cruise_spec',
+    'quality'
+  ]
+
+  desc "Run cane to check quality metrics"
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 10
+    cane.no_doc = true
+  end
+  desc "Run all specs in spec directory (excluding plugin specs)"
+  RSpec::Core::RakeTask.new(:cruise_spec) do |t|
+    out = File.join(File.expand_path(File.dirname(__FILE__)), "..","test_reports/Rspec.html")
+    t.rspec_opts = ["--format", "html", "-o", out, "--format", "progress"]
+    excluded_paths = ['bundle', 'spec', 'config/boot.rb', '/var/', '/usr']
+    t.pattern = "spec/**/*_spec.rb"
+  end
+rescue LoadError => e
+end

data/tasks/rspec.rb

@@ -0,0 +1,17 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+
+  spec_prereq = :noop
+  task :noop do
+  end
+
+  desc "Run all specs in spec directory (excluding plugin specs)"
+  RSpec::Core::RakeTask.new(:spec => spec_prereq) do |t|
+    t.rspec_opts = ["--format", "documentation"]
+    t.pattern = "spec/**/*_spec.rb"
+  end
+
+rescue LoadError => e
+  p e
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: pivotal_to_pdf-formatters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yi Wen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tailor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: growl-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The gem is a collection of possible formatters for the pivotal_to_pdf
+  gem
+email:
+- hayafirst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc.template
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pivotal_to_pdf-formatters.rb
+- lib/pivotal_to_pdf-formatters/base.rb
+- lib/pivotal_to_pdf-formatters/default.rb
+- lib/pivotal_to_pdf-formatters/version.rb
+- pivotal_to_pdf-formatters.gemspec
+- spec/spec_helper.rb
+- tasks/ci.rb
+- tasks/rspec.rb
+homepage: https://github.com/ywen/pivotal_to_pdf-formatters
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: The gem is a collection of possible formatters for the pivotal_to_pdf gem
+test_files:
+- spec/spec_helper.rb