magic_userstamp 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,5 +1,11 @@
 = MagicUserstamp
 
+== About MagicUserstamp
+This plugin is a fork of delynn/userstamp ( http://github.com/delynn/userstamp )
+
+But almost of classes have been changed. And you can use creator_id, updater_id or deleter_id (with acts_as_paranod)
+without definition in each model. Instead of them, you can write just config/initializers/magic_userstamp.rb .
+
 == Install
 
 === as a plugin
@@ -17,19 +23,58 @@ Or install gem manually
  $ sudo gem tumble
  $ sudo gem install magic_userstamp
 
-== Setting
+== Simple Configuration
 make config/initializers/magic_userstamp.rb
 
 The most simple setting
- Userstamp::Config.setup.defaults
+ require 'magic_userstamp'
+ # Comment out if you don't use t.userstamp at all in migrations
+ ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, MagicUserstamp::MigrationHelper)
+ ActiveRecord::Base.module_eval do
+   include MagicUserstamp
+ end
+
+ MagicUserstamp::Config.setup.defaults
+
+ # If you have some classes which has loaded before Userstamp is loaded,
+ # set record_userstamp true
+ # Example: vestal_versions gem
+ # Version.record_userstamp = true if defined?(Version)
+
+
+== Controller setting
+
+add followings to ApplicationController or some controller
+
+  before_filter :set_user
+  after_filter :reset_user
+
+ def set_user
+   user_id = session[:user] # ここではIDが帰ってくるはず。
+   User.model_stamper       # UserがIDを覚えられるようにする。
+   User.stamper = user_id   # IDを覚えておく。stamper=にはオブジェクトを渡してもOK。
+ end
+
+ def reset_user
+   User.model_stamper  # Userが覚えているIDを忘れることができるようにする。
+   User.reset_stamper  # Userが覚えているIDを実際に忘れる。
+ end
+
+
+
+== Various Configuration
+If you want to customize setting, chage config/initializers/magic_userstamp.rb
+
+The most simple setting
+ MagicUserstamp::Config.setup.defaults
 
 Specify User class name
- Userstamp::Config.setup.defaults(:stamper_class_name => 'AdminUser')
+ MagicUserstamp::Config.setup.defaults(:stamper_class_name => 'AdminUser')
 
 Actually
- Userstamp::Config.setup.defaults
+ MagicUserstamp::Config.setup.defaults
 means
- Userstamp.config.setup do |config|
+ MagicUserstamp.config.setup do |config|
    config.with_options(:stamper_class_name => 'User') do |c|
      c.on(:create , :creator_id)
      c.on(:update , :updater_id)
@@ -39,7 +84,7 @@ means
 
 
 Specify User class name and creator/updater columns
- Userstamp.config.setup do |config|
+ MagicUserstamp.config.setup do |config|
    config.with_options(:stamper_class_name => 'Person') do |c|
      c.on(:create , :creator_person_id)
      c.on(:update , :updater_person_id)
@@ -48,17 +93,42 @@ Specify User class name and creator/updater columns
  end
 
 Specify target stampable class names
- Userstamp.config.setup do |config|
+ MagicUserstamp.config.setup do |config|
    config.defaults(:stampable_class_names => %w(Book Schedule))
 
 Specify target stampable class names and columns
- Userstamp.config.setup do |config|
+ MagicUserstamp.config.setup do |config|
+   config.with_options(:stampable_class_names => %w(Book Schedule)) do |c|
+     c.on(:create , :creator_user_id)
+     c.on(:update , :updater_user_id)
+     c.on(:destroy, :deleter_user_id)
+   end
+ end
+
+
+Use in compatibility mode
+ MagicUserstamp.config.compatibles
+
+Same as
+ MagicUserstamp.config.setup do |c|
+   c.on(:create , :created_by)
+   c.on(:update , :updated_by)
+   c.on(:destroy, :deleted_by)
+ end
+
+
+
+Complex pattern
+ MagicUserstamp.config.setup do |config|
    config.with_options(:stampable_class_names => %w(Book Schedule)) do |c|
      c.on(:create , :creator_user_id)
      c.on(:update , :updater_user_id)
      c.on(:destroy, :deleter_user_id)
    end
+   config.compatibles(:stamper_class_name => 'Person', :stampable_class_names => %w(Person Email))
+   config.defaults
  end
 
+
 -----
 Copyright (c) 2009 'Takeshi AKIMA, released under the MIT license

data/Rakefile

@@ -40,6 +40,7 @@ Rake::RDocTask.new do |rdoc|
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "magic_userstamp #{version}"
-  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options = ["--charset", "utf-8", "--line-numbers"]
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/init.rb

@@ -1,12 +1,10 @@
 # -*- coding: utf-8 -*-
-require 'userstamp'
+require 'magic_userstamp'
 # コントローラへは自身でincludeしてください。
-# ActionController::Base.send(:include, Userstamp::Controller) if defined?(ActionController)
-ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, Userstamp::MigrationHelper)
+# ActionController::Base.send(:include, MagicUserstamp::Controller) if defined?(ActionController)
+ActiveRecord::ConnectionAdapters::TableDefinition.send(:include, MagicUserstamp::MigrationHelper)
 if defined?(ActiveRecord)
-  ActiveRecord::Base.module_eval do 
-    include Userstamp::Stampable
-    include Userstamp::Stamper
-    include Userstamp::MagicColumns # mest be included after Userstamp::Stampable
+  ActiveRecord::Base.module_eval do
+    include MagicUserstamp
   end
 end

data/lib/magic_userstamp.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+module MagicUserstamp
+  def self.included(mod)
+    if mod <= ::ActiveRecord::Base
+      mod.module_eval do
+        include MagicUserstamp::Stampable
+        include MagicUserstamp::Stamper
+        include MagicUserstamp::MagicColumns # mest be included after Userstamp::Stampable
+      end
+    end
+  end
+
+  autoload :Config, 'magic_userstamp/config'
+  autoload :Controller, 'magic_userstamp/controller'
+  autoload :Event, 'magic_userstamp/event'
+  autoload :MagicColumns, 'magic_userstamp/magic_columns'
+  autoload :MigrationHelper, 'magic_userstamp/migration_helper'
+  autoload :Stampable, 'magic_userstamp/stampable'
+  autoload :Stamper, 'magic_userstamp/stamper'
+
+  class MagicUserstampError < StandardError
+  end
+
+  def self.config
+    Config.instance
+  end
+end

data/lib/{userstamp → magic_userstamp}/config.rb

@@ -1,23 +1,17 @@
 # -*- coding: utf-8 -*-
-require 'userstamp'
+require 'magic_userstamp'
 
-module Userstamp
+module MagicUserstamp
 
-  def self.config
-    Config.instance
-  end
-  
   class Config
 
     class << self
       def instance
-        @instance || setup
+        @instance ||= Config.new
       end
       
-      def setup
-        @instance = Config.new
-        yield(@instance) if block_given?
-        @instance
+      def setup(&block)
+        instance.setup(&block)
       end
 
       def clear
@@ -34,6 +28,11 @@ module Userstamp
       @with_destroy = defined?(Caboose::Acts::Paranoid)
     end
     
+    def setup
+      yield(self) if block_given?
+      self
+    end
+
     def pattern_for(klass, column_name)
       patterns.detect{|pattern| pattern.stampable?(klass, column_name)}
     end
@@ -98,7 +97,7 @@ module Userstamp
           :stamper_attr_name => nil # sholuld not be only 'id' but PK column name
         }.update(options || {})
         @stampable_class_names = options.delete(:stampable_class_names)
-        Userstamp.raise_unless_valid_options_for_stampable_on(options)
+        MagicUserstamp::Stampable.raise_unless_valid_options_for_stampable_on(options)
         @options_for_stampable_on = options
         @stamper_class_name = options[:stamper_class_name]
         @stamper_attr_name = options[:stamper_attr_name]

data/lib/{userstamp → magic_userstamp}/controller.rb

@@ -1,6 +1,6 @@
-require 'userstamp'
+require 'magic_userstamp'
 
-module Userstamp
+module MagicUserstamp
   module Controller
     # The Userstamp module, when included into a controller, adds a before filter
     # (named <tt>set_stamper</tt>) and an after filter (name <tt>reset_stamper</tt>).

data/lib/{userstamp → magic_userstamp}/event.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-require 'userstamp'
+require 'magic_userstamp'
 
-module Userstamp
+module MagicUserstamp
 
   class Event 
     attr_reader :name, :actor, :actual_hook, :after_callback
@@ -52,7 +52,7 @@ module Userstamp
 
       def raise_unless_valid_name(event_name)
         return if valid_name?(event_name)
-        raise UserstampError, "Invalid event name '#{event_name.inspect}'. Event name must be one of #{valid_names.inspect}"
+        raise MagicUserstampError, "Invalid event name '#{event_name.inspect}'. Event name must be one of #{valid_names.inspect}"
       end
     end
   end

data/lib/{userstamp → magic_userstamp}/magic_columns.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-require 'userstamp'
+require 'magic_userstamp'
 
-module Userstamp
+module MagicUserstamp
 
   module MagicColumns
     def self.included(mod)
@@ -35,7 +35,7 @@ module Userstamp
       end
 
       def setup_userstamp(columns)
-        config = Userstamp.config
+        config = MagicUserstamp.config
         columns.each do |column|
           next if column.primary
           if pattern = config.pattern_for(self, column.name)

data/lib/magic_userstamp/migration_helper.rb

@@ -0,0 +1,17 @@
+require 'magic_userstamp'
+
+module MagicUserstamp
+  module MigrationHelper
+    def self.included(base) # :nodoc:
+      base.send(:include, InstanceMethods)
+    end
+
+    module InstanceMethods
+      def userstamps(include_deleted_by = false)
+        column(MagicUserstamp.compatibility_mode ? :created_by : :creator_id, :integer)
+        column(MagicUserstamp.compatibility_mode ? :updated_by : :updater_id, :integer)
+        column(MagicUserstamp.compatibility_mode ? :deleted_by : :deleter_id, :integer) if include_deleted_by
+      end
+    end
+  end
+end

data/lib/{userstamp → magic_userstamp}/stampable.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
-require 'userstamp'
+require 'magic_userstamp'
 
-module Userstamp
+module MagicUserstamp
   # Determines what default columns to use for recording the current stamper.
   # By default this is set to false, so the plug-in will use columns named
   # <tt>creator_id</tt>, <tt>updater_id</tt>, and <tt>deleter_id</tt>.
@@ -9,7 +9,7 @@ module Userstamp
   # To turn compatibility mode on, place the following line in your environment.rb
   # file:
   #
-  #   Userstamp.compatibility_mode = true
+  #   MagicUserstamp.compatibility_mode = true
   #
   # This will cause the plug-in to use columns named <tt>created_by</tt>,
   # <tt>updated_by</tt>, and <tt>deleted_by</tt>.
@@ -25,12 +25,6 @@ module Userstamp
     :actual_hook
   ]
   
-  def self.raise_unless_valid_options_for_stampable_on(options)
-    return if options.nil?
-    invalid_keys = (options.keys - VALID_OPTIONS_KEYS_FOR_STAMPABLE_ON)
-    raise "Invalid options keys: #{invalid_keys.inspect}" unless invalid_keys.empty?
-  end
-
   # Extends the stamping functionality of ActiveRecord by automatically recording the model
   # responsible for creating, updating, and deleting the current object. See the Stamper
   # and Userstamp modules for further documentation on how the entire process works.
@@ -44,6 +38,12 @@ module Userstamp
       end
     end
 
+    def self.raise_unless_valid_options_for_stampable_on(options)
+      return if options.nil?
+      invalid_keys = (options.keys - VALID_OPTIONS_KEYS_FOR_STAMPABLE_ON)
+      raise "Invalid options keys: #{invalid_keys.inspect}" unless invalid_keys.empty?
+    end
+
     module ClassMethods
       # This method is automatically called on for all classes that inherit from
       # ActiveRecord, but if you need to customize how the plug-in functions, this is the
@@ -59,7 +59,7 @@ module Userstamp
       # The method will automatically setup all the associations, and create <tt>before_save</tt>
       # and <tt>before_create</tt> filters for doing the stamping.
       def stampable(options = {})
-        reader_name = Userstamp.compatibility_mode ? :default_attribute_compatible : :default_attribute
+        reader_name = MagicUserstamp.compatibility_mode ? :default_attribute_compatible : :default_attribute
         options  = {
           :stamper_class_name => "User",
           :creator_attribute  => Event[:create ].send(reader_name),
@@ -78,9 +78,9 @@ module Userstamp
       end
 
       def stampable_on(event_name, options = {})
-        Userstamp.raise_unless_valid_options_for_stampable_on(options)
+        MagicUserstamp::Stampable.raise_unless_valid_options_for_stampable_on(options)
         event = Event[event_name]
-        reader_name = Userstamp.compatibility_mode ? :default_attribute_compatible : :default_attribute
+        reader_name = MagicUserstamp.compatibility_mode ? :default_attribute_compatible : :default_attribute
         options = {
           :stamper_name => event.actor,
           :stamper_class_name => "User",
@@ -102,8 +102,8 @@ module Userstamp
           #{options[:actual_hook] || event.actual_hook} :#{callback_method_name}
 
           def #{callback_method_name}
-            if Userstamp.config.verbose?(self.class, "#{options[:attribute]}") && !self.record_userstamp
-              logger.debug("aborting #{self.name}.#{callback_method_name} cause of record_userstamp is nil/false")
+            if MagicUserstamp.config.verbose?(self.class, "#{options[:attribute]}") && !self.record_userstamp
+              logger.debug("aborting #{self.name}.#{callback_method_name} cause of record_userstamp is #{self.record_userstamp.inspect}")
             end
             return unless self.record_userstamp
             if RAILS_ENV == 'development'
@@ -118,7 +118,7 @@ module Userstamp
             #{event.after_callback}
           end
         EOS
-        if Userstamp.config.verbose?(self, options[:attribute])
+        if MagicUserstamp.config.verbose?(self, options[:attribute])
           ActiveRecord::Base.logger.debug "=" * 100
           ActiveRecord::Base.logger.debug self.name
           ActiveRecord::Base.logger.debug method_definitions

data/lib/{userstamp → magic_userstamp}/stamper.rb

@@ -1,6 +1,6 @@
-require 'userstamp'
+require 'magic_userstamp'
 
-module Userstamp
+module MagicUserstamp
   module Stamper
     def self.included(base) # :nodoc:
       base.extend(ClassMethods)
@@ -9,13 +9,13 @@ module Userstamp
     module ClassMethods
       def model_stamper
         # don't allow multiple calls
-        return if self.is_a?(Userstamp::Stamper::InstanceMethods)
-        self.extend(Userstamp::Stamper::InstanceMethods)
+        return if self.is_a?(MagicUserstamp::Stamper::InstanceMethods)
+        self.extend(MagicUserstamp::Stamper::InstanceMethods)
       end
     end
 
     module InstanceMethods
-      # Used to set the stamper for a particular request. See the Userstamp module for more
+      # Used to set the stamper for a particular request. See the MagicUserstamp module for more
       # details on how to use this method.
       def stamper=(object)
         object_stamper = if object.is_a?(ActiveRecord::Base)

data/magic_userstamp.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{magic_userstamp}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["akimatter"]
@@ -26,34 +26,41 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "init.rb",
-     "lib/userstamp.rb",
-     "lib/userstamp/config.rb",
-     "lib/userstamp/controller.rb",
-     "lib/userstamp/event.rb",
-     "lib/userstamp/magic_columns.rb",
-     "lib/userstamp/migration_helper.rb",
-     "lib/userstamp/stampable.rb",
-     "lib/userstamp/stamper.rb",
+     "lib/magic_userstamp.rb",
+     "lib/magic_userstamp/config.rb",
+     "lib/magic_userstamp/controller.rb",
+     "lib/magic_userstamp/event.rb",
+     "lib/magic_userstamp/magic_columns.rb",
+     "lib/magic_userstamp/migration_helper.rb",
+     "lib/magic_userstamp/stampable.rb",
+     "lib/magic_userstamp/stamper.rb",
      "magic_userstamp.gemspec",
-     "rdoc/classes/Ddb/Controller.html",
-     "rdoc/classes/Ddb/Controller/Userstamp.html",
-     "rdoc/classes/Ddb/Controller/Userstamp/InstanceMethods.html",
-     "rdoc/classes/Ddb/Userstamp.html",
-     "rdoc/classes/Ddb/Userstamp/MigrationHelper.html",
-     "rdoc/classes/Ddb/Userstamp/MigrationHelper/InstanceMethods.html",
-     "rdoc/classes/Ddb/Userstamp/Stampable.html",
-     "rdoc/classes/Ddb/Userstamp/Stampable/ClassMethods.html",
-     "rdoc/classes/Ddb/Userstamp/Stamper.html",
-     "rdoc/classes/Ddb/Userstamp/Stamper/ClassMethods.html",
-     "rdoc/classes/Ddb/Userstamp/Stamper/InstanceMethods.html",
+     "rdoc/classes/MagicUserstamp.html",
+     "rdoc/classes/MagicUserstamp/Config.html",
+     "rdoc/classes/MagicUserstamp/Config/Pattern.html",
+     "rdoc/classes/MagicUserstamp/Controller.html",
+     "rdoc/classes/MagicUserstamp/Controller/InstanceMethods.html",
+     "rdoc/classes/MagicUserstamp/Event.html",
+     "rdoc/classes/MagicUserstamp/MagicColumns.html",
+     "rdoc/classes/MagicUserstamp/MagicColumns/ClassMethods.html",
+     "rdoc/classes/MagicUserstamp/MagicUserstampError.html",
+     "rdoc/classes/MagicUserstamp/MigrationHelper.html",
+     "rdoc/classes/MagicUserstamp/MigrationHelper/InstanceMethods.html",
+     "rdoc/classes/MagicUserstamp/Stampable.html",
+     "rdoc/classes/MagicUserstamp/Stampable/ClassMethods.html",
+     "rdoc/classes/MagicUserstamp/Stamper.html",
+     "rdoc/classes/MagicUserstamp/Stamper/ClassMethods.html",
+     "rdoc/classes/MagicUserstamp/Stamper/InstanceMethods.html",
      "rdoc/created.rid",
-     "rdoc/files/CHANGELOG.html",
-     "rdoc/files/LICENSE.html",
-     "rdoc/files/README.html",
-     "rdoc/files/lib/migration_helper_rb.html",
-     "rdoc/files/lib/stampable_rb.html",
-     "rdoc/files/lib/stamper_rb.html",
-     "rdoc/files/lib/userstamp_rb.html",
+     "rdoc/files/README_rdoc.html",
+     "rdoc/files/lib/magic_userstamp/config_rb.html",
+     "rdoc/files/lib/magic_userstamp/controller_rb.html",
+     "rdoc/files/lib/magic_userstamp/event_rb.html",
+     "rdoc/files/lib/magic_userstamp/magic_columns_rb.html",
+     "rdoc/files/lib/magic_userstamp/migration_helper_rb.html",
+     "rdoc/files/lib/magic_userstamp/stampable_rb.html",
+     "rdoc/files/lib/magic_userstamp/stamper_rb.html",
+     "rdoc/files/lib/magic_userstamp_rb.html",
      "rdoc/fr_class_index.html",
      "rdoc/fr_file_index.html",
      "rdoc/fr_method_index.html",
@@ -69,9 +76,9 @@ Gem::Specification.new do |s|
      "spec/magic_column_spec.rb",
      "spec/posts_controller_spec.rb",
      "spec/resources/controllers/application_controller.rb",
+     "spec/resources/controllers/magic_userstamp_controller.rb",
      "spec/resources/controllers/posts_controller.rb",
      "spec/resources/controllers/users_controller.rb",
-     "spec/resources/controllers/userstamp_controller.rb",
      "spec/resources/models/comment.rb",
      "spec/resources/models/person.rb",
      "spec/resources/models/ping.rb",
@@ -94,9 +101,9 @@ Gem::Specification.new do |s|
      "spec/magic_column_spec.rb",
      "spec/posts_controller_spec.rb",
      "spec/resources/controllers/application_controller.rb",
+     "spec/resources/controllers/magic_userstamp_controller.rb",
      "spec/resources/controllers/posts_controller.rb",
      "spec/resources/controllers/users_controller.rb",
-     "spec/resources/controllers/userstamp_controller.rb",
      "spec/resources/models/comment.rb",
      "spec/resources/models/person.rb",
      "spec/resources/models/ping.rb",