kk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f31a081bfd513dbb1e3c76f1b85c38e25797d1eb
+  data.tar.gz: 45b6f5b530d9cba626ee3ab0e0619da39203c04d
+SHA512:
+  metadata.gz: 4d05a0dc8046d24165b5b643892cb6adf61b064a786e74fbd148b5abe927562668839148344196936fbedeb4ef1597b7a3ea003fed99f36879ba6e8c52e34691
+  data.tar.gz: 14dd1d5b266f2d8f954eceaa2736fa4a52a0c988fb829220bfd90c03417fd2dac2d0bd653e7bc5fbe8b9db1c0d82d100f2934ccf1711850d5cdfb43b54ff596a

data/.ruby-gemset

@@ -0,0 +1 @@
+kk

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.4

data/Gemfile

@@ -0,0 +1 @@
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    kk (0.0.1)
+      sequel (~> 4.16.0)
+      sqlite3 (~> 1.3.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.8.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hitimes (1.2.2)
+    listen (2.7.11)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    sequel (4.16.0)
+    slop (3.6.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard (~> 2.8.0)
+  guard-rspec (~> 4.3.1)
+  kk!
+  rspec (~> 3.1.0)

data/README.md

@@ -0,0 +1,110 @@
+# kk - Personal diary/journaling/logging tool
+
+kk is an ultra-lightweight tool for journaling, logging and
+diarykeeping. It stores the journal in a sqlite3 database, ensuring
+fast updates and searches even when the logging gets fairly
+involved. kk is inspired by the awesome
+[jrnl app](http://maebert.github.io/jrnl/), and my intention is to
+make kk "scratch my own itch" for specialty needs like templates,
+reporting and logging.
+
+If all you need is a command-line journal app with tagging and simple
+searching, you probably want to use jrnl.
+
+# Feature Comparison with jrnl
+
+This is a list of the key features of kk and jrnl so that I can
+implement them using this document as a sort of "README-driven
+development" guide.
+
+| Feature                                  | kk | jrnl |
+|------------------------------------------+-----+------|
+| Exists at all, in any way, shape or form | YES | yes  |
+| Add entries from the command line        | YES | yes  |
+| Add journal entry with title and date    | NO  | yes  |
+| Show all journal entries                 | NO  | yes  |
+| Convenient dates and times               | NO  | yes  |
+| Export to json                           | NO  | yes  |
+| Search by date or date range             | NO  | yes  |
+| List tags                                | NO  | yes  |
+| Add tags with @ from CLI                 | NO  | yes  |
+| Search by tag                            | NO  | yes  |
+| 256-bit AES Encryption                   | NO  | yes  |
+| Portable by saving file to dropbox       | NO  | yes  |
+| Init config, db on startup if no db      | NO  | yes  |
+| Web server                               | NO  | NO   |
+| CLI->browser capture for longer entries  | NO  | NO   |
+| Template support                         | NO  | NO   |
+| Extra document data                      | NO  | NO   |
+| Search by document data                  | NO  | NO   |
+
+
+# Simple Usage Examples
+
+
+    kk Lunch. Went to favorite place.
+    # title: "Lunch", body: "Went to favorite place.", date: today, time: now
+
+    kk 3pm: Late lunch
+    # title: "Late lunch", body: nil, date: today, time: 3pm
+
+    kk yesterday: Tracked time for @work.
+    # title: "Tracked time for @work", body: nil, time: none, date: yesterday
+
+
+# Template Support
+
+I'm not sure yet how I want to tackle this, even to demonstrate how
+I'd use it (a la "design by wishful thinking"), but in short I want to
+create templates that let me quickly add new entries later. **These
+examples will likely change!**
+
+    kk --templates
+    # -> list templates
+
+    kk %fbg title: "Fasting Blood Glucose", body: %1, glucose:i: %1, fasting:b: true
+    # -> Creates/updates template "fbg" so that it takes one value
+    # from the command-line and writes it as the body of the journal
+    # entry. It sets the title to "Fasting Blood Glucose", and then
+    # adds extra data fields "glucose" (integer, set to .to_i of %1)
+    # and "fasting" (bool, set to true). TOTALLY UNSURE if I even want
+    # to support special types here or if everything should just be
+    # strings. On one hand I could see it all going into a json blob
+    # in the database anyway; on the other hand if create objects that
+    # the database can understand I can sift and sort by those types
+    # rather than by strings, so 10 would come after 9 instead of
+    # between 1 and 2, etc.
+
+    kk %fbg 86
+    # -> Records a glucose entry of 86.
+
+# Extra Document Data
+
+An extension of the extra fields idea raised by the templating
+thought. Ideally I want to all some kind of NoSQL-like data storage
+and searching, like "Show me all the glucose logs that are fasting:
+false" or "Show me the highest glucose entry in this date range". For
+now I'm thinking of either a JSON blob field, or if I move to postgres
+I can consider using an hstore column.
+
+TODO: Give some serious thought to rolling the whole thing with PStore
+or, even better, YAML::Store instead of sqlite. This would essentially
+make the whole store a NoSQL-style database. It essentially returns a
+giant hash so its use as a Key/Value store would be obvious. Expanding
+it to a "proper" document database might require more tooling than
+it's worth, dunno. Definitely have to store off my own indices, but I
+might be able to aggregate the values into document objects if the
+YAML store has a clean marshaling mechanism.
+
+Do I want to go to the trouble of separating the data access from the
+application? That means rolling a lot of the data access myself, sigh,
+but would it be worth it to be able to switch from sqlite to
+yaml/store?
+
+(Another consideration is speed: I know sqlite3 is pretty fast, but
+yaml store could end up implicitly creating objects for the entire
+file every time I loaded it. The result would be a huge performance
+hit once the journal got large. Food for thought. One option would be
+to roll my own store somehow, but right now I think perhaps the best
+option might be to use sqlite3 and roll as much of a key/value store
+on top of it as I need, but only as I need it.)

data/bin/kk

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# Load kk libs and connect to DB
+require_relative '../lib/kk'
+
+# Parse args and execute
+entry = ARGV * ' '
+time, msg = entry.split(/:/, 2)
+
+now = DateTime.now
+
+if msg.nil?
+  msg = time
+  time = now
+end
+
+title, body = msg.split(/\./, 2)
+body ||= ""
+
+Kk::Entry.create(title: title, body: body, entered_at: time, created_at: now, updated_at: now)

data/db/schema.rb

@@ -0,0 +1,12 @@
+# before running this, ensure that DB refers to the database we wanna modify...
+
+DB.create_table :entries do
+  primary_key :id
+  String :title
+  String :body, text: true
+  DateTime :entered_at
+  DateTime :created_at
+  DateTime :updated_at
+
+  index :entered_at
+end

data/kk.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'kk'
+  gem.version       = '0.0.1'
+  gem.date          = '2014-11-05'
+  gem.summary       = "Personal CLI/web diary/journaling tool"
+  gem.description   = "Personal CLI/web diary/journaling tool with tagging, templates, and customizable data fields"
+  gem.authors       = ["David Brady"]
+  gem.email         = 'dbrady@shinybit.com'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map {|f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec|test|features)/})
+  gem.require_paths = ["lib"]
+  gem.homepage      = 'https://github.com/dbrady/kk'
+  gem.license       = 'MIT'
+
+  gem.add_dependency "sqlite3", "~> 1.3"
+  gem.add_dependency "sequel", "~> 4.16"
+
+  gem.add_development_dependency "rspec", "~> 3.1"
+  gem.add_development_dependency "guard", "~> 2.8"
+  gem.add_development_dependency "guard-rspec", "~> 4.3"
+
+end

data/lib/kk.rb

@@ -0,0 +1,8 @@
+# main include/bootup/loadup file
+
+require 'sequel'
+require 'sqlite3'
+
+DB = Sequel.connect('sqlite://' + File.expand_path("~/.kk-journal.db"))
+
+require_relative './kk/entry'

data/lib/kk/entry.rb

@@ -0,0 +1,18 @@
+module Kk
+
+  class Entry < Sequel::Model
+
+    def before_create
+      super
+      now = DateTime.now
+      self.created_at ||= now
+    end
+
+    def before_update
+      super
+      now = DateTime.now
+      self.updated_at ||= now
+    end
+  end
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: kk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.16'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Personal CLI/web diary/journaling tool with tagging, templates, and customizable
+  data fields
+email: dbrady@shinybit.com
+executables:
+- kk
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/kk
+- db/schema.rb
+- kk.gemspec
+- lib/kk.rb
+- lib/kk/entry.rb
+homepage: https://github.com/dbrady/kk
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Personal CLI/web diary/journaling tool
+test_files: []