clevic 0.5.2 → 0.6.0

data/Manifest.txt

@@ -1,11 +1,15 @@
 History.txt
-INSTALL
 Manifest.txt
 README.txt
 Rakefile
 TODO
 accounts_models.rb
 bin/clevic
+bin/import-times
+config/hoe.rb
+config/jamis.rb
+config/requirements.rb
+env.sh
 lib/active_record/dirty.rb
 lib/clevic.rb
 lib/clevic/browser.rb
@@ -25,7 +29,18 @@ lib/clevic/ui/browser_ui.rb
 lib/clevic/ui/icon.png
 lib/clevic/ui/search_dialog.ui
 lib/clevic/ui/search_dialog_ui.rb
+lib/clevic/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
 sql/accounts.sql
 sql/times.sql
-template/jamis.rb
+tasks/website.rake
 times_models.rb
+values_models.rb
+website/index.html
+website/index.txt
+website/screenshot.png
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -1,6 +1,6 @@
 = clevic
 
-http://www.rubyforge.org/clevic
+http://clevic.rubyforge.org/
 
 == DESCRIPTION:
 
@@ -14,6 +14,8 @@ nice keyboard shortcuts for all sorts of things. Model (table) objects
 are extensible to allow for model (table) specific cleverness, like
 auto-filling-in of fields.
 
+Start with Clevic::Browser
+
 == FEATURES:
 
 * Filter by current field.
@@ -60,7 +62,8 @@ See TODO file.
 === Gems
 * fastercsv
 * ruby-qt4
-* active_record
+* qtext (not available on rubyforge yet. Download from http://www.semiosix.com/qtext-0.2.0.gem)
+* ActiveRecord
 
 === Other
 

data/Rakefile

@@ -1,20 +1,12 @@
 require 'rubygems'
 require 'rake/clean'
 require 'hoe'
-require 'lib/clevic/version.rb'
 require 'pathname'
 
-$hoe = Hoe.new( 'clevic', Clevic::VERSION ) do |s|
-	s.author     = "John Anderson"
-	s.email      = "john at semiosix dot com"
-	s.rubyforge_name = 'clevic'
-	s.extra_deps = [
-    ['qtext', '>=0.2.0'],
-    ['activerecord', '>=2.0.2']
-    # This isn't always installed from gems
-    #~ ['qtruby4', '>=1.4.9']
-  ]
-end
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }
 
 # generate a _ui.rb filename from a .ui filename
 def ui_rb_file( ui_file )
@@ -112,7 +104,7 @@ Rake::RDocTask.new(:docs) do |rd|
   rd.main = "README.txt"
   rd.options << '-d' if RUBY_PLATFORM !~ /win32/ and `which dot` =~ /\/dot/ and not ENV['NODOT']
   rd.rdoc_dir = 'doc'
-  rd.template = 'template/jamis.rb'
+  rd.template = 'config/jamis.rb'
   files = $hoe.spec.files.grep($hoe.rdoc_pattern)
   files -= ['Manifest.txt']
   rd.rdoc_files.push(*files)

data/accounts_models.rb

@@ -1,12 +1,11 @@
 require 'clevic.rb'
 
-# db connection options
-$options ||= {}
-$options[:database] ||= $options[:debug] ? 'accounts_test' : 'accounts'
-$options[:adapter]  ||= 'postgresql'
-$options[:host] ||= 'localhost'
-$options[:username] ||= 'panic'
-$options[:password] ||= ''
+# db connection
+Clevic::DbOptions.connect( $options ) do
+  database( debug? ? :accounts_test : :accounts )
+  adapter :postgresql
+  username 'panic'
+end
 
 class Entry < ActiveRecord::Base
   include ActiveRecord::Dirty
@@ -96,27 +95,3 @@ end
 
 # order of tab display
 $options[:models] = [ Entry, Account ]
-
-# This is a read-only view, which is currently not implemented
-#~ class Values < ActiveRecord::Base
-  #~ include ActiveRecord::Dirty
-  #~ set_table_name 'values'
-  #~ has_many :debits, :class_name => 'Entry', :foreign_key => 'debit_id'
-  #~ has_many :credits, :class_name => 'Entry', :foreign_key => 'credit_id'
-  #~ def self.ui( parent )
-    #~ Clevic::TableView.new( self, parent ).create_model do
-      #~ readonly
-      #~ plain       :date
-      #~ plain       :description
-      #~ plain       :debit
-      #~ plain       :credit
-      #~ plain       :pre_vat_amount
-      #~ plain       :cheque_number
-      #~ plain       :vat, :label => 'VAT'
-      #~ plain       :financial_year
-      #~ plain       :month
-      
-      #~ records :order => 'date'
-    #~ end
-  #~ end
-#~ end

data/bin/clevic

@@ -1,8 +1,6 @@
 #! /usr/bin/ruby
 
 require 'clevic/browser.rb'
-require 'ruby-debug'
-
 require 'optparse'
 
 # find and require variations on file_path
@@ -30,7 +28,7 @@ oparser.on( '-D', '--debug' ) { |o| $options[:debug] = true }
 oparser.on( '-v', '--verbose' ) { |o| $options[:verbose] = true }
 oparser.on( '-h', '-?', '--help' ) do |o|
   puts oparser.to_s
-  exit( 0 )
+  exit( 1 )
 end
 
 args = oparser.parse( ARGV )
@@ -45,13 +43,6 @@ end
 
 app = Qt::Application.new( args )
 
-unless $options.has_key? :database
-  raise "Please define $options[:database]"
-end
-
-# connect to db
-require 'clevic/db_options.rb'
-
 # show UI
 main_window = Qt::MainWindow.new
 browser = Clevic::Browser.new( main_window )

data/bin/import-times

@@ -0,0 +1,128 @@
+#! /usr/bin/ruby
+
+require 'yaml'
+require 'times_models.rb'
+require 'optparse'
+
+$options = {}
+oparser = OptionParser.new
+oparser.on( '-H', '--host HOST', 'RDBMS host', String ) { |o| $options[:host] = o }
+oparser.on( '-u', '--user USERNAME', String ) { |o| $options[:user] = o }
+oparser.on( '-p', '--pass PASSWORD', String ) { |o| $options[:password] = o }
+oparser.on( '-t', '--table TABLE', 'Table to display', String ) { |o| $options[:table] = o }
+oparser.on( '-d', '--database DATABASE', 'Database name', String ) { |o| $options[:database] = o }
+oparser.on( '-D', '-v', '--debug' ) { |o| $options[:debug] = true }
+oparser.on( '-h', '-?', '--help' ) do |o|
+  puts oparser.to_s
+  exit( 0 )
+end
+
+oparser.parse!( ARGV )
+
+require 'clevic/db_options.rb'
+puts "using database #{ActiveRecord::Base.connection.raw_connection.db}" if $options[:debug]
+
+st =
+if ARGV[0].nil?
+  raise ( "provide a yml file that looks like this: " + <<EOF )
+#~ dd-mmm-yyyy:
+  #~ project:
+  #~ - [08h00, 17h00, whatever, <yes|no (charge)>|<activity>]
+
+28-apr-2008:
+  stackpro:
+  - [20h01, 23h03, Research on using Matrices for stackpro]
+  
+29-apr-2008:
+  stackpro:
+  - [20h01, 22h43, Working on Stackpro]
+  - [23h02, 23h30, More on test cases]
+  clevic:
+  - [22h43, 23h02, yaml for times]
+
+30-apr-2008:
+  stackpro:
+  - [19h45, 21h10, Trying both directions]
+  - [21h10, 21h59, Has to be a pull pipeline]
+  - [21h59, 23h00, get 3 ops working]
+  - [23h00, 23h55, do stack algorithm]
+
+01-may-2008:
+  stackpro:
+  - [18h54, 20H34, fighting with eof]
+
+02-may-2008:
+  stackpro:
+  - [07h50, 08h32, fighting with eof]
+  - [19h23, 20h09, simplify testing]
+  - [21h03, 22h30, do stackpro bin]
+  
+03-may-2008:
+  stackpro:
+  - [07h50, 08h32, fighting with eof]
+  unwreck:
+  - [12h50, 15h05, start project. Do some initial coding and testing.]
+
+04-may-2008:
+  unwreck:
+  - [19h11, 19h31, find a way to store the jobs]
+  - [21h15, 21h34, find a way to store the jobs]
+  - [21h34, 23h01, Do DirectoryStorage. Improve sampling.]
+  - [23h01, 23h18, Ask for force for pre-existing job.]
+
+05-may-2008:
+  unwreck:
+  - [13h32, 14h15, build index]
+  - [20h30, 22h05, fetch using index and compare]
+  - [22h05, 22h53, doing file cleanups and serialisation]
+
+19-may-2008:
+  unwreck:
+  - [12h30, 12h50, Travel to CIM (because Warren missed the meeting)]
+  - [12h50, 13h20, Chat to Gavin, no]
+  - [13h20, 15h40, Work on stackpro and unwreck]
+  - [15h40, 16h05, Travel home]
+  - [22h03, 22h42, Work on stackpro]
+  
+21-may-2008:
+  unwreck:
+  - [6h30, 7h21, start on header line]
+  - [8h55, 10h36, finish header line]
+EOF
+else
+  File.read( ARGV[0] )
+end
+
+def process( data_structure )
+  Entry.transaction do
+    coding = Activity.find_by_activity 'Coding'
+    data_structure.keys.each do |key|
+      date = Date.parse( key )
+      day = data_structure[key]
+      day.keys.each do |project_key|
+        project = Project.find_by_project project_key
+        raise "project #{project_key} not in database" if project.nil?
+        invoice = project.latest_invoice
+        
+        times = day[project_key]
+        times.each do |entry_arr|
+          entry = Entry.new( :project => project, :invoice => invoice, :date => date, :rate => project.rate )
+          entry.start = entry_arr[0]
+          entry.end = entry_arr[1]
+          entry.description = entry_arr[2]
+          
+          if entry_arr[3] == true || entry_arr[3] == false
+            entry.charge = entry_arr[3]
+          else
+            entry.activity = entry_arr[3] || coding
+          end
+          
+          entry.save
+          puts "entry: #{entry.inspect}"
+        end
+      end
+    end
+  end
+end
+
+process( YAML.load( st ) )

data/config/hoe.rb

@@ -0,0 +1,76 @@
+require 'clevic/version'
+
+AUTHOR = 'John Anderson'  # can also be an array of Authors
+EMAIL = "panic@semiosix.com"
+DESCRIPTION = "SQL table GUI with Qt"
+GEM_NAME = 'clevic' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'clevic' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+    ['qtext', '>=0.2.0'],
+    ['activerecord', '>=2.0.2']
+    # This isn't always installed from gems
+    #~ ['qtruby4', '>=1.4.9']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "panic"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Clevic::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'clevic documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/env.sh

@@ -0,0 +1 @@
+export RUBYLIB=$RUBYLIB:`pwd`/lib

data/lib/clevic.rb

@@ -1,3 +1,4 @@
+require 'clevic/db_options.rb'
 require 'clevic/table_view.rb'
 require 'clevic/model_builder.rb'
 

data/lib/clevic/cache_table.rb

@@ -62,7 +62,9 @@ known entity in the set requires a defined ordering, so if no ordering
 is specified, the primary key of the entity will be used.
 
 It hasn't been tested with compound primary keys.
+
 --
+
 TODO drop rows when they haven't been accessed for a while
 
 TODO how to handle a quickly-changing underlying table? invalidate cache

data/lib/clevic/db_options.rb

@@ -1,18 +1,88 @@
 require 'active_record'
 
-# these will normally be defined fully in the model definition file
-# $options[:database] to be defined with the models
-$options ||= {}
-$options[:adapter]  ||= 'postgresql'
-$options[:host] ||= 'localhost'
-$options[:username] ||= ''
-$options[:password] ||= ''
+module Clevic
+=begin rdoc
+This class is intended to set up db options for a ActiveRecord
+connection to a particular database. Like this:
 
-ActiveRecord::Base.establish_connection( $options )
-ActiveRecord::Base.logger = Logger.new(STDOUT) if $options[:verbose]
-#~ ActiveRecord.colorize_logging = false
+  Clevic::DbOptions.connect( $options ) do
+    database :accounts
+    adapter :postgresql
+    username 'panic'
+  end
+
+When the block ends, a check is done to see that the :database key
+exists. If not and exception is thrown. Finally the relevant calls to
+ActiveRecord are performed.
 
-puts "using database #{ActiveRecord::Base.connection.raw_connection.db}" if $options[:debug]
+Method calls are translated to insertions into a hash with the same
+key as the method being called. The hash is initialised
+with the options value passed in (in this case $options).
+Values have to_s called on them so they can be symbols or strings.
+=end
+class DbOptions
+  def initialize( options )
+    @options = options || {}
+    # make sure the relevant entries exist, so method_missing works
+    @options[:adapter] ||= ''
+    @options[:host] ||= ''
+    @options[:username] ||= ''
+    @options[:password] ||= ''
+    @options[:database] ||= ''
+  end
+  
+  def connect( *args, &block )
+    # using the Rails implementation, included in Qt
+    block.bind( self )[*args]
+    do_connection
+  end
+  
+  # do error checking and make the ActiveRecord connection calls.
+  def do_connection
+    unless @options[:database]
+      raise "Please define database using DbOptions"
+    end
+    
+    # connect to db
+    ActiveRecord::Base.establish_connection( @options )
+    ActiveRecord::Base.logger = Logger.new(STDOUT) if @options[:verbose]
+    #~ ActiveRecord.colorize_logging = @options[:verbose]
+    puts "using database #{ActiveRecord::Base.connection.raw_connection.db}" if $options[:debug]
+  end
+  
+  # convenience method so we can do things like
+  #   Clevic::DbOptions.connect( $options ) do
+  #     database :accounts
+  #     adapter :postgresql
+  #     username 'panic'
+  #   end
+  # the block is evaluated in the context of the a new DbOptions
+  # object.
+  def self.connect( args, &block )
+    inst = self.new( args )
+    # using the Rails implementation, included in Qt
+    block.bind( inst )[*args]
+    inst.do_connection
+  end
+  
+  # translate method calls in the context of an instance
+  # of this object to setting values in the @options
+  # variable
+  def method_missing(meth, *args, &block)
+    if @options.has_key? meth.to_sym
+      @options[meth.to_sym] = args[0].to_s
+    else
+      super
+    end
+  end
+  
+  # convenience to find out if we're in debug mode
+  def debug?
+    @options[:debug] == true
+  end
+end
+
+end
 
 # workaround for the date freeze issue
 class Date