oxy_logger 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49ec790e5c7675b55bcfacdea108a881a962aba4816b0fbd057198d810394650
+  data.tar.gz: 0c6ae15b91aeeeb2bf5b8d1cf4bc6e0789a764e2b31075a35b9e890f3495a0af
+SHA512:
+  metadata.gz: 4e7ba48953768e0985a1e7985c4730f2071407ebc1ea19962a6ca085d0a80d574ffe7bc69fac72b555152a5714029828416e40429611d0516b2947191a2c8ead
+  data.tar.gz: 1545beb94aead03d7ffab827b4b38949637e273c4b65812d4d60fb789b3c25867430e9e0ca3f711a529a86fa8bf5e28fa8c82e201db1c6903f094af27f8c64b9

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/oxy_logger-*
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in oxy_logger.gemspec
+gemspec
+gem 'mustache', '~> 1.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Paqwtv
+
+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,92 @@
+# OxyLogger
+
+Welcome to our Rails logger gem!
+
+This is a simple logger that is easy to use and can be configured as you want.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'oxy_logger', '~> 0.3.0'
+```
+
+Then run:
+
+    $ bundle install
+
+## Usage
+
+To include gem tasks inside your rails app.
+Add this code to rails `Rakefile`:
+
+```ruby
+  spec = Gem::Specification.find_by_name 'oxy_logger'
+  load "#{spec.gem_dir}/lib/tasks/logger_install.rake"
+```
+
+Then run the rake task.
+This command will create a configuration file in your application and run the `migration` to update your database.
+
+    $ rake oxy:install
+
+## Controller or Model logging
+
+In order to log the controller methods, add in `app/controllers/application_controller.rb`
+Do the same code for the Model, if you need to log it `app/models/application_record.rb`
+
+```ruby
+  extend OxyLogger::Sys
+  include OxyLogger::Helper
+```
+
+And at the end, specify what methods you want to use for logging.
+IMPORTANT! The method `log_it` must be at the end of the logged methods.
+
+```ruby
+  logg_it [ :index, :show, :new, :edit, :create, :update, :destroy ] # Select any of the available methods
+```
+
+Very simple isn't?
+
+## Configuration
+
+When you launched the rake task a configuration file was copied into your project, which you can find at `/config/initializers/logger_init.rb`
+
+```ruby
+OxyLogger.configure do |config|
+  # Save logs locally to a file or database
+  config.save_to = "file"  # or config.save_to = "db"
+```
+
+If you want to log to a file, you can specify the path to it.
+If this file does not exist, the **OxyLogger** will create it.
+
+```ruby
+  #  config.files_path = Rails.root + "/log/logged_data" # the same things in example 
+  config.files_path = Rails.root.join('log', 'logged_data')
+```
+
+You can choose which parameters you want to record.
+Unnecessary parameter just comment out or delete.
+
+```ruby
+  config.logget_fields = %i[
+    date_time         # called time
+    class_name        # class in which was called
+    method_name       # method in which was called
+    result            # return result
+    params            # parameters
+  ]
+```
+
+## Contributing
+
+We will be very happy if our product interests you and you will have an irresistible desire to help us with its development.
+
+https://github.com/[USERNAME]/oxy_logger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'oxy_logger'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/logger_init.rb

@@ -0,0 +1,52 @@
+require 'rails'
+require 'oxy_logger'
+
+class Object
+  def self.method_hook(*args)
+    options = args.extract_options!
+    return unless (options[:before].present? or options[:after].present?)
+    args.each do |method_name|
+      old_method = instance_method(method_name) rescue next
+
+      define_method(method_name) do |*args|
+        # invoke before callback
+        if options[:before].present?
+          options[:before].is_a?(Proc) ? options[:before].call(method_name, self):
+            send(options[:before], method_name, *args)
+        end
+
+        # you can modify the code to call after callback
+        # only when the old method returns true etc..
+        old_method.bind(self).call(*args)
+
+        # invoke after callback
+        if options[:after].present?
+          options[:after].is_a?(Proc) ? options[:after].call(method_name, self):
+            send(options[:after], method_name, *args)
+        end
+      end
+    end
+  end
+end
+
+# Default configure Logger GEM
+OxyLogger.configure do |config|
+  # @note - Save logs locally to a file or database
+  # @param value [String] - "file" or "db"
+  # @example
+  #  config.save_to = "db"
+  config.save_to = 'file'
+  # @param value [String] - way to save logs
+  # @example
+  #  config.files_path = Rails.root + "/log/logged_data" #the same things in example 
+  config.files_path = Rails.root.join('log', 'logged_data')
+  # @note - logged parameters
+  config.logget_fields = %i[
+    date_time
+    class_name
+    method_name
+    result
+    params
+  ]
+  # TODO add 'run_time' parametrs
+end

data/lib/oxy_logger.rb

@@ -0,0 +1,79 @@
+require "oxy_logger/version"
+require "oxy_logger/writer"
+
+module OxyLogger
+  module Sys
+    def logg_it(my_names)
+      my_names.each do |my_name|
+        method_hook( my_name, before: :log_befor )
+        method_hook( my_name, after: :log_after )
+      end
+    end
+  end
+
+  module Helper
+    def log_befor(method_name, *args)
+      first_data = {}
+      type = self.class.superclass.to_s
+      first_data[:start] = DateTime.now
+      first_data[:name] = method_name
+      first_data[:class_name] = self.class.name
+        if type == "ApplicationRecord"
+        first_data[:type] = :model
+        else
+        first_data[:type] = :controller
+        end
+      first_data[:params] = first_data[:type] == :model ?
+      first_data[:args] = args :
+      first_data[:args] = params
+      Writer.write(first_data)
+    end
+
+    def log_after(method_name, *args); end
+  end
+
+    @@files_path
+  # @param value [String] - путь куда сохранять логи
+  def self.files_path=(value)
+    @@files_path = value
+  end
+
+  # @param value [String] - "file" or "db"
+    @@save_to
+  def self.save_to=(value)
+    @@save_to = value
+  end
+
+    @@logget_fields
+  def self.logget_fields=(value)
+    @@logget_fields = value    
+  end
+
+  def self.logget_data
+    @@logget_fields
+  end
+
+  def self.path_to_log
+    @@files_path
+  end
+
+  # Конфигурирует сам себя
+  def self.configure
+    yield self    
+  end
+
+  # @note метод, возвращающий настройки всего приложения после инициализации
+  # @example
+  #   OxyLogger.config_oxy_hash
+  # @return [Hash] 
+  #   OxyLogger.config_oxy_hash => {:files_path=>"~/projects/logger", :save_to_file_or_db=>"file",
+  #   :incoming_params=>true, :output_params=>true, :processing_time=>true,
+  #   :date_time=>true, :called_method=>true, :class_name=>true}
+  def self.config_oxy_hash
+    {
+      files_path: @@files_path,
+      save_to: @@save_to,
+      logget_fields: @@logget_fields
+    }
+  end
+end

data/lib/oxy_logger/formatter.rb

@@ -0,0 +1,16 @@
+module OxyLogger
+  module Formatter
+    def self.format_data(first_data)
+      data = {}
+      data[:run_time] = first_data[:work_time]
+      data[:date_time] = first_data[:start]
+      data[:class_name] = first_data[:class_name]
+      data[:method_name] = first_data[:name]
+      data[:result] = first_data[:result]
+      data[:params] = first_data[:params]
+      data[:type] = first_data[:type]
+      data[:save_to] = OxyLogger.config_oxy_hash[:save_to].to_sym
+      data
+    end
+  end
+end

data/lib/oxy_logger/log_record.rb

@@ -0,0 +1,28 @@
+require 'mustache'
+
+module OxyLogger
+  class LogRecord
+    def initialize(data)
+      @data = data
+    end
+    
+    def save_to
+      @data[:save_to]
+    end 
+         
+    def for_db
+      @data.except(:save_to, :type)
+    end
+
+    def file_name
+      @data[:class_name] + '.log'
+    end
+
+    def for_file
+      text = @data.slice(OxyLogger.logget_data)
+      Mustache.template_file = "#{__dir__}/template.mustache"
+      str = Mustache.render(@data)
+      str
+    end
+  end
+end

data/lib/oxy_logger/template.mustache

@@ -0,0 +1,20 @@
+	LogRecord for:-------{{type}}
+{{# class_name}}
+	Logging at class:----{{class_name}}
+{{/ class_name}}
+{{# called_method}}
+	In method:-----------{{method_name}}
+{{/ called_method}}
+{{# date_time}}
+	Logging time:--------{{date_time}}
+{{/ date_time}}
+{{# processing_time}}
+	Processing time is:--{{run_time}}
+{{/ processing_time}}
+{{# output_params}}
+	Result:--------------{{result}}
+{{/ output_params}}
+{{# incoming_params}}
+	Incomming params:----{{params}}
+{{/ incoming_params}}
+_________________________________________________

data/lib/oxy_logger/version.rb

@@ -0,0 +1,3 @@
+module OxyLogger
+  VERSION = '0.3.0'
+end

data/lib/oxy_logger/writer.rb

@@ -0,0 +1,49 @@
+require 'rails'
+require 'active_record'
+require_relative 'formatter'
+require_relative 'log_record'
+
+module OxyLogger
+  module Writer
+  environment = ENV['RACK_ENV'] || 'development'
+  dbconfig = YAML.load(File.read('config/database.yml'))
+  ActiveRecord::Base.establish_connection(dbconfig[environment])
+
+  class LogDb < ActiveRecord::Base
+  end
+
+    def self.write(first_data)
+      data = Formatter.format_data(first_data)
+      record = LogRecord.new(data)
+      record.save_to == :db ?
+        save_to_db(record.for_db) :
+        save_to_file(record.file_name, record.for_file)
+    end
+
+    def self.check_path
+      if OxyLogger.path_to_log.exist? == false
+        Dir.mkdir(OxyLogger.path_to_log)
+      end
+    end
+
+    def self.save_to_file(file_name, text)
+      Writer.check_path
+      path = [OxyLogger.path_to_log, file_name].join('/')
+      
+      File.open(path, "a") do  |f|
+        f.print("#{text}\n")
+      end
+    end
+
+    def self.save_to_db(data)
+      LogDb.create do |log|
+        log.run_time = data[:run_time]
+        log.class_name = data[:class_name]
+        log.date_time = data[:date_time]
+        log.method_name = data[:method_name]
+        log.result = data[:result]
+        log.params = data[:params]
+      end
+    end
+  end
+end

data/lib/tasks/logger_install.rake

@@ -0,0 +1,27 @@
+
+# To include your task inside rails app you need add this to rails Rakefile:
+
+# spec = Gem::Specification.find_by_name 'oxy_logger'
+# load '#{spec.gem_dir}/lib/tasks/logger_install.rake'
+# ================================================
+# Type 'rake oxy:install' in terminal to run the task
+# ================================================
+
+require 'rake'
+  namespace :oxy do
+    desc 'Task for copy config file from gem to rails'
+    task :logger_init do 
+      cp(File.join(Gem.loaded_specs['oxy_logger'].full_gem_path,'config', 'logger_init.rb'), File.join(Rails.root,'config','initializers','logger_init.rb'))
+    end
+    desc 'Task for create oxy_logger table file in your rails app'
+    task :logger_table do 
+      system 'rails g migration CreateLogger user:string run_time:datetime date_time:datetime class_name:string method_name:string result:string params:string'
+    end  
+    desc 'Task for accept migration to db'
+    task :migrate do
+      system 'rake db:migrate'
+    end
+    desc 'install is a :logger_init and :logger_table'
+    task install: [:logger_init, :logger_table, :migrate] do
+    end
+  end

data/oxy_logger.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "oxy_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "oxy_logger"
+  spec.version       = OxyLogger::VERSION
+  spec.authors       = ["Dima, Vitalik, Vlad"]
+  spec.email         = ["paqwtv@gmail.com"]
+  spec.summary       = %q{Ruby logger gem}
+  spec.description   = %q{This is a simple logger that is easy to use and can be configured as you want.}
+  spec.homepage      = "https://github.com/Paqwtv/oxy_logger"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org/'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against "
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.9"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: oxy_logger
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Dima, Vitalik, Vlad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+description: This is a simple logger that is easy to use and can be configured as
+  you want.
+email:
+- paqwtv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/logger_init.rb
+- lib/oxy_logger.rb
+- lib/oxy_logger/formatter.rb
+- lib/oxy_logger/log_record.rb
+- lib/oxy_logger/template.mustache
+- lib/oxy_logger/version.rb
+- lib/oxy_logger/writer.rb
+- lib/tasks/logger_install.rake
+- oxy_logger.gemspec
+homepage: https://github.com/Paqwtv/oxy_logger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.7.2
+signing_key: 
+specification_version: 4
+summary: Ruby logger gem
+test_files: []