artifact_logger 1.0.1 → 1.0.2

data/README.rdoc

@@ -4,10 +4,16 @@ This is an engine which is designed to be a drop-in logging agent for use in a R
 
 It's designed to be pretty simple and easy to use.
 
+Installation:
+  # Gemfile
+    gem "artifact_logger"
+
+  # Run this
+    rake artifact_logger_engine:install:migrations
+
 Usage:
 
-    # app/models/artifact.rb
-    
+  # app/models/artifact.rb
     class Artifact < ActiveRecord::Base
       #levels are optional
       enable_artifact_logger :levels => [:info, :warning, :error, :custom]
@@ -21,11 +27,11 @@ Usage:
 
     a = Artifact.new
 
-    # To create an error or info message in the log
+  # To create an error or info message in the log
     m = a.log "error", "This is an error message!"
     n = a.log.info "This is an error message!"
 
-    #Both of these will display the same information
+  # Both of these will display the same information
     a.log           #> [m, n]
     a.log.error     #> [m, n]
 
@@ -33,7 +39,7 @@ Usage:
     m.artifact_type #> Artifact
 
 
-    #This is also usable on the model itself
+  # This is also usable on the model itself
     info = Article.log "info", "Article did something"
     warn = Article.log.warning "Article did something else"
 

data/app/models/log.rb

@@ -0,0 +1,5 @@
+module Log
+  def self.table_name_prefix
+    'log_'
+  end
+end

data/app/models/log/message.rb

@@ -0,0 +1,47 @@
+class Log::Message < ActiveRecord::Base
+  belongs_to :artifact, :polymorphic => true
+
+  validates :text, :presence => true
+  validates :level, :presence => true, :inclusion => { :in => lambda { |record| record.valid_levels } }
+
+  scope :log_level, lambda { |level| where(:level => level)}
+
+  def self.valid_levels
+    [:info, :warning, :error]
+  end
+
+  def valid_levels
+    if artifact_type
+      artifact_type.valid_log_levels || self.class.valid_levels
+    else
+      self.class.valid_levels
+    end
+  end
+
+  #Store the old artifact and artifact= functions for later usage
+  alias_method :_get_artifact, :artifact
+  alias_method :_set_artifact, :artifact=
+
+  #Returns either the model, or the object
+  def artifact
+    _get_artifact.nil? ? artifact_type : _get_artifact
+  end
+
+  #Assignment overriden to allow the model to be used as well
+  def artifact= val
+    if val.is_a? Class
+      self[:artifact_type] = val.model_name
+    else
+      _set_artifact val
+    end
+  end
+
+  #Finds the class of object which we're dealing with
+  def artifact_type
+    self[:artifact_type].nil? ? nil : self[:artifact_type].constantize
+  end
+
+  def level= level
+    super level.to_sym
+  end
+end

data/db/migrate/20110706154303_create_artifact_logger.rb

@@ -0,0 +1,21 @@
+class CreateArtifactLogger < ActiveRecord::Migration
+  def self.up
+    create_table :log_messages do |t|
+      t.string  :level, :null => false
+      # t.string  :type
+      t.text    :text, :null => false
+      t.string  :artifact_type
+      t.integer :artifact_id
+
+      t.timestamps
+    end
+
+    add_index :log_messages, :artifact_type
+    add_index :log_messages, :artifact_id
+    add_index :log_messages, :level
+  end
+
+  def self.down
+    drop_table :artifacts
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: artifact_logger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
-- ajrkerr
+- Adam T Kerr
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -24,6 +24,9 @@ files:
 - lib/artifact_logger/engine.rb
 - lib/tasks/artifact_logger_tasks.rake
 - lib/artifact_logger.rb
+- app/models/log.rb
+- app/models/log/message.rb
+- db/migrate/20110706154303_create_artifact_logger.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc