nin 0.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5037bc8929225d80c4ffda217726c83a054c9a0c2d7c40d18b95b749248044
-  data.tar.gz: 1a85efacd7a65c1df2d3da69faa058a430d898d6c30e7b0c401473a1d6a0cba8
+  metadata.gz: 39f9e7a10bb0b9d4433ec8e048f0f98a86b69c446df00b87f60011ed51656be2
+  data.tar.gz: f531e76fab7c0dee8883f8f05bf4f5b4f2ce8ecd8322203dac43bb4ecb6dd72b
 SHA512:
-  metadata.gz: 8cd7d778fd4a06352be726ad2b2dae3b032d76d4c33db113d23f5d8e5f7527aca9e4e552d9f3200655839739064bade40dcfbc7fb0325abae69ebf00e6b846ce
-  data.tar.gz: 60196625b942e4034c304aae5ee6856f36dcad94aff28ccb6153baf4beba30095f393fcf1800eb78dfd42da3545c1a62ae7a12fe85787666d25b9af1db3e1cc4
+  metadata.gz: 36dd67aa3390451a0c127c3fcfa8c053ba8976ce7c24da2c4a822c243dfdb6b5b70a2639e222e0b6378ea4f4bd3e1696a0ebb98025808ec7ff0bf95274852c27
+  data.tar.gz: 56953c2a4da2d7eab114f35fc195a0e9415958737b1dc8133edf658cf1cbe9c4f26ba1f903223ca861457b9da7e3230a2f715c1faace7a4e7a4e2de23e988995

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.byebug_history
+.bundle/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 2.2
+ - 2.5
+ - jruby

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ahmed Saleh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,112 @@
+<div align="center">
+  <h1>
+    nin
+  </h1>
+
+  A simple, full-featured command line todo app
+
+  ![nin demo GIF](/demo.gif)
+</div>
+
+[![Build Status](https://travis-ci.com/aonemd/nin.svg?branch=master)](https://travis-ci.com/aonemd/nin)
+
+## Features
+
+- Simple, intuitive, and easy-to-use CLI
+- Currently supports: listing, adding, editing, deleting, completing,
+  archiving, prioritizing, and analyzing todo items
+- Integration and synchronization with [Todoist](https://todoist.com/) (With potential integration with more platforms)
+- Smart colored output
+- Uses YAML for storage by default (There's the option to add other stores but no configuration for it, yet)
+- Modular code covered by unit tests
+
+## Installation
+
+```bash
+gem install nin
+```
+
+## Usage
+
+```console
+NAME:
+        nin - a simple, full-featured command line todo app
+
+USAGE:
+        nin COMMAND [arguments...]
+
+COMMANDS:
+        l  | list          [a|l]      List all unarchived todos. Pass optional argument `a` to list all todos or `l` to list local todos only
+        a  | add           desc       Add a todo. Prepend due date by a @. Prepend each tag by a \#
+        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)|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
+- Each command has a short and a long name, for example, `l` and `list`
+- You can utilize the power of the CLI by using shell commands and tools to
+  help you do various tasks. For example, run `nin list | grep school` to
+  filter items tagged as school
+- For adding a due date to an item, prefix the date by an `@`. If no date is
+  passed, the default is always the date of the current day
+- For adding tags, you need to prefix a `#` by a `\` (e.g., `\#`) in order for
+  the shell to interpret it as an actual `#`. Please note that you don't need
+  to do this in the REPL mode
+- The `edit` command edits the description of an item. If a date is passed, its
+  date will be updated. If one or more tags are passed, they will be added to
+  that item's tag list
+- Commands `complete`, `archive`, and `delete` can update multiple items at
+  once by passing multiple id's as arguments
+- The `prioritize` command can take a positive or a negative weight as a step
+  to either prioritize the item up or down, respectively. The step is always
+  bound to the smallest and largest id in the current items date group.  For
+  example, passing a 1 as as step prioritizes the item by one item up and
+  passing -2 prioritizes the item by 2 items down
+- REPL (interactive) mode is where you can pass commands and arguments without
+  the need to call `nin` every time and can be triggered by calling `nin i` or
+  `nin repl`
+
+## Integration
+
+### Todoist
+
+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
+
+- Install a recent version of `Ruby` and `Bundler`
+- Run `bundle install` to install the dependencies
+- Run `bundle exec rake` to run the test suite
+- Run `gem build nin.gemspec` to build a new version
+- To push a new version to RubyGems, run `gem push nin-VERSION-NUMBER.gem`
+
+## Why
+
+Why write another todo app? I like to use the terminal for everything and I've
+been using a markdown file to manage my todo list. I looked for something
+simple and I found [Todo.rb](https://gist.github.com/mattsears/1259080) which
+`nin` started as a spinoff from. However, I needed to add some more features. I
+then found [Todolist](http://todolist.site/) which I took some inspiration from
+but kept the CLI as simple as it is in Todo.rb. I also didn't like that
+todolist uses JSON to store the todo items because I wanted to view the file on
+my phone and I needed something more readable.
+
+## Contribution
+
+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
+
+See [LICENSE](https://github.com/aonemd/nin/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+desc "Make a new build and publish it to RubyGems"
+task :publish do
+  build_name_and_version = "nin-#{Nin::VERSION}.gem"
+
+  system "gem build nin.gemspec --silent --output #{build_name_and_version}"
+  system "gem push #{build_name_and_version}"
+end

data/bin/nin

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/nin'
+
+config = {
+  integration_client: ENV['NIN_INTEGRATION_CLIENT'],
+  integration_client_token: ENV['NIN_INTEGRATION_CLIENT_TOKEN'],
+  integration_timeout_interval: ENV['NIN_INTEGRATION_TIMEOUT']
+}
+
+begin
+  Nin::Command.new(ARGV[0], ARGV[1..-1], config).call
+rescue Nin::ItemNotFoundError
+  puts "Todo item does not exist"
+rescue Nin::EmptyCommandArgumentError
+  puts "Command argument cannot be empty\nRun nin to view the USAGE message"
+end

data/lib/nin.rb

@@ -1,59 +1,40 @@
-module Nin
-  class Item
-    attr_accessor :body
-
-    def initialize(desc)
-      @desc = desc
-    end
-
-    def to_s
-      "#{@desc}"
-    end
-  end
-
-  class Todo
-    attr_accessor :items
-
-    def initialize()
-      @items = load_items
-    end
-
-    def list
-    end
-
-    def add(todo)
-    end
-
-    def edit(id)
-    end
-
-    def delete(id)
-    end
-
-    private
-
-    def load_items
-      []
-    end
-  end
+require 'psych'
+require 'date'
+require 'delegate'
+require 'readline'
+require 'securerandom'
+
+require 'chronic'
+require 'colored2'
+require 'http'
+
+if RUBY_PLATFORM =~ /mri|mingw|x66_mingw/i
+  require 'byebug'
 end
 
-if __FILE__ == $0
-  case ARGV[0]
-  when 'l'
-    Nin::Todo.new.list
-  when 'a'
-    Nin::Todo.new.add(ARGV[1])
-  when 'e'
-    Nin::Todo.new.edit(ARGV[1])
-  when 'd'
-    Nin::Todo.new.delete(ARGV[1])
-  else
-    puts "\nUSAGE: nin COMMAND [arguments...]\n\n"
-    puts "COMMANDS:"
-    puts "  l             List all todos"
-    puts "  a desc        Add a todo"
-    puts "  e id          Edit a todo"
-    puts "  d id          Remove a todo"
-  end
-end
+require_relative 'nin/version'
+require_relative 'nin/extensions/object_extensions'
+require_relative 'nin/extensions/nil_class_extensions'
+require_relative 'nin/extensions/array_extensions'
+require_relative 'nin/extensions/array_extensions'
+require_relative 'nin/extensions/string_extensions'
+require_relative 'nin/extensions/integer_extensions'
+require_relative 'nin/extensions/date_extensions'
+require_relative 'nin/error'
+require_relative 'nin/yaml_store'
+require_relative 'nin/parser'
+require_relative 'nin/item'
+require_relative 'nin/presenters/item_presenter'
+require_relative 'nin/presenters/todo_presenter'
+require_relative 'nin/integration/todoist/client'
+require_relative 'nin/integration/todoist/client/base_client'
+require_relative 'nin/integration/todoist/client/sync'
+require_relative 'nin/integration/todoist/client/project'
+require_relative 'nin/integration/todoist/client/item'
+require_relative 'nin/integration/service'
+require_relative 'nin/integration/service/todoist'
+require_relative 'nin/integration/todoist'
+require_relative 'nin/integration/synchronizer'
+require_relative 'nin/integration/synchronizer/todoist'
+require_relative 'nin/todo'
+require_relative 'nin/command'

data/lib/nin/command.rb

@@ -0,0 +1,116 @@
+module Nin
+  class Command
+    COMMANDS_WITH_ARGS = %w(a e c ac d)
+
+    def initialize(command, args, config = {})
+      @command = command
+      @args    = args
+      @config  = config
+      @todo    = Todo.new(collect_config, collect_options)
+
+      validate_args
+    end
+
+    def call
+      case @command
+      when 'l', 'list'
+        @todo.list
+      when 'a', 'add'
+        desc, date, tags = parse_item_desc(@args.join(' '))
+        @todo.add(desc, date, tags)
+      when 'e', 'edit'
+        desc, date, tags = parse_item_desc(@args[1..-1].join(' '))
+        @todo.edit(@args[0].to_i, desc, date, tags)
+      when 'p', 'prioritize'
+        @todo.prioritize(@args[0].to_i, @args[1].to_i)
+      when 'c', 'complete'
+        @todo.complete(*@args)
+      when 'ac', 'archive'
+        @todo.archive(*@args)
+      when 'd', 'delete'
+        @todo.delete(*@args)
+      when 'gc', 'garbage'
+        @todo.delete_archived
+      when 's', 'analyze'
+        @todo.analyze
+      when 'i', 'repl'
+        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...]"
+        puts "\nCOMMANDS:"
+        puts "\tl  | list          [a|l]      List all unarchived todos. Pass optional argument `a` to list all todos or `l` to list local todos only"
+        puts "\ta  | add           desc       Add a todo. Prepend due date by a @. Prepend each tag by a \\#"
+        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)|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
+
+    private
+
+    def collect_config
+      config = { store: YamlStore.new }
+
+      _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), _timeout_interval)
+      end
+
+      config
+    end
+
+    def collect_options
+      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
+    end
+
+    def parse_item_desc(desc)
+      begin
+        Parser.new(desc).call
+      rescue InvalidDateFormatError
+        puts "Invalid date format."
+        exit
+      end
+    end
+
+    def validate_args
+      COMMANDS_WITH_ARGS.each do |command|
+        raise EmptyCommandArgumentError if @command == command && @args.empty?
+      end
+    end
+
+    def run_interactive_mode
+      while line = Readline.readline("nin> ", true)
+        line = line.split(' ')
+
+        Command.new(line[0], line[1..-1]).call
+      end
+    end
+  end
+end

data/lib/nin/error.rb

@@ -0,0 +1,5 @@
+module Nin
+  class ItemNotFoundError < StandardError; end
+  class EmptyCommandArgumentError < StandardError; end
+  class InvalidDateFormatError < StandardError; end
+end

data/lib/nin/extensions/array_extensions.rb

@@ -0,0 +1,41 @@
+class Array
+  def sorted_by?
+    each_cons(2).all? { |a, b| ((yield a) <=> (yield b)) <= 0 }
+  end
+
+  def limit(offset)
+    offset > 0 ? self.last(offset) : self.first(offset.abs)
+  end
+
+  def round_shift(element, step)
+    new_element = [self.min, (element - step), self.max].median
+    actual_step = element - new_element
+
+    [new_element, actual_step]
+  end
+
+  def median
+    return nil if self.empty?
+
+    sorted = self.sort
+    len = self.length
+
+    (sorted[(len - 1) / 2] + sorted[len / 2]) / 2
+  end
+
+  def find_by(key, val)
+    self.where(key, val).first
+  end
+
+  def where(key, val = nil, &block)
+    self.select do |element|
+      key_eval = element.send(key)
+
+      block_given? ? block.call(key_eval) : (key_eval == val)
+    end
+  end
+
+  def ensure_array
+    self.to_a
+  end
+end