Overbryd-mighty-mite 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+pkg
+doc
+coverage
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Overbryd
+
+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.textile

@@ -0,0 +1,156 @@
+<pre>
+                                                                
+                _|            _|          _|                    
+_|_|_|  _|_|          _|_|_|  _|_|_|    _|_|_|_|  _|    _|      
+_|    _|    _|  _|  _|    _|  _|    _|    _|      _|    _|      
+_|    _|    _|  _|  _|    _|  _|    _|    _|      _|    _|      
+_|    _|    _|  _|    _|_|_|  _|    _|      _|_|    _|_|_|  _|  
+                          _|                            _|      
+                      _|_|                          _|_|        
+                                        
+                _|    _|                
+_|_|_|  _|_|        _|_|_|_|    _|_|    
+_|    _|    _|  _|    _|      _|_|_|_|  
+_|    _|    _|  _|    _|      _|        
+_|    _|    _|  _|      _|_|    _|_|_|  
+</pre>
+A simple command line interface for basic mite tasks.
+
+* @mite.@ is an ingeniously sleek time tracking tool: http://mite.yo.lk
+* @mighty-mite@ is a command line interface for it: http://github.com/Overbryd/mighty-mite
+  It provides a system wide command called @mite@.
+
+h3. Installation instructions:
+
+    $ gem install overbryd-mighty-mite
+    
+I assume github is in your gem sources. You may need @active_support@ and @active_resource@ too.
+
+h3. After installation instructions:
+
+You'll need to configure the client prior using it.
+To do this, you can just hammer into your console:
+
+    $ mite configure "Your Account Name" "Your API Key"
+
+It will then generate a yml file in ~/.mite.yml with your account information.
+
+The configure command also tries to install the bash auto completion hook into the following files: @~/.bash_completion@, @~/.bash_profile@, @~/.bash_login@, @~/.bashrc@.
+
+If your system doesn't support one of the files above, install the hook by yourself.
+In order to work as expected it needs bash to be configured for auto completion.
+This is actually quite easy, just append this line to your bash config file.
+
+    complete -C "mite auto-complete" mite
+
+You could use this command as an example (replace .bash_login with your bash configuration file):
+
+    $ echo "complete -C \"mite auto-complete\" mite" >> ~/.bash_login
+
+h3. Create new time entries with ease:
+
+    $ mite "project name" [service name] [start time h:mm] [note]
+    
+    $ mite "project name" "service name" [note]
+    
+    $ mite "project name" [start time h:mm] [note]
+    
+    $ mite [start time h:mm] [note]
+
+h4. The magic of the moment err... start time:
+
+Append a @+@ to the start time and it will start the tracker.
+
+The most convenient syntax to set the start time is @h:mm@. So it will accept all these kinds of values: @1:15@, @0:01@, @24:00@.
+
+Short-hand for hours:
+* @3+@ will set the start time to 3 hours, and start the tracker
+* @3.5@ will set it to 3 hours 30 minutes
+* @0.25+@ will make you look like a floating-point fetish, and start the tracker
+
+h4. Examples:
+
+    $ mite "World Domination" "W.o.M.D" 72:01+ "This takes way too long... Maybe I should try another way."
+
+This will set a time entry at 72:01 for the project "World Domination" with a note saying "This takes way too long... Maybe I should try another way.".
+The timer will start, because of the appended '+'. If there is a running timer, it will be stopped before.
+
+    $ mite HugEveryone 0:15 "Strange feelings..."
+
+This will set a time entry at 0:15 for the project HugEveryone with a note saying "Strange feelings...".
+The timer will not start.
+    
+    $ mite HugEveryone Love "Everybody should be like me..."
+
+This will set a time entry that starts at 0:00 for the Project HugEveryone, doing the service "Love" with a note "Everybody should be like me...".
+If there is a running timer, it will be stopped before.
+
+h4. Note:
+
+If a project or a service doesn't exist it will be created.
+
+h3. Amazing auto-completion:
+
+This is very nifty. (But maybe you should read the After Installation Instructions before.)
+The client was designed to save keystrokes, so I've baked in a very handy auto-completion feature.
+
+Try this:
+
+      $ mite [tab]
+
+It will try to auto-complete your projects.
+      
+      $ mite Project1 [tab]
+
+It will try to auto-complete your services.
+      
+      $ mite Project1 "System Administration" [tab]
+
+It will try to auto-complete common times!
+      
+      $ mite Project1 "System Administration" 0:48 [tab]
+
+It will try to auto-complete your notes!
+
+h4. Amazingly fast auto-completion:
+
+The auto-completion feature creates a cache in ~/.mite.cache, if you want to rebuild this cache just hit:
+    
+		$ mite rebuild-cache
+
+h4. Note: The first run without the cache might be a bit slow.
+
+h3. Controlling timers:
+
+		$ mite start
+
+This little cutey will start today's last time entry, if there is one.
+
+    $ mite stop
+
+This will just stop the current timer. (If you like you can use `mite pause` or `mite lunch` too)
+
+h3. Simple reports:
+
+    $ mite today
+
+This will generate a report of today's activity, summarizing your earnings at the bottom.
+
+    $ mite yesterday
+
+This will generate a report of yesterday's activity, summarizing your earnings at the bottom.
+Also works using @this_week@, @last_week@, @this_month@, @last_month@ as argument.
+
+h3. More simple stuff:
+
+    $ mite
+
+If there is a running timer, it will output it. Otherwise you should better not listen to it.
+
+    $ mite +
+
+Just create a new time entry and start tracking it.
+
+    $ mite open
+
+Opens your mite account in a new browser window (Max OSX only) or prints the url to your account.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mighty-mite"
+    gem.executables = "mite"
+    gem.summary = "A simple command line interface for basic mite tasks."
+    gem.email = "l.rieder@gmail.com"
+    gem.homepage = "http://github.com/Overbryd/mighty-mite"
+    gem.description = "A simple command line interface for mite, a sleek time tracking webapp."
+    gem.authors = ["Lukas Rieder"]
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+task :spec do
+  sh "spec spec/unit/* --format specdoc --color"
+end
+task :default => :spec

data/TODO

@@ -0,0 +1,4 @@
+* Make it soft around the edges
+* Improve auto-completion caching
+* Waiting for some feedback
+* Implementing feedback

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/mite

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'mighty_mite'
+
+begin
+  MightyMite.calling_script = __FILE__
+  MightyMite.run(ARGV)
+rescue MightyMite::Exception => e
+  puts "#{"Epic fail: #{e.message}".colorize(:color => :red, :background => :black)} Type `mite help` to get help."
+  exit(1)
+end

data/lib/mighty_mite/application.rb

@@ -0,0 +1,169 @@
+module MightyMite
+  class Application
+    TIME_FORMAT = /^(\d+(\.\d+)?:?\+?)|(\d+:\d+\+?)|\+$/
+    FLIRTS = [
+      'I like your hairstyle.', 'What a nice console you have.', 'My favorite color is red on black, monospaced.',
+      "What a lovely operation system this #{`uname`} is.", 'What about dinner tonight?', 'Your keystrokes are tingling.'
+    ]
+    
+    def initialize(arguments=[])
+      @arguments = arguments
+      MightyMite.load_configuration unless arguments.first == 'configure'
+    end
+    
+    def run
+      if @arguments.first == 'open'
+        open_or_echo Mite.account_url
+        
+      elsif @arguments.first == 'help'
+        open_or_echo 'http://github.com/Overbryd/mighty-mite'
+        
+      elsif @arguments.first == 'configure'
+        raise MightyMite::Exception.new('mite configure needs two arguments, the account name and the apikey') if @arguments.size < 3 # lol boobs, err... an ice cone!
+        write_configuration({:account => @arguments[1], :apikey => @arguments[2]})
+        tell("Could't set up bash completion. I'm terribly frustrated. Maybe 'mite help' helps out.") unless try_to_setup_bash_completion
+        
+      elsif @arguments.first == 'auto-complete'
+        autocomplete = MightyMite::Autocomplete.new(MightyMite.calling_script)
+        autocomplete.completion_table = if File.exist?(cache_file)
+          Marshal.load File.read(cache_file)
+        else
+          rebuild_completion_table
+        end
+        autocomplete.suggestions.map(&:quote_if_spaced).each { |s| tell s }
+        
+      elsif @arguments.first == 'rebuild-cache'
+        File.delete(cache_file) if File.exist? cache_file
+        rebuild_completion_table
+        tell 'The rebuilding of the cache has been done, Master. Your wish is my command.'
+        
+      elsif ['today', 'yesterday', 'this_week', 'last_week', 'this_month', 'last_month'].include? @arguments.first
+        total_revenue = Mite::TimeEntry.all(:params => {:at => @arguments.first, :user_id => 'current'}).each do |time_entry|
+          tell time_entry.inspect
+        end.map(&:revenue).compact.sum
+        tell ("%.2f $" % total_revenue).colorize(:lightgreen)
+        
+      elsif ['stop', 'pause'].include? @arguments.first
+        if current_tracker = (Mite::Tracker.current ? Mite::Tracker.current.stop : nil)
+          tell current_tracker.time_entry.inspect
+        end
+        
+      elsif @arguments.first == 'start'
+        if time_entry = Mite::TimeEntry.first(:params => {:at => 'today'})
+          time_entry.start_tracker
+          tell time_entry.inspect
+        else
+          tell "Oh my dear! I tried hard, but I could'nt find any time entry for today."
+        end
+      
+      elsif (1..4).include?(@arguments.size)
+        attributes = {}
+        if time_string = @arguments.select { |a| a =~ TIME_FORMAT }.first
+          attributes[:minutes] = parse_minutes(time_string) unless time_string == '+'
+          start_tracker = (time_string =~ /\+$/)
+        end
+        if project = find_or_create_project(@arguments.first)
+          attributes[:project_id] = project.id
+        end
+        if @arguments[1] && service = find_or_create_service(@arguments[1])
+          attributes[:service_id] = service.id
+        end
+        if note = parse_note(@arguments, time_string)
+          attributes[:note] = note
+        end
+        time_entry = Mite::TimeEntry.create attributes
+        time_entry.start_tracker if start_tracker
+        tell time_entry.inspect
+        
+      elsif @arguments.size == 0
+        tell Mite::Tracker.current ? Mite::Tracker.current.inspect : flirt
+      end
+    end
+    
+    def say(what)
+      puts what
+    end
+    alias_method :tell, :say
+    
+    def flirt
+      FLIRTS[rand(FLIRTS.size)]
+    end
+    
+    private
+    
+    def find_or_create_project(name)
+      project = Mite::Project.first(:params => {:name => name})
+      return nil if name =~ TIME_FORMAT
+      project ? project : Mite::Project.create(:params => {:name => name})
+    end
+    
+    def find_or_create_service(name)
+      service = Mite::Service.first(:params => {:name => name})
+      return nil if name =~ TIME_FORMAT
+      service ? service : Mite::Service.create(:params => {:name => name})
+    end
+
+    def parse_note(args, time_string)
+      if args[3]
+        args[3]
+      elsif time_string.nil? && args[2]
+        args[2]
+      elsif time_string && args[args.index(time_string)+1]
+        args[args.index(time_string)+1]
+      else
+        nil
+      end
+    end
+
+    def parse_minutes(string)
+      string = string.sub(/\+$/, '')
+      if string =~ /^\d+:\d+$/
+        string.split(':').first.to_i*60 + string.split(':').last.to_i
+      elsif string =~ /^\d+(\.\d+)?:?$/
+        (string.to_f*60).to_i
+      end
+    end
+    
+    def rebuild_completion_table
+      completion_table = {
+        0 => Mite::Project.all.map(&:name),
+        1 => Mite::Service.all.map(&:name),
+        2 => ['0:05', '0:05+', '0:15', '0:15+', '0:30', '0:30+', '1:00', '1:00+'].map(&:quote),
+        3 => Mite::TimeEntry.all.map(&:note).compact
+      }
+      File.open(cache_file, 'w') { |f| Marshal.dump(completion_table, f) }
+      completion_table
+    end
+    
+    def cache_file
+      File.expand_path('~/.mite.cache')
+    end
+    
+    def open_or_echo(open_argument)
+      exec "open '#{open_argument}' || echo '#{open_argument}'"
+    end
+    
+    def write_configuration(config)
+      File.open(File.expand_path('~/.mite.yml'), 'w') do |f|
+        YAML.dump(config, f)
+      end
+    end
+    
+    def try_to_setup_bash_completion
+      bash_code = "\n\n#{MightyMite::BASH_COMPLETION}"
+      
+      ['~/.bash_completion', '~/.bash_profile', '~/.bash_login', '~/.bashrc'].each do |file|
+        bash_config_file = File.expand_path file
+        next unless File.exist?(bash_config_file)
+        unless File.read(bash_config_file) =~ /#{bash_code}/
+          File.open(bash_config_file, 'a') do |f|
+            f.puts bash_code
+          end
+          return true
+        end
+      end
+      return false
+    end
+    
+  end
+end

data/lib/mighty_mite/autocomplete.rb

@@ -0,0 +1,48 @@
+require 'shellwords'
+
+module MightyMite
+  class Autocomplete
+    include Shellwords
+    
+    attr_accessor :completion_table
+    attr_reader :calling_script
+    
+    def initialize(calling_script)
+      @calling_script = calling_script
+    end
+    
+    def bash_line
+      ENV['COMP_LINE'].to_s
+    end
+  
+    def argument_string
+      bash_line.sub(/^(.*)#{File.basename calling_script}\s*/, '').close_unmatched_quotes
+    end
+  
+    def partial_argument_string
+      bash_line[0..cursor_position+1].sub(/^(.*)#{File.basename calling_script}\s*/, '').close_unmatched_quotes
+    end
+  
+    def current_word
+      return nil if argument_string =~ /\s$/ && bash_line.length == cursor_position
+      shellwords(partial_argument_string).last
+    end
+  
+    def current_argument_index
+      return args.size if argument_string =~ /\s$/ && bash_line.length == cursor_position
+      args.index(current_word) || 0
+    end
+  
+    def cursor_position
+      ENV['COMP_POINT'].to_i
+    end
+  
+    def args
+      shellwords(argument_string)
+    end
+  
+    def suggestions
+      completion_table[current_argument_index] ? completion_table[current_argument_index].select {|s| s =~ /^#{current_word}/} : []
+    end
+  end
+end

data/lib/mighty_mite.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+Dir[File.join(File.dirname(__FILE__), *%w[.. vendor * lib])].each do |path|
+  $LOAD_PATH.unshift path
+end
+require 'mite-rb'
+
+require 'string_ext'
+require 'mite_ext'
+require 'mighty_mite/application'
+require 'mighty_mite/autocomplete'
+
+module MightyMite
+  BASH_COMPLETION = "complete -C \"mite auto-complete\" mite"
+  
+  CONFIG_FILE = File.expand_path '~/.mite.yml'
+  
+  mattr_accessor :calling_script
+  
+  def self.load_configuration
+    if File.exist?(CONFIG_FILE)
+      configuration = YAML.load(File.read(CONFIG_FILE))
+      Mite.account = configuration[:account]
+      Mite.key = configuration[:apikey]
+    else
+      raise Exception.new("Configuration file is missing.")
+    end
+  end
+  
+  def self.run(args)
+    Application.new(args).run
+  end
+  
+  class Exception < StandardError; end
+end

data/lib/mite_ext.rb

@@ -0,0 +1,53 @@
+Mite.class_eval do
+  def self.account_url
+    host_format % [protocol, domain_format % account, (port.blank? ? '' : ":#{port}")]
+  end
+end
+
+Mite::TimeEntry.class_eval do
+  # I need the full class path, otherwise there will be LoadErrors
+  def service
+    @service ||= Mite::Service.find(service_id) unless service_id.blank?
+  end
+  
+  # I need the full class path, otherwise there will be LoadErrors
+  def project
+    @project ||= Mite::Project.find(project_id) unless project_id.blank?
+  end
+
+  def inspect
+    output = []
+    output << formatted_time.colorize(tracking? ? :lightyellow : :lightred)
+    output << formatted_revenue.colorize(:lightgreen) if revenue
+    output << "\tdoing #{service.name}" if service
+    output << "\tfor #{project.name}" if project
+    output << "\n\t\t|_ #{note}" unless note.blank?
+    output.join(' ')
+  end
+  
+  def formatted_revenue
+    revenue.nil? ? '' : "%.2f $" % (revenue / 100.0)
+  end
+    
+  def formatted_time
+    minutes = tracking? ? tracker.minutes : self.minutes
+    if minutes > 59
+      h = minutes/60
+      m = minutes-h*60
+      "#{h}:%.2d" % m
+    else
+      "0:%.2d" % minutes
+    end
+  end
+
+end
+
+Mite::Tracker.class_eval do
+  def time_entry
+    @time_entry ||= Mite::TimeEntry.find(id)
+  end
+
+  def inspect
+    time_entry.inspect
+  end
+end

data/lib/string_ext.rb

@@ -0,0 +1,50 @@
+String.class_eval do
+  def quote(q="\"")
+    "#{q}#{self}#{q}"
+  end
+  
+  def quote_if_spaced(q="\"")
+    self =~ /\s/ ? self.quote : self
+  end
+  
+  def close_unmatched_quotes(q="\"")
+    (self.scan(/"/).size % 2) != 0 ? self+q : self
+  end
+  
+  BASH_COLOR = {
+    :black => 30,
+    :red => 31,
+    :green => 32,
+    :yellow => 33,
+    :blue => 34,
+    :magenta => 35,
+    :cyan => 36,
+    :white => 37,
+    :default => 39
+  }
+  BASH_EFFECT = {
+    :none => 0,
+    :bright => 1,
+    :underline => 4,
+    :blink => 5,
+    :exchange => 7,
+    :hidden => 8
+  }
+  def colorize(options={})
+    return '' if self == ''
+    options = {:color => options} if options.is_a?(Symbol)
+    options[:color] = :default unless options[:color]
+    if options[:color] != :default && options[:color].to_s =~ /^(light|bright)/
+      options[:color] = options[:color].to_s.sub(/^(light|bright)/, '').to_sym
+      options[:effect] = :bright 
+    end
+    options[:background] = :default unless options[:background]
+    options[:effect] = :none unless options[:effect]
+    
+    effect_code = "#{BASH_EFFECT[options[:effect]]}"
+    background_code = "#{BASH_COLOR[options[:background]]+10}m"
+    color_code = "#{BASH_COLOR[options[:color]]}"
+    reset_code = "\e[0m"
+    "\e[#{effect_code};#{color_code};#{background_code}#{self}#{reset_code}"
+  end
+end

data/mighty-mite.gemspec

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mighty-mite}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lukas Rieder"]
+  s.date = %q{2009-05-22}
+  s.default_executable = %q{mite}
+  s.description = %q{A simple command line interface for mite, a sleek time tracking webapp.}
+  s.email = %q{l.rieder@gmail.com}
+  s.executables = ["mite"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "bin/mite",
+     "lib/mighty_mite.rb",
+     "lib/mighty_mite/application.rb",
+     "lib/mighty_mite/autocomplete.rb",
+     "lib/mite_ext.rb",
+     "lib/string_ext.rb",
+     "mighty-mite.gemspec",
+     "spec/spec_helper.rb",
+     "spec/unit/mighty_mite/application_spec.rb",
+     "spec/unit/mighty_mite/autocomplete_spec.rb",
+     "spec/unit/mighty_mite_spec.rb",
+     "spec/unit/mite_ext_spec.rb",
+     "spec/unit/string_ext_spec.rb",
+     "vendor/yolk-mite-rb-0.0.3/CHANGES.txt",
+     "vendor/yolk-mite-rb-0.0.3/LICENSE",
+     "vendor/yolk-mite-rb-0.0.3/README.textile",
+     "vendor/yolk-mite-rb-0.0.3/Rakefile",
+     "vendor/yolk-mite-rb-0.0.3/VERSION.yml",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite-rb.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/customer.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/project.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/service.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/time_entry.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/time_entry_group.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/tracker.rb",
+     "vendor/yolk-mite-rb-0.0.3/lib/mite/user.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/Overbryd/mighty-mite}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A simple command line interface for basic mite tasks.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/unit/mighty_mite/application_spec.rb",
+     "spec/unit/mighty_mite/autocomplete_spec.rb",
+     "spec/unit/mighty_mite_spec.rb",
+     "spec/unit/mite_ext_spec.rb",
+     "spec/unit/string_ext_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mighty_mite'
+
+Spec::Runner.configure do |config|
+
+end