fish_transactions 1.0.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a822130f177c9753a9d30a248208ae38d46e29c7
-  data.tar.gz: 051ec846fc08b2a295d8f88601c4da608c73f7f0
+  metadata.gz: f0a193af2c3034dd8fa7ab67272b97727bdd31f0
+  data.tar.gz: 3395ae0c828efdd6cf412672f9c85af768936c99
 SHA512:
-  metadata.gz: 5c9a9eb96340b83db54f2f20679616af083b25bd02892c6aceb5438de74c2a5318c3741ba26ea81679d8c5e5d02dd5cc453949d6f1779073382e6f20145d1ec6
-  data.tar.gz: d7a17433321b20d4ccea1320b5c956efe518e514c5e0c814867fbcd8040ce110697692901f66f7433830b698581235c78fcada6815876fc80bbc63b1eb09d4fc
+  metadata.gz: 1662a9bfff22ef3ff8e378be5a545c97e7317a94d9b2b72368e303f28b8204051e93fe8a042e6472450e3bd5ee3f24987c94faf30e9890de5554d0904cecb923
+  data.tar.gz: 3a9ae0856c07daafadb09c6b2dbb608671bf9cddeeb4ca96ad4f4e808839bf9f4ef0470fa0f448cddb0dce79e07b9157822c28e3ae6daf5561fee7f706c9de4d

data/README.md

@@ -31,7 +31,7 @@ the code you wanna run on such events.
 ```ruby
 class SomeClass
 
-  include FishTransaction::Callbacks
+  include FishTransactions::Callbacks
 
   # ...
 
@@ -44,8 +44,8 @@ class SomeClass
 
       after_commit do
 
-        # things to do after transaction
-        puts "runs after transaction"
+        # things to do after commit
+        puts "runs after commit"
 
       end
 
@@ -65,10 +65,56 @@ will output
 ```
 runs within transaction
 again runs within transaction
-runs after transaction
+runs after commit
+```
+
+Please see `FishTransactions::Callbacks` for more details.
+
+## Alternative class methods usage
+Since 1.1 version you can also directly use `after_* methods` as FishTransactions class methods.
+
+
+#### Example
+
+
+```ruby
+class SomeClass
+
+  # ...
+
+  def some_method
+    # ...
+
+    ActiveRecord::Base.transaction do
+      # executes some code
+      puts "runs within transaction"
+
+      FishTransactions.after_commit do
+
+        # things to do after commit
+        puts "runs after commit"
+
+      end
+
+      # executes more code
+      puts "again runs within transaction"
+    end
+    # ...
+
+  end
+
+  # ...
+
+end
+
+```
+will output
+```
+runs within transaction
+again runs within transaction
+runs after commit
 ```
 
-Please see [FishTransactions::Callbacks](FishTransactions/Callbacks.html) for more details.
 
 ## Contributing
 

data/lib/fish_transactions.rb

@@ -2,3 +2,62 @@ require 'fish_transactions/version'
 require 'fish_transactions/active_record_mods'
 require 'fish_transactions/callbacks'
 
+##
+# FishTransactions is the main Module which includes
+# all fish transaction features.
+#
+# Please visit FishTransactions::Callbacks for more information of how to use these callbacks
+#
+# Example of usage:
+#
+#
+#   class SomeClass
+#
+#     include FishTransactions::Callbacks
+#
+#     # ...
+#
+#     def some_method
+#       # ...
+#
+#       ActiveRecord::Base.transaction do
+#         # executes some code
+#         puts "runs within transaction"
+#
+#         after_commit do
+#
+#           # things to do after commit
+#           puts "runs after commit"
+#
+#         end
+#
+#         # executes more code
+#         puts "again runs within transaction"
+#       end
+#       # ...
+#
+#     end
+#
+#     # ...
+#
+#   end
+#
+#
+# will output
+#
+#   runs within transaction
+#   again runs within transaction
+#   runs after commit
+#
+# Optionally, you can use callbacks as
+# FishTransactions class methods, like this:
+#
+#   FishTransactions.after_commit do
+#     # thinks to do after commit
+#   end
+#
+# <b>Please prefer including FishTransactions::Callbacks on your classes before using class methods style.</b>
+#
+module FishTransactions
+  extend FishTransactions::Callbacks
+end

data/lib/fish_transactions/callbacks.rb

@@ -7,6 +7,48 @@ module FishTransactions
   # You just need to include this module and you will able to
   # use it.
   #
+  #
+  # Example of usage:
+  #
+  #
+  #   class SomeClass
+  #
+  #     include FishTransactions::Callbacks
+  #
+  #     # ...
+  #
+  #     def some_method
+  #       # ...
+  #
+  #       ActiveRecord::Base.transaction do
+  #         # executes some code
+  #         puts "runs within transaction"
+  #
+  #         after_commit do
+  #
+  #           # things to do after commit
+  #           puts "runs after commit"
+  #
+  #         end
+  #
+  #         # executes more code
+  #         puts "again runs within transaction"
+  #       end
+  #       # ...
+  #
+  #     end
+  #
+  #     # ...
+  #
+  #   end
+  #
+  #
+  # will output
+  #
+  #   runs within transaction
+  #   again runs within transaction
+  #   runs after commit
+  #
   module Callbacks
 
     ##

data/lib/fish_transactions/version.rb

@@ -2,5 +2,5 @@
 module FishTransactions
   ##
   # current version
-  VERSION = "1.0.0"
+  VERSION = "1.1"
 end

data/spec/fish_transactions_spec.rb

@@ -0,0 +1,23 @@
+require 'fish_transactions'
+
+describe FishTransactions do
+
+  describe '.after_transaction' do
+    it 'should exists' do
+      expect(FishTransactions).to respond_to(:after_transaction)
+    end
+  end
+
+  describe '.after_commit' do
+    it 'should exists' do
+      expect(FishTransactions).to respond_to(:after_commit)
+    end
+  end
+
+  describe '.after_rollback' do
+    it 'should exists' do
+      expect(FishTransactions).to respond_to(:after_rollback)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fish_transactions
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: '1.1'
 platform: ruby
 authors:
 - John Owen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -128,6 +128,7 @@ files:
 - lib/fish_transactions/version.rb
 - spec/callbacks_spec.rb
 - spec/callbacks_storage_spec.rb
+- spec/fish_transactions_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Beetrack/fish_transactions
 licenses:
@@ -156,4 +157,5 @@ summary: Callbacks for Active Record transactions that can be used anywhere.
 test_files:
 - spec/callbacks_spec.rb
 - spec/callbacks_storage_spec.rb
+- spec/fish_transactions_spec.rb
 - spec/spec_helper.rb