trackstamps-reborn 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fadfa370c842bc476bfa043e9fbf39403f63670a04688cfec1dbf71fa6e08aa6
+  data.tar.gz: 75b0cdeb8330a0532c44abc9666c2636786481934d4aba58d99784d004e99269
+SHA512:
+  metadata.gz: 18b286fe9b6431c629ba07bd8c324ad4d8e25405968d6ee411e984a05abff1580f0e7786b1f9bc98d700f00a8e3809691c760921081ad85550640f62f28350c8
+  data.tar.gz: c360f942e6dafa16d5b592ddafccfe02646b24b1a0363cd0b1e320ba0d47e99872840b97508d6de6ab71d25aaca945d2d1de3d169500449dd5e0ac4d89f8127f

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dušan
+Copyright (c) 2015 Shahzad Tariq 
+
+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,61 @@
+# trackstamps-reborn
+
+[![Gem Version](https://badge.fury.io/rb/trackstamps-reborn.svg)](https://rubygems.org/gems/trackstamps-reborn)
+[![Circle](https://circleci.com/gh/uvera/trackstamps-reborn/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/uvera/trackstamps-reborn?branch=main)
+[![Code Climate](https://codeclimate.com/github/uvera/trackstamps-reborn/badges/gpa.svg)](https://codeclimate.com/github/uvera/trackstamps-reborn)
+
+Track which user created or updated record in Rails.
+
+---
+
+- [Quick start](#quick-start)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+$ bundler install trackstamps-reborn
+```
+
+### Hook current_user into CurrentAttributes
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :set_trackstamps_user  
+
+  def set_trackstamps_user
+    Trackstamps::Reborn::Current.user = current_user
+  end
+end
+```
+
+### Generate migrations
+```
+rails generate trackstamps:reborn:migration table_name
+```
+
+## Include trackstamps
+```ruby
+class Example < ActiveRecord::Base
+  include Trackstamps::Reborn
+end
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/uvera/trackstamps-reborn/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/generators/trackstamps/reborn/migration_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/active_record'
+
+class Trackstamps::Reborn::MigrationGenerator < ::Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+  argument :table, :type => :string, :default => "application"
+  desc 'Generate migration file required for trackstamps'
+
+  def install
+    migration_template 'migration.rb', "db/migrate/add_trackstamps_to_#{table}.rb"
+  end
+
+  def migration_data
+    <<-RUBY
+    add_column :#{table}, :created_by_id, :integer
+    add_column :#{table}, :updated_by_id, :integer
+    RUBY
+  end
+
+  def table_name
+    table
+  end
+
+  def self.next_migration_number(dirname)
+    next_migration_number = current_migration_number(dirname) + 1
+    ActiveRecord::Migration.next_migration_number(next_migration_number)
+  end
+end

data/lib/generators/trackstamps/reborn/templates/migration.rb

@@ -0,0 +1,6 @@
+class AddTrackstampsTo<%= table_name.classify.pluralize -%> < ActiveRecord::Migration<%= [Rails::VERSION::STRING.to_f] if Rails::VERSION::MAJOR >= 5 -%>
+
+  def change
+<%= migration_data -%>
+  end
+end

data/lib/trackstamps/reborn/current.rb

@@ -0,0 +1,7 @@
+module Trackstamps
+  module Reborn
+    class Current < ActiveSupport::CurrentAttributes
+      attribute :user
+    end
+  end
+end

data/lib/trackstamps/reborn/version.rb

@@ -0,0 +1,5 @@
+module Trackstamps
+  module Reborn
+    VERSION = "0.0.3".freeze
+  end
+end

data/lib/trackstamps/reborn.rb

@@ -0,0 +1,36 @@
+require 'trackstamps/reborn/current'
+require 'active_support/current_attributes'
+require 'active_support/concern'
+
+module Trackstamps
+  module Reborn
+    extend ActiveSupport::Concern
+    autoload :VERSION, "trackstamps/reborn/version"
+
+    def trackstamps_current_user
+      Current.user
+    end
+
+    TRACKSTAMPS_USER_CLASS_NAME = 'User'
+    TRACKSTAMPS_UPDATER_FOREIGN_KEY = 'updated_by_id'
+    TRACKSTAMPS_CREATOR_FOREIGN_KEY = 'created_by_id'
+
+    included do
+      before_save :trackstamps_set_updater
+      before_create :trackstamps_set_creator
+
+      belongs_to :updater, class_name: TRACKSTAMPS_USER_CLASS_NAME, foreign_key: TRACKSTAMPS_UPDATER_FOREIGN_KEY, optional: true
+      belongs_to :creator, class_name: TRACKSTAMPS_USER_CLASS_NAME, foreign_key: TRACKSTAMPS_CREATOR_FOREIGN_KEY, optional: true
+
+      def trackstamps_set_updater
+        return unless trackstamps_current_user
+        self.send("#{TRACKSTAMPS_UPDATER_FOREIGN_KEY}=", trackstamps_current_user.id)
+      end
+
+      def trackstamps_set_creator
+        return unless trackstamps_current_user
+        self.send("#{TRACKSTAMPS_CREATOR_FOREIGN_KEY}=", trackstamps_current_user.id)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: trackstamps-reborn
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Dušan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description:
+email:
+- dusan.uveric@mitigate.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/generators/trackstamps/reborn/migration_generator.rb
+- lib/generators/trackstamps/reborn/templates/migration.rb
+- lib/trackstamps/reborn.rb
+- lib/trackstamps/reborn/current.rb
+- lib/trackstamps/reborn/version.rb
+homepage: https://github.com/uvera/trackstamps-reborn
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/uvera/trackstamps-reborn/issues
+  changelog_uri: https://github.com/uvera/trackstamps-reborn/releases
+  source_code_uri: https://github.com/uvera/trackstamps-reborn
+  homepage_uri: https://github.com/uvera/trackstamps-reborn
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ''
+test_files: []