Skip to content

Latest commit

 

History

History
235 lines (146 loc) · 6.53 KB

en.README.md

File metadata and controls

235 lines (146 loc) · 6.53 KB

Code Climate Gem Version

AssLauncher

Ruby wrapper for 1C:Enterprise platform.

Goal of this to make easily and friendly writing scripts for development and support lifecycle of 1C:Enterprise applications

AssLauncher is cross platform but it full tested in Cygwin only!. In Windows and Linux it works too.

In Linux don't support OLE feature. Don't known why I told it ;)

Quick start

Using AssLauncher as a library

Add this line to your application's Gemfile:

gem 'ass_launcher'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ass_launcher

For example, writing script which dumping 1C:Enterprise application

require 'ass_launcher'

include AssLauncher::Api

def main(dupm_path)
  # Get wrapper for the thck client
  thick_client = thicks('~> 8.3.8.0').last

  # Fail if 1C:Enterprise installation not found
  fail '1C:Enterprise not found' if thick_client.nil?

  # Build designer command
  designer = thick_client.command :designer do
    _S 'enterprse_server/application_name'
    dumpIB dupm_path
  end

  # Execute command
  designer.run.wait

  # Verify result
  designer.process_holder.result.verify!
end

main ARGV[0]

Command line utility ass-launcher

From version 0.3.0 AssLauncher provides console tool ass-launcher wich has features:

  • make new 1C:Enterprise application instance (aka information base)
  • run 1C:Enterprise
  • show help about 1C:Enterprise CLI parameters
  • and some more

For more info about ass-launcher execute:

$ass-launcher --help

x86_64 1C:Enterprise for Windows

From v8.3.9 1C provides x86_64 arch platform for Windows.

For choosing which arch of 1C binary you need AssLauncher::Enterprise::BinaryWrapper has arch property and some helpers in AssLauncher::Api like a *_i386 and *_x86_64.

For in-process OLE server v83.ComConnector aka comcntr.dll, arch of 1C binary selects automaticaly in depends of Ruby arch.

On default using of x86_64 1C OLE server is forbidden (see below trouble). For forcing to use x86_64 OLE server set config flag use_x86_64_ole:

  AssLauncher.configure do |conf|
    conf.use_x86_64_ole = true
  end

Trouble with x86_64 in-process OLE server v83.ComConnector

x86_64 in-process OLE server or Ruby win32ole is unstable now and Ruby usually crashed while handling connect error.

Еxample for x86_64 Ruby and 1C OLE server:

$ruby -v
ruby 2.3.6p384 (2017-12-14 revision 9808) [x86_64-cygwin]

$pry

RbConfig::CONFIG['arch'] #=> "x86_64-cygwin"

require 'win32ole'

inproc = WIN32OLE.new('V83.COMConnector')

inproc.connect('invalid connection string')

....*** buffer overflow detected ***: terminated
Aborted (стек памяти сброшен на диск)

The same example for i386 Ruby and 1C OLE server working fine:

$ruby -v
ruby 2.3.6p384 (2017-12-14 revision 9808) [i386-cygwin]

$pry

RbConfig::CONFIG['arch'] #=> "i386-cygwin"

require 'win32ole'

inproc = WIN32OLE.new('V83.COMConnector')

inproc.connect('invalid connection string')

WIN32OLERuntimeError: (in OLE method `connect': )
    OLE error code:80004005 in V83.COMConnector.1
      Неверные или отсутствующие параметры соединения с информационной базой
    HRESULT error code:0x80020009
      Exception occurred.
from (pry):3:in `method_missing'

Trouble with x86_64 local OLE servers v83c.Application and v83.Application

On theory, architecture of local OLE server isn't important for using them in various Ruby architectures.

But it only theory. While in the run exaples in the i386 Ruby with x86_64 local 1C OLE observes the unexpected behavior of 1C OLE servers like a errors while to connect to information base:

WIN32OLERuntimeError: (in OLE method `connect': )
    OLE error code:0 in <Unknown>
      <No Description>
    HRESULT error code:0x80010108
      The object invoked has disconnected from its clients.
    /tmp/ass_launcher/lib/ass_launcher/enterprise/ole/win32ole.rb:87:in `method_missing'
    /tmp/ass_launcher/lib/ass_launcher/enterprise/ole/win32ole.rb:87:in `call'
    /tmp/ass_launcher/lib/ass_launcher/enterprise/ole/win32ole.rb:87:in `block in <class:WIN32OLE>'
    /tmp/ass_launcher/lib/ass_launcher/enterprise/ole.rb:142:in `__try_open__'
    /tmp/ass_launcher/lib/ass_launcher/enterprise/ole.rb:136:in `__open__'
    /tmp/ass_launcher/examples/enterprise_ole_example.rb:131:in `block (4 levels) in <module:EnterpriseOle>'

Usage

Examples

For more usage examples see examples

For beginning look at examples/enterprise_running_example.rb

All examples executable. For run them require 1C:Enterprise platform version defined in Examples::MIN_PLATFORM_VERSION

Run all examples:

$rake run_examples

Or run specified example:

$rake run_examples TEST=examples/enterprise_running_example.rb

Troubles

Directory examples/troubles contains examples which describe troubles with executing 1C:Enterprise binary.

All examples/troubles are executable too.

Run all troubles:

$rake run_trouble_examples

Be careful to run examples/troubles! Learn sources before run it.

Help

If you have any questions open issue with question lable

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Development helper

AssLauncher include bin/dev-helper utility for contributors.

$bin/dev-helper --help

Testing

Run unit tests:

$export SIMPLECOV=YES && rake test

Unit tests is isolated and doesn't require installation of 1C:Enterprise

Run examples:

Examples writed as Minitest::Spec. About run examples see above

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/leoniv/ass_launcher.