oh_my_log 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b6e566db9eef37a2baa46558246d1806cdb6168b5b1e893670570f8455d4fdd
+  data.tar.gz: 5846cde591c8be91cfc8b45df5d83ff6660ae1a5782bdef8ac962ffd4765888b
+SHA512:
+  metadata.gz: aed087cbaf738416e0377c8824c995c0de36692aeaf408594fb22b413e294d842fca0479eed429a2a8bf2f7feeaae0e14d1486554911d624eef77ddb0b6ba031
+  data.tar.gz: 821c53d92e568c3790432fc683274fec3c1614b25ade16c94ecab89787eb27b5c39334bc9d2d679e2f2731a7d87cddc53eb87c3cfcac73ea19adce4a790169a8

data/.codeclimate.yml

@@ -0,0 +1,65 @@
+lversion: "2"
+checks:
+  argument-count:
+    enabled: true
+    config:
+      threshold: 4
+  complex-logic:
+    enabled: true
+    config:
+      threshold: 4
+  file-lines:
+    enabled: true
+    config:
+      threshold: 250
+  method-complexity:
+    enabled: true
+    config:
+      threshold: 5
+  method-count:
+    enabled: true
+    config:
+      threshold: 20
+  method-lines:
+    enabled: true
+    config:
+      threshold: 25
+  nested-control-flow:
+    enabled: true
+    config:
+      threshold: 4
+  return-statements:
+    enabled: true
+    config:
+      threshold: 4
+  similar-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+  identical-code:
+    enabled: true
+    config:
+      threshold: #language-specific defaults. overrides affect all languages.
+plugins:
+  rubocop:
+    enabled: true
+    channel: rubocop-0-59
+  markdownlint:
+    enabled: true
+  brakeman:
+    enabled: true
+    config:
+      app_path: spec/dummy
+exclude_patterns:
+  - "config/"
+  - "db/"
+  - "dist/"
+  - "features/"
+  - "**/node_modules/"
+  - "script/"
+  - "**/spec/"
+  - "**/test/"
+  - "**/tests/"
+  - "**/vendor/"
+  - "**/*.d.ts"
+  - "gemfiles/"

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+bin/*
+-
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,8 @@
+.idea/
+rdoc/*
+coverage/*
+spec/dummy/log/*
+spec/dummy/tmp/*
+.bundle
+Gemfile.lock
+vendor/

data/.rubocop.yml

@@ -0,0 +1,73 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+    - 'lib/tasks/**/*'
+  Exclude:
+    - Gemfile*
+    - README
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'bin/**/*'
+    - 'vendor/bundle/**/*'
+    - 'spec/support/**/*' # rspec support helpers have a strange api
+
+Rails:
+  Enabled: true
+
+# We don't care about method length, since we check method cyclomatic
+# complexity.
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Naming/FileName:
+  Exclude: ["oh_my_log.gemspec"]
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+  SupportedStyles:
+    - nested
+    - compact
+
+Layout/TrailingBlankLines:
+  Description: 'Checks trailing blank lines and final newline.'
+  StyleGuide: '#newline-eof'
+  Enabled: false
+  EnforcedStyle: final_newline
+  SupportedStyles:
+    - final_newline
+    - final_blank_line
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Trailing commas make for clearer diffs because the last line won't appear
+# to have been changed, as it would if it lacked a comma and had one added.
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    # Using `[]` for string arrays instead of `()`, since normal arrays are
+    # indicated with `[]` not `()`.
+    '%w': '[]'
+    '%W': '[]'
+
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  # They read better, more like normal English.
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,31 @@
+language: ruby
+before_install: gem install bundler -v '1.17.3'
+install: bundle _1.17.3_ install --jobs=3 --retry=3
+script: bundle exec rspec
+rvm:
+  - 2.3.0
+  - 2.4.0
+  - 2.5.0
+  - 2.6.0
+  - ruby-head
+matrix:
+  exclude:
+    # Skip these combinations because they have incompatible dependencies
+    # and will always fail.
+    - rvm: 2.6.0
+      gemfile: gemfiles/rails_4.2_stable.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/rails_4.2_stable.gemfile
+#    - rvm: 2.3
+#      gemfile: gemfiles/rails_6.0_beta.gemfile
+#    - rvm: 2.4
+#      gemfile: gemfiles/rails_6.0_beta.gemfile
+  allow_failures:
+#    - gemfile: gemfiles/rails_6.0_beta.gemfile
+#    - rvm: ruby-head
+gemfile:
+  - gemfiles/rails_4.2_stable.gemfile
+  - gemfiles/rails_5.0_stable.gemfile
+  - gemfiles/rails_5.1_stable.gemfile
+  - gemfiles/rails_5.2_stable.gemfile
+#  - gemfiles/rails_6.0_beta.gemfile

data/Appraisals

@@ -0,0 +1,25 @@
+appraise 'rails-4.2-stable' do
+  gem 'rails', '~> 4.2.0'
+  gem 'rails-observers'
+end
+
+appraise 'rails-5.0-stable' do
+  gem 'rails', '~> 5.0.0'
+  gem 'rails-observers'
+end
+
+appraise 'rails-5.1-stable' do
+  gem 'rails', '~> 5.1.0'
+  gem 'rails-observers'
+end
+
+
+appraise 'rails-5.2-stable' do
+  gem 'rails', '~> 5.2.0'
+  gem 'rails-observers'
+end
+
+# appraise 'rails-6.0-beta' do
+#   gem 'rails', '~> 6.0.0.beta1'
+#   gem 'rails-observers'
+# end

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019 Fabrizio Spadaro
+
+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,180 @@
+# OhMyLog
+
+[![Build Status](https://travis-ci.com/fabriziospadaro/oh_my_log.svg?branch=master)](https://travis-ci.com/fabriziospadaro/oh_my_log)[![Coverage Status](https://coveralls.io/repos/github/fabriziospadaro/oh_my_log/badge.svg?branch=master)](https://coveralls.io/github/fabriziospadaro/oh_my_log?branch=master)[![Maintainability](https://api.codeclimate.com/v1/badges/adf9807d95dab0112f0c/maintainability)](https://codeclimate.com/github/fabriziospadaro/oh_my_log/maintainability)
+
+![N|Solid](https://i.ibb.co/WgCY6WX/oh-my-log-logo-256x270.png)
+ 
+##### Oh my log is a powerful auditing system gem that tracks each changes on a model without being intrusive at all
+___
+### Dependecy
+* Rails
+* ActiveRecord or MongoId
+### How to use:
+* 1- Include this gem in your gemfile:
+
+```sh
+gem 'oh_my_log', git: "https://bitbucket.org/thefoolsrl/oh_my_log"
+```
+
+* 2- Generate the initializer with the following rake task:
+
+```sh
+bundle exec rake oh_my_log:generate_initializer
+```
+
+This rake task will generate a simple initializer that you can later change:
+
+```sh
+OhMyLog::Log.configure do |config|
+  OhMyLog::Log.configure do |config|
+    config.print_log = true
+    selector = OhMyLog::Log::Selector.universal_for(actions: {"EXCEPT" =>["index"]})
+    #selector.set_status_codes("ONLY" =>[(0..200)])
+    config.add_selector(selector)
+    #put your configs here
+  end
+end
+```
+
+* 3- Generate Observers using the following rake task:
+
+```sh
+bundle exec rake oh_my_log:generate_observers
+```
+
+ ---
+#### Configuration Class
+
+###### Instance variables:
+
+>models Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of models' name)
+
+>print_log bool (print the results on the console)
+
+>record_history bool (keep track of all the activity recorded by OML)
+
+>log_instance File (instance of the file where you want to store the recorded activities)
+
+>log_path string (path of the file where you want to store the recorded activities)
+
+>selectors Selector[] (instance list of all the selectors)
+
+###### Instance methods:
+
+>add_selector(selector ->Selector) (use this to add a new selector inside the configuration,
+you need to pass an instance of the Selector class)
+
+----
+
+#### Selector Class
+
+When using multiple selectors remember that if any of the conditions among all selectors fails the logger will not register
+
+###### Instance variables:
+
+>[read only] controllers Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of Controller Names)
+
+>[read only] actions Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of actions)
+
+>[read only] ips Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of ips)
+
+>[read only] status_codes Hash(the key is the rule: ONLY/EXCEPT/ALL the value is an array of status codes)
+
+###### Instance methods:
+
+>set_controllers (controller ->Hash{string =>string[]})
+
+>set_actions (actions ->Hash{string =>string[]})
+
+>set_ips (ips ->Hash{string =>string[]})
+
+>set_status_codes (status_codes ->Hash{string =>Range[]})
+
+###### Class methods:
+
+>universal_for(action: {"ALL" =>[]}, controllers: {"ALL" =>[]}) (inside the hash only or
+except you can put an array of actions)
+
+Complex initializer example:
+
+```sh
+OhMyLog::Log.configure do |config|
+  config.print_log = true
+  selector = OhMyLog::Log::Selector.new
+  selector.set_controllers("EXCEPT" =>["ApplicationController"])
+  selector.set_actions("ONLY" =>["index","create","destroy"])
+  selector.set_status_codes("ONLY" =>[(0..200)])
+  selector.set_ips("EXCEPT"=>["192.168.0.1"])
+  config.add_selector(selector)
+  #put your configs here
+end
+```
+
+---
+
+#### OhMyLog::Log Module
+
+###### Module variables:
+
+>targets Model[] (list of all models affected by the current action)
+
+>configuration Configuration (configuration for the Log)
+
+>history Result[] (history of all the results occurred during a session)
+
+>last_recorded Result (result produced by the last loggable action)
+
+###### Module methods:
+
+>configure(&block) (use configure method to pass a configuration block)
+
+>clear (clear the history)
+
+>flush (get rid of all the cached data(targets) stored in the Log)
+
+#### OhMyLog::Log::Result Class
+
+###### Instance variables:
+
+>effects Effect[] (list of effects that an action has caused)
+
+>request Request (request done by the user)
+
+>flush (get rid of all the cached data(targets) stored in the Log)
+
+---
+
+#### OhMyLog::Log::Request Class
+
+###### Instance variables:
+
+>sender string(who did the action, if you are logged with devise it will be the email of the logged user, else it will be the ip wich the request came from)
+
+>date Time (when did the action occured in UTC)
+
+>params string (headers of the rails request)
+
+>method string (method of the request: GET/HEAD/POST/PATCH/PUT/DELETE)
+
+>status int (status code of the request) 
+
+---
+
+#### OhMyLog::Log::Effect Class
+
+###### Instance variables:
+
+>receiver Model (instance of the model that got affected by the action) 
+
+>changes string (changes that this model had before and after the action)
+
+---
+ 
+### Development 
+
+Developed by Fabrizio Spadaro 
+
+### License:
+MIT
+ 
+**Free Software, Hell Yeah!**

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'rubygems'
+require 'bundler'
+require 'rake/testtask'
+require 'rdoc/task'
+require 'oh_my_log/version'
+
+desc 'Default: generate Oh My Log doc'
+task default: :doc
+
+Rake::RDocTask.new(:doc) do |rdoc|
+  version = OhMyLog::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "oh_my_log_#{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/blue_print/oh_my_log_initializer.rb

@@ -0,0 +1,8 @@
+OhMyLog::Log.configure do |config|
+  config.print_log = true
+  selector = OhMyLog::Log::Selector.universal_for(actions: {"EXCEPT" => ["index"]})
+  #selector.set_status_codes("ONLY" => [(0..200)])
+  config.add_selector(selector)
+  OhMyLog.start if File.directory?(Rails.root + "app/models/observers/oh_my_log")
+  #put your configs here
+end

data/gemfiles/rails_4.2_stable.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.0"
+gem "rails-observers"
+
+gemspec path: "../"

data/gemfiles/rails_4.2_stable.gemfile.lock

@@ -0,0 +1,181 @@
+PATH
+  remote: ..
+  specs:
+    oh_my_log (1.0.0)
+      json
+      rails (>= 4.2.0, < 7.0)
+      rails-observers (~> 0.1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.11)
+      actionpack (= 4.2.11)
+      actionview (= 4.2.11)
+      activejob (= 4.2.11)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.11)
+      actionview (= 4.2.11)
+      activesupport (= 4.2.11)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.11)
+      activesupport (= 4.2.11)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.11)
+      activesupport (= 4.2.11)
+      globalid (>= 0.3.0)
+    activemodel (4.2.11)
+      activesupport (= 4.2.11)
+      builder (~> 3.1)
+    activerecord (4.2.11)
+      activemodel (= 4.2.11)
+      activesupport (= 4.2.11)
+      arel (~> 6.0)
+    activesupport (4.2.11)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (6.0.4)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    coveralls (0.8.22)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    erubis (2.7.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    json (2.2.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rack (1.6.11)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.11)
+      actionmailer (= 4.2.11)
+      actionpack (= 4.2.11)
+      actionview (= 4.2.11)
+      activejob (= 4.2.11)
+      activemodel (= 4.2.11)
+      activerecord (= 4.2.11)
+      activesupport (= 4.2.11)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.11)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rails-observers (0.1.5)
+      activemodel (>= 4.0)
+    railties (4.2.11)
+      actionpack (= 4.2.11)
+      activesupport (= 4.2.11)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.10)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tins (1.20.2)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+    wwtd (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler
+  coveralls
+  oh_my_log!
+  rails (~> 4.2.0)
+  rails-observers
+  rspec-core
+  rspec-rails
+  rubocop (~> 0.59.2)
+  sqlite3 (= 1.3.10)
+  wwtd
+
+BUNDLED WITH
+   1.17.1

data/gemfiles/rails_5.0_stable.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.0.0"
+gem "rails-observers"
+
+gemspec path: "../"