butler-mainframe 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd2c3f32dca8f7e61d0ed59e11d59a158f7ff21
-  data.tar.gz: bc1a34ae83ca18147105f6ada19bf936cc36a417
+  metadata.gz: c1b46290497b9756b0b72bbb6f48e92066ff14a7
+  data.tar.gz: 7e131b06d932887b33afd338d200dc69e4a4ba87
 SHA512:
-  metadata.gz: c9dad70f5096a1bc38d53d8e5e9e3176e09ca29452d741e1c1f25158e3e471212227f4276d0d1016ab8f7e836476dadcd9d8b0528a986f05481debbf4b539067
-  data.tar.gz: dfeabba225bcbe7d395ce8cc0c7bf53f4a998c1cea8b4686489362a4b228f0e5ee796114d8850db079ceb8a2b53cc07edb94b268f8efe8a0ec5389614f893e32
+  metadata.gz: eb11baa752d23d1a4cdad52b6fc7f39c434f0343778c656d01cd0782eb2ade4946a9ce0febde6b7a74e8ee8100e79ca63c6d5b9d6ecab0f1909fc6d5661c64db
+  data.tar.gz: a27c4a112f43c927ddb7d7169ca6858bea9a740419ee3e4109d033bd4a99fb83ac7a6a31bbac6b1607a01c88fd011f472ab204a61893d2465627c056b09e0695

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.7.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.6.0...v0.7.0) December 2th, 2015
+------------------------------
+* Now is possible to set erase_before_writing to execute an erase until end of field before writing a text
+* Changed param name in write method: erase_before_writing instead of erase_field_first       => deprecation warning
+* Changed param name in write method: clean_chars_before_writing instead of clean_first_chars => deprecation warning
+* Changed method name: screen_title becomes catch_title to align it to the methods name that provide a similar result => deprecation warning
+
 0.6.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.5.0...v0.6.0) October 29th, 2015
 ------------------------------
 * Improved rails integration

data/README.md

@@ -130,6 +130,10 @@ host.write 'ruby on rails', :y => 6, :x => 15
 # With the hook you can use a regular expression to search a label on the y axis (2 rows up and down)
 # It is usefull when the y position could change (atm it does not use x axis)
 host.write 'ruby on rails', :y => 6, :x => 15, hook: 'SYSTEM='
+
+# write a text erasing the field text currently on the screen. This executes a erase_eof command before writing.
+host.write 'ruby on rails', :y => 6, :x => 15, hook: 'SYSTEM=', erase_before_writing: true
+# If you have to do it permanently, you can set it when you instantiate the object: host = ButlerMainframe::Host.new(erase_before_writing: true)
 ```
 
 ### Navigate
@@ -204,7 +208,7 @@ Class Invoice
         # We develop the function.
         # In this simple case we put a number in a map CICS at row 10 and column 5
         # as option we also choose to erase any previous value in the field
-        @host.write self.number, y: 10, x: 5, erase_field_first: true
+        @host.write self.number, y: 10, x: 5, erase_before_writing: true
 
         # Press enter because the example mainframe program expects it as confirmation
         @host.do_enter
@@ -419,13 +423,6 @@ stdin, stdout, thread = Open3.popen2e('"C:/Program Files (x86)/wc3270/ws3270.exe
 
 Read the methods list documentation: [windows](http://x3270.bgp.nu/Windows/wc3270-script.html) or [unix](http://x3270.bgp.nu/Unix/x3270-script.html)
 
-## ToDo
-
-* <s>Improve unit test</s> **Done** although it is still a simple rake
-* Improve write extending hooks to x axis and other ideas I have in mind
-* Improve static navigation
-* Add meta class to choose your host method name and multi language support as well
-
 ## Found a bug?
 
 If you are having a problem please open an issue. You can also send an email to m.mastrodonato@gmail.com

data/lib/mainframe/customization/generic_functions.rb

@@ -122,7 +122,7 @@ module ButlerMainframe
         wait_session
       end
 
-      raise "It was waiting #{destination} map instead of: #{screen_title(:rows => 2).strip}" unless destination_found
+      raise "It was waiting #{destination} map instead of: #{catch_title(:rows => 2).strip}" unless destination_found
     end
 
     # Check if we are the first blank cics screen
@@ -132,7 +132,7 @@ module ButlerMainframe
 
     # Check if we are on the login mainframe screen
     def session_login?
-      /#{ButlerMainframe::Settings.session_login_tag}/i === screen_title
+      /#{ButlerMainframe::Settings.session_login_tag}/i === catch_title
     end
 
     # Login to mainframe
@@ -147,7 +147,7 @@ module ButlerMainframe
 
       wait_session
       #inizializza_sessione
-      raise "It was waiting session login map instead of: #{screen_title}" unless session_login?
+      raise "It was waiting session login map instead of: #{catch_title}" unless session_login?
       write user,      :y => y_user,      :x => x_user
       write password,  :y => y_password,  :x => x_password, :sensible_data => true
       do_enter
@@ -155,7 +155,7 @@ module ButlerMainframe
 
     # Check the label to know when we are on the cics selection map
     def cics_selection?
-      /#{ButlerMainframe::Settings.cics_selection_tag}/i === screen_title
+      /#{ButlerMainframe::Settings.cics_selection_tag}/i === catch_title
     end
 
     # On this map, we have to select the cics environment
@@ -166,7 +166,7 @@ module ButlerMainframe
       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?
+      raise "It was waiting cics selezion map instead of: #{catch_title}, message: #{catch_message}" unless cics_selection?
       write cics, :y => y_cics,   :x => x_cics
       do_enter
       wait_session 1
@@ -174,7 +174,7 @@ module ButlerMainframe
 
     # Check the label to know when we are on the cics selection map
     def company_menu?
-      /#{ButlerMainframe::Settings.company_menu_tag}/i === screen_title
+      /#{ButlerMainframe::Settings.company_menu_tag}/i === catch_title
     end
 
     # On this map, we have to select the cics environment
@@ -185,7 +185,7 @@ module ButlerMainframe
       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?
+      raise "It was waiting company menu map instead of: #{catch_title}, message: #{catch_message}" unless company_menu?
       write menu, :y => y_menu, :x => x_menu
       do_enter
     end
@@ -214,12 +214,16 @@ module ButlerMainframe
 
     # Get the title usually the first row
     # You can change default option :rows to get more lines starting from the first
-    def screen_title options={}
+    def catch_title options={}
       options = {
           :rows                      => 1
       }.merge(options)
       scan(:y1 => 1, :x1 => 1, :y2 => options[:rows], :x2 => 80)
     end
+    def screen_title options={}
+      show_deprecated_method 'catch_title'
+      catch_title options
+    end
 
     def execute_cics name
       write name, :y => 1, :x => 2

data/lib/mainframe/host_base.rb

@@ -15,28 +15,30 @@ module ButlerMainframe
 
     def initialize options={}
       options = {
-          :session_tag      => ButlerMainframe.configuration.session_tag,
-          :wait             => 0.01,  #wait screen in seconds
-          :wait_debug       => 2,     #wait time for debug purpose
-          :debug            => false,
-          :browser_path     => ButlerMainframe.configuration.browser_path,
-          :session_url      => ButlerMainframe.configuration.session_url,
-          :session_path     => ButlerMainframe.configuration.session_path,
-          :timeout          => ButlerMainframe.configuration.timeout,
-          :close_session    => :evaluate
-                              #:evaluate    if the session is found will not be closed
-                              #:never       never close the session
-                              #:always      the session is always closed
+          :session_tag          => ButlerMainframe.configuration.session_tag,
+          :wait                 => 0.01,  # wait screen in seconds
+          :wait_debug           => 2,     # wait time for debug purpose
+          :debug                => false,
+          :browser_path         => ButlerMainframe.configuration.browser_path,
+          :session_url          => ButlerMainframe.configuration.session_url,
+          :session_path         => ButlerMainframe.configuration.session_path,
+          :timeout              => ButlerMainframe.configuration.timeout,
+          :erase_before_writing => false, # execute an erase until end of field before write a text
+          :close_session        => :evaluate
+                                    #:evaluate    if the session is found will not be closed
+                                    #:never       never close the session
+                                    #:always      the session is always closed
       }.merge(options)
 
-      @debug            = options[:debug]
-      @wait             = options[:wait]
-      @wait_debug       = options[:wait_debug]
-      @session_tag      = options[:session_tag]
-      @close_session    = options[:close_session]
-      @timeout          = options[:timeout]
-      @action           = {}
-      @pid              = nil
+      @debug                = options[:debug]
+      @wait                 = options[:wait]
+      @wait_debug           = options[:wait_debug]
+      @session_tag          = options[:session_tag]
+      @close_session        = options[:close_session]
+      @timeout              = options[:timeout]
+      @erase_before_writing = options[:timeout]
+      @action               = {}
+      @pid                  = nil
 
       create_object options
     end
@@ -80,8 +82,8 @@ module ButlerMainframe
     # It reads one line or an area on the screen according to parameters supplied
     def scan options={}
       options = {
-          :y => nil, :x => nil, :len => nil,
-          :y1 => nil, :x1 => nil, :y2 => nil, :x2 => nil,
+          :y  => nil, :x  => nil, :len => nil,
+          :y1 => nil, :x1 => nil, :y2  => nil, :x2 => nil,
       }.merge(options)
       if options[:len]
         scan_row options[:y], options[:x], options[:len]
@@ -104,18 +106,20 @@ module ButlerMainframe
     #     :check                      => true,
     #     :raise_error_on_check       => true,
     #     :sensible_data              => nil,
-    #     :clean_first_chars          => nil, # clean x chars before writing a value
-    #     :erase_field_first          => nil  # erase first until end of field
+    #     :clean_chars_before_writing => nil, # clean x chars before writing a value
+    #     :erase_before_writing       => nil  # execute an erase until end of field before write a text
     def write text, options={}
+      options = show_deprecated_param(:erase_field_first, :erase_before_writing, options)       if options[:erase_field_first]
+      options = show_deprecated_param(:clean_first_chars, :clean_chars_before_writing, options) if options[:clean_first_chars]
       options = {
           :hook                       => nil,
-          :y                          => nil, #row
-          :x                          => nil, #column
+          :y                          => nil,
+          :x                          => nil,
           :check                      => true,
           :raise_error_on_check       => true,
           :sensible_data              => nil,
-          :clean_first_chars          => nil, # clean x chars before writing a value
-          :erase_field_first          => nil  # erase first until end of field
+          :clean_chars_before_writing => nil,
+          :erase_before_writing       => @erase_before_writing
       }.merge(options)
 
       y           = options[:y]
@@ -124,8 +128,8 @@ module ButlerMainframe
       x         ||= get_cursor_axes[1]
 
       hooked_rows = 2
-      raise "Missing coordinates! y(row)=#{y} x(column)=#{x} " unless x && y
-      raise "Sorry, cannot write null values" unless text
+      raise "Missing coordinates! y(row)=#{y} x(column)=#{x} "  unless x && y
+      raise "Sorry, cannot write null values"                   unless text
 
       bol_written = false
       if options[:hook]
@@ -258,7 +262,7 @@ module ButlerMainframe
           :raise_error_on_check       => true,
           :sensible_data              => nil,
           :clean_first_chars          => nil,
-          :erase_field_first          => nil
+          :erase_before_writing       => nil
       }.merge(options)
       raise "Impossible to write beyond row #{MAX_TERMINAL_ROWS}"       if y > MAX_TERMINAL_ROWS
       raise "Impossible to write beyond column #{MAX_TERMINAL_COLUMNS}" if x > MAX_TERMINAL_COLUMNS
@@ -273,7 +277,7 @@ module ButlerMainframe
         end
       end
 
-      if options[:erase_field_first]
+      if options[:erase_before_writing]
         set_cursor_axes y, x
         do_erase
       end
@@ -295,6 +299,16 @@ module ButlerMainframe
       res
     end
 
+    def show_deprecated_param old, new, params={}
+      #Ruby 2+ caller_locations(1,1)[0].label
+      puts "[DEPRECATION] please use param :#{new} instead of :#{old} for method #{caller[0][/`([^']*)'/, 1]}"
+      # Creating new param with the value of the old param
+      {new => params[old]}.merge(params)
+    end
+    def show_deprecated_method new
+      puts "[DEPRECATION] please use #{new} method instead of #{caller[0][/`([^']*)'/, 1]}"
+    end
+
     # If is called a not existing method there is the chance that an optional module may not have been added
     def method_missing method_name, *args
       raise NoMethodError, "Method #{method_name} not found! Please check you have included any optional modules"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: butler-mainframe
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Marco Mastrodonato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-12-02 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