RubyGems - kanboard - Versions diffs - 0.0.1 - Mend

kanboard 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

checksums.yaml +7 -0
data/.gitignore +20 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +29 -0
data/Rakefile +1 -0
data/bin/kanboard +8 -0
data/example/_layouts/default.html +11 -0
data/example/project1.textile +36 -0
data/example/stylesheets/default.css +11 -0
data/kanboard.gemspec +23 -0
data/lib/kanboard.rb +14 -0
data/lib/kanboard/board.rb +95 -0
data/lib/kanboard/card.rb +74 -0
data/lib/kanboard/jekyll_renderer.rb +80 -0
data/lib/kanboard/version.rb +3 -0
metadata +89 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: deb5937ebfd90e9c95f7068512deb0b27747f5af
+  data.tar.gz: 08be304d8eaa9b1e8157ff5ee1409d8b79c71001
+SHA512:
+  metadata.gz: 23280c79d9fef6356e82bf571be4d8dbb9fc0c12acae97a577bd74a49328e3c6806071ddeec00a6985a4a11ef9b7313840fc3463e5c772ad64ed57391755aedd
+  data.tar.gz: 1debdd2e0e2fb611131de93160c4bd650adf2bcc336eb7b5fbdc52b9b66b0aefc68d2885ebbb78503993718786c3e4a2bdea6bdf30d88a7db9141935af1c1ea0

data/.gitignore ADDED Viewed

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/nbproject/private/
+.DS_Store
+_site

data/Gemfile ADDED Viewed

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

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adolfo Villafiorita
+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 ADDED Viewed

@@ -0,0 +1,29 @@
+# Kanboard
+TODO: Write a gem description
+## Installation
+Add this line to your application's Gemfile:
+    gem 'kanboard'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install kanboard
+## Usage
+TODO: Write usage instructions here
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/bin/kanboard ADDED Viewed

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require 'kanboard'
+ARGV.each do |filename|
+  Kanboard::do_it(filename)
+end

data/example/_layouts/default.html ADDED Viewed

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>KanBoard - a Kanban Board from a Textile File</title>
+    <link href="{{site.url}}/stylesheets/default.css" media="screen" rel="stylesheet" type="text/css" />
+  </head>
+  <body>
+    {{ content }}
+  </body>
+</html>

data/example/project1.textile ADDED Viewed

@@ -0,0 +1,36 @@
+---
+title: Project 1
+layout: default
+---
+h1. Project 1
+All text inserted (and not starting with a dash or with a "hN" directive) will be ignored.
+The following items will be used by the script and used to generated a Kanban Board.
+The kanboard is accessible from:
+* "kanboard/Project 1.html":kanboard/Project_1.html
+* "kanboard/Project 1.html":kanboard/Project_1-assignments.html
+h2. Inbox
+- action I1 +bug #important
+- action I2 +feature
+- action I3 +bug
+h2. Approved
+- action A1 +feature @adolfo
+- action A2 +bug @andrea
+- action A3 @pietro
+h2. In Progress
+- action D1 +feature @adolfo
+- action D2 +bug @pietro
+- action D3
+h2. Done
+h2. Trashed

data/example/stylesheets/default.css ADDED Viewed

@@ -0,0 +1,11 @@
+table {
+  border: 1px solid #ccc;
+  width: 100%
+}
+.card {
+  border: 1px solid #ccc;
+  margin: 2px;
+  padding: 3px;
+  background: #eee;
+}

data/kanboard.gemspec ADDED Viewed

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kanboard/version'
+Gem::Specification.new do |spec|
+  spec.name          = "kanboard"
+  spec.version       = Kanboard::VERSION
+  spec.authors       = ["Adolfo Villafiorita"]
+  spec.email         = ["adolfo.villafiorita@icloud.com"]
+  spec.description   = %q{Generate a kanboard from a textile file}
+  spec.summary       = %q{Generate a kanboard from a textile file}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/kanboard.rb ADDED Viewed

@@ -0,0 +1,14 @@
+require 'kanboard/version'
+require 'kanboard/board'
+require 'kanboard/jekyll_renderer'
+module Kanboard
+  def self.do_it(filename)
+    board = Board.new
+    board.load(filename)
+    r = JekyllRenderer.new(board)
+    r.render
+  end
+end

data/lib/kanboard/board.rb ADDED Viewed

@@ -0,0 +1,95 @@
+# make a textile file into a kanban board
+#
+# input a file in the form specified by example.textile
+# result: an internal representation of the board good for being displayed, which
+# includes:
+#
+# - project name
+# - list of workflow states defined in the file
+# - list of swimlanes defined in the files
+# - entries defined in the file organized in a two-dimensional matrix:
+#
+#      (status, swimlane)
+#
+#   (so that they can be placed in the kanban board)
+#
+#   the entries are stored with a hash of arrays. (status, swimlane) are transformed
+#   into a unique key (with string concatenation) and the entry added as elements
+#   of an array
+require "kanboard/card"
+class Kanboard::Board
+  attr_accessor :project, :statuses, :swimlanes, :all_cards
+  def initialize
+    @project = ""
+    @statuses = []         # all statuses (h2. strings) defined in the input file
+    @swimlanes = []        # all unique swim-lane (+ strings) defined in the input file
+    @cards = Hash.new      # cards organised by board position
+    @all_cards = Array.new # all cards defined in the input file
+  end
+  def load filename
+    current_status = "" # current status
+    File.open(filename).each do |line|
+      # set the title to the first h1 found in the file
+      match = line.match(/^h1\.[ ]+(.+)$/)
+      if match and @project == ""
+        @project = match[1]
+      end
+      # look for statuses and add them to the list of statuses.
+      # don't bother about duplications
+      match = line.match(/^h2\.[ ]+(.+)$/)
+      if match
+        @statuses << match[1]
+        current_status = match[1]
+      end
+      # look for cards and manage them
+      if line.start_with?('- ') # make sure we ignore YAML front matter ("---")
+        card = Kanboard::Card.new(@project, @status, line)
+        swimlane = card.swimlane
+        owner = card.owner
+        @swimlanes << swimlane unless @swimlanes.include? swimlane
+        position = hash(current_status, swimlane)
+        @cards[position] = Array.new unless @cards[position]
+        @cards[position] << card
+        @all_cards << card
+      end
+    end
+  end
+  def cards(status, swimlane)
+    @cards[hash(status, swimlane)] || Array.new  # so that we always return an array
+  end
+  #
+  # return all the owners mentioned in the input file
+  #
+  def owners
+    @all_cards.map { |c| c.owner }.uniq
+  end
+  #
+  # return all the cards owned by owner
+  #
+  def cards_of(owner)
+    @all_cards.select { |c| c.owner == owner }
+  end
+  private
+  #
+  # generate an hash which uniquely identifies a cell in the kanban board
+  #
+  def hash(status, swimlane)
+    status + "*" + swimlane
+  end
+end

data/lib/kanboard/card.rb ADDED Viewed

@@ -0,0 +1,74 @@
+# Kanban card
+#
+# Textile markupped text describing a card.
+# a card is a line of text starting with a dash "-"
+#
+# - @adolfo fix this #bug: 234 (c:2013-02-15)
+#
+# the card embeds information such as:
+#
+# * owner: @name
+# * swimlane: +swimlane (at most one)
+# * tags: #tag1, #tag2 (TODO)
+#
+# * creation date: c:
+# * finish date: f:
+# * due date: d:
+#
+# the card stores also information which is defined elsewhere in the kanban file.
+# This information includes:
+#
+# - project: the project the card refers to (set with a h1. tag in the file)
+# - status: the current status of the card (set with a h2. tag in the file)
+#
+class Kanboard::Card
+  GENERIC_SWIMLANE = "Generic" # the swimlane for cards with no swimlane
+  NO_ONE = "Unassigned" # the owned of cards not owned by anyone
+  attr_accessor :project, :status
+  def initialize(project, status, title)
+    @project = project
+    @status = status
+    @title = title[2, title.length] # forget about the initial "- "
+  end
+  def owner
+    find("@", @title) || NO_ONE
+  end
+  def swimlane
+    find("\\+", @title) || GENERIC_SWIMLANE
+  end
+  def created
+    find("c:", @title)
+  end
+  def finished
+    find("f:", @title)
+  end
+  def done?
+    finished != nil
+  end
+  def due
+    find("d:", @title)
+  end
+  def to_s
+    @title
+  end
+  private
+  # find a substring of the type tag[\w]+ in argument
+  # return nil if not found.
+  def find(tag, string)
+    match = string.match(Regexp.new(tag + "([\\w]+)"))
+    match ? match[1] : nil
+  end
+end

data/lib/kanboard/jekyll_renderer.rb ADDED Viewed

@@ -0,0 +1,80 @@
+require 'kanboard/board'
+class Kanboard::JekyllRenderer
+  OUTPUT_DIR = "kanboard"
+  def initialize(board)
+    @board = board
+  end
+  def render
+    Dir.mkdir(OUTPUT_DIR) if not Dir.exists?(OUTPUT_DIR)
+    board_filename = File.join(OUTPUT_DIR,
+                               @board.project.gsub(/[\p{Punct}\p{Space}]+/, "_") +
+                               ".textile")
+    File.open(board_filename, 'w') do |f|
+      f.puts render_board
+    end
+    board_filename = File.join(OUTPUT_DIR,
+                               @board.project.gsub(/[\p{Punct}\p{Space}]+/, "_") +
+                               "-assignments.textile")
+    File.open(board_filename, 'w') do |f|
+      f.puts render_assignments
+    end
+  end
+  def render_board
+    statuses = @board.statuses
+    swimlanes = @board.swimlanes
+    output = ""
+    output << "---
+title: Kanban Board for #{@board.project}
+layout: default
+---
+h1. Board for #{@board.project}\n\n"
+    output << "<table class=\"board\">"
+    output << "<tr>\n"
+    output << "  <th></th>\n"
+    statuses.each do |status|
+      output << "  <th>#{status}</th>\n"
+    end
+    output << "</tr>\n"
+    swimlanes.each do |swimlane|
+      output << "<tr>\n"
+      output << "  <td>#{swimlane}</td>\n"
+      statuses.each do |status|
+        output << "  <td>\n"
+        @board.cards(status, swimlane).each do |card|
+          output << "    <div class=\"card\">#{card}</div>\n"
+        end
+        output << "  </td>\n"
+      end
+      output << "</tr>\n"
+    end
+    output << "</table>\n"
+    output
+  end
+  def render_assignments
+    output = ""
+    output << "---
+title: Assignments for #{@board.project}
+layout: default
+---
+h1. Assignments for #{@board.project}\n\n"
+    @board.owners.each do |owner|
+      output << "h2. #{owner}\n"
+      @board.cards_of(owner).each do |card|
+        output << "* #{card}\n"
+      end
+    end
+    output
+  end
+end

data/lib/kanboard/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Kanboard
+  VERSION = "0.0.1"
+end

metadata ADDED Viewed

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: kanboard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adolfo Villafiorita
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a kanboard from a textile file
+email:
+- adolfo.villafiorita@icloud.com
+executables:
+- kanboard
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/kanboard
+- example/_layouts/default.html
+- example/project1.textile
+- example/stylesheets/default.css
+- kanboard.gemspec
+- lib/kanboard.rb
+- lib/kanboard/board.rb
+- lib/kanboard/card.rb
+- lib/kanboard/jekyll_renderer.rb
+- lib/kanboard/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.0.3
+signing_key:
+specification_version: 4
+summary: Generate a kanboard from a textile file
+test_files: []
+has_rdoc: