remexify 1.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in remexify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adam Pahlevi
+
+MIT License
+
+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,138 @@
+# Remexify
+
+Remexify is a simple, opinionated Ruby on Rails gem to write logs to your database. No fluff and to the point,
+record and access your logs anytime from your database.
+
+## Behind the scene
+
+> Roses are red violets are blue, a log is not a poem it should be accessible to you.
+
+In all the projects I am working on, I always have a database-backed logger. I am tired of managing
+all of those, but should-be identical logger. So, this gem really helped in.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'remexify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install remexify
+
+## Design Decision
+
+This gem monkey patch attribute already_logged(?) in two standard ruby error classes:
+
+1. RuntimeError
+2. StandardError
+ 
+`already_logged` (or `already_logged?`) will return nil if the exception is not yet logged.
+
+Additionally, there is new error class `DisplayableError`. DisplayableError will be quite handy if you want to raise an enduser-visible error. In your controller, you may only allow an instance of DisplayableError to be displayed. DisplayableError
+is nothing but a StandardError subclassed.
+
+If Remexify caught exceptions any of the above class, it will mark `already_logged` to `true`. Remexify won't log it again when parent/calling method rescue the error.
+
+## Usage
+
+To use this gem, you need to generate some files first. You can let the gem to generate all required files, including migration and initializer, for you. To do so, issue:
+
+    rails g remexify System::Loggers
+    
+You can name your log class anything, such as `System::Loggers`. After that, you have to migrate it.
+
+    rake db:migrate
+    
+Finally, you can use the gem!
+
+    Remexify.log err
+    Remexify.info "System is starting"
+    
+In a rails app, you may invoke the `error()` like this:
+
+    begin 
+      raise "error"
+    rescue => e 
+      Remexify.error e, file: __FILE__, class: self.class.name, method: __method__, line: __LINE__
+      raise e
+    end 
+            
+Remexify have 3 static functions:
+
+    def write(level, obj, options = {}); end;
+    def info(obj, options = {}); end;
+    def warning(obj, options = {}); end;
+    def error(obj, options = {}); end;
+    
+`write()` is the most basic function, that you will only need to use if you want to define the level yourself.
+Some level is predefined:
+
+    INFO = 100
+    WARNING = 200
+    ERROR = 300
+
+Thus, if you invoke `info()` level will be 100.
+
+The obj can be any object. You can pass it a(n instance of) `String`, or an `Exception`, `StandardError`, `RuntimeError`, `DisplayableError`.
+
+It will **automatically generate the backtrace if the object passed is an exception.**
+
+Options can have:
+
+1. :method
+2. :line
+3. :file
+4. :parameters
+5. :description
+
+All those options are optional, and, if given, will be stored in the database.
+
+In order to retrieve the recorded logs, you will deal with Remexify's Retrieve module. You may retrieve all logs:
+
+    Remexify::Retrieve.all
+    
+Or, you may also retrieve all logs recorded today:
+
+    Remexify::Retrieve.today
+    
+Both methods accepts a hash to which you can indicate an ordering of retrieved data:
+
+    Remexify::Retrieve.all order: "created_at DESC"
+    
+You may also delete all the logs in your database:
+
+    Remexify.delete_all_logs
+
+## What is recorded?
+
+These are the fields that is recorded:
+
+Field name | Key | Is for...
+---------- | ------------- | ------------
+level | N/A | let you know the level of the log: error, warning or info.
+md5 | N/A  | the fingerprint of the error, similar error should have similar fingerprint.
+message | :message | string of the error
+backtrace | N/A | backtrace of error, if the object is an instance of Error
+file_name | :file | file where the log was recorded
+class_name | :class | class where the log was recorded
+method_name | :method | method where the log was recorded
+line | :line | line where the log was recorded
+parameters | :params | arguments that's passed in a function/block that can be used later in attemp to reproduce the error
+description | :desc | programmer may pass in additional description here
+frequency | N/A | how many times `Remexify` encounter this error?
+timestamps | N/A | timestamp of the error when it was created, and last updated.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/remexify/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+by Adam Pahlevi Baihaqi

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/remexify_generator.rb

@@ -0,0 +1,33 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/named_base"
+
+module Remexify
+  module Generators
+    class RemexifyGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates a model with the given NAME for remexify to log error/informations"
+
+      namespace "remexify"
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_migration
+        migration_template "create_remexify_lognotes.rb", "db/migrate/create_remexify_lognotes.rb"
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], migration: false
+        # invoke "active_record:model", ["Remexify::Logs", "md5:string"], {migration: true, timestamps: true}
+      end
+
+      def make_initializer
+        template "initialize_remexify.rb", "config/initializers/remexify.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/create_remexify_lognotes.rb

@@ -0,0 +1,38 @@
+class CreateRemexifyLognotes < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      # 0 the more high the level, the more important.
+      t.integer :level, null: false, default: 0
+
+      # let your log unique
+      t.string :md5, null: false
+
+      t.text :message, null: false
+      t.text :backtrace
+      t.text :file_name
+
+      t.string :class_name, null: false
+      t.string :method_name
+      t.string :line
+
+      # additional parameters that want to be logged as well
+      t.text :parameters
+
+      # additional description that want to be logged as well
+      t.text :description
+
+      # how many times the system logging this error?
+      t.integer :frequency, null: false, default: 1
+
+      t.timestamps
+    end
+    add_index :<%= table_name %>, [:md5], unique: true
+  end
+
+  def self.down
+    # we don't want to make assumption of your roll back, please
+    # by all mean edit it.
+    # drop_table :<%= table_name %>
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/templates/initialize_remexify.rb

@@ -0,0 +1,3 @@
+Remexify.setup do |config|
+  config.model = <%= class_name %>
+end

data/lib/remexify/displayable_error.rb

@@ -0,0 +1,2 @@
+class DisplayableError < StandardError
+end

data/lib/remexify/remexify_retriever.rb

@@ -0,0 +1,30 @@
+module Remexify
+  module Retrieve
+    class << self
+      def all(options = {})
+        if options[:order]
+          return Remexify.config.model.order(options[:order]).all.to_a
+        end
+        return Remexify.config.model.all.to_a
+      end
+
+      def today(options = {})
+        ar_statement = Remexify.config.model.where(created_at: Time.now.beginning_of_day..Time.now.end_of_day)
+        if options[:order]
+          return ar_statement.order(options[:order]).all.to_a
+        end
+        return ar_statement.all.to_a
+      end
+
+      def where_fingerprint_is(fingerprint)
+        Remexify.config.model.where(md5: fingerprint).first
+      end
+    end
+  end
+
+  class << self
+    def delete_all_logs
+      Remexify.config.model.delete_all
+    end
+  end
+end

data/lib/remexify/remexify_writer.rb

