nin 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3861707860a4a5fabaf36726dee7e0e96d806bcfb3186f8d89e20fb31ace4e8e
-  data.tar.gz: e4a55a32155286f7e06064795d77b2611a17e6c4a6534f850ea1e1798f5002d1
+  metadata.gz: d8d6d3094654b2846aad88459d296d5f80806095ed1e4c904ffac4de3d0c06d9
+  data.tar.gz: 3f8b51f4d5cbfe4458866bb2cf2298f3ebc953de04b69ac0381fe3ca859ddef4
 SHA512:
-  metadata.gz: 754a8cc8c7a0a503f1feec3a46d725fefc793cbc41514f592e4c8bdcccec14d87926d11b0833abb44e5afe69ab141f30681b6d653008dfaca28f12bef70d2ac7
-  data.tar.gz: 3923c3a626568dc5f20478c6235c98305dda0ac7536618f65337d7a9123c7ec8148d70dedc58e393638e651bbfee0e05ff66edef2f495d9657df9933ecdb1788
+  metadata.gz: a8f6db899bad0219bb28b7ed1d86c6e948b29ca28d4b017106f7ffc379bfefc82794a2dca45e8872468f3be556a31432d5e5b76004b91498239d428f56ae9491
+  data.tar.gz: d81b09f774728f8ec0f1df871b7cab86c3049e8fa372cfea2fda0fa88f812abc276c576fe79f6a621c70c58bee3489d3f9d2d67a650ee8c762251212713a1801

data/README.md

@@ -12,11 +12,11 @@
 
 ## Features
 
-- Simple, easy-to-use CLI
+- Simple, intuitive, and easy-to-use CLI
 - Currently supports: listing, adding, editing, deleting, completing,
-  archiving, and deleting archived todo items
+  archiving, prioritizing, and analyzing todo items
 - Smart colored output
-- Uses YAML for storage by default (There's an option to use TOML but no configuration for it, yet)
+- 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
@@ -25,12 +25,6 @@
 gem install nin
 ```
 
-To run the tests:
-
-```console
-rake
-```
-
 ## Usage
 
 ```console
@@ -54,6 +48,38 @@ COMMANDS:
         o  | open                     Open todo file in $EDITOR
 ```
 
+- 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`
+
+## 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

data/Rakefile

@@ -7,3 +7,10 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+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/lib/nin/presenters/todo_presenter.rb

@@ -2,6 +2,8 @@ module Nin
   module Presenter
     class TodoPresenter < ::SimpleDelegator
       def call
+        return 'No todo items yet. Call `nin add hello world` to add a new item.' if self.empty?
+
         formatting_options = { separating_spaces: 4,
                                longest_id: self.map(&:id).max.length,
                                longest_date: 11 }

data/lib/nin/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ahmed Saleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-01 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic