troo 0.0.10 → 0.0.11

data/lib/troo/helpers/model_helpers.rb

@@ -1,34 +1,47 @@
 module Troo
   module ModelHelpers
     module ClassMethods
+      # @param  [Hash]
+      # @return [Ohm::Model]
       def first(criteria = {})
         return all.first if criteria.nil? || criteria.empty?
         find(criteria).first
       end
 
+      # @param  [Hash]
+      # @return [TrueClass]
       def update(criteria = {})
         return false if criteria.nil? || criteria.empty?
         all.map { |record| record.update(criteria) }
         true
       end
 
+      # @return [Ohm::Model]
       def default
         first(default: true)
       end
 
+      # @return [TrueClass, FalseClass]
       def default?
         !!(default)
       end
 
+      # @param  [Hash]
+      # @return [Integer]
       def count(criteria = {})
         return all.count if criteria.empty?
         find(criteria).size
       end
 
+      # @param  [String]
+      # @return [Ohm::Model]
       def by_external_id(id)
         first(external_id: id)
       end
 
+      # @param  [String, NilClass]
+      # @param  [Hash]
+      # @return [Ohm::Model]
       def retrieve(id = nil, options = {})
         Troo::Retrieval::Local.retrieve(self, id, options)
       end

data/lib/troo/helpers/remote_model_helpers.rb

@@ -1,32 +1,40 @@
 module Troo
   module RemoteModelHelpers
     module ClassMethods
+      # @param  [Array]
+      # @return [Array]
       def with_collection(resources = [])
         resources.map { |resource| new(resource) }
       end
 
+      # @return [Hash]
       def all
         {}
       end
 
+      # @return [Hash]
       def by_board_id
         {}
       end
 
+      # @return [Hash]
       def by_list_id
         {}
       end
 
+      # @return [Hash]
       def by_card_id
         {}
       end
 
+      # @return [Hash]
       def by_member_id
         {}
       end
     end
 
     module InstanceMethods
+      # @return []
       def preprocess
         associations.map do |association|
           associated(association).map { |record| record.preprocess }
@@ -35,6 +43,7 @@ module Troo
         Persistence::Local.persist(self)
       end
 
+      # @return [Ohm::Model]
       def local
         @local ||= local_model.by_external_id(id)
       end

data/lib/troo/launcher.rb

@@ -0,0 +1,44 @@
+module Troo
+  class Launcher
+    # @param  [Array]
+    # @param  []
+    # @param  []
+    # @param  []
+    # @param  []
+    # @return []
+    def initialize(argv, stdin = STDIN,
+                         stdout = STDOUT,
+                         stderr = STDERR,
+                         kernel = Kernel)
+      @argv = argv
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @kernel = kernel
+    end
+
+    # @return []
+    def execute!
+      $stdin, $stdout, $stderr = @stdin, @stdout, @stderr
+      pad { Troo::CLI::Main.start(@argv) }
+      @kernel.exit(0)
+    rescue Errno::ENOENT
+      pad { puts "Configuration cannot be found, please run 'troo init'" \
+                 " first." }
+      @kernel.exit(1)
+    rescue Redis::CannotConnectError
+      pad { puts 'Cannot connect to Redis database.' }
+      @kernel.exit(1)
+    ensure
+      $stdin, $stdout, $stderr = STDIN, STDOUT, STDERR
+    end
+
+    private
+
+    def pad
+      puts
+      yield
+      puts
+    end
+  end
+end

data/lib/troo/models/behaviours/set_default.rb

@@ -1,6 +1,7 @@
 module Troo
   module Behaviours
     class NullEntity
+      # @return [FalseClass]
       def default?
         false
       end
@@ -8,15 +9,20 @@ module Troo
 
     class SetDefault
       class << self
+        # @param  []
+        # @return []
         def for(entity)
           new(entity).set_default!
         end
       end
 
+      # @param  []
+      # @return []
       def initialize(entity)
         @entity = entity
       end
 
+      # @return [TrueClass, ?]
       def set_default!
         return true if already_default?
         unset_default

data/lib/troo/models/board.rb

@@ -17,31 +17,40 @@ module Troo
     alias_method :default?,    :default
 
     class << self
+      # @return [Remote::Board]
       def remote
         Remote::Board
       end
 
+      # @return [Symbol]
       def type
         :board
       end
     end
 
+    # @return [Ohm::Set]
     def lists
       Troo::List.find(external_board_id: external_id)
     end
 
+    # @return [Ohm::Set]
     def cards
       Troo::Card.find(external_board_id: external_id)
     end
 
+    # @param  [Hash]
+    # @return []
     def decorator(options = {})
       Decorators::Resource.new(self, options)
     end
 
+    # @param  [Hash]
+    # @return [Troo::Presenters::Board]
     def presenter(options = {})
       Presenters::Board.new(self, options)
     end
 
+    # @return [Symbol]
     def type
       self.class.type
     end

data/lib/troo/models/card.rb

@@ -26,15 +26,18 @@ module Troo
     alias_method :description, :desc
 
     class << self
+      # @return [Remote::Card]
       def remote
         Remote::Card
       end
 
+      # @return [Symbol]
       def type
         :card
       end
     end
 
+    # @return [Array, Array, String]
     def external_member_ids
       if @attributes[:external_member_ids].nil?
         []
@@ -45,22 +48,27 @@ module Troo
       end
     end
 
+    # @return []
     def board
       @board ||= Troo::Board.retrieve(external_board_id)
     end
 
+    # @return []
     def list
       @list ||= Troo::List.retrieve(external_list_id)
     end
 
+    # @return [Ohm::Set]
     def comments
       Troo::Comment.find(external_card_id: external_id)
     end
 
+    # @return []
     def recent_comments
       comments.sort(by: :date, limit: [0, 3])
     end
 
+    # @return []
     def members
       return [] if external_member_ids.empty?
       @members ||= external_member_ids.map do |member_id|
@@ -68,18 +76,25 @@ module Troo
       end.compact
     end
 
+    # @param  [Hash]
+    # @return []
     def decorator(options = {})
       Decorators::Resource.new(self, options)
     end
 
+    # @param  [Hash]
+    # @return [Troo::Presenters::Card]
     def presenter(options = {})
       Presenters::Card.new(self, options)
     end
 
+    # @param  [Hash]
+    # @return []
     def comment_presenter(options = {})
       Presenters::Comment.new(self, options)
     end
 
+    # @return [Symbol]
     def type
       self.class.type
     end

data/lib/troo/models/comment.rb

@@ -19,35 +19,44 @@ module Troo
     index :short_id
 
     class << self
+      # @return [Remote::Comment]
       def remote
         Remote::Comment
       end
 
+      # @return [Symbol]
       def type
         :comments
       end
     end
 
+    # @return []
     def board
       Troo::Board.retrieve(external_board_id)
     end
 
+    # @return []
     def card
       Troo::Card.retrieve(external_card_id)
     end
 
+    # @return []
     def member
       Troo::Member.retrieve(external_member_id)
     end
 
+    # @param  [Hash]
+    # @return []
     def decorator(options = {})
       Decorators::Resource.new(self, options)
     end
 
+    # @return [FalseClass]
     def default?
       false
     end
 
+    # @return [Symbol]
     def type
       self.class.type
     end

data/lib/troo/models/list.rb

@@ -19,31 +19,40 @@ module Troo
     alias_method :default?,    :default
 
     class << self
+      # @return [Remote::List]
       def remote
         Remote::List
       end
 
+      # @return [Symbol]
       def type
         :list
       end
     end
 
+    # @return []
     def board
       Troo::Board.retrieve(external_board_id)
     end
 
+    # @return [Ohm::Set]
     def cards
       Troo::Card.find(external_list_id: external_id)
     end
 
+    # @param  [Hash]
+    # @return []
     def decorator(options = {})
       Decorators::Resource.new(self, options)
     end
 
+    # @param  [Hash]
+    # @return [Troo::Presenters::List]
     def presenter(options = {})
       Presenters::List.new(self, options)
     end
 
+    # @return [Symbol]
     def type
       self.class.type
     end

data/lib/troo/models/member.rb

@@ -17,27 +17,35 @@ module Troo
     index :short_id
 
     class << self
+      # @return []
       def remote
         Remote::Member
       end
 
+      # @return [Symbol]
       def type
         :member
       end
     end
 
+    # @param  [Hash]
+    # @return []
     def decorator(options = {})
       Decorators::Member.new(self, options)
     end
 
+    # @param  [Hash]
+    # @return []
     def presenter(options = {})
       Presenters::Member.new(decorator, options)
     end
 
+    # @return [FalseClass]
     def default?
       false
     end
 
+    # @return [Symbol]
     def type
       self.class.type
     end

data/lib/troo/models/refresh.rb

@@ -8,11 +8,13 @@ module Troo
     index :last_performed_at
 
     class << self
+      # @return []
       def completed!
         all.map { |record| record.delete }
         create(last_performed_at: Time.now.to_s)
       end
 
+      # @return []
       def last_performed_at
         first ? first.last_performed_at : nil
       end

data/lib/troo/options.rb

@@ -0,0 +1,9 @@
+module Troo
+  class Options
+    include Virtus.value_object
+
+    values do
+      attribute :mode
+    end
+  end
+end

data/lib/troo/persistence/local.rb

@@ -2,25 +2,33 @@ module Troo
   module Persistence
     class Local
       class << self
+        # @param  [Array]
+        # @return [Array]
         def with_collection(resources = [])
           resources.map do |resource|
             new(resource).preprocess
           end
         end
 
+        # @param  []
+        # @return []
         def persist(resource)
           new(resource).persist
         end
       end
 
+      # @param  []
+      # @return [Troo::Persistence::Local]
       def initialize(resource)
         @resource = resource
       end
 
+      # @return []
       def preprocess
         resource.preprocess
       end
 
+      # @return []
       def persist
         set_default
         delete