@@ -0,0 +1,79 @@
+module Remexify
+  class << self
+    # options = class, method, line, file, params/param/parameters, desc/description
+    def write(level, obj, options = {})
+      if (obj.is_a?(StandardError) || obj.is_a?(RuntimeError)) && obj.already_logged
+        return
+      end
+
+      message = "message is nil"
+      backtrace = "backtrace is nil"
+
+      if obj.class <= Exception
+        message = obj.message
+        backtrace = obj.backtrace.join("\n")
+      elsif obj.class <= String
+        message = obj
+        backtrace = nil
+      end
+
+      # standardize into options[:parameters]
+      options[:parameters] = options[:param] if options[:param]
+      options[:parameters] = options[:params] if options[:params]
+      options[:parameters] = options[:parameter] if options[:parameter]
+      options[:parameters] ||= ""
+
+      # standardize into options[:description]
+      options[:description] = options[:desc] if options[:desc]
+      options[:description] ||= ""
+
+      # class name cannot be blank
+      class_name = options[:class]
+      class_name = Time.now.strftime("%Y%m%d") if class_name.blank?
+
+      # generate hash
+      hashed = "#{message}#{class_name}"
+      md5 = Digest::MD5.hexdigest hashed
+
+      # assure md5 is not yet exist, if exist, don't save
+      log = config.model.where(md5: md5).first
+      if log
+        log.frequency += 1
+        log.save
+      else
+        config.model.create({
+                                md5: md5,
+                                level: level,
+                                message: message,
+                                backtrace: backtrace,
+                                class_name: class_name,
+                                method_name: options[:method],
+                                line: options[:line],
+                                file_name: options[:file],
+                                parameters: (options[:parameters].blank? ? "" : options[:parameters].inspect),
+                                description: options[:description]
+                            })
+      end
+
+      # mark already logged if DisplayableError
+      if obj.is_a?(StandardError) || obj.is_a?(DisplayableError)
+        obj.already_logged = true
+      end
+
+      nil # don't return anything for logging!
+    end
+
+    def info(obj, options = {})
+      write INFO, obj, options
+    end
+
+    def warning(obj, options = {})
+      write WARNING, obj, options
+    end
+
+    def error(obj, options = {})
+      write ERROR, obj, options
+    end
+  end
+
+end

data/lib/remexify/runtime_error.rb

@@ -0,0 +1,4 @@
+class RuntimeError
+  attr_accessor :already_logged
+  alias_method :already_logged?, :already_logged
+end

data/lib/remexify/standard_error.rb

@@ -0,0 +1,4 @@
+class StandardError
+  attr_accessor :already_logged
+  alias_method :already_logged?, :already_logged
+end

data/lib/remexify/version.rb

@@ -0,0 +1,3 @@
+module Remexify
+  VERSION = "1.0.0"
+end

data/lib/remexify.rb

@@ -0,0 +1,24 @@
+require "remexify/version"
+require "active_support/configurable"
+
+module Remexify
+  include ActiveSupport::Configurable
+
+  INFO = 100
+  WARNING = 200
+  ERROR = 300
+
+  class << self
+    def setup
+      config.model = nil
+      yield config
+    end
+  end
+
+end
+
+require "remexify/standard_error"
+require "remexify/runtime_error"
+require "remexify/displayable_error"
+require "remexify/remexify_retriever"
+require "remexify/remexify_writer"

data/remexify.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remexify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "remexify"
+  spec.version       = Remexify::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Adam Pahlevi"]
+  spec.email         = ["adam.pahlevi@gmail.com"]
+  spec.summary       = %q{Simply log any message/error to your database}
+  spec.description   = %q{A gem that make your system a log handler as well, by saving any error to your database system}
+  spec.homepage      = "http://adampahlevi.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "railties", ">= 3.2.6", "< 5"
+  spec.add_development_dependency "rails", "~> 3"
+  spec.add_development_dependency "activesupport"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: remexify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Pahlevi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that make your system a log handler as well, by saving any error
+  to your database system
+email:
+- adam.pahlevi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.name"
+- ".idea/.rakeTasks"
+- ".idea/encodings.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/remexify.iml"
+- ".idea/scopes/scope_settings.xml"
+- ".idea/vcs.xml"
+- ".idea/workspace.xml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/remexify_generator.rb
+- lib/generators/templates/create_remexify_lognotes.rb
+- lib/generators/templates/initialize_remexify.rb
+- lib/remexify.rb
+- lib/remexify/displayable_error.rb
+- lib/remexify/remexify_retriever.rb
+- lib/remexify/remexify_writer.rb
+- lib/remexify/runtime_error.rb
+- lib/remexify/standard_error.rb
+- lib/remexify/version.rb
+- remexify.gemspec
+homepage: http://adampahlevi.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Simply log any message/error to your database
+test_files: []