olsen 0.0.5 → 0.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    olsen (0.0.3)
+    olsen (0.0.5)
       sadie
 
 GEM
@@ -14,7 +14,7 @@ GEM
       deprecated (= 2.0.1)
     deprecated (2.0.1)
     mysql (2.8.1)
-    sadie (0.0.34)
+    sadie (0.0.35)
       dbd-mysql
       dbi
       mysql

data/README

@@ -1 +1,17 @@
-Olsen is a simple reporter.  More later.
+=Olsen
+==A simple reporter.
+
+===Overview
+Olsen is a framework that wraps the Sadie gem and provides a facility for producing reports which make use of data managed in a Sadie-style primer chassis.
+
+===Usage
+1. create/choose a directory to put the olsen framework in (or use /var/olsen, the default...ensure writable)
+2. call olsen -init [ -framework-dir /my/dir ]
+3. define jobs in jobs folder and filters, outputs, and inbound data primers in primers folder
+4. call olsen -process <job>
+5. find output product in output folder
+6. Rejoice!
+
+===Todo
+* enable a 'olsen -init -with-examples' that will create a functioning olsen framework with example ini files, sqlite databases and queries, pdf outputs, formatting filters, etc.
+* provide docs on job and pdf ini-file format

data/bin/olsen

@@ -1,14 +1,69 @@
 #!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
-# run report for each input file
-nomoreopts = false
-ARGV.each do |infile|
-    
-    
-    puts "processing: #{infile}"
-    
-    Olsen.process infile
-    
-    
+require 'olsen'
+
+# define usage writer
+def write_usage( msg=nil )
+    if defined? msg
+        puts "\n===  ERR: #{msg} ===\n\n"
+    end
+    usage_text = <<TXT
+
+    # to init framework with examples
+    olsen -init -framework-dir <dir>  # defaults to /var/olsen
+
+    # to process jobs
+    olsen -process [-framework-dir <dir>] <job1> <job2> ... <jobn>
+
+TXT
+    puts "USAGE:\n#{usage_text}"
+end
+
+# validate args
+if ARGV.length < 1
+    write_usage "not enough arguments"
+    exit
 end
 
+mainarg                 = ARGV.first
+secarg                  = ARGV[1]
+framework_dirpath       = "/var/olsen"
+restargs                = ARGV[1..(ARGV.length-1)]
+if secarg == "-framework-dir"
+    if ARGV.length < 3
+        write_usage "no framework dir given"
+        exit
+    end
+    framework_dirpath   = ARGV[2]
+    if mainarg == "-process"
+        if ARGV.length < 4
+            write_usage "no jobs listed"
+            exit
+        end
+        restargs        = ARGV[3..(ARGV.length-1)]
+    end
+end
+
+Olsen.setFrameworkDir framework_dirpath
+
+if ARGV.length > 0
+    case mainarg
+    when "-process"
+        # process each input file
+        restargs.each do |infile|
+            puts "processing: #{infile}"
+            Olsen.process infile
+        end
+    when "-init"
+        if ! File.writable? framework_dirpath
+            write_usage "directory not writable (#{framework_dirpath})"
+        end
+        Olsen.initFramework
+    else
+        write_usage
+        exit
+    end
+end
+
+

data/lib/olsen.rb

@@ -12,7 +12,6 @@ def O( key, params=nil )
     if defined? params
         if params.respond_to? "has_key?"
             if params.has_key? :filter
-#                 puts "got filter!!!"
                 filter = params[:filter]
                 if filter.respond_to? "each"
                     ret = Olsen::filter instance.get( key ), filter
@@ -24,7 +23,6 @@ def O( key, params=nil )
             end
         end
     end
-#     puts "O(#{key}): NO PARAMS?"
     instance.get( key )
     
 end
@@ -33,8 +31,6 @@ class Olsen
     
     def self.filter( value, filters )
         
-#         puts "filters: #{filters}"
-        
         # validate filters
         defined? filters \
             or return value
@@ -43,13 +39,9 @@ class Olsen
         
         instance = Sadie::getCurrentSadieInstance
         
-        #pp(instance)
-        
         fhnd = "filter.#{filters[0]}"
         f = instance.get fhnd
         
-#         puts "f(#{fhnd}): #{f}"
-        
         if filters.length > 1
             rem = filters[1..(filters.length-1)]
             ret = f.call value
@@ -61,14 +53,24 @@ class Olsen
         end
     end
     
+    def self.initFramework
+        if ! defined? @@framework_dirpath
+            puts "framework dirpath not set...aborting."
+            return nil
+        end        
+        puts "initializing olsen framework in #{@@framework_dirpath}"
+        [ "output", "jobs", "primers" ].each do |dir|
+            Dir.mkdir File.join( @@framework_dirpath, dir )
+        end
+    end
+    
+    def self.setFrameworkDir( dirpath )
+        @@framework_dirpath = dirpath
+    end
+    
     def self.registerFilter( name, &block )
         instance = Sadie::getCurrentSadieInstance
         instance.set "filter.#{name}", block
-#         if ! defined? @@filters
-#             @@filters = { name => block }
-#         else
-#             @@filters[name] = block
-#         end
     end
     
     def self.initSadie( params )
@@ -99,10 +101,19 @@ class Olsen
         end
         
         # init sadie
-#         puts "init storage!"
         storage = Sadie::getSadieInstance( sadieparams )
         
-        
+        # add olsen plugin handlers
+        plugins_dirpath = File.join(
+            ENV['GEM_HOME'],
+            "gems/olsen-#{Olsen::VERSION}",
+            "lib/olsen/primer_plugins"
+        )
+        if ! File.exists? plugins_dirpath   # for dev
+            plugins_dirpath = "lib/olsen/primer_plugins"
+        end        
+        storage.addPrimerPluginsDirPath plugins_dirpath
+        storage.initializePrimers
     end
     
     def self.process( job, storage )
@@ -112,9 +123,16 @@ class Olsen
             return nil
         end
         
+        # turn files into hashes
         if ! job.respond_to? "each"
             if File.exists? job
                 job = Sadie::iniFileToHash( job )
+            elsif defined? @@framework_dirpath
+                jobdirpath = File.join( @@framework_dirpath, "jobs" )
+                jobfile = File.join jobdirpath, "#{job}.job" 
+                if File.exists? jobfile
+                    job = Sadie::iniFileToHash( jobfile )
+                end
             else
                 puts "job param was non-hash and was not a path to valid job file"
                 return nil
@@ -126,29 +144,9 @@ class Olsen
             puts "job has no output definition"
             return nil
         end
-        
-#         sadieparams = {
-#             "sadie.primer_plugins_dirpath" => "lib/olsen/primer_plugins",
-#             "sadie.primers_dirpath" => "primers"
-#         }
-        
-        # set keys from job
-#         [ "sadie", "parameters","olsen" ].each do |ptype|
-#             if job.has_key? ptype 
-#                 job[ptype].each do |key,value|
-#                     if ptype.eql? "sadie"
-#                         sadieparams["sadie.#{key}"] = value
-#                     else
-#                         sadieparams["#{key}"] = value
-#                     end
-#                 end
-#             end
-#         end
-        
-
-        
-        
+                
         # call output triggers
+        storage = Sadie::getCurrentSadieInstance
         job["output"].each do |x,type|
             outputkey = "output.#{type}"
             puts "processing output trigger: #{outputkey}"

data/lib/olsen/version.rb

@@ -1,3 +1,3 @@
 class Olsen
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/test/tc_initframework.rb

@@ -0,0 +1,39 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$:.unshift ENV["GEM_HOME"]
+
+require "test/unit"
+require "sadie"
+require "olsen"
+require "tmpdir"
+
+class TestInitFramework < Test::Unit::TestCase
+    def test_simple
+        #ofdir = "test/olsen_framework_test"
+        
+        Dir.mktmpdir("olsen_testdir") do | dir |
+        
+            # create temp output and sessdirs
+            outputdir = File.join( dir, "output" )
+            Dir.mkdir outputdir
+            sessdir = File.join( dir, "session" )
+            Dir.mkdir sessdir
+            
+            s = Olsen::initSadie( "sadie.primers_dirpath" => "#{ofdir}/primers",
+                                  "sadie.sessions_dirpath" => sessdir,
+                                  "olsen.output_dirpath" => outputdir  )
+
+            # --------------- test pdf ---------------
+            # process some olsenry
+            output = nil
+            Olsen::process( File.join( ofdir, "jobs/outputtest_pdf.job" ),s  ) do |sadie|
+            
+            
+                # test
+                output_path = sadie.get( "output.outputtest_pdf.pdf" )
+                output = File.exists? output_path
+            end
+            assert_equal( output, true   )
+
+        end
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: olsen
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000Z
+date: 2012-04-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sadie
-  requirement: &13544120 !ruby/object:Gem::Requirement
+  requirement: &11535020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13544120
+  version_requirements: *11535020
 description: Olsen is a reporting tool intended to be used with Sadie.
 email:
 - fred@landmetrics.com
@@ -46,7 +46,6 @@ files:
 - lib/olsen/primer_plugins/Filter.plugin.rb
 - lib/olsen/primer_plugins/PDFINI.plugin.rb
 - lib/olsen/version.rb
-- olsen-0.0.2.gem
 - olsen.gemspec
 - test/olsen_framework_test/jobs/outputtest_filter.job
 - test/olsen_framework_test/jobs/outputtest_ltx.job
@@ -67,6 +66,7 @@ files:
 - test/olsen_framework_test/primers/output/outputtext_tex.tex.erb
 - test/olsen_framework_test/primers/testdata.ini
 - test/tc_framework_outputtest.rb
+- test/tc_initframework.rb
 - test/tc_outputpdf.rb
 - test/tc_outputsimple.rb
 homepage: http://www.landmetrics.com/Olsen