rod 0.7.1 → 0.7.2

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm: 1.9.2
 before_script:
-  - "apt-get install libdb4.6-dev"
+  - "sudo apt-get install libdb4.8-dev"

data/README.rdoc

@@ -1,6 +1,8 @@
 = ROD -- Ruby Object Database
 
-* http://github.com/apohllo/rod
+* http://github.com/apohllo/rod - source code
+* http://rubydoc.info/github/apohllo/rod/master/frames - API
+* https://www.relishapp.com/apohllo/rod - Cucumber features
 
 == WARNING
 
@@ -15,22 +17,28 @@ fast access for data, which rarely changes.
 
 == FEATURES:
 
-* nice Ruby interface which mimicks Active Record
+* object-oriented Ruby interface
 * Ruby-to-C on-the-fly translation based on mmap and RubyInline
 * optimized for (reading) speed
 * weak reference collections for easy memory reclaims
 * Berkeley DB hash index for the best index performance
+* immediate updates of hash indices
 * compatibility check of library version
 * compatibility check of data model
-* autogeneration of model (based on the database metadata)
-* automatic model migrations (limitied to addition/removal of properties and indexes)
+* auto-generation of model (based on the database meta-data)
+* automatic model migrations (limited to addition/removal of properties and indexes)
 * full update of the database (removal of objects not available yet)
 * databases interlinking (via direct links or inverted indices)
+* data portability between big and little-endian systems
+* works on Linux and BSD
 
 == PROBLEMS
 
 * tested mostly on 64-bit systems
 * doesn't work on Windows
+* concurrent writes not supported
+* batch-only data input/update
+* data removal not supported
 
 == SYNOPSIS:
 
@@ -71,7 +79,7 @@ number of disk reads was designed. The Ruby interface facilitates it's usage.
 
 == TROUBLESHOOTING
 
-If you get the following error during library usage:
+If you get the following error:
 
   error: db.h: No such file or directory
 
@@ -79,6 +87,19 @@ then you don't have Berkeley DB installed or its header fiels are not available
 on the default path. Make sure that the library is installed and the headers
 are available.
 
+If you get the following error:
+
+  .ruby: symbol lookup error: /home/vagrant/.ruby_inline/... undefined symbol: db_env_create
+
+then you have to provide system-specific linker information. By default the library
+is linked with '-ldb' linker flag. To change it you have to set up ROD_BDB_LINK_FLAGS
+environment variable, e.g.
+
+   ROD_BDB_LINK_FLAGS='-ldb-4.8'
+   export ROD_BDB_LINK_FLAGS
+
+This configuration option will select the libdb-4.8.so library.
+
 == BASIC USAGE:
 
  class MyDatabase < Rod::Database
@@ -107,7 +128,7 @@ are available.
    field :data, :string
  end
 
- MyDatabase.create_database("data")
+ MyDatabase.instance.create_database("data")
  user = User.new(:name => 'Fred',
                  :surname => 'Smith',
                  :age => 22)
@@ -127,9 +148,9 @@ are available.
  account.store
  file1.store
  file2.store
- MyDatabase.close_database
+ MyDatabase.instance.close_database
 
- MyDatabase.open_database("data")
+ MyDatabase.instance.open_database("data")
  User.each do |user|
    puts "Name: #{user.name} surname: #{user.surname}"
    puts "login: #{user.account.login} e-mail: #{user.account.email}"
@@ -170,11 +191,18 @@ Then be sure to write tests covering the added feature/fixed bug.
 Include the tests in Rakefile, run the tests and if everything is fine
 send me a pull request.
 
+== BENCHMARKS:
+
+There is a separate project available under http://github.com/apohllo/rod-benchmark
+that shows how ROD behave compared to the other storage engines.
+It should be noted that this benchmarks are biased towards the design goals
+of ROD. So don't expect general purpose database tests.
+
 == LICENSE:
 
-(The MIT License)
+(The MIT/X11 License)
 
-Copyright (c) 2008-2011 Aleksander Pohl
+Copyright (c) 2008-2012 Aleksander Pohl
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -27,7 +27,7 @@ task :uninstall do
   sh "sudo gem uninstall #$gem_name"
 end
 
-task :all_tests => [:test,:regression_test,:spec] do
+task :all_tests => [:test,:unit_test,:regression_test,:features] do
 end
 
 desc "Run performence tests"
@@ -37,7 +37,7 @@ task :perf do
   sh "ruby tests/full_runs.rb"
 end
 
-desc "Run tests and specs"
+desc "Run multi-step tests"
 task :test do
   sh "ruby tests/save_struct.rb"
   sh "ruby tests/load_struct.rb"
@@ -47,17 +47,28 @@ task :test do
   sh "ruby tests/generate_classes_rewrite.rb"
   sh "ruby tests/generate_classes_rewrite.rb"
   sh "ruby tests/generate_classes_verify.rb"
-  sh "ruby tests/migration_create.rb 1000"
-  sh "ruby tests/migration_migrate.rb 1000"
-  sh "ruby tests/migration_verify.rb 1000"
+  # TODO #206 fix index migration
+  #sh "ruby tests/migration_create.rb 1000"
+  #sh "ruby tests/migration_migrate.rb 1000"
+  #sh "ruby tests/migration_verify.rb 1000"
   sh "ruby tests/missing_class_create.rb"
   sh "ruby tests/missing_class_verify.rb"
   sh "ruby tests/properties_order_create.rb"
   sh "ruby tests/properties_order_verify.rb"
-  sh "ruby tests/unit/model.rb"
+end
+
+desc "Run unit tests and model specs"
+task :unit_test do
   sh "ruby tests/unit/model_tests.rb"
   sh "ruby tests/unit/database.rb"
   sh "ruby tests/unit/abstract_database.rb"
+  sh "ruby spec/property/base.rb"
+  sh "ruby spec/property/field.rb"
+  sh "ruby spec/property/singular_association.rb"
+  sh "ruby spec/property/plural_association.rb"
+  sh "ruby spec/berkeley/environment.rb"
+  sh "ruby spec/berkeley/database.rb"
+  sh "ruby spec/berkeley/transaction.rb"
 end
 
 # Should be removed some time -- specs should cover all these cases
@@ -66,12 +77,12 @@ task :regression_test do
   sh "ruby tests/check_strings.rb"
 end
 
-desc "Run all specs without the ignored ones"
-task :spec do
+desc "Run all cucumber features without the ignored ones"
+task :features do
   sh "bundle exec cucumber --tags ~@ignore features/*"
 end
 
-desc "Run only work-in-progress specs"
+desc "Run only work-in-progress features"
 task :wip do
   sh "bundle exec cucumber --tags @wip features/*"
 end

data/changelog.txt

@@ -1,3 +1,28 @@
+0.7.2
+- Fix variable declaration place #118
+- Implementation of & and | for collection proxies
+- Fix strange error caused by mocha #219
+- Change compile flags to link flags and API accordingly #200
+- Fix memleak when growing DB file #211
+- Change hash cache size to 0.5 MB
+- Add flags needed on BSD #215
+- Fix destroy of hash index #217 #218
+- Immediate hash index updates #209 #213
+- Add method for computing collections' intersection size #224
+- Add hash index compile flags env. variable #223
+- Add negative float values in basic feature
+- #204 fix features for out-of-scope indexing
+- Fix: too large values for 32-bit systems in tests
+- Remove old unit tests
+- Change directory of Berkeley env
+- #199 spec and new implementation for Model#[]
+- Change libdb to 4.8 in travis script
+- Updated links and year, note about benchmarks
+- Berkeley DB building blocks
+- Update requires for latest Active Model
+- Allow latest version of active model to be used
+- Fix example in README
+- #190 #98 #173 refactoring of properties
 0.7.1
 - #189 guard object load against empty strings.
 - Don't close hash index when it is destroyed.

data/contributors.txt

@@ -1,3 +1,4 @@
 People who contributed to Ruby Object Database:
 * Piotr Gurgul
 * Marcin Sieniek
+* Rafal Michalski

data/data/backward/0.7.0/database.yml

