trelloscrum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7400785d9440390067e1d35fd8d33cbb6ca7930
+  data.tar.gz: 7e4ca5f8d0974e16adbbcae7962f24581a031f24
+SHA512:
+  metadata.gz: 3fc10493800ca0dac2f36719fb2f849b147a227dbcaa73f6f5cf53c3b4f181573fe267d06180f0b3201029f15fcd2b8b3d98265b9a7a64c7ffaca92bb39de02d
+  data.tar.gz: 3398005874c404863abc6ec9fe4d9e1592421b536edc012e9f7b28c437511ce452d14b5e4e020b572fda1753895b87a83a13bad766ccb361fb75be7acc67bc40

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "pry"

data/bin/trelloscrum

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require_relative '../lib/cli'
+
+TrelloScrum::Cli.start()

data/lib/cli.rb

@@ -0,0 +1,130 @@
+require 'thor'
+
+require 'json'
+require 'chronic'
+require 'trello'
+
+require_relative 'pdf'
+
+module TrelloScrum
+  class Cli < Thor
+    class_option :"config", :default => "./config.json", :type => :string, :desc => "Path to config, default is local directory/config.json"
+    class_option :"verbose", :aliases => ["v"], :default => false, :type => :boolean, :desc => "Verbose output"
+
+
+    desc "pdf OUTFILE", "generate PDF for cards"
+    method_option :"only-estimated", :default => true, :type => :boolean, :desc => "Wether or not to output only estimates"
+    method_option :"list", :type => :string, :desc => "Listname to use"
+    method_option :"board", :type => :string, :desc => "Board id to use"
+    method_option :"filter-title", :type => :string, :desc => "Regexp to filter on titles, only show's cards matching title"
+
+    def pdf(outfile)
+      setup_trello
+      cards = get_cards
+      generate_pdf(cards, outfile)
+    end
+
+    desc "setup DEVELOPER_PUBLIC_KEY MEMBER_TOKEN [BOARD_ID]", "config trello"
+    long_desc <<-EOT
+      Generate the appropriate keys for Trello:
+
+      1. Get the developer public key
+      \x5  1. Log in to Trello
+      \x5  2. Go to https://trello.com/1/appKey/generate
+      \x5  3. Save the developer public key
+
+      2. Get the member token
+      \x5  1. Go to https://trello.com/1/connect?key=DEVELOPER_PUBLIC_KEY&name=TrelloScrumCard&response_type=token
+              Replace DEVELOPER_PUBLIC_KEY with the previously generated key
+      \x5  2. Click "Allow"
+      \x5  3. Save the member token
+
+    EOT
+    def setup(developer_public_key, member_token, board_id=nil)
+      self.config["developer_public_key"] = developer_public_key
+      self.config["member_token"] = member_token
+      self.config["board_id"] = board_id if board_id
+
+      File.open(options.config, "w") do |f|
+        f.write JSON.pretty_generate(self.config)
+      end
+
+      puts "New config written to #{options.config}"
+    end
+
+    protected
+
+    def log(msg)
+      puts msg if options.verbose
+    end
+
+    def setup_trello
+      if !config["developer_public_key"] || config["developer_public_key"].empty?
+        puts "Please make sure you have configured a developer public key (run setup help for more info)"
+        exit(1)
+      end
+
+      if !config["member_token"] || config["member_token"].empty?
+        puts "Please make sure you have configured a member token (run setup help for more info)"
+        exit(1)
+      end
+
+      Trello.configure do |c|
+        c.developer_public_key = config["developer_public_key"]
+        c.member_token = config["member_token"]
+      end
+    end
+
+    def config
+      if File.exist?(options.config)
+        @config ||= JSON.parse(File.read(options.config));
+      else
+        @config ||= {}
+      end
+    end
+
+    def get_cards
+      list_name = options.list || config["list_name"]
+
+      if !list_name || list_name.empty?
+        puts "Please enter a lisname or configurate one (use --list)"
+        exit(1)
+      end
+
+      board_id = options.board || config["board_id"]
+
+      if !board_id || board_id.empty?
+        puts "Please enter a board_id or configurate one (use --board)"
+        exit(1)
+      end
+
+      log "Getting cards from list #{list_name} of board #{board_id}"
+
+      board = Trello::Board.find(board_id)
+
+      list = board.lists.find{|l| l.name == list_name }
+
+      log "Found list: #{list ? "yes" : "no"}"
+
+      cards = list.cards.sort!{|a, b| a.pos <=> b.pos }
+
+      log "List contains #{cards.size} cards"
+
+      cards.find_all do |card|
+        keep = true
+        keep = false if options[:"only-estimated"] && !(card.name =~ /^\(\d+/)
+        keep = false if options[:"filter-title"] && !(card.name =~ Regexp.new(options[:"filter-title"]))
+        keep
+      end
+    end
+
+    def generate_pdf(cards, output_path)
+      pdf = Pdf.new
+      pdf.render_cards(cards)
+      pdf.save(output_path)
+    end
+
+
+
+  end
+end

data/lib/pdf.rb

@@ -0,0 +1,203 @@
+require 'prawn'
+require 'prawn/table'
+
+module TrelloScrum
+  class Pdf
+
+    attr_reader :doc, :options
+
+    def initialize(page_size = 'A4', options = {})
+
+      @options = {
+        base_font_size: 20
+      }.update(options)
+
+      @doc = Prawn::Document.new :page_size => page_size, :page_layout => :landscape
+
+      self.doc.font_families.update("FontAwesome" => {:normal => "#{File.dirname(__FILE__)}/../resources/fontawesome-webfont.ttf"})
+      self.doc.font "Helvetica", :size => self.options[:base_font_size]
+
+
+    end
+
+    def render_cards(cards)
+      cards.each_with_index do |card, i|
+        render_card(card)
+
+        # Start next card on new page
+        self.doc.start_new_page unless i == cards.size - 1
+      end
+    end
+
+    def save(filename)
+      self.doc.render_file filename
+    end
+
+    protected
+
+    def render_card(card)
+      points,client,title = parse_card_title(card.name)
+
+      puts "- #{points} :: #{client} :: #{title}"
+
+      box_width = 100
+
+      # Output storypoints
+      points_box_size = render_points_box(points)
+
+      self.doc.bounding_box([0, self.doc.cursor], :width => self.doc.bounds.width - points_box_size) do
+        self.doc.text(client, {
+          :size => self.options[:base_font_size],
+          :overflow => :expand
+        })
+
+        self.doc.text(title, {
+          :size => self.options[:base_font_size] * 2.25,
+          :style => :bold,
+          :overflow => :expand
+        })
+      end
+
+      # Output due date
+      render_due_date(card.due)
+
+      self.doc.move_down 10
+
+      if card.checklists.any?
+        # Take half the size of the remaining card for description, leave the rest fot checklists
+        # Yes, taking doc.cursor is weird, but keep in mind the coordinate system's origin is bottom left
+        desc_height = doc.cursor / 2
+      else
+        desc_height = doc.cursor
+      end
+
+      # Manually creating box here so we can get heigh later.
+      desc_box = Prawn::Text::Box.new(card.desc,
+        at: [0, self.doc.cursor],
+        width: self.doc.bounds.width,
+        height: desc_height,
+        overflow: :shrink_to_fit,
+        document: self.doc)
+
+
+      desc_box.render()
+
+      # Textbox doesn't move the cursor so we'll do it manually
+      self.doc.move_down desc_box.height
+
+      if card.checklists.any?
+        self.doc.move_down 20
+
+        card.checklists.each do |checklist|
+          render_checklist(checklist)
+        end
+      end
+
+    end
+
+    def render_checklist(checklist)
+      data = checklist.items.map do |item|
+        [
+          (item.state != "complete" ? "\uF096" : "\uF046"),
+          item.name
+        ]
+      end
+
+      if data.any?
+        self.doc.text(checklist.name, {
+          :style => :bold
+        })
+
+        table_height = self.doc.cursor
+
+        table = nil
+        real_table_height = self.doc.bounds.height + 1 # Should always be bigger than table_height
+        table_font_size = self.options[:base_font_size]
+        while(real_table_height > table_height && table_font_size > 8) do
+          table = Prawn::Table.new(data, self.doc) do |tbl|
+            tbl.width = self.doc.bounds.width
+            tbl.cells.size = table_font_size
+            tbl.cells.borders = []
+            if table_font_size < 15
+              tbl.cells.padding = [0,0,2,0]
+              tbl.column(0).padding = [1.5,0,2,0]
+            else
+              tbl.cells.padding = [0,0,5,0]
+            end
+            tbl.column(0).font = "FontAwesome"
+            tbl.column(0).width = table_font_size + 2
+          end
+          real_table_height = table.height
+          table_font_size -= 1
+        end
+
+        table.draw
+      end
+    end
+
+    def render_due_date(date)
+      return unless date
+
+      date_text = date.strftime("%-d %^B")
+
+      due_box_text = {
+        text: date_text,
+        color: "FF0000",
+        styles: [:bold],
+        style: :bold, # Hack to make it work for width measuring too...
+        size: self.options[:base_font_size] * 3
+      }
+
+      due_box_width = self.doc.width_of(due_box_text[:text], due_box_text)
+      due_box_height = self.doc.height_of_formatted([due_box_text], {})
+
+      due_box = Prawn::Text::Formatted::Box.new([due_box_text], {
+        at: [self.doc.bounds.right - due_box_width, self.doc.bounds.absolute_bottom],
+        width: due_box_width,
+        height: due_box_height,
+        disable_wrap_by_char: true,
+        align: :right,
+        overflow: :shrink_to_fit,
+        document: doc
+      })
+
+      due_box.render()
+    end
+
+    def render_points_box(points)
+      return 0 if points.to_s.empty?
+
+      points_box_size = 100
+      points_box_padding = 10
+
+      points_box = Prawn::Text::Box.new(points.to_s,
+        {
+          at: [self.doc.bounds.absolute_right - points_box_size + points_box_padding, self.doc.bounds.absolute_top - points_box_padding],
+          align: :center,
+          valign: :center,
+          disable_wrap_by_char: true,
+          width: points_box_size - 2 * points_box_padding,
+          height: points_box_size - 2 * points_box_padding,
+          size: 60,
+          style: :bold,
+          overflow: :shrink_to_fit,
+          document: self.doc
+        }
+      )
+
+      points_box.render
+
+      self.doc.stroke do
+        self.doc.rectangle [self.doc.bounds.absolute_right - points_box_size, self.doc.bounds.absolute_top], points_box_size, points_box_size
+      end
+
+      return points_box_size
+    end
+
+    def parse_card_title(title)
+      match = title.match(/^\s*(\((\d+)\))?\s*(\[(.*?)\])?\s*(.*)/)
+      [match[2], match[4], match[5]]
+    end
+
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module TrelloScrum
+  VERSION = '0.1.0'.freeze
+end

data/readme.md

@@ -0,0 +1,59 @@
+# Trello SCRUM
+
+Generates PDF's with (+/-) one page per card with title, body and checklists. Print 4 of them on an A4 for the best action.
+
+## Getting started
+
+1. Install the trelloscrum gem: `gem install trelloscrum`
+1. Create a `config.json` in the current directory by running `trelloscrum setup`. For more information on how to set up everything run `trelloscrum help setup`
+1. Run
+
+## Card format
+
+To get a nice output for cards (see below) write card titles in the following format (all fields are optional).
+
+`(STORYPOINTS) [CLIENT] Rest of the title`
+
+Other supported (native) Trello fields are:
+
+* The card body of course (markdown is not supported)
+* Card checklists (works best with just one list)
+* Due date
+
+This is an example output for a card generated by TrelloScrum
+
+![Example card](https://github.com/flurin/trelloscrum/raw/master/doc/card_example.png)
+
+## Commandline options
+
+```
+Commands:
+  trelloscrum help [COMMAND]                                      # Describe available commands or one specific command
+  trelloscrum pdf OUTFILE                                         # generate PDF for cards
+  trelloscrum setup DEVELOPER_PUBLIC_KEY MEMBER_TOKEN [BOARD_ID]  # config trello
+
+Options:
+      [--config=CONFIG]           # Path to config, default is local directory/config.json
+                                  # Default: ./config.json
+  v, [--verbose], [--no-verbose]  # Verbose output
+```
+
+For more options run `trelloscrum help [COMMAND]`
+
+## Config.json
+
+```
+{
+  "developer_public_key" : "",
+  "member_token" : "",
+  "list_name" : "",
+  "board_id" : ""
+}
+```
+
+## License
+
+- All code and documentation is licesned under the MIT license:
+  - http://opensource.org/licenses/mit-license.html
+- The Font Awesome font is licensed under the SIL OFL 1.1:
+  - http://scripts.sil.org/OFL

data/trelloscrum.gemspec

@@ -0,0 +1,34 @@
+basedir = File.expand_path(File.dirname(__FILE__))
+require "#{basedir}/lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "trelloscrum"
+  spec.version = TrelloScrum::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "Creates product backlog cards from trello cards"
+  spec.files =  Dir.glob("{bin,lib,resources}/**/**/*") +
+                ["trelloscrum.gemspec", "Gemfile", "readme.md"]
+  spec.require_path = "lib"
+
+  spec.executables = ["trelloscrum"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_rubygems_version = ">= 1.3.6"
+
+  spec.authors = ["Flurin Egger"]
+  spec.email = ["flurin@digitpaint.nl"]
+  spec.licenses = ['MIT', 'SIL OFL']
+
+
+  spec.add_dependency "json", "~> 1.8.1"
+  spec.add_dependency "prawn", "~> 2.0.1"
+  spec.add_dependency "prawn-table", "~> 0.2.1"
+  spec.add_dependency "chronic", "~> 0.10.2"
+  spec.add_dependency "ruby-trello", "~> 1.1.2"
+  spec.add_dependency "thor", "~> 0.19.1"
+
+  spec.homepage = "https://github.com/flurin/trelloscrum"
+  spec.description = <<END_DESC
+  Generates PDF's with (+/-) one page per card with title, body and checklists. Print 4 of them on an A4 for the best action.
+END_DESC
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: trelloscrum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Flurin Egger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: prawn-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: ruby-trello
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: |2
+    Generates PDF's with (+/-) one page per card with title, body and checklists. Print 4 of them on an A4 for the best action.
+email:
+- flurin@digitpaint.nl
+executables:
+- trelloscrum
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- bin/trelloscrum
+- lib/cli.rb
+- lib/pdf.rb
+- lib/version.rb
+- readme.md
+- resources/fontawesome-webfont.ttf
+- trelloscrum.gemspec
+homepage: https://github.com/flurin/trelloscrum
+licenses:
+- MIT
+- SIL OFL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Creates product backlog cards from trello cards
+test_files: []