ass_ole 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c521cf1ed642c0bfee22b61d8185f8910c48685
+  data.tar.gz: a261e51a1e48eb2cd35a0d3f0f9dc232ec04a75c
+SHA512:
+  metadata.gz: 04bd263480e52c373c6c45360bd88313376127a5c0a0e976ef25f6c072af80c664b252b766450c787c3d7378350e04fe081c19a71d14b527db298e8e7df0e615
+  data.tar.gz: c9b0cb80d1b55d69aa4f54805a7e85797931e50b5c7a98d40c2791981db19d665cf4bea3025d09fcb6578d6a59a272f0bbc9d8990506d18cc4005211ba0be6a5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start if ENV['SIMPLECOV']

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,62 @@
+# AssOle
+
+Provides features for easy access to 1C:Enterprise Ole from Ruby code.
+Main things of this gem is `AssOle::Runtimes` and `AssOle::Snippets`
+
+`AssOle::Runtimes` provides features for control, despatch and easy access to
+the 1C:Enterprise Ole connectors. `AssOle::Runtimes` inclides mixins which
+provides `ole_connector` method returned specified Ole connector.
+
+`AssOle::Snippets` provides features for transparent access to 1C:Enterprise Ole
+methods and properties from Ruby objects like as they are was own Ruby object
+methods. In other words `AssOle::Snippetes` forvarding call unknown methods
+to the `ole_connector` in the `method_missing` handler.
+
+Both this things makes Ruby code shorter and tidier
+
+## Attention
+
+`AssOle::Runtimes` closes all ole connections in `at_exit` hook. You should
+checks order of modules loading.
+For example if `ass_ole` uses with `minitest` first load
+`ass_ole` secont load `minitest` otherwise all ole connections will be closed
+before start tests executing:
+
+```ruby
+requre 'ass_ole'
+requre 'minitest/autorun'
+```
+
+## Examples
+
+More about it and how to use see [test/examples_test.rb](test/examples_test.rb)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ass_ole'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ass_ole
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Testing
+
+    $ export SIMPLECOV=YES && rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/leoniv/ass_ole.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/ass_ole.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ass_ole/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ass_ole"
+  spec.version       = AssOle::VERSION
+  spec.authors       = ["Leonid Vlasov"]
+  spec.email         = ["leoniv.vlasov@gmail.com"]
+
+  spec.summary       = %q{Easy access to 1C:Enterprise apps and servers via Ole}
+  spec.description   = %q{Provides features for easy access to 1C:Enterprise applications and 1C:Enterprise servers from Ruby code}
+  spec.homepage      = "https://github.com/leoniv/ass_ole"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ass_launcher", "~> 0.2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "ass_maintainer-info_base"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ass_ole"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ass_ole.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+
+# AssOle provides helpers for manipulate with
+# 1C:Enterprise Ole serevers and some more
+module AssOle
+  require 'ass_launcher'
+  require 'ass_ole/version'
+  require 'ass_ole/snippets'
+  require 'ass_ole/dsl'
+
+  # @api private
+  # Runtimes hold all created Ole runtimes and stopped they in +at_axit+ see
+  # {.do_at_exit}
+  module Runtimes
+    def self.runtimes
+      @runtimes ||= []
+    end
+
+    # @api private
+    # `at_exit` handler closed all opened connections
+    def self.do_at_exit
+      runtimes.each(&:stop)
+    end
+
+    at_exit do
+      do_at_exit
+    end
+
+    # @api private
+    module RuntimeDispatcher
+      def ole_connector
+        ole_runtime_get.ole_connector
+      end
+
+      def ole_runtime_get
+        if self.class == Module
+          instance_variable_get(:@ole_runtime)
+        elsif self.class == Class
+          class_variable_get(:@@ole_runtime)
+        else
+          self.class
+        end
+      end
+      private :ole_runtime_get
+    end
+
+    # @api private
+    module ModuleMethods
+      attr_reader :ole_connector
+
+      def run_(connection_string_or_uri)
+        ole_connector.__open__ connection_string_or_uri unless runned?
+      end
+      private :run_
+
+      def stop
+        ole_connector.__close__ if runned?
+      end
+
+      def runned?
+        initialized? && ole_connector.__opened__?
+      end
+
+      def initialized?
+        !ole_connector.nil?
+      end
+
+      def included(obj)
+        ole_runtime_set obj
+        obj.send(:extend, RuntimeDispatcher)
+      end
+
+      def extended(obj)
+        ole_runtime_set obj
+      end
+
+      def ole_runtime_set(obj)
+        if obj.class == Class
+          obj.class_variable_set(:@@ole_runtime, self)
+        else
+          obj.instance_variable_set(:@ole_runtime, self)
+        end
+      end
+      private :ole_runtime_set
+    end
+
+    # @api private
+    module AbstractRuntime
+      def extended(obj)
+        obj.send(:extend, AssOle::Runtimes::ModuleMethods)
+        obj.send(:include, AssOle::Runtimes::RuntimeDispatcher)
+        Runtimes.runtimes << obj
+      end
+    end
+
+    # 1C:Enterprise application runtime helpers
+    # @api private
+    module App
+      # @api private
+      # @abstract
+      module Abstract
+        def run(info_base)
+          return ole_connector if runned?
+          instance_variable_set(:@ole_connector, info_base.ole(ole_type))
+          run_ info_base.connection_string
+        end
+      end
+      # 1C:Enterprise application external connection runtime helper
+      module External
+        extend AbstractRuntime
+        include Abstract
+        def ole_type
+          :external
+        end
+      end
+
+      # 1C:Enterprise thick application connection runtime helper
+      module Thick
+        extend AbstractRuntime
+        include Abstract
+        def ole_type
+          :thick
+        end
+      end
+
+      # 1C:Enterprise thin application connection runtime helper
+      module Thin
+        extend AbstractRuntime
+        include Abstract
+        def ole_type
+          :thin
+        end
+      end
+    end
+
+    # 1C:Enterprise server runtime helpers
+    # @api private
+    module Claster
+      # @abstract
+      # @api private
+      module Abstract
+        def run(uri, platform_require = '> 0')
+          return ole_connector if runned?
+          instance_variable_set(:@ole_connector,
+                                ole_class.new(platform_require))
+          run_ uri
+        end
+      end
+
+      # 1C:Enterprise serever worcking process connection helper
+      module Wp
+        extend AbstractRuntime
+        include Abstract
+        def ole_class
+          AssLauncher::Enterprise::Ole::WpConnection
+        end
+      end
+
+      # 1C:Enterprise serever agent connection helper
+      module Agent
+        extend AbstractRuntime
+        include Abstract
+        def ole_class
+          AssLauncher::Enterprise::Ole::AgentConnection
+        end
+      end
+    end
+  end
+end

