recorder 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99e7c1bf50c6c1844ee0961756ffe1ab06128991
-  data.tar.gz: 51d81209e457c6d099f3ffb168ac261bcf559aed
+  metadata.gz: b4550b7a532edd1f5ce2c56036803a96ca4f8242
+  data.tar.gz: 4051cdb776fe3d7c25ad879547cd56dae3ae35ac
 SHA512:
-  metadata.gz: f0d3fc8fb50bbb4bb2d87ad02cb2086669e6cced785e65a96a4f911a1ec6e33d0a4dcf81feecdc8bf6299e9fefe8601ae5fd54845f9ce0c8a100f256b26d278b
-  data.tar.gz: 4812c0ac7f9c24fb614f7eb9f038c42ab57b5a732e319674d89ad87fe374fb4dd513077a881330e3a496859a7f3d1677ee1108c0818c3c3829d064a051d734d1
+  metadata.gz: 73714c8436f37e393705489ecfe4ea23d805cec43bf158e3b920945e246bd48d631fb48c7c07c4e114ce9a891b7ac857293faa099a8a63f08a2cb15c1e29838f
+  data.tar.gz: c3030783723e4d3e59ae67fabc6e2bd3f18c718f2339893375b750c54ad2d7cfdbcd6bfded0c7d08b115edc2adbe8c1a122b4b4091b64b98fc60ef3dc9e8a190

data/lib/generators/recorder/install_generator.rb

@@ -12,14 +12,30 @@ module Recorder
       :with_partitions,
       type: :boolean,
       default: false,
-      desc: "Create partitions for `revisions` table"
+      desc: "Create partitions to `recorder_revisions` table"
     )
 
-    desc "Generates (but does not run) a migration to add a `revisions` table."
+    class_option(
+      :with_number_column,
+      type: :boolean,
+      default: false,
+      desc: "Add `number` column to `recorder_revisions` table"
+    )
+
+    class_option(
+      :with_index_by_user_id,
+      type: :boolean,
+      default: false,
+      desc: "Add index by `user_id` column to `recorder_revisions` table"
+    )
+
+    desc "Generates (but does not run) a migration to add a `recorder_revisions` table."
 
     def create_migration_file
       self.add_or_skip_recorder_migration('create_recorder_revisions')
-      self.add_or_skip_recorder_migration('add_partitions_to_recorder_revisions_table') if options.with_partitions?
+      self.add_or_skip_recorder_migration('add_number_column_to_recorder_revisions') if options.with_number_column?
+      self.add_or_skip_recorder_migration('add_index_by_user_id_to_recorder_revisions') if options.with_index_by_user_id?
+      self.add_or_skip_recorder_migration('add_partitions_to_recorder_revisions') if options.with_partitions?
     end
 
     def self.next_migration_number(dirname)

data/lib/generators/recorder/templates/add_index_by_user_id_to_recorder_revisions.rb

@@ -0,0 +1,6 @@
+# This migration adds number column to the `revisions` table.
+class AddIndexByUserIdToRecorderRevisions < ActiveRecord::Migration
+  def up
+    add_index :recorder_revisions, :user_id
+  end
+end

data/lib/generators/recorder/templates/add_number_column_to_recorder_revisions.rb

@@ -0,0 +1,41 @@
+# This migration adds number column to the `revisions` table.
+class AddNumberColumnToRecorderRevisions < ActiveRecord::Migration
+  def up
+    add_column :recorder_revisions, :number, :integer, :null => false, :default => 0
+
+    execute <<-SQL
+CREATE OR REPLACE FUNCTION get_recorder_revisions_number()
+  RETURNS trigger AS
+$BODY$
+BEGIN
+    SELECT COALESCE(MAX(recorder_revisions.number), 0) + 1
+    INTO NEW.number
+    FROM
+      recorder_revisions
+    WHERE
+      recorder_revisions.item_type = NEW.item_type
+      AND recorder_revisions.item_id = NEW.item_id;
+
+    RETURN NEW;
+END;
+$BODY$ LANGUAGE plpgsql;
+    SQL
+
+    execute <<-SQL
+CREATE TRIGGER update_recorder_revisions_number BEFORE INSERT ON recorder_revisions FOR EACH ROW
+EXECUTE PROCEDURE get_recorder_revisions_number();
+    SQL
+  end
+
+  def down
+    execute <<-SQL
+      DROP TRIGGER update_recorder_revisions_number;
+    SQL
+
+    execute <<-SQL
+      DROP FUNCTION IF EXISTS get_recorder_revisions_number;
+    SQL
+
+    remove_column :recorder_revisions, :number
+  end
+end

data/lib/generators/recorder/templates/create_recorder_revisions.rb

@@ -1,4 +1,4 @@
-# This migration creates the `revisions` table.
+# This migration creates the `recorder_revisions` table.
 class CreateRecorderRevisions < ActiveRecord::Migration
   def change
     create_table :recorder_revisions do |t|

data/lib/recorder/changeset.rb

@@ -16,12 +16,9 @@ module Recorder
       else
         self.item.class.human_attribute_name(attribute.to_s)
       end
-
     end
 
     def previous(attribute)
-      # self.changes[attribute.to_s][0]
-      # self.previous_version.try("display_#{attribute}") || self.previous_version.try(attribute)
       self.try("previous_#{attribute}") || self.previous_version.try(attribute)
     end
 
@@ -39,7 +36,6 @@ module Recorder
 
     def next(attribute)
       self.try("next_#{attribute}") || self.next_version.send(attribute)
-      # self.next_version.try("display_#{attribute}") || self.next_version.try(attribute)
     end
 
     def next_version

data/lib/recorder/observer.rb

@@ -11,7 +11,7 @@ module Recorder
 
     module ClassMethods
       def recorder(options = {})
-        define_method 'recorder_option' do
+        define_method 'recorder_options' do
           options
         end
 

data/lib/recorder/revision.rb

@@ -24,4 +24,32 @@ class Recorder::Revision < ActiveRecord::Base
   validates :data, :presence => true
 
   scope :ordered_by_created_at, -> { order(:created_at => :desc) }
+
+  def item_changeset
+    return @item_changeset if defined?(@item_changeset)
+
+    @item_changeset ||= self.changeset_klass(self.item).new(self.item, self.data['changes'])
+  end
+
+  def changed_associations
+    self.data['associations'].keys
+  end
+
+  def association_changeset(name)
+    association = self.item.send(name)
+    # association = association.source if association.decorated?
+
+    self.changeset_klass(association).new(association, self.data['associations'].fetch(name.to_s).try(:fetch, 'changes'))
+  end
+
+protected
+
+  def changeset_klass(object)
+    klass = (defined?(Draper) && object.decorated?) ? object.source.class : object.class
+    klass = klass.base_class
+    klass = "#{klass}Changeset"
+
+    klass = klass.constantize rescue nil
+    klass.present? ? klass : Recorder::Changeset
+  end
 end

data/lib/recorder/tape.rb

@@ -6,12 +6,23 @@ module Recorder
       @item = item;
     end
 
-    def record_create
-      data = {
-        :changes => self.sanitize_attributes(self.item.attributes)
-      }
+    def changes_for(event)
+      changes = case event.to_sym
+      when :create
+        self.sanitize_attributes(self.item.attributes)
+      when :update
+        self.sanitize_attributes(self.item.previous_changes)
+      when :destroy
+        self.sanitize_attributes(self.item.previous_changes)
+      else
+        raise ArgumentError
+      end
 
-      # changes.merge!(self.parse_associations_attributes)
+      changes.any? ? { :changes => changes } : {}
+    end
+
+    def record_create
+      data = self.changes_for(:create)
 
       if data.any?
         self.record(
@@ -24,12 +35,14 @@ module Recorder
     end
 
     def record_update
-      data = {
-        :changes => self.sanitize_attributes(self.item.previous_changes)
-      }
+      # data = {
+      #   :changes => self.sanitize_attributes(self.item.previous_changes)
+      # }
 
-      associations = self.parse_associations_attributes
-      data.merge!(:associations => self.parse_associations_attributes) if associations.any?
+      data = self.changes_for(:update)
+
+      associations = self.parse_associations_attributes(:update)
+      data.merge!(:associations => self.parse_associations_attributes(:update)) if associations.any?
 
       if data.any?
         self.record(
@@ -55,10 +68,15 @@ module Recorder
     end
 
     def sanitize_attributes(attributes = {})
-      attributes.symbolize_keys.except(self.item.recorder_options[:except])
+      if self.item.recorder_options[:except].present?
+        except = Array.wrap(self.item.recorder_options[:except])
+        attributes.symbolize_keys.except(*except)
+      else
+        attributes
+      end
     end
 
-    def parse_associations_attributes
+    def parse_associations_attributes(event)
       if self.item.recorder_options[:associations].any?
         self.item.recorder_options[:associations].inject({}) do |hash, association|
           reflection = self.item.class.reflect_on_association(association)
@@ -66,13 +84,16 @@ module Recorder
             if reflection.collection?
 
             else
-              object = self.item.send(association)
-
-              if object.present? && self.sanitize_attributes(object.previous_changes).any?
-                hash[reflection.name] = {
-                  :changes => self.sanitize_attributes(object.previous_changes)
-                }
+              if object = self.item.send(association)
+                changes = Recorder::Tape.new(object).changes_for(event)
+                hash[reflection.name] =  changes if changes.any?
               end
+
+              # if object.present? && self.sanitize_attributes(object.previous_changes).any?
+              #   hash[reflection.name] = {
+              #     :changes => self.sanitize_attributes(object.previous_changes)
+              #   }
+              # end
             end
           end
 

data/lib/recorder/version.rb

@@ -3,7 +3,7 @@ module Recorder
   module VERSION
     MAJOR = 0
     MINOR = 1
-    TINY = 3
+    TINY = 4
     PRE = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".").freeze

data/lib/recorder.rb

@@ -25,20 +25,17 @@ module Recorder
       @active_record_protected_attributes ||= !!defined?(ProtectedAttributes)
     end
 
+    # Returns version of Recorder as +String+
+    def version
+      VERSION::STRING
+    end
+
     # Thread-safe hash to hold Recorder's data.
     # @api private
     def store
       RequestStore.store[:recorder] ||= { }
     end
-
-    def version
-      VERSION::STRING
-    end
   end
 end
 
-if defined?(Draper)
-  require 'recorder/draper/decorator_concern'
-end
-
 require 'recorder/revision'

data/recorder.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recorder
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Igor Alexandrov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -120,6 +120,20 @@ dependencies:
     - - "~>"
       - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Recorder tracks changes of your Rails models
 email:
 - igor.alexandrov@jetrockets.ru
@@ -138,10 +152,11 @@ files:
 - bin/setup
 - lib/generators/recorder/USAGE
 - lib/generators/recorder/install_generator.rb
+- lib/generators/recorder/templates/add_index_by_user_id_to_recorder_revisions.rb
+- lib/generators/recorder/templates/add_number_column_to_recorder_revisions.rb
 - lib/generators/recorder/templates/create_recorder_revisions.rb
 - lib/recorder.rb
 - lib/recorder/changeset.rb
-- lib/recorder/draper/decorator_concern.rb
 - lib/recorder/observer.rb
 - lib/recorder/rails/controller_concern.rb
 - lib/recorder/revision.rb
@@ -173,3 +188,4 @@ signing_key:
 specification_version: 4
 summary: Rails model auditor
 test_files: []
+has_rdoc: 

data/lib/recorder/draper/decorator_concern.rb

@@ -1,37 +0,0 @@
-module Recorder
-  module Draper
-    module DecoratorConcern
-      def self.included(base)
-        base.decorates_association :item
-      end
-
-      def item_changeset
-        return @item_changeset if defined?(@item_changeset)
-
-        @item_changeset ||= self.changeset_klass(self.item.source).new(self.item, source.data['changes'])
-      end
-
-      def changed_associations
-        source.data['associations'].keys
-      end
-
-      def association_changeset(name)
-        association = self.item.send(name)
-        # association = association.source if association.decorated?
-
-        self.changeset_klass(association).new(association, source.data['associations'].fetch(name.to_s).try(:fetch, 'changes'))
-      end
-
-    protected
-
-      def changeset_klass(object)
-        klass = object.decorated? ? object.source.class : object.class
-        klass = klass.base_class
-        klass = "#{klass}Changeset"
-
-        klass = klass.constantize rescue nil
-        klass.present? ? klass : Recorder::Changeset
-      end
-    end
-  end
-end