troo 0.0.10 → 0.0.11

data/lib/troo/cli/commands/default.rb

@@ -2,15 +2,22 @@ module Troo
   module Commands
     class Default
       class << self
+        # @param  []
+        # @param  []
+        # @return []
         def dispatch(klass, id)
           new(klass, id).set_default
         end
       end
 
+      # @param  []
+      # @param  []
+      # @return []
       def initialize(klass, id)
         @klass, @id = klass, id
       end
 
+      # @return []
       def set_default
         return success if resource && resource.set_default!
         error

data/lib/troo/cli/commands/move/card.rb

@@ -3,15 +3,24 @@ module Troo
     module Move
       class Card
         class << self
+          # @param  []
+          # @param  []
+          # @param  []
+          # @return []
           def dispatch(card_id, list_id, board_id = nil)
             new(card_id, list_id, board_id).move
           end
         end
 
+        # @param  []
+        # @param  []
+        # @param  []
+        # @return []
         def initialize(card_id, list_id, board_id = nil)
           @card_id, @list_id, @board_id = card_id, list_id, board_id
         end
 
+        # @return []
         def move
           return 'Card cannot be found.'  if card_not_found?
           return 'List cannot be found.'  if list_not_found?

data/lib/troo/cli/commands/refresh.rb

@@ -4,15 +4,22 @@ module Troo
       attr_reader :id
 
       class << self
+        # @param  []
+        # @param  []
+        # @return []
         def dispatch(klass, id = nil)
           new(klass, id).refresh
         end
       end
 
+      # @param  []
+      # @param  []
+      # @return []
       def initialize(klass, id = nil)
         @klass, @id = klass, id
       end
 
+      # @return []
       def refresh
         return not_found    if not_found?
         return many_success if multiple_refreshed?

data/lib/troo/cli/commands/refresh/all.rb

@@ -1,10 +1,12 @@
 module Troo
   module Commands
     class RefreshAll
+      # @return [String]
       def self.dispatch
         new.refresh_all
       end
 
+      # @return [String]
       def refresh_all
         return success if refreshed?
         failure

data/lib/troo/cli/commands/show.rb

@@ -4,15 +4,22 @@ module Troo
       attr_reader :id, :type
 
       class << self
+        # @param  []
+        # @param  []
+        # @return [String]
         def dispatch(klass, id = nil)
           new(klass, id).render
         end
       end
 
+      # @param  []
+      # @param  []
+      # @return [Troo::Commands::Show]
       def initialize(klass, id = nil)
         @klass, @id = klass, id
       end
 
+      # @return [String]
       def render
         if resource
           presenter

data/lib/troo/cli/commands/show/show_boards.rb

@@ -2,6 +2,7 @@ module Troo
   module Commands
     class ShowBoards
       class << self
+        # @return []
         def dispatch
           new.render
         end
@@ -9,6 +10,7 @@ module Troo
 
       def initialize; end
 
+      # @return []
       def render
         return presenter if resources.any?
         error

data/lib/troo/cli/commands/show/show_comments.rb

@@ -4,15 +4,20 @@ module Troo
       attr_reader :id
 
       class << self
+        # @param  []
+        # @return []
         def dispatch(id = nil)
           new(id).render
         end
       end
 
+      # @param  []
+      # @return []
       def initialize(id = nil)
         @id = id
       end
 
+      # @return []
       def render
         if resource
           presenter

data/lib/troo/cli/commands/status.rb

@@ -2,15 +2,20 @@ module Troo
   module Commands
     class Status
       class << self
+        # @param  []
+        # @return []
         def dispatch(klass)
           new(klass).report_status
         end
       end
 
+      # @param  []
+      # @return []
       def initialize(klass)
         @klass = klass
       end
 
+      # @return []
       def report_status
         return success if resource
         error

data/lib/troo/cli/default.rb

@@ -3,18 +3,24 @@ module Troo
     class Default < ThorFixes
       package_name 'default'
 
+      # @param  [String]
+      # @return [String]
       desc 'board <id>',
            'Set the board <id> to default.'
       def board(id)
         say Commands::Default.dispatch(Board, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'card <id>',
            'Set the card <id> to default.'
       def card(id)
         say Commands::Default.dispatch(Card, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'list <id>',
            'Set the list <id> to default.'
       def list(id)

data/lib/troo/cli/main.rb

@@ -1,6 +1,7 @@
 module Troo
   module CLI
     class Main < ThorFixes
+      # @return [String]
       desc 'status',
            'Get troo status.'
       def status
@@ -18,6 +19,7 @@ module Troo
         end
       end
 
+      # @return [String]
       desc 'config',
            'Show the current configuration.'
       def config
@@ -25,6 +27,7 @@ module Troo
         say Troo.configuration.view
       end
 
+      # @return [String]
       desc 'cleanup',
            'Removes all local data.'
       def cleanup
@@ -36,6 +39,7 @@ module Troo
         end
       end
 
+      # @return [String]
       desc 'version',
            'Print the version.'
       def version
@@ -59,6 +63,10 @@ module Troo
            'Refresh all local data or board, list or card with <id>.'
       subcommand :refresh, CLI::Refresh
 
+      # @param  [String]
+      # @param  [String]
+      # @param  [String]
+      # @return [String]
       desc 'move <card_id> <list_id> (<board_id>)',
            'Move card with <card_id> to list with <list_id> ' \
            'optionally to another board with <board_id>.'

data/lib/troo/cli/refresh.rb

@@ -3,24 +3,31 @@ module Troo
     class Refresh < ThorFixes
       package_name 'refresh'
 
+      # @return [String]
       desc 'all',
            'Refresh all the local data.'
       def all
         say Commands::RefreshAll.dispatch
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'board (<id>)',
            'Refresh the default board or board with <id>.'
       def board(id = nil)
         say Commands::Refresh.dispatch(Troo::Board, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'card (<id>)',
            'Refresh the default card or card with <id>.'
       def card(id = nil)
         say Commands::Refresh.dispatch(Troo::Card, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'list (<id>)',
            'Refresh the default list or list with <id>.'
       def list(id = nil)

data/lib/troo/cli/show.rb

@@ -3,12 +3,15 @@ module Troo
     class Show < ThorFixes
       package_name 'show'
 
+      # @return [String]
       desc 'boards',
            'Show all the boards with lists.'
       def boards
         say Troo::Commands::ShowBoards.dispatch
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'board (<id>)',
            'Show lists and cards for board <id>' \
            ' (uses default board if <id> not provided).'
@@ -16,6 +19,8 @@ module Troo
         say Troo::Commands::Show.dispatch(Troo::Board, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'list (<id>)',
            'Show all cards for list <id>' \
            ' (uses default list if <id> not provided).'
@@ -23,6 +28,8 @@ module Troo
         say Troo::Commands::Show.dispatch(Troo::List, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'card (<id>)',
            'Show a card <id> including last 3 comments' \
            ' (uses default card if <id> not provided).'
@@ -30,6 +37,8 @@ module Troo
         say Troo::Commands::Show.dispatch(Troo::Card, id)
       end
 
+      # @param  [String]
+      # @return [String]
       desc 'comments (<id>)',
            'Show all comments for card <id>' \
            ' (uses default card if <id> not provided).'

data/lib/troo/cli/thor_fixes.rb

@@ -1,6 +1,10 @@
 module Troo
   module CLI
     class ThorFixes < Thor
+      # @param  []
+      # @param  []
+      # @param  []
+      # @return []
       def self.banner(command, namespace = nil, subcommand = false)
         [basename, @package_name, command.usage].compact.join(' ')
       end

data/lib/troo/configuration.rb

@@ -1,29 +1,4 @@
 module Troo
-  class Preference
-    include Virtus.value_object
-
-    values do
-      attribute :label, String
-      attribute :value, String
-    end
-
-    class << self
-      def view(parameters)
-        new(parameters).view
-      end
-    end
-
-    def view
-      [formatted_label, value].join(' ')
-    end
-
-    private
-
-    def formatted_label
-      (label + ':').rjust(25, ' ')
-    end
-  end
-
   class Configuration
     include Virtus.value_object
 
@@ -40,15 +15,15 @@ module Troo
     end
 
     class << self
+      # @param  []
+      # @param  [String]
+      # @return []
       def load(file, env)
-        new(YAML.load_file(file)[env.to_s])
-      rescue Errno::ENOENT
-        puts "\nConfiguration cannot be found, please run 'troo init'" \
-             " first.\n\n"
-        exit(1)
+        new(YAML.load_file(file)[env])
       end
     end
 
+    # @return []
     def view
       attributes.map do |label, value|
         Preference.view(label: label, value: value)

data/lib/troo/database.rb

@@ -1,15 +1,22 @@
 module Troo
   class Database
     class << self
+      # @param  []
+      # @param  [Hash]
+      # @return []
       def connect(configuration, options = {})
         new(configuration, options).connect
       end
     end
 
+    # @param  []
+    # @param  [Hash]
+    # @return []
     def initialize(configuration, options = {})
       @configuration, @options = configuration, options
     end
 
+    # @return []
     def connect
       Ohm.connect(db: configuration.database)
     end

data/lib/troo/debug.rb

@@ -3,6 +3,9 @@ require 'pry-nav'
 require 'ruby-prof'
 
 module Troo
+  # @param  [String]
+  # @param  []
+  # @return []
   def self.debug(filename = 'profile.html', &block)
     RubyProf.start
 

data/lib/troo/decorators/member.rb

@@ -3,6 +3,7 @@ module Troo
     class Member < Resource
       include DecoratorHelpers
 
+      # @return [String]
       def username
         ['@', klass.username].join
       end

data/lib/troo/decorators/resource.rb

@@ -3,10 +3,14 @@ module Troo
     class Resource
       include DecoratorHelpers
 
+      # @param  []
+      # @param  [Hash]
+      # @return [Troo::Decorators::Resource]
       def initialize(klass, options = {})
         @klass, @options = klass, options
       end
 
+      # @return [String]
       def title
         [
           resource_id,
@@ -15,6 +19,7 @@ module Troo
         ].compact.join(' ') + "\n"
       end
 
+      # @return [String]
       def resource_title
         if klass.type == :card
           Troo::Wordwrap.this(name, prune: true)
@@ -24,6 +29,7 @@ module Troo
         end
       end
 
+      # @return [String]
       def resource_id
         if klass.type == :card
           brackets(Troo::Formatter.highlight(
@@ -33,32 +39,39 @@ module Troo
         end
       end
 
+      # @return []
       def id
         (klass.type == :card) ? klass.short_id : klass.id
       end
 
+      # @return [String]
       def description
         return 'N/A' if klass.description.nil? ||
                         klass.description.empty?
         Troo::Formatter.wordwrap(klass.description)
       end
 
+      # @return [String, NilClass]
       def default
         klass.default? ? '*' : nil
       end
 
+      # @return [String]
       def name
         (klass.name && klass.name.chomp) || 'N/A'
       end
 
+      # @return []
       def board
         klass.board.decorator
       end
 
+      # @return []
       def list
         klass.list.decorator
       end
 
+      # @return [String]
       def comments
         if klass.comments.any? && klass.comments.size > 3
           msg = '(There are more comments, use: ' \
@@ -72,28 +85,34 @@ module Troo
         end
       end
 
+      # @return [String]
       def members
         Presenters::Member.new(klass).show
       end
 
+      # @return [String]
       def last_activity_date
         return 'N/A' unless klass.last_activity_date
         Time.parse(klass.last_activity_date)
             .strftime('%a, %b %d at %H:%M')
       end
 
+      # @return [String]
       def as_view
         Template.parse(self, '/../views/' + type + '.erb')
       end
 
+      # @return [String]
       def username
         ['@', klass.member.username].join
       end
 
+      # @return [String]
       def text
         Troo::Formatter.wordwrap(klass.text)
       end
 
+      # @return [String]
       def date
         Time.parse(klass.date).strftime('%a, %b %d at %H:%M')
       end