olsen 0.0.3 → 0.0.4

data/.gitignore

@@ -1,2 +1,3 @@
 *~
+*.gem
 

data/CHANGELOG

@@ -0,0 +1,2 @@
+[0.0.4] initial public release...working in a lot of ways, but no docs
+

data/Gemfile.lock

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

data/Rakefile

@@ -3,6 +3,11 @@ require "bundler/gem_tasks"
 require 'rake'
 require 'rdoc/task'
 
+task :test do
+    ruby "test/tc_outputsimple.rb"
+    ruby "test/tc_outputpdf.rb"
+end
+
 task :deploy => 'inc_version' do
     version = current_olsen_version
     sh "git push"

data/lib/olsen.rb

@@ -1,44 +1,182 @@
+require 'pp'
+
+def O( key, params=nil )
+    
+    instance = Sadie::getCurrentSadieInstance
+
+    if ! defined? instance 
+        puts "err: getCurrentSadieInstance returned nil"
+        return nil
+    end
+      
+    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
+                    return ret
+                else
+                    ret = Olsen::filter instance.get( key ), [filter]
+                    return ret
+                end
+            end
+        end
+    end
+#     puts "O(#{key}): NO PARAMS?"
+    instance.get( key )
+    
+end
+
 class Olsen
-    def self.process( job )
+    
+    def self.filter( value, filters )
+        
+#         puts "filters: #{filters}"
+        
+        # validate filters
+        defined? filters \
+            or return value
+        filters.respond_to? "each" \
+            or return value
+        
+        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
+            ret = Olsen.filter f.call(ret), rem
+            return ret
+        else
+            ret = f.call value
+            return ret
+        end
+    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 )
+        sadieparams = {
+            "sadie.primer_plugins_dirpath" => "lib/olsen/primer_plugins",
+            "sadie.primers_dirpath" => "primers"
+        }
+        
+        # if session and output dirs not defined, create temp dirs and use them
+        if ! sadieparams.has_key? "sadie.sessions_dirpath"
+            Dir.mktmpdir("olsen_tmp_sess") do | dir |
+                sadieparams["sadie.sessions_dirpath"] =  dir
+            end
+        end
+        if ! sadieparams.has_key? "olsen.output_dirpath"
+            Dir.mktmpdir("olsen_output") do | dir |
+                sadieparams["olsen.output_dirpath"] =  dir
+            end
+        end
+
+        # process params
+        if defined? params
+            if params.respond_to? "each"
+                params.each do |k,v|
+                    sadieparams[k] = v
+                end
+            end
+        end
+        
+        # init sadie
+#         puts "init storage!"
+        storage = Sadie::getSadieInstance( sadieparams )
+        
+        
+    end
+    
+    def self.process( job, storage )
         
         if ( ! defined?( job ) )
             puts "job parameter was undefined.  must be hash or file.  returning nil."
             return nil
         end
         
-        if job.respond_to?( "each" )
-            
-            return self._processHash( job )
-            
-        elsif File.exists? job
-            
-            j = Sadie::iniFileToHash( job )
-            
-            if ( ! defined?( j ) )
-                puts "Unable to interpret job ini file: #{job}.  returning nil."
+        if ! job.respond_to? "each"
+            if File.exists? job
+                job = Sadie::iniFileToHash( job )
+            else
+                puts "job param was non-hash and was not a path to valid job file"
                 return nil
             end
-            
-            return self._processHash( j )
-            
         end
         
-        puts "Unintelligible job param. returning nil."
-        return nil
-    end
-    
-    def self._processHash( job )
-        # init sadie
-        storage = Sadie::getSadieInstance( job["parameters"] )
-        
-        # set sadie-specific keys
-        job["sadie"].each do |key,value|
-            storage.set "sadie.#{key}", value
+        # validate job
+        if ! job.has_key? "output"
+            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
-        job.["output"].each do |x,type|
-            storage.output type
+        job["output"].each do |x,type|
+            outputkey = "output.#{type}"
+            puts "processing output trigger: #{outputkey}"
+            storage.output outputkey
+        end
+        
+        if block_given?
+            yield storage
         end
+        
+    end
+
+    def registerFilter( filter, &block )
+        defined? @filters \
+            or @filters = Hash.new
+        
+        @filters["filter"] = block
     end
+    
+    def filter( filter_name, value )
+        defined? @filters \
+            or return nil
+        @filters.respond_to? "has_key?" \
+            or return nil
+        @filters.has_key? filter_name \
+            or return nil
+        f = @filters[filter_name]
+        f.call value
+    end
+    
 end

data/lib/olsen/primer_plugins/ERBOutput.plugin.rb

@@ -0,0 +1,32 @@
+require 'erb'
+Sadie::registerPrimerPlugin( { "match" => /\.erb$/,
+                               "accepts-block" => false,
+                               "prime-on-init" => false } ) do |sadie, key_prefix, primer_file_filepath|
+    
+    
+    # determine output filename
+    output_filename = File.basename( primer_file_filepath )
+    output_filename = output_filename.gsub(/\.erb$/,"")
+    
+    # determine sadie key
+    sadie_key = "#{key_prefix}.#{output_filename}"
+    #puts "priming with primer file: #{primer_file_filepath}, sadie key: #{sadie_key}"
+    
+    Sadie::prime( { "provides" => [ sadie_key ] } ) do |sadie|
+        
+        output_contents = Sadie::templatedFileToString( primer_file_filepath )
+        
+        # write results to output file
+        output_dirpath = sadie.get "olsen.output_dirpath"
+        output_filepath = File.join(output_dirpath,output_filename)
+        File.open( output_filepath, "w" ) do |f|
+            f.print output_contents
+#             puts "contents: #{output_contents}"
+        end
+        
+        # set a sadie key/val for output file path
+        puts "setting erb output key: #{sadie_key} to value: #{output_filepath}"
+        sadie.set( sadie_key, output_filepath )
+    end
+    
+end

data/lib/olsen/primer_plugins/Filter.plugin.rb

@@ -0,0 +1,30 @@
+Sadie::registerPrimerPlugin( { "match" => /\.filter.rb$/,
+                               "accepts-block" => false,
+                               "prime-on-init" => false } ) do |sadie, key_prefix, primer_file_filepath|
+    
+    # basically, just loading a ruby file
+    load primer_file_filepath
+    
+#     primer_file_basename = File.basename( primer_file_filepath )
+#     output_filename = primer_file_basename
+#     output_filename.gsub(/\.erb$/,"")
+#     sadie_key = key_prefix + '.' + primer_file_basename
+#     sadie_key = sadie_key.gsub(/^\./,"")
+#     sadie_key = sadie_key.gsub(/\.erb$/,"")
+#     Sadie::prime( { "provides" => sadie_key } ) do |sadie|
+#         
+#         # run erb
+#         input_contents = File.open(primer_file_filepath, 'r') { |f| f.read }
+#         template = ERB.new( input_contents )
+#         output_contents = template.result
+#         
+#         # write results to output file
+#         output_dirpath = sadie.get "olsen.output_dirpath"
+#         File.open( File.join(output_dirpath,output_filename), "w" ) do |f|
+#             f.print output_contents
+#         end
+#         
+#         # set output filepath to sadie_key
+#         sadie.set( sadie_key, File.join(output_dirpath,output_filename) )
+#     end
+end

data/lib/olsen/primer_plugins/PDFINI.plugin.rb

@@ -0,0 +1,77 @@
+require 'pp'
+Sadie::registerPrimerPlugin( {  "match" => /\.pdf\.ini$/,
+                                "accepts-block" => false,
+                                "prime-on-init" => true } ) do |sadie, key_prefix, primer_file_filepath|
+    
+    puts "processing pdf ini file: #{primer_file_filepath}"
+    
+    ini_file_basename = File.basename primer_file_filepath
+    ini_file_root = ini_file_basename.gsub( /\.pdf\.ini$/, "" )
+    
+    output_filename = "#{ini_file_root}.pdf"
+    
+    sadie_key = "output.#{output_filename}"
+    
+    if pdfparams = Sadie::iniFileToHash( primer_file_filepath )
+        
+        # validate pdfparams
+        if ! defined? pdfparams
+            puts "iniFileToHash returned nil...aborting"
+            return nil
+        end
+        
+        if ! pdfparams.respond_to? "has_key?"
+            puts "initFileToHash returned unusable param set...aborting"
+            return nil
+        end
+        
+        if pdfparams.has_key? "pdf"
+            secpdf = pdfparams["pdf"]
+            if secpdf.respond_to? "has_key?"
+                if secpdf.has_key? "type"
+                    case secpdf["type"]
+                    when "latexmk"
+                        
+                        # determine bin to latexmk
+                        cmd = "/usr/bin/latexmk"
+                        template = "output.#{ini_file_root}.tex"
+                        if pdfparams.has_key? "latexmk"
+                            
+                            latexmkparams = pdfparams["latexmk"]
+                            if latexmkparams.has_key? "path_to_latexmk"
+                                if "#{latexmkparams['path_to_latexmk']}" !~ /^\s*$/
+                                    cmd = latexmkparams['path_to_latexmk']
+                                end
+                            end
+                            if latexmkparams.has_key? "template"
+                                if "#{latexmkparams['template']}" !~ /^\s*$/
+                                    template = latexmkparams['template']
+                                end
+                            end
+                        end
+                        
+                        Sadie::prime( { "provides" => [ sadie_key ] } ) do |sadie|
+                            
+                            # gen output
+                            template_filepath = sadie.get( template )
+                            dirpath = File.dirname template_filepath
+                            puts "dirpath: #{dirpath}"
+                            filepath = File.basename template_filepath
+                            system "cd #{dirpath}; #{cmd} -f -pdf #{filepath};"
+                            
+                            outpath = File.join dirpath, output_filename 
+                            
+                            puts "setting s[#{sadie_key}]: #{outpath}"
+                            sadie.set sadie_key, outpath
+                            
+                        end
+                    else
+                        puts "unsupported pdf type: #{secpdf['type']}"
+                        return nil
+                    end
+                end
+            end
+        end
+    end    
+    
+end

data/lib/olsen/version.rb

@@ -1,3 +1,3 @@
 class Olsen
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/olsen_framework_test/jobs/outputtest_filter.job

@@ -0,0 +1,2 @@
+[output]
+o1 = outputtest_filter.txt

data/test/olsen_framework_test/jobs/outputtest_pdf.job

@@ -0,0 +1,2 @@
+[output]
+o1=outputtest_pdf.pdf

data/test/olsen_framework_test/jobs/outputtest_simple.job

@@ -0,0 +1,2 @@
+[output]
+o1=outputtest_simple.txt

data/test/olsen_framework_test/primers/filters/testfilter1.filter.rb

@@ -0,0 +1,3 @@
+Olsen::registerFilter( "testfilter1" ) do |input|
+    output = "[" + input + "]"
+end

data/test/olsen_framework_test/primers/filters/testfilter2.filter.rb

@@ -0,0 +1,3 @@
+Olsen::registerFilter( "testfilter2" ) do |input|
+    output = "{" + input + "}"
+end

data/test/olsen_framework_test/primers/output/outputtest_filter.txt.erb

@@ -0,0 +1,4 @@
+item1: <%= S("testdata.group.item1") %>
+item2: <%= O("testdata.group.item2") %>
+item3: <%= O("testdata.group.item1", :filter => "testfilter1" ) %>
+item4: <%= O("testdata.group.item2", :filter => ["testfilter1","testfilter2"] ) %>

data/test/olsen_framework_test/primers/output/outputtest_pdf.pdf.ini

@@ -0,0 +1,6 @@
+[pdf]
+type = latexmk
+
+[latexmk]
+path_to_latexmk = /usr/bin/latexmk
+template = output.outputtest_pdf.tex

data/test/olsen_framework_test/primers/output/outputtest_pdf.tex.erb

@@ -0,0 +1,4 @@
+\documentclass{article}
+\begin{document}
+A Minimal LaTeX Document
+\end{document}

data/test/olsen_framework_test/primers/output/outputtest_simple.txt.erb

@@ -0,0 +1,2 @@
+item1: <%= S("testdata.group.item1") %>
+item2: <%= S("testdata.group.item2") %>

data/test/olsen_framework_test/primers/output/outputtext_minimal.tex.erb

@@ -0,0 +1,4 @@
+\documentclass{article}
+\begin{document}
+A Minimal LaTeX Document
+\end{document}

data/test/olsen_framework_test/primers/output/outputtext_minimal.tex2pdf

@@ -0,0 +1 @@
+[latexmk]

data/test/olsen_framework_test/primers/output/outputtext_tex.tex.erb

@@ -0,0 +1,4 @@
+\documentclass{article}
+\begin{document}
+A Minimal LaTeX Document
+\end{document}

data/test/olsen_framework_test/primers/testdata.ini

@@ -0,0 +1,3 @@
+[group]
+item1 = "item txt 1"
+item2 = item txt 2

data/test/tc_outputpdf.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 TestPDFOutput < 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

data/test/tc_outputsimple.rb

@@ -0,0 +1,49 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+$:.unshift ENV["GEM_HOME"]
+
+require "test/unit"
+require "sadie"
+require "olsen"
+require "tmpdir"
+
+class TestSimpleOutput < 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 1: simple ---------------
+            # process some olsenry
+            output = nil
+            Olsen::process( File.join( ofdir, "jobs/outputtest_simple.job" ),s  ) do |sadie|
+            
+            
+                # test
+                output_path = sadie.get( "output.outputtest_simple.txt" )
+                output = File.open( output_path, "r" ) { |f| f.read }
+            end
+            assert_equal( output, "item1: item txt 1\nitem2: item txt 2\n"    )
+
+            # --------------- test 2: filter ---------------
+            # process some olsenry
+            Olsen::process( File.join( ofdir, "jobs/outputtest_filter.job" ),s ) do |sadie|
+            
+                # test
+                output_path = sadie.get( "output.outputtest_filter.txt" )
+                output = File.open( output_path, "r" ) { |f| f.read }
+            end
+            assert_equal( output, "item1: item txt 1\nitem2: item txt 2\nitem3: [item txt 1]\nitem4: {[[item txt 2]]}\n"    )
+            
+        end
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: olsen
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-13 00:00:00.000000000Z
+date: 2012-04-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sadie
-  requirement: &20084920 !ruby/object:Gem::Requirement
+  requirement: &11029180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20084920
+  version_requirements: *11029180
 description: Olsen is a reporting tool intended to be used with Sadie.
 email:
 - fred@landmetrics.com
@@ -42,9 +42,34 @@ files:
 - TODO
 - bin/olsen
 - lib/olsen.rb
+- lib/olsen/primer_plugins/ERBOutput.plugin.rb
+- 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
+- test/olsen_framework_test/jobs/outputtest_ltx2pdf.job
+- test/olsen_framework_test/jobs/outputtest_pdf.job
+- test/olsen_framework_test/jobs/outputtest_simple.job
+- test/olsen_framework_test/jobs/outputtest_txt.job
+- test/olsen_framework_test/primers/filters/filterstub.filter.rb
+- test/olsen_framework_test/primers/filters/testfilter1.filter.rb
+- test/olsen_framework_test/primers/filters/testfilter2.filter.rb
+- test/olsen_framework_test/primers/output/market-areas.tex.erb
+- test/olsen_framework_test/primers/output/outputtest.tex.erb
+- test/olsen_framework_test/primers/output/outputtest_filter.txt.erb
+- test/olsen_framework_test/primers/output/outputtest_pdf.pdf.ini
+- test/olsen_framework_test/primers/output/outputtest_pdf.tex.erb
+- test/olsen_framework_test/primers/output/outputtest_simple.txt.erb
+- test/olsen_framework_test/primers/output/outputtext_minimal.tex.erb
+- test/olsen_framework_test/primers/output/outputtext_minimal.tex2pdf
+- test/olsen_framework_test/primers/output/outputtext_tex.tex.erb
+- test/olsen_framework_test/primers/testdata.ini
+- test/tc_framework_outputtest.rb
+- test/tc_outputpdf.rb
+- test/tc_outputsimple.rb
 homepage: http://www.landmetrics.com/Olsen
 licenses: []
 post_install_message: