kood 0.0.1

data/lib/kood/cli/switch.rb

@@ -0,0 +1,10 @@
+class Kood::CLI < Thor
+
+  desc "switch <BOARD-ID>", "Switches to the specified board"
+  def switch(board_id)
+    Kood::Board.get!(board_id).select
+    ok "Board switched to #{ board_id }."
+  end
+  map 'select' => 'switch'
+
+end

data/lib/kood/core.rb

@@ -0,0 +1,95 @@
+require 'toystore'
+
+module Kood
+  extend self
+
+  # Path to where data, such as user configurations and boards, is stored
+  KOOD_PATH = ".kood"
+  KOOD_ROOT = Pathname(File.expand_path("~")).join(KOOD_PATH)
+
+  # Check if the environment is set to test or production mode
+  def test?
+    ENV['RACK_ENV'] == 'test'
+  end
+
+  # Default path to the repository where boards are stored
+  # @return [String] path to the main repository
+  def root
+    @root ||= test? ? KOOD_ROOT.join('storage-test').to_s : KOOD_ROOT.join('storage').to_s
+  end
+
+  # File where configurations are stored
+  # @return [String] the name of the file
+  def config_path
+    test? ? "config-test.yml" : "config.yml"
+  end
+
+  # Initialize a repo (and create a master branch since some git commands
+  # rely on its existence)
+  def repo(path = root)
+    @repo ||= {}
+    @repo[path] ||= begin
+      new_repo = Grit::Repo.init(path)
+      Dir.chdir(path) # TODO This is not ideal but otherwise it would be necessary to pass
+      # a :chdir option in all calls to Grit. This may be a bug in Grit related with the
+      # --work-tree flag
+
+      unless new_repo.branches.any? { |b| b.name == 'master' } # Check if master exists
+        index = new_repo.index
+        index.add('k', '')
+        index.commit("init")
+      end
+      new_repo # If this has been done before, the above command will do nothing
+    end
+  end
+
+  # Default colors to represent some common card labels
+  # @return [Hash] The keys are labels and values are the associated colors
+  def default_labels
+    labels = { 'user-story' => 'magenta', 'tech-story' => 'green' }
+    %w{ bug issue }.each { |k| labels[k] = 'red' }
+    %w{ improvement enhancement }.each { |k| labels[k] = 'yellow' }
+    %w{ documentation docs }.each { |k| labels[k] = 'cyan' }
+    labels['other'] = 'blue'
+    return labels
+  end
+
+  # Live configurations that need to be saved.
+  class Config
+    include Toy::Store
+
+    # There's no use in tracking changes made to the configurations, so instead of using
+    # the git adapter, use a simple configuration file
+    adapter :user_config, {}
+
+    # Associations
+    list :boards, Kood::Board
+
+    # Attributes
+    attribute :custom_repos,     Hash   # Support storing boards in external repos
+    attribute :current_board_id, String # Can be stored externally, so checkout isn't enough
+    attribute :labels,           Hash,  default: Kood.default_labels
+
+    # Only one instance of Config should be created
+    # @return [Kood::Config] The singleton instance to be used outside this module
+    def self.instance
+      @@instance ||= get_or_create('config')
+    end
+
+    # Helper method to set the `current_board_id` attribute
+    def select_board(board_id)
+      self.current_board_id = board_id
+      save! if changed?
+    end
+
+    # Sets the `current_board_id` attribute to nil
+    def unselect_board
+      select_board nil
+    end
+  end
+
+  # @return [Kood::Config] The singleton instance to be used outside this module
+  def config
+    Config.instance
+  end
+end

data/lib/kood/errors.rb

@@ -0,0 +1,8 @@
+module Kood
+  class Error < StandardError; end
+  class TypeError < TypeError; end
+
+  class NotFound < Error; end
+  class NotUnique < Error; end
+  class MultipleDocumentsFound < Error; end
+end

data/lib/kood/extensions/grit.rb

@@ -0,0 +1,65 @@
+module Grit
+  # Reopen the `Grit::Repo` class and add some useful methods.
+  #
+  # This code is based on [git.io/git-up](//git.io/git-up).
+  # A special Thank You to the authors.
+  #
+  class Repo
+    # Automatically stashes and unstashes changes in the current branch.
+    # @yield The code block is executed after stashing all existing changes, if any. After
+    #   executing the block, a `stash pop` applies changes and deletes the stash
+    def with_stash(options = {})
+      stashed = false
+      if change_count(options) > 0
+        git.stash(options)
+        stashed = true
+      end
+      yield
+    ensure
+      git.stash(options, "pop") if stashed
+    end
+
+    # Checkout a specific branch and then return to the previously checked out branch.
+    # @yield The code block is executed after a `checkout`. After executing the block,
+    #   the previous branch is checked out again.
+    # @raise [CheckoutError] If it fails to checkout the branch
+    def with_branch(options = {}, branch_name)
+      unless head.respond_to?(:name)
+        raise CheckoutError, "It seems you changed things manually. You are not on a branch."
+      end
+      current_branch = head.name
+      checkout!(options, branch_name)
+      yield
+    ensure
+      checkout!(options, current_branch) unless on_branch? current_branch
+    end
+
+    # Utility method that does both `with_stash` and `with_branch`
+    # @see #with_stash
+    # @see #with_branch
+    def with_stash_and_branch(stash_options = {}, branch_options = {}, branch_name)
+      with_stash(stash_options) do
+        with_branch(branch_options, branch_name) { yield }
+      end
+    end
+
+    # Check if the currently checked out branch matches a given branch name
+    def on_branch?(branch_name = nil)
+      head.respond_to?(:name) and head.name == branch_name
+    end
+
+    private
+
+    def change_count(options = {})
+      options = { :porcelain => true, :'untracked-files' => 'no' }.merge(options)
+      git.status(options).split("\n").count
+    end
+
+    def checkout!(options = {}, branch)
+      git.checkout(options, branch)
+      raise CheckoutError, "Failed to checkout #{ branch }." unless on_branch? branch
+    end
+  end
+
+  class CheckoutError < StandardError; end
+end

data/lib/kood/list.rb

@@ -0,0 +1,36 @@
+require 'toystore'
+
+module Kood
+  class List
+    include Toy::Store
+
+    # Associations
+    list :cards, Card, dependent: true
+
+    # Observers
+    before_create :id_is_unique?
+
+    def self.get!(id)
+      super rescue raise NotFound, "The specified list does not exist."
+    end
+
+    private
+
+    # ToyStore supports adapters per model but this program needs an adapter per instance
+    def self.with_adapter(branch, root)
+      current_client = adapter.client
+      current_options = adapter.options
+
+      adapter :git, Kood.repo(root), branch: branch, path: 'lists'
+      Card.with_adapter(branch, root) do
+        yield
+      end
+    ensure
+      adapter :git, current_client, current_options
+    end
+
+    def id_is_unique?
+      raise NotUnique, "A list with this ID already exists." unless List.get(id).nil?
+    end
+  end
+end

data/lib/kood/version.rb

@@ -0,0 +1,3 @@
+module Kood
+  VERSION = '0.0.1'
+end

data/man/kood-board.1

@@ -0,0 +1,74 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "KOOD" "1" "January 2013" "" ""
+.
+.SH "NAME"
+\fBkood\fR \- sample help page
+.
+.SH "SYNOPSIS"
+\fBkood\fR [\fIformat\fR\.\.\.] \fIfile\fR\.\.\.
+.
+.br
+\fBkood\fR \fB\-m\fR|\fB\-\-man\fR \fIfile\fR\.\.\.
+.
+.br
+\fBkood\fR \fB\-S\fR|\fB\-\-server\fR \fIfile\fR\.\.\.
+.
+.br
+\fBkood\fR \fB\-\-pipe\fR \fIfile\fR
+.
+.br
+\fBkood\fR < \fIfile\fR
+.
+.SH "DESCRIPTION"
+\fBKood\fR is a CLI for taskboards with a minimal self\-hosted web interface\.
+.
+.SH "FILES"
+Sed posuere consectetur est at lobortis\. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus\. Curabitur blandit tempus porttitor\. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit\. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus\. Praesent commodo cursus magna, vel scelerisque nisl consectetur et\. Curabitur blandit tempus porttitor\.
+.
+.P
+Lorem ipsum dolor sit amet, consectetur adipiscing elit\. Donec ullamcorper nulla non metus auctor fringilla\. Aenean eu leo quam\. Pellentesque ornare sem lacinia quam venenatis vestibulum\. Curabitur blandit tempus porttitor\.
+.
+.SH "OPTIONS"
+These options control things\.
+.
+.TP
+\fB\-s\fR, \fB\-\-sample\fR
+Aenean eu leo quam\. Pellentesque ornare sem lacinia quam venenatis vestibulum\. Maecenas faucibus mollis interdum\. Curabitur blandit tempus porttitor\.
+.
+.TP
+\fB\-L\fR, \fB\-\-lorem\fR
+Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor\. Cras mattis consectetur purus sit amet fermentum\.
+.
+.TP
+\fB\-\-pipe\fR
+Don\'t generate files, write generated output to standard output\. This is the default behavior when ronn source text is piped in on standard input and no \fIfile\fR arguments are provided\.
+.
+.P
+Miscellaneous options:
+.
+.TP
+\fB\-e\fR, \fB\-\-example\fR
+Porta risus etiam consectetur vestibulum\.
+.
+.SH "EXAMPLES"
+Vestibulum id ligula porta felis euismod semper:
+.
+.IP "" 4
+.
+.nf
+
+$ kood \-\-clone my\-board new\-board
+$ kood \-\-c my\-board new\-board
+$ kood \-\-assigned user@server status
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BUGS"
+\fBKood\fR is a work in progress\.
+.
+.SH "SEE ALSO"
+kood\-card(1), kood\-status(1)

data/man/kood-board.1.html

@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>kood(1) - sample help page</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#FILES">FILES</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+    <a href="#BUGS">BUGS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>kood(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>kood(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>kood</code> - <span class="man-whatis">sample help page</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>kood</code> [<var>format</var>...] <var>file</var>...<br />
+<code>kood</code> <code>-m</code>|<code>--man</code> <var>file</var>...<br />
+<code>kood</code> <code>-S</code>|<code>--server</code> <var>file</var>...<br />
+<code>kood</code> <code>--pipe</code> <var>file</var><br />
+<code>kood</code> &lt; <var>file</var></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><strong>Kood</strong> is a CLI for taskboards with a minimal self-hosted web interface.</p>
+
+<h2 id="FILES">FILES</h2>
+
+<p>Sed posuere consectetur est at lobortis. Fusce dapibus, tellus ac cursus commodo,
+tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Curabitur
+blandit tempus porttitor. Duis mollis, est non commodo luctus, nisi erat porttitor
+ligula, eget lacinia odio sem nec elit. Cum sociis natoque penatibus et magnis dis
+parturient montes, nascetur ridiculus mus. Praesent commodo cursus magna, vel
+scelerisque nisl consectetur et. Curabitur blandit tempus porttitor.</p>
+
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ullamcorper nulla
+non metus auctor fringilla. Aenean eu leo quam. Pellentesque ornare sem lacinia
+quam venenatis vestibulum. Curabitur blandit tempus porttitor.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>These options control things.</p>
+
+<dl>
+<dt><code>-s</code>, <code>--sample</code></dt><dd><p>Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.
+Maecenas faucibus mollis interdum. Curabitur blandit tempus porttitor.</p></dd>
+<dt><code>-L</code>, <code>--lorem</code></dt><dd><p>Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.
+Cras mattis consectetur purus sit amet fermentum.</p></dd>
+<dt class="flush"><code>--pipe</code></dt><dd><p>Don't generate files, write generated output to standard output. This is the
+default behavior when ronn source text is piped in on standard input and no
+<var>file</var> arguments are provided.</p></dd>
+</dl>
+
+
+<p>Miscellaneous options:</p>
+
+<dl>
+<dt><code>-e</code>, <code>--example</code></dt><dd>Porta risus etiam consectetur vestibulum.</dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Vestibulum id ligula porta felis euismod semper:</p>
+
+<pre><code>$ kood --clone my-board new-board
+$ kood --c my-board new-board
+$ kood --assigned user@server status
+</code></pre>
+
+<h2 id="BUGS">BUGS</h2>
+
+<p><strong>Kood</strong> is a work in progress.</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><span class="man-ref">kood-card<span class="s">(1)</span></span>, <span class="man-ref">kood-status<span class="s">(1)</span></span></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>January 2013</li>
+    <li class='tr'>kood(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>