nikki 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44304d85497a945b10d26b403c1ffde95cd529b4
-  data.tar.gz: e1666230471fd50b243da107cee48a7351c39b79
+  metadata.gz: 21a4942b6497d674f4f13d34edfaf921c16c83b3
+  data.tar.gz: 8405b9f8aee38bbe34ad0b2166679b092df21d1e
 SHA512:
-  metadata.gz: 1de9407ab295181a8a958e0c22db022cb117de70d67ec5371874078fb3c37a1ccc79ed8f8176c980c26492ddc15a93139aad8892e34d4d1d4e2838844e608b86
-  data.tar.gz: 64825596f66e99613f4d9c08e6a76b6b93463b72a8e2703b56c52063b3603bc93f0edacaf61e8d0a6cdc61ceb94eb448395550f6c663968ad48f738e25115b31
+  metadata.gz: 8774c8bb643a5896c88394b72acbaa19345f4c196f3e41d257cccc44114d6625b5c282c6069f4377f3d16fc0f72093d250c496cd084adb773b389acf9599cc4a
+  data.tar.gz: 0f80bc207652527b4e8abf25750e67c88558b14fd3587cba7c41549daf868eb714555b6da2a1b70ca7eb1ae20dfe38ed97c2dda7ad2334c7fe9179be5b3d1660

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in nikki.gemspec
 gemspec
-gem 'cucumber'
-gem 'thor'

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/nikki.png)](http://badge.fury.io/rb/nikki) [![Build Status](https://travis-ci.org/brandonpittman/nikki.png?branch=master)](https://travis-ci.org/brandonpittman/nikki)
+
 # nikki
 
 > "Record something new learned every day of the year."
@@ -31,4 +33,4 @@ Or install it yourself as:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/TODO.md

@@ -0,0 +1,6 @@
+# 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/features/initialize_journal.feature

@@ -0,0 +1,9 @@
+Feature: Initialize a new config file
+  I want more information about exactly when last a journal was updated
+  And I want to have a place to save a custom journal location
+
+Background: No config file exists
+
+Scenario: New user wants to create a new journal using defaults
+
+Scenario: New user wants to create a new journal with a custom save location

data/features/new_entry.feature

@@ -3,21 +3,22 @@ Feature: Add a new entry to the journal
   Because I'm keeping a daily one-line journal, I want to be able to be able to save a new line with the day of the month next to it.
 
 Background:
-  Given I have a journal entry to make
+  Given I have a journal file
 
 Scenario: I haven't created a journal file
-  When I try to save my entry
-  And the journal file can't be found
+  When the journal file can't be found
   Then a file should be created
   And my journal entry saved
 
 Scenario: I have a journal file and it's the first of the month
-  When I try to save my entry
-  And it's the first of the month
-  Then the name of the month as an H1 header should be appended
+  When it's the first of the month
+  Then the name of the month as an H2 header should be appended
   And and my entry should be saved
 
 Scenario: I have a journal file and it's *not* the first of the month
-  When I try to save my entry
-  And it's not the first of the month
+  When it's not the first of the month
   Then my entry should be appended along with the day of the month
+
+Scenario: I didn't update the journal yesterday
+  When the mtime of the journal isn't yesterday
+  Then the journal should open in my editor

data/features/reveal_journal.feature

@@ -0,0 +1,9 @@
+Feature: Reveal journal file
+
+Scenario: I try to reveal a journal file
+  Given the file doesn't exist
+  Then create the file
+  And reveal the file
+
+  Given the file does exist
+  Then reveal the file

data/features/step_definitions/new_entry.steps.rb

@@ -1,10 +1,13 @@
-Given(/^I have a (.+) to make$/) do |arg|
-  @text = arg
-  @file = "#{ENV['HOME']}/.nikki_#{Time.now.strftime("%Y")}"
-end
+require "time"
+require "pathname"
+require "nikki"
+
+include Nikki
 
-When(/^I try to (save) my entry$/) do |arg|
-  arg == "save"
+Given(/^I have a journal file$/) do
+  @nikki = Generator.new
+  @file = @nikki.file
+  FileUtils.touch(@file) unless @file.exist?
 end
 
 When(/^the journal file can't be found$/) do
@@ -16,26 +19,34 @@ Then(/^a file should be created$/) do
 end
 
 Then(/^(my journal entry) saved$/) do |arg|
-  @entry = arg
-  File.open(@file,"a") { |f| f.puts "#{Time.now.strftime("%d")}. #{arg}" }
+  File.open(@file,"a") { |f| f.puts @nikki.text(arg) }
 end
 
 When(/^it's the first of the month$/) do
-  @date = Date.new(2014,2,1)
+  @first = Date.new(2014,2,1)
 end
 
-Then(/^the name of the month as an H1 header should be appended$/) do
-  File.open(@file, "a") { |file| file.puts "#{@date.strftime("%B")}" }
+Then(/^the name of the month as an H2 header should be appended$/) do
+  File.open(@file, "a") { |file| file.puts "\n## #{@first.strftime("%B").strip}\n\n" }
 end
 
 Then(/^and my (entry) should be saved$/) do |arg|
-  File.open(@file, "a") { |file| file.puts "#{@date.strftime("%d").strip} #{arg}" }
+  File.open(@file, "a") { |file| file.puts "#{@first.strftime("%e").strip}. #{arg}" }
 end
 
 When(/^it's not the first of the month$/) do
-  @date = Date.new(2014,2,2)
+  @not_first = Date.new(2014,2,2)
 end
 
 Then(/^my (entry) should be appended along with the day of the month$/) do |arg|
-  File.open(@file, "a") { |file| file.puts "#{@date.strftime("%d").strip} #{arg}" }
-end
+  File.open(@file, "a") { |file| file.puts "#{@not_first.strftime("%e").strip}. #{arg}" }
+end
+
+When(/^the mtime of the journal isn't yesterday$/) do
+    today = Date.today
+    @file.mtime.to_date != Date.today-1
+end
+
+Then(/^the journal should open in my editor$/) do
+    %x{open -a 'Sublime Text' #{@file}}
+end

data/features/step_definitions/reveal_file.steps.rb

@@ -0,0 +1,22 @@
+require "pathname"
+require "fileutils"
+
+def file
+  path = Pathname.new("/tmp/journal.md")
+end
+
+Given(/^the file doesn't exist$/) do
+  FileUtils.rm_rf(file) if file.exist?
+end
+
+Then(/^create the file$/) do
+  FileUtils.touch(file)
+end
+
+Then(/^reveal the file$/) do
+  %x{open -a 'Sublime Text' #{file}}
+end
+
+Given(/^the file does exist$/) do
+  FileUtils.touch(file) unless file.exist?
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+# require "aruba/cucumber"
+# require "fileutils"
+
+# Before do
+#   @real_home = ENV['HOME']
+#   fake_home = File.join('/tmp','fake_home')
+#   FileUtils.rm_rf fake_home, secure: true
+#   ENV['HOME'] = fake_home
+# end
+
+# After do
+#   ENV['HOME'] = @real_home
+# end

data/lib/nikki/version.rb

@@ -1,3 +1,3 @@
 module Nikki
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

data/lib/nikki.rb

@@ -1,52 +1,106 @@
 require 'thor'
 require "pathname"
+require "yaml"
+require "date"
+require 'time'
 
 module Nikki
   class Generator < Thor
+    @@config = nil
 
     desc "new ENTRY", "Creates a new entry in the Nikki journal."
     def new(entry)
       file.open('a') { |file| file.puts text(entry)}
+      open unless updated_yesterday?
+      @@config = config
+      @@config[:updated] = Date.today
+      config_file.open('w') { |t| t << @@config.to_yaml }
+    end
+
+    desc "open", "Opens current year's journal file in editor."
+    def open
+      %x{open -a "#{editor}" #{file}}
+    end
+
+    desc "setup", "Change Nikki's settings."
+    option :editor, :aliases => :e
+    def setup
+      @@config = config
+      @@config[:editor] = options[:editor] || 'TextEdit'
+      config_file.open('w') { |t| t << @@config.to_yaml }
     end
 
     no_commands do
+      def path
+        dropbox = Pathname.new("#{ENV['HOME']}/Dropbox/")
+        home = Pathname.new("#{ENV['HOME']}/")
+        path = dropbox.exist? ? dropbox : home
+      end
+
+      def config_file
+        path.join(".nikki.config.yaml")
+      end
+
+      def config
+        config_file_exist?
+        YAML.load(config_file.read)
+      end
+
+      def editor
+        config[:editor]
+      end
+
       def file
-       Pathname.new("#{ENV['HOME']}/.nikki_#{Time.now.strftime("%Y")}.md")
+        path.join(".nikki_#{Time.now.strftime("%Y")}.md")
+      end
+
+      def config_file_exist?
+        return true if config_file.exist?
+        create_config_file
+        return true
       end
 
       def file_exist?
-        if file.exist?
-          return true
-        else
-          create_file
-          return true
-        end
+        return true if file.exist?
+        create_file
+        return true
+      end
+
+      def create_config_file
+        FileUtils.touch(config_file)
       end
 
       def create_file
         FileUtils.touch(file)
       end
 
+      def today
+        Date.today
+      end
+
       def first_of_month?
-        Time.now.strftime("%d") == "1"
+        today.day == "1"
       end
 
       def date
-        Time.now.strftime("%d")
+        today.day
       end
 
       def month
-        Time.now.strftime("%B")
+        today.month
+      end
+
+      def updated_yesterday?
+        config[:updated] == Date.today-1
       end
 
       def text(entry)
         if first_of_month?
-          "## #{month}\n\n#{date}. #{entry}"
+          "\n## #{month}\n\n#{date}. #{entry}"
         else
           "#{date}. #{entry}"
         end
       end
     end
-
   end
 end

data/nikki.gemspec

@@ -20,7 +20,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "thor", "~> 0.18"
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
 end

data/test/tc_nikki.rb

@@ -2,7 +2,7 @@ require "minitest/autorun"
 require "minitest/unit"
 require "nikki"
 
-class TestCase < MiniTest::Unit::TestCase
+class NikkiTest < MiniTest::Unit::TestCase
 
   include Nikki
 
@@ -11,4 +11,11 @@ class TestCase < MiniTest::Unit::TestCase
     assert_equal(true,nikki.file_exist?)
   end
 
+  def test_updated_yesterday?
+    nikki = Generator.new
+    file = nikki.file
+    FileUtils.touch(file, :mtime => Time.now-86000)
+    assert(nikki.updated_yesterday?)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nikki
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Brandon Pittman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  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 one-line-a-day journaling app.
 email:
 - brandonpittman@gmail.com
@@ -76,13 +90,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
-- LICENSE
-- LICENSE.txt
+- License.txt
 - README.md
 - Rakefile
+- TODO.md
 - bin/nikki
+- features/initialize_journal.feature
 - features/new_entry.feature
+- features/reveal_journal.feature
 - features/step_definitions/new_entry.steps.rb
+- features/step_definitions/reveal_file.steps.rb
+- features/support/env.rb
 - lib/nikki.rb
 - lib/nikki/version.rb
 - nikki.gemspec
@@ -112,6 +130,10 @@ signing_key:
 specification_version: 4
 summary: A simple one-line-a-day journaling app.
 test_files:
+- features/initialize_journal.feature
 - features/new_entry.feature
+- features/reveal_journal.feature
 - features/step_definitions/new_entry.steps.rb
+- features/step_definitions/reveal_file.steps.rb
+- features/support/env.rb
 - test/tc_nikki.rb

data/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2013 brandonpittman
-
-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.