trackit 0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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/README.md

@@ -0,0 +1,128 @@
+TrackIt
+=======
+
+TrackIt is a small gem which helps you keep track of changes in you ActiveRecord models persistently.
+While ActiveModel::Dirty allows you to keep track on changes only when the change occurs, TrackIt will keep attributes as changed until you decide to clear them.
+
+Getting Started
+===============
+
+First you will have to add TrackIt to your gemfile.
+
+```ruby
+gem 'trackit'
+```
+
+Run the `bundle install` command in order to install the gem.
+
+After the gem was successfully installed you need to run the generator:
+
+```console
+rails generate track_it Model attr_a attr_b
+```
+
+This will generate tracking for Model class which inherits from ActiveRecord::Base, and only for attributes attr_a, attr_b.
+
+The last step is migrating your database:
+
+```console
+rake db:migrate
+```
+
+You may need to restart your app if it is already running.
+
+Usage
+=====
+
+TrackIt provides an interface on your model instance as follows:
+
+```ruby
+model = Model.new
+
+model.tracked.changed?
+model.tracked.changed
+model.tracked.attr_a_changed?
+model.tracked.attr_b_changed?
+.
+.
+.
+```
+
+Each method corresponds to its similiar named method under [ActiveModel::Dirty](http://api.rubyonrails.org/classes/ActiveModel/Dirty.html).
+
+Two auxiliary methods are supplied:
+
+```ruby
+model.tracked.set_all_changed
+model.tracked.set_all_unchanged
+```
+
+Which sets all tracked attributes to changed/unchaged states.
+
+Concrete Example
+================
+Assume you have a User model which has the following attributes: name, address, current_job
+
+```ruby
+class User < ActiveRecord::Base
+end
+```
+
+And you want to keep track on all those users who changed their current jobs or addresses:
+
+```console
+rails generate track_it User address current_job
+```
+
+And
+
+```console
+rake db:migrate
+```
+
+Let's take a look at the effects of our change:
+
+```ruby
+u = User.create!(:name => "user1", :adderss => "address1", :current_job => "job1")
+
+u.address = "address2"
+u.current_job = "job2"
+
+u.current_job_changed? # => true
+u.address_changed? # => true
+u.changed? # => true
+u.changed # => ['address', 'current_job']
+
+u.tracked.current_job_changed? # => false
+u.tracked.address_changed? # => false
+u.tracked.changed? # => false
+u.tracked.changed # => []
+
+u.save!
+
+u.current_job_changed? # => false
+u.address_changed? # => false
+u.changed? # => false
+u.changed # => []
+
+
+u.tracked.current_job_changed? # => true
+u.tracked.address_changed? # => true
+u.tracked.changed? # => true
+u.tracked.changed # => ['address', 'current_job']
+
+u.tracked.set_unchanged(:current_job)
+u.tracked.current_job_changed? # => false
+
+u.tracked.set_changed(:current_job)
+u.tracked.current_job_changed? # => true
+
+u.tracked.set_all_unchanged
+u.tracked.changed? # => false
+u.tracked.changed # => []
+
+u.tracked.set_all_changed
+u.tracked.changed? # => true
+u.tracked.changed # => ['address', 'current_job'] # note name is not changed - only tracked attributes get changed.
+
+```

data/Rakefile

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

data/lib/generators/track_it/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Generates tracked attributes for Model and attributes attr_a attr_b
+
+Example:
+    rails generate track_it Model attr_a attr_b
+
+    This will create:
+       /db/migrate/add_tracked_attributes_to_models.rb
+    And Inject:
+       track_attributes :attr_a, :attr_b into /app/models/model.rb

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

@@ -0,0 +1,10 @@
+class AddTrackedAttributesTo<%= name.camelize.pluralize %> < ActiveRecord::Migration
+  def up
+    add_column :<%= table_name %>, :tracked_attributes, :integer, :default => 0, :null => false
+  end
+
+  def down
+    remove_column :<%= table_name %>, :tracked_attributes
+  end
+  
+end

data/lib/generators/track_it/track_it_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators/active_record'
+require 'rails/generators/migration'
+
+module TrackIt
+  module Generators
+    class TrackItGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attrs, :type => :array, :default => []
+
+      def generate_track_attributes_call_on_model_file
+        inject_into_class model_file_path,  model_class, model_content
+      end
+
+      def create_attributes_tracker_migration
+        migration_template "migration.rb", "db/migrate/add_tracked_attributes_to_#{table_name}"
+      end
+
+      protected
+
+      def model_file_path
+        File.join("app", "models", "#{name.underscore}.rb")
+      end
+
+      def model_class
+        name.camelize.constantize
+      end
+
+      def model_content
+        "  track_attributes #{attrs.map {|a| ":#{a}"}.join(", ")}\n"
+      end
+    end
+  end
+end

data/lib/trackit/track_attributes.rb

@@ -0,0 +1,36 @@
+module TrackIt
+  module TrackAttributes
+    extend ActiveSupport::Concern
+ 
+    included do
+    end
+ 
+    module ClassMethods
+      def track_attributes(*attrs)
+        self.class_eval do
+          before_save :update_tracked_attributes
+          @tracked_attributes = attrs.flatten
+        end
+      end
+
+      def tracked_attributes
+        @tracked_attributes ||= []
+      end
+    end
+
+    def update_tracked_attributes
+      changed_attrs = self.changes.keys.map(&:to_sym)
+      changed_tracked_attributes = self.class.tracked_attributes.select {|k| changed_attrs.include?(k)}
+      changed_tracked_attributes.each do |attr|
+        self.tracked.set_changed(attr)
+      end
+    end
+
+    def tracked
+      @tracked ||= TrackIt::Wrapper.new(self)
+    end
+
+  end
+
+end
+ActiveRecord::Base.send :include, TrackIt::TrackAttributes

data/lib/trackit/version.rb

@@ -0,0 +1,3 @@
+module TrackIt
+  VERSION = "0.1"
+end

data/lib/trackit/wrapper.rb

@@ -0,0 +1,62 @@
+module TrackIt
+
+  class Wrapper
+    include ActiveModel::AttributeMethods
+    attribute_method_suffix '_changed?'
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+    def changed?
+      model.tracked_attributes != 0
+    end
+    
+    def changed
+      changed = []
+      bits_num = tracked_attributes.size
+      (bits_num-1).downto(0) do |i|
+        changed << tracked_attributes[i] if model.tracked_attributes[i] == 1
+      end
+      changed
+    end
+
+    def set_changed(attr)
+      @model.tracked_attributes |= 2 ** tracked_attributes.index(attr)
+    end
+
+    def set_unchanged(attr)
+      @model.tracked_attributes &= ~(2 ** tracked_attributes.index(attr))
+    end
+
+    def set_all_unchanged
+      @model.tracked_attributes = 0
+    end
+
+    def set_all_changed
+      @model.tracked_attributes |= (~0)
+    end
+
+
+    protected
+
+    def attributes
+      model.attributes.slice(*tracked_attributes.map(&:to_s))
+    end
+
+    def model_class
+      model.class
+    end
+
+    def tracked_attributes
+      @tracked_attributes ||= model.class.tracked_attributes
+    end
+    
+    def attribute_changed?(attr)
+      model.tracked_attributes[tracked_attributes.index(attr.to_sym)] == 1
+    end
+  end
+
+  
+end

data/lib/trackit.rb

@@ -0,0 +1,5 @@
+require 'trackit/wrapper'
+require 'trackit/track_attributes'
+
+module TrackIt
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: trackit
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Erez Rabih
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2169451920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169451920
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2169451500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169451500
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &2169451040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169451040
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2169450620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169450620
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: &2169450200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169450200
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &2169449780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169449780
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: &2169449360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169449360
+description: TrackIt allows you to track attributes changes in your ActiveRecord models
+email:
+- erez.rabih@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/track_it/templates/migration.rb
+- lib/generators/track_it/track_it_generator.rb
+- lib/generators/track_it/USAGE
+- lib/trackit/track_attributes.rb
+- lib/trackit/version.rb
+- lib/trackit/wrapper.rb
+- lib/trackit.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/erez-rabih/tracker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: TrackIt allows you to track attributes changes in your ActiveRecord models
+test_files: []