jog 0.0.2

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    jog (0.0.2)
+      activesupport
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    i18n (0.6.0)
+    multi_json (1.3.4)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jog!

data/README.md

@@ -0,0 +1,51 @@
+Jog
+===
+
+*In-progress.*
+
+Simple command-line tool for logging what you've been up to in plain text files.
+
+Create / edit log entry for today
+---------------------------------
+
+```shell
+> jog today
+```
+
+By default, this will create a blank file at `~/jog/YYYY/MM/DD.txt'` and open it with Vim. If the file already exists, it will be opened in your editor.
+
+Configuration
+-------------
+
+When run, `jog` will walk up your directory tree from your current working directory looking for `.jogrc` and `.jogtemplate`. If it can't find them, it will look in your home directory. If they don't exist there, it will use the built-in defaults.
+
+To view your current configuration, run `jog config`:
+
+```shell
+> jog config
+Config
+------
+{:root=>"/Users/tyson/Dropbox/log",
+ :editor=>"mate -w",
+ :path_format=>"%Y/%B/%d.txt"}
+
+Template
+--------
+---
+Date: <%= Time.now.strftime( "%B %-d, %Y" ) %>
+Time: <%= Time.now.strftime( "%-I:%M%P %Z" ) %>
+---
+```
+
+### `.jogrc` Example
+
+    root: ~/Dropbox/log
+    editor: vim -f
+    path_format: '%Y/%B/%d.txt'
+
+### `.dontemplate` Example
+
+    ---
+    Date: <%= Time.now.strftime( "%B %-d, %Y" ) %>
+    Time: <%= Time.now.strftime( "%-I:%M%P %Z" ) %>
+    ---

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'

data/bin/jog

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+$:.push File.expand_path("../../lib", __FILE__)
+require 'jog'
+require 'jog/cli'
+
+begin
+  Jog::CLI.start(ARGV)
+rescue Jog::Config::InvalidConfig => e
+  puts e.message
+  exit 1
+end

data/jog.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "jog/version"
+
+Gem::Specification.new do |s|
+  s.name        = "jog"
+  s.version     = Jog::VERSION
+  s.authors     = ["Tyson Tate"]
+  s.email       = ["tyson@tysontate.com"]
+  s.homepage    = "http://github.com/tysontate/jog"
+  s.summary     = "Command-line tool that makes it easy to log your work."
+  s.description = "Jog is a simple command-line tool that simplifies the process of logging what you've worked on, storing plain-text files in a sensible file structue."
+
+  s.rubyforge_project = "jog"
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "thor"
+  s.add_runtime_dependency "activesupport"
+end

data/lib/jog/cli.rb

@@ -0,0 +1,22 @@
+require 'thor'
+require 'pp'
+
+module Jog
+  class CLI < Thor
+    desc "today", "Edit the log entry for today"
+    def today
+      Jog.edit( Jog.get_or_create_file( Time.now ) )
+    end
+
+    desc "config", "Print the current configuration"
+    def config
+      puts "Config"
+      puts "------"
+      pp Jog.config
+      puts
+      puts "Template"
+      puts "--------"
+      puts Jog.template
+    end
+  end
+end

data/lib/jog/config.rb

@@ -0,0 +1,82 @@
+require 'active_support/concern'
+require 'ostruct'
+
+module Jog
+  module Config
+    extend ActiveSupport::Concern
+    class InvalidConfig < StandardError; end
+
+    module ClassMethods
+      CONFIG_NAME = ".jogrc"
+      TEMPLATE_NAME = ".jogtemplate"
+      CONFIG_VARS = %w{root editor path_format}
+      DEFAULT_CONFIG = {
+        root: '~/jog',
+        editor: 'vim -f',
+        path_format: '%Y/%B/%d.txt'
+      }
+      DEFAULT_TEMPLATE = nil
+
+      def config
+        @config ||= load_config
+      end
+
+      def template
+        @template ||= load_template
+      end
+
+      protected
+
+      def load_config
+        config = DEFAULT_CONFIG.dup
+        if path = config_path
+          File.readlines( path ).each do |line|
+            next unless match = /([a-z_]+): (.+)/.match( line )
+            key, value = [match[1], match[2]]
+            unless CONFIG_VARS.include?( key )
+              raise InvalidConfig.new( "\"#{key}\" is not a valid configuration variable (from #{path})" )
+            end
+            config[key.to_sym] = value
+          end
+        end
+        config[:root] = File.expand_path( config[:root] )
+        config
+      end
+
+      def load_template
+        if path = template_path
+          File.read( path )
+        else
+          DEFAULT_TEMPLATE.dup
+        end
+      end
+
+      def config_path
+        allowed_paths( CONFIG_NAME ).find do |path|
+          File.exists?( path )
+        end
+      end
+
+      def template_path
+        allowed_paths( TEMPLATE_NAME ).find do |path|
+          File.exists?( path )
+        end
+      end
+
+      # Returns an array of allowed paths for the given folder / file name, in
+      # the order they should be searched.
+      def allowed_paths( basename )
+        dir = Dir.pwd
+        paths = []
+        while dir != File::SEPARATOR do
+          paths << File.join( dir, basename )
+          dir = File.split( dir ).first
+        end
+        ["/", "~/"].each do |root|
+          paths << File.expand_path( "#{root}#{CONFIG_NAME}" )
+        end
+        paths
+      end
+    end
+  end
+end

data/lib/jog/version.rb

@@ -0,0 +1,3 @@
+module Jog
+  VERSION = "0.0.2"
+end

data/lib/jog.rb

@@ -0,0 +1,33 @@
+require 'jog/version'
+require 'jog/config'
+require 'fileutils'
+require 'erb'
+
+module Jog
+  include Config
+
+  class << self
+    def get_or_create_file( time )
+      subpath = time.strftime( Jog.config[:path_format] )
+      full_path = File.expand_path( File.join( Jog.config[:root], subpath ) )
+      path, _ = File.split( full_path )
+
+      unless File.exists?( full_path )
+        FileUtils.mkdir_p( path )
+        if Jog.template
+          File.open( full_path, 'w' ) do |file|
+            text = ERB.new( Jog.template ).result
+            file.write( text )
+          end
+        else
+          FileUtils.touch( path )
+        end
+      end
+      full_path
+    end
+
+    def edit( path )
+      system "#{Jog.config[:editor]} #{path}"
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jog
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Tyson Tate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70230803245000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70230803245000
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70230803244520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70230803244520
+description: Jog is a simple command-line tool that simplifies the process of logging
+  what you've worked on, storing plain-text files in a sensible file structue.
+email:
+- tyson@tysontate.com
+executables:
+- jog
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/jog
+- jog.gemspec
+- lib/jog.rb
+- lib/jog/cli.rb
+- lib/jog/config.rb
+- lib/jog/version.rb
+homepage: http://github.com/tysontate/jog
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: jog
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Command-line tool that makes it easy to log your work.
+test_files: []