personal-backlog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f937e28de5a51a5b188138452070cca2c8cf853
+  data.tar.gz: ac3e80e89aec853be2ce32609a9d64421372bac4
+SHA512:
+  metadata.gz: a2267d885e2b55ddc85548efc0a80765d2cf276b6545571fded88c2433561e7ce59fc2ee19b55bd7053dd6283d76ca0b91c9480e67d1c284e5575adbfedfb474
+  data.tar.gz: dbad5aa9642bd71cccbab13daf78c9223975bdc328275c474c34c9eb2a2df7dc97850ad9f0fd2e78f510473200219f91f83c7b749ca8172c1337cce816c5a3fd

data/README.md

@@ -0,0 +1,34 @@
+Backlog Tool
+============
+
+Commands
+--------
+
+```
+export BACKLOG_PATH=PATH_TO_BACKLOG || $HOME/.backlog
+
+# call next tuesday
+backlog next tuesday 
+
+# add something to today's todo list
+backlog -t "Start element" 
+
+# check for a match of this task in the todo
+backlog -c "Today" 
+  
+# work on todays backlog - open with edtior
+backlog 
+
+# archive everything previous to today
+backlog a
+backlog archive
+
+# go to the current directory
+backlog cd
+
+# backlog set up the directory
+backlog init
+
+
+```
+

data/bin/backlog

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'backlog'
+
+# initialize CLI 
+Backlog::CLI.new(ARGV.dup).execute!
+
+
+
+

data/lib/backlog/archive.rb

@@ -0,0 +1,39 @@
+require 'chronic'
+
+module Backlog
+
+  class Archive 
+  
+    def initialize(args, date)
+      @args = args
+      @date = date
+    end
+
+    def execute!
+        # our cli parser will always try to guess a legitimate date
+        if @date == nil or @date.date == Date.today
+          archive_all  
+        else 
+          archive_path @date.path
+        end
+    end
+
+    private
+    def archive_all
+      Dir.glob("#{Config.current_dir}/**md").each do |path|
+        date = DateFile.date_from_path(path)
+        if date < Date.today
+          archive_path(path)
+        end
+      end
+    end
+
+    def archive_path(path)
+      filename = File.basename(path)
+      FileUtils.mv(path, File.join(Config::archive_dir, filename))
+    end
+  end
+end
+
+
+

data/lib/backlog/args.rb

@@ -0,0 +1,12 @@
+module Backlog
+
+  class Args < Array
+
+    def initialize(*args)
+
+      super
+
+    end
+
+  end
+end

data/lib/backlog/cli.rb

@@ -0,0 +1,91 @@
+module Backlog
+  class CLI
+
+    @@commands = {
+        init:  Init, 
+        help: Help,
+        open: Open,
+        archive: Archive,
+        save: Save,
+        push: Push
+      }
+
+    @@aliases = {
+      
+      :init => :in,
+      :open => [:o, :edit],
+      :help => :h,
+      :archive => :a,
+      :save => :s,
+      :push => :p,
+    }
+
+    def self.commands
+      return @@commands
+    end
+
+    def initialize(argv, stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel)
+
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+    end
+
+    def execute!
+
+      # get the method to call for this command
+      command_class, argv = subcommand
+
+      # run the command
+      command_class.new(argv, @datefile).execute!
+
+    end
+
+    # return a function pointer for the subcommand
+    def subcommand()
+
+      if not @argv.length > 0
+        @datefile = DateFile.new
+        return Open, nil
+      end
+      # cache the first string a symbol
+      keyword = @argv[0].to_sym
+      
+      # loop through all commands and see if we have a match
+      @@commands.each do |key, command_class|
+
+        # grab a list of the aliases
+        aliases = nil
+        # check to see if aliases key exists
+        if @@aliases.has_key?(key)
+
+          # grab the key and then fill the aliases hash properly
+          value = @@aliases[key] 
+          if value.kind_of?(Symbol)
+            aliases = [value]
+          else
+            aliases = value
+          end
+        end
+        
+        # if alias / keywords match up then go ahead and return the correct class
+        if keyword == key or aliases.include? keyword
+          # return the correct command method
+          @argv = @argv[1,@argv.length]
+          @datefile = DateFile.new_from_argv(@argv)
+          return command_class, @argv 
+        end
+      end
+
+      # no command matches up - check to see if this is a date
+      # we need to pass the date on to the next step ...
+      date = DateFile.new_from_argv(@argv)
+
+      if date != nil 
+        @datefile = date
+        return Open, date.argv
+      else
+        @datefile = DateFile.new_from_argv(@argv)
+        return Open, nil
+      end
+    end
+  end
+end

data/lib/backlog/config.rb

@@ -0,0 +1,36 @@
+module Backlog
+
+  attr_accessor :base_dir
+
+  class Config
+
+    # internal variables
+    @@path = nil
+
+    def self.base_dir
+      if @@path != nil 
+        return @@path
+      end
+      if ENV.has_key? "BACKLOG_DIR"
+
+        if ENV['BACKLOG_DIR'].start_with? "/" or ENV['BACKLOG_DIR'].start_with? "~/" or ENV['BACKLOG_DIR'].start_with? "$HOME"
+          @@path = ENV['BACKLOG_DIR']
+        else
+          @@path = File.join(ENV['HOME'], ENV['BACKLOG_DIR'])
+        end
+      else
+        @@path = File.join(ENV['HOME'], ".backlog")
+      end
+      @@path = File.expand_path @@path
+    end
+
+    def self.current_dir
+      return File.join(Config.base_dir, "current")
+    end
+
+    def self.archive_dir
+      return File.join(Config.base_dir, "archive")
+    end
+
+  end
+end

data/lib/backlog/datefile.rb

@@ -0,0 +1,124 @@
+require 'chronic'
+
+module Backlog
+  class DateFile
+
+    attr_accessor :valid
+    attr_accessor :date
+
+    def initialize(date_string = nil)
+      
+      @string = date_string
+      if date_string == nil
+        now
+      else
+        parse_date(date_string)
+      end
+      
+    end
+
+    def self.date_from_path(path)
+      
+      date_string = File.basename(path).sub!(".md", "").gsub!("-", " ")
+      return Date.parse(Chronic.parse(date_string).to_s)
+    end
+
+    def self.new_from_argv(argv)
+
+      if argv.length == 0
+        return DateFile.new
+      end
+
+      # return a datefile with the argv changed up properly
+      first_keyword = argv[0]
+      date = DateFile.new(first_keyword)
+      argv.shift
+      
+      if date.valid == nil && argv.length > 0
+        date = DateFile.new("#{first_keyword} #{argv[0]}")
+        argv.shift
+
+      end
+
+      if date.valid
+        return date
+      else
+        return nil
+      end
+    end
+
+    def filename
+      
+      code = @date.strftime("%a-%b-%d")
+      return "#{code.downcase}.md"
+    end
+
+    def argv
+      return @argv
+    end
+
+    def path
+      # determine path
+      # if a past date - check to see if the date exists
+      # check current/archive
+      # generate the correct path as needed
+      current_path = File.join Config.current_dir, filename
+      archive_path = File.join Config.archive_dir, filename
+
+      # logic to return the correct path
+      if @date == Date.today
+        return current_path
+
+      elsif @date < Date.today
+        
+        if File.exist? current_path
+          return current_path
+        elsif File.exist? archive_path
+            return archive_path
+        else
+            return current_path
+        end
+      else 
+        return current_path
+      end
+    end
+
+    def relative_path
+
+      # remove the base directory from the path
+      return path.sub "#{Config.base_dir}/", ""
+
+    end
+
+    def exists
+
+      # return whether or not the date exists
+      return File.exist? path
+
+    end
+
+    private
+    def parse_date(date_string)
+
+      # our file names are of the type - mon-mar-16
+      # these don't play nice with chronic
+      date = Chronic.parse(date_string.sub("-", " "))
+      
+      # chronic couldn't create a date object from this
+      if date == nil
+        @valid = nil
+        @date = nil
+      else
+        @valid = true
+        @date = Date.parse(date.to_s)
+      end
+    end
+
+    def now
+      @date = Date.parse(Time.now.to_s)
+      @valid = true
+    end
+  end
+end
+
+

data/lib/backlog/entry.rb

@@ -0,0 +1,53 @@
+module Backlog
+  class Entry
+    def initialize(date)
+
+      @date = date
+      @path = date.path
+      if not File.exists?(date.path)
+        @exists = nil
+      else
+        @exists = true
+      end
+
+    end
+
+    def exists
+      return @exists
+    end
+
+    def create
+     
+      File.open(@path, "w").write content
+      
+    end
+
+    private
+    def title
+
+      return @date.date.strftime("%A %B %d")
+    end
+
+    def content
+      return <<-eos
+#{title} 
+#{(0..title.length).map{"="}.join}
+
+Completed
+---------
+
+
+
+
+Todo
+----
+
+
+
+
+      eos
+    end
+
+
+  end
+end

data/lib/backlog/file.rb

@@ -0,0 +1,9 @@
+module Backlog
+
+  class Entry
+
+    
+
+  end
+
+end

data/lib/backlog/help.rb

@@ -0,0 +1,36 @@
+module Backlog
+  class Help
+
+    def initialize(cli_args, *args)
+
+    end
+
+    def execute!
+
+      # run the command as needed
+      CLI.commands.each do |command, command_class| 
+        #puts command_class
+        puts command
+        ##print_help(command_class)
+
+      end
+
+    end
+
+    def self.help()
+
+      return <<-eos
+      Help: \tPrint this menu
+      eos
+
+    end
+
+    def print_help(command_class)
+
+      help = command_class.help
+      puts help
+
+    end
+
+  end
+end

data/lib/backlog/init.rb

@@ -0,0 +1,40 @@
+require 'fileutils'
+
+module Backlog
+  class Init
+  
+    def initialize(*args)
+
+    end
+
+    def execute!
+      
+      create_directories
+      initialize_git
+    end
+
+    def self.help()
+      return <<-eos
+      Init:\tInitialize the backlog directory with the correct directory structures (ie: current/archive)
+      eos
+    end
+
+    private
+    def create_directories
+      [Config.base_dir, Config.archive_dir, Config.current_dir].each do |directory|
+        if not File.directory? directory 
+          FileUtils.mkdir(directory)
+        end
+      end
+    end
+
+    def initialize_git
+      git_directory = File.join Config.base_dir, ".git"
+      if not File.directory? git_directory
+        system "cd #{Config.base_dir} && git init"
+      end
+    end
+
+  end
+end
+

data/lib/backlog/open.rb

@@ -0,0 +1,48 @@
+module Backlog
+  class Open
+
+    def initialize(args, date)
+  
+      @date = date
+
+    end
+
+    def execute!
+
+      entry = Entry.new(@date)
+
+      # make sure that the file is created 
+      if not entry.exists
+        entry.create
+      end
+
+      if Date.today == @date.date
+        symlink
+      end
+
+      # save date as needed
+      Save.save_date_on_open(@date.date)
+
+      # open file
+      Kernel::exec "cd #{Config.base_dir} && #{ENV['EDITOR']} #{@date.relative_path}"
+    end
+
+    def self.help
+
+      return <<-eos
+      Open:\tedit backlog entries
+      eos
+
+    end
+
+    private
+    def symlink
+      
+      path = File.join(Config.base_dir, "README.md")
+
+      # symlink current entry to readme
+      FileUtils.ln_s(@date.path, path, :force => true)
+    end
+
+  end
+end

data/lib/backlog/push.rb

@@ -0,0 +1,28 @@
+module Backlog
+
+  class Push
+
+    def initialize(args, date)
+      # determine whether or not this is pushable
+      @pushable = remote_set
+    end
+
+    def execute!
+      if @pushable
+        push
+      end
+    end
+
+    private
+    def remote_set
+      command = "cd #{Config.base_dir} && git remote show origin 2>&1 1>/dev/null"
+      return Kernel::system command
+    end
+
+    def push
+      command = "cd #{Config.base_dir} && git push --force"
+      Kernel::system command
+    end
+  end
+
+end

data/lib/backlog/save.rb

@@ -0,0 +1,49 @@
+module Backlog
+
+  class Save
+
+    def initialize(args = nil, datefile = nil)
+    end
+
+    def execute!
+      Save.save
+    end
+
+    def self.save_in_background
+
+      job = fork do
+        Kernel::exec command
+      end
+      Process.detach job
+
+    end
+
+    def self.save_date_on_open(date)
+
+      # takes in a date object and saves properly
+      Kernel::system command(commit_message(date))
+
+    end
+
+    def self.save
+      Kernel::exec command(commit_message)
+    end
+
+    private
+    def self.command(message)
+      command = "cd #{Config.base_dir} && git add --all . && git commit -a -m \"#{message}\""
+    end
+
+    def self.commit_message(date = nil)
+
+      today = Date.today.strftime("%A %B %d")
+      if date == nil
+        return today 
+      else
+        entry = date.strftime("%A %B %d")
+        return "#{entry} (updated on #{today})"
+      end
+    end
+
+  end
+end

data/lib/backlog.rb

@@ -0,0 +1,20 @@
+require 'version'
+
+# utilities
+require 'backlog/args'
+require 'backlog/config'
+require 'backlog/datefile'
+
+# individual commands
+require 'backlog/help'
+require 'backlog/entry'
+require 'backlog/init'
+require 'backlog/open'
+require 'backlog/archive'
+require 'backlog/save'
+require 'backlog/push'
+
+# cli controller 
+require 'backlog/cli'
+
+

data/lib/version.rb

@@ -0,0 +1,5 @@
+module Backlog
+
+  VERSION = "1.0.0"
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: personal-backlog
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Morehouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-30 00:00:00.000000000 Z
+dependencies: []
+description: Personal backlog cli. Wraps a github repository and utilizes markdown
+  as a day to day management software
+email:
+- morehousej09@gmail.com
+executables:
+- backlog
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/backlog
+- lib/backlog.rb
+- lib/backlog/archive.rb
+- lib/backlog/args.rb
+- lib/backlog/cli.rb
+- lib/backlog/config.rb
+- lib/backlog/datefile.rb
+- lib/backlog/entry.rb
+- lib/backlog/file.rb
+- lib/backlog/help.rb
+- lib/backlog/init.rb
+- lib/backlog/open.rb
+- lib/backlog/push.rb
+- lib/backlog/save.rb
+- lib/version.rb
+homepage: http://github.com/backlog
+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: Personal Backlog manager
+test_files: []