butler-mainframe 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5b3e86c2581052e59a8f1e74ff1da11a09ebb3c
-  data.tar.gz: ddb71edc9e79c6b0a487e975f9bf9b2074b80beb
+  metadata.gz: 5dd2c3f32dca8f7e61d0ed59e11d59a158f7ff21
+  data.tar.gz: bc1a34ae83ca18147105f6ada19bf936cc36a417
 SHA512:
-  metadata.gz: 542c1c9854d0163f5562cbc1bf2216ddf5294599362c8a8dc27d8fa2aeb82798c6d12c0dac9b8d2aaec842f3c71628306432e64a45ef3df1b234eacf471a381c
-  data.tar.gz: 2a176d220c4f589313277eb8674c255ce1fff43e0d61a004e8919f9b0406ea0885d0a9cc1e04c59dadfa77fa10c461de0805ad5ea11769c0d49355f2699cf17a
+  metadata.gz: c9dad70f5096a1bc38d53d8e5e9e3176e09ca29452d741e1c1f25158e3e471212227f4276d0d1016ab8f7e836476dadcd9d8b0528a986f05481debbf4b539067
+  data.tar.gz: dfeabba225bcbe7d395ce8cc0c7bf53f4a998c1cea8b4686489362a4b228f0e5ee796114d8850db079ceb8a2b53cc07edb94b268f8efe8a0ec5389614f893e32

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.6.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.5.0...v0.6.0) October 29th, 2015
+------------------------------
+* Improved rails integration
+* Added rails model test with the scaffold generator, see documentation
+* Added env parameter in the configuration file
+* Several little improvements
+
 0.5.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.4.0...v0.5.0) October 26th, 2015
 ------------------------------
 * Moved sensible parameters in a separate yml file (private.yml) do not share it

data/README.md

@@ -160,7 +160,7 @@ My advice is to use navigate method for generic navigation and use a specific mo
 
 ## With Rails
 
-This module can be use on rails project.
+This gem can be use on rails project.
 Add in your gemfile
 
     gem 'butler-mainframe'
@@ -169,11 +169,11 @@ then
 
     bundle install
 
-run generator to copy configuration files suitable for the emulator you need
+run generator to copy configuration files passing your emulator as parameter (default x3270)
 
-    rails g butler:install --emulator=passport
+    rails g butler:install --emulator=pcomm
 
-You should have a model for every function to perform.
+My advice is to have a model for every function.
 In this simple example i have to insert an invoice number on a cics map so i create the invoice model:
 
     rails generate scaffold invoice number:integer
@@ -222,12 +222,49 @@ Class Invoice
 end
 ```
 
-Massive uses or one shot depends on your needs.
-The uses are many and only limited by your imagination!
-Experiment and you'll find the solution right for you :rocket:
+If massive uses or one shot depends on your needs and according to these must be optimized the function.
 
+The uses are many and only limited by your imagination! :rocket:
 
-## Test with rake
+Experiment and you'll find the solution right for you
+
+## Test
+
+### Test models with rails
+
+Add the butler test helper in yours rails config/application.rb before create the resource.
+In this way will be added for you the test cases for that model.
+Available only for the test unit framework.
+
+```ruby
+config.generators do |g|
+  ...
+  g.test_framework  :test_unit
+  g.helper          :butler_mainframe_test
+end
+```
+
+For example if you created the invoice resource:
+
+With rails 4:
+
+    rake test test\models\butler_mainframe_invoice_test.rb
+
+Rails 3 is not tested yet:
+
+    ruby -I test unit butler_mainframe_invoice_test.rb
+
+You should get something like this:
+
+    ** Connection established with PComm A **
+    ...
+    Session closed because started by this process with id 1234
+
+    Finished in 13.044988s, 0.1533 runs/s, 0.3066 assertions/s.
+
+    2 runs, 4 assertions, 0 failures, 0 errors, 0 skips
+
+### Test with rake
 
 Simple embedded tests
 

data/lib/butler-mainframe.rb

@@ -8,7 +8,6 @@
 
 require 'core/configuration'
 require 'core/configuration_dynamic'
-require 'config/config'
 
 module ButlerMainframe
   def self.root
@@ -16,49 +15,28 @@ module ButlerMainframe
   end
 end
 
-# TODO
-# require 'i18n'
-# I18n.load_path=Dir['config/locales/*.yml']
-# I18n.locale = ButlerMainframe.configuration.language
+# This project use monkey patch for 1.8 compatibility
+require 'mainframe/host_base'
 
-env = Rails.env if defined?(Rails)
-env ||= $ARGV[0] if $ARGV
-env ||= "development"
-debug = env == "development" ? true : false
+# puts "Butler Mainframe #{defined?(Rails) ? 'with' : 'without'} Rails" #DEBUG
+if defined?(Rails)
+  # Rails use own configuration file into initializers folder
 
-# require the emulator sub class specified in the config.rb
-require "mainframe/emulators/#{ButlerMainframe.configuration.host_gateway.to_s.downcase}"
-
-
-%w(settings.yml private.yml).each  do |file|
-  filepath = File.join(ButlerMainframe.root,'lib','config',file)
-  ButlerMainframe::Settings.load!(filepath, :env => env) if File.exist? filepath
-end
-
-require 'mainframe/customization/active_record'
-# puts "Extending Host class with #{Host3270::ActiveRecord}" if debug
-# Use monkey patch for 1.8 compatibility
-class ButlerMainframe::Host
-  include Host3270::ActiveRecord
-end
+  # This module adds additional methods useful only for projects rails
+  require 'mainframe/customization/active_record'
+  class ButlerMainframe::HostBase
+    include ButlerMainframe::ActiveRecord
+  end
+else
+  # ...if it is not a rails project load configuration file
+  require 'config/config'
 
-require 'mainframe/customization/generic_functions'
-# puts "Extending Host class with #{Host3270::GenericFunctions}" if debug
-class ButlerMainframe::Host
-  include Host3270::GenericFunctions
-end
+  # require the emulator sub class specified in the config.rb
+  raise "Define your host gateway in the configuration file!" unless ButlerMainframe.configuration.host_gateway
+  require "mainframe/emulators/#{ButlerMainframe.configuration.host_gateway.to_s.downcase}"
 
-if defined?(Host3270::CustomFunctions)
-  # puts "Extending Host class with #{Host3270::CustomFunctions}" if debug
-  class ButlerMainframe::Host
-    include Host3270::CustomFunctions
+  %w(settings.yml private.yml).each  do |file|
+    filepath = File.join(ButlerMainframe.root,'lib','config',file)
+    ButlerMainframe::Settings.load!(filepath, :env => ButlerMainframe.configuration.env) if File.exist? filepath
   end
-end
-
-=begin
-# To test in irb
-require 'butler-mainframe'
-host=ButlerMainframe::Host.new(debug: :full)
-host.scan_page
-host.navigate :next
-=end
+end

data/lib/config/config.rb

@@ -1,6 +1,6 @@
 ButlerMainframe.configure do |config|
-  config.host_gateway   = :x3270
-  config.session_path   = '"C:/Program Files (x86)/wc3270/ws3270.exe" YOUR_HOST_IP -model 2 --'
-  config.timeout        = 6 # In seconds
+  # config.host_gateway   = :x3270
+  # config.session_path   = '"C:/Program Files (x86)/wc3270/ws3270.exe" YOUR_HOST_IP -model 2 --'
+  # config.timeout        = 6 # In seconds
 end
 

data/lib/config/config_EXAMPLE_passport.rb

@@ -4,5 +4,6 @@ ButlerMainframe.configure do |config|
   config.session_url    = 'https://YOUR_HOST_IP/zephyr/Ecomes.zwh?sessionprofile=3270dsp/Sessions/host3270'
   config.session_tag    = 1
   config.timeout        = 6000
+ #config.env            = 'production'
 end
 

data/lib/config/config_EXAMPLE_pcomm.rb

@@ -7,5 +7,6 @@ ButlerMainframe.configure do |config|
   config.session_path   = '"C:/Program Files (x86)/IBM/Personal Communications/pcsws.exe" "C:/Users/YOUR_USER/AppData/Roaming/IBM/Personal Communications/host3270.ws" /Q /H /S=A'
   config.session_tag    = 'A'
   config.timeout        = 6000
+ #config.env            = 'production'
 end
 

data/lib/config/config_EXAMPLE_x3270.rb

@@ -2,5 +2,6 @@ ButlerMainframe.configure do |config|
   config.host_gateway   = :x3270
   config.session_path   = '"C:/Program Files (x86)/wc3270/ws3270.exe" YOUR_HOST_IP -model 2 --'
   config.timeout        = 6 # In seconds
+ #config.env            = 'production'
 end
 

data/lib/core/configuration.rb

@@ -2,7 +2,7 @@ module ButlerMainframe
   class Configuration
     attr_writer :allow_sign_up
 
-    attr_accessor :language, :host_gateway, :browser_path, :session_url, :session_path, :session_tag, :timeout
+    attr_accessor :language, :host_gateway, :browser_path, :session_url, :session_path, :session_tag, :timeout, :env
 
     def initialize
       @language       = :en
@@ -12,6 +12,7 @@ module ButlerMainframe
       @session_path   = ""
       @session_tag    = nil
       @timeout        = 1000
+      @env            = 'development'
     end
 
   end

data/lib/generators/butler/install_generator.rb

@@ -12,12 +12,19 @@ module Butler
 
       def copy_to_local
         copy_file "butler/templates/custom_functions.rb", "config/initializers/butler_custom_functions.rb"
-        copy_file "../config/settings.yml", "config/butler.yml"
+        copy_file "../config/settings.yml",               "config/butler.yml"
+        copy_file "../config/private.yml",                "config/butler_private.yml"
         file = "config/initializers/butler.rb"
         copy_file "../config/config_EXAMPLE_#{options[:emulator]}.rb", file
         append_file file do
           <<-FILE.gsub(/^            /, '')
-            ButlerMainframe::Settings.load!(File.join(Rails.root,'config','butler.yml'), :env => Rails.env)
+            raise "Define your host gateway in the rails initializer file!" unless ButlerMainframe.configuration.host_gateway
+            require "mainframe/emulators/#{ButlerMainframe.configuration.host_gateway.to_s.downcase}"
+
+            %w(butler.yml butler_private.yml).each  do |file|
+              filepath = File.join(Rails.root,'config',file)
+              ButlerMainframe::Settings.load!(filepath, :env => Rails.env) if File.exist? filepath
+            end
           FILE
         end
       end

data/lib/generators/butler/templates/custom_functions.rb

@@ -1,27 +1,16 @@
 # These modules contain extensions for the Host class
-module Host3270
+module ButlerMainframe
   module CustomFunctions
     ### Insert here your custom methods ###
 
     ### Update default generic function ###
-    # def do_enter; exec_command "ENTER" end
-    #
-    # def go_back; exec_command "PA2" end
-    #
-    # def do_confirm; exec_command "PF3" end
-    #
-    # def do_quit; exec_command "CLEAR" end
-    #
-    # def do_erase; exec_command "ERASE EOF" end
-    #
-    # # If you add your static screen you must add it in the navigation method to define how to manage it
+    # If you add your static screen you must add it in the navigation method to define how to manage it
     # def destination_list
-    #   [
-    #       :company_menu,
-    #       :cics_selection,
-    #       :session_login,
-    #       :next,
-    #       :back]
+    #   [:company_menu,
+    #    :cics_selection,
+    #    :session_login,
+    #    :next,
+    #    :back]
     # end
     #
     # # Use navigation method to move through the static screens
@@ -32,91 +21,98 @@ module Host3270
     # # :raise_on_abend   => false raise an exception if an abend is occured
     # def navigate destination, options={}
     #   options = {
+    #       :session_user     => ButlerMainframe::Settings.session_user,
+    #       :session_password => ButlerMainframe::Settings.session_password,
     #       :cics             => ButlerMainframe::Settings.cics,
-    #       :user             => ButlerMainframe::Settings.user,
-    #       :password         => ButlerMainframe::Settings.password,
+    #       :company_menu     => ButlerMainframe::Settings.company_menu,
     #       :raise_on_abend   => false
     #   }.merge(options)
-    #   attempts_number       = ButlerMainframe::Settings.navigation_iterations
+    #   max_attempts_number   = ButlerMainframe::Settings.max_attempts_number
     #   transactions_cics     = ButlerMainframe::Settings.transactions_cics
     #
     #   raise "Destination #{destination} not valid, please use: #{destination_list.join(', ')}" unless destination_list.include? destination
-    #   bol_found = nil
-    #   attempts_number.times do
+    #
+    #   puts "Navigating to #{destination}" if @debug
+    #   destination_found = nil
+    #   attempt_number    = 0
+    #   while !destination_found do
+    #     attempt_number += 1
+    #
     #     if abend?
+    #       puts "Navigate: abend" if @debug
     #       options[:raise_on_abend] ? raise(catch_abend) : do_quit
     #     elsif company_menu?
+    #       puts "Navigating to #{destination} from company menu" if @debug
     #       case destination
     #         when  :cics_selection,
     #             :session_login      then
     #           do_quit
     #         when  :back               then
     #           do_quit
-    #           bol_found = true; break
+    #           destination_found = true
     #         when :next                then
-    #           company_menu
-    #           bol_found = true; break
-    #         when :company_menu        then bol_found = true; break
+    #           company_menu options[:company_menu]
+    #           destination_found = true
+    #         when :company_menu        then destination_found = true
     #         else
     #           # Every other destination is forward
-    #           company_menu
+    #           company_menu options[:company_menu]
     #       end
     #     elsif cics?
+    #       puts "Navigating to #{destination} from cics" if @debug
     #       case destination
     #         when :cics_selection,
     #             :session_login       then
-    #           write ButlerMainframe::Settings.logoff_cics, :y => 1, :x => 1
-    #           do_enter
+    #           execute_cics ButlerMainframe::Settings.logoff_cics
     #         when :back                then
-    #           write ButlerMainframe::Settings.logoff_cics, :y => 1, :x => 1
-    #           do_enter
-    #           bol_found = true; break
+    #           execute_cics ButlerMainframe::Settings.logoff_cics
+    #           destination_found = true
     #         when :next                then
-    #           write transactions_cics[:main_application], :y => 1, :x => 1
-    #           do_enter
-    #           bol_found = true; break
+    #           execute_cics transactions_cics[:main_application]
+    #           destination_found = true
     #         when :company_menu        then
-    #           write transactions_cics[:company_menu], :y => 1, :x => 1
-    #           do_enter
+    #           execute_cics transactions_cics[:company_menu]
     #         else
     #           #If we are in CICS with blank screen start the first transaction
-    #           write transactions_cics[:main_application], :y => 1, :x => 1
-    #           do_enter
+    #           execute_cics transactions_cics[:main_application]
     #       end
     #     elsif cics_selection?
+    #       puts "Navigating to #{destination} from cics selection" if @debug
     #       case destination
-    #         when :cics_selection      then bol_found = true; break
+    #         when :cics_selection      then destination_found = true
     #         when :session_login       then exec_command("PF3")
     #         when :next                then
     #           cics_selection options[:cics] if options[:cics]
-    #           bol_found = true; break
+    #           destination_found = true
     #         when :back                then
     #           exec_command("PF3")
-    #           bol_found = true; break
+    #           destination_found = true
     #         else
     #           cics_selection options[:cics] if options[:cics]
     #       end
     #     elsif session_login?
+    #       puts "Navigating to #{destination} from session login" if @debug
     #       case destination
     #         when :session_login,
-    #             :back                then bol_found = true; break
+    #             :back                then destination_found = true
     #         when :next                then
-    #           session_login options[:user], options[:password] if options[:user] && options[:password]
-    #           bol_found = true; break
+    #           session_login options[:session_user], options[:session_password]
+    #           destination_found = true
     #         else
-    #           session_login options[:user], options[:password] if options[:user] && options[:password]
+    #           session_login options[:session_user], options[:session_password]
     #       end
     #     else
+    #       puts "Navigating to #{destination} from unknown screen" if @debug
     #       # If we do not know where we are...
     #       case destination
-    #         when  :session_login    then
+    #         when  :session_login      then
     #           # ...to come back to the first screen we surely have to go back
     #           go_back
     #         when  :back               then
     #           # ...we can try to go back (not all the screen may go back in the same way)
     #           go_back
-    #           bol_found = true; break
-    #         when :next              then
+    #           destination_found = true
+    #         when :next                then
     #           # ...but we dont know how to move forward
     #           raise "Define how to go forward in the navigation method on generic function module"
     #         else
@@ -124,10 +120,11 @@ module Host3270
     #           raise "Destination #{destination} not defined in the current screen"
     #       end
     #     end
+    #     break if attempt_number > max_attempts_number
     #     wait_session
     #   end
     #
-    #   raise "It was waiting #{destination} map instead of: #{screen_title(:rows => 2).strip}" unless bol_found
+    #   raise "It was waiting #{destination} map instead of: #{screen_title(:rows => 2).strip}" unless destination_found
     # end
     #
     # # Check if we are the first blank cics screen
@@ -141,15 +138,20 @@ module Host3270
     # end
     #
     # # Login to mainframe
-    # # param1 user
-    # # param2 password [sensible data]
-    # def session_login user, password
+    # # param1 user(array)        [text, y, x]
+    # # param2 password(array)    [text, y, x]
+    # def session_login ar_user, ar_password
     #   puts "Starting session login..." if @debug
+    #   user,     y_user,     x_user      = ar_user
+    #   raise "Check session user configuration! #{user} #{y_user} #{x_user}" unless user && y_user && x_user
+    #   password, y_password, x_password  = ar_password
+    #   raise "Check session password configuration! #{password} #{y_password} #{x_password}" unless password && y_password && x_password
+    #
     #   wait_session
     #   #inizializza_sessione
     #   raise "It was waiting session login map instead of: #{screen_title}" unless session_login?
-    #   write user,      :y => 16, :x => 36
-    #   write password,  :y => 17, :x => 36, :sensible_data => true
+    #   write user,      :y => y_user,      :x => x_user
+    #   write password,  :y => y_password,  :x => x_password, :sensible_data => true
     #   do_enter
     # end
     #
@@ -159,12 +161,15 @@ module Host3270
     # end
     #
     # # On this map, we have to select the cics environment
-    # # param1 cics usually is a number
-    # def cics_selection cics
+    # # param1 cics(array)        [text, y, x]
+    # def cics_selection ar_cics
     #   puts "Starting selezione_cics..." if @debug
+    #   cics, y_cics, x_cics = ar_cics
+    #   raise "Check cics configuration! #{cics} #{y_cics} #{x_cics}" unless cics && y_cics && x_cics
+    #
     #   wait_session
     #   raise "It was waiting cics selezion map instead of: #{screen_title}, message: #{catch_message}" unless cics_selection?
-    #   write cics, :y => 23, :x => 14
+    #   write cics, :y => y_cics,   :x => x_cics
     #   do_enter
     #   wait_session 1
     # end
@@ -176,11 +181,14 @@ module Host3270
     #
     # # On this map, we have to select the cics environment
     # # param1 cics usually is a number
-    # def company_menu
+    # def company_menu ar_menu
     #   puts "Starting company menu..." if @debug
+    #   menu, y_menu, x_menu = ar_menu
+    #   raise "Check company menu configuration! #{menu} #{y_menu} #{x_menu}" unless menu && y_menu && x_menu
+    #
     #   wait_session
     #   raise "It was waiting company menu map instead of: #{screen_title}, message: #{catch_message}" unless company_menu?
-    #   write "01", :y => 24, :x => 43
+    #   write menu, :y => y_menu, :x => x_menu
     #   do_enter
     # end
     #
@@ -214,9 +222,24 @@ module Host3270
     #   }.merge(options)
     #   scan(:y1 => 1, :x1 => 1, :y2 => options[:rows], :x2 => 80)
     # end
+    #
+    # def execute_cics name
+    #   write name, :y => 1, :x => 2
+    #   do_enter
+    # end
+    #
+    # def do_enter; exec_command "ENTER" end
+    #
+    # def go_back; exec_command "PA2" end
+    #
+    # def do_confirm; exec_command "PF3" end
+    #
+    # def do_quit; exec_command "CLEAR" end
+    #
+    # def do_erase; exec_command "ERASE EOF" end
   end
 end
 
 class ButlerMainframe::Host
-  include Host3270::CustomFunctions
+  include ButlerMainframe::CustomFunctions
 end

data/lib/generators/rails/butler_mainframe_test/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate butler_helper Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/rails/butler_mainframe_test/butler_mainframe_test_generator.rb

@@ -0,0 +1,5 @@
+class Rails::ButlerMainframeTestGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  hook_for :test_framework
+end

data/lib/generators/test_unit/butler_mainframe_test/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate butler_helper Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/test_unit/butler_mainframe_test/butler_mainframe_test_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/test_unit'
+require 'rails/generators/resource_helpers'
+
+module TestUnit # :nodoc:
+  module Generators # :nodoc:
+    class ButlerMainframeTestGenerator < Base # :nodoc:
+      include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_test_file
+        create_file "test/#{/^4\./ === Rails.version ? 'models' : 'unit'}/butler_mainframe_#{file_name}_test.rb",
+                    <<-FILE.gsub(/^      /, '')
+          require 'test_helper'
+
+          class #{class_name}Test < ActiveSupport::TestCase
+            test "Basic navigation" do
+              params  = {:debug => true, :wait_debug => 0.5}
+              host    = ButlerMainframe::Host.new(params)
+              host.navigate :session_login
+              assert host.session_login?, 'navigate :session_login => this is not the session login'
+
+              host.navigate :next
+              assert !host.session_login?, 'navigate :next => does not pass login screen'
+
+              host.close_session
+              assert host.action[:object] == nil, "Close session failed!"
+            end
+
+            test "#{class_name} navigation" do
+              params  = {:debug => true, :wait_debug => 0.5}
+              host    = ButlerMainframe::Host.new(params)
+
+              #host.navigate :your_starting_screen
+              # WRITE YOUR TEST
+
+              host.close_session
+              assert host.action[:object] == nil, "Close session failed!"
+            end
+          end
+        FILE
+      end
+
+    end
+  end
+end

data/lib/mainframe/customization/active_record.rb

@@ -1,5 +1,5 @@
 # These modules contain extensions for the Host class
-module Host3270
+module ButlerMainframe
   # This module can be use on rails project.
   #
   # Create a polimorphic model:

data/lib/mainframe/customization/generic_functions.rb

@@ -1,25 +1,14 @@
 # These modules contain extensions for the Host class
-module Host3270
+module ButlerMainframe
   module GenericFunctions
 
-    def do_enter; exec_command "ENTER" end
-
-    def go_back; exec_command "PA2" end
-
-    def do_confirm; exec_command "PF3" end
-
-    def do_quit; exec_command "CLEAR" end
-
-    def do_erase; exec_command "ERASE EOF" end
-
     # If you add your static screen you must add it in the navigation method to define how to manage it
     def destination_list
-      [
-      :company_menu,
-      :cics_selection,
-      :session_login,
-      :next,
-      :back]
+      [:company_menu,
+       :cics_selection,
+       :session_login,
+       :next,
+       :back]
     end
 
     # Use navigation method to move through the static screens
@@ -236,6 +225,17 @@ module Host3270
       write name, :y => 1, :x => 2
       do_enter
     end
+
+    def do_enter;   exec_command "ENTER"      end
+
+    def go_back;    exec_command "PA2"        end
+
+    def do_confirm; exec_command "PF3"        end
+
+    def do_quit;    exec_command "CLEAR"      end
+
+    def do_erase;   exec_command "ERASE EOF"  end
+
   end
 
 end

data/lib/mainframe/emulators/passport.rb

@@ -1,5 +1,4 @@
 require 'win32ole'
-require 'mainframe/host_base'
 
 # This class use Rocket 3270 emulator API
 # http://www.zephyrcorp.com/legacy-integration/Documentation/passport_host_integration_objects.htm
@@ -12,37 +11,37 @@ module ButlerMainframe
     def sub_create_object options={}
       str_obj = 'PASSPORT.System'
       puts "#{Time.now.strftime "%H:%M:%S"} Creating object #{str_obj}..." if @debug == :full
-      @action[:ole] = WIN32OLE.new(str_obj)
-      @screen = @action[:ole].Sessions(@session_tag).Screen if sub_object_created?
+      @action[:object] = WIN32OLE.new(str_obj)
+      @screen = @action[:object].Sessions(@session_tag).Screen if sub_object_created?
     end
 
     # Check is session is started
     def sub_object_created?
-      res = @action[:ole] && @action[:ole].Sessions(@session_tag)
+      res = @action[:object] && @action[:object].Sessions(@session_tag)
       puts "#{Time.now.strftime "%H:%M:%S"} Terminal successfully detected" if @debug == :full && res
       res
     end
 
     # Check is session is operative
     def sub_object_ready?
-      res = @action[:ole].Sessions(@session_tag).Connected == -1
+      res = @action[:object].Sessions(@session_tag).Connected == -1
       puts "#{Time.now.strftime "%H:%M:%S"} Session ready" if @debug == :full && res
       res
     end
 
     def sub_name
-      "#{@action[:ole].Name} #{@action[:ole].Sessions(@session_tag).Name}"
+      "#{@action[:object].Name} #{@action[:object].Sessions(@session_tag).Name}"
     end
 
     def sub_fullname
-      "#{sub_name} #{@action[:ole].Sessions(@session_tag).FullName}"
+      "#{sub_name} #{@action[:object].Sessions(@session_tag).FullName}"
     end
 
     #Ends the connection and closes the session
     def sub_close_session
-      @action[:ole].Sessions(@session_tag).Close
-      @action[:ole].Quit
-      @action[:ole] = nil
+      @action[:object].Sessions(@session_tag).Close
+      @action[:object].Quit
+      @action[:object] = nil
     end
 
     #Execute keyboard command like PF1 or PA2 or ENTER ...

data/lib/mainframe/emulators/pcomm.rb

@@ -1,5 +1,4 @@
 require 'win32ole'
-require 'mainframe/host_base'
 
 # This class use IBM personal communication
 # http://www-01.ibm.com/support/knowledgecenter/SSEQ5Y_6.0.0/welcome.html
@@ -14,38 +13,38 @@ module ButlerMainframe
     def sub_create_object options={}
       str_obj = 'PComm.autECLSession'
       puts "#{Time.now.strftime "%H:%M:%S"} Creating object #{str_obj}..." if @debug == :full
-      @action[:ole] = WIN32OLE.new(str_obj)
-      @action[:ole].SetConnectionByName @session_tag
-      @space  = @action[:ole].autECLPS
-      @screen = @action[:ole].autECLOIA
+      @action[:object] = WIN32OLE.new(str_obj)
+      @action[:object].SetConnectionByName @session_tag
+      @space  = @action[:object].autECLPS
+      @screen = @action[:object].autECLOIA
     end
 
     # Check is session is started
     def sub_object_created?
-      res = @action[:ole] && @action[:ole].CommStarted
+      res = @action[:object] && @action[:object].CommStarted
       puts "#{Time.now.strftime "%H:%M:%S"} Terminal successfully detected" if @debug == :full && res
       res
     end
 
     # Check is session is operative
     def sub_object_ready?
-      res = @action[:ole].Ready
+      res = @action[:object].Ready
       puts "#{Time.now.strftime "%H:%M:%S"} Session ready" if @debug == :full && res
       res
     end
 
     def sub_name
-      "PComm #{@action[:ole].Name}"
+      "PComm #{@action[:object].Name}"
     end
 
     def sub_fullname
-      "#{sub_name} #{@action[:ole].ConnType}"
+      "#{sub_name} #{@action[:object].ConnType}"
     end
 
     #Ends the connection and closes the session
     def sub_close_session
-      @action[:ole].StopCommunication
-      @action[:ole] = nil
+      @action[:object].StopCommunication
+      @action[:object] = nil
       # See http://www-01.ibm.com/support/knowledgecenter/SSEQ5Y_6.0.0/com.ibm.pcomm.doc/books/html/admin_guide10.htm?lang=en
       Process.spawn "PCOMSTOP /S=#{@session_tag} /q" if @pid
       # Process.kill 9, @pid #Another way is to kill the process but the session start 2nd process pcscm.exe

data/lib/mainframe/emulators/x3270.rb

@@ -1,5 +1,4 @@
 require 'open3'
-require 'mainframe/host_base'
 
 # This class use X3270, an interesting project open source
 # http://x3270.bgp.nu/Windows/wc3270-script.html
@@ -14,6 +13,7 @@ module ButlerMainframe
       puts "#{Time.now.strftime "%H:%M:%S"} Creating object #{str_obj}..." if @debug == :full
       @action = {}
       @action[:in], @action[:out], @action[:thr] = Open3.popen2e(str_obj)
+      @action[:object] = true
       sleep WAIT_AFTER_START_SESSION
       @pid    = @action[:thr].pid
     end
@@ -44,6 +44,7 @@ module ButlerMainframe
     def sub_close_session
       @action[:in].close
       @action[:out].close
+      @action[:object] = nil
     end
 
     #Execute keyboard command like PF1 or PA2 or ENTER ...

data/lib/mainframe/host_base.rb

@@ -1,7 +1,10 @@
+require 'mainframe/customization/generic_functions'
+
 module ButlerMainframe
   # This is the host class base that contains high level logic
   # It uses sub method that have to be defined in the specific sub class
   class HostBase
+    include ButlerMainframe::GenericFunctions
 
     attr_reader :action, :wait
     attr_accessor :debug
@@ -40,6 +43,10 @@ module ButlerMainframe
 
     # Ends the connection and closes the session
     def close_session
+      # puts "[DEPRECATED] .close_session will no longer be available, please use .quit"
+      quit
+    end
+    def quit
       puts "Closing session with criterion \"#{@close_session}\"" if @debug
       case @close_session
         when :always
@@ -57,6 +64,7 @@ module ButlerMainframe
       end
     end
 
+
     # Sleep time between operations
     def wait_session wait=nil
       sleep(wait || (@debug ? @wait_debug : @wait))

data/test/test.rake

@@ -43,27 +43,31 @@ def simple_iteration options={}
   host          = options[:host] || ButlerMainframe::Host.new(params)
 
   navigate host, :session_login
-
   str_screen1 = host.scan_page
   raise 'host.scan_page' if str_screen1.empty?
+  raise 'navigate :session_login => this is not the session login' unless host.session_login?
 
   navigate host, :next
   str_screen2 = host.scan_page
-  raise 'navigate :next does not pass login screen' if str_screen1 == str_screen2
+  raise 'navigate :next from :session_login => the screen is not changed' if str_screen1 == str_screen2
+
+  raise 'navigate :next => does not pass login screen' if host.session_login?
 
   navigate host, :next
-  str_screen2 = host.scan_page
-  raise 'navigate :next does not pass cics selection' if str_screen1 == str_screen2
+  raise 'navigate :next => does not pass cics selection' if host.cics_selection?
 
   # Go back until the first screen
   navigate host, :session_login
+  raise 'navigate :session_login => this is not the session login' unless host.session_login?
 
-  raise "host.scan row failed"  unless host.scan(:y => 1, :x => 1, :len => 80).size             == 80
-  raise "host.scan area failed" unless host.scan(:y1 => 1, :x1 => 1, :y2 => 3, :x2 => 80).size  == 240
+  raise "host.scan row failed"  unless host.scan(:y  => 1, :x  => 1, :len => ButlerMainframe::Host::MAX_TERMINAL_COLUMNS).size == ButlerMainframe::Host::MAX_TERMINAL_COLUMNS
+  raise "host.scan area failed" unless host.scan(:y1 => 1, :x1 => 1, :y2  => 3, :x2 => ButlerMainframe::Host::MAX_TERMINAL_COLUMNS).size == (ButlerMainframe::Host::MAX_TERMINAL_COLUMNS * 3)
 
   navigate host, :back
+  raise 'navigate :back from :session_login => this is not the session login' unless host.session_login?
 
   navigate host, :company_menu
+  raise 'navigate :company_menu from :session_login => this is not the company menu' unless host.company_menu?
 
   navigate host, :next
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: butler-mainframe
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Marco Mastrodonato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides a virtual butler which can perform your custom tasks
   on a 3270 emulator. Choose your emulator, configure your task and discover a new
@@ -30,13 +30,16 @@ files:
 - lib/config/config_EXAMPLE_x3270.rb
 - lib/config/private.yml
 - lib/config/settings.yml
-- lib/config/settings_EXAMPLE.yml
 - lib/core/configuration.rb
 - lib/core/configuration_dynamic.rb
 - lib/generators/butler/USAGE
 - lib/generators/butler/install_generator.rb
 - lib/generators/butler/templates/custom_functions.rb
 - lib/generators/butler_mainframe.rb
+- lib/generators/rails/butler_mainframe_test/USAGE
+- lib/generators/rails/butler_mainframe_test/butler_mainframe_test_generator.rb
+- lib/generators/test_unit/butler_mainframe_test/USAGE
+- lib/generators/test_unit/butler_mainframe_test/butler_mainframe_test_generator.rb
 - lib/mainframe/customization/active_record.rb
 - lib/mainframe/customization/generic_functions.rb
 - lib/mainframe/emulators/passport.rb

data/lib/config/settings_EXAMPLE.yml

@@ -1,25 +0,0 @@
-defaults: &defaults
-  # The max number of iteration through static screen
-  max_attempts_number: 20
-  session_login_tag:  'EMSP00'                                  # Use a regular expression
-  cics_selection_tag: 'EMSP01'                                  # Use a regular expression
-  cics:               ['7', 23, 14]                             # Text to write at coordinates y, x
-  company_menu:       ['01', 24, 43]
-  logoff_cics:        'cesf logoff'
-  company_menu_tag:   '\*\*       \*\*        \*\*        \*\*' # Use a regular expression
-  # Starts these transactions from blank cics in order to move forward
-  transactions_cics:
-    company_menu:     'vita'
-    main_application: 'life'
-  #foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
-  #  bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
-
-development:
-  <<: *defaults
-
-test:
-  <<: *defaults
-
-production:
-  <<: *defaults
-  cics: ['4', 23, 14]