@@ -0,0 +1,58 @@
+--- 
+Rod: 
+  :version: 0.7.0
+  :created_at: 2012-04-30 10:49:34.260940 +02:00
+  :updated_at: 2012-04-30 10:49:34.281290 +02:00
+Rod::JoinElement: 
+  :superclass: Rod::AbstractModel
+  :count: 1
+Rod::PolymorphicJoinElement: 
+  :superclass: Rod::JoinElement
+  :count: 0
+Rod::StringElement: 
+  :superclass: Rod::AbstractModel
+  :count: 25
+RodTest::Automobile: 
+  :superclass: RodTest::TestModel
+  :fields: 
+    :name: 
+      :options: 
+        :type: :string
+  :count: 1
+RodTest::Caveman: 
+  :superclass: RodTest::TestModel
+  :fields: 
+    :name: 
+      :options: 
+        :type: :string
+    :age: 
+      :options: 
+        :type: :integer
+    :identifier: 
+      :options: 
+        :type: :ulong
+    :height: 
+      :options: 
+        :type: :float
+    :account_balance: 
+      :options: 
+        :type: :float
+  :has_one: 
+    :automobile: 
+      :options: {}
+
+  :has_many: 
+    :dogs: 
+      :options: {}
+
+  :count: 1
+RodTest::Dog: 
+  :superclass: RodTest::TestModel
+  :fields: 
+    :nickname: 
+      :options: 
+        :type: :string
+  :count: 1
+RodTest::TestModel: 
+  :superclass: Rod::Model
+  :count: 0

data/data/portability/database.yml

@@ -0,0 +1,49 @@
+--- 
+Rod: 
+  :version: 0.7.1
+  :created_at: 2012-05-02 01:00:18.322307 +02:00
+  :updated_at: 2012-05-02 01:00:18.380358 +02:00
+Rod::JoinElement: 
+  :superclass: Rod::AbstractModel
+  :count: 1
+Rod::PolymorphicJoinElement: 
+  :superclass: Rod::JoinElement
+  :count: 0
+Rod::StringElement: 
+  :superclass: Rod::AbstractModel
+  :count: 25
+RodTest::Automobile: 
+  :superclass: RodTest::TestModel
+  :fields: 
+    :name: 
+      :type: :string
+  :count: 1
+RodTest::Caveman: 
+  :superclass: RodTest::TestModel
+  :fields: 
+    :name: 
+      :type: :string
+    :age: 
+      :type: :integer
+    :identifier: 
+      :type: :ulong
+    :height: 
+      :type: :float
+    :account_balance: 
+      :type: :float
+  :has_one: 
+    :automobile: {}
+
+  :has_many: 
+    :dogs: {}
+
+  :count: 1
+RodTest::Dog: 
+  :superclass: RodTest::TestModel
+  :fields: 
+    :nickname: 
+      :type: :string
+  :count: 1
+RodTest::TestModel: 
+  :superclass: Rod::Model
+  :count: 0

data/features/backward.feature

@@ -0,0 +1,33 @@
+Feature: Data backward compatiblity
+    The data scheme should be compatible between certain library versions.
+    Some of the scenarios might be ignored and run only directly to
+    indicate the incompatiblities.
+  Background:
+    Given the library works in development mode
+
+  @ignore
+  Scenario: compatiblity with version 0.7.0
+      To make the data compatible, the 'options' key should be removed from 
+      the database.yml
+    Given the class space is cleared
+    And the model is connected with the default database
+    And a class Caveman has a name field of type string
+    And a class Caveman has an age field of type integer
+    And a class Caveman has an identifier field of type ulong
+    And a class Caveman has a height field of type float
+    And a class Caveman has a account_balance field of type float
+    And a class Automobile has a name field of type string
+    And a class Caveman has one automobile
+    And a class Dog has a nickname field of type string
+    And a class Caveman has many dogs
+    When I open the database for reading in data/backward/0.7.0
+    Then there should be 1 Caveman
+    And there should be 1 Dog
+    And there should be 1 Automobile
+    And the name of the first Caveman should be 'Fred'
+    And the age of the first Caveman should be '25'
+    And the identifier of the first Caveman should be '111222333'
+    And the height of the first Caveman should be '1.86'
+    And the account_balance of the first Caveman should be '-0.00000001'
+    And the automobile of the first Caveman should be equal to the first Automobile persisted
+    And the first of dogs of the first Caveman should be equal to the first Dog persisted

