best_boy 0.0.2

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 cseydel
+
+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.

data/README.md

@@ -0,0 +1,52 @@
+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.
+
+
+Installation
+------------
+
+Add it to your gemfile
+
+    gem 'best_boy'
+
+Install it with Bundler
+
+    bundle install
+
+Generate the BestBoyEvent table migration
+
+    rails g best_boy:install
+
+Run the migration
+
+    rake db:migrate
+
+BestBoyEvent table
+------------------
+
+    t.integer   "owner_id"      # owner model id
+    t.string    "owner_type"    # owner model class type
+    t.string    "event"         # event (create, delete)
+    t.datetime  "updated_at"    # last update timestamp
+    t.datetime  "created_at"    # creation timestamp
+
+Getting BestBoyEvents
+---------------------
+
+The table is namespaced, so you can access for statistics maybe with BestBoy::BestBoyEvent.where...
+
+
+Famous last words
+-----------------
+It's my first gem, be gentle ;)
+
+Copyright (c) 2012 Christoph Seydel. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+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
+
+task :test => :spec
+task :default => :spec
+
+namespace :best_boy do
+  
+end

data/app/controllers/best_boy_controller.rb

@@ -0,0 +1,15 @@
+module BestBoyController
+  module InstanceMethods
+    def best_boy_event(obj, event)
+      if obj.respond_to?("eventable?")
+        if event.present?
+          obj.trigger_custom_event(event)
+        else
+          raise "There is no event to trigger."
+        end
+      else
+        raise "#{obj.class.to_s} is not a best_boy eventable!"
+      end
+    end
+  end
+end

data/app/models/best_boy/eventable.rb

@@ -0,0 +1,14 @@
+module BestBoy
+  module Eventable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      
+    end
+
+    def eventable?
+      true
+    end
+
+  end
+end

data/best_boy.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "best_boy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "best_boy"
+  s.version     = BestBoy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = ['MIT']
+  s.authors     = ["Christoph Seydel"]
+  s.email       = ["christoph.seydel@me.com"]
+  s.homepage    = "https://github.com/cseydel/best_boy"
+  s.summary     = %q{a simple event driven logging for models}
+  s.description = %q{Hybrid action logging, consisting of standard and custom logging.}
+
+  s.rubyforge_project = "best_boy"
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.add_development_dependency("bundler", ">= 1.0.0")
+  s.add_development_dependency("rspec", "~> 2.0.1")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/best_boy.rb

@@ -0,0 +1,12 @@
+require "best_boy/engine.rb"
+
+module BestBoy
+  # Define ORM
+  mattr_accessor :orm
+  @@orm = :active_record
+
+  # Load configuration from initializer
+  def self.setup
+    yield self
+  end
+end

data/lib/best_boy/engine.rb

@@ -0,0 +1,23 @@
+require "best_boy"
+require "rails"
+
+module BestBoy
+  class Engine < Rails::Engine
+    initializer 'best_boy.model' do |app|
+      require "#{root}/app/models/best_boy/eventable.rb"
+      if BestBoy.orm == :active_record
+        require "best_boy/models/active_record/best_boy_event.rb"
+        require "best_boy/models/active_record/best_boy/eventable.rb"
+        ActiveRecord::Base.send(:include, BestBoy::Eventable)
+      else
+        raise "Sorry, best_boy actually only supports ActiveRecord ORM."
+      end
+    end
+
+    initializer 'best_boy.controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include BestBoyController::InstanceMethods
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module BestBoy
+  module Eventable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_a_best_boy
+        # meta programming
+        #
+        #
+        include InstanceMethods
+        
+        # associations
+        #
+        #
+        has_many :best_boy_events, :as => :owner, :dependent => :nullify
+        
+        # callbacks
+        #
+        #
+        after_create :trigger_create_event
+        before_destroy :trigger_destroy_event
+      end
+    end
+
+    module InstanceMethods
+      def trigger_create_event
+        create_best_boy_event_with_type "create"
+      end
+
+      def trigger_destroy_event
+        create_best_boy_event_with_type "destroy"
+      end
+
+      def trigger_custom_event type
+        create_best_boy_event_with_type(type) if type.present? 
+      end
+
+      def create_best_boy_event_with_type type
+        best_boy_event = BestBoyEvent.new(:event => type)
+        best_boy_event.owner = self
+        best_boy_event.save
+      end
+    end
+  end
+end

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

@@ -0,0 +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
+  
+  end

data/lib/best_boy/version.rb

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

data/lib/generators/active_record/best_boy_generator.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module Generators
+    class BestBoyGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.join(File.dirname(__FILE__), 'templates')
+
+      def self.next_migration_number(dirname)
+        sleep 1
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'create_best_boy_events_table.rb', 'db/migrate/create_best_boy_events_table.rb'
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/create_best_boy_events_table.rb

@@ -0,0 +1,18 @@
+class CreateBestBoyEventsTable < ActiveRecord::Migration
+  def self.up
+    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
+  end
+
+  def self.down
+    drop_table :best_boy_events
+  end
+end

data/lib/generators/best_boy_generator.rb

@@ -0,0 +1,12 @@
+module BestBoy
+  module Generators
+    class BestBoyGenerator < Rails::Generators::Base
+      hook_for :orm
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config_file
+        template 'best_boy.rb', 'config/initializers/best_boy.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/best_boy.rb

@@ -0,0 +1,5 @@
+# Use this hook to configure impressionist parameters
+BestBoy.setup do |config|
+  # Define ORM. Could be :active_record (default) and :mongo_mapper
+  # config.orm = :active_record
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: best_boy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Christoph Seydel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-12 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :development
+  version_requirements: *id002
+description: Hybrid action logging, consisting of standard and custom logging.
+email: 
+- christoph.seydel@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/best_boy_controller.rb
+- app/models/best_boy/eventable.rb
+- best_boy.gemspec
+- lib/best_boy.rb
+- lib/best_boy/engine.rb
+- lib/best_boy/models/active_record/best_boy/eventable.rb
+- lib/best_boy/models/active_record/best_boy_event.rb
+- lib/best_boy/version.rb
+- lib/generators/active_record/best_boy_generator.rb
+- lib/generators/active_record/templates/create_best_boy_events_table.rb
+- lib/generators/best_boy_generator.rb
+- lib/generators/templates/best_boy.rb
+has_rdoc: true
+homepage: https://github.com/cseydel/best_boy
+licenses: 
+- - MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: best_boy
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: a simple event driven logging for models
+test_files: []
+