nin 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00b4da872337ca4ab8b11be39d559f398f029e617683437dde721bc61dd10517
-  data.tar.gz: 9230fd0f962c4a3a3e6e3ce38059508e404e66deec956406c6147006642463ac
+  metadata.gz: 39f9e7a10bb0b9d4433ec8e048f0f98a86b69c446df00b87f60011ed51656be2
+  data.tar.gz: f531e76fab7c0dee8883f8f05bf4f5b4f2ce8ecd8322203dac43bb4ecb6dd72b
 SHA512:
-  metadata.gz: 8e5591b0e4cd06c15e5248089b87c52d77f4483b033d97eab6c37be16b283314251e556059360a15c8df0cede4cf38757a964d28e49e77f2cdc73e88f80d5873
-  data.tar.gz: 614a0cdd1365036d91019d086c128884fd789bbe4b685539f9e82ab16a142c0b4eea2fed45b8dbfe442efaa5ba526993444411226b502f4991ba09f33dd29069
+  metadata.gz: 36dd67aa3390451a0c127c3fcfa8c053ba8976ce7c24da2c4a822c243dfdb6b5b70a2639e222e0b6378ea4f4bd3e1696a0ebb98025808ec7ff0bf95274852c27
+  data.tar.gz: 56953c2a4da2d7eab114f35fc195a0e9415958737b1dc8133edf658cf1cbe9c4f26ba1f903223ca861457b9da7e3230a2f715c1faace7a4e7a4e2de23e988995

data/README.md

@@ -41,12 +41,13 @@ COMMANDS:
         e  | edit          id desc    Edit a todo. Prepend due date by a @. Prepend each tag by a \#
         p  | prioritize    id step    Prioritize a todo by either a positive or negative step within its date group
         c  | complete      id(s)      Un/complete todo(s)
-        ac | archive       id(s)      Un/archive todo(s)
+        ac | archive       id(s)|c    Un/archive todo(s) or pass `c` to archive all completed items
         d  | delete        id(s)      Delete todo(s)
         gc | garbage                  Delete all archived todos. Resets item ids as a side effect
         s  | analyze                  Analyze tasks and print statistics
         i  | repl                     Open nin in REPL mode
         o  | open                     Open todo file in $EDITOR
+        v  | version                  Print current version of nin
 ```
 
 - Print the usage instructions by calling `nin` without commands or arguments
@@ -80,6 +81,7 @@ COMMANDS:
 For Todoist integration, two environment variables must be set:
   - `NIN_INTEGRATION_CLIENT=todoist`
   - `NIN_INTEGRATION_CLIENT_TOKEN=token`. Token can be found in your [integration settings page](https://todoist.com/prefs/integrations)
+  - `NIN_INTEGRATION_TIMEOUT=interval_in_seconds`. A timeout interval for when the synchronization times out. Defaults to 60 seconds
 
 ## Development
 
@@ -102,8 +104,8 @@ my phone and I needed something more readable.
 
 ## Contribution
 
-Contributions are welcome. If you found a bug or want to add a new feature,
-open an issue or send a pull request.
+Contributions are welcome. If you find a bug or want to add a new feature,
+please open an issue or send a pull request.
 
 ## License
 

data/bin/nin

@@ -3,8 +3,9 @@
 require_relative '../lib/nin'
 
 config = {
-  integrated_client: ENV['NIN_INTEGRATION_CLIENT'],
-  integrated_client_token: ENV['NIN_INTEGRATION_CLIENT_TOKEN']
+  integration_client: ENV['NIN_INTEGRATION_CLIENT'],
+  integration_client_token: ENV['NIN_INTEGRATION_CLIENT_TOKEN'],
+  integration_timeout_interval: ENV['NIN_INTEGRATION_TIMEOUT']
 }
 
 begin

data/lib/nin/command.rb

@@ -37,6 +37,8 @@ module Nin
         run_interactive_mode
       when 'o', 'open'
         system("`echo $EDITOR` #{@todo.store.file}")
+      when 'v', 'version'
+        puts "nin #{Nin::VERSION}"
       else
         puts "NAME:\n\tnin - a simple, full-featured command line todo app"
         puts "\nUSAGE:\n\tnin COMMAND [arguments...]"
@@ -46,12 +48,13 @@ module Nin
         puts "\te  | edit          id desc    Edit a todo. Prepend due date by a @. Prepend each tag by a \\#"
         puts "\tp  | prioritize    id step    Prioritize a todo by either a positive or negative step within its date group"
         puts "\tc  | complete      id(s)      Un/complete todo(s)"
-        puts "\tac | archive       id(s)      Un/archive todo(s)"
+        puts "\tac | archive       id(s)|c    Un/archive todo(s) or pass `c` to archive all completed items"
         puts "\td  | delete        id(s)      Delete todo(s)"
         puts "\tgc | garbage                  Delete all archived todos. Resets item ids as a side effect"
         puts "\ts  | analyze                  Analyze tasks and print statistics"
         puts "\ti  | repl                     Open nin in REPL mode"
         puts "\to  | open                     Open todo file in $EDITOR"
+        puts "\tv  | version                  Print current version of nin"
       end
     end
 
@@ -60,25 +63,28 @@ module Nin
     def collect_config
       config = { store: YamlStore.new }
 
-      _client_name        = @config.fetch(:integrated_client, nil)
-      _client_credentials = @config.fetch(:integrated_client_token, nil)
+      _client_name        = @config.fetch(:integration_client, nil)
+      _client_credentials = @config.fetch(:integration_client_token, nil)
+      _timeout_interval   = @config.fetch(:integration_timeout_interval, 60)
       if _client_name && _client_credentials
         _client_klass       = Object.const_get("Nin::Integration::#{_client_name.capitalize}::Client")
         _synchronizer_klass = Object.const_get("Nin::Integration::Synchronizer::#{_client_name.capitalize}")
 
-        config[:integration_syncrhonizer] = _synchronizer_klass.new(_client_klass.new(_client_credentials))
+        config[:integration_syncrhonizer] = _synchronizer_klass.new(_client_klass.new(_client_credentials), _timeout_interval)
       end
 
       config
     end
 
     def collect_options
-      options = { archived: false, local: false }
+      options = { archived: false, local: false, completed_only: false }
 
       if @command == 'l' && @args[0] == 'a'
         options[:archived] = true
       elsif @command == 'l' && @args[0] == 'l'
         options[:local] = true
+      elsif @command == 'ac' && @args[0] == 'c'
+        options[:completed_only] = true
       end
 
       options

data/lib/nin/integration/synchronizer.rb

@@ -1,8 +1,11 @@
 module Nin
   module Integration
     class Synchronizer
-      def initialize(client)
-        @client = client
+      attr_reader :timeout_interval
+
+      def initialize(client, timeout_interval = nil)
+        @client           = client
+        @timeout_interval = timeout_interval
       end
     end
   end

data/lib/nin/presenters/item_presenter.rb

@@ -2,7 +2,7 @@ module Nin
   module Presenter
     class ItemPresenter < ::SimpleDelegator
       def call(options = {})
-        _id, _completed, _date, _desc, _tags = id, completed, date, desc, tags
+        _id, _completed, _date, _desc, _tags = id, decorate_completed, decorate_date, decorate_desc, decorate_tags
 
         separating_spaces = options.fetch(:separating_spaces, 2)
         id_spaces         = options.fetch(:longest_id, 1) + separating_spaces
@@ -15,7 +15,7 @@ module Nin
 
       private
 
-      def desc
+      def decorate_desc
         if self.archived?
           self.desc.yellow
         elsif self.completed?
@@ -25,7 +25,7 @@ module Nin
         end
       end
 
-      def completed
+      def decorate_completed
         if self.completed?
           '[x]'.green
         else
@@ -33,7 +33,7 @@ module Nin
         end
       end
 
-      def date
+      def decorate_date
         date_in_words = '@' << self.date.humanize
 
         if self.past?
@@ -45,7 +45,7 @@ module Nin
         end
       end
 
-      def tags
+      def decorate_tags
         self.tags.map { |tag| tag.dup.prepend('#') }.join(' ').blue
       end
     end

data/lib/nin/todo.rb

@@ -1,3 +1,5 @@
+require 'timeout'
+
 module Nin
   class Todo
     attr_accessor :items
@@ -71,9 +73,13 @@ module Nin
     end
 
     def archive(*ids)
-      ids.each do |id|
-        item = find_by_id(id.to_i)
-        item.toggle_archived!
+      unless @options[:completed_only]
+        ids.each do |id|
+          item = find_by_id(id.to_i)
+          item.toggle_archived!
+        end
+      else
+        completed_unarchived_items.each(&:toggle_archived!)
       end
 
       @store.write(to_hash)
@@ -108,8 +114,15 @@ module Nin
     def sync(op, store_write = false, params = {})
       return unless @integration_syncrhonizer
 
-      @integration_syncrhonizer.sync(op, params)
-      reset_item_indices! if store_write
+      begin
+        Timeout::timeout(@integration_syncrhonizer.timeout_interval) {
+          @integration_syncrhonizer.sync(op, params)
+          reset_item_indices! if store_write
+        }
+      rescue Timeout::Error
+        puts 'Syncing timed out. Showing local items...'
+        puts
+      end
     end
 
     def fork_sync(op, store_write = false, params = {})
@@ -156,6 +169,10 @@ module Nin
       @items.where(:archived?, false)
     end
 
+    def completed_unarchived_items
+      unarchived_items.where(:completed, true)
+    end
+
     def find_by_id(id)
       found_item = @items.find_by(:id, id)
 

data/lib/nin/version.rb

@@ -1,3 +1,3 @@
 module Nin
-  VERSION='1.2.0'
+  VERSION='1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nin
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Ahmed Saleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-26 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A command line todo app that provides an easy to use CLI for everyday todo