artifact_logger 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.rdoc

@@ -0,0 +1,18 @@
+= ArtifactLogger
+
+This is an engine which is designed to be a drop-in logging agent for use in a Rails application.
+
+Usage:
+
+    # app/models/artifact.rb
+    
+    class Artifact < ActiveRecord::Base
+      has_many 'Log::Messages', :as => :artifacts
+
+    end
+
+    art = Artifact.new
+
+    art.log("Error", "This is an error message")
+
+    art.logs

data/Rakefile

@@ -0,0 +1,51 @@
+#!/usr/bin/env rake
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ArtifactLogger'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+# Use rspec instead
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "active_logger"
+    gem.summary = "Dropin Logging for Rails"
+    gem.description = "A dropin logging engine for rails.  It will keep rack of log message against a given record/artifact."
+    gem.files = Dir["{app,lib,config}/**/*"] + ["MIT-LICENSE", "Rakefile", "Gemfile", "README.rdoc"]
+    # other fields that would normally go in your gemspec
+    # like authors, email and has_rdoc can also be included here
+
+  end
+rescue
+  puts "Jeweler or one of its dependencies is not installed."
+end
+
+Rake.application.invoke_task(:load_app)

data/lib/artifact_logger/active_record.rb

@@ -0,0 +1,19 @@
+# ActiveRecord augmentations
+module ArtifactLogger::ActiveRecord
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def enable_artifact_logger options
+      #Configure the has_many
+      has_many :log, :as => :artifact, :class_name => '::Log::Message'
+      #Store the old logging method
+      alias_method :_log, :log
+      remove_method :log
+
+      include ArtifactLogger::ModelExtensions
+
+      #Store the levels which are valid
+      @_valid_levels = options[:levels]
+    end
+  end
+end

data/lib/artifact_logger/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module ArtifactLogger
+  class Engine < Rails::Engine
+  end
+end

data/lib/artifact_logger/model_extensions.rb

@@ -0,0 +1,34 @@
+#Model extensions for Artifct Logger
+module ArtifactLogger::ModelExtensions
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def log *params
+      if params.length == 0
+        ArtifactLogger.extend_object(Log::Message.where(:artifact_type => model_name, :artifact_id => nil), self)
+      elsif params.length == 2
+        Log::Message.create :level => params[0], :text => params[1], :artifact_type => model_name
+      else
+        super
+      end
+    end
+
+    def valid_log_levels
+      return @_valid_levels || [:error, :info, :warning]
+    end
+  end
+
+  module InstanceMethods
+    def log *params
+      if params.length != 2
+        ArtifactLogger.extend_object(_log(*params), self)
+      else
+        Log::Message.create :level => params[0], :text => params[1], :artifact => self
+      end
+    end
+
+    def valid_log_levels
+      return self.class.valid_log_levels
+    end
+  end
+end

data/lib/artifact_logger.rb

@@ -0,0 +1,24 @@
+require 'artifact_logger/engine'
+require 'artifact_logger/model_extensions'
+require 'artifact_logger/active_record'
+
+
+module ArtifactLogger
+
+  def self.extend_object obj, artifact
+    artifact.valid_log_levels.each do |level|
+      obj.define_singleton_method level do |message=nil|
+        if message.nil?
+          artifact.log.log_level(level)
+        else
+          artifact.log.create(:text => message, :level => level)
+        end
+      end
+    end
+    return obj
+  end
+end
+
+class ActiveRecord::Base
+  include ArtifactLogger::ActiveRecord
+end

data/lib/tasks/artifact_logger_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :artifact_logger do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: artifact_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- ajrkerr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-08 00:00:00.000000000 -04:00
+default_executable: 
+dependencies: []
+description: A very simple dropin engine for logging information on artifacts in a
+  database.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/artifact_logger/active_record.rb
+- lib/artifact_logger/model_extensions.rb
+- lib/artifact_logger/engine.rb
+- lib/tasks/artifact_logger_tasks.rake
+- lib/artifact_logger.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A simple dropin engine for logging information on artifacts in a databse.
+test_files: []