data/features/basic.feature

@@ -38,6 +38,7 @@ Feature: Store and load small amount of data from one class
     And a class Caveman has an age field of type integer
     And a class Caveman has an identifier field of type ulong
     And a class Caveman has a height field of type float
+    And a class Caveman has a account_balance field of type float
     And a class Caveman has a symbol field of type object
     And a class Caveman has a empty_string field of type string
     And a class Caveman has a empty_object field of type object
@@ -47,6 +48,7 @@ Feature: Store and load small amount of data from one class
     And his age is '25'
     And his identifier is '111222333'
     And his height is '1.86'
+    And his account_balance is '-0.00000001'
     And his symbol is ':fred'
     # nil is converted to an empty string, consider using object field
     # if you wish to store nil for string fields
@@ -61,6 +63,7 @@ Feature: Store and load small amount of data from one class
     And the age of the first Caveman should be '25'
     And the identifier of the first Caveman should be '111222333'
     And the height of the first Caveman should be '1.86'
+    And the account_balance of the first Caveman should be '-0.00000001'
     And the symbol of the first Caveman should be ':fred'
     And the empty_string of the first Caveman should be ''
     And the empty_object of the first Caveman should be nil

data/features/collection_proxy.feature

@@ -143,3 +143,98 @@ Feature: collection proxy specification
     Given the initial size of the collection proxy is 5
     # Can't figure out anything better.
     Then an exception should be raised when the collection is modified during iteration
+
+  Scenario: fast intersection computing
+    Given the class space is cleared
+    And the model is connected with the default database
+    And a class Caveman has a name field of type string
+    And a class Automobile has a name field of type string
+    And a class Caveman has many automobiles
+    When the database is created
+    And I create an Automobile
+    And its name is 'Car 1'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 2'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 3'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 4'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 5'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 6'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 7'
+    And I store it in the database
+    And I create a Caveman
+    And his name is 'Fred'
+    # The automobiles have to be in the creation order, since this is assumed by the
+    # fast intersection computation routine.
+    And his automobiles contain the first Automobile created
+    And his automobiles contain the second Automobile created
+    And his automobiles contain the third Automobile created
+    And his automobiles contain the fourth Automobile created
+    And I store him in the database
+    And I create another Caveman
+    And his name is 'Bill'
+    And his automobiles contain the third Automobile created
+    And his automobiles contain the fourth Automobile created
+    And his automobiles contain the fifth Automobile created
+    And his automobiles contain the sixth Automobile created
+    And his automobiles contain the seventh Automobile created
+    And I store him in the database
+    And I reopen database for reading
+    Then there should be 2 Caveman(s)
+    And there should be 7 Automobile(s)
+    And the first Caveman should have 4 automobiles
+    And the second Caveman should have 5 automobiles
+    And the intersection size of automobiles of the first and the second Caveman should equal 2
+
+    When the database is created
+    And I create an Automobile
+    And its name is 'Car 1'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 2'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 3'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 4'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 5'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 6'
+    And I store it in the database
+    And I create another Automobile
+    And its name is 'Car 7'
+    And I store it in the database
+    And I create a Caveman
+    And his name is 'Fred'
+    And his automobiles contain the first Automobile created
+    And his automobiles contain the fifth Automobile created
+    And his automobiles contain the sixth Automobile created
+    And his automobiles contain the seventh Automobile created
+    And I store him in the database
+    And I create another Caveman
+    And his name is 'Bill'
+    And his automobiles contain the first Automobile created
+    And his automobiles contain the second Automobile created
+    And his automobiles contain the third Automobile created
+    And his automobiles contain the sixth Automobile created
+    And I store him in the database
+    And I reopen database for reading
+    Then there should be 2 Caveman(s)
+    And there should be 7 Automobile(s)
+    And the first Caveman should have 4 automobiles
+    And the second Caveman should have 4 automobiles
+    And the intersection size of automobiles of the first and the second Caveman should equal 2