rhubarb 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CHANGES

@@ -0,0 +1,95 @@
+version 0.2.0
+
+*  First standalone release of Rhubarb.  Previous releases are included
+   with SPQR.
+
+*  Managed classes that use the non-default db will respect assignments
+   to the db class field, even if it occurs before the call to
+   create_table.  This should simplify some client code.
+
+version 0.1.4 (f24baeafb0fe88e09c232acac3891d11771325a9)
+
+*  0.1.3 introduced a compatibility issue with previous versions of
+   Rhubarb.  These should be resolved here.
+
+version 0.1.3 (c5c095db4d5f22d0fff6633237859cd33a319884)
+
+*  This is a release featuring only minor enhancements to Rhubarb.  If 
+   you don't use Rhubarb, there is no need to upgrade.
+
+*  Rhubarb classes now support a delete_all method.
+
+*  Rhubarb now supports multiple backend databases, via an extra
+   parameter to Persistence::open and to the create_table class methods.
+   Note that it is not currently possible to have one class backed by
+   multiple databases.
+
+version 0.1.2 (2c45fd4d693a396e9206607a6f053b1eb4696272)
+
+*  Enhancements to SPQR/Rhubarb interoperability.  (Rhubarb row_ids are
+   now used for half of the QMF object ID).
+
+*  Enhancements to app skeleton class: now allows specifying username,
+   password, hostname, and port in the constructor to SPQR::App.
+
+version 0.1.1 (85c87b1239f730374d47e2d8baf795c8c69050f4)
+
+*  Other minor Rhubarb fixes.
+
+*  Rhubarb now properly handles persisting classes declared in
+   different modules and supports defining custom table names.
+
+*  spqr-gen now has preliminary support for generating classes that
+   persist via rhubarb.
+
+*  Fixes and cleanups to class- and package-name metadata.  Previously,
+   the app skeleton would fail to find some manageable classes
+   declared in separate Ruby modules.  In addition, the manageable
+   mixin now sets sensible default names for the QMF class and package
+   (when one is not provided within the class declaration).
+
+version 0.1.0 (3a3ca52c4f086d1f20fdf5ed89dda262622c171d)
+
+*  Note that this version breaks backwards compatibility, for reasons
+   mentioned below.  Most notably, the Manageable API names have changed,
+   and the old-style exposed-method declarations (with hash args) are no
+   longer supported in favor of a more idiomatic style.
+
+*  Exposed methods now use idiomatic parameter-passing style: input
+   (and in/out) parameters are passed in to methods by name (in the
+   order that they appear in the expose declaration), and output (and
+   in/out) values are returned in a list via a standard return
+   statement.  (Again, the order of output and in/out parameters is
+   specified by the order that they appear in the expose declaration.)
+
+*  Code generation now uses idiomatic parameter-passing style.  Code
+   generation should still be considered "alpha"-quality.
+
+*  Changed mixed-in method names from Manageable.
+
+version 0.0.4  (180897a77b55400b31d364a08cb9f81c423eb59f)
+
+*  Test suite is mainly stable (individual tests will sometimes hang
+   upon creating a QMF agent).
+*  This is probably the last version before I change the method call API.
+
+version 0.0.3  (060c7b5bcaa2711b3e3ce511c9c3ecaa59bf0de8)
+
+*  Agent-ready callback and parent-process notification (app.rb)
+*  The beginnings of an SPQR test suite
+
+version 0.0.2  (ecd94b141307c5f0f141833836ea686854cfda9c)
+
+*  First shaky pass at automated RPM packaging (see rpmspec and
+   srpm rake targets)
+*  Automatic find_all methods for Rhubarb persisting classes
+
+version 0.0.1  (0714a87f30469772fc302515e95576e329f7deb9)
+
+*  Gem support
+*  Codegen fixes
+
+version 0.0.0  (bbbc2e9d6983f773f6d093a821a0e635714ea869)
+
+*  Initial numbered release; corresponds roughly to the functionality
+   from the "Introducing SPQR" blog posts, but with an added Rakefile.

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,24 @@
+= rhubarb
+
+Rhubarb is a simple versioned object-graph persistence layer that
+stores instances of specially-declared Ruby classes in a SQLite3
+database.  It was developed for use with the SPQR project, but is
+independently useful (and independently updated).
+
+== Maintainer
+
+Will Benton (willb@redhat.com)
+
+== Patches and pull requests
+ 
+* Please add tests for any new features you add.
+* Send me a pull request; ideally, your functionality is on a topic branch forked from my master.
+
+== Credits
+
+* Thanks to William Henry for suggesting the "rhubarb" name
+* Gem support by technicalpickles' jeweler
+
+== Copyright
+
+Copyright (c) 2009--2010 Red Hat, Inc.  See LICENSE for details.

data/Rakefile

@@ -0,0 +1,99 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rhubarb"
+    gem.summary = %Q{Rhubarb:  object graph persistence, easy as pie}
+    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.}
+    gem.email = "willb@redhat.com"
+    gem.homepage = "http://git.fedorahosted.org/git/grid/rhubarb.git"
+    gem.authors = ["William Benton"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "sqlite3-ruby", ">= 1.2.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+def pkg_version
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  return version.chomp
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rhubarb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,12 @@
+* Test coverage of multiple-db situations
+* Test coverage of close-and-reopen db situations
+* Metadata stored in db files
+* Bring code coverage up to 100%
+* Documentation
+* Standalone examples (i.e. not just "please see the test suite")
+
+Legend:
+
+! --> highest priority
+* --> standard priority
+- --> low priority

data/VERSION

@@ -0,0 +1 @@
+0.2.0