userstamper 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 573cc10f10027aeabf2f04892ea63c517fed448bdea2f909c4f307d9123d1944
+  data.tar.gz: 62283d938f34afaedcc402efa5fdf2be2446c253fa55773094bf760fee4ea6c2
+SHA512:
+  metadata.gz: c3c6dbfa08158b688a48d54f01c39c59e3fd487e83b393407d48990cc369fe2683fb18e2ecf08302487574d31944815cc33c8aa25042308b9b26adc4ac4816cf
+  data.tar.gz: d732dc019eb418216f9c0e0bfdfeb9c85b57103a8d3d3c878e24bd45b1dd3fe9ba756d86b3ca56a2ba76ca8bda1c4910226c3e37625578999e6258f83cdd61fc

data/.gitignore

@@ -0,0 +1,4 @@
+*.log
+*.sqlite3
+/.rdoc
+/spec/examples.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,35 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - ruby-head
+env:
+  - "RAILS_VERSION=4.1.0"
+  - "RAILS_VERSION=4.2.0"
+  - "RAILS_VERSION=5.0.0"
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  exclude:
+    - rvm: 2.1.10
+      env: "RAILS_VERSION=5.0.0"
+    - rvm: 2.4.0
+      env: "RAILS_VERSION=4.1.0"
+    - rvm: 2.4.0
+      env: "RAILS_VERSION=4.2.0"
+    - rvm: ruby-head
+      env: "RAILS_VERSION=4.1.0"
+    - rvm: ruby-head
+      env: "RAILS_VERSION=4.2.0"
+
+bundler_args: "--jobs=3 --retry=3"
+cache: bundler
+
+before_install:
+  - gem update bundler
+
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -0,0 +1,116 @@
+ # Changelog
+ ## 4.0.0 (09-04-2021)
+  * Priit Tark        - Rails 6.1 support and renamed gem to userstamper
+
+ ## 3.0.5 (22-8-2017)
+  * Jonathan Putney   - Support Rails 5.0.
+  * Joel Low          - Add additional combinations to Travis build matrix.
+  * Joel Low          - Defer association definitions until the schema is loaded.
+  * Joel Low          - Respect custom stamper definitions.
+
+ ## 3.0.4 (14-7-2015)
+  * Joel Low          - Allow using ActiveRecord-Userstamp with anonymous models (e.g. some 
+                        `has_and_belongs_to_many` join tables.)
+ 
+ ## 3.0.3 (14-7-2015)
+  * Joel Low          - Allow using ActiveRecord-Userstamp with generated tables (e.g. 
+                        `has_and_belongs_to_many` join tables.)
+
+ ## 3.0.2 (12-7-2015)
+  * Joel Low          - Depending on what was set to a stamper (ID or record object), the
+                        association ID or association setter is used to assign the
+                        creator/updater/deleter attributes. This only applies if the attributes
+                        end with `_id`; otherwise the attribute would be used verbatim (e.g. the
+                        compatibility mode `created_by`).
+  * Joel Low          - Provide a `with_stamper` method to specify the stamper for a given
+                        stamper class during the execution of the block.
+  * Joel Low          - Ensure that the `set_stamper` and `reset_stamper` calls from the
+                        controller are always paired so that the stamper state is always properly
+                        restored. `set_stamper` and `reset_stamper` is now deprecated and will be
+                        removed in ActiveRecord::Userstamp 3.1 and replaced with a single
+                        `with_stamper` `around_action` callback.
+
+ ## 3.0.1 (11-7-2015)
+  * Joel Low          - Only declare the creator/updater/deleter associations when the table has
+                        the attribute columns. If the columns cannot be determined (e.g. if the
+                        table has not been defined, such as during tests), then the model would
+                        need to explicitly call `stampable`.
+
+ ## 3.0.0 (10-7-2015)
+  * Joel Low          - Remove `compatibility_mode`. Use the `creator_attribute`,
+                        `updater_attribute`, and `deleter_attribute` configuration options instead.
+  * Joel Low          - The table definition migration helper should follow the gem configuration
+                        when generating column names.
+  * Joel Low          - When deciding whether to generate a `deleter_id` column, check the gem
+                        configuration for the `deleter_attribute` configuration option instead of
+                        relying on the user to specify in every migration.
+  * Joel Low          - Remove the `deleter` option from the `stampable` model declaration.
+  * Joel Low          - Remove the `creator_attribute`, `updater_attribute`, and `deleter_attribute`
+                        options from the `stampable` model declaration. All models will follow
+                        the gem configuration.
+  * Joel Low          - Added the `default_stamper` configuration option. The controller will
+                        automatically stamp using that model.
+  * Joel Low          - Additional attributes passed to `stampable` would be passed to the
+                        underlying `belongs_to` association.
+  * Joel Low          - Declare the creator/updater/deleter setter callbacks directly in
+                        `ActiveRecord::Base`. So now, all models will automatically be stamped
+                        when the creator/updater/deleter attributes are present. This mirrors
+                        `ActiveRecord::Timestamp` behaviour.
+  * Joel Low          - Automatically declare the creator/updater/deleter associations on every
+                        model. To add additional configuration options, simply call `stampable`.
+                        This can be called multiple times per model; the last call takes effect.
+  * Joel Low          - Remove support for `serialized_attributes`. It will be removed in Rails 5.
+
+ ## 2.1.1 (9-7-2015)
+
+  * Chris Hilton      - Only set updater attribute if the record has changed or contains a
+                        serialized attribute.
+  * Chris Hilton      - Support `:with_deleted` in the `stampable` declaration.
+  * Chris Hilton      - Only set the creator attribute if it is blank.
+  * Chris Branson     - Fix deprecation warning in `serialized_attributes`.
+  * Joel Low          - Trigger the updater/creator stamping before saving, so that the correct
+                        users are stamped even if validation was not run.
+  * Joel Low          - Allow extra parameters to be passed to the migration helpers.
+
+## 2.1.0 (28-3-2014)
+  * Thomas von Deyen  - Do not automatically make every class stampable.
+
+## 2.0.2 (11-8-2011)
+  * Chris Hilton      - Set the creator/updater attributes before validation, so that they can
+                        be checked as part of validations.
+  * Alex              - Specify that the stampable class is camelized from the given symbol,
+                        not just capitalized, to follow ActiveRecord convention.
+## 2.0.1 (8-10-2010)
+  * Michael Grosser   -  Make stampable define the deleter association and before filter whenever
+                         a :deleter_attribute has been passed in options, or :deleter => true is
+                         passed, or Caboose::Acts::Paranoid is defined. This makes :deleter
+                         functionality useable to people who aren't use acts_as_paranoid.
+  * Michael Grosser   -  do not leave record_userstamp turned on when an exception occurs inside
+                         the `without_stamps` block
+
+## 2.0 (2-17-2008)
+  * Ben Wyrosdick    - Added a migration helper that gives migration scripts a <tt>userstamps</tt>
+                       method.
+  * Marshall Roch    - Stamping can be temporarily turned off using the 'without_stamps' class
+                       method.
+    Example:
+      Post.without_stamps do
+        post = Post.find(params[:id])
+        post.update_attributes(params[:post])
+        post.save
+      end
+
+  * Models that should receive updates made by 'stampers' now use the acts_as_stampable class
+    method. This sets up the belongs_to relationships and also injects private methods for use by
+    the individual callback filter methods.
+
+  * Models that are responsible for updating now use the acts_as_stamper class method. This
+    injects the stamper= and stamper methods that are thread safe and should be updated per
+    request by a controller.
+
+  * The Userstamp module is now meant to be included with one of your project's controllers (the
+    Application Controller is recommended). It creates a before filter called 'set_stampers' that
+    is responsible for setting all the current Stampers.
+
+## 1.0 (01-18-2006)
+  * Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,222 @@
+PATH
+  remote: .
+  specs:
+    userstamp (4.0.0)
+      rails (>= 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    multi_json (1.15.0)
+    netrc (0.11.0)
+    nio4r (2.5.7)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    rdoc (6.3.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-instafail (1.0.0)
+      rspec
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.28.0)
+      sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter
+  coveralls
+  pry
+  rake
+  rdoc
+  rspec
+  rspec-instafail
+  rspec-rails (>= 3.3)
+  simplecov
+  sqlite3
+  userstamp!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2006-2008 DeLynn Berry
+Copyright (c) 2014-2015 Joel Low
+Copyright (c) 2021 Priit Tark
+
+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,142 @@
+# Userstamper
+
+## Overview
+
+Userstamp extends `ActiveRecord::Base` to add automatic updating of `creator` and `updater` attributes.
+
+Two class methods (`model_stamper` and `stampable`) are implemented in this gem. The `model_stamper`
+method is used in models that are responsible for creating or updating other objects.
+Typically this would be the `User` model of your application. The `stampable` method is used in 
+models that are subject to being created or updated by stampers.
+
+Gem is tested with Ruby 2.7.2 and Rails 6.1.3.1
+
+## Features
+to result in a `belongs_to` relation which looks like:
+
+```ruby
+  belongs_to :creator, class_name: '::User', foreign_key: :created_by
+```
+
+### Saving before validation
+This includes changes to perform model stamping before validation. This allows models to
+enforce the presence of stamp attributes:
+
+```ruby
+  validates :created_by, presence: true
+  validates :updated_by, presence: true
+```
+
+Furthermore, the `creator` attribute is set only if the value is blank allowing for a manual
+override.
+
+## Usage
+Assume that we are building a blog application, with User and Post objects. Add the following 
+to the application's Gemfile:
+
+```ruby
+  gem 'userstamper'
+```
+
+Define an initializer in your Rails application to configure the gem:
+config/initilialize/userstamper.rb:
+
+```ruby
+Userstamper.configure do |config|
+  # config.default_stamper = 'User'
+  # config.creator_attribute = :creator_id
+  # config.updater_attribute = :updater_id
+  config.deleter_attribute = nil
+end
+```
+
+Ensure that each model has a set of columns for creators and updaters.
+
+```ruby
+  class CreateUsers < ActiveRecord::Migration
+    def change
+      create_table :users do |t|
+        ...
+        t.userstamps
+      end
+    end
+  end
+
+  class CreatePosts < ActiveRecord::Migration
+    def change
+      create_table :posts do |t|
+        ...
+        t.userstamps
+      end
+    end
+  end
+```
+
+If you use `protect_from_forgery`, make sure the hooks are prepended:
+
+```ruby
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception, prepend: true # with: anything will do, note `prepend: true`!
+end
+```
+
+Declare the stamper on the User model:
+
+```ruby
+  class User < ActiveRecord::Base
+    model_stamper
+  end
+```
+
+If your stamper is called `User`, that's it; you're done.
+
+## Customisation
+The association which is created on each of the `creator_id` and `updater_id` can
+be customised. Also, the stamper used by each class can also be customised. For this purpose, the
+ `ActiveRecord::Base.stampable` method can be used:
+
+```ruby
+  class Post < ActiveRecord::Base
+    stampable
+  end
+```
+
+The `stampable` method allows you to customize the `creator` and `updater` associations.
+It also allows you to specify the name of the stamper for the class being declared. Any additional
+arguments are passed to the `belongs_to` declaration.
+
+## Upgrade
+When upgradeing from activerecord_userstamp gem, please remove deleted attributes. 
+Soft delete is not supported and not recommended. Soft delete is more pain in real life.
+
+## Tests
+Run
+
+    $ bundle exec rspec
+
+## Forkception
+
+This is a fork of:
+ - the [activerecord-userstamp](https://github.com/lowjoel/activerecord-userstamp) gem
+ - the [magiclabs-userstamp](https://github.com/magiclabs/userstamp) gem
+ - which is a fork of [Michael Grosser's](https://github.com/grosser)
+   [userstamp gem] (https://github.com/grosser/userstamp) 
+ - which is a fork of the original [userstamp plugin](https://github.com/delynn/userstamp) by
+   [delynn](https://github.com/delynn)
+
+In addition to these, some ideas are cherry picked from the following forks:
+
+ - [simplificator](https://github.com/simplificator/userstamp)
+ - [akm](https://github.com/akm/magic_userstamp)
+ - [konvenit](https://github.com/konvenit/userstamp)
+
+## Authors
+ - [DeLynn Berry](http://delynnberry.com/): The original idea for this plugin came from the Rails
+   Wiki article entitled
+   [Extending ActiveRecord](http://wiki.rubyonrails.com/rails/pages/ExtendingActiveRecordExample)
+ - [Michael Grosser](http://pragmatig.com)
+ - [John Dell](http://blog.spovich.com/)
+ - [Chris Hilton](https://github.com/chrismhilton)
+ - [Thomas von Deyen](https://github.com/tvdeyen)
+ - [Joel Low](http://joelsplace.sg)
+ - [Priit Tark](https://github.com/priit)