ass_launcher 0.1.1.alpha → 0.2.0

data/lib/ass_launcher/enterprise/binary_wrapper.rb

@@ -4,29 +4,6 @@ module AssLauncher
   #
   module Enterprise
     require 'ass_launcher/enterprise/cli'
-    # rubocop:disable all
-    # TODO: перенести этот текст в другое место
-    # fucking 1C: команда `CEATEINFOBASE` принимает фаловую строку
-    # соединения в котрой путь должен быть в формате win т.е. H:\bla\bla.
-    # При этом команды `ETERPRISE` и `DESIGNER` понимают и смешаный формат пути:
-    # H:/bla/bla. При передаче команде `CREATEINFOBASE` некорректного пути
-    # база будет создана абы где и в косоль вернется успех $?=0. Какие бывают
-    # некоректные пути:
-    # - (!! Похоже в v 8.3.8 устранили) H:/bla/bla - будет создана база H: где? Да прямо в корне диска H:. Вывод 1С win-xp:
-    #   `Создание информационной базы ("File=H:;Locale = "ru_RU";") успешно завершено`
-    # - (!! Похоже в v 8.3.8 устранили) H:/путь/котрого/нет/имябазы - будет оздана база в каталоге по умолчанию
-    #   с именем InfoBase[N]. Вывод 1С win-xp:
-    #   `Создание информационной базы ("File = "C:\Documents and Settings\vlv\Мои документы\InfoBase41";Locale = "ru_RU";") успешно завершено`
-    #   в linux отработает корректно и попытается содать каталоги или вылитит с
-    #   ошибкой ?$>0
-    # - ../empty.ib - использование относительного пути в win создает базу по
-    #   умолчанию как в предидущем пункте в linux создаст базу empty.ib в текущем
-    #   каталоге при этом вывод 1C в linux:
-    #   `Создание информационной базы ("File=../empty.ib;Locale = "en_US";") успешно завершено`
-    # - H(!! Похоже в v 8.3.8 устранили):\путь\содержит-тире - в win создаст базу H:\путь\содержит вывод 1С:
-    #   `Создание информационной базы ("File=H:\genm\содержит;Locale = "ru_RU";") успешно завершено`
-    #   в linux отработет корректно
-    # rubocop:enable all
 
     # Class for wrapping 1C:Enterprise platform binary executables such as
     # 1cv8.exe and 1cv8c.exe.
@@ -45,16 +22,18 @@ module AssLauncher
         @path = platform.path(binpath).realpath
         fail ArgumentError, "Is not a file `#{binpath}'" unless @path.file?
         fail ArgumentError,
-             "Invalid binary #{@path.basename} for #{self.class}"\
-          unless @path.basename.to_s.upcase == expects_basename.upcase
+             "Invalid binary #{@path.basename} for #{self.class}" unless\
+             @path.basename.to_s.upcase == expects_basename.upcase
       end
 
       # Define version of 1C platform.
-      # @note version parsed from path and may content incorrect value - not
-      #  real 1C platform version see {#extract_version}. In windows,
-      #  if 1C platform instaled in standart directories it work correctly.
-      #  In Linux it have only 2 major
-      #  digits.
+      # @note In Windows version parsed from path and may
+      #  content incorrect value - not
+      #  real 1C platform version see {#extract_version}. For platform > 8.2
+      #  if 1C platform instaled in standart directories it works correctly.
+      #
+      #  In linux version returns from method
+      #  {AssLauncher::Support::Linux.get_pkg_version}
       #
       # @api public
       # @return [Gem::Version]
@@ -77,6 +56,8 @@ module AssLauncher
       #  - In Linux 1V default install into path:
       #    +/opt/1C/v8.3/i386/1cv8+
       def extract_version(realpath)
+        return AssLauncher::Support::Linux.get_pkg_version(realpath) if\
+          platform.linux?
         extracted = realpath.to_s.split('/')[-3]
         extracted =~ /(\d+\.\d+\.?\d*\.?\d*)/i
         extracted = (Regexp.last_match(1).to_s.split('.')\
@@ -144,8 +125,9 @@ module AssLauncher
       private :to_script
 
       def fail_if_wrong_mode(run_mode)
-        fail ArgumentError, "Invalid run_mode `#{run_mode}' for #{self.class}"\
-          unless run_modes.include? run_mode
+        fail ArgumentError,
+          "Invalid run_mode `#{run_mode}' for #{self.class}" unless\
+          run_modes.include? run_mode
         run_mode
       end
       private :fail_if_wrong_mode
@@ -161,133 +143,31 @@ module AssLauncher
 
       # @api public
       # @return (see Cli.defined_modes_for)
-      def run_modes
+      def self.run_modes
         Cli.defined_modes_for(self)
       end
 
-      # @return (see Cli::CliSpec#parameters)
-      def defined_parameters(run_mode)
-        cli_spec(run_mode).parameters
+      # @api public
+      # @return (see Cli.defined_modes_for)
+      def run_modes
+        self.class.run_modes
       end
-      private :defined_parameters
 
       # @api public
-      # @param run_mode [Symbol] run mode 1C binary.
       # @return [Cli::CliSpec]
-      def cli_spec(run_mode = :enterprise)
-        Cli::CliSpec.for(self, fail_if_wrong_mode(run_mode))
+      def cli_spec
+        @cli_spec ||= Cli::CliSpec.for(self)
       end
 
       def build_args(run_mode, &block)
-        arguments_builder = Cli::ArgumentsBuilder\
-                            .new(defined_parameters(run_mode), run_mode)
-        arguments_builder.instance_eval(&block)
-        arguments_builder.builded_args
+        Cli::ArgumentsBuilder.build_args(self, run_mode, &block)
       end
       private :build_args
 
       # Wrapper for 1C thick client binary
       # @api public
-      #
-      # @example
-      #
-      #  script = cl.script(:createinfobase, 'File="path\\new.ib"')
-      #  ph = script.run # this waiting until process executing
-      #  ph.result.expected_assout = /\("File="path\\new.ib";.*"\)/i
-      #  ph.result.verify!
-      #
-      # @example
-      #
-      #  # Get 1C:Enterprise last release for 8.3.6 version:
-      #
-      #  cl = AssLauncher::Enterprise.thick_clients('~> 8.3.6').last
-      #  raise 'Can\'t find 1C binary' if cl.nil?
-      #
-      # @example
-      #
-      #  # Run 1C:Enterprise designer
-      #  # Directly pass parameters:
-      #
-      #  args = ['/F', 'path/to/file/infobase']
-      #  ph = cl.command(:designer, args).run
-      #
-      #  ph.wait.result.assout # => "Информационная база не обнаружена!"
-      #  ph.result.exitstatus # => 0
-      #
-      #  # Fucking 1C: "Информационная база не обнаружена!" but exit with 0 ????
-      #
-      # @example
-      #
-      #  # Dump infobase
-      #  # Directly pass parameters:
-      #
-      #  args = ['/F', 'path/infobase', '/DumpIB', 'dump/path/file.dt']
-      #  cm = cl.command(:designer, args)
-      #
-      #  cm.run.wait.result.verify!
-      #  #=> RunAssResult::RunAssError: Информационная база не обнаружена!
-      #
-      # @example
-      #
-      #  TODO `verify' exaples:
-      #
-      #  # Dump infobase
-      #  # Uses Cli::ArgumentsBuilder:
-      #
-      #  conn_str = AssLauncher::Support::ConnectionString.\
-      #    new('File="//host/infobase"')
-      #
-      #  command = cl.command(:designer) do
-      #    connection_string conn_str
-      #    DumpIB './infobase.dt'
-      #  end
-      #  ph = command.run.wait
-      #
-      #  ph.result.verify!
-      #
-      #  # Crete info base
-      #
-      #  ph = cl.command(:createinfobase) do
-      #    connection_string "File='//host/new.ib';"
-      #    _UseTemplate './application.cf'
-      #    _AddInList
-      #  end.run.wait
-      #
-      #  ph.result.verify!
-      #
-      #  # Check configuration
-      #
-      #  ph = cl.command(:designer) do
-      #    _S '1c-server/infobase'
-      #    _N 'admin'
-      #    _P 'password'
-      #    _CheckConfig do
-      #      _ConfigLogIntegrity
-      #      _IncorrectReferences
-      #      _Extension :all
-      #    end
-      #  end.run.wait
-      #
-      #  ph.result.verify!
-      #
-      #  # Run enterprise Hello World
-      #
-      #  # Prepare external data processor 'processor.epf'
-      #  # Make OnOpen form handler for main form of processor:
-      #  # procedure OnOpen(Cansel)
-      #  #   message("Ass listen:  " + LaunchParameter)
-      #  #   exit()
-      #  # endprocedure
-      #
-      #  ph = cl.command(:enterprise) do
-      #    connection_string 'File="./infobase";Usr="admin";Pwd="password"'
-      #    _Execute './processor.epf'
-      #    _C 'Hello World'
-      #  end.run.wait
-      #
-      #  ph.result.verify!
-      #
-      #  puts ph.result.assout #=> 'Ass listen: Hello World'
+      # @example (see #script)
+      # @example (see #command)
       #
       class ThickClient < BinaryWrapper
         # (see ThinClient#accepted_connstr)
@@ -311,13 +191,105 @@ module AssLauncher
         # @param args (see BinaryWrapper#to_command)
         # @option options (see BinaryWrapper#to_command)
         # @return (see #to_command)
+        # @example
+        #
+        #  # Get 1C:Enterprise last release for 8.3.6 version:
+        #
+        #  cl = AssLauncher::Enterprise.thick_clients('~> 8.3.6').last
+        #  raise 'Can\'t find 1C binary' if cl.nil?
+        #
+        # @example
+        #
+        #  # Run 1C:Enterprise designer
+        #  # Directly pass parameters:
+        #
+        #  args = ['/F', 'path/to/file/infobase', '/L', 'en']
+        #  ph = cl.command(:designer, args).run
+        #
+        #  ph.wait.result.assout # => "Infobase not found!"
+        #  ph.result.exitstatus # => 0
+        #
+        #  # Fucking 1C: "Infobase not found!" but exit with 0 ????
+        #
+        # @example
+        #
+        #  # Dump infobase
+        #  # Directly pass parameters:
+        #
+        #  args = ['/F', 'path/infobase', '/DumpIB', 'dump/path/file.dt', '/L',
+        #         'en']
+        #  cm = cl.command(:designer, args)
+        #
+        #  cm.run.wait.result.verify!
+        #  #=> RunAssResult::RunAssError: Infobase not found!
+        #
+        # @example
+        #
+        #  # Dump infobase
+        #  # Uses Cli::ArgumentsBuilder:
+        #
+        #  conn_str = AssLauncher::Support::ConnectionString.\
+        #    new('File="//host/infobase"')
+        #
+        #  command = cl.command(:designer) do
+        #    connection_string conn_str
+        #    DumpIB './infobase.dt'
+        #  end
+        #  ph = command.run.wait
+        #
+        #  ph.result.verify!
+        # @example
+        #  # Open thick client and attache into debuger
+        #
+        #  conn_str = AssLauncher::Support::ConnectionString.\
+        #    new('srvr="localhost"; ref="infobase"')
+        #
+        #  command = cl.command(:enterprise) do
+        #    connection_string conn_str
+        #    debug
+        #    debuggerUrl 'localhost'
+        #  end
+        #  ph = command.run.wait # Fucking 1C: If infobase not exists
+        #  #will be opened GUI window with info similar 'Inforamation base
+        #  #not found. Create new?" and exit whith status 0
+        #
+        #  #Fucking 1C:
+        #  #USES GUI DIALOG FOR ERROR REPORTING WHEN RUN IN NO GUI MODE
         def command(run_mode, args = [], **options, &block)
           args_ = args.dup
           args_.unshift mode(run_mode)
           args_ += build_args(run_mode, &block) if block_given?
+          verify_createinfobase_param_order! args_ if\
+            run_mode == :createinfobase
           to_command(args_, options)
         end
 
+        # Fucking 1C not check CLI parameter
+        # In create infobase mode create default infobase in user profile
+        # directory if the first parameter is not connection string!!!
+        def verify_createinfobase_param_order!(args)
+          cs = parse_cs args[1]
+          fail ArgumentError, ':createinfobase expects file or server'\
+          " connection string in first argument but given `#{args[1]}'" unless\
+          good_cs?(cs)
+          args
+        end
+        private :verify_createinfobase_param_order!
+
+        def good_cs?(cs)
+          return false unless cs
+          cs.is?(:file) || cs.is?(:server)
+        end
+        private :good_cs?
+
+        def parse_cs(string)
+          AssLauncher::Support::ConnectionString\
+            .new(string.to_s.tr('\'', '"'))
+        rescue AssLauncher::Support::ConnectionString::ParseError
+          nil
+        end
+        private :parse_cs
+
         # Run 1C:Enterprise client as cmd or shell script.
         # @note It waiting for script
         #  execution.
@@ -327,6 +299,14 @@ module AssLauncher
         # @param run_mode (see #command)
         # @param args (see #to_script)
         # @option options (see #to_script)
+        # @example
+        #
+        #  cl = AssLauncher::Enterprise.thick_clients('~> 8.3.6').last
+        #  script = cl.script(:createinfobase, 'File="path\\new.ib"')
+        #  ph = script.run # this waiting until process executing
+        #  ph.result.expected_assout = /\("File="path\\new.ib";.*"\)/i
+        #  ph.result.verify!
+        #
         # @return (see #to_script)
         def script(run_mode, args = '', **options)
           args_ = "#{mode(run_mode)} #{args}"
@@ -336,6 +316,9 @@ module AssLauncher
 
       # Wrapper for 1C thin client binary
       # @api public
+      # @example (see #script)
+      # @example (see #command)
+      #
       class ThinClient < ThickClient
         # Define type of connection_string
         # suitable for 1C binary
@@ -349,6 +332,32 @@ module AssLauncher
         # @param args (see ThickClient#command)
         # @option options (see ThickClient#command)
         # @return (see ThickClient#command)
+        # @example
+        #
+        #  cl = AssLauncher::Enterprise.thin_clients('~> 8.3.6').last
+        #  args = ['/F', 'path/to/file/infobase']
+        #  ph = cl.command(args).run # Fucking 1C: If infobase not exists
+        #  #will be opened GUI window with error info similar 'Inforamation base
+        #  #not found"
+        #
+        #  ph.wait # => waiting wile execiting
+        #  ph.result.exitstatus # => 0
+        #
+        #  # Uses Cli::ArgumentsBuilder:
+        #
+        #  conn_str = AssLauncher::Support::ConnectionString.\
+        #    new('File="//host/infobase"')
+        #
+        #  command = cl.command do
+        #    connection_string conn_str
+        #    debug
+        #    debuggerUrl 'localhost'
+        #  end
+        #  ph = command.run.wait # Fucking 1C: If infobase not exists
+        #  #will be opened GUI window with error info similar 'Inforamation base
+        #  #not found"
+        #
+
         def command(args = [], **options, &block)
           super(:enterprise, args, options, &block)
         end
@@ -358,6 +367,12 @@ module AssLauncher
         # @param args (see ThickClient#script)
         # @option options (see ThickClient#script)
         # @return (see ThickClient#script)
+        # @example
+        #  cl = AssLauncher::Enterprise.thin_clients('~> 8.3.6').last
+        #  script = cl.script('File="path\\new.ib"')
+        #  ph = script.run # this waiting until process executing
+        #  # Fucking 1C: if infobase not exists will be opened GUI window
+        #  #for infobase choice!
         def script(args = '', **options)
           super(:enterprise, args, options)
         end

data/lib/ass_launcher/enterprise/cli/arguments_builder.rb

@@ -4,37 +4,198 @@ module AssLauncher
   module Enterprise
     module Cli
       # @api private
+      # Provides DSL for build arguments for run 1C:Enterprise clients.
+      #
+      # DSL dynamically generated based on CLI specifications {Cli::CliSpec}
+      # For each CLI parameter is assigned a DSL method called
+      # like a parameter but whitout parameter key such as
+      # {TOP_LEVEL_PARAM_KEY} or {NESTED_LEVEL_PARAM_KEY}.
+      # DSL methods may be prefixed +_+ char for
+      # escape uppercase name of method. DSL method +_SomeParameter+ and
+      # +someParameter+ equal and assigned for +/SomParameter+ or
+      # +-SomeParameter+ CLI parameter. DLS methods case insensitive.
+      # Top level builder have method
+      # {IncludeConnectionString#connection_string} for pass connection
+      # string and convert him into arguments array.
+      # @example
+      #  client = AssLauncher::Enterprise.thick_clients('> 0').sort.last
+      #  # Builds arguments for check configuration:
+      #
+      #  # 1) Use #connection_string DLS method
+      #  args = AssLauncher::Enterprise::Cli::ArgumentsBuilder.build_args(
+      #           client, :designer) do
+      #    connection_string 'File="tmp/new.ib";Usr="user";Pwd="password";'
+      #    checkConfig do            # top level CLI parameter '/CheckConfig'
+      #       unreferenceProcedures  # nested parameter '-UnreferenceProcedures'
+      #     end
+      #  end
+      #  args #=> ["/N", "user",\
+      #  # "/P", "password",
+      #  # "/F", "C:/cygwin/home/vlv/workspace/ass_launcher/tmp/new.ib",
+      #  # "/CheckConfig", "", "-UnreferenceProcedures", ""]
+      #
+      #  # 2) Without #connection_string DLS method
+      #  args = AssLauncher::Enterprise::Cli::ArgumentsBuilder.build_args(
+      #            client, :designer) do
+      #    _N 'user'
+      #    _P 'password'
+      #    _F 'tmp/new.ib'
+      #    _CheckConfig do
+      #      _UnreferenceProcedures
+      #    end
+      #  end
+      #  args #=> ["/N", "user",
+      #  # "/P", "password",
+      #  # "/F", "C:/cygwin/home/vlv/workspace/ass_launcher/tmp/new.ib",
+      #  # "/CheckConfig", "", "-UnreferenceProcedures", ""]
+      #
+      # @raise (see #method_missing )
       class ArgumentsBuilder
-        attr_reader :run_mode, :defined_parameters, :builded_args
+        class BuildError < StandardError; end
+        METHOD_TO_PARAM_NAME = /^_/i
+        TOP_LEVEL_PARAM_KEY = '/'
+        NESTED_LEVEL_PARAM_KEY = '-'
 
-        # @param defined_arguments [Parameters::ParamtersList]
-        def initialize(defined_arguments, run_mode)
+        # DSL method {#connection_string} for top level arguments builder
+        # @api public
+        module IncludeConnectionString
+          # DLS method for convert connection string into 1C:Enterprise cli
+          # arguments and add them on the head of arguments array.
+          #
+          # @param conn_str [String
+          #  AssLauncher::Support::ConnectionString::Server
+          #  AssLauncher::Support::ConnectionString::File
+          #  AssLauncher::Support::ConnectionString::Http] connection string
+          #
+          def connection_string(conn_str)
+            conn_str = AssLauncher::Support::ConnectionString\
+                       .new(conn_str) if conn_str.is_a? String
+            args = conn_str_to_args(conn_str)
+            self.builded_args = args + builded_args
+          end
+
+          def conn_str_to_args(conn_str)
+            return conn_str.createinfobase_args if run_mode == :createinfobase
+            conn_str.to_args
+          end
+          private :conn_str_to_args
+        end
+
+        # @param binary_wrapper [AssLauncher::Enterprise::BinaryWrapper]
+        #  subclass
+        # @param run_mode [Symbol]
+        # @return [Array] arguments for run 1C:Enterprise client
+        def self.build_args(binary_wrapper, run_mode, &block)
+          new(binary_wrapper.cli_spec, run_mode).build_args(&block)
+        end
+
+        attr_reader :cli_spec, :params_stack, :parent_parameter, :run_mode
+        private :cli_spec, :params_stack, :parent_parameter, :run_mode
+        attr_accessor :builded_args
+        protected :builded_args, :builded_args=
+
+        # @param cli_spec [CliSpec]
+        # @param parent_parameter [Cli::Parameters] parent for nested params
+        def initialize(cli_spec, run_mode, parent_parameter = nil)
           @builded_args = []
-          @defined_parameters = defined_arguments
+          @cli_spec = cli_spec
+          @parent_parameter = parent_parameter
+          @params_stack = []
           @run_mode = run_mode
         end
 
-        def connection_string(conn_str)
-          conn_str = AssLauncher::Support::ConnectionString.\
-            new(conn_str) if conn_str.is_a? String
-          args = conn_str_to_args(conn_str)
-          args += build_args
+        def defined_parameters
+          cli_spec.parameters(run_mode)
         end
+        private :defined_parameters
 
-        def conn_str_to_args(conn_str)
-          return conn_str.createinfobase_args if run_mode == :createinfobase
-          conn_str.to_args
+        def binary_wrapper
+          cli_spec.binary_wrapper
         end
+        private :binary_wrapper
 
+        # Evaluate &block return array of arguments
+        # @raise [ArgumentError] unless block given
+        def build_args(&block)
+          fail ArgumentError, 'Block require' unless block_given?
+          extend IncludeConnectionString\
+            if (parent_parameter.nil? && run_mode != :webclient)
+          instance_eval(&block)
+          builded_args
+        end
+
+        def nested_builder(parent_parameter)
+          self.class.new(cli_spec, run_mode, parent_parameter)
+        end
+        private :nested_builder
+
+        # @raise [BuildError] if could not find parameter
+        # @raise [BuildError] if argument already build
+        # @raise [ArgumentError] if invlid value passed in parameter
         def method_missing(method, *args, &block)
-          param_name = method_to_param_name(method)
-          FIXME
+          param = param_find(method)
+          fail_no_parameter_error(method) unless param
+          fail_if_parameter_exist(param)
+          add_args(param.to_args(*param_argument_get(param, args)))
+          self.builded_args += nested_builder(param).build_args(&block)\
+            if block_given?
+        end
+
+        def fail_if_parameter_exist(param)
+          fail(BuildError, "Parameter `#{param.full_name}' alrady build.")\
+            if params_stack.include? param
+          params_stack << param
+        end
+        private :fail_if_parameter_exist
+
+        def param_argument_get(param, args)
+          v = args[0, param.arguments_count]
+          fail_wrong_number_arguments(param.full_name, param.arguments_count,
+                                      v.size) if param.argument_require
+          v
+        end
+        private :param_argument_get
+
+        def fail_wrong_number_arguments(name, req, act)
+          fail ArgumentError, "Parameter #{name}"\
+            " wrong number of arguments (#{req} for #{act})" if req != act
+
         end
+        private :fail_wrong_number_arguments
 
-        def method_to_param_name(method)
-          FIXME
+        def add_args(args)
+          self.builded_args = builded_args + args
         end
+        private :add_args
 
+        def fail_no_parameter_error(method)
+          fail BuildError,
+               "CLI parameter `#{to_param_name(method)}' not definded"\
+               " for `#{bw_pesentation}' in `#{run_mode}' run mode."\
+        end
+        private :fail_no_parameter_error
+
+        def bw_pesentation
+          "#{binary_wrapper.class.name.split('::').last}"\
+          " #{binary_wrapper.version}"
+        end
+        private :bw_pesentation
+
+        def param_find(method)
+          defined_parameters.find(to_param_name(method), parent_parameter)
+        end
+        private :param_find
+
+        def to_param_name(method)
+          param_key + method.to_s.gsub(METHOD_TO_PARAM_NAME, '')
+        end
+        private :to_param_name
+
+        def param_key
+          return TOP_LEVEL_PARAM_KEY unless parent_parameter
+          NESTED_LEVEL_PARAM_KEY
+        end
+        private :param_key
       end
     end
   end