rhubarb 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/CHANGES +95 -0
- data/LICENSE +202 -0
- data/README.rdoc +24 -0
- data/Rakefile +99 -0
- data/TODO +12 -0
- data/VERSION +1 -0
- data/lib/rhubarb/rhubarb.rb +545 -0
- data/test/helper.rb +7 -0
- data/test/test_rhubarb.rb +632 -0
- metadata +87 -0
data/.document
ADDED
data/.gitignore
ADDED
data/CHANGES
ADDED
@@ -0,0 +1,95 @@
|
|
1
|
+
version 0.2.0
|
2
|
+
|
3
|
+
* First standalone release of Rhubarb. Previous releases are included
|
4
|
+
with SPQR.
|
5
|
+
|
6
|
+
* Managed classes that use the non-default db will respect assignments
|
7
|
+
to the db class field, even if it occurs before the call to
|
8
|
+
create_table. This should simplify some client code.
|
9
|
+
|
10
|
+
version 0.1.4 (f24baeafb0fe88e09c232acac3891d11771325a9)
|
11
|
+
|
12
|
+
* 0.1.3 introduced a compatibility issue with previous versions of
|
13
|
+
Rhubarb. These should be resolved here.
|
14
|
+
|
15
|
+
version 0.1.3 (c5c095db4d5f22d0fff6633237859cd33a319884)
|
16
|
+
|
17
|
+
* This is a release featuring only minor enhancements to Rhubarb. If
|
18
|
+
you don't use Rhubarb, there is no need to upgrade.
|
19
|
+
|
20
|
+
* Rhubarb classes now support a delete_all method.
|
21
|
+
|
22
|
+
* Rhubarb now supports multiple backend databases, via an extra
|
23
|
+
parameter to Persistence::open and to the create_table class methods.
|
24
|
+
Note that it is not currently possible to have one class backed by
|
25
|
+
multiple databases.
|
26
|
+
|
27
|
+
version 0.1.2 (2c45fd4d693a396e9206607a6f053b1eb4696272)
|
28
|
+
|
29
|
+
* Enhancements to SPQR/Rhubarb interoperability. (Rhubarb row_ids are
|
30
|
+
now used for half of the QMF object ID).
|
31
|
+
|
32
|
+
* Enhancements to app skeleton class: now allows specifying username,
|
33
|
+
password, hostname, and port in the constructor to SPQR::App.
|
34
|
+
|
35
|
+
version 0.1.1 (85c87b1239f730374d47e2d8baf795c8c69050f4)
|
36
|
+
|
37
|
+
* Other minor Rhubarb fixes.
|
38
|
+
|
39
|
+
* Rhubarb now properly handles persisting classes declared in
|
40
|
+
different modules and supports defining custom table names.
|
41
|
+
|
42
|
+
* spqr-gen now has preliminary support for generating classes that
|
43
|
+
persist via rhubarb.
|
44
|
+
|
45
|
+
* Fixes and cleanups to class- and package-name metadata. Previously,
|
46
|
+
the app skeleton would fail to find some manageable classes
|
47
|
+
declared in separate Ruby modules. In addition, the manageable
|
48
|
+
mixin now sets sensible default names for the QMF class and package
|
49
|
+
(when one is not provided within the class declaration).
|
50
|
+
|
51
|
+
version 0.1.0 (3a3ca52c4f086d1f20fdf5ed89dda262622c171d)
|
52
|
+
|
53
|
+
* Note that this version breaks backwards compatibility, for reasons
|
54
|
+
mentioned below. Most notably, the Manageable API names have changed,
|
55
|
+
and the old-style exposed-method declarations (with hash args) are no
|
56
|
+
longer supported in favor of a more idiomatic style.
|
57
|
+
|
58
|
+
* Exposed methods now use idiomatic parameter-passing style: input
|
59
|
+
(and in/out) parameters are passed in to methods by name (in the
|
60
|
+
order that they appear in the expose declaration), and output (and
|
61
|
+
in/out) values are returned in a list via a standard return
|
62
|
+
statement. (Again, the order of output and in/out parameters is
|
63
|
+
specified by the order that they appear in the expose declaration.)
|
64
|
+
|
65
|
+
* Code generation now uses idiomatic parameter-passing style. Code
|
66
|
+
generation should still be considered "alpha"-quality.
|
67
|
+
|
68
|
+
* Changed mixed-in method names from Manageable.
|
69
|
+
|
70
|
+
version 0.0.4 (180897a77b55400b31d364a08cb9f81c423eb59f)
|
71
|
+
|
72
|
+
* Test suite is mainly stable (individual tests will sometimes hang
|
73
|
+
upon creating a QMF agent).
|
74
|
+
* This is probably the last version before I change the method call API.
|
75
|
+
|
76
|
+
version 0.0.3 (060c7b5bcaa2711b3e3ce511c9c3ecaa59bf0de8)
|
77
|
+
|
78
|
+
* Agent-ready callback and parent-process notification (app.rb)
|
79
|
+
* The beginnings of an SPQR test suite
|
80
|
+
|
81
|
+
version 0.0.2 (ecd94b141307c5f0f141833836ea686854cfda9c)
|
82
|
+
|
83
|
+
* First shaky pass at automated RPM packaging (see rpmspec and
|
84
|
+
srpm rake targets)
|
85
|
+
* Automatic find_all methods for Rhubarb persisting classes
|
86
|
+
|
87
|
+
version 0.0.1 (0714a87f30469772fc302515e95576e329f7deb9)
|
88
|
+
|
89
|
+
* Gem support
|
90
|
+
* Codegen fixes
|
91
|
+
|
92
|
+
version 0.0.0 (bbbc2e9d6983f773f6d093a821a0e635714ea869)
|
93
|
+
|
94
|
+
* Initial numbered release; corresponds roughly to the functionality
|
95
|
+
from the "Introducing SPQR" blog posts, but with an added Rakefile.
|
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README.rdoc
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
= rhubarb
|
2
|
+
|
3
|
+
Rhubarb is a simple versioned object-graph persistence layer that
|
4
|
+
stores instances of specially-declared Ruby classes in a SQLite3
|
5
|
+
database. It was developed for use with the SPQR project, but is
|
6
|
+
independently useful (and independently updated).
|
7
|
+
|
8
|
+
== Maintainer
|
9
|
+
|
10
|
+
Will Benton (willb@redhat.com)
|
11
|
+
|
12
|
+
== Patches and pull requests
|
13
|
+
|
14
|
+
* Please add tests for any new features you add.
|
15
|
+
* Send me a pull request; ideally, your functionality is on a topic branch forked from my master.
|
16
|
+
|
17
|
+
== Credits
|
18
|
+
|
19
|
+
* Thanks to William Henry for suggesting the "rhubarb" name
|
20
|
+
* Gem support by technicalpickles' jeweler
|
21
|
+
|
22
|
+
== Copyright
|
23
|
+
|
24
|
+
Copyright (c) 2009--2010 Red Hat, Inc. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,99 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "rhubarb"
|
8
|
+
gem.summary = %Q{Rhubarb: object graph persistence, easy as pie}
|
9
|
+
gem.description = %Q{Rhubarb is a simple object-graph persistence library implemented as a mixin. It also works with the SPQR library for straightforward object publishing over QMF.}
|
10
|
+
gem.email = "willb@redhat.com"
|
11
|
+
gem.homepage = "http://git.fedorahosted.org/git/grid/rhubarb.git"
|
12
|
+
gem.authors = ["William Benton"]
|
13
|
+
gem.add_development_dependency "rspec", ">= 1.2.9"
|
14
|
+
gem.add_dependency "sqlite3-ruby", ">= 1.2.2"
|
15
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
16
|
+
end
|
17
|
+
Jeweler::GemcutterTasks.new
|
18
|
+
rescue LoadError
|
19
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
20
|
+
end
|
21
|
+
|
22
|
+
def pkg_version
|
23
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
24
|
+
return version.chomp
|
25
|
+
end
|
26
|
+
|
27
|
+
require 'spec/rake/spectask'
|
28
|
+
Spec::Rake::SpecTask.new(:spec) do |spec|
|
29
|
+
spec.libs << 'lib' << 'spec'
|
30
|
+
spec.spec_files = FileList['spec/**/*_spec.rb']
|
31
|
+
end
|
32
|
+
|
33
|
+
Spec::Rake::SpecTask.new(:rcov) do |spec|
|
34
|
+
spec.libs << 'lib' << 'spec'
|
35
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
36
|
+
spec.rcov = true
|
37
|
+
end
|
38
|
+
|
39
|
+
task :spec => :check_dependencies
|
40
|
+
|
41
|
+
|
42
|
+
require 'rake/testtask'
|
43
|
+
Rake::TestTask.new(:test) do |test|
|
44
|
+
test.libs << 'lib' << 'test'
|
45
|
+
test.pattern = 'test/**/test_*.rb'
|
46
|
+
test.verbose = true
|
47
|
+
end
|
48
|
+
|
49
|
+
begin
|
50
|
+
require 'rcov/rcovtask'
|
51
|
+
Rcov::RcovTask.new do |test|
|
52
|
+
test.libs << 'test'
|
53
|
+
test.pattern = 'test/**/test_*.rb'
|
54
|
+
test.verbose = true
|
55
|
+
end
|
56
|
+
rescue LoadError
|
57
|
+
task :rcov do
|
58
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
task :test => :check_dependencies
|
63
|
+
|
64
|
+
begin
|
65
|
+
require 'reek/adapters/rake_task'
|
66
|
+
Reek::RakeTask.new do |t|
|
67
|
+
t.fail_on_error = true
|
68
|
+
t.verbose = false
|
69
|
+
t.source_files = 'lib/**/*.rb'
|
70
|
+
end
|
71
|
+
rescue LoadError
|
72
|
+
task :reek do
|
73
|
+
abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
begin
|
78
|
+
require 'roodi'
|
79
|
+
require 'roodi_task'
|
80
|
+
RoodiTask.new do |t|
|
81
|
+
t.verbose = false
|
82
|
+
end
|
83
|
+
rescue LoadError
|
84
|
+
task :roodi do
|
85
|
+
abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
task :default => :spec
|
90
|
+
|
91
|
+
require 'rake/rdoctask'
|
92
|
+
Rake::RDocTask.new do |rdoc|
|
93
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
94
|
+
|
95
|
+
rdoc.rdoc_dir = 'rdoc'
|
96
|
+
rdoc.title = "rhubarb #{version}"
|
97
|
+
rdoc.rdoc_files.include('README*')
|
98
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
99
|
+
end
|
data/TODO
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
* Test coverage of multiple-db situations
|
2
|
+
* Test coverage of close-and-reopen db situations
|
3
|
+
* Metadata stored in db files
|
4
|
+
* Bring code coverage up to 100%
|
5
|
+
* Documentation
|
6
|
+
* Standalone examples (i.e. not just "please see the test suite")
|
7
|
+
|
8
|
+
Legend:
|
9
|
+
|
10
|
+
! --> highest priority
|
11
|
+
* --> standard priority
|
12
|
+
- --> low priority
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.2.0
|