fingerprints 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rails', '> 3.2.0'
+  gem 'sqlite3'
+end
+
+# Specify your gem's dependencies in fingerprints.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Philip Hallstrom
+
+MIT License
+
+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,70 @@
+# Fingerprints
+
+[![Gem Version](https://badge.fury.io/rb/fingerprints.png)](http://badge.fury.io/rb/fingerprints)
+
+Make it easy to track who created/updated your models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fingerprints'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fingerprints
+
+## Usage
+
+
+Example
+=======
+
+    # Widget Schema...
+    create_table :widgets do |t|
+      t.string :name
+      t.fingerprints # creates integer fields for created_by and updated_by
+    end
+
+    # User model...
+    class User < ActiveRecord::Base
+      has_fingerprints
+    end
+
+    # Widget model...
+    class Widget < ActiveRecord::Base
+      leaves_fingerprints
+
+      # If your 'user' is really a Person you could do this:
+      #
+      # leaves_fingerprints :class_name => 'Person'
+    end
+
+Now, some how, some way you need to set User.fingerprint to either the User instance
+or User 'id' of the "currently logged in user".  One way to do this would be to put
+this in your controller assuming your controller has a `:current_user` method that will
+return the current user.
+
+    before_filter { |c| User.fingerprint = c.send(:current_user) }
+
+At this point if you create/update a Widget it will set the `created_by/updated_by` attributes
+automatically.  You can also do this:
+
+    @widget.creator => User instance...
+    @widget.updator => User instance...
+
+The default `:class_name` is 'User' and can be overridden like this:
+
+    ActiveRecord::HasFingerprints::OPTIONS.merge!(:class_name => 'Person')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' 
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/fingerprints.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fingerprints/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "fingerprints"
+  gem.version       = Fingerprints::VERSION
+  gem.authors       = ["Philip Hallstrom"]
+  gem.email         = ["philip@pjkh.com"]
+  gem.description   = %q{Make it easy to track who created/updated your models.}
+  gem.summary       = %q{Make it easy to track who created/updated your models.}
+  gem.homepage      = "https://github.com/phallstrom/fingerprints"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/fingerprints/active_record.rb

@@ -0,0 +1,49 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class TableDefinition
+      # Appends <tt>:integer</tt> columns <tt>:created_by</tt> and
+      # <tt>:updated_by</tt> to the table.
+      def fingerprints(*args)
+        options = args.extract_options!
+        column(:created_by, :integer, options)
+        column(:updated_by, :integer, options)
+      end
+    end
+
+    class Table
+      # Adds fingerprints (created_by and updated_by) columns to the table. See SchemaStatements#add_fingerprints
+      # ===== Example
+      #  t.fingerprints
+      def fingerprints
+        @base.add_fingerprints(@table_name)
+      end
+
+
+      # Removes the fingerprint columns (created_by and updated_by) from the table.
+      # ===== Example
+      #  t.remove_fingerprints
+      def remove_fingerprints
+        @base.remove_fingerprints(@table_name)
+      end
+    end
+  end
+
+  module SchemaStatements
+    # Adds fingerprints (created_by and updated_by) columns to the named table.
+    # ===== Examples
+    #  add_fingerprints(:suppliers)
+    def add_fingerprints(table_name)
+      add_column table_name, :created_by, :integer
+      add_column table_name, :updated_by, :integer
+    end
+
+    # Removes the fingerprint columns (created_by and updated_by) from the table definition.
+    # ===== Examples
+    #  remove_fingerprints(:suppliers)
+    def remove_fingerprints(table_name)
+      remove_column table_name, :updated_by
+      remove_column table_name, :created_by
+    end
+  end
+end
+

data/lib/fingerprints/version.rb

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

data/lib/fingerprints.rb

@@ -0,0 +1,61 @@
+require 'active_record'
+require 'fingerprints/active_record'
+require 'fingerprints/version'
+
+module Fingerprints
+  module Extensions
+
+    OPTIONS = {
+      :class_name => 'User'
+    }
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      def has_fingerprints(options = {})
+        options.reverse_merge!(OPTIONS)
+
+        class_eval <<-"EOV"
+          class << self
+            def fingerprint
+              Thread.current["fingerprint_for_#{self.class}"]
+            end
+            def fingerprint=(val)
+              Thread.current["fingerprint_for_#{self.class}"] = val
+            end
+          end
+        EOV
+      end
+
+      def leaves_fingerprints(options = {})
+        options.reverse_merge!(OPTIONS)
+
+        include Fingerprints::Extensions::InstanceMethods
+
+        belongs_to :creator, :class_name => options[:class_name], :foreign_key => 'created_by'
+        belongs_to :updater, :class_name => options[:class_name], :foreign_key => 'updated_by'
+        before_create :fingerprint_created_by
+        before_update :fingerprint_updated_by
+        define_method('fingerprint_created_by') {|*args| set_fingerprint_for(:created_by, options) }
+        define_method('fingerprint_updated_by') {|*args| set_fingerprint_for(:updated_by, options) }
+      end
+    end 
+
+    module InstanceMethods
+      def set_fingerprint_for(field, options = {})
+        klass = options[:class_name].constantize
+        raise(NoMethodError, "HasFingerprints for #{self.class} expected #{options[:class_name]} to respond to :fingerprint") unless klass.respond_to? :fingerprint
+        value = klass.fingerprint
+        value = value.id if value.is_a? klass
+        self.send("#{field}=", value)
+      end
+      protected :set_fingerprint_for
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Fingerprints::Extensions

data/test/test_fingerprints.rb

@@ -0,0 +1,92 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'fingerprints'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  silence_stream(STDOUT) do
+    ActiveRecord::Schema.define(:version => 1) do
+      create_table :widgets do |t|
+        t.column :name, :string
+        t.fingerprints
+      end
+      create_table :users do |t|
+        t.column :login, :string
+      end
+    end
+  end
+end
+
+def teardown_db
+  silence_stream(STDOUT) do
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_fingerprints
+  def self.table_name() "users" end
+end
+
+class InvalidUser < ActiveRecord::Base
+  def self.table_name() "users" end
+end
+
+class Widget < ActiveRecord::Base
+  leaves_fingerprints :class_name => 'User'
+  def self.table_name() "widgets" end
+end
+
+class InvalidWidget < ActiveRecord::Base
+  leaves_fingerprints :class_name => 'InvalidUser'
+  def self.table_name() "widgets" end
+end
+
+class HasFingerprintsTest < ActiveSupport::TestCase
+  def setup
+    setup_db
+    @widget = Widget.new(:name => 'Spring')
+    @invalid_widget = InvalidWidget.new(:name => 'Mobius Strip')
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_fingerprint_columns_exist
+    assert Widget.column_names.include? 'created_by'
+    assert Widget.column_names.include? 'updated_by'
+  end
+
+  def test_fingerprint_associations_exist
+    assert_equal :belongs_to, Widget.reflect_on_association(:creator).try(:macro)
+    assert_equal :belongs_to, Widget.reflect_on_association(:updater).try(:macro)
+  end
+
+  def test_fingerprints_set_on_create
+    User.fingerprint = 5
+    @widget.save!
+    assert_equal 5, @widget.created_by
+    assert_nil @widget.updated_by
+  end
+
+  def test_fingerprints_set_on_update
+    User.fingerprint = 5
+    @widget.save!
+    User.fingerprint = 6
+    @widget.save!
+    assert_equal 5, @widget.created_by
+    assert_equal 6, @widget.updated_by
+  end
+
+  def test_invalid_fingerprint_method_raises_error
+    assert_raise NoMethodError do
+      @invalid_widget.save
+    end
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: fingerprints
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Philip Hallstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-25 00:00:00.000000000 Z
+dependencies: []
+description: Make it easy to track who created/updated your models.
+email:
+- philip@pjkh.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fingerprints.gemspec
+- lib/fingerprints.rb
+- lib/fingerprints/active_record.rb
+- lib/fingerprints/version.rb
+- test/test_fingerprints.rb
+homepage: https://github.com/phallstrom/fingerprints
+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'
+      segments:
+      - 0
+      hash: -3235234909104547132
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3235234909104547132
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Make it easy to track who created/updated your models.
+test_files:
+- test/test_fingerprints.rb