data/lib/ass_ole/dsl.rb

@@ -0,0 +1,124 @@
+module AssOle
+  # It mixins for {Module}
+  module DSL
+    # rubocop:disable Style/PredicateName
+
+    # Define module as Ole snippet
+    # @example
+    #  module Query
+    #    is_ole_snippet
+    #
+    #    def execute(query)
+    #      q = newObject 'Query', query
+    #      q.exequte
+    #    end
+    #  end
+    #
+    #  class MyOleAccessor
+    #    it_has_ole_runtime
+    #    like_ole_runtime external_connection
+    #
+    #    include Query
+    #
+    #    def get_foo
+    #      text = 'select * from foo where bar'
+    #      result = execute text
+    #    end
+    #  end
+    #
+    #  MyOleAccessor.new.get_foo
+    def is_ole_snippet
+      fail 'Ole snippet must be a Module not a Class' if\
+        self.class == Class
+      extend AssOle::Snippets::IsSnippet
+    end
+
+    # Define class or module which transparent call Ole runtime as self
+    # @example
+    #   info_base = AssMaintainer::InfoBase.new('', 'File="path"')
+    #   class MyOleAccessor
+    #     like_ole_runtime thick_app
+    #
+    #     thick_app.run info_base
+    #
+    #     def hello(s)
+    #       sTring s
+    #     end
+    #   end
+    #
+    #   MyOleAccessor.hello('Ass')
+    def like_ole_runtime(runtime)
+      it_has_ole_runtime runtime
+      case self
+      when Class then
+        include AssOle::Snippets::LikeOleRuntime
+      else
+        extend AssOle::Snippets::LikeOleRuntime
+      end
+    end
+
+    # Define class or module wich include Ole runtime
+    # @example
+    #   info_base = AssMaintainer::InfoBase.new('', 'File="path"')
+    #   class MyOleAccessor
+    #     it_has_ole_runtime thick_app
+    #
+    #     thick_app.run info_base
+    #
+    #     def hello(s)
+    #       ole_connector.sTring s
+    #     end
+    #   end
+    #
+    #   MyOleAccessor.hello('Ass')
+    def it_has_ole_runtime(runtime)
+      case self
+      when Class then
+        include runtime
+      else
+        extend runtime
+      end
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+
+    # Define Ole runtime
+    # @example
+    #  acct_infobase = AssMaintainer::InfoBase.new('name', 'File="path"')
+    #
+    #  module AccountingExternal
+    #    is_ole_runtime :external
+    #  end
+    #
+    #  AccountingExternal.run acct_infobase
+    #
+    #  module MyScript
+    #    like_ole_runtime acct_infobase
+    #
+    #    def self.version
+    #      Metadata.Version
+    #    end
+    #  end
+    #
+    #  puts MyScript.version
+    def is_ole_runtime(type)
+      fail 'Ole runtime is a Module not a Class' if self.class == Class
+      case type
+      when :external then extend AssOle::Runtimes::App::External
+      when :thick then extend AssOle::Runtimes::App::Thick
+      when :thin then extend AssOle::Runtimes::App::Thin
+      when :wp then extend AssOle::Runtimes::Claster::Wp
+      when :agent then extend AssOle::Runtimes::Claster::Agent
+      else fail "Invalid runtime #{type}"
+      end
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity
+
+    # rubocop:enable Style/PredicateName
+  end
+end
+
+# Pathch for include DSL
+class Module
+  include AssOle::DSL
+end

