ass_ole-snippets-shared 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ef8af3522c444ae9dc38adca2ac74a46f6c88a6
-  data.tar.gz: 63163372c91ab83d973249f3f0a152ad70084c4d
+  metadata.gz: 695fcd6c1d95365a3592620312f61342185c0a28
+  data.tar.gz: 3dccb72013e0b28d8f3ea34bf3245ac279930f2d
 SHA512:
-  metadata.gz: 9b17ae1e23d8cd2dce0af0e1d384e9c9a81a19440547ba99cf47e1371cc6ff9fdc6fb5b581f498a379fe8bf2ec0ae1092327fc2dff85c177f04ed5afdbc828e4
-  data.tar.gz: b8ea8240651d0bcd64c463c58490581589bf6ea97d6cfe0d1f1b46e2cfcc4448c08f4ed733091b46913882c7b98eb83e1d19e11c76c35b1188e394ceca9e54fc
+  metadata.gz: 59787df2957c0ffac5666a812c72d850ca8f1b7b77045bd5eba5acdbcac825060171f45f4449a65087fa1d425950ebb8726914e6505d767f8b0c3c350afca49c
+  data.tar.gz: 82558bf3c383d166f8aba8d1773f0d86835c0c64671f14ce44952c1cd0e97da6fe9341243ab21786a35a4fec027b0e31e548ed1c11cb1f6253924061898a866b

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/ass_ole-snippets-shared.svg)](https://badge.fury.io/rb/ass_ole-snippets-shared)
 # AssOle::Snippets::Shared
 
 Shared ole snippets for [ass_ole](https://github.com/leoniv/ass_ole)

data/lib/ass_ole/snippets/shared.rb

@@ -3,7 +3,35 @@ require 'ass_ole'
 
 module AssOle
   module Snippets
-    # Shared Ole snippets
+    # Shared Ole snippets.
+    #
+    # Object included snippets must +respond_to? ole_connector+ and returns
+    # 1C OLE connector or includes +AssOle+ runtime using: +like_ole_runtime+
+    # method defined in +ass_ole+ gem.
+    # @example
+    #   require 'ass_ole'
+    #   require 'ass_ole/snippets/shared'
+    #   require 'ass_maintainer/info_base'
+    #
+    #   # External connection runtime
+    #   module ExternalRuntime
+    #     is_ole_runtime :external
+    #   end
+    #
+    #   class Worker
+    #     like_ole_runtime ExternalRuntime
+    #     include AssOle::Snippets::Shared::Query
+    #
+    #     def initialize(connection_string)
+    #       ole_runtime_get.run AssMaintainer::InfoBase.new('ib_name', connection_string)
+    #     end
+    #
+    #     def select(value)
+    #       query('select &arg as arg', arg: value).Execute.Unload.Get(0).arg
+    #     end
+    #   end
+    #
+    #   Worker.new('File="path"').select('Hello') #=> "Hello"
     module Shared
       # Snippet for serialize and deserilize 1C objects to xml
       # @note In external runtime it will be cause of a fail in +InfoBase#rm!+
@@ -81,14 +109,37 @@ module AssOle
         end
       end
 
+      # @deprecated Use {InTransactionDo} instead
+      # @todo remove module in v1.0.0
       # Do in transaction wrapper
       module Transaction
         is_ole_snippet
 
+        def self.depricate
+          Kernel.warn '[DEPRICATION]'\
+            " '#{self.name}` is deprecated and will be"\
+            " removed soon. Please use "\
+            '\'AssOle::Snipptes::Shared::InTransactionDo` instead.'\
+        end
+
+        [method(:included), method(:extended)].each do |old_method|
+          name = old_method.name
+          old = "_depricate_#{name}"
+          singleton_class.class_eval {
+            alias_method old, name
+            define_method name do |*args, &block|
+              AssOle::Snippets::Shared::Transaction.depricate
+              send old, *args, &block
+            end
+          }
+        end
+
         # rubocop:disable Metrics/MethodLength
 
+        # @deprecated Use {InTransactionDo#in_transaction} instead
         # @raise [RuntimeError] if nested transaction
         def do_in_transaction(&block)
+          AssOle::Snippets::Shared::Transaction.depricate
           fail ArgumentError, 'Block require' unless block_given?
           fail 'Nested transaction is mindless in 1C runtime' if\
             transactionActive
@@ -110,6 +161,7 @@ module AssOle
       require 'ass_ole/snippets/shared/array'
       require 'ass_ole/snippets/shared/binary_data'
       require 'ass_ole/snippets/shared/value_table'
+      require 'ass_ole/snippets/shared/in_transaction_do'
     end
   end
 end

data/lib/ass_ole/snippets/shared/in_transaction_do.rb

@@ -0,0 +1,144 @@
+module AssOle
+  module Snippets
+    module Shared
+      # Mixin for wrapping execution into 1C transaction.
+      # @example
+      #   #!/sbin/env ruby
+      #
+      #   require 'ass_ole'
+      #   require 'ass_ole/snippets/shred/in_transaction_do'
+      #
+      #   PLATFORM_REQUIRE = '~> 8.3.10.0'
+      #
+      #   # External connection runtime for accounting infobase
+      #   module AccountingRuntime
+      #     is_ole_runtime :external
+      #   end
+      #
+      #   # External connection runtime for HRM infobase
+      #   module HrmRuntime
+      #     is_ole_runtime :external
+      #   end
+      #
+      #   # Worker do anything in accounting infobase
+      #   class AcctWorker
+      #     like_ole_runtime AccountingRuntime
+      #     include AssOle::Snipptes::Shared::InTransactionDo
+      #
+      #     attr_reader :ib
+      #     def initialize(connection_string)
+      #       @ib = AssMaintainer::InfoBase
+      #         .new('accounting', connection_string, PLATFORM_REQUIRE)
+      #       ole_runtime_get.run ib #connect to infobase
+      #     end
+      #
+      #     def action_one
+      #       #NOP
+      #     end
+      #
+      #     def action_two(action_one_result)
+      #       #NOP
+      #     end
+      #
+      #     def make_job_in_transaction
+      #       in_transaction do
+      #         make_job
+      #       end
+      #     end
+      #
+      #     def make_job
+      #       action_two(action_one)
+      #     end
+      #   end
+      #
+      #   # Worker do anything in HRM infobase
+      #   class HrmWorker
+      #     like_ole_runtime HrmRuntime
+      #     include AssOle::Snipptes::Shared::InTransactionDo
+      #
+      #     attr_reader :ib
+      #     def initialize(connection_string)
+      #       @ib = AssMaintainer::InfoBase
+      #         .new('accounting', connection_string, PLATFORM_REQUIRE)
+      #       ole_runtime_get.run ib #connect to infobase
+      #     end
+      #
+      #     def action_one(acct_result)
+      #       #NOP
+      #     end
+      #
+      #     def action_two(acct_result)
+      #       #NOP
+      #     end
+      #
+      #     def make_job(acct_result)
+      #       action_one(acct_result)
+      #       action_two(acct_reult)
+      #       true
+      #     end
+      #   end
+      #
+      #   module Programm
+      #     # It working like distributed transaction
+      #     def self.execute_in_nested_transaction(acct_cs, hrm_cs)
+      #       # Trasaction in HrmWorker committed  automatically
+      #       HrmWorker.new(hrm_cs).in_transaction do |hrm_worker|
+      #         # Trasaction in AcctWorker keep alive
+      #         acct_result = AcctWorker.new(acct_cs).in_transaction(false) do |acct_worker|
+      #           acct_worker.make_job
+      #         end
+      #         result = hrm_worker.make_job(acct_result)
+      #         #Commit AcctWorker transaction
+      #         acct_worker._commit_transaction_
+      #         result
+      #       end
+      #     end
+      #   end
+      #
+      #   #Do in accounting infobase only
+      #   puts AcctWorker.new(ARGV[0]).make_job_in_transaction
+      #
+      #   #Do in accounting and hrm infobases
+      #   puts Programm.execute_in_nested_transaction(ARGV[0], ARGV[1])
+      module InTransactionDo
+        is_ole_snippet
+
+        # Wrap execution in 1C transaction. If execution failure
+        # transaction always rolledback!
+        # @param auto_commit [true false] if +true+ transaction will be committed
+        #  automatically
+        # @param managed_lock (see #_begin_transaction_)
+        # @yield self
+        # @return execution result
+        def in_transaction(auto_commit = true, managed_lock = false, &block)
+          fail 'Block require' unless block_given?
+          _begin_transaction_ managed_lock
+          begin
+            result = yield self
+            _commit_transaction_ if auto_commit
+          rescue Exception => e
+            _rollback_transaction_
+            fail e
+          end
+          result
+        end
+
+        # @param managed_lock [false true] if true 1C +BeginTransaction+ call with
+        #  +DataLockControlMode.Managed+
+        def _begin_transaction_(managed_lock = false)
+          ole_connector.beginTransaction unless managed_lock
+          ole_connector.beginTransaction ole_connector
+            .dataLockControlMode.Managed if managed_lock
+        end
+
+        def _rollback_transaction_
+          ole_connector.rollBackTransaction
+        end
+
+        def _commit_transaction_
+          ole_connector.commitTransaction
+        end
+      end
+    end
+  end
+end

data/lib/ass_ole/snippets/shared/value_table.rb

@@ -95,8 +95,8 @@ module AssOle
 
         # @param columns [Array] +ValueTable+ columns
         # @param columns_with_types [Hash] +ValueTable+ columns with column
-        #  type names [Array] like %w{TypeName OtheTypeName}
-        #  or [String] like 'TypeName, OtheTypeName'
+        #  type names +Array+ like +%w{TypeName OtheTypeName}+
+        #  or +String+ like +'TypeName, OtheTypeName'+
         # @yield [Wrapper]
         # @return [WIN32OLE] 1C +ValueTable+ object
         def value_table(*columns, **columns_with_types, &block)

data/lib/ass_ole/snippets/shared/version.rb

@@ -2,7 +2,7 @@ module AssOle
   module Snippets
     #
     module Shared
-      VERSION = '0.3.2'
+      VERSION = '0.4.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ass_ole-snippets-shared
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Leonid Vlasov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ass_ole
@@ -141,6 +141,7 @@ files:
 - lib/ass_ole/snippets/shared.rb
 - lib/ass_ole/snippets/shared/array.rb
 - lib/ass_ole/snippets/shared/binary_data.rb
+- lib/ass_ole/snippets/shared/in_transaction_do.rb
 - lib/ass_ole/snippets/shared/mapped.rb
 - lib/ass_ole/snippets/shared/value_table.rb
 - lib/ass_ole/snippets/shared/version.rb
@@ -163,9 +164,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Shared snippets for ass_ole gem
 test_files: []
-has_rdoc: