paper_trail-globalid 0.1.3.rc → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c20b5b51c09214b2d68507447eb576cbc286ad3
-  data.tar.gz: f3c196d23b6da562c45e4ee6c44c9d36f3574d4d
+  metadata.gz: 102e00cb9ac9f000210f7616d21282c4bc8cad0f
+  data.tar.gz: 79a1e30e95486bc103720f785322d8d9f16bb276
 SHA512:
-  metadata.gz: 2802eb9dfa98e7f824fa27989f2e1bad93825c19b26357c0a44dcd085bc01d403bbd2141b6f1adced2ae195a5e9a93722fa827d70b952b0d1ee8e327ae8bad9b
-  data.tar.gz: f8b4259f36ee36538c7d59447a3600cf2b023d0c4fdaf953a2372ed65da0c91afe4a6bdd706b2de6aacca53b904903f30f8fb3a4a93b16e6ca9df4b946e934ed
+  metadata.gz: 4f301f67094a75e64884c3f7b85db75c4b79cb3a9bd2b07b3904aee7cd7b4471d4388a56c33c25f78df9b567f1baf4a4c20d7284a7da2468326c846033ae0333
+  data.tar.gz: 905514bf080152ac06f8a0a407a5ec0da943be9c6fbbf44dc16e1c8424aa4ed386147e0fdb2bc4bd58538e5cf0f895a60e57046e0bcfce082582b4eee5514963

data/.gitignore

@@ -21,3 +21,5 @@ tmp
 *.a
 mkmf.log
 .DS_Store
+.byebug_history
+paper_trail_globalid_test

data/README.md

@@ -1,7 +1,8 @@
 # PaperTrailGlobalid