data/lib/ass_ole/snippets.rb

@@ -0,0 +1,86 @@
+module AssOle
+  # Helpers for transparency and friendly
+  # execute 1C:Enterprise Ole connectors methods as
+  # methods a Ryby objects and makes easy for use ruby wrappers over the
+  # long and awkward 1C:Enterprise embedded programming language syntax.
+  # @api private
+  module Snippets
+    GOOD_CONTEXT = AssLauncher::Enterprise::Ole::OLE_CLIENT_TYPES.values
+
+    # :nodoc:
+    class ContextError < StandardError
+      def initialize(ole_class)
+        super "Invalid `ole_connector': #{ole_class}"
+      end
+    end
+
+    def self.fail_if_bad_context(obj)
+      fail ContextError, ole_class(obj) unless good_context? obj
+    end
+
+    def self.good_context?(obj)
+      GOOD_CONTEXT.include? ole_class(obj)
+    end
+    private_class_method :good_context?
+
+    def self.ole_class(obj)
+      obj.ole_connector.class if obj.respond_to? :ole_connector
+    end
+    private_class_method :ole_class
+
+    # @api private
+    module IsSnippet
+      # Helper for pass into 1C ole runtime understandable file system pathes.
+      # This provides method {#real_win_path}
+      # which will be available in snippets
+      module WinPath
+        def real_win_path(path)
+          AssLauncher::Support::Platforms
+            .path(path).realdirpath.win_string
+        end
+      end
+
+      # It worcking via method_missing handler
+      module MethodMissing
+        def method_missing(method, *args)
+          AssOle::Snippets.fail_if_bad_context(self)
+          return ole_connector.send(method, *args) if ole_connector
+        end
+      end
+
+      # Ole ARGV helper for get value over parameters
+      # This provides method `argv` which will be available in snippets
+      module Argv
+        def argv(i)
+          WIN32OLE::ARGV[i]
+        end
+      end
+
+      def included(obj)
+        return if helper?(obj)
+        obj.send(:include, MethodMissing) unless obj.include? MethodMissing
+        obj.send(:include, Argv) unless obj.include? Argv
+        obj.send(:include, WinPath) unless obj.include? WinPath
+      end
+
+      def helper?(obj)
+        obj.class == Module
+      end
+
+      def extended(obj)
+        return if obj == AssOle::Snippets::IsSnippet
+        obj.send(:extend, MethodMissing) unless\
+          obj.singleton_class.include? MethodMissing
+        obj.send(:extend, Argv) unless\
+          obj.singleton_class.include? Argv
+        obj.send(:extend, WinPath) unless\
+          obj.singleton_class.include? WinPath
+      end
+    end
+
+    # @api private
+    module LikeOleRuntime
+      extend IsSnippet
+    end
+  end
+end

data/lib/ass_ole/version.rb

@@ -0,0 +1,4 @@
+#
+module AssOle
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: ass_ole
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leonid Vlasov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ass_launcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: pry
+  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: simplecov
+  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: ass_maintainer-info_base
+  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: Provides features for easy access to 1C:Enterprise applications and 1C:Enterprise
+  servers from Ruby code
+email:
+- leoniv.vlasov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .simplecov
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- ass_ole.gemspec
+- bin/console
+- bin/setup
+- lib/ass_ole.rb
+- lib/ass_ole/dsl.rb
+- lib/ass_ole/snippets.rb
+- lib/ass_ole/version.rb
+homepage: https://github.com/leoniv/ass_ole
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Easy access to 1C:Enterprise apps and servers via Ole
+test_files: []
+has_rdoc: