ricordami 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog #
 
+## 0.0.2 (March 5th, 2011)
+
+  - added examples and fixed README
+  - created a basic Ricordami::Model#to_s method
+
 ## 0.0.1 (March 5th, 2011)
 
 Initial release.

data/README.md

@@ -12,11 +12,12 @@ not ready for use yet.</div>
 
     require "ricordami"
 
-    Ricordami::Model.configure do |config|
+    Ricordami::configure do |config|
       config.redis_host = "127.0.0.1"
       config.redis_port = 6379
-      config.redis_db   = 0
+      config.redis_db   = 15
     end
+    Ricordami.redis.flushdb
 
     class Singer
       include Ricordami::Model
@@ -36,8 +37,10 @@ not ready for use yet.</div>
 
       model_can :be_queried, :have_relationships
 
-      attribute :title, :indexed => :unique, :get_by => true
-      attribute :year
+      attribute :title
+      attribute :year, :indexed => :value
+
+      index :unique => :title, :get_by => true
 
       referenced_in :singer
     end
@@ -45,7 +48,7 @@ not ready for use yet.</div>
     serge = Singer.create :name => "Gainsbourg"
     jetaime = serge.songs.create :title => "Je T'Aime Moi Non Plus", :year => "1967"
     jetaime.year = "1968"
-    jetaime.changes  # => {:year => ["1967", "1968"]}
+    p :changes, jetaime.changes  # => {:year => ["1967", "1968"]}
     jetaime.save
     ["La Javanaise", "Melody Nelson", "Love On The Beat"].each do |name|
       serge.songs.create :title => name, :year => "1962"
@@ -53,8 +56,9 @@ not ready for use yet.</div>
     Song.get_by_title("Melody Nelson").update_attributes(:year => "1971")
     Song.get_by_title("Love On The Beat").update_attributes(:year => "1984")
 
-    Song.count  # => 3
-    Song.where(:year => "1971").map(&:title)  # => "Melody Nelson"
+    p :count, Song.count  # => 4
+    p :all, Song.all.map(&:title)
+    p :where, Song.where(:year => "1971").map(&:title)  # => "Melody Nelson"
 
 
 ## How To Install? ##
@@ -94,13 +98,15 @@ source code:
     Ricordami::Model.configure do |config|
       config.redis_host  = "redis.lab"
       config.redis_port  = 6379
+      config.redis_db    = 0
       config.thread_safe = true
     end
 
 Or using a hash:
 
     Ricordami.configure do |config|
-      config.from_hash(YAML.load("config.yml"))
+      values = YAML.load(File.expand_path("../../config.yml"))
+      config.from_hash(values)
     end
 
 ### Declare A Model ###
@@ -116,6 +122,24 @@ additional features using the class method **#model_can**.
                 :have_relationships
     end
 
+A model class has the following methods:
+
+  - *#get* - lookup an instance by id (i.e.: Singer.get(2))
+  - *#[]* - alias for *#get* (i.e.: Singer[2])
+  - *#all* - return all existing instances
+  - *#count* - return the number of existing instances
+
+and a model instance the following expected instance methods:
+
+  - *#save*
+  - *#delete*
+  - *#update_attributes*
+  - *#reload*
+
+Both class and instances have a shortcut access to the redis object
+(that uses the *redis* gem).
+
+
 ### Declare Attributes ###
 
 The model state is stored in attributes. Those attributes can be indexed
@@ -150,10 +174,10 @@ Example:
       attribute :age,  :type => :integer
     end
 
-    zhanna = Person.create(:name => "Zhanna", :sex => "Female", :age => 29
-    zhanna.id                  # => 42
-    Person[42].name            # => "Zhanna"
-    Person.get_by_id(42).name  # => "Zhanna"
+    zhanna = Person.create(:name => "Zhanna", :sex => "Female", :age => 29)
+    p :id, zhanna.id              # => "1"
+    p :[], Person["1"].name       # => "Zhanna"
+    p :get, Person.get("1").name  # => "Zhanna"
 
 Methods:
 
@@ -256,12 +280,14 @@ Better go with an example to make it all clear:
     osez = bashung.songs.build(:title => "Osez Josephine")
     osez.save
     gaby = bashung.songs.create(:title => "Vertiges de l'Amour")
-    bashung.songs.map(&:title)  # => ["Osez Josephine", "Vertiges de l'Amour"]
-    gaby.singer_id == bashung.id  # => true
+    p :songs, bashung.songs.map(&:title)  # => ["Osez Josephine", "Vertiges de l'Amour"]
+    p :singer_id, gaby.singer_id == bashung.id  # => true
 
     padam = Song.create(:title => "Padam")
-    benjamin = padam.create_singer(:name => "Benjamin Biolay")
-    benjamin.songs.map(&:title)  # => "Padam"
+    p :padam, padam
+    benjamin = padam.build_singer(:name => "Benjamin Biolay")
+    p :benjamin, benjamin
+    p :songs, benjamin.songs.map(&:title)  # => "Padam"
 
 The class methods **#references_many**, **#references_one** and
 **#referenced_by** can take the following options:
@@ -335,27 +361,30 @@ of an operator among AT&amp;T, Qwest and Level3.
       attribute :dnis,      :indexed => :value
       attribute :call_type, :indexed => :value
       attribute :network,   :indexed => :value
-      attribute :seconds,   :type => :integer
+      attribute :seconds, :type => :integer
 
-      referenced_in :tenant, :as owner
+      referenced_in :tenant, :as => :owner
 
       validates_presence_of  :call_type, :seconds, :owner_id
       validates_inclusion_of :call_type, :in => ["pots", "voip"]
       validates_inclusion_of :network,   :in => ["att", "qwest", "level3"]
     end
 
-    # what is the total number of seconds of the phone calls made from
-    # the phone number 650 123 4567?
-    Call.where(:ani => "6501234567").inject(0) { |sum, call| sum + call.seconds }
+    # ...create tenant and calls...
 
-    # what are the VoIP calls that didn't go through Level3 network?
-    Call.where(:call_type => "voip").not(:network => "level3").all
+    # What is the total number of seconds of the phone calls made from the phone number 650 123 4567?
+    seconds = Call.where(:ani => "6501234567").inject(0) { |sum, call| sum + call.seconds }
+    puts "  => seconds = #{seconds}"
 
-    # what are the calls for tenant "mycompany" that went through
-    # AT&amp;T's network or originated from ANI 408 123 4567? but were
-    # not VoIP calls?
+    # What are the VoIP calls that didn't go through Level3 network?
+    calls = Call.where(:call_type => "voip").not(:network => "level3")
+    puts "  => #{calls.inspect}"
+
+    # What are the calls for tenant "mycompany" that went through AT&amp;T's network or originated from ANI 408 123 4567? but were not VoIP calls?
     mycompany = Tenant.get_by_name("mycompany")
-    mycompany.calls.any(:ani => "4081234567", :network => "att").not(:call_type => "voip").all
+    calls = mycompany.calls.any(:ani => "4081234567", :network => "att").not(:call_type => "voip")
+    puts "  => #{calls.count} calls"
+    puts "  => first page of 10: #{calls.paginate(:page => 1, :per_page => 10).inspect}"
 
 
 ## How To Run Specs ##
@@ -382,8 +411,8 @@ Ruby Enterprise:
     $ rvm install ree-1.8.7-2011.03 # install if necessary
     $ rvm use ree-1.8.7-2011.03
     $ rvm gemset create ricordami
-    $ gem install bundler --no-ri --no-rdoc
     $ rvm gemset use ricordami
+    $ gem install bundler --no-ri --no-rdoc
     $ bundle
 
 Rubinius:

data/examples/calls.rb

@@ -1,15 +1,31 @@
 #!/usr/bin/env ruby
-#$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
+require "pp"
 require "rubygems"
 require "ricordami"
 
-Ricordami.configure do |config|
-  config.redis_host = "127.0.0.1"
-  config.redis_port = 6379
-  config.redis_db   = 15
+module ValueGenerator
+  extend self
+
+  CALL_TYPES = ["pots", "voip"]
+  NETWORKS = ["att", "qwest", "level3"]
+
+  def phone_number
+    "xxxxxxxxxx".split('').map { rand(10) }.join
+  end
+
+  def call_type
+    CALL_TYPES[rand(CALL_TYPES.length)]
+  end
+
+  def networks
+    NETWORKS[rand(NETWORKS.length)]
+  end
 end
-Ricordami.driver.flushdb
+
+Ricordami.redis.select(15)
+Ricordami.redis.flushdb
 
 class Tenant
   include Ricordami::Model
@@ -41,18 +57,46 @@ class Call
   validates_inclusion_of :network,   :in => ["att", "qwest", "level3"]
 end
 
-t = Tenant.create(:name => "mycompany")
-t.calls.create(:ani => "6501234567", :dnis => "911", :call_type => "pots", :network => "qwest", :seconds => 42)
-# TODO: create more calls
+tenants = %w(mycompany blah foo bar sowhat hereitgoesagain).map { |name| Tenant.create(:name => name) }
+
+12.times do |i|
+  t = tenants[rand(tenants.length)]
+  t.calls.create(:ani => "6501234567",
+                 :dnis => ValueGenerator.phone_number,
+                 :call_type => ValueGenerator.call_type,
+                 :network => ValueGenerator.networks,
+                 :seconds => 10 * i)
+end
+
+123.times do |i|
+  t = tenants[rand(tenants.length)]
+  t.calls.create(:ani => ValueGenerator.phone_number,
+                 :dnis => ValueGenerator.phone_number,
+                 :call_type => "voip",
+                 :network => "level3",
+                 :seconds => 10 + rand(3600))
+end
+
+t = tenants[rand(tenants.length)]
+t.calls.create(:ani => "you-found@me", :dnis => "911", :call_type => "voip", :network => "qwest", :seconds => 42)
+
+50.times do |i|
+  t = tenants.first
+  t.calls.create(:ani => "4081234567",
+                 :dnis => ValueGenerator.phone_number,
+                 :call_type => "pots",
+                 :network => "att",
+                 :seconds => 10 + rand(3600))
+end
 
 puts <<EOC
 ?? What is the total number of seconds of the phone calls made from the phone number 650 123 4567?
 EOC
 seconds = Call.where(:ani => "6501234567").inject(0) { |sum, call| sum + call.seconds }
-puts "  => seconds = #{seconds}"
+puts "  => seconds = #{seconds} (should be 780)"
 
-puts "?? What are the VoIP calls that didn't go through Level3 network?"
-calls = Call.where(:call_type => "voip").not(:network => "level3")
+puts "?? What are the VoIP calls from ani 'you-found@me' that didn't go through Level3 network?"
+calls = Call.where(:call_type => "voip", :ani => "you-found@me").not(:network => "level3").all
 puts "  => #{calls.inspect}"
 
 puts <<EOC
@@ -60,5 +104,6 @@ puts <<EOC
 EOC
 mycompany = Tenant.get_by_name("mycompany")
 calls = mycompany.calls.any(:ani => "4081234567", :network => "att").not(:call_type => "voip")
-puts "  => #{calls.count} calls"
-puts "  => first page of 10: #{calls.paginate(:page => 1, :per_page => 10).inspect}"
+puts "  => #{calls.count} calls (should be 50)"
+puts "  => first page of 10:"
+pp calls.paginate(:page => 1, :per_page => 10)

data/examples/person.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "rubygems"
+require "ricordami"
+
+Ricordami.redis.select(15)
+Ricordami.redis.flushdb
+
+class Person
+  include Ricordami::Model
+  attribute :name, :default => "First name, Last name"
+  attribute :sex,  :indexed => :value
+  attribute :age,  :type => :integer
+end
+
+zhanna = Person.create(:name => "Zhanna", :sex => "Female", :age => 29)
+p :id, zhanna.id            # => "1"
+p :[], Person[1].name       # => "Zhanna"
+p :get, Person.get(1).name  # => "Zhanna"

data/examples/singers.rb

@@ -1,15 +1,11 @@
 #!/usr/bin/env ruby
-#$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
 
 require "rubygems"
 require "ricordami"
 
-Ricordami.configure do |config|
-  config.redis_host = "127.0.0.1"
-  config.redis_port = 6379
-  config.redis_db   = 0
-end
-Ricordami.driver.flushdb
+Ricordami.redis.select(15)
+Ricordami.redis.flushdb
 
 class Singer
   include Ricordami::Model
@@ -32,11 +28,11 @@ bashung.songs  # => []
 osez = bashung.songs.build(:title => "Osez Josephine")
 osez.save
 gaby = bashung.songs.create(:title => "Vertiges de l'Amour")
-p bashung.songs.map(&:title)  # => ["Osez Josephine", "Vertiges de l'Amour"]
-p gaby.singer_id == bashung.id  # => true
+p :songs, bashung.songs.map(&:title)  # => ["Osez Josephine", "Vertiges de l'Amour"]
+p :singer_id, gaby.singer_id == bashung.id  # => true
 
 padam = Song.create(:title => "Padam")
 p :padam, padam
 benjamin = padam.build_singer(:name => "Benjamin Biolay")
 p :benjamin, benjamin
-p benjamin.songs.map(&:title)  # => "Padam"
+p :songs, benjamin.songs.map(&:title)  # => "Padam"

data/examples/summary.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "rubygems"
+require "ricordami"
+
+Ricordami::configure do |config|
+  config.redis_host = "127.0.0.1"
+  config.redis_port = 6379
+  config.redis_db   = 15
+end
+Ricordami.redis.flushdb
+
+class Singer
+  include Ricordami::Model
+
+  model_can :be_validated, :have_relationships
+
+  attribute :name
+
+  validates_presence_of :name
+  validates_uniqueness_of :name
+
+  references_many :songs
+end
+
+class Song
+  include Ricordami::Model
+
+  model_can :be_queried, :have_relationships
+
+  attribute :title
+  attribute :year, :indexed => :value
+
+  index :unique => :title, :get_by => true
+
+  referenced_in :singer
+end
+
+serge = Singer.create :name => "Gainsbourg"
+jetaime = serge.songs.create :title => "Je T'Aime Moi Non Plus", :year => "1967"
+jetaime.year = "1968"
+p :changes, jetaime.changes  # => {:year => ["1967", "1968"]}
+jetaime.save
+["La Javanaise", "Melody Nelson", "Love On The Beat"].each do |name|
+  serge.songs.create :title => name, :year => "1962"
+end
+Song.get_by_title("Melody Nelson").update_attributes(:year => "1971")
+Song.get_by_title("Love On The Beat").update_attributes(:year => "1984")
+
+p :count, Song.count  # => 4
+p :all, Song.all.map(&:title)
+p :where, Song.where(:year => "1971").map(&:title)  # => "Melody Nelson"

data/lib/ricordami/connection.rb

@@ -3,13 +3,13 @@ module Ricordami
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def driver
-        @driver ||= create_driver
+      def redis
+        @redis ||= create_redis
       end
 
       private
 
-      def create_driver
+      def create_redis
         c = self.configuration
         Redis.new(:host         => c.redis_host,
                   :port         => c.redis_port,

data/lib/ricordami/is_persisted.rb

@@ -29,7 +29,7 @@ module Ricordami
       end
 
       def redis
-        @redis ||= Ricordami.driver
+        @redis ||= Ricordami.redis
       end
     end
 
@@ -55,12 +55,12 @@ module Ricordami
       def save(opts = {})
         raise ModelHasBeenDeleted.new("can't save a deleted model") if deleted?
         set_initial_attribute_values if new_record?
-        redis.tap do |driver|
+        redis.tap do |redis|
           session = {}
-          driver.multi
-          driver.hmset(attributes_key_name, *attributes.to_a.flatten)
+          redis.multi
+          redis.hmset(attributes_key_name, *attributes.to_a.flatten)
           self.class.save_queue.each { |block| block.call(self, session) } if self.class.save_queue
-          driver.exec
+          redis.exec
         end
         @persisted = true
         attributes_synced_with_db!
@@ -99,12 +99,12 @@ module Ricordami
       end
 
       def execute_delete(db_commands)
-        redis.tap do |driver|
-          driver.multi
+        redis.tap do |redis|
+          redis.multi
           db_commands.each do |message, args|
-            driver.send(message, *args)
+            redis.send(message, *args)
           end
-          driver.exec
+          redis.exec
         end
       end
 
@@ -118,6 +118,16 @@ module Ricordami
       def redis
         self.class.redis
       end
+
+      def to_s
+        [
+          "#<#{self.class}:0x#{object_id.to_s(16)}",
+          "persisted?(#{persisted?.inspect})",
+          "new_record?(#{new_record?.inspect})",
+          "deleted?(#{deleted?.inspect})",
+          "attributes=#{attributes.inspect}>"
+        ].join(" ")
+      end
     end
   end
 end

data/lib/ricordami/version.rb

@@ -1,3 +1,3 @@
 module Ricordami
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/ricordami/connection_spec.rb

@@ -17,9 +17,9 @@ describe Ricordami::Connection do
     end
 
     it "has a connection to Redis" do
-      Mixer.driver.should be_a(Redis)
-      Mixer.driver.get("not_exist")
-      Mixer.driver.client.connection.should be_connected
+      Mixer.redis.should be_a(Redis)
+      Mixer.redis.get("not_exist")
+      Mixer.redis.client.connection.should be_connected
     end
   end
 end

data/spec/ricordami/is_persisted_spec.rb

@@ -17,8 +17,8 @@ describe Ricordami::IsPersisted do
   end
 
   it "returns the redis driver instance with #redis" do
-    Tenant.redis.should == Ricordami.driver
-    Tenant.new.redis.should == Ricordami.driver
+    Tenant.redis.should == Ricordami.redis
+    Tenant.new.redis.should == Ricordami.redis
   end
 
   describe "#save & #create" do
@@ -26,7 +26,7 @@ describe Ricordami::IsPersisted do
       it "persists a new model" do
         Tenant.attribute :balance
         persister_action.call
-        attributes = Ricordami.driver.hgetall("Tenant:att:jojo")
+        attributes = Ricordami.redis.hgetall("Tenant:att:jojo")
         attributes["id"].should == "jojo"
         attributes["balance"].should == "-$99.98"
       end
@@ -153,7 +153,7 @@ describe Ricordami::IsPersisted do
 
     it "deletes the attributes from the DB" do
       tenant.delete.should be_true
-      from_db = Ricordami.driver.hgetall("Tenant:att:myid")
+      from_db = Ricordami.redis.hgetall("Tenant:att:myid")
       from_db.should be_empty
     end
 

data/spec/ricordami/model_spec.rb

@@ -28,6 +28,9 @@ describe Ricordami::Model do
       user.to_model.should == user
     end
 
+    it "has a simple to_s method" do
+    end
+
     describe "#to_key" do
       before(:each) do
         @user = User.new

data/spec/ricordami/unique_index_spec.rb

@@ -25,27 +25,27 @@ describe Ricordami::UniqueIndex do
 
   it "adds a string to the index with #add" do
     @index.add("ze-id", "allo")
-    Ricordami.driver.smembers("DataSource:udx:id").should == ["allo"]
+    Ricordami.redis.smembers("DataSource:udx:id").should == ["allo"]
   end
 
   it "also indices the hash index with #add if fields is not :id and :get_by is true" do
     DataSource.attribute :domain
     other = subject.new(DataSource, [:name, :domain], :get_by => true)
     other.add("ze-id", ["jobs", "apple.com"])
-    Ricordami.driver.smembers("DataSource:udx:name_domain").should == ["jobs_-::-_apple.com"]
-    Ricordami.driver.hget("DataSource:hsh:name_domain_to_id", "jobs_-::-_apple.com").should == "ze-id"
+    Ricordami.redis.smembers("DataSource:udx:name_domain").should == ["jobs_-::-_apple.com"]
+    Ricordami.redis.hget("DataSource:hsh:name_domain_to_id", "jobs_-::-_apple.com").should == "ze-id"
   end
 
   it "doesn't index the has index with #add if :get_by is false or fields is :id" do
     one = subject.new(DataSource, :name)
     one.add("ze-id", "jobs")
-    Ricordami.driver.hexists("DataSource:hsh:name_to_id", "jobs").should be_false
+    Ricordami.redis.hexists("DataSource:hsh:name_to_id", "jobs").should be_false
     two = subject.new(DataSource, :id, :get_by => true)
     two.add("ze-id", "ze-id")
-    Ricordami.driver.hexists("DataSource:hsh:id_to_id", "ze-id").should be_false
+    Ricordami.redis.hexists("DataSource:hsh:id_to_id", "ze-id").should be_false
     three = subject.new(DataSource, :name, :get_by => true)
     three.add("ze-id", "jobs")
-    Ricordami.driver.hexists("DataSource:hsh:name_to_id", "jobs").should be_true
+    Ricordami.redis.hexists("DataSource:hsh:name_to_id", "jobs").should be_true
   end
 
   it "returns the id from values with #id_for_values if :get_by is true" do
@@ -61,7 +61,7 @@ describe Ricordami::UniqueIndex do
   it "removes a string from the index with #rem" do
     @index.add("ze-id", "allo")
     @index.rem("ze-id", "allo")
-    Ricordami.driver.smembers("DataSource:udx:id").should == []
+    Ricordami.redis.smembers("DataSource:udx:id").should == []
   end
 
   it "returns the redis command(s) to remove the value from the index when return_command is true" do

data/spec/ricordami/value_index_spec.rb

@@ -23,14 +23,14 @@ describe Ricordami::ValueIndex do
 
   it "adds the id to the index value with #add" do
     index.add("3", "VALUE")
-    Ricordami.driver.smembers("Friend:idx:first_name:VkFMVUU=").should == ["3"]
+    Ricordami.redis.smembers("Friend:idx:first_name:VkFMVUU=").should == ["3"]
   end
 
   it "removes the id from the index value with #rem" do
     index.add("1", "VALUE")
     index.add("2", "VALUE")
     index.rem("1", "VALUE")
-    Ricordami.driver.smembers("Friend:idx:first_name:VkFMVUU=").should == ["2"]
+    Ricordami.redis.smembers("Friend:idx:first_name:VkFMVUU=").should == ["2"]
   end
 
   it "returns the redis command to remove the value from the index when return_command is true" do

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ RSpec.configure do |config|
                        :redis_db    => 7,
                        :thread_safe => true)
     end
-    Ricordami.driver.flushdb
+    Ricordami.redis.flushdb
   end
 end
 

data/spec/support/db_manager.rb

@@ -6,12 +6,12 @@ module Support
       def error.method_missing(meth, *args, &blk)
         raise Errno::ECONNREFUSED
       end
-      Ricordami.instance_eval { @driver = error }
+      Ricordami.instance_eval { @redis = error }
     end
 
     def switch_db_to_ok
       return unless @_db_mode_error
-      Ricordami.instance_eval { @driver = nil }
+      Ricordami.instance_eval { @redis = nil }
       @_db_mode_error = false
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: ricordami
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Mathieu Lajugie
@@ -19,9 +19,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 2.1.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -30,9 +30,9 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -41,9 +41,9 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.0
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -123,7 +123,11 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id010
-description: Simple way to persist Ruby objects into the Redis data structure server.
+description: |
+  Ricordami ("Remember me" in Italian) is an attempt at providing a simple
+  interface to build Ruby objects that can be validated, persisted and
+  queried in a Redis data structure server.
+
 email: 
 - mathieu.l AT gmail.com
 executables: []
@@ -139,7 +143,9 @@ files:
 - README.md
 - TODO.md
 - examples/calls.rb
+- examples/person.rb
 - examples/singers.rb
+- examples/summary.rb
 - lib/ricordami.rb
 - lib/ricordami/attribute.rb
 - lib/ricordami/can_be_queried.rb