pickle-surprise 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - ruby-head
+services:
+  - mongodb

data/Gemfile

@@ -4,4 +4,3 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rb-fsevent', require: false if RUBY_PLATFORM =~ /darwin/i
-gem 'pry'

data/README.md

@@ -1,6 +1,10 @@
-# Pickle::Surprise
+![Pickle::Surprise](https://raw.github.com/dlibanori/pickle-surprise/master/pickle-surprise.jpg "That's the surprise!")
 
-TODO: Write a gem description
+# Where is the Pickle?  [![Build Status](https://secure.travis-ci.org/dlibanori/pickle-surprise.png)](http://travis-ci.org/dlibanori/pickle-surprise)
+
+Wouldn't it be nice if you could save messages in production to see them later?  Things like: “suspicious action”, “this request is taking too long” or “third part service is not working again”.
+
+We use [Mongoid](https://github.com/mongoid/mongoid) as database, so you can save anything that is serializable.
 
 ## Installation
 
@@ -18,12 +22,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This gem is intended to be very simple:
+
+```ruby
+  class Customer
+    include Pickle::Surprise
+
+    def suspicious
+      Pickle msg: "#{@name} is trying something…"
+    end
+  end
+```
+
+_Pickle_ from any place in your source code:
+
+```ruby
+  include Pickle::Surprise
+
+  Pickle msg: "Something is strange"
+```
+
+You can have a block that catches all exceptions, creates a _Pickle_ and reraise them:
+
+```ruby
+  Pickle do
+    raise 'FFFUUUUUU-'
+  end
+```
+
+**Pickle** expects 3 fields:
+
+* **msg** (String): message
+* **ns** (String): namespace
+* **ts** (Time): timestamp
+
+But you can save anything that is serializable in a _Pickle_:
+
+```ruby
+  Pickle msg: 'some crazy exception', stack: [1,2,3]
+```
+
+What if I want to build an interface for my _Pickles_?
+
+```ruby
+  puts "You have #{Pickle.count}"
+  puts "My last Pickle: #{Pickle.last}"
+
+  Pickle.all.each do |pickle|
+    puts pickle.msg
+  end
+
+  # Forget all my Pickles!
+  Pickle.reset
+```
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
+3. Commit your changes (`git commit -am "Added a new feature"`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new **Pull Request**
+6. ???
+7. PROFIT

data/examples/usage.rb

@@ -1,6 +1,21 @@
-ENV['MONGOID_ENV'] = 'development'
-Mongoid.load! 'examples/config.yml'
+require 'pickle-surprise'
 
-include Pickle::Surprise
+class Some
+  include Pickle::Surprise
 
-Pickle msg: 'Fuuu'
+  def thing
+    raise "Where is the Pickle?"
+  rescue
+    Pickle msg: "That's the surprise!"
+  end
+
+  def raiser
+    # boring code
+
+    Pickle ns: 'my namespace' do
+      raise 'FFFUUUUU-'
+    end
+
+    # more boring code
+  end
+end

data/lib/pickle-surprise.rb

@@ -6,6 +6,10 @@ module Pickle
     Surprise::Pickle.count
   end
 
+  def self.all
+    Surprise::Pickle.all
+  end
+
   def self.last
     Surprise::Pickle.last
   end
@@ -15,12 +19,12 @@ module Pickle
   end
 
   module Surprise
-    def Pickle(params=nil,&block)
+    def Pickle(params={},&block)
       if block
         begin
           yield
         rescue Exception => ex
-          Pickle.factory ex
+          Pickle.factory ex, params
           raise
         end
       else

data/lib/pickle-surprise/pickle.rb

@@ -6,14 +6,17 @@ module Pickle
       include Mongoid::Document
 
       store_in collection: 'pickles'
+      default_scope order_by(ts: 1)
 
       field :ns, type: String
       field :ts, type: Time, default: -> { Time.now }
       field :msg, type: String
 
-      def self.factory(params)
+      index ts: 1
+
+      def self.factory(params, options={})
         params = { msg: params.to_s } unless params.respond_to? :to_hash
-        create params.to_hash
+        create options.merge params
       end
     end
   end

data/lib/pickle-surprise/version.rb

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

data/pickle-surprise.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |gem|
   gem.version       = Pickle::Surprise::VERSION
   gem.authors       = ["Daniel Libanori"]
   gem.email         = ["daniellibanori@gmail.com"]
-  gem.description   = %q{Save anything you don't expect at your database}
-  gem.summary       = %q{Where is the pickle? It is not a surprise anymore...}
-  gem.homepage      = "http://dlibanori.github.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.homepage      = "https://github.com/dlibanori/pickle-surprise"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'mongoid', '~> 3.0.0'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.11.0'
   gem.add_development_dependency 'guard-rspec'
 end

data/spec/pickle-surprise/pickle_spec.rb

@@ -1,5 +1,15 @@
+require 'spec_helper'
 require 'pickle-surprise/pickle'
 
 describe Pickle::Surprise::Pickle do
-  pending 'not implemented yet'
+  it 'should create a new Pickle' do
+    pickle = described_class.factory msg: 'where is the pickle?'
+    expect(pickle.msg).to eq('where is the pickle?')
+  end
+
+  it 'should accept default params' do
+    options = { ns: 'namespace' }
+    pickle = described_class.factory({ msg: 'where is the pickle?' }, options)
+    expect(pickle.ns).to eq('namespace')
+  end
 end

data/spec/pickle-surprise_spec.rb

@@ -3,12 +3,7 @@ require 'pickle-surprise'
 
 class SomeException < Exception; end
 
-describe Pickle do
-  pending 'not implemented yet'
-end
-
 describe Pickle::Surprise do
-  use_mongoid
   use_pickle_surprise
   after { Pickle.reset }
 
@@ -22,14 +17,35 @@ describe Pickle::Surprise do
     expect(pickle.msg).to eq('hash')
   end
 
-  it 'should accept a block' do
-    expect {
-      Pickle do
-        raise SomeException, 'from an exception'
+  context 'with block' do
+    it 'should create a pickle' do
+      ignore do
+        Pickle do
+          raise SomeException, 'from an exception'
+        end
+      end
+
+      pickle = Pickle.last
+      expect(pickle.msg).to eq('from an exception')
+    end
+
+    it 'should reraise same expection' do
+      expect {
+        Pickle do
+          raise SomeException, 'from an exception'
+        end
+      }.to raise_error(SomeException)
+    end
+
+    it 'should accept params' do
+      ignore do
+        Pickle ns: 'namespace' do
+          raise SomeException, 'from an exception'
+        end
       end
-    }.to raise_error(SomeException)
 
-    pickle = Pickle.last
-    expect(pickle.msg).to eq('from an exception')
+      pickle = Pickle.last
+      expect(pickle.ns).to eq('namespace')
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,9 +1,19 @@
-def use_mongoid
-  require 'mongoid'
-  ENV['MONGOID_ENV'] = 'development'
-  Mongoid.load! 'examples/config.yml'
+require 'mongoid'
+
+def database_id
+  ENV['CI'] ? "mongoid_slug_#{Process.pid}" : 'pickle_surprise_test'
 end
 
 def use_pickle_surprise
   include Pickle::Surprise
 end
+
+def ignore(type=Exception)
+  yield
+rescue Exception => ex
+  raise unless ex.is_a? type
+end
+
+Mongoid.configure do |config|
+  config.connect_to database_id
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pickle-surprise
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +75,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Save anything you don't expect at your database
+description: Save stuff you do not expect, in your database.
 email:
 - daniellibanori@gmail.com
 executables: []
@@ -68,22 +84,22 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rbenv-version
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/config.yml
-- examples/some.rb
 - examples/usage.rb
 - lib/pickle-surprise.rb
 - lib/pickle-surprise/pickle.rb
 - lib/pickle-surprise/version.rb
 - pickle-surprise.gemspec
+- pickle-surprise.jpg
 - spec/pickle-surprise/pickle_spec.rb
 - spec/pickle-surprise_spec.rb
 - spec/spec_helper.rb
-homepage: http://dlibanori.github.com
+homepage: https://github.com/dlibanori/pickle-surprise
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -106,7 +122,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Where is the pickle? It is not a surprise anymore...
+summary: Where is the pickle? It's not a surprise anymore…
 test_files:
 - spec/pickle-surprise/pickle_spec.rb
 - spec/pickle-surprise_spec.rb

data/examples/config.yml

@@ -1,6 +0,0 @@
-development:
-  sessions:
-    default:
-      database: pickle_surprise
-      hosts:
-      - localhost:27017

data/examples/some.rb

@@ -1,21 +0,0 @@
-require 'pickle-surprise'
-
-class Some
-  include Pickle::Surprise
-
-  def thing
-    raise 'Where is the pickle?'
-  rescue
-    Pickle msg: 'That is surprise!'
-  end
-
-  def raiser
-    # boring code
-
-    Pickle ns: 'my namespace' do
-      raise 'Fuuu...'
-    end
-
-    # more boring code
-  end
-end