sadie 0.0.11 → 0.0.12

data/CHANGELOG

@@ -3,4 +3,5 @@
 [0.0.8] abstracted primer types such that sadie can now use plugins.  with two working plugins, IniFile and Resource, it is functionaly equivalent to v0.0.7.  More to come.
 [0.0.9] primer logic bugfix, added sql and db connection primer types
 [0.0.10] sql plugin handler became sql2ar to better reflect what's going on
-[0.0.11] updated documentation
+[0.0.11] updated documentation
+[0.0.12] updated documentation, Rakefile, code cleanups

data/README

@@ -17,3 +17,16 @@ It's very simple to add new primer types, so it would be simple to create primer
 At Landmetrics, we use a predecessor to Sadie to power perimetercomps[http://perimetercomps.com], producing each 50+ page report with charts, graphs and tables with only 12 queries to the database.
 
 Sadie can be downloaded via its rubygems page[https://rubygems.org/gems/sadie] or from github[https://github.com/FredAtLandMetrics/sadie].
+
+USE CASES
+
+[templating]    As noted above, perimetercomps[http://perimetercomps.com] is an example of how one might
+                use sadie to to create a templating engine wherein many pieces of related information
+                from many different sources are made into charts, graphs, tables and text before being
+                assembled into a single deliverable document.  We used LaTeX, but html, xml, css, txt, etc.
+                would be just as easy.
+
+[data import]   Tasks involving grabbing data from different places in different formats and
+                massaging the data into a consistent and useful format.  A few simple primer plugins
+                would make this very easy.
+                

data/Rakefile

@@ -10,13 +10,43 @@ task :test do
     ruby "test/tc_sadie_twodeep.rb"
 end
 
-# task :rdoc do
-#     
-# end
+task :deploy => 'inc_version' do
+    version = current_sadie_version
+    sh "git push"
+    sh "gem build sadie.gemspec"
+    sh "gem push sadie-#{version}.gem"
+end
+
+task :inc_version do
+    version = current_sadie_version
+    if (matches = version.match(/^(\d+\.\d+\.)(\d+)$/))
+        pre = matches[1]
+        post = Integer(matches[2]) + 1
+        version = "#{pre}#{post}"
+    end
+    fh = File.open("lib/sadie/version.rb","w")
+    fh.puts "class Sadie"
+    fh.puts '  VERSION = "' + version + '"'
+    fh.puts "end"
+    fh.close
+    puts "incremented sadie version to #{version}"
+end
+
 Rake::RDocTask.new do |rdoc|
     rdoc.title = 'Sadie'
     rdoc.rdoc_files.include('lib/**/*.rb')
-    rdoc.rdoc_files.include('README')
+    rdoc.rdoc_files.include('README','TODO','CHANGELOG')
     rdoc.main = 'README'
     rdoc.rdoc_dir = 'rdoc'
 end
+
+def current_sadie_version
+    version = "0.0.0"
+    File.open("lib/sadie/version.rb","r").each do |line|
+        if matches = line.match(/version\s*\=\s*\"([^\"]+)\"/i)
+            version = matches[1]
+            break
+        end
+    end    
+    version
+end

data/TODO

@@ -0,0 +1,21 @@
+[setDestroyTimer]  this will accept either a quantity of time or a specific date and
+                   will destroy the data at that time, causing a "reprime" event
+                   
+[threadedness]     split getSadieInstance(sessionid] into getSadieInstanceSlave[sessionid]
+                   where getSadieInstance will continute to bring up a normal Sadie
+                   instance and getSadieInstanceSlave will perform reads in its own thread
+                   but will prime in sync with the main instance thread (such that two
+                   primers for the same key would never execute at the same time, rather,
+                   the second one would simply block until the first completed).  This
+                   would allow for some concurrency within a session without.  Rather than
+                   calling getSadieInstanceSlave directly, a prgram could simple call a
+                   new method, consider( key ) which would fire off a get in an instance
+                   slave to allow for some background processing
+                   
+[keyregexpmatch]   instead of requiring that all keys must be known either as having been set
+                   or having a known primer, a key could be matched against a regex.
+                   This would make it possible to encode some useful priming information
+                   in the key itself, enough that the primer could use it and divine the
+                   desired result.  So, where Sadie::prime takes an arg of containing
+                   a list of keys that this primer "provides", it will alternatively take an
+                   arg of "key-match" which will fire off the primer when the key matches.

data/lib/sadie/version.rb

@@ -1,6 +1,3 @@
-# ==Notes
-# this file sets the version of the Sadie gem
-
 class Sadie
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/sadie.rb

@@ -162,20 +162,6 @@ class Sadie
             set( "sadie.session_id", _generateNewSessionId )
         end
         
-#         if  defined? options["sadie.session_filepath"] \
-#             && options["sadie.session_filepath"].match(/^[^\s]+$/)
-#             set( "sadie.session_filepath", options["sadie.session_filepath"] )
-#             _initializeWithSessionFilePath( get("sadie.session_filepath") )
-#             return
-#         end
-#         
-#         # determine session id, init from session if provided as arg
-#         if defined?options["sadie.session_id"] && options["sadie.session_id"].match(/^[^\s]+$/)
-#             set( "sadie.session_id", options["sadie.session_id"] )
-#             _initializeWithSessionId( get( "sadie.session_id" ) )
-#         else
-#             set( "sadie.session_id", _generateNewSessionId )
-#         end
         
     end
     
@@ -236,62 +222,11 @@ class Sadie
         # a primer or actually priming
         else
             yield( self, getCurrentPrimerKeyPrefix, @@current_primer_filepath ) \
-#                unless midPrimerInit?
-            # if registering the prime mode, skips block exec
-#            
-#             if currentPrimerPluginAcceptsBlock?
-#                 
-#                 # call with block only if accepts block
-#                 yield( self, getCurrentPrimerKeyPrefix, @@current_primer_filepath, &block )
-#                 
-#             else
-                
-#             yield( self, getCurrentPrimerKeyPrefix, @@current_primer_filepath ) \
-#                 if prime_on_init or 
-                
-#             end
-            
-#             prime_on_init \
-#                 or unsetMidPrimerInit
-            
         end
     end
     
     
     
-#     # ==method: pathToKey
-#     #
-#     # returns a dot-separated version of the filepath such that
-#     #   with parentify=1 returns dot path to directory file is in,
-#     #   with parentify=2 returns dot path to directory above directory file is in, etc.
-#     def pathToKey( filepath, parentify=0 )
-#         
-#         # separate path into basename,dirname
-#         path_basename = File.basename( filepath )
-#         path_dirname = File.dirname( filepath )
-#         
-#         # create stack of dir components
-#         path_stack = Array.new
-#         temp_path_stack = path_dirname.split(/\//)
-#         temp_path_stack.each do |item|
-#             next if item.match(/^\s*$/)
-#             path_stack.push item
-#         end
-#         
-#         # lose the suffix on the basename
-#         root_path_basename = path_basename.gsub( /\.[^\.]*$/, "" )
-#         path_stack.push( root_path_basename )
-#         if parentify > 1
-#             parentify.times do |i|
-#                 path_stack.pop
-#             end
-#         end
-#         
-#         path_stack.join( "," )
-#         
-#     end
-
-    
     # ==method: get
     #
     # a standard getter which primes the unprimed and recalls "expensive" facts from files
@@ -355,11 +290,12 @@ class Sadie
     #
     # returns true if the destructOnGet flag is set for the key
     def destroyOnGet?( key )
-        @flag_destroyonget.has_key?( key ) \
-            or return _newline( false )
-        @flag_destroyonget["#{key}"] \
-            and return _newline( true )
-        return _newline(false)
+        ( @flag_destroyonget.has_key?( key ) && @flag_destroyonget["#{key}"] )
+#         @flag_destroyonget.has_key?( key ) \
+#             or return _newline( false )
+#         @flag_destroyonget["#{key}"] \
+#             and return _newline( true )
+#         return _newline(false)
     end
     
     # ==method: set
@@ -648,8 +584,6 @@ class Sadie
            
            if regexp.match( filename )
                
-#                currentPrimerPluginAcceptsBlock( accepts_block )
-#                currentPrimerPluginPrimeOnInit( prime_on_init )
                setCurrentPrimerPluginFilepath( plugin_filepath )
                prime_on_init \
                     or setMidPrimerInit( filepath )
@@ -691,7 +625,13 @@ class Sadie
         @@current_primer_filepath
     end
     
+    def setCurrentPrimerRequestingKey( key )
+        @@current_primer_requesting_key = key
+    end
     
+    def getCurrentPrimerRequestingKey
+        @@current_primer_requesting_key
+    end
     
     # ==memorizePrimerLocation
     #
@@ -772,7 +712,6 @@ class Sadie
     
 
     def _newline( rval=true )
-        #puts
         return rval
     end
     
@@ -907,7 +846,6 @@ class Sadie
         if ! defined? @@mid_primer_initialization
             @@mid_primer_initialization = false
             @@mid_primer_filepath       = nil
-#             @@mid_primer_toplevel_primer_dirpath = nil
         end
         
     end

data/sadie.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "dbi"
   s.add_runtime_dependency "mysql"
   s.add_runtime_dependency "dbd-mysql"
-  
+  s.extra_rdoc_files = ['README', 'CHANGELOG', 'TODO']
 end

metadata

@@ -1,74 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sadie
-version: !ruby/object:Gem::Version 
-  hash: 9
+version: !ruby/object:Gem::Version
+  version: 0.0.12
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 11
-  version: 0.0.11
 platform: ruby
-authors: 
+authors:
 - Fred McDavid
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: dbi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &9930400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mysql
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *9930400
+- !ruby/object:Gem::Dependency
+  name: mysql
+  requirement: &9929980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: dbd-mysql
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *9929980
+- !ruby/object:Gem::Dependency
+  name: dbd-mysql
+  requirement: &9929560 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-description: Sadie is a data framework intended to ease the pain of managing related data.
-email: 
+  prerelease: false
+  version_requirements: *9929560
+description: Sadie is a data framework intended to ease the pain of managing related
+  data.
+email:
 - fred@landmetrics.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: []
-
-files: 
+extra_rdoc_files:
+- README
+- CHANGELOG
+- TODO
+files:
 - .gitignore
 - CHANGELOG
 - Gemfile
@@ -76,6 +62,7 @@ files:
 - LICENSE
 - README
 - Rakefile
+- TODO
 - lib/.gitignore
 - lib/sadie.rb
 - lib/sadie/defaults.rb
@@ -114,36 +101,26 @@ files:
 - test/test_primers/two/deep/two_results.res
 homepage: http://www.landmetrics.com/Sadie
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: sadie
-rubygems_version: 1.7.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A gem that provides sadie, a data access framework
 test_files: []
-