logga 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13c49b4d4a45c966a1e329a5e4fbecbf1d0766d2
-  data.tar.gz: 8b828e895133ea716983708adf4c7a763c04519b
+  metadata.gz: 92f8cbeea38fa8e6c0df26be6722dba58b4d2672
+  data.tar.gz: e5ff164fe6b4023e64b3d9e3d55fbd95e8197167
 SHA512:
-  metadata.gz: 39e077a00926918f3a62787ceb86ece91676aec46d0bc89052a4e15f77fb02a3a19926fb7d2bd97c4b618b39b2fb784d72449b57f9b06b5703b0e98c1eb4ec71
-  data.tar.gz: 8e991e17f2b07de6ed7da2e212c60a3c3c75c813d360d3c9063010847ce2957510b825300a65fc2fe57235e793688bbab246297b462c4c67c800828a3cc2e5ae
+  metadata.gz: d19d2e4b6b8e87221957d9996f35f14366106a3d6a8dfe4ccb71a6b8f7b2b3802cb5ce6243216de342c0f659d44143d5f76028b6fc5e503f6c79271ee39ad78e
+  data.tar.gz: 0766e0cc21b355d1a8462298d81b394ed16add4f27d01155052bb4b873fc9bc748cc956a610e41254520478dd41e702259f061f01ebc43ca0d0b3c3448c0f9c7

data/lib/logga/active_record.rb

@@ -2,30 +2,42 @@ module Logga
   module ActiveRecord
     extend ActiveSupport::Concern
 
+    EXCLUDED_KEYS          = [:created_at, :updated_at, :log, :sent_photos_chaser_email, :sent_after_sales_emails]
+    EXCLUDED_KEYS_SUFFIXES = [:_id, :_filenames]
+
+    included do
+      class_attribute :log_fields, instance_writer: false
+      self.log_fields = {}
+    end
+
     class_methods do
-      def add_log_entries_for(*actions, to: :self)
+      def add_log_entries_for(*actions, to: :self, fields: {})
         after_create :log_model_creation if actions.include?(:create)
         after_update :log_model_changes  if actions.include?(:update)
         define_method(:log_receiver) { to == :self ? self : send(to) }
+        self.log_fields = fields
       end
     end
 
     def log_model_creation
-      body = "#{self.class} created"
+      body_generator = ->(record) { default_creation_log_body(record) }
+      body = log_fields.fetch(:created_at, body_generator).call(self)
       log_receiver.log_entries.create(author_data.merge(body: body))
     end
 
     def log_model_changes
-      field_changes = changes.except(:created_at, :updated_at, :log)
+      field_changes = changes.reject do |k, _|
+        EXCLUDED_KEYS.include?(k.to_sym) ||
+        EXCLUDED_KEYS_SUFFIXES.any? { |suffix| k.to_s.end_with?(suffix.to_s) }
+      end
       log_field_changes(field_changes)
     end
 
     def log_field_changes(changes)
-      changes.each { |field, values| log_field_change(field, *values) }
-    end
-
-    def log_field_change(field, old_value, new_value)
-      body = "changed #{field} from #{old_value} to #{new_value}"
+      body_generator = ->(record, field, old_value, new_value) { default_change_log_body(record, field, old_value, new_value) }
+      body = changes.inject([]) do |body, (field, (old_value, new_value))|
+        body << log_fields.fetch(field.to_sym, body_generator).call(self, field, old_value, new_value)
+      end.join('\n')
       log_receiver.log_entries.create(author_data.merge(body: body))
     end
 
@@ -37,5 +49,16 @@ module Logga
           author_name: data[:name]
       }
     end
+
+    def default_creation_log_body(record)
+      [
+        "#{record.class.name.demodulize} created",
+        ("(#{record.state})" if record.try(:state))
+      ].compact.join(' ')
+    end
+
+    def default_change_log_body(record, field, old_value, new_value)
+      "#{record.class.name.demodulize} #{field} set to #{new_value}"
+    end
   end
-end
+end

data/lib/logga/version.rb

@@ -1,3 +1,3 @@
 module Logga
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logga
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stuart Chinery, Rob Hesketh, Lorenzo Tello
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler