diary-ruby 0.1.0

data/README.md

@@ -0,0 +1,56 @@
+**DON'T USE THIS YET**
+
+# diary-ruby
+
+A toy CLI app for me. Playing with encryption and the `$EDITOR` env var.
+
+## Usage
+
+    $ gem install diary-ruby
+    $ diaryrb
+
+    TYPE TYPE TYPE
+
+Now you have a diary too.
+
+You can create a config file to make it easier to manage multiple diaries.
+`diaryrb` looks for a config file in ~/.diaryrb/config.yaml. Valid config
+options are `passphrase` and `path`. For example:
+
+```yaml
+default:
+  path: "/Users/yername/Dropbox/Documents/notes.diary"
+
+secure.store:
+  passphrase: "this is the passphrase, I put it in a config file! 82acf427f94c513f8d7f81995a549361089d903f"
+  path: "~/secure.secret.diary"
+```
+
+If a config file is used, diaryrb uses the -d option to pick a diary by name:
+
+    $ diaryrb -d default
+
+would load the diary at `/Users/.../notes.diary`, while
+
+    $ diaryrb -d mynotes
+
+would create a new diary file named "mynotes" in the current directory.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/abachman/diary-ruby. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,4 @@
+- [x] add "last post" date to top of template
+- [ ] add search to exe/diaryrb
+- [ ] add date range filters to exe/diaryrb
+- [ ] add edit functionality

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "diary-ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/diary-ruby.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'diary-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "diary-ruby"
+  spec.version       = Diary::VERSION
+  spec.authors       = ["Adam Bachman"]
+  spec.email         = ["adam.bachman@gmail.com"]
+  spec.licenses      = ['GPL-3.0']
+
+  spec.summary       = %q{A CLI diary: diaryrb}
+  spec.description   = %q{A command line diary: diaryrb}
+  spec.homepage      = "https://github.com/abachman/diary-ruby"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = ['diaryrb']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", '~> 5.8'
+  spec.add_development_dependency "minitest-display", '~> 0.3'
+
+  spec.add_dependency 'sinatra', '~> 1.4'
+  spec.add_dependency 'rdiscount', '~> 2.1'
+  spec.add_dependency 'slop', '~> 4.2'
+  spec.add_dependency 'launchy', '~> 2.4'
+end

data/exe/diaryrb

@@ -0,0 +1,188 @@
+#!/usr/bin/env ruby
+
+require 'diary-ruby'
+require 'slop'
+require 'launchy'
+require 'thread'
+
+DEFAULT_DIARY = "diaryrb.store"
+
+prompt_for_password = false
+opts = Slop.parse do |o|
+  # o.string '-c', '--configuration', 'config file location'
+  o.string '-d', '--diary', "choose diary storage file (leave blank for default, #{DEFAULT_DIARY})"
+  o.string '-p', '--passphrase', 'Use given encryption passphrase or prompt if option is used but no passphrase is given.', default: false do |v|
+    if v.start_with?('-') || v.nil? || v.strip.size == 0
+      prompt_for_password = true
+    end
+  end
+
+  # usage modes
+  o.separator ''
+  o.separator "Actions (can't be used in combination):"
+  o.string '-e', '--edit', 'edit a specific post'
+  o.bool '-l', '--list', 'list all posts by date'
+  o.bool '-s', '--serve', 'start Diary webserver'
+
+  o.separator ''
+  o.separator 'Other options:'
+  o.bool '-v', '--verbose', 'enable verbose mode'
+  o.on '-V', '--version', 'print the version and quit' do
+    puts "diaryrb #{ Diary::VERSION }"
+    exit
+  end
+  o.on '-h', '--help', 'show help and quit' do
+    puts o
+    exit
+  end
+end
+
+# Global config options
+Diary::Configuration.verbose = opts.verbose?
+
+# Get diary name from configuration or command line
+_diary = DEFAULT_DIARY
+if opts[:diary]
+  # ALWAYS prefer the given argument
+  _diary = opts[:diary]
+elsif Diary::Configuration.exists?
+  if Diary::Configuration.has_diary_config?('default')
+    Diary.debug "LOADING default DIARY"
+    _diary = 'default'
+    Diary::Configuration.load_config('default')
+  else
+    Diary.debug "CONFIG EXISTS, NO DEFAULT. LOADING DIARY #{ _diary }"
+  end
+end
+
+Diary::Configuration.current_diary = _diary
+
+_passphrase = nil
+if prompt_for_password
+  require 'io/console'
+  print "Enter passphrase (leave blank for none): "
+  _passphrase = STDIN.noecho {|io| io.gets}.chomp
+elsif opts[:passphrase] && opts[:passphrase].strip.size > 0
+  _passphrase = opts[:passphrase]
+elsif ENV['PASSPHRASE']
+  _passphrase = ENV['PASSPHRASE']
+elsif Diary::Configuration.passphrase
+  _passphrase = Diary::Configuration.passphrase
+end
+
+diary_path = Diary::Configuration.path || Diary::Configuration.current_diary
+Diary.debug "LOADING DIARY #{ Diary::Configuration.current_diary } AT PATH #{ diary_path }"
+if _passphrase.nil? || _passphrase.size == 0
+  Diary.debug "LOADING WITH NO PASSPHRASE!"
+  $store = Diary::Store.new(diary_path)
+else
+  Diary.debug "LOADING WITH PASSPHRASE #{ _passphrase.gsub(/./, '*') }"
+  $store = Diary::SecureStore.new(diary_path, _passphrase)
+end
+
+# this is like rake db:migrate
+$store.write do |db|
+  db[:entries] ||= []
+  db[:entries] = db[:entries].compact.uniq.sort
+  db[:tags] ||= []
+end
+
+if opts.list?
+  entries = $store.read(:entries)
+  puts ''
+
+  if entries.nil? || entries.size == 0
+    puts "No entries"
+    exit
+  else
+    entries.uniq.sort.reverse.each do |entry_key|
+      puts "#{ entry_key }   #{ $store.read(entry_key)[:text][0..40].gsub("\n", ' ') }..."
+    end
+  end
+elsif opts.serve?
+  Diary::Server.store = $store
+  t = Thread.new do
+    Diary::Server.run!
+  end
+  Launchy.open('http://localhost:4567')
+  t.join
+else
+  def finish(file)
+    file.close
+    file.unlink   # deletes the temp file
+  end
+
+  def parse_and_store(file)
+    diary_entry = Diary::Parser.parse_file(file)
+    $store.write_entry(diary_entry)
+  end
+
+  # create a tempfile to store entry in progress in EDITOR
+  file = Tempfile.new(['diary', '.md'])
+  file.sync = true
+
+  # default new entry
+  entry_source = {
+    day: Time.now.strftime("%F"),
+    time: Time.now.strftime("%T"),
+    tags: "",
+    title: "",
+    text: "text goes here"
+  }
+
+  # if --edit option is used with a valid entry, load it
+  if opts[:edit] && (entry_hash = $store.read(opts[:edit]))
+    entry = Diary::Entry.from_store(entry_hash)
+    entry_source = entry.to_hash
+    entry_source[:tags] = entry_source[:tags].join(', ')
+  end
+
+  # prepare entry and launch editor
+  tmpl = Diary::Entry.generate(entry_source, $store)
+  file.write(tmpl)
+
+  ed = "vim -f"
+  if ENV['DIARY_EDITOR']
+    ed = ENV['DIARY_EDITOR']
+  elsif ENV['EDITOR']
+    ed = ENV['EDITOR']
+  end
+
+  pid = fork do
+    exec("#{ ed } #{ file.path }")
+  end
+
+  # wait for child to finish, exit when the editor exits
+  exit_signal = Queue.new
+
+  trap("CLD") do
+    Diary.log "CHILD PID #{pid} TERMINATED"
+    exit_signal.push(true)
+  end
+
+  Diary.log "WAITING FOR EDITOR IN PROCESS #{ pid }"
+
+  # Polling based observation of tempfile, save to Store whenever Entry is updated
+  omtime = File.mtime(file.path)
+  while true do
+    quitter = exit_signal.pop(true) rescue nil
+
+    mtime = File.mtime(file.path)
+    if mtime != omtime
+      Diary.log "FILE MODIFIED, UPDATING ENTRY"
+      parse_and_store(file)
+      omtime = mtime
+    end
+
+    if quitter
+      Diary.debug "QUIT SIGNAL RECEIVED"
+      # parse_and_store(file)
+      Diary.debug "CLEANING UP..."
+      finish(file)
+      Diary.debug "EXIT"
+      exit 0
+    end
+
+    sleep 1
+  end
+end

data/lib/diary-ruby.rb

@@ -0,0 +1,20 @@
+require "diary-ruby/version"
+require "diary-ruby/store"
+require "diary-ruby/entry"
+require "diary-ruby/parser"
+require "diary-ruby/configuration"
+require "diary-ruby/server/server"
+
+module Diary
+  def self.log(message)
+    if Diary::Configuration.verbose
+      puts message
+    end
+  end
+
+  def self.debug(message)
+    if Diary::Configuration.verbose
+      puts message
+    end
+  end
+end

data/lib/diary-ruby/configuration.rb

@@ -0,0 +1,88 @@
+require 'pathname'
+require 'yaml'
+
+DIARY_DIR = ".diaryrb"
+
+module Diary
+  # Read only app configuration
+  #
+  class Configuration
+    class Error < StandardError
+    end
+
+    class << self
+      attr_accessor :current_diary
+      attr_accessor :verbose
+
+      # Find config directory starting at current dir and then moving up the tree
+      def config_dir(dir = Pathname.new("."))
+        app_config_dir = dir + DIARY_DIR
+
+        if dir.children.include?(app_config_dir)
+          app_config_dir.expand_path
+        else
+          return nil if dir.expand_path.root?
+
+          # go up the stack
+          config_dir(dir.parent)
+        end
+      end
+
+      def method_missing(method)
+        config[method.to_s]
+      end
+
+      def exists?
+        !config_dir.nil?
+      end
+
+      def has_diary_config?(diary_identifier)
+        load_global_settings
+        global_settings.has_key?(diary_identifier)
+      end
+
+      def global_settings
+        @global_settings || {}
+      end
+
+      # load a specific diary
+      def load_config(diary_identifier)
+        @config = load_config_for_diary(diary_identifier)
+      end
+
+      # default to current_diary
+      def config
+        @config ||= load_config_for_diary(current_diary)
+      end
+
+      private
+
+      def load_config_for_diary(diary_identifier)
+        if !exists?
+          # no config file exists, build empty configuration options starting now
+          {}
+        else
+          load_global_settings
+          if global_settings.has_key?(diary_identifier)
+            global_settings[diary_identifier]
+          else
+            # configuration for this diary doesn't exist, build empty
+            # configuration options starting now
+            {}
+          end
+        end
+      end
+
+      def load_global_settings
+        @global_settings ||= begin
+                               if exists?
+                                 cf = File.join(config_dir, 'config.yaml')
+                                 YAML.load(File.open(cf))
+                               else
+                                 {}
+                               end
+                             end
+      end
+    end
+  end
+end

data/lib/diary-ruby/entry.rb

@@ -0,0 +1,85 @@
+TEMPLATE = "# last entry posted at %{last_update_at}
+
+DAY   %{day}
+TIME  %{time}
+TAGS  %{tags}
+TITLE %{title}
+
+---
+
+%{text}
+"
+
+require 'rdiscount'
+
+module Diary
+  class Entry
+    attr_accessor :version, :day, :time, :tags, :text, :title, :key
+
+    CURRENT_VERSION = 1
+
+    def self.from_store(record)
+      if record[:version] == 1
+        self.new(
+          record[:version],
+          day: record[:day],
+          time: record[:time],
+          tags: record[:tags],
+          text: record[:text],
+          title: record[:title],
+          key: record[:key],
+        )
+      end
+    end
+
+    def self.keygen(day, time)
+      "%s-%s" % [day, time]
+    end
+
+    def self.generate(options={}, store)
+      options[:last_update_at] = store.read(:last_update_at)
+
+      # convert Arrays to dumb CSV
+      options.each do |(k, v)|
+        if v.is_a?(Array)
+          options[k] = v.join(', ')
+        end
+      end
+
+      TEMPLATE % options
+    end
+
+    def initialize(version, options={})
+      @version = version || CURRENT_VERSION
+
+      @day = options[:day]
+      @time = options[:time]
+      @tags = options[:tags] || []
+      @text = options[:text]
+      @title = options[:title]
+
+      if options[:key].nil?
+        @key = Entry.keygen(day, time)
+      else
+        @key = options[:key]
+      end
+    end
+
+    def formatted_text
+      RDiscount.new(text).to_html
+    end
+
+    def to_hash
+      {
+        version: version,
+        day: day,
+        time: time,
+        tags: tags,
+        text: text,
+        title: '',
+        key: key,
+      }
+    end
+  end
+end
+