perobs 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cea78483599ce586c57310a9d4aa622b3bfc3ca2
-  data.tar.gz: febaf3328e7a157a38529507a4a5a91a0bc49d2e
+  metadata.gz: a2fdb476312688171e078295e7b128663885249e
+  data.tar.gz: 26b0422a60677e6120ded2ff43943a8b805304ca
 SHA512:
-  metadata.gz: 6be86d3f49ff2e7bb816d7a6a257f07642b01cd8bdb94636fc2ccbd571fd225e0cd281786372051fc940f84f5440001ab5519994980775bd710c73fef59cffeb
-  data.tar.gz: fc1632708462f8f81b15f28f8a0226d49521443bf6fc6a0b0f1470efcec0a9f81412a08093f956718d84ab9e02b3c5f6e31fa37fa9da3b949250f8c5904a8200
+  metadata.gz: b415f4d0e12b9fd5e62ec6bc801911651970b70fcb52609a2f24c2d13b86bdcaa668207ac4723589ca8538950da9ddea23aae221e0d1b321c07574c2d211e619
+  data.tar.gz: e52498a83b9a21bc6514ec6e61d6ca310d9054ec68801042e4ed65cda8f6a4276bfd3e6b325daf22d6fa79084b787b72cabc77cddda6a0bf6679f1a83148d3c6

data/README.md

@@ -19,14 +19,14 @@ raised.
 It features a garbage collector that removes all objects that are no
 longer in use. A build-in cache keeps access latencies to recently
 used objects low and lazily flushes modified objects into the
-persistend back-end.
+persistend back-end when not using transactions.
 
 Persistent objects must be created by deriving your class from
 PEROBS::Object. Only instance variables that are declared via
-po_attr will be persistent. All objects that are stored in persitant
-instance variables must provide a to_json method that generates JSON
-syntax that can be parsed into their original object again. It is
-recommended that references to other objects are all going to persistent
+po_attr will be persistent. All objects that are stored in persistent
+instance variables must provide a to_json() method that generates JSON
+syntax that can be also parsed into their original object again. It is
+required that references to other objects are all going to persistent
 objects again.
 
 There are currently 3 kinds of persistent objects available:
@@ -40,12 +40,11 @@ There are currently 3 kinds of persistent objects available:
 * PEROBS::Hash provides an interface similar to the built-in Hash
   class but its objects are automatically stored.
 
-In addition to these classes, you also need to create a PEROBS::Store
-object that owns your persistent objects. The store provides the
-persistent database. If you are using the default serializer (JSON),
-you can only use the subset of Ruby types that JSON supports.
-Alternatively, you can use Marshal or YAML which support almost every
-Ruby data type.
+You must create at least one PEROBS::Store object that owns your
+persistent objects. The store provides the persistent database. If you
+are using the default serializer (JSON), you can only use the subset
+of Ruby types that JSON supports.  Alternatively, you can use Marshal
+or YAML which support almost every Ruby data type.
 
 Here is an example how to use PEROBS. Let's define a class that models
 a person with their family relations.
@@ -55,17 +54,23 @@ require 'perobs'
 
 class Person < PEROBS::Object
 
-  po_attr :name, :mother, :father, :kids
+  po_attr :name, :mother, :father, :kids, :spouse, :status
 
   def initialize(store, name)
     super
     attr_init(:name, name)
     attr_init(:kids, store.new(PEROBS::Array))
+    attr_init(:status, :single)
+  end
+
+  def merry(spouse)
+    self.spouse = spouse
+    self.status = :married
   end
 
   def to_s
-    "#{@name} is the child of #{self.mother ? self.mother.name : 'unknown'} " +
-    "and #{self.father ? self.father.name : 'unknown'}.
+    "#{@name} is the child of #{@mother ? @mother.name : 'unknown'} " +
+    "and #{@father ? @father.name : 'unknown'}.
   end
 
 end
@@ -84,6 +89,23 @@ store.sync
 When you run this script, a folder named 'family' will be created. It
 contains the 3 Person objects.
 
+### Accessing persistent instance variables
+
+All instance variables that should be persisted must be declared with
+'po_attr'. This will create the instance variable, a getter and setter
+method for it. These getter and setter methods are the recommended way
+to access instance variables both from ouside of the instances as well
+as from within. To access the setter or getter method from within an
+instance method use the self.<variable> notation.
+
+The @<variable> notation is also supported, but special care needs to
+be taken when modifying an instance variable. The setter methods will
+automatically take care of persisting the modified instance when
+required. If you use the @ notation for mutating instance variable
+accesses, you must manually mark the instance as modified by calling
+Object::mark_as_modified(). If that is forgotten, the change will
+reside in memory but might not be persisted into the database.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -100,6 +122,31 @@ Or install it yourself as:
 
     $ gem install perobs
 
+## Copyright and License
+
+Copyright (c) 2015, 2016 by Chris Schlaeger <chris@taskjuggler.org>
+
+PEROBS and all accompanying files are licensed under this MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 ## Contributing
 
 1. Fork it ( https://github.com/scrapper/perobs/fork )

data/lib/perobs/Object.rb

@@ -2,7 +2,7 @@
 #
 # = Object.rb -- Persistent Ruby Object Store
 #
-# Copyright (c) 2015 by Chris Schlaeger <chris@taskjuggler.org>
+# Copyright (c) 2015, 2016 by Chris Schlaeger <chris@taskjuggler.org>
 #
 # MIT License
 #
@@ -99,6 +99,21 @@ module PEROBS
       false
     end
 
+    # Call this method to manually mark the object as modified. This is
+    # necessary if you are using the '@' notation to access instance variables
+    # during assignment operations (=, +=, -=, etc.). To avoid having to call
+    # this method you can use the self. notation.
+    #
+    #   @foo = 42      # faster but requires call to mark_as_modified()
+    #   self.foo = 42  # somewhat slower
+    #
+    # IMPORTANT: If you use @foo = ... and forget to call mark_as_modified()
+    # your data will only be modified in memory but might not be persisted
+    # into the database!
+    def mark_as_modified
+      @store.cache.cache_write(self)
+    end
+
     # Return a list of all object IDs that the attributes of this instance are
     # referencing.
     # @return [Array of Fixnum or Bignum] IDs of referenced objects
@@ -142,7 +157,11 @@ module PEROBS
       "{\n" +
       _all_attributes.map do |attr|
         ivar = ('@' + attr.to_s).to_sym
-        "  #{attr.inspect}=>#{instance_variable_get(ivar).inspect}"
+        if (value = instance_variable_get(ivar)).respond_to?('is_poxreference?')
+          "  #{attr}=>#{value.class}:#{value._id}"
+        else
+          "  #{attr}=>#{value}"
+        end
       end.join(",\n") +
       "\n}\n"
     end

data/lib/perobs/version.rb

@@ -1,4 +1,4 @@
 module PEROBS
   # The version number
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perobs
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Chris Schlaeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2016-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler