nin 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e69e3a795983376ba5be5fd6bd9b639dcb8856cf11585e52cb2493b701e98ab4
-  data.tar.gz: 4e3662bb0d5e87243eb78d20619e5a33904c586e158a3e4fa067ebd098e6e0d1
+  metadata.gz: 3861707860a4a5fabaf36726dee7e0e96d806bcfb3186f8d89e20fb31ace4e8e
+  data.tar.gz: e4a55a32155286f7e06064795d77b2611a17e6c4a6534f850ea1e1798f5002d1
 SHA512:
-  metadata.gz: 72afcf6252cd03732ebd9b1e03d9eb0fc209aaf22edc1de4760be1a0d5e89ee2cf01210dd915cd0cb01d3d23700552e45e7de9738ebcd76b86b196d432a416e7
-  data.tar.gz: f6850697bc332effae708dcee96ef0b1f0812e8e254c8a9f7ad5bb3da57f35db6188c0d739dfb386be4dc03e1529d5ff7538051f69044210f9bf09cf0f311c8a
+  metadata.gz: 754a8cc8c7a0a503f1feec3a46d725fefc793cbc41514f592e4c8bdcccec14d87926d11b0833abb44e5afe69ab141f30681b6d653008dfaca28f12bef70d2ac7
+  data.tar.gz: 3923c3a626568dc5f20478c6235c98305dda0ac7536618f65337d7a9123c7ec8148d70dedc58e393638e651bbfee0e05ff66edef2f495d9657df9933ecdb1788

data/.gitignore

@@ -1,2 +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

@@ -3,3 +3,7 @@ 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/README.md

@@ -1,9 +1,14 @@
-nin
----
+<div align="center">
+  <h1>
+    nin
+  </h1>
 
-A simple, full-featured command line todo app
+  A simple, full-featured command line todo app
 
-![nin demo GIF](/demo.gif)
+  ![nin demo GIF](/demo.gif)
+</div>
+
+[![Build Status](https://travis-ci.com/aonemd/nin.svg?branch=master)](https://travis-ci.com/aonemd/nin)
 
 ## Features
 
@@ -11,8 +16,8 @@ A simple, full-featured command line todo app
 - Currently supports: listing, adding, editing, deleting, completing,
   archiving, and deleting archived todo items
 - Smart colored output
+- Uses YAML for storage by default (There's an option to use TOML but no configuration for it, yet)
 - Modular code covered by unit tests
-- Uses YAML for storage by default
 
 ## Installation
 
@@ -36,14 +41,17 @@ USAGE:
         nin COMMAND [arguments...]
 
 COMMANDS:
-        l  [a]         List all unarchived todos. Pass optional argument `a` to list all todos
-        a  desc        Add a todo. Prepend due date by an @. Prepend tag by a \#
-        e  id desc     Edit a todo. Prepend due date by an @. Prepend tag by a \#
-        c  id(s)       Un/complete todo(s)
-        ac id(s)       Un/archive todo(s)
-        d  id(s)       Delete todo(s)
-        gc             Delete all archived todos. Resets item ids as a side effect
-        o              Open todo file in $EDITOR
+        l  | list          [a]        List all unarchived todos. Pass optional argument `a` to list all todos
+        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)      Un/archive todo(s)
+        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
 ```
 
 ## Why

data/lib/nin.rb

@@ -1,16 +1,20 @@
 require 'psych'
-require 'toml-rb'
 require 'chronic'
 require 'colored2'
 require 'date'
+require 'delegate'
 require 'readline'
 
 require_relative 'nin/version'
+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/toml_store'
 require_relative 'nin/parser'
-require_relative 'nin/item_presenter'
 require_relative 'nin/item'
 require_relative 'nin/todo'
+require_relative 'nin/presenters/item_presenter'
+require_relative 'nin/presenters/todo_presenter'
 require_relative 'nin/command'

data/lib/nin/command.rb

@@ -12,38 +12,45 @@ module Nin
 
     def call
       case @command
-      when 'l'
+      when 'l', 'list'
         @todo.list
-      when 'a'
+      when 'a', 'add'
         desc, date, tags = Parser.new(@args.join(' ')).call
         @todo.add(desc, date, tags)
-      when 'e'
+      when 'e', 'edit'
         desc, date, tags = Parser.new(@args[1..-1].join(' ')).call
         @todo.edit(@args[0].to_i, desc, date, tags)
-      when 'c'
+      when 'p', 'prioritize'
+        @todo.prioritize(@args[0].to_i, @args[1].to_i)
+      when 'c', 'complete'
         @todo.complete(*@args)
-      when 'ac'
+      when 'ac', 'archive'
         @todo.archive(*@args)
-      when 'd'
+      when 'd', 'delete'
         @todo.delete(*@args)
-      when 'gc'
+      when 'gc', 'garbage'
         @todo.delete_archived
-      when 'o'
-        system("`echo $EDITOR` #{@todo.store.file}")
-      when 'i'
+      when 's', 'analyze'
+        @todo.analyze
+      when 'i', 'repl'
         run_interactive_mode
+      when 'o', 'open'
+        system("`echo $EDITOR` #{@todo.store.file}")
       else
         puts "NAME:\n\tnin - a simple, full-featured command line todo app"
         puts "\nUSAGE:\n\tnin COMMAND [arguments...]"
         puts "\nCOMMANDS:"
-        puts "\tl  [a]         List all unarchived todos. Pass optional argument `a` to list all todos"
-        puts "\ta  desc        Add a todo. Prepend due date by a @. Prepend each tag by a \\#"
-        puts "\te  id desc     Edit a todo. Prepend due date by a @. Prepend each tag by a \\#"
-        puts "\tc  id(s)       Un/complete todo(s)"
-        puts "\tac id(s)       Un/archive todo(s)"
-        puts "\td  id(s)       Delete todo(s)"
-        puts "\tgc             Delete all archived todos. Resets item ids as a side effect"
-        puts "\to              Open todo file in $EDITOR"
+        puts "\tl  | list          [a]        List all unarchived todos. Pass optional argument `a` to list all todos"
+        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)      Un/archive todo(s)"
+        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"
       end
     end
 

data/lib/nin/extensions/array_extensions.rb

@@ -0,0 +1,37 @@
+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
+end

data/lib/nin/extensions/date_extensions.rb

@@ -0,0 +1,20 @@
+class Date
+  def self.parse_or_return(unparsed_date)
+    return unparsed_date unless unparsed_date.is_a?(String)
+
+    Date.parse(unparsed_date)
+  end
+
+  def humanize
+    case self
+    when Date.today.prev_day
+      'yesterday'
+    when Date.today
+      'today'
+    when Date.today.succ
+      'tomorrow'
+    else
+      self.to_s
+    end
+  end
+end

data/lib/nin/extensions/integer_extensions.rb

@@ -0,0 +1,5 @@
+class Integer
+  def length
+    Math.log10(self).to_i + 1
+  end
+end

data/lib/nin/extensions/string_extensions.rb

@@ -0,0 +1,5 @@
+class String
+  def remove_color
+    self.gsub(/\e\[([;\d]+)?m/, '')
+  end
+end

data/lib/nin/item.rb

@@ -4,23 +4,25 @@ module Nin
 
     def initialize(id,
                    desc,
-                   date = nil,
+                   date = Date.today,
                    tags = [],
                    completed = false,
                    archived = false,
-                   formatter = ItemPresenter)
+                   formatter = Presenter::ItemPresenter)
 
       @id        = id
       @desc      = desc
-      self.date  = date # this looks ugly
+      @date      = Date.parse_or_return(date) || Date.today
       @tags      = tags
       @completed = completed
       @archived  = archived
       @formatter = formatter.new(self)
     end
 
-    def date=(date = nil)
-      @date = date || Date.today.to_s
+    def edit(desc, date = nil, tags = [])
+      self.desc = desc
+      self.date = date unless date.nil?
+      self.tags.concat(tags)
     end
 
     def toggle_completed!
@@ -31,6 +33,22 @@ module Nin
       @archived = !@archived
     end
 
+    def completed?
+      @completed
+    end
+
+    def archived?
+      @archived
+    end
+
+    def past?
+      @date < Date.today
+    end
+
+    def today?
+      @date == Date.today
+    end
+
     def to_s
       @formatter.call
     end
@@ -41,20 +59,8 @@ module Nin
         'desc' => desc,
         'tags' => tags,
         'completed' => completed,
-        'archived'  => archived
+        'archived' => archived
       }
     end
-
-    def completed?
-      @completed
-    end
-
-    def archived?
-      @archived
-    end
-
-    def due?
-      @date < Date.today.to_s
-    end
   end
 end

data/lib/nin/presenters/item_presenter.rb

@@ -0,0 +1,53 @@
+module Nin
+  module Presenter
+    class ItemPresenter < ::SimpleDelegator
+      def call(options = {})
+        _id, _completed, _date, _desc, _tags = id, completed, date, desc, tags
+
+        separating_spaces = options.fetch(:separating_spaces, 2)
+        id_spaces         = options.fetch(:longest_id, 1) + separating_spaces
+        completed_spaces  = _completed.length + separating_spaces
+        date_spaces       = _date.length + (options.fetch(:longest_date, 11) - _date.remove_color.length) + separating_spaces
+
+        sprintf("%-#{id_spaces}d %-#{completed_spaces}s %-#{date_spaces}s %s %s",
+                _id, _completed, _date, _desc, _tags)
+      end
+
+      private
+
+      def desc
+        if self.archived?
+          self.desc.yellow
+        elsif self.completed?
+          self.desc.white
+        else
+          self.desc
+        end
+      end
+
+      def completed
+        if self.completed?
+          '[x]'.green
+        else
+          '[ ]'
+        end
+      end
+
+      def date
+        date_in_words = '@' << self.date.humanize
+
+        if self.past?
+          date_in_words.magenta
+        elsif self.today?
+          date_in_words.bold.cyan
+        else
+          date_in_words.cyan
+        end
+      end
+
+      def tags
+        self.tags.map { |tag| tag.dup.prepend('#') }.join(' ').blue
+      end
+    end
+  end
+end

data/lib/nin/presenters/todo_presenter.rb

@@ -0,0 +1,15 @@
+module Nin
+  module Presenter
+    class TodoPresenter < ::SimpleDelegator
+      def call
+        formatting_options = { separating_spaces: 4,
+                               longest_id: self.map(&:id).max.length,
+                               longest_date: 11 }
+
+        self.map do |item|
+          Presenter::ItemPresenter.new(item).call(formatting_options)
+        end
+      end
+    end
+  end
+end

data/lib/nin/todo.rb

@@ -6,29 +6,47 @@ module Nin
     def initialize(store = YamlStore.new, options = {})
       @store   = store
       @options = options
-      @items   = load_items.sort_by(&:date)
+      @items   = load_items_sorted
     end
 
     def list
-      if @options[:archived]
-        @items
-      else
-        unarchived_items
-      end.each do |item|
-        puts item
-      end
+      items_to_list = if @options[:archived]
+                        @items
+                      else
+                        unarchived_items
+                      end
+
+      puts Presenter::TodoPresenter.new(items_to_list).call
     end
 
     def add(desc, date, tags)
       @items << Item.new(next_id, desc, date, tags)
+
       @store.write(to_hash)
     end
 
     def edit(id, desc, date, tags)
-      item      = find_by_id(id)
-      item.desc = desc
-      item.date = date
-      item.tags = tags
+      item = find_by_id(id)
+
+      item.edit(desc, date, tags)
+
+      @store.write(to_hash)
+    end
+
+    def prioritize(id, step = 1)
+      item_to_prioritize = find_by_id(id)
+      item_group         = @items.group_by(&:date)[item_to_prioritize.date]
+
+      new_id, actual_step = item_group.map(&:id).round_shift(id, step)
+      step_sign           = actual_step > 0 ? +1 : -1
+
+      items_to_reprioritize = item_group.where(:id) do |item_id|
+        step_sign * item_id < step_sign * id
+      end.limit(actual_step)
+
+      item_to_prioritize.id = new_id
+      items_to_reprioritize.each { |item| item.id += step_sign }
+
       @store.write(to_hash)
     end
 
@@ -52,6 +70,7 @@ module Nin
 
     def delete_archived
       delete(*archived_items.map(&:id))
+
       reset_item_indices!
     end
 
@@ -64,8 +83,21 @@ module Nin
       reset_item_indices!
     end
 
+    def analyze
+      items_to_analyze = @items.where(:completed, true)
+
+      histogram = items_to_analyze.group_by(&:date).map { |k, v| [k, v.size] }
+      histogram.each do |date, size|
+        puts "#{date} : #{'*' * size}"
+      end
+    end
+
     private
 
+    def load_items_sorted
+      load_items.sort_by { |item| [item.date, item.id] }
+    end
+
     def load_items
       items = []
       @store.read.map do |key, values|
@@ -76,21 +108,39 @@ module Nin
                             date,
                             item.fetch('tags'),
                             item.fetch('completed'),
-                            item.fetch('archived')
-                           )
+                            item.fetch('archived'))
         end
       end
 
       items
     end
 
+    def archived_items
+      @items.where(:archived?, true)
+    end
+
+    def unarchived_items
+      @items.where(:archived?, false)
+    end
+
+    def find_by_id(id)
+      found_item = @items.find_by(:id, id)
+
+      raise ItemNotFoundError unless found_item
+
+      found_item
+    end
+
     def to_hash
-      @items.group_by(&:date).reduce({}) do |hash, (key, values)|
-        hash[key] = values.map(&:to_h)
-        hash
+      groupped_items.reduce({}) do |hash, (date, items)|
+        hash.update(date => items.map(&:to_h))
       end
     end
 
+    def groupped_items
+      @items.group_by { |item| item.date.to_s }
+    end
+
     def next_id
       last_id + 1
     end
@@ -103,22 +153,6 @@ module Nin
       end
     end
 
-    def find_by_id(id)
-      found_item = @items.find { |item| item.id == id }
-
-      raise ItemNotFoundError unless found_item
-
-      found_item
-    end
-
-    def archived_items
-      @items.select { |item| item.archived? }
-    end
-
-    def unarchived_items
-      @items.select { |item| !item.archived? }
-    end
-
     def reset_item_indices!
       @items.each.with_index(1) do |item, index|
         item.id = index

data/lib/nin/version.rb

@@ -1,3 +1,3 @@
 module Nin
-  VERSION='0.7.0'
+  VERSION='1.0.0'
 end

data/nin.gemspec

@@ -18,10 +18,9 @@ Gem::Specification.new do |gem|
   gem.version = Nin::VERSION
   gem.license = 'MIT'
 
-  gem.add_dependency 'toml-rb'
   gem.add_dependency 'chronic'
   gem.add_dependency 'colored2'
 
-  gem.add_development_dependency 'byebug'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'minitest'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: nin
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ahmed Saleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-24 00:00:00.000000000 Z
+date: 2019-12-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: toml-rb
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,8 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -98,11 +84,15 @@ files:
 - lib/nin.rb
 - lib/nin/command.rb
 - lib/nin/error.rb
+- lib/nin/extensions/array_extensions.rb
+- lib/nin/extensions/date_extensions.rb
+- lib/nin/extensions/integer_extensions.rb
+- lib/nin/extensions/string_extensions.rb
 - lib/nin/item.rb
-- lib/nin/item_presenter.rb
 - lib/nin/parser.rb
+- lib/nin/presenters/item_presenter.rb
+- lib/nin/presenters/todo_presenter.rb
 - lib/nin/todo.rb
-- lib/nin/toml_store.rb
 - lib/nin/version.rb
 - lib/nin/yaml_store.rb
 - nin.gemspec
@@ -125,8 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A command line todo app that provides an easy to use CLI for everyday todo

data/Gemfile.lock

@@ -1,29 +0,0 @@
-PATH
-  remote: .
-  specs:
-    nin (0.6.0)
-      chronic
-      colored2
-      toml-rb
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (10.0.2)
-    chronic (0.10.2)
-    citrus (3.0.2)
-    colored2 (3.1.2)
-    minitest (5.11.3)
-    toml-rb (1.1.2)
-      citrus (~> 3.0, > 3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  minitest
-  nin!
-
-BUNDLED WITH
-   1.17.1

data/lib/nin/item_presenter.rb

@@ -1,49 +0,0 @@
-module Nin
-  class ItemPresenter < SimpleDelegator
-    def call
-      sprintf("%d\t%s\t%s   \t%s %s",
-              id, completed, date, desc, tags).gsub('  ', ' ')
-    end
-
-    private
-
-    def desc
-      if self.archived?
-        self.desc.yellow
-      elsif self.completed?
-        self.desc.white
-      else
-        self.desc
-      end
-    end
-
-    def completed
-      if self.completed?
-        '[x]'.green
-      else
-        '[ ]'
-      end
-    end
-
-    def date
-      case self.date
-      when Date.today.to_s
-        '@today'.bold
-      when Date.today.succ.to_s
-        '@tomorrow'
-      when Date.today.prev_day.to_s
-        '@yesterday'.magenta
-      else
-        if self.due?
-          ('@' << self.date).magenta
-        else
-          '@' << self.date
-        end
-      end.cyan
-    end
-
-    def tags
-      self.tags.map { |tag| tag.dup.prepend('#') }.join(' ').blue
-    end
-  end
-end

data/lib/nin/toml_store.rb

@@ -1,31 +0,0 @@
-module Nin
-  class TomlStore
-    DEFAULT_FILE = "#{ENV['HOME']}/.todos.toml"
-
-    attr_reader :file
-
-    def initialize(file = DEFAULT_FILE)
-      @file = file
-
-      init_store
-    end
-
-    def read
-      TomlRB.load_file(@file)
-    end
-
-    def write(hash)
-      File.open(@file, 'w') do |file|
-        file.write(TomlRB.dump(hash))
-      end
-    end
-
-    private
-
-    def init_store
-      return if File.exist?(@file)
-
-      File.open(@file, "w")
-    end
-  end
-end