kood 0.0.1

data/lib/kood/cli/edit.rb

@@ -0,0 +1,40 @@
+class Kood::CLI < Thor
+
+  desc "edit [<CARD-ID|CARD-TITLE>]", "Launch the configured editor to modify the card"
+  def edit(card_id_or_title = nil)
+    Kood::Board.current!.with_context do |current_board|
+      card = Kood::Card.find_by_partial_id_or_title!(card_id_or_title)
+      success, command = false, ""
+
+      editor = [ ENV['KOOD_EDITOR'], ENV['EDITOR'] ].find { |e| !e.nil? && !e.empty? }
+      return error "To edit a card set $EDITOR or $KOOD_EDITOR." unless editor
+
+      changed = card.edit_file do |filepath|
+        command = "#{ editor } #{ filepath }"
+        success = system(command)
+      end
+
+      if not success
+        error "Could not run `#{ command }`."
+      elsif changed
+        ok "Card updated."
+      else
+        error "The editor exited without changes. Run `kood update` to persist changes."
+      end
+    end
+  end
+
+  desc "update [<CARD-ID|CARD-TITLE>]", "Persist changes made to cards", hide: true
+  def update(card_id_or_title = nil)
+    Kood::Board.current!.with_context do |current_board|
+      card = Kood::Card.find_by_partial_id_or_title!(card_id_or_title)
+      changed = card.edit_file
+
+      if changed
+        ok "Card updated."
+      else
+        error "No changes to persist."
+      end
+    end
+  end
+end

data/lib/kood/cli/helpers/shell.rb

@@ -0,0 +1,124 @@
+module Kood
+  # Utility functions related to the Shell.
+  #
+  # Contains functions for colors from [git.io/thor](//git.io/thor) and for terminal size
+  # from [git.io/hirb](//git.io/hirb). A special Thank You for both authors.
+  #
+  module Shell
+    extend self
+
+    # Embed in a String to clear all previous ANSI sequences.
+    CLEAR      = "\e[0m"
+    # The start of an ANSI bold sequence.
+    BOLD       = "\e[1m"
+
+    # Set the terminal's foreground ANSI color to black.
+    BLACK      = "\e[30m"
+    # Set the terminal's foreground ANSI color to red.
+    RED        = "\e[31m"
+    # Set the terminal's foreground ANSI color to green.
+    GREEN      = "\e[32m"
+    # Set the terminal's foreground ANSI color to yellow.
+    YELLOW     = "\e[33m"
+    # Set the terminal's foreground ANSI color to blue.
+    BLUE       = "\e[34m"
+    # Set the terminal's foreground ANSI color to magenta.
+    MAGENTA    = "\e[35m"
+    # Set the terminal's foreground ANSI color to cyan.
+    CYAN       = "\e[36m"
+    # Set the terminal's foreground ANSI color to white.
+    WHITE      = "\e[37m"
+
+    # Set the terminal's background ANSI color to black.
+    ON_BLACK   = "\e[40m"
+    # Set the terminal's background ANSI color to red.
+    ON_RED     = "\e[41m"
+    # Set the terminal's background ANSI color to green.
+    ON_GREEN   = "\e[42m"
+    # Set the terminal's background ANSI color to yellow.
+    ON_YELLOW  = "\e[43m"
+    # Set the terminal's background ANSI color to blue.
+    ON_BLUE    = "\e[44m"
+    # Set the terminal's background ANSI color to magenta.
+    ON_MAGENTA = "\e[45m"
+    # Set the terminal's background ANSI color to cyan.
+    ON_CYAN    = "\e[46m"
+    # Set the terminal's background ANSI color to white.
+    ON_WHITE   = "\e[47m"
+
+    # Set color by using a string or one of the defined constants. If a third
+    # option is set to true, it also adds bold to the string. This is based
+    # on Highline implementation and it automatically appends CLEAR to the end
+    # of the returned String.
+    #
+    # Pass foreground, background and bold options to this method as
+    # symbols.
+    #
+    # Example:
+    #
+    #     set_color "Hi!", :red, :on_white, :bold
+    #
+    def set_color(string, *colors)
+      ansi_colors = colors.map { |color| lookup_color(color) }
+      "#{ansi_colors.join}#{string}#{CLEAR}"
+    end
+
+    # Determines if a shell command exists by searching for it in `ENV['PATH']`.
+    # Utility function gently stolen from [git.io/hirb](//git.io/hirb)
+    def command_exists?(command)
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? {|d| File.exists? File.join(d, command) }
+    end
+
+    # Returns width and height of terminal when detected, nil if not detected.
+    # Utility function gently stolen from [git.io/hirb](//git.io/hirb)
+    # @return [Array] width, height
+    def terminal_size
+      if (ENV['COLUMNS'] =~ /^\d+$/) && (ENV['LINES'] =~ /^\d+$/)
+        [ENV['COLUMNS'].to_i, ENV['LINES'].to_i]
+      elsif (RUBY_PLATFORM =~ /java/ || (!STDIN.tty? && ENV['TERM'])) && command_exists?('tput')
+        [`tput cols`.to_i, `tput lines`.to_i]
+      elsif STDIN.tty? && command_exists?('stty')
+        `stty size`.scan(/\d+/).map { |s| s.to_i }.reverse
+      else
+        nil
+      end
+    rescue
+      nil
+    end
+
+    # Check if terminal supports unicode characters
+    def unicode?
+      "\u2501" != 'u2501'
+    end
+
+    # Check if terminal supports colors. Condition stolen from Thor.
+    def color_support?
+      !(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/) || ENV['ANSICON']
+    end
+
+    # Horizontal delimiter for box drawing
+    # @return [String]
+    def horizontal_bar
+      unicode? ? "\u2501" : '-'
+    end
+
+    # Vertical delimiter for box drawing
+    # @return [String]
+    def vertical_bar
+      unicode? ? "\u2503" : '|'
+    end
+
+    # Try to convert a string to a float or integer. Returns the converted object or the
+    # original string if it cannot be converted. Based on code from
+    # [stackoverflow.com/a/8072164/543293](//stackoverflow.com/a/8072164/543293)
+    def type_cast(v)
+      ((float = Float(v)) && (float % 1.0 == 0) ? float.to_i : float) rescue v
+    end
+
+    protected
+
+    def lookup_color(color)
+      self.class.const_get(color.to_s.upcase)
+    end
+  end
+end

data/lib/kood/cli/helpers/table.rb

@@ -0,0 +1,195 @@
+require_relative "shell"
+
+module Kood
+  class Column < Array
+    include Shell
+
+    attr_accessor :width, :rows, :separator
+
+    def initialize(width)
+      @width = width
+      @rows = []
+    end
+
+    # Add a new row to this column
+    # @param [String] row All contents to be added to the row of the column. It may be
+    #   split in several lines.
+    # @param [Hash] options The `:separator` option adds a horizontal line to the end of
+    #   the row. The `:align` option is used for text alignment; acceptable values are
+    #   `ljust`, `lright` and `center`. The `:slice` option slices the given `row`
+    #   parameter in order to fit in the column width. The following keys with default
+    #   values will be added if not present: `{ separator: true, align: 'ljust',
+    #   slice: true }`
+    def add_row(row, options = {})
+      options = { separator: true, align: 'ljust', slice: true }.merge(options)
+      row = row.to_s.force_encoding("UTF-8")
+
+      if @width and options[:slice]
+        sliced_rows = []
+        row.split("\n").each do |row|
+          sliced_rows += self.slice_row(row, options)
+        end
+        sliced_rows << self.separator if options[:separator]
+        self.add_rows(sliced_rows)
+      else
+        @rows.push(row)
+      end
+    end
+
+    # A sequence of dashes with the same width of the column
+    # @return [String]
+    def separator
+      self.horizontal_bar * @width
+    end
+
+    protected
+
+    def add_rows(rows)
+      @rows.push(*rows)
+    end
+
+    def slice_row(row, options = {})
+      sliced_rows = []
+      i = 0
+
+      while slice = row[i, @width]
+        break if slice.blank? and !row.blank?
+        i += @width
+
+        # This slice may start with space(s). If it does, remove them, grab some extra
+        # characters and add them to the slice
+        i, slice = lstrip_row(i, slice, row)
+
+        # If this slice does not end with a space, and the first character of the next
+        # slice is not a space, it means we would be cutting a word in half. If this
+        # is not a big word move it to the next line
+        i, slice = hyphenize_row(i, slice, row)
+
+        slice = align_row(slice, options)
+        slice = colorize_row(slice, options) if options.key? :color
+
+        sliced_rows << slice
+      end
+      sliced_rows
+    end
+
+    def lstrip_row(i, slice, row)
+      slice = slice.lstrip
+      len_diff = @width - slice.length
+      if slice.length < @width and not row[i, len_diff].blank?
+        slice += row[i, len_diff]
+        i += len_diff
+      end
+      return i, slice
+    end
+
+    def hyphenize_row(i, slice, row)
+      if slice[-1] != ' ' and row[i] and row[i] != ' '
+        last_word = slice.split.last
+        len_diff = slice.length - last_word.length
+        if not last_word.blank? and last_word.length <= (@width * 0.25).floor
+          unless slice[0, len_diff].blank?
+            slice = slice[0, len_diff]
+            i -= last_word.length
+          end
+        elsif not last_word.blank? # Cut the word and add an hyphen
+          slice = slice[0..-2] +"-"
+          i -= 1
+        end
+      end
+      return i, slice
+    end
+
+    def align_row(slice, options = {})
+      slice.send(options[:align], @width)
+    end
+
+    def colorize_row(slice, options = {})
+      options.key?(:color) ? set_color(slice, *options[:color]) : slice
+    end
+  end
+
+  class Table
+    include Shell
+
+    attr_accessor :width, :cols, :col_width
+
+    def initialize(num_columns, width = nil)
+      terminal_width = width || terminal_size[0] || 70
+      spare_cols = (terminal_width - 3 * num_columns -1) % num_columns
+      @width     = terminal_width - spare_cols
+      @num_cols  = num_columns
+      @col_width = (@width - 3 * num_columns -1) / num_columns
+      @cols      = []
+      raise "There is not enough space to accommodate all columns" if @col_width < 5
+    end
+
+    def new_column
+      raise "Unable to add more columns to table" if @cols.size == @num_cols
+      column = Kood::Column.new(@col_width)
+      @cols << column
+      column
+    end
+
+    def to_s(options = { separator: true })
+      max_col_rows = biggest_column.rows
+      return empty_row(options) if max_col_rows.length.zero?
+
+      output = max_col_rows.each_with_index.map do |col_row, i|
+        # Don't print the last separator if this is the last thing to be printed
+        row(i, options) unless i == max_col_rows.length-1 and col_row == @cols[0].separator
+      end.join.chomp
+
+      improve_cell_corners(output)
+    end
+
+    # This code comes from [git.io/command_line_reporter](//git.io/command_line_reporter).
+    # A special Thank You to the authors.
+    def separator(type = 'middle')
+      if unicode?
+        case type
+        when 'first'  then left, center, right = "\u250F", "\u2533", "\u2513"
+        when 'middle' then left, center, right = "\u2523", "\u254A", "\u252B"
+        when 'last'   then left, center, right = "\u2517", "\u253B", "\u251B"
+        end
+      else
+        left = right = center = '+'
+      end
+      left + @cols.map { |c| horizontal_bar * (c.width + 2) }.join(center) + right
+    end
+
+    private
+
+    # Returns the column with the largest number of rows
+    def biggest_column
+      @cols.max_by { |col| col.rows.length }
+    end
+
+    # Returns an empty (full width) row
+    def empty_row(options = { separator: true })
+      vbar = options[:separator] ? self.vertical_bar : " "
+      @cols.map { |col| vbar + " #{ " "*@col_width } " }.join + vbar
+    end
+
+    # Returns an entire row from the table (which may cross several columns)
+    def row(row_index, options = { separator: true })
+      vbar = options[:separator] ? self.vertical_bar : " "
+      out = @cols.map { |col| vbar + " #{ col.rows[row_index] || " "*@col_width } " }.join
+      out + vbar + "\n"
+    end
+
+    # Improves cell corners  |               |
+    # For example,        |--|--| becomes |--+--|
+    #                        |               |
+    def improve_cell_corners(table_str)
+      # The ([\e\[\d*m]*) groups are meant to handle colored horizontal bars. This does
+      # not take into account vertical colored bars and assumes the color code is
+      # positioned before the first horizontal bar or after the last one.
+      str = table_str.dup.gsub(/\u2501([\e\[\d*m]*) \u2503 ([\e\[\d*m]*)\u2501/) do
+        "\u2501#{ $1 }\u2501\u254B\u2501#{ $2 }\u2501"
+      end
+      str.gsub!(/\u2501([\e\[\d*m]*) \u2503/) { "\u2501#{ $1 }\u2501\u252B" }
+      str.gsub(/\u2503 ([\e\[\d*m]*)\u2501/)  { "\u2523\u2501#{ $1 }\u2501" }
+    end
+  end
+end

data/lib/kood/cli/list.rb

@@ -0,0 +1,70 @@
+class Kood::CLI < Thor
+
+  desc "list [OPTIONS] [<LIST-ID>]", "Display and manage lists"
+  #
+  # Delete a list. If <list-id> is present, the specified list will be deleted.
+  method_option :delete, :aliases => '-d', :type => :boolean
+  #
+  # Copy a list. <list-id> will be copied to <new-list-id>.
+  # <list-id> is kept intact and a new one is created with the exact same data.
+  method_option :copy, :aliases => '-c', :type => :string
+  #
+  # Move a list to another board. <list-id> will be moved to <board-id>.
+  method_option :move, :aliases => '-m', :type => :string
+  def list(list_id = nil)
+    Kood::Board.current!.with_context do |current_board|
+      # If no arguments and options are specified, the command displays all existing lists
+      if list_id.nil? and no_method_options?
+        list_existing_lists(current_board)
+
+      # If the <list-id> argument is present without options, a new list will be created
+      elsif no_method_options?
+        create_list(current_board, list_id)
+
+      # Since <list-id> is present, operate on the specified list
+      else
+        operate_on_list(current_board, list_id)
+      end
+    end
+  end
+  map 'lists' => 'list'
+
+  private
+
+  def operate_on_list(current_board, list_id)
+    list = Kood::List.get!(list_id)
+
+    if options.copy.present?
+      # TODO
+    end # The copied list may be deleted or moved now
+
+    if options.move.present?
+      # TODO
+      # If the list was moved, it cannot be deleted
+
+    elsif options.key? 'delete'
+      delete_list(current_board, list_id)
+    end
+  end
+
+  def list_existing_lists(current_board)
+    error "No lists were found." if current_board.lists.empty?
+    puts current_board.list_ids
+  end
+
+  def create_list(current_board, list_id)
+    list = current_board.lists.create(id: list_id)
+
+    if list.persisted?
+      ok "List created."
+    else
+      msgs = list.errors.full_messages.join("\n")
+      error "#{ msgs }."
+    end
+  end
+
+  def delete_list(current_board, list_id)
+    current_board.lists.destroy(list_id)
+    ok "List deleted."
+  end
+end

data/lib/kood/cli/plugin.rb

@@ -0,0 +1,37 @@
+class Kood::CLI < Thor
+
+  private
+
+  # Load third-party commands / plugins
+  #
+  def self.load_plugins
+    program = File.basename $PROGRAM_NAME
+    command = ARGV.first
+    command = ARGV[1] if command.eql? 'help' and ARGV.length > 1 # Help command
+
+    if program.eql? 'kood' # File is being imported from the bin and not from the test suite
+      unless command.nil? or Kood::CLI.method_defined? command # Check if command is unknown
+        begin
+          plugin_name = command # The command is the name of the plugin
+
+          # Require the plugin, which must be accessible and follow the naming convention
+          require "kood-plugin-#{ plugin_name }"
+
+          # Transform plugin name to a valid class name (for example, foo_bar becomes FooBar)
+          plugin_class_name = Thor::Util.camel_case(plugin_name)
+
+          # Get the class and register it (the plugin must extend Thor)
+          plugin_class = Kood::Plugin.const_get(plugin_class_name)
+          Kood::CLI.register(plugin_class, plugin_name, plugin_name, "Kood plugin")
+        rescue LoadError
+          # TODO Thor supports partial subcommands and aliases for subcommands. The
+          # `method_defined?` condition is not enough. For now, we don't exit here and
+          # everything should still work as expected, but this could be improved.
+          #
+          # puts "Could not find command or plugin \"#{ plugin_name }\"."
+        end
+      end
+    end
+  end
+
+end