nikki 0.4.0 → 0.4.1

data/lib/nikki.rb

@@ -6,11 +6,11 @@ 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.
 class Generator < Thor
 
   desc "setup", "Creates new Nikki and config files."
-  # Setup up Nikki for use
-  # @note This methods creates the ".nikki" directory, config file and journal file.
+  # This methods creates the ".nikki" directory, config file and journal file.
   def setup
     create_path
     create_file
@@ -56,11 +56,11 @@ 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
-  # @option options [String] :editor (read_config[:editor]) Sets Nikki's editor to open journal file
-  # @option options [Boolean] :yesterday Set `settings[:updated]` to yesterday
-  # @option options [Boolean] :today Set `settings[:updated]` to today
-  # @option options [Boolean] :print Prints Nikki's configuration settings to STDOUT
-  # @option options [Boolean] :latest Prints Nikki's latest entries to STDOUT
+  # @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
   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.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Brandon Pittman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-29 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -108,8 +108,30 @@ files:
 - License.txt
 - README.md
 - Rakefile
-- TODO.md
 - bin/nikki
+- doc/Generator.html
+- doc/Nikki.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/cucumber.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/feature_list.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/cucumber.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/requirements.html
+- doc/requirements/step_transformers.html
+- doc/requirements/tags.html
+- doc/tag_list.html
+- doc/top-level-namespace.html
 - features/new_entry.feature
 - features/random.feature
 - features/step_definitions/new_entry.steps.rb
@@ -120,7 +142,6 @@ files:
 - nikki.gemspec
 - spec/nikki_spec.rb
 - spec/spec_helper.rb
-- tags
 - test/tc_nikki.rb
 homepage: http://github.com/brandonpittman/nikki
 licenses:

data/TODO.md

@@ -1,6 +0,0 @@
-# New Features
-
-## Add config file
-
-- Let users set a custom location for their journal.
-- Let users set the editor that they want to open if the mtime check failed.

data/tags

@@ -1,37 +0,0 @@
-!_TAG_FILE_FORMAT	2	/extended format; --format=1 will not append ;" to lines/
-!_TAG_FILE_SORTED	1	/0=unsorted, 1=sorted, 2=foldcase/
-!_TAG_PROGRAM_AUTHOR	Darren Hiebert	/dhiebert@users.sourceforge.net/
-!_TAG_PROGRAM_NAME	Exuberant Ctags	//
-!_TAG_PROGRAM_URL	http://ctags.sourceforge.net	/official site/
-!_TAG_PROGRAM_VERSION	5.8	//
-Generator	lib/nikki.rb	/^class Generator < Thor$/;"	c
-Nikki	lib/nikki/version.rb	/^module Nikki$/;"	m
-NikkiTest	test/tc_nikki.rb	/^class NikkiTest < MiniTest::Unit::TestCase$/;"	c
-config	lib/nikki.rb	/^  def config$/;"	f	class:Generator
-config_file	lib/nikki.rb	/^    def config_file$/;"	f	class:Generator
-config_file_exist?	lib/nikki.rb	/^    def config_file_exist?$/;"	f	class:Generator
-create_config_file	lib/nikki.rb	/^    def create_config_file$/;"	f	class:Generator
-create_file	lib/nikki.rb	/^    def create_file$/;"	f	class:Generator
-create_path	lib/nikki.rb	/^    def create_path$/;"	f	class:Generator
-editor	lib/nikki.rb	/^    def editor$/;"	f	class:Generator
-file	features/step_definitions/reveal_file.steps.rb	/^def file$/;"	f
-file	lib/nikki.rb	/^    def file$/;"	f	class:Generator
-file_exist?	lib/nikki.rb	/^    def file_exist?$/;"	f	class:Generator
-last_updated	lib/nikki.rb	/^    def last_updated$/;"	f	class:Generator
-latest	lib/nikki.rb	/^    def latest$/;"	f	class:Generator
-leap_year?	lib/nikki.rb	/^    def leap_year?$/;"	f	class:Generator
-marked	lib/nikki.rb	/^    def marked$/;"	f	class:Generator
-months_with_names	lib/nikki.rb	/^    def months_with_names$/;"	f	class:Generator
-new	lib/nikki.rb	/^  def new(*args)$/;"	f	class:Generator
-open	lib/nikki.rb	/^  def open$/;"	f	class:Generator
-path	lib/nikki.rb	/^    def path$/;"	f	class:Generator
-read_config	lib/nikki.rb	/^    def read_config$/;"	f	class:Generator
-read_file	lib/nikki.rb	/^    def read_file$/;"	f	class:Generator
-setup	lib/nikki.rb	/^  def setup$/;"	f	class:Generator
-test_file_exist?	test/tc_nikki.rb	/^  def test_file_exist?$/;"	f	class:NikkiTest
-test_read_config	test/tc_nikki.rb	/^  def test_read_config$/;"	f	class:NikkiTest
-test_updated_yesterday?	test/tc_nikki.rb	/^  def test_updated_yesterday?$/;"	f	class:NikkiTest
-today	lib/nikki.rb	/^    def today$/;"	f	class:Generator
-updated_yesterday?	lib/nikki.rb	/^    def updated_yesterday?$/;"	f	class:Generator
-write_config	lib/nikki.rb	/^    def write_config(hash)$/;"	f	class:Generator
-write_file	lib/nikki.rb	/^    def write_file(hash)$/;"	f	class:Generator