sadie 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,6 @@
1
+ *.gem
2
+ .bundle
3
+ Gemfile.lock
4
+ pkg/*
5
+ *~
6
+
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ source :rubygems
2
+ source "http://rubyforge.org"
3
+ source :rubyforge
4
+ source "http://gems.rubyforge.org"
5
+ gem "ini", "~> 0.1.1"
6
+
7
+ # Specify your gem's dependencies in sadie.gemspec
8
+ gemspec
data/LEGAL ADDED
@@ -0,0 +1,6 @@
1
+ LEGAL NOTICE INFORMATION
2
+ ------------------------
3
+
4
+ All the files in this distribution are covered under the GPLv2 (see file LICENSE).
5
+
6
+ Copyright (C) 2012, LandMetrics, LC
data/LICENSE ADDED
@@ -0,0 +1,340 @@
1
+ GNU GENERAL PUBLIC LICENSE
2
+ Version 2, June 1991
3
+
4
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The licenses for most software are designed to take away your
12
+ freedom to share and change it. By contrast, the GNU General Public
13
+ License is intended to guarantee your freedom to share and change free
14
+ software--to make sure the software is free for all its users. This
15
+ General Public License applies to most of the Free Software
16
+ Foundation's software and to any other program whose authors commit to
17
+ using it. (Some other Free Software Foundation software is covered by
18
+ the GNU Library General Public License instead.) You can apply it to
19
+ your programs, too.
20
+
21
+ When we speak of free software, we are referring to freedom, not
22
+ price. Our General Public Licenses are designed to make sure that you
23
+ have the freedom to distribute copies of free software (and charge for
24
+ this service if you wish), that you receive source code or can get it
25
+ if you want it, that you can change the software or use pieces of it
26
+ in new free programs; and that you know you can do these things.
27
+
28
+ To protect your rights, we need to make restrictions that forbid
29
+ anyone to deny you these rights or to ask you to surrender the rights.
30
+ These restrictions translate to certain responsibilities for you if you
31
+ distribute copies of the software, or if you modify it.
32
+
33
+ For example, if you distribute copies of such a program, whether
34
+ gratis or for a fee, you must give the recipients all the rights that
35
+ you have. You must make sure that they, too, receive or can get the
36
+ source code. And you must show them these terms so they know their
37
+ rights.
38
+
39
+ We protect your rights with two steps: (1) copyright the software, and
40
+ (2) offer you this license which gives you legal permission to copy,
41
+ distribute and/or modify the software.
42
+
43
+ Also, for each author's protection and ours, we want to make certain
44
+ that everyone understands that there is no warranty for this free
45
+ software. If the software is modified by someone else and passed on, we
46
+ want its recipients to know that what they have is not the original, so
47
+ that any problems introduced by others will not reflect on the original
48
+ authors' reputations.
49
+
50
+ Finally, any free program is threatened constantly by software
51
+ patents. We wish to avoid the danger that redistributors of a free
52
+ program will individually obtain patent licenses, in effect making the
53
+ program proprietary. To prevent this, we have made it clear that any
54
+ patent must be licensed for everyone's free use or not licensed at all.
55
+
56
+ The precise terms and conditions for copying, distribution and
57
+ modification follow.
58
+
59
+ GNU GENERAL PUBLIC LICENSE
60
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61
+
62
+ 0. This License applies to any program or other work which contains
63
+ a notice placed by the copyright holder saying it may be distributed
64
+ under the terms of this General Public License. The "Program", below,
65
+ refers to any such program or work, and a "work based on the Program"
66
+ means either the Program or any derivative work under copyright law:
67
+ that is to say, a work containing the Program or a portion of it,
68
+ either verbatim or with modifications and/or translated into another
69
+ language. (Hereinafter, translation is included without limitation in
70
+ the term "modification".) Each licensee is addressed as "you".
71
+
72
+ Activities other than copying, distribution and modification are not
73
+ covered by this License; they are outside its scope. The act of
74
+ running the Program is not restricted, and the output from the Program
75
+ is covered only if its contents constitute a work based on the
76
+ Program (independent of having been made by running the Program).
77
+ Whether that is true depends on what the Program does.
78
+
79
+ 1. You may copy and distribute verbatim copies of the Program's
80
+ source code as you receive it, in any medium, provided that you
81
+ conspicuously and appropriately publish on each copy an appropriate
82
+ copyright notice and disclaimer of warranty; keep intact all the
83
+ notices that refer to this License and to the absence of any warranty;
84
+ and give any other recipients of the Program a copy of this License
85
+ along with the Program.
86
+
87
+ You may charge a fee for the physical act of transferring a copy, and
88
+ you may at your option offer warranty protection in exchange for a fee.
89
+
90
+ 2. You may modify your copy or copies of the Program or any portion
91
+ of it, thus forming a work based on the Program, and copy and
92
+ distribute such modifications or work under the terms of Section 1
93
+ above, provided that you also meet all of these conditions:
94
+
95
+ a) You must cause the modified files to carry prominent notices
96
+ stating that you changed the files and the date of any change.
97
+
98
+ b) You must cause any work that you distribute or publish, that in
99
+ whole or in part contains or is derived from the Program or any
100
+ part thereof, to be licensed as a whole at no charge to all third
101
+ parties under the terms of this License.
102
+
103
+ c) If the modified program normally reads commands interactively
104
+ when run, you must cause it, when started running for such
105
+ interactive use in the most ordinary way, to print or display an
106
+ announcement including an appropriate copyright notice and a
107
+ notice that there is no warranty (or else, saying that you provide
108
+ a warranty) and that users may redistribute the program under
109
+ these conditions, and telling the user how to view a copy of this
110
+ License. (Exception: if the Program itself is interactive but
111
+ does not normally print such an announcement, your work based on
112
+ the Program is not required to print an announcement.)
113
+
114
+ These requirements apply to the modified work as a whole. If
115
+ identifiable sections of that work are not derived from the Program,
116
+ and can be reasonably considered independent and separate works in
117
+ themselves, then this License, and its terms, do not apply to those
118
+ sections when you distribute them as separate works. But when you
119
+ distribute the same sections as part of a whole which is a work based
120
+ on the Program, the distribution of the whole must be on the terms of
121
+ this License, whose permissions for other licensees extend to the
122
+ entire whole, and thus to each and every part regardless of who wrote it.
123
+
124
+ Thus, it is not the intent of this section to claim rights or contest
125
+ your rights to work written entirely by you; rather, the intent is to
126
+ exercise the right to control the distribution of derivative or
127
+ collective works based on the Program.
128
+
129
+ In addition, mere aggregation of another work not based on the Program
130
+ with the Program (or with a work based on the Program) on a volume of
131
+ a storage or distribution medium does not bring the other work under
132
+ the scope of this License.
133
+
134
+ 3. You may copy and distribute the Program (or a work based on it,
135
+ under Section 2) in object code or executable form under the terms of
136
+ Sections 1 and 2 above provided that you also do one of the following:
137
+
138
+ a) Accompany it with the complete corresponding machine-readable
139
+ source code, which must be distributed under the terms of Sections
140
+ 1 and 2 above on a medium customarily used for software interchange; or,
141
+
142
+ b) Accompany it with a written offer, valid for at least three
143
+ years, to give any third party, for a charge no more than your
144
+ cost of physically performing source distribution, a complete
145
+ machine-readable copy of the corresponding source code, to be
146
+ distributed under the terms of Sections 1 and 2 above on a medium
147
+ customarily used for software interchange; or,
148
+
149
+ c) Accompany it with the information you received as to the offer
150
+ to distribute corresponding source code. (This alternative is
151
+ allowed only for noncommercial distribution and only if you
152
+ received the program in object code or executable form with such
153
+ an offer, in accord with Subsection b above.)
154
+
155
+ The source code for a work means the preferred form of the work for
156
+ making modifications to it. For an executable work, complete source
157
+ code means all the source code for all modules it contains, plus any
158
+ associated interface definition files, plus the scripts used to
159
+ control compilation and installation of the executable. However, as a
160
+ special exception, the source code distributed need not include
161
+ anything that is normally distributed (in either source or binary
162
+ form) with the major components (compiler, kernel, and so on) of the
163
+ operating system on which the executable runs, unless that component
164
+ itself accompanies the executable.
165
+
166
+ If distribution of executable or object code is made by offering
167
+ access to copy from a designated place, then offering equivalent
168
+ access to copy the source code from the same place counts as
169
+ distribution of the source code, even though third parties are not
170
+ compelled to copy the source along with the object code.
171
+
172
+ 4. You may not copy, modify, sublicense, or distribute the Program
173
+ except as expressly provided under this License. Any attempt
174
+ otherwise to copy, modify, sublicense or distribute the Program is
175
+ void, and will automatically terminate your rights under this License.
176
+ However, parties who have received copies, or rights, from you under
177
+ this License will not have their licenses terminated so long as such
178
+ parties remain in full compliance.
179
+
180
+ 5. You are not required to accept this License, since you have not
181
+ signed it. However, nothing else grants you permission to modify or
182
+ distribute the Program or its derivative works. These actions are
183
+ prohibited by law if you do not accept this License. Therefore, by
184
+ modifying or distributing the Program (or any work based on the
185
+ Program), you indicate your acceptance of this License to do so, and
186
+ all its terms and conditions for copying, distributing or modifying
187
+ the Program or works based on it.
188
+
189
+ 6. Each time you redistribute the Program (or any work based on the
190
+ Program), the recipient automatically receives a license from the
191
+ original licensor to copy, distribute or modify the Program subject to
192
+ these terms and conditions. You may not impose any further
193
+ restrictions on the recipients' exercise of the rights granted herein.
194
+ You are not responsible for enforcing compliance by third parties to
195
+ this License.
196
+
197
+ 7. If, as a consequence of a court judgment or allegation of patent
198
+ infringement or for any other reason (not limited to patent issues),
199
+ conditions are imposed on you (whether by court order, agreement or
200
+ otherwise) that contradict the conditions of this License, they do not
201
+ excuse you from the conditions of this License. If you cannot
202
+ distribute so as to satisfy simultaneously your obligations under this
203
+ License and any other pertinent obligations, then as a consequence you
204
+ may not distribute the Program at all. For example, if a patent
205
+ license would not permit royalty-free redistribution of the Program by
206
+ all those who receive copies directly or indirectly through you, then
207
+ the only way you could satisfy both it and this License would be to
208
+ refrain entirely from distribution of the Program.
209
+
210
+ If any portion of this section is held invalid or unenforceable under
211
+ any particular circumstance, the balance of the section is intended to
212
+ apply and the section as a whole is intended to apply in other
213
+ circumstances.
214
+
215
+ It is not the purpose of this section to induce you to infringe any
216
+ patents or other property right claims or to contest validity of any
217
+ such claims; this section has the sole purpose of protecting the
218
+ integrity of the free software distribution system, which is
219
+ implemented by public license practices. Many people have made
220
+ generous contributions to the wide range of software distributed
221
+ through that system in reliance on consistent application of that
222
+ system; it is up to the author/donor to decide if he or she is willing
223
+ to distribute software through any other system and a licensee cannot
224
+ impose that choice.
225
+
226
+ This section is intended to make thoroughly clear what is believed to
227
+ be a consequence of the rest of this License.
228
+
229
+ 8. If the distribution and/or use of the Program is restricted in
230
+ certain countries either by patents or by copyrighted interfaces, the
231
+ original copyright holder who places the Program under this License
232
+ may add an explicit geographical distribution limitation excluding
233
+ those countries, so that distribution is permitted only in or among
234
+ countries not thus excluded. In such case, this License incorporates
235
+ the limitation as if written in the body of this License.
236
+
237
+ 9. The Free Software Foundation may publish revised and/or new versions
238
+ of the General Public License from time to time. Such new versions will
239
+ be similar in spirit to the present version, but may differ in detail to
240
+ address new problems or concerns.
241
+
242
+ Each version is given a distinguishing version number. If the Program
243
+ specifies a version number of this License which applies to it and "any
244
+ later version", you have the option of following the terms and conditions
245
+ either of that version or of any later version published by the Free
246
+ Software Foundation. If the Program does not specify a version number of
247
+ this License, you may choose any version ever published by the Free Software
248
+ Foundation.
249
+
250
+ 10. If you wish to incorporate parts of the Program into other free
251
+ programs whose distribution conditions are different, write to the author
252
+ to ask for permission. For software which is copyrighted by the Free
253
+ Software Foundation, write to the Free Software Foundation; we sometimes
254
+ make exceptions for this. Our decision will be guided by the two goals
255
+ of preserving the free status of all derivatives of our free software and
256
+ of promoting the sharing and reuse of software generally.
257
+
258
+ NO WARRANTY
259
+
260
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261
+ FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262
+ OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263
+ PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264
+ OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265
+ MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266
+ TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267
+ PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268
+ REPAIR OR CORRECTION.
269
+
270
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272
+ REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273
+ INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274
+ OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275
+ TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276
+ YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277
+ PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278
+ POSSIBILITY OF SUCH DAMAGES.
279
+
280
+ END OF TERMS AND CONDITIONS
281
+
282
+ How to Apply These Terms to Your New Programs
283
+
284
+ If you develop a new program, and you want it to be of the greatest
285
+ possible use to the public, the best way to achieve this is to make it
286
+ free software which everyone can redistribute and change under these terms.
287
+
288
+ To do so, attach the following notices to the program. It is safest
289
+ to attach them to the start of each source file to most effectively
290
+ convey the exclusion of warranty; and each file should have at least
291
+ the "copyright" line and a pointer to where the full notice is found.
292
+
293
+ <one line to give the program's name and a brief idea of what it does.>
294
+ Copyright (C) <year> <name of author>
295
+
296
+ This program is free software; you can redistribute it and/or modify
297
+ it under the terms of the GNU General Public License as published by
298
+ the Free Software Foundation; either version 2 of the License, or
299
+ (at your option) any later version.
300
+
301
+ This program is distributed in the hope that it will be useful,
302
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
303
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304
+ GNU General Public License for more details.
305
+
306
+ You should have received a copy of the GNU General Public License
307
+ along with this program; if not, write to the Free Software
308
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
309
+
310
+
311
+ Also add information on how to contact you by electronic and paper mail.
312
+
313
+ If the program is interactive, make it output a short notice like this
314
+ when it starts in an interactive mode:
315
+
316
+ Gnomovision version 69, Copyright (C) year name of author
317
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
318
+ This is free software, and you are welcome to redistribute it
319
+ under certain conditions; type `show c' for details.
320
+
321
+ The hypothetical commands `show w' and `show c' should show the appropriate
322
+ parts of the General Public License. Of course, the commands you use may
323
+ be called something other than `show w' and `show c'; they could even be
324
+ mouse-clicks or menu items--whatever suits your program.
325
+
326
+ You should also get your employer (if you work as a programmer) or your
327
+ school, if any, to sign a "copyright disclaimer" for the program, if
328
+ necessary. Here is a sample; alter the names:
329
+
330
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
331
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
332
+
333
+ <signature of Ty Coon>, 1 April 1989
334
+ Ty Coon, President of Vice
335
+
336
+ This General Public License does not permit incorporating your program into
337
+ proprietary programs. If your program is a subroutine library, you may
338
+ consider it more useful to permit linking proprietary applications with the
339
+ library. If this is what you want to do, use the GNU Library General
340
+ Public License instead of this License.
data/README ADDED
File without changes
data/Rakefile ADDED
@@ -0,0 +1,22 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ require 'rake'
4
+ require 'rake/rdoctask'
5
+
6
+ task :default => [:test]
7
+
8
+ task :test do
9
+ ruby "test/tc_sadie_toplevel.rb"
10
+ ruby "test/tc_sadie_twodeep.rb"
11
+ end
12
+
13
+ # task :rdoc do
14
+ #
15
+ # end
16
+ Rake::RDocTask.new do |rdoc|
17
+ rdoc.title = 'Sadie'
18
+ rdoc.rdoc_files.include('lib/**/*.rb')
19
+ rdoc.rdoc_files.include('README')
20
+ rdoc.main = 'README'
21
+ rdoc.rdoc_dir = 'rdoc'
22
+ end
data/lib/.gitignore ADDED
@@ -0,0 +1,2 @@
1
+ doc
2
+ doc/*
@@ -0,0 +1,10 @@
1
+ # ==Notes
2
+ # this file sets defaults which can and should be overridden using arguments
3
+ # the sadie constructor
4
+
5
+ class Sadie
6
+ DEFAULTS = {
7
+ "sadie.primers_dirpath" => File.expand_path("primers","/var/sadie"),
8
+ "sadie.sessions_dirpath" => File.expand_path("sessions","/var/sadie")
9
+ }
10
+ end
@@ -0,0 +1,6 @@
1
+ # ==Notes
2
+ # this file sets the version of the Sadie gem
3
+
4
+ class Sadie
5
+ VERSION = "0.0.1"
6
+ end
data/lib/sadie.rb ADDED
@@ -0,0 +1,405 @@
1
+ # this requires the gem: ini
2
+ require 'rubygems'
3
+ require "bundler/setup"
4
+ require 'bundler'
5
+ Bundler.require(:default)
6
+ #require 'ini'
7
+
8
+
9
+ # ==Description
10
+ # Sadie is a data framework intended to ease the pain of constructing, accessing, and
11
+ # managing the resources required by large stores of inter-related data. It supports
12
+ # sessions, lazy on-demand, one-time evaluation and file-based storage/retrieval
13
+ # operations for resource-heavy data.
14
+ #
15
+ # For simplicity, it supports simple, ini-style data
16
+ # initialization, but for efficient optimization of resource-intensive computations, it
17
+ # supports on-demand, one-time evaluation of &quot;primers&quot; which may define, or prime,
18
+ # multiple key, value pairs in a single run.
19
+
20
+ class Sadie
21
+
22
+ # init sadie instance:
23
+ # options can include any kay, value pairs but the following key values bear mention:
24
+ # REQUIRED
25
+ # sadie.sessions_dirpath
26
+ # or
27
+ # sadie.session_id
28
+ # or
29
+ # sadie.session_filepath <- this is probably a bad call, use with caution
30
+ #
31
+ # sadie.primers_dirpath
32
+ def initialize( options )
33
+
34
+ # start with blank slate short-term memory, primed and expensive flag hashes
35
+ @shortterm = Hash.new
36
+ @flag_expensive = Hash.new
37
+ @flag_primed = Hash.new
38
+
39
+ # init class
40
+ Sadie::_checkSanity
41
+
42
+ # init mid_primer_initialization if not already done
43
+ if ! defined? @@mid_primer_initialization
44
+ @@mid_primer_initialization = false
45
+ @@mid_primer_filepath = nil
46
+ @@mid_primer_toplevel_primer_dirpath = nil
47
+ end
48
+
49
+ # internalize defaults to shortterm
50
+ DEFAULTS.each do |key, value|
51
+ _set( key, value )
52
+ end
53
+
54
+ # internalize supplied defaults
55
+ options.each do |key, value|
56
+ set( key, value )
57
+ end
58
+
59
+ # if a path to a session is given, init using session file
60
+ if defined? options[:sadie.session_filepath] && options[:sadie.session_filepath].match(/^[^\s]+$/)
61
+ set( "sadie.session_filepath", options[:sadie.session_filepath] )
62
+ _initializeWithSessionFilePath( get("sadie.session_filepath") )
63
+ return
64
+ end
65
+
66
+ # determine session id, init from session if provided as arg
67
+ if defined?options[:sadie.session_id] && options[:sadie.session_id].match(/^[^\s]+$/)
68
+ set( "sadie.session_id", options[:sadie.session_id] )
69
+ _initializeWithSessionId( get( "sadie.session_id" ) )
70
+ else
71
+ set( "sadie.session_id", _generateNewSessionId )
72
+ end
73
+
74
+ end
75
+
76
+ def self.getSadieInstance( options )
77
+ Sadie.new(options)
78
+ end
79
+
80
+ def self.Prime ( primer_definition )
81
+
82
+ # validate params
83
+ defined? primer_definition \
84
+ or raise "Prime called without parameters"
85
+ primer_definition.is_a? Hash \
86
+ or raise "Prime called without hash parameters"
87
+ defined? primer_definition["provides"] \
88
+ or raise "Prime called without provides parameter"
89
+
90
+ # if initializing primers, just remember how to get back to the primer later,
91
+ # otherwise, prime
92
+ if Sadie::_midPrimerInit?
93
+ Sadie::_memorizePrimerLocation( @@mid_primer_filepath, primer_definition["provides"] )
94
+ else
95
+ current_sadie_instance = Sadie::_getCurrentSadieInstance
96
+ current_primer_filepath = Sadie::_getCurrentPrimerFilepath
97
+ yield( current_sadie_instance )
98
+ primer_definition["provides"].each do | key |
99
+ next if key.match /^\s*$/
100
+ #puts "Prime> providing: #{key}"
101
+ current_sadie_instance.primed? key \
102
+ or raise "primer definition file: #{current_primer_filepath} was supposed to define #{key}, but did not"
103
+ end
104
+ end
105
+ end
106
+
107
+ def get( k )
108
+
109
+ # prime if not yet primed
110
+ primed?( k ) \
111
+ or _prime( k )
112
+
113
+ # if not expensive, then return what's already known
114
+ expensive?( k ) \
115
+ or return _get( k )
116
+
117
+ # expensive, so recall from file
118
+ return _recallExpensive( k )
119
+ end
120
+
121
+ def setExpensive(k,v)
122
+ expensive_filepath = _computeExpensiveFilepath( k )
123
+ serialized_value = Marshal::dump( v )
124
+ File.open(expensive_filepath, 'w') { |f|
125
+ f.write( serialized_value )
126
+ }
127
+ _expensive( k, true )
128
+ _primed( k, true )
129
+ end
130
+
131
+ # alias for setCheap(k,v)
132
+ def set( k, v )
133
+ setCheap( k, v )
134
+ end
135
+
136
+ def setCheap(k,v)
137
+
138
+ # set it, mark not expensive and primed
139
+ _set( k, v )
140
+ _expensive( k, false )
141
+ _primed( k, true )
142
+
143
+ # if we've reset the primers dirpath, init the primers
144
+ if k.eql?( "sadie.primers_dirpath" )
145
+ Sadie::_setMidPrimerTopLevelPrimersDirpath( v )
146
+ Sadie::_setCurrentSadieInstance( self )
147
+ Sadie::_init_primers
148
+ end
149
+
150
+ end
151
+
152
+ def save
153
+ session_filepath = File.expand_path( "session."+value, get( "sadie.sessions_dirpath" ) )
154
+ serialized_value = Marshal::dump( [ @shortterm, @flag_primed, @flag_expensive ] )
155
+ File.open(session_filepath, 'w') { |f|
156
+ f.write( serialized_value )
157
+ }
158
+ end
159
+
160
+ # return to saved state
161
+ def revert!
162
+
163
+ @shortterm = {
164
+ "sadie.session_id" => get( "sadie.session_id" ),
165
+ "sadie.sessions_dirpath" => get( "sadie.sessions_dirpath" )
166
+ }
167
+
168
+ _initializeWithSessionId( get( "sadie.session_id" ) )
169
+ end
170
+
171
+ def primed?( k )
172
+ @flag_primed[:"#{k}"] \
173
+ and return true
174
+ return false
175
+ end
176
+
177
+ def expensive?( k )
178
+ @flag_expensive[:"#{k}"] \
179
+ and return true
180
+ return false
181
+ end
182
+
183
+ private
184
+
185
+
186
+
187
+ def _prime ( k )
188
+ primer_dirpath = _get("sadie.primers_dirpath")
189
+ if primer_filepath = @@primer_hash["#{primer_dirpath}"]["#{k}"]
190
+ Sadie::_setCurrentPrimerFilepath(primer_filepath)
191
+ Sadie::_setCurrentSadieInstance( self )
192
+ load primer_filepath
193
+ end
194
+
195
+ end
196
+
197
+ def self._setCurrentPrimerFilepath ( filepath )
198
+ @@current_primer_filepath = filepath
199
+ end
200
+
201
+ def self._getCurrentPrimerFilepath
202
+ @@current_primer_filepath
203
+ end
204
+
205
+ def self._setCurrentSadieInstance ( instance )
206
+ @@current_sadie_instance = instance
207
+ end
208
+
209
+ def self._getCurrentSadieInstance
210
+ @@current_sadie_instance
211
+ end
212
+
213
+
214
+ def self._init_primers( key_prefix="", current_dirpath="" )
215
+
216
+ # default to the top-level primers dirpath
217
+ if current_dirpath.empty?
218
+ sadie_instance = Sadie::_getCurrentSadieInstance
219
+ current_dirpath = sadie_instance.get( "sadie.primers_dirpath" ) \
220
+ or raise "sadie.primers_dirpath not set"
221
+ end
222
+
223
+
224
+
225
+ # loop thru each file in the directory, recurse into subdirs and
226
+ # process known filetypes
227
+ Dir.foreach( current_dirpath ) do |filename|
228
+
229
+ filepath = File.expand_path( filename, current_dirpath )
230
+
231
+ if File.directory?( filepath )
232
+
233
+ # recurse
234
+ filename.eql?(".") || filename.eql?("..") \
235
+ or Sadie::_init_primers( key_prefix + "." + filename, filepath )
236
+ else
237
+
238
+ # proc known filetypes
239
+ if matches = filename.match( /^(.*)\.ini$/ )
240
+ prefix = key_prefix + "." + matches[1]
241
+ prefix.gsub( /^\.+/, "" )
242
+
243
+ Sadie::_init_primers_proc_ini_file( prefix, filepath )
244
+ elsif filename.match( /\.res$/ ) || filename.match( /\.res.rb$/ )
245
+ Sadie::_init_primers_proc_res_file( filepath )
246
+ end
247
+ end
248
+ end
249
+ end
250
+
251
+ def self._init_primers_proc_ini_file( key_prefix, filepath )
252
+ inifile = Ini.new( filepath )
253
+ inifile.each do | section, key_from_ini_file, value |
254
+
255
+ # compute key
256
+ key_to_set = key_prefix + "." + section + "." + key_from_ini_file
257
+ key_to_set = key_to_set.gsub( /^\.+/, "" )
258
+ #puts "key_to_set: #{key_to_set}"
259
+
260
+ # get sadie instance and set
261
+ sadie_instance = Sadie::_getCurrentSadieInstance
262
+ sadie_instance.set( key_to_set, value )
263
+ end
264
+ end
265
+
266
+ def self._init_primers_proc_res_file( filepath )
267
+
268
+ # puts "Loading #{filepath}..."
269
+
270
+ # load the res file
271
+ Sadie::_setMidPrimerInit( filepath )
272
+ load( filepath )
273
+ Sadie::_unsetMidPrimerInit
274
+
275
+ end
276
+
277
+ def _recallExpensive( k )
278
+ expensive_filepath = _computeExpensiveFilepath( k )
279
+ File.exists? expensive_filepath \
280
+ or raise "expensive filepath: #{filepath} does not exist"
281
+ f = open( expensive_filepath )
282
+ v = Marshal::load( f.read )
283
+
284
+ return v
285
+ end
286
+
287
+ def _computeExpensiveFilepath( k )
288
+ session_id = get( "sadie.session_id" )
289
+ File.expand_path("session."+session_id+".exp."+k, _get( "sadie.sessions_dirpath" ) )
290
+ end
291
+
292
+ def _primed( k, isprimed )
293
+ if isprimed
294
+ @flag_primed[:"#{k}"] = true
295
+ return
296
+ end
297
+ @flag_primed.delete( k )
298
+ end
299
+
300
+ def _expensive( k, isexpensive )
301
+ if isexpensive
302
+ @flag_expensive[:"#{k}"] = true
303
+ return
304
+ end
305
+ @flag_expensive.delete( k )
306
+ end
307
+
308
+ # direct access getter for shortterm memory
309
+ def _get( key )
310
+ value = @shortterm[:"#{key}"]
311
+ #puts "_get(#{key})> #{value}"
312
+ return value
313
+ end
314
+
315
+ # direct access setter for shortterm memory
316
+ def _set( key, value )
317
+
318
+ # puts "_set> key: #{key}, value: #{value}"
319
+ @shortterm[:"#{key}"] = value
320
+ end
321
+
322
+ # init given path to session file
323
+ def _initializeWithSessionFilePath(session_filepath)
324
+
325
+ # bail on non-existant file
326
+ File.exist?( session_filepath ) \
327
+ or raise "session file, " + session_filepath + " does not exist"
328
+
329
+ # open session file and read internal vars from it
330
+ File.open( session_filepath, "r" ).each do |f|
331
+
332
+ # make sure no writing happens while we read
333
+ f.flock(File::Lock_SH)
334
+
335
+ # read vars from file
336
+ mem, primed, expensive = Marshal::load( f.read )
337
+ end
338
+
339
+ # destructive set on flag vars
340
+ @flag_primed = primed
341
+ @flag_expensive = expensive
342
+
343
+ # additive set on shortterm mem
344
+ mem.each do |k,v|
345
+ set(k, v)
346
+ end
347
+ end
348
+
349
+ # init given session id
350
+ def _initializeWithSessionId(session_id)
351
+ session_filepath = File.expand_path( "session."+session_id, get( "sadie.sessions_dirpath" ) )
352
+ _initializeWithSessionFilePath(session_filepath)
353
+ end
354
+
355
+ # gen new session id
356
+ def _generateNewSessionId
357
+ begin
358
+ value = ""
359
+ 24.times{value << (65 + rand(25)).chr}
360
+ end while File.exist?(File.expand_path("session."+value, get( "sadie.sessions_dirpath" ) ) )
361
+ return value
362
+ end
363
+
364
+ def self._setMidPrimerInit ( filepath )
365
+ @@mid_primer_initialization = true
366
+ @@mid_primer_filepath = filepath
367
+ end
368
+
369
+ def self._unsetMidPrimerInit
370
+ @@mid_primer_initialization = false
371
+ end
372
+
373
+ def self._midPrimerInit?
374
+ @@mid_primer_initialization
375
+ end
376
+
377
+ def self._memorizePrimerLocation( filepath, primer_provides )
378
+ primer_dirpath = @@mid_primer_toplevel_primer_dirpath
379
+ @@primer_hash.has_key?(primer_dirpath) \
380
+ or @@primer_hash["#{primer_dirpath}"] = Hash.new
381
+ primer_provides.each do | key |
382
+ Sadie::_setPrimerProvider( key, filepath )
383
+ end
384
+ end
385
+
386
+ def self._setMidPrimerTopLevelPrimersDirpath( dirpath )
387
+ @@mid_primer_toplevel_primer_dirpath = dirpath
388
+ end
389
+
390
+ def self._setPrimerProvider( primer_name, primer_filepath )
391
+ primer_dirpath = @@mid_primer_toplevel_primer_dirpath
392
+ @@primer_hash["#{primer_dirpath}"]["#{primer_name}"] = primer_filepath
393
+ end
394
+
395
+ def self._checkSanity
396
+ if ! defined? @@primer_hash
397
+ @@primer_hash = Hash.new
398
+ end
399
+
400
+ end
401
+ end
402
+
403
+ require "sadie/version"
404
+ require "sadie/defaults"
405
+
data/sadie.gemspec ADDED
@@ -0,0 +1,24 @@
1
+ # -*- encoding: utf-8 -*-
2
+ $:.push File.expand_path("../lib", __FILE__)
3
+ require "sadie/version"
4
+
5
+ Gem::Specification.new do |s|
6
+ s.name = "sadie"
7
+ s.version = Sadie::VERSION
8
+ s.authors = ["Fred McDavid"]
9
+ s.email = ["fred@landmetrics.com"]
10
+ s.homepage = "http://www.landmetrics.com"
11
+ s.summary = %q{A gem that provides sadie, a data access framework}
12
+ s.description = %q{Sadie is a data framework intended to ease the pain of constructing, accessing, and managing the resources required by large stores of inter-related data. It supports sessions, lazy on-demand, one-time evaluation and file-based storage/retrieval operations for resource-heavy data.}
13
+
14
+ s.rubyforge_project = "sadie"
15
+
16
+ s.files = `git ls-files`.split("\n")
17
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
18
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
19
+ s.require_paths = ["lib"]
20
+
21
+ # specify any dependencies here; for example:
22
+ # s.add_development_dependency "rspec"
23
+ # s.add_runtime_dependency "rest-client"
24
+ end
@@ -0,0 +1,21 @@
1
+ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
2
+
3
+ require "test/unit"
4
+ require "sadie"
5
+ require "tmpdir"
6
+
7
+ class TestSadieToplevel < Test::Unit::TestCase
8
+ def test_simple
9
+ Dir.mktmpdir("sadie_testdir") do | dir |
10
+ sadie = Sadie::getSadieInstance( { "sadie.primers_dirpath" => "test/test_primers",
11
+ "sadie.sessions_dirpath" => dir } )
12
+
13
+ # test top-level ini
14
+ assert_equal( sadie.get( "toplevel.somegroup.somekey" ), "someval" )
15
+ assert_equal( sadie.get( "toplevel.anothergroup.anotherkey" ), "anotherval" )
16
+
17
+ # test top-level res
18
+ assert_equal( sadie.get( "toplevel_single.oneprime" ), "primedit" )
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,24 @@
1
+ $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
2
+
3
+ require "test/unit"
4
+ require "sadie"
5
+ require "tmpdir"
6
+
7
+ class TestSadieTwoDeep < Test::Unit::TestCase
8
+ def test_simple
9
+ Dir.mktmpdir("sadie_testdir") do | dir |
10
+ sadie = Sadie::getSadieInstance( { "sadie.primers_dirpath" => "test/test_primers",
11
+ "sadie.sessions_dirpath" => dir } )
12
+
13
+ # test two-deep ini
14
+ assert_equal( sadie.get( "two.deep.conf.section.thiskey" ), "thisval" )
15
+
16
+ # test two-deep res
17
+ assert_equal( sadie.get( "two.deep.two_results.firstkey" ), "primedthem" )
18
+ assert_equal( sadie.get( "two.deep.two_results.secondkey" ), "primedthem" )
19
+
20
+ # test two-deep expensive
21
+ assert_equal( sadie.get( "expensive.oneprime" ), "primedit" )
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,7 @@
1
+ require 'sadie'
2
+
3
+ Sadie::Prime( "provides" => %w{ onedeep.multiresult.oneprime
4
+ onedeep.multiresult.twoprime } ) do |sadie|
5
+ sadie.set( "onedeep.multiresult.oneprime", "primedthem" )
6
+ sadie.set( "onedeep.multiresult.twoprime", "primedthem" )
7
+ end
@@ -0,0 +1,5 @@
1
+ [somegroup]
2
+ somekey = someval
3
+
4
+ [anothergroup]
5
+ anotherkey = anotherval
@@ -0,0 +1,7 @@
1
+ require 'sadie'
2
+
3
+ Sadie::Prime( "provides" => %w{ toplevel_double.oneprime
4
+ toplevel_double.twoprime } ) do |sadie|
5
+ sadie.set( "toplevel_double.oneprime", "primedthem" )
6
+ sadie.set( "toplevel_double.twoprime", "primedthem" )
7
+ end
@@ -0,0 +1,5 @@
1
+ require 'sadie'
2
+
3
+ Sadie::Prime( "provides" => %w{ toplevel_single.oneprime } ) do |sadie|
4
+ sadie.set( "toplevel_single.oneprime", "primedit" )
5
+ end
@@ -0,0 +1,2 @@
1
+ [section]
2
+ thiskey = thisval
@@ -0,0 +1,5 @@
1
+ require 'sadie'
2
+
3
+ Sadie::Prime( "provides" => %w{ expensive.oneprime } ) do |sadie|
4
+ sadie.setExpensive( "expensive.oneprime", "primedit" )
5
+ end
@@ -0,0 +1,7 @@
1
+ require 'sadie'
2
+
3
+ Sadie::Prime( { "provides" => %w{ two.deep.two_results.firstkey \
4
+ two.deep.two_results.secondkey } } ) do |sadie|
5
+ sadie.set( "two.deep.two_results.firstkey", "primedthem" )
6
+ sadie.set( "two.deep.two_results.secondkey", "primedthem" )
7
+ end
metadata ADDED
@@ -0,0 +1,85 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: sadie
3
+ version: !ruby/object:Gem::Version
4
+ hash: 29
5
+ prerelease:
6
+ segments:
7
+ - 0
8
+ - 0
9
+ - 1
10
+ version: 0.0.1
11
+ platform: ruby
12
+ authors:
13
+ - Fred McDavid
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2012-01-19 00:00:00 Z
19
+ dependencies: []
20
+
21
+ description: Sadie is a data framework intended to ease the pain of constructing, accessing, and managing the resources required by large stores of inter-related data. It supports sessions, lazy on-demand, one-time evaluation and file-based storage/retrieval operations for resource-heavy data.
22
+ email:
23
+ - fred@landmetrics.com
24
+ executables: []
25
+
26
+ extensions: []
27
+
28
+ extra_rdoc_files: []
29
+
30
+ files:
31
+ - .gitignore
32
+ - Gemfile
33
+ - LEGAL
34
+ - LICENSE
35
+ - README
36
+ - Rakefile
37
+ - lib/.gitignore
38
+ - lib/sadie.rb
39
+ - lib/sadie/defaults.rb
40
+ - lib/sadie/version.rb
41
+ - sadie.gemspec
42
+ - test/tc_sadie_toplevel.rb
43
+ - test/tc_sadie_twodeep.rb
44
+ - test/test_primers/onedeep/multiresult.res
45
+ - test/test_primers/toplevel.ini
46
+ - test/test_primers/toplevel_double.res.rb
47
+ - test/test_primers/toplevel_single.res.rb
48
+ - test/test_primers/two/deep/conf.ini
49
+ - test/test_primers/two/deep/expensive.res
50
+ - test/test_primers/two/deep/two_results.res
51
+ homepage: http://www.landmetrics.com
52
+ licenses: []
53
+
54
+ post_install_message:
55
+ rdoc_options: []
56
+
57
+ require_paths:
58
+ - lib
59
+ required_ruby_version: !ruby/object:Gem::Requirement
60
+ none: false
61
+ requirements:
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ hash: 3
65
+ segments:
66
+ - 0
67
+ version: "0"
68
+ required_rubygems_version: !ruby/object:Gem::Requirement
69
+ none: false
70
+ requirements:
71
+ - - ">="
72
+ - !ruby/object:Gem::Version
73
+ hash: 3
74
+ segments:
75
+ - 0
76
+ version: "0"
77
+ requirements: []
78
+
79
+ rubyforge_project: sadie
80
+ rubygems_version: 1.7.2
81
+ signing_key:
82
+ specification_version: 3
83
+ summary: A gem that provides sadie, a data access framework
84
+ test_files: []
85
+