nikki 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f2b22a3d803a872b060cc4ecfd9dac63c2e67e4
-  data.tar.gz: c9e68b5e9657caa7ab6b886a429e4375460cf2e4
+  metadata.gz: 1d347080dcf01332640b8f3b1cedc21d5d9b8f24
+  data.tar.gz: da6963a943d8dad877f36e2bb92c0f7959dab365
 SHA512:
-  metadata.gz: 15c40d6f5fbd78673cd4a5a7cc3b5c5959e7446a20e0e3f9a81da4f2bb67e13823bdd86132d5cfd8a986df619286226554f5415c47cf7aa2de2a2e11b36ad901
-  data.tar.gz: 3d033d1356c87f9c048ce5fc6a6e08b9305fd9ebe2c72ca10f58cb63476cf46b8c7214fa576b9154c83498c1e562d3d76548e1894b7412b49ca6a089f835ef9a
+  metadata.gz: c96519fb7c78be496e6b9b05d747c68bf872848199b66b8278394b7d676eff329d891de017726bed0c74309f41f5e150b73068b41bc856cda442c10b0da6714c
+  data.tar.gz: e2a49ff9889337ac09409c0ec6654d159a6e2ed527ad080654772ecef10fc5611f727acae60da3c6546fd41f8187523d5613ba4ecf10016a1e72b636edfbfebc

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/nikki.png)](http://badge.fury.io/rb/nikki)
-[![Inline docs](http://inch-pages.github.io/github/brandonpittman/nikki.png)](http://inch-pages.github.io/github/brandonpittman/nikki)
+[![Inline docs](http://inch-ci.org/github/brandonpittman/nikki.png)](http://inch-ci.org/github/brandonpittman/nikki)
 
 # nikki
 
@@ -31,6 +31,15 @@ Or install it yourself as:
     nikki open            # Open current year's journal file in editor.
     nikki setup           # Creates new Nikki and config files.
 
+## Examples
+
+### New entry
+    nikki new "Brandon Pittman is a super cool guy."
+
+### Configure Nikki
+    nikki config --yesterday  # Reset last updated `datetime`
+    nikki config --list       # Prints latest entries
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/nikki/fork )

data/lib/nikki/version.rb

@@ -1,5 +1,5 @@
 # Sets version for RubyGems
 module Nikki
   # Sets version for RubyGems
-  VERSION = "0.4.3"
+  VERSION = "0.4.5"
 end

data/lib/nikki.rb

@@ -5,8 +5,8 @@ require "date"
 require 'fileutils'
 
 # @author Brandon Pittman
-# This is the main class that interfaces with Thor's methods and does all the heavy lifting for Nikki.
-# It's a bit of a "God" object. Sorries.
+# This is the main class that interfaces with Thor's methods and does all the
+# heavy lifting for Nikki.  It's a bit of a "God" object. Sorries.
 class Generator < Thor
 
   desc "setup", "Creates new Nikki and config files."
@@ -19,16 +19,21 @@ class Generator < Thor
 
   desc "new ENTRY", "Creates a new entry in the Nikki journal."
   # Add entry to journal
-  # @param entry [String] entry to add to the journal
-  # Will open your configured text editor on OS X if you didn't update the journal the previous day.
-  # This will allow you to add missing entries in bulk.
-  # It reads the settings in from the config YAML file and changes the date updated.
-  # It does the same with the journal file, reading in the YAML and merging the hash of entries, and then saves the YAML back again.
-  # There's also a method to check off a corresponding task in OmniFocus at the end.
-  def new(*args)
+  # @param --entry [String] entry to add to the journal
+  # @return [Hash] Returns a Hash which is then saved in a YAML file.
+  # @example
+  #   "nikki new 'This is a thing I learned today!'"
+  # Will open your configured text editor on OS X if you didn't update the
+  # journal the previous day.  This will allow you to add missing entries in
+  # bulk.  It reads the settings in from the config YAML file and changes the
+  # date updated.  It does the same with the journal file, reading in the YAML
+  # and merging the hash of entries, and then saves the YAML back again.
+  # There's also a method to check off a corresponding task in OmniFocus at the
+  # end.
+  def new(*entry)
     settings = read_config
     settings[:updated] = today
-    entry = args.join(" ")
+    entry = entry.join(" ")
     entry_hash = { today => entry }
     journal = read_file.merge(entry_hash)
     write_file(journal)
@@ -39,16 +44,19 @@ class Generator < Thor
   end
 
   desc "open", "Open current year's journal file in editor."
-  option :marked, :aliases => :m, :type => :boolean
   # Open Nikki journal in configured text editor
   def open
-    if options[:marked]
-      %x{open -a Marked #{file}}
-    else
-      %x{open -a "#{editor}" #{file}}
-    end
+    %x{open -a "#{editor}" #{file}}
   end
 
+  desc "ls", "Displays latest Nikki entries."
+  # Display Nikki's latest entires
+  # @return [String]
+  def ls
+    puts latest
+  end
+
+
   desc "config", "Change Nikki's settings."
   option :editor, :aliases => :e, :banner => "Set default editor to open journal file in."
   option :yesterday, :aliases => :y, :type => :boolean, :banner => "Set nikki's \"updated\" date to yesterday."
@@ -56,11 +64,12 @@ class Generator < Thor
   option :print, :aliases => :p, :type => :boolean, :banner => "Prints nikki's config settings."
   option :latest, :aliases => :l, :type => :boolean, :banner => "Prints latest journal entries."
   # Configure Nikki's settings
-  # @param --editor [String] (read_config[:editor]) Sets Nikki's editor to open journal file
-  # @param --yesterday Set `settings[:updated]` to yesterday
-  # @param --today Set `settings[:updated]` to today
-  # @param --print Prints Nikki's configuration settings to STDOUT
-  # @param --latest Prints Nikki's latest entries to STDOUT
+  # @param [Hash] options The options for configuring Nikki
+  # @option options :editor [String] (read_config[:editor]) Sets Nikki's editor to open journal file
+  # @option options :yesterday [Boolean] Set `settings[:updated]` to yesterday
+  # @option options :today [Boolean] Set `settings[:updated]` to today
+  # @option options :print [Boolean] Prints Nikki's configuration settings to STDOUT
+  # @option options :latest [Boolean] Prints Nikki's latest entries to STDOUT
   def config
     settings = read_config
     settings[:editor] = options[:editor] || read_config[:editor]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nikki
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.5
 platform: ruby
 authors:
 - Brandon Pittman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2014-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A simple one-line-a-day journaling app.