blamer 3.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTU4ZTNkZGIwZmZkZGNjMzRmNmNjMzUyNTliMDk5YjI2NjI2YTc2ZA==
+  data.tar.gz: !binary |-
+    NDM3MDg3MmFhYzRmOTAzYTAxZGNiZWViNTFkNjlmMjMzOTBmMmJkYw==
+SHA512:
+  metadata.gz: !binary |-
+    OTQxZGQ1YjM2ZGM3YTM3YzA0YTRmZWRmMmEwMWFjNWEyOWY5MTY0YmEyNWRi
+    MTNiZDEyM2Q3ZWRjNmMxNDdlMjc1OWZmNzY4M2IzN2ZiZWZiZWRhNjc0ZDVl
+    N2Q0ZjNkNDY4MWJiN2VhOGJlODFhM2RhZWRkMGNjZDRjMGM4N2Q=
+  data.tar.gz: !binary |-
+    ZjEyMDA3NTJhZDNiZjE2MGZjMzI0OGNlMjI0Yzc5YzQ2NjAxNTE3YjZlNDg0
+    ZTFlZWE0ZDIyZTY5NDllMTdiMjkyOGE0MWNkNDczMzg4Njg1YmIzZmZkMDY3
+    YWI0MmExMjNhMTU0MzY3MzFjMzgzZGJhNjMzYWYwYTFkN2RiM2M=

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.1.1, released 2009-01-04
+  - Migration helper now support custom column names
+
+## 1.1.0, released 2008-12-17
+  - Make userstamp columns configurable
+
+## 1.0.0, released 2008-10-28
+  - Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+gemspec
+
+group :test do
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    blamer (2.0.0)
+      activerecord (> 2.3.0, < 3.2.0)
+
+GEM
+  specs:
+    activemodel (3.0.8)
+      activesupport (= 3.0.8)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.8)
+    arel (2.0.10)
+    builder (2.1.2)
+    i18n (0.5.4)
+    sqlite3 (1.3.10)
+    tzinfo (0.3.43)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  blamer!
+  sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2014 Keith Morrison <keithm@infused.org>
+
+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,83 @@
+# Blamer
+
+Automatically userstamps create and update operations if the table has columns named *created_by* and/or *updated_by*.
+The Blamer plugin attempts to mirror the simplicity of ActiveRecord's timestamp module.
+
+Blamer assumes that you are using restful-authentication and expects User.current_user to return the current user. You
+can override this behavior by writing your own *userstamp_object* method in ActiveRecord::Base or any of your models. For example:
+
+    def userstamp_object
+      User.find(session[:user_id])
+    end
+
+If you don't like created_by/updated_by you can customize the column names:
+
+    # Globally in environment.rb
+    ActiveRecord::Base.created_userstamp_column = :creator_id
+
+    # In a model definition
+    class Subscription
+      self.created_userstamp_column = :creator_id
+      self.updated_userstamp_column = :updater_id
+    end
+
+Automatic userstamping can be turned off globally by setting:
+
+    ActiveRecord::Base.record_userstamps = false
+
+Blamer adds a *userstamps* migration helper which will add the created_by and updated_by columns (or your custom column names) to your table:
+
+    create_table :widgets do |t|
+      t.string :name
+      t.timestamps
+      t.userstamps
+    end
+
+
+## Installation
+
+
+### Rails 2.x
+
+Add a line to your environment.rb
+
+    config.gem 'blame'
+
+
+### Rails 3.x +
+
+Add to your Gemfile
+
+    gem 'blame'
+
+
+## Credit
+
+Thanks to DeLynn Berry <delynn@gmail.com> for writing the original Userstamp plugin
+(http://github.com/delynn/userstamp/tree/master), which was the inspiration for this plugin.
+
+
+## License
+
+Copyright (c) 2008-2014 Keith Morrison <<keithm@infused.org>>
+
+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,12 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the blame plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/lib/blamer.rb

@@ -0,0 +1,52 @@
+require 'active_record'
+
+module Blamer
+  module Userstamp
+    def self.included(base)
+      base.alias_method_chain :create, :userstamps
+      base.alias_method_chain :update, :userstamps
+
+      base.class_inheritable_accessor :record_userstamps, :instance_writer => false
+      base.record_userstamps = true
+
+      base.class_inheritable_accessor :created_userstamp_column, :instance_writer => false
+      base.created_userstamp_column = :created_by
+
+      base.class_inheritable_accessor :updated_userstamp_column, :instance_writer => false
+      base.updated_userstamp_column = :updated_by
+    end
+
+    private
+
+    def userstamp_object
+      User.current_user
+    end
+
+    def create_with_userstamps
+      if record_userstamps && userstamp_object
+        write_attribute(created_userstamp_column, userstamp_object.id) if respond_to?(created_userstamp_column)
+        write_attribute(updated_userstamp_column, userstamp_object.id) if respond_to?(updated_userstamp_column)
+      end
+      create_without_userstamps
+    end
+
+    def update_with_userstamps(*args)
+      if record_userstamps && userstamp_object && (!partial_updates? || changed?)
+        write_attribute(updated_userstamp_column, userstamp_object.id) if respond_to?(updated_userstamp_column)
+      end
+      update_without_userstamps
+    end
+
+  end
+
+  module UserstampMigrationHelper
+    def userstamps
+      column ActiveRecord::Base.created_userstamp_column, :integer
+      column ActiveRecord::Base.updated_userstamp_column, :integer
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, Blamer::Userstamp
+ActiveRecord::ConnectionAdapters::TableDefinition.send :include, Blamer::UserstampMigrationHelper

data/test/blame_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class BlamerTest < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Base.partial_updates = false
+    @user1 = User.create
+    @user2 = User.create
+    User.current_user = @user1
+    @widget = Widget.create :name => 'One'
+  end
+  
+  def test_partial_updates_disabled
+    assert !ActiveRecord::Base.partial_updates
+  end
+  
+  def test_create
+    assert_equal @user1.id, @widget.created_by
+    assert_equal @user1.id, @widget.updated_by
+  end
+  
+  def test_update
+    User.current_user = @user2
+    @widget.update_attribute(:name, 'Two')
+    assert_equal @user1.id, @widget.created_by
+    assert_equal @user2.id, @widget.updated_by
+  end
+  
+end

data/test/models/monkey.rb

@@ -0,0 +1,3 @@
+class Monkey < ActiveRecord::Base
+  cattr_accessor :banana
+end

data/test/models/sprocket.rb

@@ -0,0 +1,2 @@
+class Sprocket < ActiveRecord::Base
+end

data/test/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  cattr_accessor :current_user
+end

data/test/models/widget.rb

@@ -0,0 +1,2 @@
+class Widget < ActiveRecord::Base
+end

data/test/override_userstamp_object_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class OverrideBlamerTest < Test::Unit::TestCase
+  
+  # Override the default userstamp_object method
+  class Sprocket < ActiveRecord::Base
+    def userstamp_object
+      Monkey.banana
+    end
+  end
+  
+  def setup
+    @monkey1 = Monkey.create
+    @monkey2 = Monkey.create
+    Monkey.banana = @monkey1
+    @sprocket = Sprocket.create :name => 'One'
+  end
+  
+  def test_create
+    assert_equal @monkey1.id, @sprocket.created_by
+    assert_equal @monkey1.id, @sprocket.updated_by
+  end
+  
+  def test_update
+    Monkey.banana = @monkey2
+    @sprocket.update_attribute(:name, 'Two')
+    assert_equal @monkey1.id, @sprocket.created_by
+    assert_equal @monkey2.id, @sprocket.updated_by
+  end
+  
+end

data/test/partial_blame_test.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class PartialBlamerTest < Test::Unit::TestCase
+  def setup
+    ActiveRecord::Base.partial_updates = true
+    @user1 = User.create
+    @user2 = User.create
+    User.current_user = @user1
+    @widget = Widget.create :name => 'One'
+  end
+  
+  def test_partial_updates_enabled
+    assert ActiveRecord::Base.partial_updates
+  end
+  
+  def test_create
+    assert_equal @user1.id, @widget.created_by
+    assert_equal @user1.id, @widget.updated_by
+  end
+  
+  def test_update
+    User.current_user = @user2
+    @widget.update_attribute(:name, 'Two')
+    assert_equal @user1.id, @widget.created_by
+    assert_equal @user2.id, @widget.updated_by
+  end
+  
+end

data/test/schema.rb

@@ -0,0 +1,22 @@
+# Stop ActiveRecord from printing schema statements to the console
+$stdout = StringIO.new
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :name
+  end
+  
+  create_table :monkeys do |t|
+    t.string :name
+  end
+  
+  create_table :widgets do |t|
+    t.string :name
+    t.userstamps
+  end
+  
+  create_table :sprockets do |t|
+    t.string :name
+    t.userstamps
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+Bundler.setup(:default, :test)
+
+require 'test/unit'
+
+# Initialize the plugin
+require File.dirname(__FILE__) + '/../lib/blamer'
+
+# Use in-memory sqlite3
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+# Create test tables
+require File.dirname(__FILE__) + '/schema'
+
+# Load test models
+require File.dirname(__FILE__) + '/models/user'
+require File.dirname(__FILE__) + '/models/monkey'
+require File.dirname(__FILE__) + '/models/widget'
+require File.dirname(__FILE__) + '/models/sprocket'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: blamer
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Keith Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Automatically userstamps create and update operations if the table has
+  created_by and/or updated_by columns
+email: keithm@infused.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/blamer.rb
+- test/blame_test.rb
+- test/models/monkey.rb
+- test/models/sprocket.rb
+- test/models/user.rb
+- test/models/widget.rb
+- test/override_userstamp_object_test.rb
+- test/partial_blame_test.rb
+- test/schema.rb
+- test/test_helper.rb
+homepage: http://github.com/infused/blame
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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: 1.3.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Userstamps for ActiveRecord
+test_files:
+- test/blame_test.rb
+- test/override_userstamp_object_test.rb
+- test/partial_blame_test.rb