+[![Code Climate](https://codeclimate.com/github/ankit1910/paper_trail-globalid/badges/gpa.svg)](https://codeclimate.com/github/ankit1910/paper_trail-globalid)
+
 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.
 
-[![Code Climate](https://codeclimate.com/github/ankit1910/paper_trail-globalid/badges/gpa.svg)](https://codeclimate.com/github/ankit1910/paper_trail-globalid)
 
 ## Supported Rails
 

data/lib/paper_trail-globalid.rb

@@ -4,7 +4,9 @@ require "paper_trail_globalid/version_concern"
 
 module PaperTrailGlobalid
   module ::PaperTrail
-    include ::PaperTrailGlobalid::PaperTrail
+    class << self
+      prepend ::PaperTrailGlobalid::PaperTrail
+    end
   end
 
   module ::PaperTrail

data/lib/paper_trail_globalid/paper_trail.rb

@@ -1,21 +1,15 @@
 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
+    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 self.included(receiver)
-      receiver.extend ClassMethods
+    def actor
+      ::GlobalID::Locator.locate(paper_trail_store[:whodunnit]) || whodunnit
     end
   end
 end

data/lib/paper_trail_globalid/version.rb

@@ -1,3 +1,3 @@
 module PaperTrailGlobalid
-  VERSION = "0.1.3.rc"
+  VERSION = "0.2.0"
 end

data/paper_trail_globalid.gemspec

@@ -24,4 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'appraisal', '~> 2.1'
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "coveralls", "~> 0.8.2"
+  spec.add_development_dependency "activerecord", ">=3.2.0"
+  spec.add_development_dependency "activesupport", ">=3.2.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
 end

data/spec/paper_trail_globalid_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require_relative '../spec/support/order.rb'
+require_relative '../spec/support/admin.rb'
+
+
+describe PaperTrailGlobalid do
+  before(:all) do
+    ActiveRecord::Migration.verbose = false
+    ActiveRecord::Schema.define do
+      create_table :orders, force: true do |t|
+        t.string :order_number
+        t.integer :total
+      end
+
+      create_table :admins, force: true do |t|
+        t.string :name
+      end
+
+      create_table :versions do |t|
+        t.string   :item_type, :null => false
+        t.integer  :item_id,   :null => false
+        t.string   :event,     :null => false
+        t.string   :whodunnit
+        t.text     :object,    :limit => 1_073_741_823
+        t.datetime :created_at
+      end
+    end
+  end
+
+  after(:all) do
+    ActiveRecord::Schema.define do
+      drop_table :orders
+      drop_table :versions
+    end
+    ActiveRecord::Migration.verbose = true
+  end
+
+  describe 'paper_trail_globalid' do
+    before do
+      GlobalID.app = "App"
+      @admin = Admin.create(name: 'admin')
+      @order = Order.create!(order_number: 'ord_1', total: 100)
+      @version = @order.versions.last
+    end
+
+    describe 'paper_trail' do
+      describe 'class_methods' do
+        describe 'PaperTrail.actor' do
+          context 'when value for whodunnit is object of ActiveRecord' do
+            it 'returns object' do
+              PaperTrail.whodunnit=@admin
+              expect(PaperTrail.actor).to eq(@admin)
+            end
+          end
+
+          context 'when value for whodunnit is not an object of ActiveRecord' do
+            it 'returns value itself' do
+              PaperTrail.whodunnit="test"
+              expect(PaperTrail.actor).to eq("test")
+            end
+          end
+        end
+
+        describe '.whodunnit' do
+          context 'when value for whodunnit is object of ActiveRecord' do
+            it 'returns global id' do
+              PaperTrail.whodunnit=@admin
+              expect(PaperTrail.paper_trail_store[:whodunnit]).to eq(@admin.to_gid)
+            end
+          end
+
+          context 'when value for whodunnit is not an object of ActiveRecord' do
+            it 'returns value itself' do
+              PaperTrail.whodunnit="test"
+              expect(PaperTrail.paper_trail_store[:whodunnit]).to eq("test")
+            end
+          end
+        end
+      end
+    end
+
+    describe 'version_concern' do
+      describe 'instance_methods' do
+        describe '#actor' do
+          context 'when value for whodunnit is object of ActiveRecord' do
+            it 'returns object' do
+              @version.whodunnit = @admin
+              @version.save
+              expect(@version.actor).to eq(@admin)
+            end
+          end
+
+          context 'when value for whodunnit is not an object of ActiveRecord' do
+            it 'returns value itself' do
+              @version.whodunnit = "test"
+              @version.save
+              expect(@version.actor).to eq("test")
+            end
+          end
+        end
+
+        describe '.whodunnit' do
+          context 'when value for whodunnit is object of ActiveRecord' do
+            it 'returns global id' do
+              @version.whodunnit = @admin
+              @version.save
+              expect(@version.whodunnit).to eq(@admin.to_gid.to_s)
+            end
+          end
+
+          context 'when value for whodunnit is not an object of ActiveRecord' do
+            it 'returns value itself' do
+              @version.whodunnit = "test"
+              @version.save
+              expect(@version.whodunnit).to eq("test")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+# 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 'sqlite3'
+require 'active_record'
+require 'byebug'
+require_relative './../lib/paper_trail-globalid.rb'
+require_relative './support/database_connection.rb'
+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
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # 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
+end

data/spec/support/admin.rb

@@ -0,0 +1,4 @@
+require 'globalid'
+class Admin < ActiveRecord::Base
+  include ::GlobalID::Identification
+end

data/spec/support/database_connection.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database  => "paper_trail_globalid_test"
+)

data/spec/support/order.rb

@@ -0,0 +1,5 @@
+require 'paper_trail'
+require 'paper_trail-globalid'
+class Order < ActiveRecord::Base
+  has_paper_trail
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-globalid
 version: !ruby/object:Gem::Version
-  version: 0.1.3.rc
+  version: 0.2.0
 platform: ruby
 authors:
 - Ankit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paper_trail
@@ -80,6 +80,90 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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:
@@ -98,6 +182,11 @@ files:
 - lib/paper_trail_globalid/version.rb
 - lib/paper_trail_globalid/version_concern.rb
 - paper_trail_globalid.gemspec
+- spec/paper_trail_globalid_spec.rb
+- spec/spec_helper.rb
+- spec/support/admin.rb
+- spec/support/database_connection.rb
+- spec/support/order.rb
 homepage: https://github.com/ankit1910/paper_trail-globalid
 licenses:
 - MIT
@@ -113,9 +202,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -123,4 +212,9 @@ 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: []
+test_files:
+- spec/paper_trail_globalid_spec.rb
+- spec/spec_helper.rb
+- spec/support/admin.rb
+- spec/support/database_connection.rb
+- spec/support/order.rb