nin 0.0.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5037bc8929225d80c4ffda217726c83a054c9a0c2d7c40d18b95b749248044
-  data.tar.gz: 1a85efacd7a65c1df2d3da69faa058a430d898d6c30e7b0c401473a1d6a0cba8
+  metadata.gz: e69e3a795983376ba5be5fd6bd9b639dcb8856cf11585e52cb2493b701e98ab4
+  data.tar.gz: 4e3662bb0d5e87243eb78d20619e5a33904c586e158a3e4fa067ebd098e6e0d1
 SHA512:
-  metadata.gz: 8cd7d778fd4a06352be726ad2b2dae3b032d76d4c33db113d23f5d8e5f7527aca9e4e552d9f3200655839739064bade40dcfbc7fb0325abae69ebf00e6b846ce
-  data.tar.gz: 60196625b942e4034c304aae5ee6856f36dcad94aff28ccb6153baf4beba30095f393fcf1800eb78dfd42da3545c1a62ae7a12fe85787666d25b9af1db3e1cc4
+  metadata.gz: 72afcf6252cd03732ebd9b1e03d9eb0fc209aaf22edc1de4760be1a0d5e89ee2cf01210dd915cd0cb01d3d23700552e45e7de9738ebcd76b86b196d432a416e7
+  data.tar.gz: f6850697bc332effae708dcee96ef0b1f0812e8e254c8a9f7ad5bb3da57f35db6188c0d739dfb386be4dc03e1529d5ff7538051f69044210f9bf09cf0f311c8a

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.byebug_history

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+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/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,67 @@
+nin
+---
+
+A simple, full-featured command line todo app
+
+![nin demo GIF](/demo.gif)
+
+## Features
+
+- Simple, easy-to-use CLI
+- Currently supports: listing, adding, editing, deleting, completing,
+  archiving, and deleting archived todo items
+- Smart colored output
+- Modular code covered by unit tests
+- Uses YAML for storage by default
+
+## Installation
+
+```bash
+gem install nin
+```
+
+To run the tests:
+
+```console
+rake
+```
+
+## Usage
+
+```console
+NAME:
+        nin - a simple, full-featured command line todo app
+
+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
+```
+
+## 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 found a bug or want to add a new feature,
+open an issue or send a pull request.
+
+## License
+
+See [LICENSE](https://github.com/aonemd/nin/blob/master/LICENSE).

data/Rakefile

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

data/bin/nin

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/nin'
+
+begin
+  Nin::Command.new(ARGV[0], ARGV[1..-1]).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,16 @@
-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
-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 'psych'
+require 'toml-rb'
+require 'chronic'
+require 'colored2'
+require 'date'
+require 'readline'
+
+require_relative 'nin/version'
+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/command'

data/lib/nin/command.rb

@@ -0,0 +1,76 @@
+module Nin
+  class Command
+    COMMANDS_WITH_ARGS = %w(a e c ac d)
+
+    def initialize(command, args)
+      @command = command
+      @args    = args
+      @todo    = Todo.new(YamlStore.new, collect_options)
+
+      validate_args
+    end
+
+    def call
+      case @command
+      when 'l'
+        @todo.list
+      when 'a'
+        desc, date, tags = Parser.new(@args.join(' ')).call
+        @todo.add(desc, date, tags)
+      when 'e'
+        desc, date, tags = Parser.new(@args[1..-1].join(' ')).call
+        @todo.edit(@args[0].to_i, desc, date, tags)
+      when 'c'
+        @todo.complete(*@args)
+      when 'ac'
+        @todo.archive(*@args)
+      when 'd'
+        @todo.delete(*@args)
+      when 'gc'
+        @todo.delete_archived
+      when 'o'
+        system("`echo $EDITOR` #{@todo.store.file}")
+      when 'i'
+        run_interactive_mode
+      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"
+      end
+    end
+
+    private
+
+    def collect_options
+      options = { archived: false }
+
+      if @command == 'l' && @args[0] == 'a'
+        options[:archived] = true
+      end
+
+      options
+    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,4 @@
+module Nin
+  class ItemNotFoundError < StandardError; end
+  class EmptyCommandArgumentError < StandardError; end
+end

data/lib/nin/item.rb

@@ -0,0 +1,60 @@
+module Nin
+  class Item
+    attr_accessor :id, :desc, :date, :tags, :completed, :archived
+
+    def initialize(id,
+                   desc,
+                   date = nil,
+                   tags = [],
+                   completed = false,
+                   archived = false,
+                   formatter = ItemPresenter)
+
+      @id        = id
+      @desc      = desc
+      self.date  = date # this looks ugly
+      @tags      = tags
+      @completed = completed
+      @archived  = archived
+      @formatter = formatter.new(self)
+    end
+
+    def date=(date = nil)
+      @date = date || Date.today.to_s
+    end
+
+    def toggle_completed!
+      @completed = !@completed
+    end
+
+    def toggle_archived!
+      @archived = !@archived
+    end
+
+    def to_s
+      @formatter.call
+    end
+
+    def to_h
+      {
+        'id' => id,
+        'desc' => desc,
+        'tags' => tags,
+        'completed' => completed,
+        'archived'  => archived
+      }
+    end
+
+    def completed?
+      @completed
+    end
+
+    def archived?
+      @archived
+    end
+
+    def due?
+      @date < Date.today.to_s
+    end
+  end
+end

data/lib/nin/item_presenter.rb

@@ -0,0 +1,49 @@
+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/parser.rb

@@ -0,0 +1,41 @@
+module Nin
+  class Parser
+    def initialize(desc)
+      @desc = desc
+      @date = extract_date
+      @tags = extract_tags
+    end
+
+    def call
+      [@desc, @date, @tags]
+    end
+
+    private
+
+    def extract_date
+      date_pattern = /@[A-Z0-9.,-]+/i
+      date         = @desc.scan(date_pattern).last
+
+      return nil if date.nil?
+
+      date.gsub!('@', '')
+      strip_tags(date_pattern)
+
+      Chronic.parse(date).strftime('%Y-%m-%d')
+    end
+
+    def extract_tags
+      tag_pattern = /#[A-Z0-9_]+/i
+      tags        = @desc.scan(tag_pattern).map { |tag| tag.gsub!('#', '') }
+
+      strip_tags(tag_pattern)
+
+      tags
+    end
+
+    def strip_tags(pattern)
+      @desc.gsub!(pattern, '')
+      @desc.strip!
+    end
+  end
+end

data/lib/nin/todo.rb

@@ -0,0 +1,130 @@
+module Nin
+  class Todo
+    attr_accessor :items
+    attr_reader :store
+
+    def initialize(store = YamlStore.new, options = {})
+      @store   = store
+      @options = options
+      @items   = load_items.sort_by(&:date)
+    end
+
+    def list
+      if @options[:archived]
+        @items
+      else
+        unarchived_items
+      end.each do |item|
+        puts item
+      end
+    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
+      @store.write(to_hash)
+    end
+
+    def complete(*ids)
+      ids.each do |id|
+        item = find_by_id(id.to_i)
+        item.toggle_completed!
+      end
+
+      @store.write(to_hash)
+    end
+
+    def archive(*ids)
+      ids.each do |id|
+        item = find_by_id(id.to_i)
+        item.toggle_archived!
+      end
+
+      @store.write(to_hash)
+    end
+
+    def delete_archived
+      delete(*archived_items.map(&:id))
+      reset_item_indices!
+    end
+
+    def delete(*ids)
+      ids.each do |id|
+        item = find_by_id(id.to_i)
+        @items.delete(item)
+      end
+
+      reset_item_indices!
+    end
+
+    private
+
+    def load_items
+      items = []
+      @store.read.map do |key, values|
+        date = key.dup
+        values.map do |item|
+          items << Item.new(item.fetch('id').to_i,
+                            item.fetch('desc'),
+                            date,
+                            item.fetch('tags'),
+                            item.fetch('completed'),
+                            item.fetch('archived')
+                           )
+        end
+      end
+
+      items
+    end
+
+    def to_hash
+      @items.group_by(&:date).reduce({}) do |hash, (key, values)|
+        hash[key] = values.map(&:to_h)
+        hash
+      end
+    end
+
+    def next_id
+      last_id + 1
+    end
+
+    def last_id
+      begin
+        @items.sort_by(&:id).last.id
+      rescue NoMethodError
+        0
+      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
+      end
+
+      @store.write(to_hash)
+    end
+  end
+end

data/lib/nin/toml_store.rb

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

data/lib/nin/version.rb

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

data/lib/nin/yaml_store.rb

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

data/nin.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+require File.expand_path('../lib/nin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors     = ["Ahmed Saleh"]
+  gem.email       = 'aonemdsaleh@gmail.com'
+  gem.description = "A simple, full-featured command line todo app"
+  gem.summary     = "A command line todo app that provides an easy to use CLI for everyday todo management"
+  gem.homepage    = 'https://github.com/aonemd/nin'
+
+  gem.files         = `git ls-files`.split($\).reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables   = ["nin"]
+
+  gem.name    = 'nin'
+  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 'minitest'
+end

metadata

@@ -1,23 +1,112 @@
 --- !ruby/object:Gem::Specification
 name: nin
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ahmed Saleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
-dependencies: []
-description: Under construction
+date: 2018-12-24 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
+    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: colored2
+  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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple, full-featured command line todo app
 email: aonemdsaleh@gmail.com
-executables: []
+executables:
+- nin
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/nin
+- demo.gif
 - lib/nin.rb
-homepage: https://github.com/gems/nin
+- lib/nin/command.rb
+- lib/nin/error.rb
+- lib/nin/item.rb
+- lib/nin/item_presenter.rb
+- lib/nin/parser.rb
+- lib/nin/todo.rb
+- lib/nin/toml_store.rb
+- lib/nin/version.rb
+- lib/nin/yaml_store.rb
+- nin.gemspec
+homepage: https://github.com/aonemd/nin
 licenses:
 - MIT
 metadata: {}
@@ -40,5 +129,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Under construction
+summary: A command line todo app that provides an easy to use CLI for everyday todo
+  management
 test_files: []