best_boy 0.0.2 → 0.0.3

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+.rvmrc
 .bundle
 Gemfile.lock
 pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.0.3
+
+* added rspec tests
+
+## 0.0.2
+
+* initial release

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/README.md

@@ -1,14 +1,15 @@
 best_boy
 ========
+[![Build Status](https://secure.travis-ci.org/cseydel/best_boy.png?branch=master)](https://secure.travis-ci.org/cseydel/best_boy)
 
 A simple event driven logging for ActiveRecord models.
-This gem is not tested for now. I add testing asap.
------------------------------------------
+
 
 What does this gem do?
 ----------------------
 
-best_boy logs create and delete events in its first iteration. It uses an own polimorphic database table to log each event.
+best_boy logs "create" and "delete" events as well as custom events triggered in controller actions. It uses an own polimorphic database table to log each event.
+At the moment, best_boy only provides support for ActiveRecord models.
 
 
 Installation
@@ -24,12 +25,30 @@ Install it with Bundler
 
 Generate the BestBoyEvent table migration
 
-    rails g best_boy:install
+    rails g best_boy
 
 Run the migration
 
     rake db:migrate
 
+
+Usage
+-----
+
+In model context:
+    
+    has_a_best_boy
+
+This will log "create" and "delete" event for each instance.
+
+In controller context:
+
+    best_boy_event object, event
+
+This will log custom events for a object and a event phrase.
+If no Object is given, it will raise an exception as well as if no event is provided.
+
+
 BestBoyEvent table
 ------------------
 
@@ -44,9 +63,15 @@ Getting BestBoyEvents
 
 The table is namespaced, so you can access for statistics maybe with BestBoy::BestBoyEvent.where...
 
+Thanks
+------
+
+Big thanks to each contributor on Impressionist. This gem helped me a long way to get here in modelling and creating a gem.
 
 Famous last words
 -----------------
 It's my first gem, be gentle ;)
 
+
+
 Copyright (c) 2012 Christoph Seydel. See LICENSE.txt for further details.

data/Rakefile

@@ -1,16 +1,11 @@
+require 'rubygems'
 require 'bundler/setup'
+require 'rake'
+require 'rspec/core'
 require 'rspec/core/rake_task'
 
 Bundler::GemHelper.install_tasks
 
-RSpec::Core::RakeTask.new do |task|
-  task.rspec_opts = "-I ./test_app/spec"
-  task.pattern = "./test_app/spec/**/*_spec.rb"
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
-
-namespace :best_boy do
-  
-end
+task :default => :spec

data/app/models/best_boy/eventable.rb

@@ -2,10 +2,6 @@ module BestBoy
   module Eventable
     extend ActiveSupport::Concern
 
-    module ClassMethods
-      
-    end
-
     def eventable?
       true
     end

data/best_boy.gemspec

@@ -17,7 +17,11 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
 
   s.add_development_dependency("bundler", ">= 1.0.0")
-  s.add_development_dependency("rspec", "~> 2.0.1")
+  s.add_development_dependency('activerecord', '>= 3.0.0')
+  s.add_development_dependency('activesupport', '>= 3.0.0')
+  s.add_development_dependency('sqlite3', '>= 1.3.4')
+  s.add_development_dependency("rake")  
+  s.add_development_dependency("rspec")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/best_boy/models/active_record/best_boy_event.rb

@@ -1,17 +1,17 @@
 class BestBoyEvent < ActiveRecord::Base
-    # associations
-    #
-    #
-    belongs_to :owner, :polymorphic => true
-    
-    # validations
-    #
-    #
-    validates :event, :presence => true
-    
-    # attributes
-    #
-    #
-    attr_accessible :owner_id, :owner_type, :event
+  # associations
+  #
+  #
+  belongs_to :owner, :polymorphic => true
+
+  # validations
+  #
+  #
+  validates :event, :presence => true
+
+  # attributes
+  #
+  #
+  attr_accessible :owner_id, :owner_type, :event
   
-  end
+end

data/lib/best_boy/version.rb

@@ -1,3 +1,3 @@
 module BestBoy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/best_boy/best_boy_controller_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe BestBoyController do
+  before(:each) do
+    @user = User.create
+  end
+
+  it "should send valid custom event" do
+    best_boy_event @user, "testing"
+    BestBoyEvent.where(:owner_id => @user.id, :owner_type => @user.class.name.to_s, :event => "testing").first.should_not be_nil
+  end
+
+  it "should raise error on empty event_phrase" do
+    expect {best_boy_event(@user, "")}.should raise_error
+  end
+
+  it "should raise error on class not beeing a eventable" do
+    klass = Dummy.new
+    expect {best_boy_event(klass, "testing")}.should raise_error
+  end
+end

data/spec/best_boy/best_boy_event_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+describe BestBoyEvent do
+  it "should have valid model" do
+    user = User.create
+    BestBoyEvent.create(:owner_id => user.id, :owner_type => user.class.name.to_s, :event => "create").should be_valid
+  end
+
+  it "should require a event" do
+    BestBoyEvent.create(:event => "").should_not be_valid
+  end
+
+end

data/spec/best_boy/eventable_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe BestBoy::Eventable do
+  before(:each) do
+    @user = User.create
+  end
+
+  it "should send valid create event" do
+    best_boy_event = @user.best_boy_events.first.should_not be_nil
+  end
+
+  it "should send valid destroy event" do
+    @user.destroy
+    BestBoyEvent.where(:owner_type => "User", :event => "destroy").should_not be_nil
+  end
+
+  it "should be an eventable" do
+    @user.respond_to?("eventable?").should eql(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+require 'active_record'
+require 'active_support'
+require "best_boy/models/active_record/best_boy_event.rb"
+require "best_boy/models/active_record/best_boy/eventable.rb"
+require "./app/models/best_boy/eventable.rb"
+require "./app/controllers/best_boy_controller.rb"
+require 'rspec'
+require 'rspec/autorun'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3", 
+  :database => "#{root}/db/bestboy.db"
+)
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'users'")
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'best_boy_events'")
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :best_boy_events, :force => true do |t|
+    t.integer :owner_id
+    t.string :owner_type
+    t.string :event
+    t.timestamps
+  end
+  add_index :best_boy_events, :owner_id
+  add_index :best_boy_events, :owner_type
+  add_index :best_boy_events, [:owner_id, :owner_type]
+  add_index :best_boy_events, :event
+
+  create_table :users, :force => true do |t|
+    t.timestamps
+  end
+
+end
+
+ActiveRecord::Base.send(:include, BestBoy::Eventable)
+
+RSpec.configure do |config|
+  config.include BestBoyController::InstanceMethods
+end
+
+class User < ActiveRecord::Base
+  has_a_best_boy
+end
+
+class Dummy
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: best_boy
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors: 
 - Christoph Seydel
@@ -14,37 +10,75 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-12 00:00:00 +02:00
+date: 2012-06-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: activerecord
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 1
-        version: 2.0.1
+        version: 3.0.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.4
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: Hybrid action logging, consisting of standard and custom logging.
 email: 
 - christoph.seydel@me.com
@@ -56,6 +90,9 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -63,6 +100,7 @@ files:
 - app/controllers/best_boy_controller.rb
 - app/models/best_boy/eventable.rb
 - best_boy.gemspec
+- db/bestboy.db
 - lib/best_boy.rb
 - lib/best_boy/engine.rb
 - lib/best_boy/models/active_record/best_boy/eventable.rb
@@ -72,6 +110,10 @@ files:
 - lib/generators/active_record/templates/create_best_boy_events_table.rb
 - lib/generators/best_boy_generator.rb
 - lib/generators/templates/best_boy.rb
+- spec/best_boy/best_boy_controller_spec.rb
+- spec/best_boy/best_boy_event_spec.rb
+- spec/best_boy/eventable_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/cseydel/best_boy
 licenses: 
@@ -82,27 +124,26 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: best_boy
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: a simple event driven logging for models
-test_files: []
-
+test_files: 
+- spec/best_boy/best_boy_controller_spec.rb
+- spec/best_boy/best_boy_event_spec.rb
+- spec/best_boy/eventable_spec.rb
+- spec/spec_helper.rb