pickle-surprise 0.0.3 → 0.0.4

data/lib/pickle-surprise.rb

@@ -1,24 +1,46 @@
 require "pickle-surprise/version"
 require "pickle-surprise/pickle"
 
+# = Pickle interface
+#
+# This module has some class methods to you build an interface.
 module Pickle
+  # Get how many pickles do you have
+  #
+  # @return [Integer]
   def self.count
     Surprise::Pickle.count
   end
 
+  # Get all your pickles
+  #
+  # @return [Mongoid::Criteria]
   def self.all
     Surprise::Pickle.all
   end
 
-  def self.last
-    Surprise::Pickle.last
-  end
-
+  # Delete all your pickles
   def self.reset
     Surprise::Pickle.delete_all
   end
 
   module Surprise
+    # The most important method in Pickle::Surprise.  A pickle, by default, has
+    # these 3 attributes:
+    # * msg: a message
+    # * ns: a namespace
+    # * ts: a timestamp
+    #
+    # Attribute __ts__ has a default value to Time.now.
+    #
+    # As Pickle::Surprise use [mongodb](http://www.mongodb.org/) you can save
+    # extra attibutes of any type, but they can be serializable.
+    #
+    # You can use block mode: if any exception is raised inside block, it
+    # creates a new pickle using exception message.  If you pass a hash and a
+    # block, it merges hash with exception message and create a pickle.
+    #
+    # @param [Hash] attributes for your pickle
     def Pickle(params={},&block)
       if block
         begin

data/lib/pickle-surprise/version.rb

@@ -1,5 +1,5 @@
 module Pickle
   module Surprise
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/pickle-surprise.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Pickle::Surprise::VERSION
   gem.authors       = ["Daniel Libanori"]
   gem.email         = ["daniellibanori@gmail.com"]
-  gem.description   = %q{Save stuff you do not expect, in your database.}
-  gem.summary       = %q{Where is the pickle? It's not a surprise anymore…}
+  gem.description   = %q{Save stuff you do not expect, in your mongo database and see them later.}
+  gem.summary       = %q{Pickle::Surprise saves any serializable message at your mongo database.  We do like logs, but sometimes you just can't grep them. Pickle::Surprise may help you: it saves any message you want at your database so you can read them later.  As we use mongo as database, you can a lot of things, they just have to be serializable.}
   gem.homepage      = "https://github.com/dlibanori/pickle-surprise"
 
   gem.files         = `git ls-files`.split($/)
@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.11.0'
   gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'yard'
 end

data/spec/pickle-surprise_spec.rb

@@ -25,7 +25,7 @@ describe Pickle::Surprise do
         end
       end
 
-      pickle = Pickle.last
+      pickle = Pickle.all.last
       expect(pickle.msg).to eq('from an exception')
     end
 
@@ -44,7 +44,7 @@ describe Pickle::Surprise do
         end
       end
 
-      pickle = Pickle.last
+      pickle = Pickle.all.last
       expect(pickle.ns).to eq('namespace')
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pickle-surprise
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -75,7 +75,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Save stuff you do not expect, in your database.
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Save stuff you do not expect, in your mongo database and see them later.
 email:
 - daniellibanori@gmail.com
 executables: []
@@ -122,8 +138,12 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Where is the pickle? It's not a surprise anymore…
+summary: ! 'Pickle::Surprise saves any serializable message at your mongo database.  We
+  do like logs, but sometimes you just can''t grep them. Pickle::Surprise may help
+  you: it saves any message you want at your database so you can read them later.  As
+  we use mongo as database, you can a lot of things, they just have to be serializable.'
 test_files:
 - spec/pickle-surprise/pickle_spec.rb
 - spec/pickle-surprise_spec.rb
 - spec/spec_helper.rb
+has_rdoc: