paper_trail-globalid 0.1.2.rc

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05709a7d0e45d43c43bcbaf60181092ffb82440b
+  data.tar.gz: b76c015d28a0062793052dc2eb7311f7881f62cd
+SHA512:
+  metadata.gz: c2a6cb1fe2a3e1f95d4c0fbd1c88d4280c694deed699adf5aabbb98567b5b199d7040eb977fb4163eb8fabbe1bcf77d7186318d09c858461a6b992a994efdec4
+  data.tar.gz: 94865f8f943b5b7f49deef53fd7c57615df47e90171fd5491b1d3664db780a31c4fea781e143ef1a5c76545f708d502b1995c2f97d8706d693faf898514c356d

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in paper_trail_globalid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 ankit1910
+
+MIT License
+
+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,62 @@
+# PaperTrailGlobalid
+This gem is an extension to paper_trail gem https://github.com/airblade/paper_trail. That means you need to pre install `paper_trail` gem. This gem will add one more method `actor` to instances of `PaperTrail::Version` that will return you the `ActiveRecord` object who was responsible for change.
+
+
+## Supported Rails
+
+This Gem only support `>= rails 4.1.0` and above versions.
+
+## Installation
+
+1. Add PaperTrailGlobalid to your `Gemfile`.
+
+  `gem 'paper_trail-globalid'`
+
+1. And then execute:
+
+  ```
+  bundle install
+  ```
+
+## Basic Usage
+
+Basically this gem works on stroring global_id to whodunnit field of `PaperTrail::Version table`. As this is an additional extension installed, this will not hinder / break existing paper_trail functionalities.
+
+```ruby
+widget = Widget.find 42
+widget.versions               # [<PaperTrail::Version>, <PaperTrail::Version>, ...]
+v = widget.versions.last
+```
+Now you can also store object to `PaperTrail.whodunnit=`, and if object will be instance of `ActiveRecord::Base` it will store the global id in the version's `whodunnit` column.
+
+And you can also retrieve the actually object later just by using method `actor`.
+
+```ruby
+admin = Admin.find(1)                       # <Admin:0x007fa2df9a5590>
+
+PaperTrail.whodunnit = admin
+PaperTrail.actor                            # <Admin:0x007fa2df9a5590> actual object
+
+widget.update_attributes :name => 'Wibble'
+widget.versions.last.whodunnit              # "gid://app/Admin/1"
+widget.versions.last.actor                  # retruns the actuall object
+```
+
+Method `actor` will return the whodunnit value if we pass value another than `ActiveRecord` object.
+
+```ruby
+PaperTrail.whodunnit = 'admin_name'
+PaperTrail.actor                            # "admin_name"
+
+widget.update_attributes :name => 'Wibble'
+widget.versions.last.whodunnit              # "admin_name"
+widget.versions.last.actor                  # "admin_name"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/paper_trail-globalid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/paper_trail_globalid.rb

@@ -0,0 +1,15 @@
+require "paper_trail_globalid/paper_trail"
+require "paper_trail_globalid/version"
+require "paper_trail_globalid/version_concern"
+
+module PaperTrailGlobalid
+  module ::PaperTrail
+    include ::PaperTrailGlobalid::PaperTrail
+  end
+
+  module ::PaperTrail
+    module VersionConcern
+      include ::PaperTrailGlobalid::VersionConcern
+    end
+  end
+end

data/lib/paper_trail_globalid/paper_trail.rb

@@ -0,0 +1,21 @@
+module PaperTrailGlobalid
+  module PaperTrail
+    module ClassMethods
+      def whodunnit=(value)
+        if value.is_a? ActiveRecord::Base
+          paper_trail_store[:whodunnit] = value.to_gid
+        else
+          paper_trail_store[:whodunnit] = value
+        end
+      end
+
+      def actor
+        ::GlobalID::Locator.locate(paper_trail_store[:whodunnit]) || whodunnit
+      end
+    end
+
+    def self.included(receiver)
+      receiver.extend ClassMethods
+    end
+  end
+end

data/lib/paper_trail_globalid/version.rb

@@ -0,0 +1,3 @@
+module PaperTrailGlobalid
+  VERSION = "0.1.2.rc"
+end

data/lib/paper_trail_globalid/version_concern.rb

@@ -0,0 +1,19 @@
+module PaperTrailGlobalid
+  module VersionConcern
+    def whodunnit=(value)
+      if value.is_a? ActiveRecord::Base
+        super(value.to_gid)
+      else
+        super
+      end
+    end
+
+    # Returns an object which was responsible for a change
+    # you need to store global_id to whodunnit field to make this method return the object(who was responsible)
+    # for example, whodunnit => "gid://app/Order/1" then
+    # whodunnit_user will return Order.find_by(id: 1) in application scope.
+    def actor
+      ::GlobalID::Locator.locate(whodunnit) || whodunnit
+    end
+  end
+end

data/paper_trail_globalid.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'paper_trail_globalid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "paper_trail-globalid"
+  spec.version       = PaperTrailGlobalid::VERSION
+  spec.authors       = ["Ankit"]
+  spec.email         = ["ankit.bansal1910@gmail.com"]
+  spec.summary       = "An extension to paper_trail, using this you can fetch actual object who was responsible for this change"
+  spec.description   = "An extension to paper_trail, using this you can fetch actual object who was responsible for this change"
+  spec.homepage      = "https://github.com/ankit1910/paper_trail-globalid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'paper_trail', '>= 3.0.0'
+  spec.add_dependency 'globalid'
+
+  spec.add_development_dependency 'appraisal', '~> 2.1'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: paper_trail-globalid
+version: !ruby/object:Gem::Version
+  version: 0.1.2.rc
+platform: ruby
+authors:
+- Ankit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: globalid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: An extension to paper_trail, using this you can fetch actual object who
+  was responsible for this change
+email:
+- ankit.bansal1910@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/paper_trail_globalid.rb
+- lib/paper_trail_globalid/paper_trail.rb
+- lib/paper_trail_globalid/version.rb
+- lib/paper_trail_globalid/version_concern.rb
+- paper_trail_globalid.gemspec
+homepage: https://github.com/ankit1910/paper_trail-globalid
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An extension to paper_trail, using this you can fetch actual object who was
+  responsible for this change
+test_files: []