nikki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44304d85497a945b10d26b403c1ffde95cd529b4
+  data.tar.gz: e1666230471fd50b243da107cee48a7351c39b79
+SHA512:
+  metadata.gz: 1de9407ab295181a8a958e0c22db022cb117de70d67ec5371874078fb3c37a1ccc79ed8f8176c980c26492ddc15a93139aad8892e34d4d1d4e2838844e608b86
+  data.tar.gz: 64825596f66e99613f4d9c08e6a76b6b93463b72a8e2703b56c52063b3603bc93f0edacaf61e8d0a6cdc61ceb94eb448395550f6c663968ad48f738e25115b31

data/.gitignore

@@ -0,0 +1,21 @@
+<<<<<<< HEAD
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+=======
+.codekit
+>>>>>>> f81665bccd16c1a42bab86632a3bf9fd4d080625

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nikki.gemspec
+gemspec
+gem 'cucumber'
+gem 'thor'

data/LICENSE

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brandon Pittman
+
+MIT License
+
+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,34 @@
+# nikki
+
+> "Record something new learned every day of the year."
+
+### Track newly learned things
+
+In Japanese, "nikki" means "daily journal". The idea behind *nikki* is to record one thing you learned today. If all goes well, you've got a 365 line journal formatted in Markdown and ready to be posted to your blog on January 1st next year. The months are H1's and every day in the month is part of an ordered list. The journal file is saved at `~/.nikki_#{year}.md`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nikki'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nikki
+
+## Usage
+
+- nikki help [COMMAND]  # Describe available commands or one specific command
+- nikki new ENTRY       # Creates a new entry in the Nikki journal.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/nikki/fork )
+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

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*.rb']
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task(default: :test)

data/bin/nikki

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/../lib/nikki.rb'
+
+Nikki::Generator.start(ARGV)

data/features/new_entry.feature

@@ -0,0 +1,23 @@
+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
+
+Scenario: I haven't created a journal file
+  When I try to save my entry
+  And 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
+  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
+  Then my entry should be appended along with the day of the month

data/features/step_definitions/new_entry.steps.rb

@@ -0,0 +1,41 @@
+Given(/^I have a (.+) to make$/) do |arg|
+  @text = arg
+  @file = "#{ENV['HOME']}/.nikki_#{Time.now.strftime("%Y")}"
+end
+
+When(/^I try to (save) my entry$/) do |arg|
+  arg == "save"
+end
+
+When(/^the journal file can't be found$/) do
+  FileUtils.rm(@file) if File.exist?(@file)
+end
+
+Then(/^a file should be created$/) do
+  FileUtils.touch(@file)
+end
+
+Then(/^(my journal entry) saved$/) do |arg|
+  @entry = arg
+  File.open(@file,"a") { |f| f.puts "#{Time.now.strftime("%d")}. #{arg}" }
+end
+
+When(/^it's the first of the month$/) do
+  @date = 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")}" }
+end
+
+Then(/^and my (entry) should be saved$/) do |arg|
+  File.open(@file, "a") { |file| file.puts "#{@date.strftime("%d").strip} #{arg}" }
+end
+
+When(/^it's not the first of the month$/) do
+  @date = 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

data/lib/nikki/version.rb

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

data/lib/nikki.rb

@@ -0,0 +1,52 @@
+require 'thor'
+require "pathname"
+
+module Nikki
+  class Generator < Thor
+
+    desc "new ENTRY", "Creates a new entry in the Nikki journal."
+    def new(entry)
+      file.open('a') { |file| file.puts text(entry)}
+    end
+
+    no_commands do
+      def file
+       Pathname.new("#{ENV['HOME']}/.nikki_#{Time.now.strftime("%Y")}.md")
+      end
+
+      def file_exist?
+        if file.exist?
+          return true
+        else
+          create_file
+          return true
+        end
+      end
+
+      def create_file
+        FileUtils.touch(file)
+      end
+
+      def first_of_month?
+        Time.now.strftime("%d") == "1"
+      end
+
+      def date
+        Time.now.strftime("%d")
+      end
+
+      def month
+        Time.now.strftime("%B")
+      end
+
+      def text(entry)
+        if first_of_month?
+          "## #{month}\n\n#{date}. #{entry}"
+        else
+          "#{date}. #{entry}"
+        end
+      end
+    end
+
+  end
+end

data/nikki.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nikki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nikki"
+  spec.version       = Nikki::VERSION
+  spec.authors       = ["Brandon Pittman"]
+  spec.email         = ["brandonpittman@gmail.com"]
+  spec.summary       = %q{A simple one-line-a-day journaling app.}
+  spec.description   = %q{A simple one-line-a-day journaling app.}
+  spec.homepage      = "http://github.com/brandonpittman/nikki"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = ['nikki']
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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"
+end

data/test/tc_nikki.rb

@@ -0,0 +1,14 @@
+require "minitest/autorun"
+require "minitest/unit"
+require "nikki"
+
+class TestCase < MiniTest::Unit::TestCase
+
+  include Nikki
+
+  def test_file_exist?
+    nikki = Generator.new
+    assert_equal(true,nikki.file_exist?)
+  end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: nikki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Pittman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: cucumber
+  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
+executables:
+- nikki
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/nikki
+- features/new_entry.feature
+- features/step_definitions/new_entry.steps.rb
+- lib/nikki.rb
+- lib/nikki/version.rb
+- nikki.gemspec
+- test/tc_nikki.rb
+homepage: http://github.com/brandonpittman/nikki
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple one-line-a-day journaling app.
+test_files:
+- features/new_entry.feature
+- features/step_definitions/new_entry.steps.rb
+- test/tc_nikki.rb