log_changes 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cac50df66f4bbf5b431b1594c2ae8b051ce81fc4
-  data.tar.gz: 836919fc6c68e35d9abaaec218d9b7f81a46755b
+  metadata.gz: b1470104760459fde7eb28abce175dc5c94e2157
+  data.tar.gz: f1e02001e4ea961d395d8b3301767b807764dd4b
 SHA512:
-  metadata.gz: 8490c5addfef1fa4d696598c4c9b56b333c936cdcf659853192870c25a011a1477a8cb4bded905bdb6425961877580ef8c21dccd433429529d1c8b3bb7623596
-  data.tar.gz: d20b3e85a7aa3de3e88389e7a02943c4cf20cd7e10f045d1f3549b86580b750afcd1bdcb31425dcc32baaf3c630a3bf821699f8a3861c51ad68eb97f5baf86bc
+  metadata.gz: 7bb15684947c874a4f972bc53b09fa81c91c2249fd3994020aad8eff94bcdaf26a69d180a1628048ae039bb3d28907dff529fbb3f23d2648159a279d259fd072
+  data.tar.gz: f47441a7a0d1e087ed50242c2b013fce2905d9f38cbf4a930409b2fbbcfe486f87729eefdc35dd352682ffe7dc162b85f165afce3ef952da7bbd4f0ae86d5f0d

data/README.md

@@ -1,8 +1,44 @@
 # LogChanges
-Short description and motivation.
+
+`log_changes` is a simple gem that writes `ActiveRecord#changes` contents to model-dedicated logfiles.
 
 ## Usage
-How to use my plugin.
+To log attribute changes for a model simply add `include LogChanges::Base` to an `ActiveRecord` model:
+
+```ruby
+class User < ApplicationRecord
+  include LogChanges::Base
+
+  def to_s
+    "#{first_name} #{last_name}"
+  end
+end
+```
+
+In this example, if the `User` record with id = 1 had his name updated you may see an entry like this appear `logs/record_changes/2016.12_User.log`:
+
+```
+12/29/2016 at 3:48 PM (UTC)
+Updated User {id: 1} John Smith
+  first_name:
+    FROM: Johnny
+    TO: John
+  last_name:
+    FROM: Smithers
+    TO: Smith
+```
+
+Logfiles are prefixed with a month stamp (to prevent them from getting too big over time).
+
+### Aggregating logfiles
+
+If your Rails app runs in a load-balanced distributed environment, you may wish to aggregate logs from multiple servers. `log_changes` comes with a rake task for this purpose:
+
+```
+rake log_changes:merge['/path/to/logs/directory']
+```
+
+Make sure the path you pass to the task has multiple subfolders (one per server), each with a `record_changes` directory containing the log files.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -13,16 +49,8 @@ gem 'log_changes'
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install log_changes
-```
-
-## Contributing
-Contribution directions go here.
-
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/log_changes.rb

@@ -2,5 +2,6 @@ require 'log_changes/engine'
 require 'sr_log'
 
 module LogChanges
-  autoload :Base,   'log_changes/base'
+  autoload :Base, 'log_changes/base'
+  autoload :Merge, 'log_changes/merge'
 end

data/lib/log_changes/merge.rb

@@ -0,0 +1,123 @@
+module LogChanges
+  module Merge
+    def merge_logfiles( log_dir )
+      [true, false].each do |record_changes|
+        logfiles = associate_logfiles( log_dir, record_changes )
+
+        aggregate_log_dir = File.expand_path( File.join(log_dir, "../#{Time.now.in_time_zone.strftime('%Y-%m-%d_%H%M')}_aggregated_logs#{record_changes ? '/record_changes' : ''}") )
+        FileUtils.mkdir_p( aggregate_log_dir )
+
+        logfiles.each do |log_type, logfile_paths|
+          entries = []
+          logfile_paths.each do |lf|
+            lf_entries = logfile_entries(lf)
+            if lf_entries.nil?
+              puts "\nSKIPPING logfile (unable to parse entries): #{lf}\n\n"
+            else
+              entries += lf_entries
+            end
+          end
+          next if entries.empty?
+          entries.sort!{|e1, e2| e1[:time] <=> e2[:time]}
+          merged_log = File.join(aggregate_log_dir, "#{log_type}_#{entries.first[:time].in_time_zone.strftime('%Y-%m-%d_%H%M')}_-_#{entries.last[:time].in_time_zone.strftime('%Y-%m-%d_%H%M')}.log")
+          File.open( merged_log, 'w' ) do |file|
+            entries.each do |entry|
+              file.write "#{entry[:time].strftime('%-m/%-d/%Y at %-l:%M %p (%Z)')}\n"
+              file.write "#{entry[:text]}\n\n"
+            end
+          end
+          puts "Merged log: #{merged_log}\n  #{entries.length} #{'entry'.pluralize(entries.length)}"
+        end
+      end
+    end
+
+    # Returns a hash whose keys are the common log names and whose values are arrays of file paths, e.g.:
+    # {
+    #                     "ajax_errors" => [
+    #       [ 0] "/Users/seanhuber/Downloads/record_changes/2015.08_ajax_errors.log",
+    #       [ 1] "/Users/seanhuber/Downloads/record_changes/2015.09_ajax_errors.log",
+    #       [ 2] "/Users/seanhuber/Downloads/record_changes/2015.10_ajax_errors.log"
+    #   ],
+    #               "care_plan_updates" => [
+    #       [ 0] "/Users/seanhuber/Downloads/record_changes/2015.08_care_plan_updates.log",
+    #       [ 1] "/Users/seanhuber/Downloads/record_changes/2015.09_care_plan_updates.log",
+    #       [ 2] "/Users/seanhuber/Downloads/record_changes/2015.10_care_plan_updates.log"
+    #   ],
+    #                    "eval_updates" => [
+    #       [ 0] "/Users/seanhuber/Downloads/record_changes/2015.08_eval_updates.log",
+    #       [ 1] "/Users/seanhuber/Downloads/record_changes/2015.09_eval_updates.log",
+    #       [ 2] "/Users/seanhuber/Downloads/record_changes/2015.10_eval_updates.log"
+    #   ],
+    # }
+    def associate_logfiles( log_dir, record_changes = false )
+      raise "Directory does not exist: #{log_dir}" unless File.directory?( log_dir )
+
+      # scans for logfiles prefixed with a month stamp like "2016.03_"
+      ret_h = {}
+      search_path = record_changes ? File.join(log_dir, '**', 'record_changes', '*.log') : File.join(log_dir, '**', '20*_*.log')
+      Dir.glob(search_path) do |log_fp|
+        next if !record_changes && (log_fp.include?('record_changes') || log_fp.include?('import')) # TODO: include import
+        month_stamp = File.basename(log_fp).split('_').first
+        next unless month_stamp.length == 7 && month_stamp[4] == '.'
+        begin
+          DateTime.strptime(month_stamp, '%Y.%m')
+        rescue ArgumentError
+          next
+        end
+        log_class = File.basename(log_fp, File.extname(log_fp)).split('_')[1..-1].join('_')
+        ret_h[log_class] ||= []
+        ret_h[log_class] << log_fp
+      end
+      ret_h
+    end
+
+    # Returns an array of hashes containing time and text of each log entry, e.g.,
+    # [
+    #   [0] {
+    #       :time => Thu, 17 Sep 2015 12:20:00 -0500,
+    #       :text => "Logged by user: (bm25671) John Doe\nSome message was logged"
+    #   },
+    #   [1] {
+    #       :time => Thu, 17 Sep 2015 12:27:00 -0500,
+    #       :text => "Logged by user: (bm25671) Jane Smith\nLorem ipsum..."
+    #   },
+    #   [2] {
+    #       :time => Thu, 17 Sep 2015 13:24:00 -0500,
+    #       :text => "Logged by user: (vr16208) Charlie Williams\nblah blah blah"
+    #   }
+    # ]
+    #
+    # Returns nil if entries couldn't be parsed (unable to find lines structured DateTime)
+    def logfile_entries( logfile )
+      lines = File.open( logfile ).map{|l| l}
+      entry_indexes = [] # lines that are just a timestamp
+      lines.each_with_index do |line, idx|
+        next unless first_char_is_num?( line )
+        dt = begin
+          DateTime.strptime(line.strip, "%m/%d/%Y at %l:%M %p (%Z)")
+        rescue ArgumentError
+          nil
+        end
+        next if dt.nil?
+        next if idx > 0 && lines[idx-1].strip.present? && !lines[idx-1].strip.starts_with?('Logged by user:')
+        entry_indexes << idx
+      end
+      return nil if entry_indexes.empty?
+
+      # TODO: refactor (shouldn't need to loop over the logfile twice)
+      entries = []
+      entry_indexes.each_with_index do |entry_idx, entry_indexes_idx|
+        end_idx = entry_indexes_idx == (entry_indexes.length - 1) ? (lines.length-1) : (entry_indexes[entry_indexes_idx+1]-1)
+        end_idx -= 1 if lines[end_idx].starts_with?('Logged by user:')
+        entry_text = lines[entry_idx+1..end_idx].join
+        entry_text = lines[entry_idx-1] + entry_text if entry_idx > 0 && lines[entry_idx-1].starts_with?('Logged by user:')
+        entries << {:time => DateTime.strptime(lines[entry_idx].strip, "%m/%d/%Y at %l:%M %p (%Z)"), :text => entry_text.strip}
+      end
+      entries
+    end
+
+    def first_char_is_num?( str )
+      !(str[0] =~ /^\d/).nil?
+    end
+  end
+end

data/lib/log_changes/version.rb

@@ -1,3 +1,3 @@
 module LogChanges
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/tasks/merge_logfiles.rake

@@ -0,0 +1,9 @@
+namespace :log_changes do
+  desc 'aggregates logfiles created with log_changes'
+  task :merge, [:logs_path] do |_, args|
+    raise ArgumentError, 'No logs directory specified' unless args[:logs_path].present? && File.directory?(args[:logs_path])
+    include LogChanges::Merge
+    Time.zone = 'Central Time (US & Canada)' # for timestamping log files (TODO: is this needed?)
+    merge_logfiles args[:logs_path]
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_changes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Sean Huber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2016-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -136,8 +136,10 @@ files:
 - lib/log_changes.rb
 - lib/log_changes/base.rb
 - lib/log_changes/engine.rb
+- lib/log_changes/merge.rb
 - lib/log_changes/version.rb
 - lib/tasks/log_changes_tasks.rake
+- lib/tasks/merge_logfiles.rake
 - log_changes.gemspec
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/config/manifest.js