activerecord-userstamp 2.1.1

data/spec/lib/migration_spec.rb

@@ -0,0 +1,26 @@
+require 'rails_helper'
+
+RSpec.describe 'Migration helpers', type: :model do
+  class self::Random < ActiveRecord::Base
+    stampable
+  end
+  subject { self.class::Random.new }
+
+  temporary_table(:randoms) do |t|
+    t.userstamps
+  end
+
+  with_temporary_table(:randoms) do
+    it 'has a creator_id association' do
+      expect(subject.has_attribute?(:creator_id)).to be true
+    end
+
+    it 'has an updater_id association' do
+      expect(subject.has_attribute?(:updater_id)).to be true
+    end
+
+    it 'has a deleter_id association' do
+      expect(subject.has_attribute?(:deleter_id)).to be false
+    end
+  end
+end

data/spec/lib/stamping_spec.rb

@@ -0,0 +1,170 @@
+require 'rails_helper'
+
+RSpec.describe 'Stamping', type: :model do
+  before(:each) do
+    reset_to_defaults
+    User.stamper = @zeus
+    Person.stamper = @delynn
+  end
+
+  context 'when creating a Person' do
+    context 'when the stamper is an object' do
+      it 'sets the correct creator and updater' do
+        expect(User.stamper).to eq(@zeus.id)
+
+        person = Person.create(:name => "David")
+        expect(person.creator_id).to eq(@zeus.id)
+        expect(person.updater_id).to eq(@zeus.id)
+        expect(person.creator).to eq(@zeus)
+        expect(person.updater).to eq(@zeus)
+      end
+    end
+
+    context 'when the stamper is an ID' do
+      it 'sets the correct creator and updater' do
+        User.stamper = @hera.id
+        expect(User.stamper).to eq(@hera.id)
+
+        person = Person.create(:name => "Daniel")
+        expect(person.creator_id).to eq(@hera.id)
+        expect(person.updater_id).to eq(@hera.id)
+        expect(person.creator).to eq(@hera)
+        expect(person.updater).to eq(@hera)
+      end
+    end
+  end
+
+  context 'when creating a Post' do
+    context 'when the stamper is an object' do
+      it 'sets the correct creator and updater' do
+        expect(Person.stamper).to eq(@delynn.id)
+
+        post = Post.create(:title => "Test Post - 1")
+        expect(post.creator_id).to eq(@delynn.id)
+        expect(post.updater_id).to eq(@delynn.id)
+        expect(post.creator).to eq(@delynn)
+        expect(post.updater).to eq(@delynn)
+      end
+    end
+
+    context 'when the stamper is an ID' do
+      it 'sets the correct creator and updater' do
+        Person.stamper = @nicole.id
+        expect(Person.stamper).to eq(@nicole.id)
+
+        post = Post.create(:title => "Test Post - 2")
+        expect(post.creator_id).to eq(@nicole.id)
+        expect(post.updater_id).to eq(@nicole.id)
+        expect(post.creator).to eq(@nicole)
+        expect(post.updater).to eq(@nicole)
+      end
+    end
+  end
+
+  context 'when updating a Person' do
+    context 'when the stamper is an object' do
+      it 'sets the correct updater' do
+        User.stamper = @hera
+        expect(User.stamper).to eq(@hera.id)
+
+        @delynn.name << " Berry"
+        @delynn.save
+        @delynn.reload
+        expect(@delynn.creator).to eq(@zeus)
+        expect(@delynn.updater).to eq(@hera)
+        expect(@delynn.creator_id).to eq(@zeus.id)
+        expect(@delynn.updater_id).to eq(@hera.id)
+      end
+    end
+  end
+
+  context 'when the stamper is an ID' do
+    it 'sets the correct updater' do
+      User.stamper = @hera.id
+      expect(User.stamper).to eq(@hera.id)
+
+      @delynn.name << " Berry"
+      @delynn.save
+      @delynn.reload
+      expect(@delynn.creator_id).to eq(@zeus.id)
+      expect(@delynn.updater_id).to eq(@hera.id)
+      expect(@delynn.creator).to eq(@zeus)
+      expect(@delynn.updater).to eq(@hera)
+    end
+  end
+
+  context 'when updating a Post' do
+    context 'when the stamper is an ID' do
+      it 'sets the correct updater' do
+        Person.stamper = @nicole.id
+        expect(Person.stamper).to eq(@nicole.id)
+
+        @first_post.title << " - Updated"
+        @first_post.save
+        @first_post.reload
+        expect(@first_post.creator_id).to eq(@delynn.id)
+        expect(@first_post.updater_id).to eq(@nicole.id)
+        expect(@first_post.creator).to eq(@delynn)
+        expect(@first_post.updater).to eq(@nicole)
+      end
+    end
+
+    context 'when the stamper is an object' do
+      it 'sets the correct updater' do
+        Person.stamper = @nicole
+        expect(Person.stamper).to eq(@nicole.id)
+
+        @first_post.title << " - Updated"
+        @first_post.save
+        @first_post.reload
+        expect(@first_post.creator_id).to eq(@delynn.id)
+        expect(@first_post.updater_id).to eq(@nicole.id)
+        expect(@first_post.creator).to eq(@delynn)
+        expect(@first_post.updater).to eq(@nicole)
+      end
+    end
+  end
+
+  context 'when destroying a Post' do
+    context 'when the stamper is an ID' do
+      it 'sets the deleter' do
+        expect(@first_post.deleted_at).to be_nil
+
+        Person.stamper = @nicole.id
+        expect(Person.stamper).to eq(@nicole.id)
+
+        @first_post.destroy
+        @first_post.save
+        @first_post.reload
+
+        expect(@first_post.deleted_at).to be_present
+        expect(@first_post.deleter_id).to eq(@nicole.id)
+      end
+    end
+  end
+
+  context 'when no deleter column is present' do
+    it 'does not create a deleter relation' do
+      expect(@delynn.respond_to?('creator')).to eq(true)
+      expect(@delynn.respond_to?('updater')).to eq(true)
+      expect(@delynn.respond_to?('deleter')).to eq(false)
+    end
+  end
+
+  context 'when a deleter column is present' do
+    it 'creates a deleter relation' do
+      expect(@first_post.respond_to?('creator')).to eq(true)
+      expect(@first_post.respond_to?('updater')).to eq(true)
+      expect(@first_post.respond_to?('deleter')).to eq(true)
+    end
+  end
+
+  context 'when the deleter attribute is explicitly set' do
+    it 'creates a deleter relation' do
+      @foo = Foo.create
+      expect(@foo.respond_to?('creator')).to eq(true)
+      expect(@foo.respond_to?('updater')).to eq(true)
+      expect(@foo.respond_to?('deleter')).to eq(true)
+    end
+  end
+end

data/spec/lib/userstamp_spec.rb

@@ -0,0 +1,7 @@
+require 'rails_helper'
+
+RSpec.describe ActiveRecord::Userstamp do
+  it 'has a VERSION' do
+    expect(ActiveRecord::Userstamp::VERSION).to match(/^\d+\.\d+\.\d+$/)
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,7 @@
+ENV['RAILS_ENV'] ||= 'test'
+require 'spec_helper'
+
+require File.expand_path('dummy/config/environment.rb', __dir__)
+require 'rspec/rails'
+
+Dir[__dir__ + '/support/**/*'].each { |f| require f if File.file?(f) }

data/spec/spec_helper.rb

@@ -0,0 +1,97 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'bundler/setup'
+Bundler.setup
+
+require 'coverage_helper'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/database_helpers.rb

@@ -0,0 +1,22 @@
+def reset_to_defaults
+  ActiveRecord::Userstamp.compatibility_mode = false
+  create_test_models
+end
+
+def create_test_models
+  User.delete_all
+  Person.delete_all
+  Post.delete_all
+  Comment.delete_all
+  Foo.delete_all
+
+  @zeus = User.create!(:name => 'Zeus')
+  @hera = User.create!(:name => 'Hera')
+  User.stamper = @zeus.id
+
+  @delynn = Person.create!(:name => 'Delynn')
+  @nicole = Person.create!(:name => 'Nicole')
+  Person.stamper = @delynn.id
+
+  @first_post = Post.create!(:title => 'a title')
+end

data/spec/support/with_temporary_table.rb

@@ -0,0 +1,50 @@
+# Test group helpers for creating tables.
+# The latest version can be gound at https://gist.github.com/lowjoel/bda0d44b48aac2925079
+module ActiveRecord::TemporaryTable; end
+module ActiveRecord::TemporaryTable::TestGroupHelpers
+  # Defines a temporary table that is instantiated when needed, within a `with_temporary_table`
+  # block.
+  #
+  # @param [Symbol] table_name The name of the table to define.
+  # @param [Proc] proc The table definition, same as that of a block given to
+  #   +ActiveRecord::Migration::create_table+
+  def temporary_table(table_name, &proc)
+    define_method(table_name) do
+      proc
+    end
+  end
+
+  # Using the temporary table defined previously, run the examples in this group.
+  #
+  # @param [Symbol] table_name The name of the table to use.
+  # @param [Proc] proc The examples requiring the use of the temporary table.
+  def with_temporary_table(table_name, &proc)
+    context "with temporary table #{table_name}" do |*params|
+      before(:context) do
+        ActiveRecord::TemporaryTable::TestGroupHelpers.before_context(table_name, send(table_name))
+      end
+
+      after(:context) do
+        ActiveRecord::TemporaryTable::TestGroupHelpers.after_context(table_name)
+      end
+
+      module_exec(*params, &proc)
+    end
+  end
+
+  def self.before_context(table_name, table_definition)
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.create_table(table_name, &table_definition)
+    end
+  end
+
+  def self.after_context(table_name)
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migration.drop_table(table_name)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend ActiveRecord::TemporaryTable::TestGroupHelpers, type: :model
+end

metadata

@@ -0,0 +1,276 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-userstamp
+version: !ruby/object:Gem::Version
+  version: 2.1.1
+platform: ruby
+authors:
+- Joel Low
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem extends ActiveRecord::Base to add automatic updating of created_by
+  and updated_by attributes of your models in much the same way that the ActiveRecord::Timestamp
+  module updates created_(at/on) and updated_(at/on) attributes.
+email:
+- joel@joelsplace.sg
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-userstamp.gemspec
+- lib/active_record/userstamp.rb
+- lib/active_record/userstamp/controller_additions.rb
+- lib/active_record/userstamp/migration_additions.rb
+- lib/active_record/userstamp/model_additions.rb
+- lib/active_record/userstamp/stampable.rb
+- lib/active_record/userstamp/stamper.rb
+- lib/active_record/userstamp/version.rb
+- lib/activerecord/userstamp.rb
+- spec/controllers/posts_controller_spec.rb
+- spec/controllers/users_controller_spec.rb
+- spec/coverage_helper.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/concerns/.keep
+- spec/dummy/app/controllers/posts_controller.rb
+- spec/dummy/app/controllers/users_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.keep
+- spec/dummy/app/models/comment.rb
+- spec/dummy/app/models/concerns/.keep
+- spec/dummy/app/models/foo.rb
+- spec/dummy/app/models/person.rb
+- spec/dummy/app/models/post.rb
+- spec/dummy/app/models/user.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/bundle
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/config/secrets.yml
+- spec/dummy/db/schema.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/lib/compatibility_stamping_spec.rb
+- spec/lib/migration_spec.rb
+- spec/lib/stamping_spec.rb
+- spec/lib/userstamp_spec.rb
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/database_helpers.rb
+- spec/support/with_temporary_table.rb
+homepage: https://github.com/lowjoel/activerecord-userstamp
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Adds magic creator and updater attributes to your ActiveRecord models.
+test_files: []