tracker_jacker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 840c6c43cfb9f27c32cd7487eda3adcfb5ac2df5
+  data.tar.gz: 6fd3f01466d48867e7d381bd16e0d18d986e2617
+SHA512:
+  metadata.gz: 40e43e92d5b704a09668aa85a3bec30b7642a6c7899ade9fd9b22ae19a7fbf30c73610926c96869ecb7b7a06e4fc708ca246023da4baef181e4e107d42790159
+  data.tar.gz: c38e3ec0bac64b2520ac131d1cc5b140d3b4dd6f65d3ec7d4e96dffdb64ae6cf19e0f5df7fd63708f1abbdc0650a261d7b266668e2318bd82d5720f8224d8432

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2015 John Gesimondo and PlateJoy, Inc
+
+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/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TrackerJacker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/tracker_jacker/migration/migration_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/active_record'
+
+module TrackerJacker
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :name, :type => :string, :default => 'create_trackable_events'
+      # Create migration in project's folder
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}.rb"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# Migration responsible for creating trackable events
+class CreateTrackableEvents < ActiveRecord::Migration
+  def change
+    create_table :trackable_events do |t|
+      t.belongs_to :trackable, :polymorphic => true
+      t.belongs_to :owner, :polymorphic => true
+
+      t.string :category
+      t.string :event
+      t.text :new_value
+      t.text :old_value
+
+      t.timestamps null: false
+    end
+
+    add_index :trackable_events, [:trackable_id, :trackable_type]
+    add_index :trackable_events, [:owner_id, :owner_type]
+  end
+end

data/lib/tasks/tracker_jacker_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tracker_jacker do
+#   # Task goes here
+# end

data/lib/tracker_jacker/trackable.rb

@@ -0,0 +1,86 @@
+module TrackerJacker
+  module Trackable
+    EventTrackingCallback = Struct.new(:event, :if_proc, :owner_method, :category)
+    AttributeTrackingCallback = Struct.new(:attribute, :owner_method, :category)
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        after_save :run_track_event_callbacks
+        after_save :run_track_attribute_callbacks
+      end
+    end
+
+    module ClassMethods
+      def analytic_event_tracking_callbacks
+        @analytic_event_tracking_callbacks ||= {}
+      end
+
+      def analytic_attribute_tracking_callbacks
+        @analytic_attribute_tracking_callbacks ||= {}
+      end
+
+      def track_event(event, options = {})
+        if_proc = options.fetch(:if)
+        owner_method = options.fetch(:owner)
+        category = options.fetch(:category)
+
+        analytic_event_tracking_callbacks[event] = EventTrackingCallback.new(event, if_proc, owner_method, category)
+      end
+
+      def track_attribute(attribute, options = {})
+        owner_method = options.fetch(:owner)
+        category = options.fetch(:category)
+
+        analytic_attribute_tracking_callbacks[attribute] = AttributeTrackingCallback.new(attribute, owner_method, category)
+      end
+
+      def track_attributes(attributes, options = {})
+        attributes.each {|attr| track_attribute(attr, options)}
+      end
+    end
+
+    def run_track_attribute_callbacks
+      return if @ignore_tracking
+
+      object = self
+      object.class.analytic_attribute_tracking_callbacks.values.each do |event_callback|
+        dirty_method = event_callback.attribute.to_s + "_changed?"
+        if object.public_send(dirty_method)
+          owner = object.public_send(event_callback.owner_method)
+          TrackerJacker::TrackableEvent.create(
+            category: event_callback.category,
+            owner: owner,
+            trackable: object,
+            event: event_callback.attribute.to_s + "_changed",
+            old_value: object.public_send(event_callback.attribute.to_s + "_was"),
+            new_value: object.public_send(event_callback.attribute)
+          )
+        end
+      end
+      true
+    end
+
+    def run_track_event_callbacks
+      return if @ignore_tracking
+
+      object = self
+      object.class.analytic_event_tracking_callbacks.values.each do |event_callback|
+        if event_callback.if_proc.call(object)
+          owner = object.public_send(event_callback.owner_method)
+          TrackerJacker::TrackableEvent.create(
+            category: event_callback.category,
+            owner: owner,
+            trackable: object,
+            event: event_callback.event
+          )
+        end
+      end
+      true
+    end
+
+    def ignore_tracking!
+      @ignore_tracking = true
+    end
+  end
+end

data/lib/tracker_jacker/trackable_event.rb

@@ -0,0 +1,14 @@
+module TrackerJacker
+  class TrackableEvent < ActiveRecord::Base
+    belongs_to :trackable, polymorphic: true
+    belongs_to :owner, polymorphic: true
+    
+    def week_created
+      created_at.at_beginning_of_week
+    end
+
+    def month_created
+      created_at.at_beginning_of_month
+    end
+  end
+end

data/lib/tracker_jacker/version.rb

@@ -0,0 +1,3 @@
+module TrackerJacker
+  VERSION = "1.0.0"
+end

data/lib/tracker_jacker.rb

@@ -0,0 +1,5 @@
+require 'tracker_jacker/trackable'
+require 'tracker_jacker/trackable_event'
+
+module TrackerJacker
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: tracker_jacker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Gesimondo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: Track events and ActiveRecord attribute changes in a timeline
+email:
+- john@jmondo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/generators/tracker_jacker/migration/migration_generator.rb
+- lib/generators/tracker_jacker/migration/templates/migration.rb
+- lib/tasks/tracker_jacker_tasks.rake
+- lib/tracker_jacker.rb
+- lib/tracker_jacker/trackable.rb
+- lib/tracker_jacker/trackable_event.rb
+- lib/tracker_jacker/version.rb
+homepage: https://github.com/HealthyDelivery/tracker_jacker
+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: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Track events and ActiveRecord attribute changes
+test_files: []