troo 0.0.10 → 0.0.11

data/lib/troo/preference.rb

@@ -0,0 +1,29 @@
+module Troo
+  class Preference
+    include Virtus.value_object
+
+    values do
+      attribute :label, String
+      attribute :value, String
+    end
+
+    class << self
+      # @param  [Hash]
+      # @return []
+      def view(parameters)
+        new(parameters).view
+      end
+    end
+
+    # @return [String]
+    def view
+      [formatted_label, value].join(' ')
+    end
+
+    private
+
+    def formatted_label
+      (label + ':').rjust(25, ' ')
+    end
+  end
+end

data/lib/troo/presentation/formatter.rb

@@ -26,6 +26,7 @@ module Troo
       attribute :align,     Troo::Align, default: Troo::Align.new
     end
 
+    # @return [String]
     def underline
       @underline ? Esc.underline : nil
     end
@@ -38,21 +39,30 @@ module Troo
     attribute :options, Troo::Format
 
     class << self
+      # @param  []
+      # @param  [Hash]
+      # @return []
       def highlight(value, options = {})
         new(value: value, options: options).highlight
       end
 
+      # @param  []
+      # @return []
       def error(value)
         new(value:   value,
             options: { colour: Esc.red }).error
       end
 
+      # @param  []
+      # @param  [Integer]
+      # @return []
       def wordwrap(value, width = 70)
         new(value:   value,
             options: { align: { width: width } }).wordwrap
       end
     end
 
+    # @return [String]
     def highlight
       [
         options.colour,
@@ -62,6 +72,7 @@ module Troo
       ].join
     end
 
+    # @return [String]
     def error
       [
         options.colour,
@@ -70,6 +81,7 @@ module Troo
       ].join
     end
 
+    # @return []
     def wordwrap
       Wordwrap.this(formatted_value, width: width)
     end

data/lib/troo/presentation/sentence.rb

@@ -1,15 +1,22 @@
 module Troo
   class Sentence
     class << self
+      # @param  [Array]
+      # @param  [String]
+      # @return [String]
       def construct(elements, label = 'elements')
         new(elements, label).construct
       end
     end
 
+    # @param  [Array]
+    # @param  [String]
+    # @return [Troo::Sentence]
     def initialize(elements, label)
       @elements, @label = elements, label
     end
 
+    # @return [String]
     def construct
       if one?
         first

data/lib/troo/presentation/template.rb

@@ -3,15 +3,22 @@ module Troo
     include DecoratorHelpers
 
     class << self
+      # @param  []
+      # @param  []
+      # @return []
       def parse(object, path)
         new(object, path).parse
       end
     end
 
+    # @param  []
+    # @param  []
+    # @return []
     def initialize(object, path)
       @object, @path = object, path
     end
 
+    # @return []
     def parse
       ERB.new(load, nil, '-').result(binding)
     end

data/lib/troo/presenters/board.rb

@@ -4,16 +4,23 @@ module Troo
       include DecoratorHelpers
 
       class << self
+        # @param  [Array]
+        # @param  [Hash]
+        # @return [NilClass]
         def all(boards, options = {})
           boards.map { |board| new(board, options).show }
           nil
         end
       end
 
+      # @param  [Troo::Board]
+      # @param  [Hash]
+      # @return [Troo::Presenters::Board]
       def initialize(board, options = {})
         @board, @options = board, options
       end
 
+      # @return []
       def show
         output.render Presenters::Resource.list_view(board)
 
@@ -28,6 +35,7 @@ module Troo
         end
       end
 
+      # @return []
       def render_lists
         output.spacer
 

data/lib/troo/presenters/card.rb

@@ -3,10 +3,14 @@ module Troo
     class Card
       include DecoratorHelpers
 
+      # @param  [Troo::Card]
+      # @param  [Hash]
+      # @return [Troo::Presenter::Card]
       def initialize(card, options = {})
         @card, @options = card, options
       end
 
+      # @return []
       def show
         output.render Template.parse(card, '/../views/card.erb')
       end

data/lib/troo/presenters/comment.rb

@@ -3,10 +3,14 @@ module Troo
     class Comment
       include DecoratorHelpers
 
+      # @param  [Troo::Card]
+      # @param  [Hash]
+      # @return [Troo::Presenters::Comment]
       def initialize(card, options = {})
         @card, @options = card, options
       end
 
+      # @return []
       def show
         title
 

data/lib/troo/presenters/list.rb

@@ -3,10 +3,13 @@ module Troo
     class List
       include DecoratorHelpers
 
+      # @param  [Troo::List]
+      # @return [Troo::Presenters::List]
       def initialize(list, options = {})
         @list, @options = list, options
       end
 
+      # @return [String]
       def show
         output.render Presenters::Resource.list_view(list.board)
 
@@ -17,6 +20,7 @@ module Troo
         end
       end
 
+      # @return [String]
       def render_list
         output.render Presenters::Resource.list_view(list)
 
@@ -31,6 +35,7 @@ module Troo
         end
       end
 
+      # @return [String]
       def render_cards
         output.spacer do
           list.cards.map do |card|

data/lib/troo/presenters/member.rb

@@ -3,10 +3,14 @@ module Troo
     class Member
       include DecoratorHelpers
 
+      # @param  [Troo::Card]
+      # @param  [Hash]
+      # @return [Troo::Presenters::Member]
       def initialize(card, options = {})
         @card, @options = card, options
       end
 
+      # @return [String]
       def show
         Sentence.construct(members, 'members')
       end

data/lib/troo/presenters/resource.rb

@@ -4,15 +4,22 @@ module Troo
       include DecoratorHelpers
 
       class << self
+        # @param  []
+        # @param  [Hash]
+        # @return []
         def list_view(klass, options = {})
           new(klass, options).list_view
         end
       end
 
+      # @param  []
+      # @param  [Hash]
+      # @return []
       def initialize(klass, options = {})
         @klass, @options = klass, options
       end
 
+      # @return []
       def list_view
         [id, name, default].compact.join(' ') + "\n"
       end

data/lib/troo/remote/board.rb

@@ -20,10 +20,12 @@ module Troo
       attribute :members,       Array[Troo::Remote::Member]
 
       class << self
+        # @return [Hash]
         def remote_options
           { mode: :board }
         end
 
+        # @return [Hash]
         def all
           {
             endpoint: :boards_all,
@@ -31,6 +33,7 @@ module Troo
           }
         end
 
+        # @return [Hash]
         def by_board_id
           {
             endpoint: :board_by_id,
@@ -43,14 +46,17 @@ module Troo
         end
       end
 
+      # @return [Hash]
       def associations
         [:lists, :cards, :members]
       end
 
+      # @return []
       def local_model
         Troo::Board
       end
 
+      # @return [Hash]
       def adapted
         {
           external_id: id,

data/lib/troo/remote/card.rb

@@ -27,10 +27,12 @@ module Troo
       attribute :actions,               Array[Troo::Remote::Comment]
 
       class << self
+        # @return [Hash]
         def remote_options
           { mode: :card }
         end
 
+        # @return [Hash]
         def by_board_id
           {
             endpoint: :cards_by_board_id,
@@ -38,6 +40,7 @@ module Troo
           }
         end
 
+        # @return [Hash]
         def by_list_id
           {
             endpoint: :cards_by_list_id,
@@ -45,6 +48,7 @@ module Troo
           }
         end
 
+        # @return [Hash]
         def by_card_id
           {
             endpoint: :card_by_id,
@@ -53,14 +57,17 @@ module Troo
         end
       end
 
+      # @return [Array]
       def associations
         [:actions]
       end
 
+      # @return []
       def local_model
         Troo::Card
       end
 
+      # @return [Hash]
       def adapted
         {
           short_id:            idShort,

data/lib/troo/remote/comment.rb

@@ -12,10 +12,12 @@ module Troo
       attribute :memberCreator,   Troo::Remote::Member
 
       class << self
+        # @return [Hash]
         def remote_options
           { mode: :card }
         end
 
+        # @return [Hash]
         def by_board_id
           {
             endpoint: :comments_by_board_id,
@@ -23,6 +25,7 @@ module Troo
           }
         end
 
+        # @return [Hash]
         def by_card_id
           {
             endpoint: :comments_by_card_id,
@@ -31,30 +34,37 @@ module Troo
         end
       end
 
+      # @return []
       def external_board_id
         data.board.id
       end
 
+      # @return []
       def external_card_id
         data.card.id
       end
 
+      # @return []
       def external_comment_id
         id
       end
 
+      # @return []
       def text
         data.text
       end
 
+      # @return [Array]
       def associations
         [:memberCreator]
       end
 
+      # @return []
       def local_model
         Troo::Comment
       end
 
+      # @return [Hash]
       def adapted
         {
           external_id:        id,

data/lib/troo/remote/list.rb

@@ -11,10 +11,12 @@ module Troo
       attribute :pos,     Integer
 
       class << self
+        # @return [Hash]
         def remote_options
           { mode: :list }
         end
 
+        # @return [Hash]
         def by_board_id
           {
             endpoint: :lists_by_board_id,
@@ -22,19 +24,23 @@ module Troo
           }
         end
 
+        # @return [Hash]
         def by_list_id
           { endpoint: :list_by_id }
         end
       end
 
+      # @return [Array]
       def associations
         []
       end
 
+      # @return []
       def local_model
         Troo::List
       end
 
+      # @return [Hash]
       def adapted
         {
           external_board_id: idBoard,

data/lib/troo/remote/member.rb

@@ -34,10 +34,12 @@ module Troo
       attribute :premiumFeatures
 
       class << self
+        # @return [Hash]
         def remote_options
           { mode: :member }
         end
 
+        # @return [Hash]
         def by_board_id
           {
             endpoint: :members_by_board_id,
@@ -45,19 +47,23 @@ module Troo
           }
         end
 
+        # @return [Hash]
         def by_member_id
           { endpoint: :member_by_id }
         end
       end
 
+      # @return [Array]
       def associations
         []
       end
 
+      # @return []
       def local_model
         Troo::Member
       end
 
+      # @return [Hash]
       def adapted
         {
           external_id: id,