error_log 0.0.5 → 0.0.6

data/Changelog.txt

@@ -1,3 +1,10 @@
+0.0.6 to be
+	 * basic VCS awareness (currently git only)
+	 * bugfix for showing errors from any category
+	 * bugfix for sorting by level then count
+	 * some cleanup, and a little bit of doc
+	 * bugfix for migrations (add_index bug)
+
 0.0.5 
 	 * haml dependency added (sorry folks, I could not stand rhtml
 	 * viewing archive

data/{README.txt → README.rdoc}

@@ -12,7 +12,7 @@ THIS IS AN EARLY DEVELOPMENT VERSION, DO NOT EVEN TOUCH PRODUCTION SERVER WITH I
 Actually, it is so unmature that even playing with it can make you sad.
 And no one likes to be sad.
 
-dev screenshot: http://tesuji.pl/error_logs.png
+dev screenshot: http://tesuji.pl/error_logs.png (v 0.0.2)
 
 == REQUIREMENTS
 
@@ -53,15 +53,15 @@ To be continued.
 
 == TODOS
 
-* git (and other VCS) awareness
+* alternative errors storage (for database failures, probably sqlite will do)
 * better params viewing (currently only example params)
 * setting error level threshold while browsing
 * better look (themes would be good, but I really do not like css, so help needed)
 * adding errors to ignore list
 * pagination could by nice ;) (it ain't actually so bad without it thanks to grouping)
-* alternative errors storage (for database failures, probably sqlite will do)
-* clickable backtraces? we could show some code
+* clickable backtraces? we could try showing some code
 * rails 2.x compatibility
+* svn & other vcs support
 
 == STUFF
 

data/lib/error_log/class_methods.rb

@@ -0,0 +1,66 @@
+module ErrorLog
+  module ClassMethods
+
+    def options
+      @options ||= {
+        :vcs => Vcs.guess
+      }
+    end
+
+    # Log error, exception, or whatever you have on your mind
+    #
+    # Args:
+    #   * level - error level {:debug, :info, :warn, :error, :fatal}
+    #   * error - error string itself
+    #   * options 
+    #
+    # Possible options:
+    #   * :backtrace 
+    #   * :params - params that can help you recreate this error, Hash
+    #   * :category - error category, helps you to group them later
+    #
+    def log(level,error,options={})
+      backtrace = options[:backtrace]
+      unless backtrace
+        begin
+          # I'm raising an exception just to get the current backtrace
+          # If there is any more clever way to do that, please share.
+          raise "wat?!"
+        rescue Exception => e
+          backtrace = e.backtrace[1..-1]
+        end
+      end
+
+      # Silent rescues may not be optimal, for now they seem better than creating more mess
+      logger.error "\n\n\n#{Time.now}\n= #{error}\n#{backtrace.join("\n")}\n#{options[:params]}" rescue nil
+
+      ErrorLog::Model.create(
+        :error => error,
+        :backtrace => backtrace,
+        :level => level,
+        :params => options[:params],
+        :vcs_revision => current_revision,
+        :category => options[:category] || 'error_log'
+      ) rescue nil 
+    end
+
+    # Errors log, may be useful when you're facing some db related problems
+    def logger
+      @logger = Logger.new(File.join(Rails.root,'log','error.log'))
+    end
+
+    def init
+      @current_revision = Vcs.revision
+      Migrations.auto_migrate!
+    end
+
+    def current_revision
+      @current_revision
+    end
+
+  end
+
+  class << self
+    include ClassMethods
+  end
+end

data/lib/error_log/controller.rb

@@ -9,9 +9,10 @@ module ErrorLog
 
       prepare_opts
 
-      scope = ErrorLog::Model
+      scope = cat_scope = rev_scope = ErrorLog::Model
 
-      scope = scope.where(:category => @errors_category) unless @errors_category.to_s.empty? 
+      scope = cat_scope = scope.where(:category => @opts[:category]) if @opts[:category] 
+      scope = rev_scope = scope.where(:vcs_revision => @opts[:revision].empty? ? nil : @opts[:revision]) if @opts[:revision] 
 
       @error_logs = scope.all(
         :select => 'count(*) as count_all,
@@ -30,11 +31,20 @@ module ErrorLog
       })
 
 
-      @category_counts = ErrorLog::Model.count(
+      @category_counts = rev_scope.count(
         :conditions => {:viewed => viewing_archive?},
         :group => :category 
       )
 
+      @revisions = cat_scope.all(
+        :select => 'vcs_revision, 
+        min(created_at) as  created_at_first, 
+        count(*) as count_all',
+        :conditions => {:viewed => viewing_archive?},
+        :group => :vcs_revision,
+        :order => 'created_at_first'
+      )
+
       render :template => '/index'
     end
 
@@ -82,12 +92,13 @@ module ErrorLog
         'first' => 'created_at_first DESC',
         'count' => 'count_all DESC',
         'level' => 'level_id DESC',
-        'level_count' => 'level DESC, count_all DESC'
+        'level_count' => 'level_id DESC, count_all DESC'
       }
 
       @opts = {
         :archive => '0',
         :sort_by => sorts['last'],
+        :revision => nil,
         :category => nil
       }
 
@@ -98,7 +109,12 @@ module ErrorLog
       @opts[:sort_by] = sorts[session[:erlgs_sort_by]]
 
       session[:erlgs_category] = params[:category] if params[:category]
-      @opts[:category] = @errors_category = session[:erlgs_category]
+      session[:erlgs_category] = nil if params[:category] == '-none-'
+      @opts[:category] = session[:erlgs_category]
+
+      session[:erlgs_revision] = params[:revision] if params[:revision]
+      session[:erlgs_revision] = nil if params[:revision] == '-none-'
+      @opts[:revision] = session[:erlgs_revision]
     end
   end
 end

data/lib/error_log/migrations/add_params_column.rb

@@ -0,0 +1,10 @@
+module ErrorLog
+  module Migrations
+    # ErrorLog 0.2 to 0.3 migration, creating params column 
+    class AddParamsColumn < ActiveRecord::Migration
+      def self.up
+        add_column :error_logs, :params, :text
+      end
+    end
+  end
+end

data/lib/error_log/migrations/add_vcs_revision_column.rb

@@ -0,0 +1,10 @@
+module ErrorLog
+  module Migrations
+    # ErrorLog 0.2 to 0.3 migration, creating params column 
+    class AddVcsRevisionColumn < ActiveRecord::Migration
+      def self.up
+        add_column :error_logs, :vcs_revision, :string
+      end
+    end
+  end
+end

data/lib/error_log/migrations/base.rb

@@ -0,0 +1,20 @@
+module ErrorLog
+  module Migrations
+    # Base migration, create error_logs table
+    class Base < ActiveRecord::Migration
+      def self.up
+        create_table :error_logs do |t|
+          t.text :error
+          t.text :backtrace
+          t.string :category
+          t.string :error_hash
+          t.integer :level_id
+          t.timestamp :created_at
+          t.boolean :viewed, :default => false
+        end
+
+        add_index :error_logs, :category
+      end
+    end 
+  end
+end

data/lib/error_log/migrations.rb

@@ -1,25 +1,29 @@
 module ErrorLog
+  module Migrations
 
-  class Migration < ActiveRecord::Migration
-    def self.up
-      create_table :error_logs do |t|
-        t.text :error
-        t.text :backtrace
-        t.string :category
-        # note to future me: "hash" is a really bad name for the column
-        t.string :error_hash
-        t.integer :level_id
-        t.timestamp :created_at
-        t.boolean :viewed, :default => false
+    # Chack what do we have in database and migratie what's needed
+    # Those migrations does not work like rails migrations, I check manually if table exists, 
+    # or if given column exist, and add it if it's not there. I didnt want to use rails migrations 
+    # to avoid messing with your database, and adding there anything more than the error_logs table 
+    # that is needed. Also this way we dont have to care if you still use old kind of numbered 
+    # migrations.
+    def self.auto_migrate!
+
+      unless Model.table_exists? 
+         Base.up
+         Model.reset_column_information
       end
 
-      add_index :error_hash, :category
-    end
-  end 
+      unless Model.column_names.include?('params')
+         AddParamsColumn.up
+         Model.reset_column_information
+      end
+
+      unless Model.column_names.include?('vcs_revision')
+         AddVcsRevisionColumn.up
+         Model.reset_column_information
+      end
 
-  class UpgradeMigration1 < ActiveRecord::Migration
-    def self.up
-      add_column :error_logs, :params, :text
     end
   end
 

data/lib/error_log/model.rb

@@ -5,18 +5,6 @@ module ErrorLog
 
       self.table_name = 'error_logs'
 
-      # Migrate database if needed
-      unless self.table_exists? 
-         Migration.up
-         reset_column_information
-      end
-
-      # Upgrade if needed
-      unless column_names.include?('params')
-         UpgradeMigration1.up
-         reset_column_information
-      end
-
       LEVELS = {
          :debug => 0,
          :info  => 1,
@@ -28,7 +16,6 @@ module ErrorLog
       }
 
       serialize :params, Hash
-      attr_accessor :count # used in grouping 
 
       def level
          LEVELS.invert[self.level_id]
@@ -47,6 +34,8 @@ module ErrorLog
 
          obj.error_hash = Digest::MD5.hexdigest(obj.backtrace.to_s + obj.error.to_s + obj.category.to_s)
 
+         obj.vcs_revision = nil if vcs_revision.empty?
+
          true
       end
 

data/lib/error_log/vcs.rb

@@ -0,0 +1,23 @@
+module ErrorLog
+  # VCS would be a better name, I'm just sticking to rails file and modules naming convention
+  module Vcs
+    def self.guess
+      if File.exists?(File.join(Rails.root,'.git'))
+        return :git
+      end
+      false
+    end
+
+    def self.revision
+      case ErrorLog.options[:vcs]
+      when :git
+        git_root = File.join(Rails.root,'.git') 
+        head = File.read("#{git_root}/HEAD")
+        ref = head.strip.split("ref:",2).last.strip
+        hash = File.read("#{git_root}/#{ref}").strip
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/error_log/version.rb

@@ -1,3 +1,3 @@
 module ErrorLog
-   VERSION = "0.0.5" unless defined?(::ErrorLog::VERSION)
+   VERSION = "0.0.6" unless defined?(::ErrorLog::VERSION)
 end

data/lib/error_log.rb

@@ -1,5 +1,12 @@
 require 'pp'
 
+
+# Everything you find directly in this module is skel from bones
+# Some really useful methods as for lib, but you probably are not
+# interested in any of them
+#
+# If you want to take a look at methods that you call directly on 
+# ErrorLog module, like ErrorLog.log, take a look at class_methods.rb
 module ErrorLog
 
   # :stopdoc:
@@ -60,37 +67,10 @@ module ErrorLog
     Dir.glob(search_me).sort.each {|rb| require rb}
   end
 
-
-  def self.log(level,error,options={})
-    backtrace = options[:backtrace]
-    unless backtrace
-       # get current backtrace, I'm happy to learn any more clever way
-       begin
-         raise "wat?!"
-       rescue Exception => e
-         backtrace = e.backtrace[1..-1]
-       end
-    end
-
-    #TODO: silent rescues may not be optimal, for now they seem better than creating more mess
-    logger.error "\n\n\n#{Time.now}\n= #{error}\n#{backtrace.join("\n")}\n#{options[:params]}" rescue nil
-
-    ErrorLog::Model.create(
-      :error => error,
-      :backtrace => backtrace,
-      :level => level,
-      :params => options[:params],
-      :category => options[:category] || 'error_log'
-    ) rescue nil 
-  end
-
-  def self.logger
-     @logger = Logger.new(File.join(Rails.root,'log','error.log'))
-  end
-
 end  # module ErrorLog
 
 
 ActiveSupport.on_load(:before_initialize) do
    ErrorLog.require_all_libs_relative_to(__FILE__)
+   ErrorLog.init
 end

data/views/index.html.haml

@@ -21,14 +21,29 @@
 %table#error_logs_wrap
   %tr
     %td{:valign=>"top"}
+
+      - all_count = @category_counts.values.sum
       %b Categories:
       %ul
         %li
-          = link_to_if @errors_category, 'all', :action => :index 
-          (#{@category_counts.values.sum})
+          = link_to_if @opts[:category], 'all', :action => :index, :category => '-none-' 
+          (#{all_count})
         - @category_counts.each_pair do |category,count| 
           %li
-            #{link_to_if (@errors_category != category), category, :action => :index, :category => category} (#{count})
+            #{link_to_if (@opts[:category] != category), category, :action => :index, :category => category} (#{count})
+
+      - if @revisions.count > 1 
+        %b Revisions:
+        %ul
+          %li
+            = link_to_if @opts[:revision], 'all', :action => :index, :revision => '-none-' 
+            (#{all_count})
+          - @revisions.each do |rev| 
+            %li{:style => 'white-space: nowrap'}
+              - name = rev.created_at_first.to_date.to_s + ' ' 
+              - name += (rev.vcs_revision.to_s.empty? ? 'unknown' : truncate(rev.vcs_revision,:length => 9))
+
+              #{link_to_if (@opts[:revision] != rev.vcs_revision.to_s), raw(name), :action => :index, :revision => rev.vcs_revision.to_s} (#{rev.count_all})
       %br 
       %br 
       %br 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: error_log
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Kacper Ciesla
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-17 00:00:00 +01:00
+date: 2010-11-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,11 +47,16 @@ files:
 - lib/error_log/model.rb
 - lib/error_log/controller.rb
 - lib/error_log/core_ext.rb
+- lib/error_log/class_methods.rb
 - lib/error_log/migrations.rb
+- lib/error_log/migrations/base.rb
+- lib/error_log/migrations/add_params_column.rb
+- lib/error_log/migrations/add_vcs_revision_column.rb
+- lib/error_log/vcs.rb
 - views/index.html.haml
 - views/_styles.html.erb
 - views/_error_log.html.haml
-- README.txt
+- README.rdoc
 - Changelog.txt
 has_rdoc: true
 homepage: