kood 0.0.1

data/.gitignore

@@ -0,0 +1,47 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+
+# OS or Editor folders
+.DS_Store
+Thumbs.db
+.cache
+.project
+.settings
+.tmproj
+*.esproj
+nbproject
+
+# Dreamweaver added files
+_notes
+dwsync.xml
+
+# Komodo
+*.komodoproject
+.komodotools
+
+# Folders to ignore
+.hg
+.svn
+.CVS
+intermediate
+publish
+.idea
+
+# Build script local files
+build/buildinfo.properties
+build/config/buildinfo.properties
+
+# Ruby specifics
+.rvmrc
+Gemfile.lock
+pkg/*
+.yardoc

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+-
+LICENSE
+README.md

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Francisco
+
+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,9 @@
+
+# k▥
+
+Kood is a command-line tool for task boards. It's collaborative and works offline. All data and settings are stored in text files. The application uses Git to handle conflicts and keep track of changes.
+The idea was to use Git as a database and take advantage of some of its features (such as conflict-resolution and branching) and distributed nature.
+
+At least for now, this is a **pet project not intended for real use**, so expect some things to be broken. Nevertheless, more information will be added here in the future.
+
+![Work smarter](//raw.github.com/dmfrancisco/kood/media/promo.gif "Kood Promo")

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+
+# To run all tests at once, simply do:
+#   bundle exec rake test
+#
+# To run unit tests:
+#   bundle exec rake test:unit
+#
+# To turn specs with verbose output:
+#   bundle exec rake test:spec TESTOPTS="--verbose"
+#
+# For additional help:
+#   rake --tasks
+#
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+namespace :test do
+  Rake::TestTask.new(:spec) do |t|
+    ENV["RACK_ENV"] = "test"
+    t.libs << "spec"
+    t.pattern = "spec/**/*_spec.rb"
+  end
+
+  Rake::TestTask.new(:unit) do |t|
+    ENV["RACK_ENV"] = "test"
+    t.libs << "test"
+    t.pattern = "test/**/*_test.rb"
+  end
+
+  task :all => [:unit, :spec]
+end
+
+desc "Run all test suites"
+task :test => 'test:all'
+
+desc "Uninstall the current version of kood"
+task :uninstall do
+  puts `gem uninstall -x kood` # -x flag uninstalls executables too without confirmation
+end

data/bin/kood

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "kood"
+
+Kood::CLI.start

data/kood.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/kood/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name     = 'kood'
+  gem.version  = Kood::VERSION
+  gem.authors  = ['David Francisco']
+  gem.email    = 'kood@dmfranc.com'
+  gem.homepage = 'http://kood.dmfranc.com'
+  gem.summary  = 'Work smarter -- An extensible CLI for git-backed taskboards.'
+  gem.platform = Gem::Platform::RUBY
+  gem.required_ruby_version = '>= 1.9.0'
+
+  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.require_paths = ["lib"]
+
+  gem.add_development_dependency "ronn",      "~> 0.7.0"
+  gem.add_development_dependency "rake",      "~> 0.9.2"
+  gem.add_runtime_dependency "activesupport", "~> 3.2.9"
+  gem.add_runtime_dependency "thor",          "~> 0.16.0"
+  gem.add_runtime_dependency "adapter-git",   "~> 0.5.0"
+  gem.add_runtime_dependency "toystore",      "~> 0.10.4"
+  gem.add_runtime_dependency "user_config"
+end

data/lib/kood-plugin-example.rb

@@ -0,0 +1,10 @@
+module Kood
+  module Plugin
+    class Example < Thor
+      desc "foo", "An example command"
+      def foo
+        puts "Hello from example"
+      end
+    end
+  end
+end

data/lib/kood.rb

@@ -0,0 +1,14 @@
+require 'kood/adapter/git'
+require 'kood/adapter/user_config'
+require 'kood/extensions/grit'
+require 'kood/errors'
+require 'kood/version'
+
+module Kood
+  autoload :Card,  'kood/card'
+  autoload :List,  'kood/list'
+  autoload :Board, 'kood/board'
+
+  require 'kood/cli'
+  require 'kood/core'
+end

data/lib/kood/adapter/git.rb

@@ -0,0 +1,56 @@
+require 'adapter-git'
+
+module Adapter
+  # This reopens the git adapter module and changes part of its behavior.
+  #
+  # It adds support for custom file extensions. Like the original git adapter, data is
+  # persisted in YAML but, if there is a key named `content`, then the content will be
+  # saved in plain text and a YAML front matter block is added to the top of the file.
+  #
+  module Git
+    attr_accessor :file_extension
+
+    # Transform a key into a filename
+    # @return [String] the name of the file
+    def key_for(key)
+      key = super + "." + (@file_extension || 'yml')
+      File.join(*[options[:path], key].compact)
+    end
+
+    # Encode data to be written
+    # @return [String] data in `yaml` format or `yaml frontmatter + text`
+    def encode(value)
+      # If it contains a `content` attribute, other data is in a YAML front matter block
+      if value.key? "content"
+        content = value["content"].to_s
+        value.delete("content")
+
+        data = value.to_yaml
+        data += "---\n\n"
+        data += content
+        data
+      else
+        # Standard YAML file
+        value.to_yaml
+      end
+    end
+
+    # Decode data to be read
+    # @return [Hash] data
+    def decode(value)
+      # Check if a YAML front matter block is present
+      yaml_regex = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      if value =~ yaml_regex
+        content = value.sub(yaml_regex, "")
+        data = YAML.load($1)
+        data["content"] = content
+        data
+      else
+        # Standard YAML file
+        data = YAML.load(value)
+      end
+    rescue => e
+      raise "YAML Exception: #{ e.message }"
+    end
+  end
+end

data/lib/kood/adapter/user_config.rb

@@ -0,0 +1,36 @@
+require 'user_config'
+
+module Adapter
+  # Simple adapter that uses the `user_config` gem to
+  # persist data into a YAML configuration file.
+  #
+  module UserConfigFile
+    def read(key, options = nil)
+      config[key]
+    end
+
+    def write(key, attributes, options = nil)
+      config[key] = attributes
+      config.save
+    end
+
+    def delete(key, options = nil)
+      config.delete(key)
+      config.save
+    end
+
+    def clear(options = nil)
+      config.clear
+      config.save
+    end
+
+    private
+
+    def config
+      @@conf ||= UserConfig.new Kood::KOOD_PATH
+      @@conf[Kood.config_path]
+    end
+  end
+end
+
+Adapter.define(:user_config, Adapter::UserConfigFile)

data/lib/kood/board.rb

@@ -0,0 +1,160 @@
+require 'toystore'
+
+module Kood
+  class Board
+    include Toy::Store
+
+    # Associations
+    list :lists, List
+
+    # Attributes
+    attribute :custom_repo, String, virtual: true
+
+    # Validations
+    validates_format_of :id, :with => /^[A-Za-z\d_\-]+$/
+
+    # Observers
+    before_create :id_is_unique?
+    before_create do |board|
+      if custom_repo # Support external branches
+        Kood.config.custom_repos[board.id] = custom_repo
+        Kood.config.save!
+      end
+      board.update_adapter # To create a board we need to change the current branch
+    end
+
+    def self.get(id)
+      board = nil
+      Board.with_adapter(id, root(id)) do
+        board = super
+        board.update_adapter unless board.nil?
+      end
+      return board
+    end
+
+    def self.get!(id)
+      super rescue raise NotFound, "The specified board does not exist."
+    end
+
+    def self.current
+      get Kood.config.current_board_id
+    end
+
+    def self.current!
+      current or raise Error, "No board has been selected yet."
+    end
+
+    def is_current?
+      Board.current.eql? self
+    end
+
+    def delete
+      client.with_stash do
+        client.git.checkout('master') if client.on_branch? id
+        Kood.config.unselect_board if is_current?
+        Kood.config.custom_repos.delete(id)
+        client.git.branch({ :D => true }, id)
+      end # Since we deleted the branch, the default behavior is not necessary
+    end
+
+    def cards
+      lists.inject([]) { |cards, list| cards += list.cards }
+    end
+
+    def select
+      Kood.config.select_board(id)
+    end
+
+    def pull(remote = 'origin')
+      client.with_stash_and_branch(id) do
+        client.git.pull({ process_info: true }, remote, id)
+      end
+    end
+
+    def push(remote = 'origin')
+      client.with_stash_and_branch(id) do
+        client.git.push({ process_info: true }, remote, id)
+      end
+    end
+
+    def sync(remote = 'origin')
+      exit_status, out, err = pull(remote)
+      exit_status.zero? ? push(remote) : [exit_status, out, err]
+    end
+
+    # Returns a list of git users. It will search in other boards or in the rest of the
+    # git repository if this is an external board. The result also includes the users that
+    # already made commits to this board
+    def potential_members(options = { all_branches: true })
+      members = client.git.log(all: options[:all_branches], format: '%aN <%cE>').split("\n").uniq
+      members.map! { |m| m.force_encoding("UTF-8") }
+    end
+
+    def find_potential_member_by_partial_name_or_email(search_param)
+      # Find partial (and exact) matches
+      matches = potential_members.select do |u|
+        # `search_param` may be a normal string or a string representing a regular expression
+        u.match /#{ search_param }/i or u.downcase.include?(search_param.downcase)
+      end
+      return matches.first if matches.length <= 1
+
+      # Refine the search and retrieve only exact matches
+      exact_matches = matches.select { |u| u.casecmp(search_param).zero? }
+      return exact_matches.length == 1 ? exact_matches.first : nil
+    end
+
+    def published?
+      client.remotes.any? { |b| b.name =~ /\/#{ id }$/ }
+    end
+
+    def external?
+      Kood.config.custom_repos[id].present?
+    end
+
+    def root
+      Board.root(id)
+    end
+
+    def adapter
+      @adapter || self.class.adapter
+    end
+
+    # Set adapter for this instance
+    def update_adapter
+      @adapter = Adapter[:git].new(Kood.repo(root), branch: id)
+    end
+
+    def with_context
+      Board.with_adapter(id, root) do
+        yield self
+      end
+    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
+      List.with_adapter(branch, root) do
+        yield
+      end
+    ensure
+      adapter :git, current_client, current_options
+    end
+
+    def self.root(board_id)
+      Kood.config.custom_repos[board_id] or Kood.root
+    end
+
+    def client
+      adapter.client
+    end
+
+    def id_is_unique?
+      raise NotUnique, "A board with this ID already exists." unless Board.get(id).nil?
+    end
+  end
+end