maven_logger 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a75fedeba0df43a70e64852c3dbf330f5d8cf837
+  data.tar.gz: 3101f0d0129e0304abaa3c918bd87974b472740a
+SHA512:
+  metadata.gz: 06584688213c1d96a6f6f93ee3770bd5d98c7b4fd8403b8f64d0922bd6042e099726a67fd7ba180ca4a6e957a62225ea2bbb90d7a14efc45f8653383ad97998d
+  data.tar.gz: 31fae3f5b95f05516bb0da65d4b85648b2a19e634e5d9e6ac4d0ec3f0649547e6e58685c9d5e61cf6459bbcfbe976488ba70012efc475bde48c9fabe58437846

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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,49 @@
+= MavenLogger
+
+Easily logger for mongoid
+
+== Usage
+
+MavenLogger requires you to have a LoggerEntry and LoggerSchema models.
+The simplest way is to use the generator for install maven_logger:
+
+  rails generate maven_logger:install
+
+Next step is to determine in config maven_logger.rb file what generates an event in your various classes.
+
+  MavenLogger.setup do |config|
+    config.class_actions = [
+      [PostsController, %i[new create]],
+      [Post, %i[import]],
+      ...
+    ]
+  end
+
+and add description text to maven_logger.en.yml that should be written in description in LoggerEntry
+Name of locale method should contain name of class with underscore. For example:
+
+  maven_logger:
+    posts_controller:
+      new: 'new post event called'
+      create: 'post created'
+    post:
+      import: 'the new post imported'
+
+You can add schema statements to classes to log some info about it.
+For example to save of count results:
+
+  class LoggerSchema < MavenLogger::Schema
+    add_schema_for Post, :import, :data_fetched
+
+    private
+
+    def self.data_fetched(result)
+      { count: result.count }
+    end
+  end
+
+== Credits
+
+Thank you, Arkadiy Butermanov for sharing your modules and other scripts from which I derived inspiration for items in this project.
+
+Copyright (c) 2014 Ildus Sadykov. It is free software and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+# put here translations for logger description
+
+en:
+  maven_logger:
+    #  some_class:
+    #    some_action: 'some info'
+

data/lib/generators/maven_logger/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/base'
+require 'securerandom'
+
+module MavenLogger
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc 'Creates a MavenLogger initializer and copy locale files to your application.'
+
+      def copy_initializer
+        template 'maven_logger.rb', 'config/initializers/maven_logger.rb'
+      end
+
+      def copy_locale
+        copy_file '../../../config/locales/en.yml', 'config/locales/maven_logger.en.yml'
+      end
+
+      def copy_models
+        copy_file 'logger_entry.rb', 'app/models/logger_entry.rb'
+        copy_file 'logger_schema.rb', 'app/models/logger_schema.rb'
+      end
+    end
+  end
+end

data/lib/generators/templates/logger_entry.rb

@@ -0,0 +1,22 @@
+class LoggerEntry
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :object_type, type: String
+  field :object_id,   type: String
+  field :action_type, type: String
+  field :description, type: String
+  field :data,        type: Hash
+
+  attr_accessor :result
+
+  before_create :prepare_result
+
+  validates :object_type, :object_id, :action_type, :description, presence: true
+
+  private
+
+  def prepare_result
+    self.data = LoggerSchema.prepare(self)
+  end
+end

data/lib/generators/templates/logger_schema.rb

@@ -0,0 +1,12 @@
+class LoggerSchema < MavenLogger::Schema
+  # add some schema for classes
+  # add_schema_for SomeClass, :some_action, :some_method
+
+  private
+
+  # WARNING: These methods should be whitelisted in RBP
+
+  #def self.some_method(result)
+  #  { some_info: result }
+  #end
+end

data/lib/generators/templates/maven_logger.rb

@@ -0,0 +1,9 @@
+MavenLogger.setup do |config|
+  # add class and class actions that should be logged
+  # in locale config files should use main module or class name for action description
+
+  # config.class_actions =
+  #  [
+  #    [SomeClass, %i[some_method some_method]]
+  #  ]
+end

data/lib/maven_logger/action.rb

@@ -0,0 +1,19 @@
+module MavenLogger
+  module Action
+    def add_action(logged_methods)
+      logged_methods.each do |method_name|
+        if instance_methods.include?(method_name)
+          Redefiner.redefine_instance_method(
+            self,
+            method_name
+          )
+        else
+          Redefiner.redefine_class_method(
+            self,
+            method_name
+          )
+        end
+      end
+    end
+  end
+end

data/lib/maven_logger/engine.rb

@@ -0,0 +1,24 @@
+module MavenLogger
+  class Engine < ::Rails::Engine
+    #isolate_namespace MavenLogger
+    config.maven_logger = MavenLogger
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+      g.orm :mongoid
+    end
+
+    initializer 'maven_logger.logger_configure' do
+      Initializer.configure do |config|
+        MavenLogger.class_actions.each do |class_name, actions|
+          config.log_class class_name do |klass|
+            klass.add_action actions
+          end
+        end
+      end
+    end
+  end
+end

data/lib/maven_logger/initializer.rb

@@ -0,0 +1,12 @@
+module MavenLogger
+  class Initializer
+    def self.configure(&block)
+      yield(new)
+    end
+
+    def log_class(klass, &block)
+      klass.extend(MavenLogger::Action)
+      yield(klass)
+    end
+  end
+end

data/lib/maven_logger/redefiner.rb

@@ -0,0 +1,59 @@
+module MavenLogger
+  module Redefiner
+    def self.redefine_instance_method(mixer_class, method_name)
+      original_method = "#{method_name}_original"
+
+      mixer_class.class_eval do
+        alias_method original_method, method_name
+
+        send :define_method, method_name do |*args|
+          result = send(original_method, *args)
+          MavenLogger::Redefiner.create_log_entry(
+            mixer_class,
+            method_name,
+            result
+          )
+          result
+        end
+      end
+    end
+
+    def self.redefine_class_method(mixer_class, method_name)
+      name = "#{name}_original"
+
+      mixer_class.instance_eval do
+        mixer_class.singleton_class.send(:alias_method, name, method_name)
+
+        mixer_class.singleton_class.send :define_method, method_name do |*args|
+          result = send(name.to_s, *args)
+          MavenLogger::Redefiner.create_log_entry(
+            mixer_class,
+            method_name,
+            result
+          )
+          result
+        end
+      end
+    end
+
+    def self.create_log_entry(mixer_class, method_name, result)
+      if mixer_class.respond_to?(:id)
+        object_id = mixer_class.id
+      else
+        object_id = mixer_class.object_id
+      end
+
+      log_name = mixer_class.to_s.demodulize.underscore
+
+      log_info = {
+        object_type: mixer_class.to_s,
+        object_id:   object_id,
+        action_type: method_name.to_s,
+        description: I18n.t("maven_logger.#{log_name}.#{method_name}"),
+        result:      result
+      }
+
+      LoggerEntry.create(log_info)
+    end
+  end
+end

data/lib/maven_logger/schema.rb

@@ -0,0 +1,20 @@
+module MavenLogger
+  class Schema
+    cattr_accessor :schema
+    self.schema = {}
+
+    def self.prepare(entry)
+      class_name = entry.object_type.underscore.to_sym
+      method_name = entry.action_type.to_sym
+
+      send(schema[class_name][method_name], entry.result) if schema[class_name] && schema[class_name][method_name]
+    end
+
+    def self.add_schema_for(klass, method, handler)
+      class_name = klass.name.underscore.to_sym
+      schema[class_name] = {} unless schema[class_name]
+
+      schema[class_name][method] = handler
+    end
+  end
+end

data/lib/maven_logger/version.rb

@@ -0,0 +1,3 @@
+module MavenLogger
+  VERSION = '0.0.1.alpha'
+end

data/lib/maven_logger.rb

@@ -0,0 +1,13 @@
+require 'maven_logger/action'
+require 'maven_logger/engine'
+require 'maven_logger/initializer'
+require 'maven_logger/redefiner'
+require 'maven_logger/schema'
+
+module MavenLogger
+  mattr_accessor :class_actions
+
+  def self.setup
+    yield self
+  end
+end

data/lib/tasks/maven_logger_tasks.rake

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

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,4 @@
+class PostsController < ApplicationController
+  def index
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/logger_entry.rb

@@ -0,0 +1,22 @@
+class LoggerEntry
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :object_type, type: String
+  field :object_id,   type: String
+  field :action_type, type: String
+  field :description, type: String
+  field :data,        type: Hash
+
+  attr_accessor :result
+
+  before_create :prepare_result
+
+  validates :object_type, :object_id, :action_type, :description, presence: true
+
+  private
+
+  def prepare_result
+    self.data = LoggerSchema.prepare(self)
+  end
+end

data/spec/dummy/app/models/logger_schema.rb

@@ -0,0 +1,12 @@
+class LoggerSchema < MavenLogger::Schema
+  # add some schema for classes
+  # add_schema_for SomeClass, :some_action, :some_method
+
+  private
+
+  # WARNING: These methods should be whitelisted in RBP
+
+  #def self.some_method(result)
+  #  { some_info: result }
+  #end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie"
+
+Bundler.require(*Rails.groups)
+require "maven_logger"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end