historyable 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWE3OTczNmRmZmQxY2RhMzc0OTk1MTJlY2JjMGUwY2E1YjlkMTJkNQ==
+  data.tar.gz: !binary |-
+    OTZhYWFhOWQwZGIzNGNhNWMwNTlhM2U4OTJlNWY3YjM5OGUwMmU4NA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjUyZTBiZDRhMmRmYmVhZmYyOTU4ZjBjMGU5MDc1ODZhOTUwZjE3ZWIxY2Vm
+    ZDM5MGE5ZDhmOGIwZWY3OTY1MDUzZDM3YWQ4MzBlY2NiYzE3YWQ3YzkwZTMw
+    ZjJlMzNjOGNhMTQwNTM3OWU1YThhMmM2MmQ0YTYwNTYyNzJjY2M=
+  data.tar.gz: !binary |-
+    MWI1YzFmZmZiODZkNzg4ZDU2ZTRlM2RlN2NjYjk0YzY0NmI0NDc1M2Y5ZWEy
+    ZDU4MTRhZDZjMmNmMzEzZDJmNmUyYTU5NjllOWI4MDA3YzQ5Y2NkYmQ3NTUw
+    NThhYTczM2FiOWFmNjY3YWE3MTc2MzYxNmRjMmVlMTlmNTU5YWI=

data/lib/generators/historyable/USAGE

@@ -0,0 +1,2 @@
+Description:
+  The historyable:install generator generates a migration creating a `changes` table in your database.

data/lib/generators/historyable/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Historyable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+         "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_changes.rb'
+      end
+    end
+  end
+end

data/lib/generators/historyable/templates/migration.rb

@@ -0,0 +1,16 @@
+class CreateChanges < ActiveRecord::Migration
+  def up
+    create_table :changes do |t|
+      t.references :item, polymorphic: true
+      t.string     :object_attribute
+      t.text       :object_attribute_value
+      t.datetime   :created_at
+    end
+
+    add_index :changes, [:item_type, :item_id]
+  end
+
+  def down
+    drop_table :changes
+  end
+end

data/lib/historyable/change.rb

@@ -0,0 +1,4 @@
+class Change < ActiveRecord::Base
+  belongs_to :historyable, polymorphic: true
+  serialize :object_attribute_value
+end

data/lib/historyable/version.rb

@@ -0,0 +1,3 @@
+module Historyable
+  VERSION = "0.0.1"
+end

data/lib/historyable.rb

@@ -0,0 +1,102 @@
+require "historyable/version"
+
+require "active_record"
+require "historyable/change"
+
+module Historyable
+  class Item < Struct.new(:attribute, :association_name); end
+
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :historyable_items, instance_writer: false
+  end
+
+
+  module ClassMethods
+
+    # @param attributes [Array, Symbol]
+    def has_history(*attributes)
+      self.historyable_items = attributes.map do |attribute|
+        attribute        = attribute.to_sym
+        association_name = attribute.to_s.insert(-1, '_changes').to_sym
+
+        Historyable::Item.new(attribute, association_name)
+      end
+
+      # Associations
+      historyable_items.each do |historyable|
+        has_many historyable.association_name,
+                 as:         :item,
+                 class_name: '::Change',
+                 dependent:  :destroy
+      end
+
+
+      # Instance methods
+      historyable_items.each do |historyable|
+
+        # raw_attribute_history
+        #
+        # @return [ActiveRecord::Relation]
+        define_method("raw_#{historyable.attribute.to_s}_history") do
+          send(historyable.association_name)
+            .where(object_attribute: historyable.attribute)
+            .order('created_at DESC')
+            .select(:object_attribute_value, :created_at)
+        end
+
+
+        # attribute_history
+        #
+        # @return [Array]
+        define_method("#{historyable.attribute.to_s}_history") do
+          unless instance_variable_get("@#{historyable.attribute.to_s}_history".to_sym)
+            array = []
+
+            records = send("raw_#{historyable.attribute}_history")
+                         .pluck(:object_attribute_value, :created_at)
+            records.map do |attribute_value, created_at|
+              hash = HashWithIndifferentAccess.new
+              hash[:attribute_value] = attribute_value
+              hash[:changed_at]      = created_at
+
+              array << hash
+            end
+
+            # Sets attribute_history cache
+            instance_variable_set("@#{historyable.attribute.to_s}_history".to_sym, array)
+            array
+          else
+            instance_variable_get("@#{historyable.attribute.to_s}_history".to_sym)
+          end
+        end
+      end
+
+
+      # Callbacks
+      around_save :save_changes
+    end
+  end
+
+
+  private
+
+  # Creates a Change record when an attribute marked as 'historyable' changes
+  def save_changes
+    changed_historyable_items = historyable_items.select do |historyable|
+      changed.include?(historyable.attribute.to_s)
+    end
+
+    yield # saves the records
+
+    changed_historyable_items.each do |historyable|
+      send(historyable.association_name).create(object_attribute: historyable.attribute,
+                                                object_attribute_value: send(historyable.attribute))
+      # Expires attribute_history cache
+      instance_variable_set("@#{historyable.attribute.to_s}_history".to_sym, nil)
+    end
+
+    true
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: historyable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Philippe Dionne
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURmRENDQW1TZ0F3SUJB
+  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREJDTVJRd0VnWURWUVFEREF0a2FX
+  OXUKYm1VdWNHaHBiREVWTUJNR0NnbVNKb21UOGl4a0FSa1dCV2R0WVdsc01S
+  TXdFUVlLQ1pJbWlaUHlMR1FCR1JZRApZMjl0TUI0WERURXpNRE13T1RFek1q
+  TXpOVm9YRFRFME1ETXdPVEV6TWpNek5Wb3dRakVVTUJJR0ExVUVBd3dMClpH
+  bHZibTVsTG5Cb2FXd3hGVEFUQmdvSmtpYUprL0lzWkFFWkZnVm5iV0ZwYkRF
+  VE1CRUdDZ21TSm9tVDhpeGsKQVJrV0EyTnZiVENDQVNJd0RRWUpLb1pJaHZj
+  TkFRRUJCUUFEZ2dFUEFEQ0NBUW9DZ2dFQkFMdEdLMk5vRnlWWApzZUtsZkhi
+  OG51aEJ5OHJ3MW5QM0pWSFdveXFhbExzMHQzYXhVV2U2c0RDZ1FYQU9MM0Z0
+  a2ZZUFlseVg2WDRzCkZnZ2NTeVNVdDBQdkdkYXMweW0vbFcrc2ZHVDZnWERC
+  S2JQdmtXRk50cFhhSUo4RkxocW5KUjJtNTdiOFI2cGYKVk1CRGthOTVOODBY
+  dTlOUXJBZXNGK3dXL2M2WmlBT04yVkRzV2FiWkVmajE0Nnk3WnZ2aUI3cFpI
+  bFB6bkk0VwpHVmZPazBNQ2wwUTYwSnlrN1d3TmVjK05BOXJHN3ZFL2RXZEdP
+  S2Z4VTZaSm5DNmRyQzNrQnNCS2tSWnMrR1JoCjZYb0NBc3JLYlJ3Yi9aSTNB
+  MVMvSjl5dnEvTlExQi9VM0Npc0JGaHQrQ2Jkc3BlWFZVRHg1ZGZmRFZ4bnhk
+  by8KdzJSM3dKTXZEMk1DQXdFQUFhTjlNSHN3Q1FZRFZSMFRCQUl3QURBTEJn
+  TlZIUThFQkFNQ0JMQXdIUVlEVlIwTwpCQllFRkErNjlkR3h2RnRMeEorYUg4
+  bDRVTzl5eTg1M01DQUdBMVVkRVFRWk1CZUJGV1JwYjI1dVpTNXdhR2xzClFH
+  ZHRZV2xzTG1OdmJUQWdCZ05WSFJJRUdUQVhnUlZrYVc5dWJtVXVjR2hwYkVC
+  bmJXRnBiQzVqYjIwd0RRWUoKS29aSWh2Y05BUUVGQlFBRGdnRUJBRDdWcHV5
+  bTBWdm5YT3lkb0NCa3Yvdzh1MzJOamlndDNiRjNpL1A5MTEwOAphRHZPUlV5
+  bVlyUHhhQmUrQXNTSlVrSkIwTUh5d0pkTWM0TUYzWUlTZWxDdlVGR3phOExZ
+  dnZVSWd5VktGb20rClROOFdDUFpMbzRtWWFZbzRzU3RrRi9HNXY4STNydVpP
+  YnI3by9mMjB4RzVyOEU0TkQyR0VHVGVGSmhncE1jSE8KSXIxdVluL0xMZUdH
+  NWcyRUFLQ2RZeTJYb29odGNTUFlBcGJlRlFnV09HS29pb1FWUkNERzNjSG1h
+  a2ZWQVY1TQpEdU5senZqaFd0UER3RTVtWU81eDVYcXVXUXVFTnc3OHVydDFh
+  aW9OckllMC8xNWRIcERvSUVESUxhNnpVNDZCClhEdHAxWXhkZVZHSUJ1Tm9Q
+  MXZqRFN2TktZajBwTWpSQUVQcnFLMzlqS0U9Ci0tLS0tRU5EIENFUlRJRklD
+  QVRFLS0tLS0K
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: active_record
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+description: Tracks model attributes changes.
+email:
+- philippe.dionne@hooktstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/historyable/USAGE
+- lib/generators/historyable/install_generator.rb
+- lib/generators/historyable/templates/migration.rb
+- lib/historyable.rb
+- lib/historyable/change.rb
+- lib/historyable/version.rb
+homepage: https://github.com/hooktstudios/historyable
+licenses:
+- MIT
+metadata: {}
+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: ! '[none]'
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Tracks model attributes changes.
+test_files: []
+has_rdoc: