dfhmdf 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b63e9ac034b94142ef123c5557fe73b860e0f853
-  data.tar.gz: 749a0b27b492e45c7c83fb9c3588160a6e150b9b
+  metadata.gz: 9348a12cf9fb46196a9be3484938e13f3f1d6e69
+  data.tar.gz: 55b130e157490eee7f4f85a76cdb6dc166b168e6
 SHA512:
-  metadata.gz: 9378f25ada91fd1bc9462d9189133c51c13bbc43d33f32b41cc4a241818b730c36fe41545180109c9d5faa4e658585555313f8c3119951bc461004c2c92ca51c
-  data.tar.gz: aea1f18ac9970760998a21538bfc7622a03110545dbe05cf7351357aae8b88a4753e3104eacca9788da43802125140e656f586f0cde7642959a61c51868602bc
+  metadata.gz: fd0be31ab9f0c55fe934776d404f2a807f888e73738c21e39707c4003d6eebe91bfbc967cf8aa239b85c84e4937b04564cbdf840e6b55faf0ff907735d4646f5
+  data.tar.gz: e4d44fe0f1646e974d8719b926e558ba07682e7f148aa3b024026acf9cc01243cc66eb84c8acdb2fefedf100fa3eca34201677f14978469c18d3f2b7b4e5d4d9

data/README.md

@@ -1,29 +1,30 @@
 # dfhmdf
 
-Converts DFHMDF macro specifications into ```text_field``` definitions for use with the (https://github.com/cheezy/te3270/)[TE3270 gem]. The purpose is to eliminate the need for you to count the characters across and down a 3270 screen to determine the X and Y coordinates and the length of each field you wish to define for TE3270.
+Converts DFHMDF macro specifications into ```text_field``` definitions for use with the [TE3270 gem](https://github.com/cheezy/te3270/). The purpose is to eliminate the need for you to count the characters across and down a 3270 screen to determine the X and Y coordinates and the length of each field you wish to define for TE3270.
 
 ## Example
 
-Given a BMS macro source file named ```myscreen.txt``` with the following contents:
+Given a BMS macro source file named ```macro-source``` with the following contents:
 
 ```
 QCKSET   DFHMSD TYPE=MAP,STORAGE=AUTO,MODE=OUT,LANG=COBOL,TIOAPFX=YES
 QCKMAP   DFHMDI SIZE=(24,80),LINE=1,COLUMN=1,CTRL=ALARM
          DFHMDF POS=(1,1),LENGTH=3,ATTRB=(ASKIP,BRT),INITIAL='QCK'
-         DFHMDF POS=(1,26),LENGTH=28,ATTRB=(ASKIP,NORM),                X
+TITLE    DFHMDF POS=(1,26),LENGTH=28,ATTRB=(ASKIP,NORM),                X
               INITIAL='Quick Customer Account Check'
-         DFHMDF POS=(3,1),LENGTH=8,ATTRB=(ASKIP,NORM),INITIAL='Account:'
+HEAD     DFHMDF POS=(3,1),LENGTH=8,ATTRB=(ASKIP,NORM),INITIAL='Account:'
 ACCTNO   DFHMDF POS=(3,13),LENGTH=7,ATTRB=(ASKIP,NORM)
          DFHMDF POS=(4,1),LENGTH=5,ATTRB=(ASKIP,NORM),INITIAL='Name:'
 SURNAME  DFHMDF POS=(4,13),LENGTH=15,ATTRB=(ASKIP,NORM)
 FNAME    DFHMDF POS=(4,30),LENGTH=10,ATTRB=(ASKIP,NORM)
-         DFHMDF POS=(5,1),LENGTH=11,ATTRB=(ASKIP,NORM),INITIAL='Max charge:'
+         DFHMDF POS=(5,1),LENGTH=11,ATTRB=(ASKIP,NORM),                 X
+             INITIAL='Max charge:'                                
 CHG      DFHMDF POS=(5,13),ATTRB=(ASKIP,NORM),PICOUT='$,$$0.00'
 MSG      DFHMDF LENGTH=20,POS=(7,1),ATTRB=(ASKIP,NORM)
          DFHMSD TYPE=FINAL
 ```
 
-run ```dfhmdf`` as a command-line utility:
+run ```dfhmdf``` as a command-line utility:
 
 ```sh
 dfhmdf macro-source > target-file
@@ -32,11 +33,15 @@ dfhmdf macro-source > target-file
 to produce the following output:
 
 ```ruby
-  text_field(:acctno, 4, 13, 7)
-  text_field(:surname, 5, 13, 15)
-  text_field(:fname, 5, 30, 10)
-  text_field(:chg, 6, 13, 8)
-  text_field(:msg, 8, 1, 20)
+text_field(:x2y1, 1, 2, 3)
+text_field(:title, 1, 27, 28)
+text_field(:head, 3, 2, 8)
+text_field(:x5y1, 4, 2, 5)
+text_field(:surname, 4, 14, 15)
+text_field(:fname, 4, 31, 10)
+text_field(:x6y1, 5, 2, 11)
+text_field(:chg, 5, 14, 8)
+text_field(:msg, 7, 2, 20)
 ```
 
 From the example you may surmise:

data/dfhmdf.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
 end

data/lib/convert_dfhmdf.rb

@@ -32,13 +32,9 @@ class ConvertDfhmdf
     @macro_source
   end
 
-  def process_macro dfhmdf_macro
-    parse_tokens tokenize_line dfhmdf_macro
-  end  
-
   def squish str
     str[71] = ' ' unless str.length < 72
-    str.split.join(' ')
+    str[0..70].split.join(' ')
   end  
 
   def macro_source

data/lib/dfhmdf.rb

@@ -1,41 +1,60 @@
 module Dfhmdf  
 
+  # Generate a te3270 text_field declaration using values parsed from a DFHMDF macro.
   def te3270_text_field
-    "text_field(:#{field_label}, #{x_coordinate}, #{y_coordinate}, #{field_length})" 
+    "text_field(:#{field_label}, #{line_position}, #{column_position}, #{field_length})" 
   end  
 
+  # Clear variables to prepare for parsing a DFHMDF macro.
   def clear
     @field_label, @parameter_hash, @parameters, @tokens = nil
     @dfhmdf = false
   end
 
-  def tokenize_line input_line
 
-# Want to split on spaces except when space occurs within single quotes.    
-# Should be able to do it with a regex. Unable to figure it out so far. Using brute force.
-# This regex doesn't work but was as close as I was able to get.
-#    @tokens = [@tokens, input_line.scan(/'.*?'|".*?"|\S+/)].compact.reduce([], :|)
+  # Tokenize an input line from the macro source file. 
+  #
+  # LABEL MACRO OPERAND,OPERAND,OPERAND COMMENT X
+  # 1     2     3                       4       discard
+  def tokenize_line input_line
+    # Want to split on spaces except when space occurs within single quotes.    
+    # Should be able to do it with a regex. Unable to figure it out so far. Using brute force.
+    # This regex doesn't work but was as close as I was able to get.
+    #    @tokens = [@tokens, input_line.scan(/'.*?'|".*?"|\S+/)].compact.reduce([], :|)
+    # +input_line+:: A line of input from the macro source file.
 
     new_tokens = []
     temp = input_line.split
+    new_tokens[0] = temp[0]
+    if temp[0] == 'DFHMDF'
+      start_ix = 1
+    else
+      start_ix = 2
+      new_tokens[1] = temp[1]
+    end    
+    temp = input_line.split(' ')
+    open_quote = false
     for i in 0..temp.length-1 do
       if temp[i] != nil
-        if temp[i].include? "'"
-          temp[i] << ' ' << temp[i+1] unless temp[i+1] == nil
-          temp[i + 1] = nil
-          if new_tokens[i] == nil
-            new_tokens[i] = temp[i]
-          else  
-            new_tokens[i] << temp[i]
-          end   
-        else
-          new_tokens << temp[i]
+        open_quote = true unless temp[i].count("'") % 2 == 0
+        while open_quote
+          if temp[i+1] != nil
+            temp[i] << ' ' << temp[i+1]
+            temp[i+1] = nil
+            temp.compact!
+            open_quote = false if temp[i].count("'") % 2 == 0
+          else
+            open_quote = false  
+          end  
         end  
-      end    
-    end
-    @tokens = [@tokens, new_tokens].compact.reduce([], :|)
+      end
+    end  
+    @tokens = [@tokens, temp].compact.reduce([], :|)
   end  
 
+  # Look at the tokens that were extracted from an input line and determine whether
+  # we are reading a DFHMDF macro. There may or may not be a label (1st token).
+  # +tokens+:: array of tokens extracted from the current input line
   def parse_tokens tokens
     @dfhmdf = false
     if tokens[0] == 'DFHMDF'
@@ -52,9 +71,6 @@ module Dfhmdf
     end  
   end  
 
-
-  def parse_operands operands_as_string
-  #-----------------------------------------------------------------------------
   # Parse the operands in a macro source statement:
   #
   # LABEL MACRO OPERAND,OPERAND,OPERAND COMMENT X
@@ -68,13 +84,12 @@ module Dfhmdf
   # to this...
   # { :pos => [ "6", "18" ], :length => "14", :attrb => [ "ASKIP", "NORM" ], 
   #   :initial => "Hello there" }
-  #-----------------------------------------------------------------------------
+  # +operands_as_string+:: The DFHMDF operands as a single string.
+  def parse_operands operands_as_string
     @operands_hash = {}
-
     # Split on comma except when the comma appears within parentheses.
-    # Couldn't figure out how to make it ignore commas within single quotes,
+    # Couldn't figure out how to make regex ignore commas within single quotes,
     # so it misses PICOUT='$,$$0.00' and similar. Using brute force to handle it.
-
     item = operands_as_string.split(/,(?![^(]*\))/)
     for i in 0..item.length-1
       if item[i].match(/^PICOUT=/)
@@ -101,24 +116,39 @@ module Dfhmdf
     @operands_hash
   end  
 
-  def x_coordinate
-    (@operands_hash != nil && @operands_hash[:pos] && @operands_hash[:pos][0].to_i + 1) || 0
+  
+  # Return the line position of the field as specified in the POS=(line, column) operand of DFHMDF. 
+  # If the position has not been set, return zero.
+  def line_position
+    (@operands_hash != nil && @operands_hash[:pos] && @operands_hash[:pos][0].to_i) || 0
   end  
 
-  def y_coordinate
-    (@operands_hash != nil && @operands_hash[:pos] && @operands_hash[:pos][1].to_i) || 0
+
+  # Return the column position of the field as specified in the POS=(row, column) operand of DFHMDF.
+  # Increment the value by 1 to bypass the attribute byte.
+  # If the value has not been set, return zero.
+  def column_position 
+    (@operands_hash != nil && @operands_hash[:pos] && @operands_hash[:pos][1].to_i + 1) || 0
   end  
 
+
+  # Return the length of the field. This may be specified in the LENGTH= operand of DFHMDF or
+  # derived from the PICOUT= or INTIAL= operand.
   def field_length
     (@operands_hash != nil && @operands_hash[:length] && @operands_hash[:length].to_i) ||
     (@operands_hash != nil && @operands_hash[:initial] && @operands_hash[:initial].length) ||
     (@operands_hash != nil && @operands_hash[:picout] && @operands_hash[:picout].length) || 0
   end  
 
+
+  # Return the field label (name) as specified on the DFHMDF macro. When no label is coded on
+  # the macro, build a name based on the X and Y coordinates, like x20y5 or x9y32.
   def field_label
-    (@field_label == nil && "x#{x_coordinate}y#{y_coordinate}") || @field_label
+    (@field_label == nil && "x#{line_position}y#{column_position}") || @field_label
   end
 
+
+  # True if we are looking at a DFHMDF macro in the input.
   def dfhmdf?
     @dfhmdf
   end    

data/lib/dfhmdf/version.rb

@@ -1,3 +1,3 @@
 module Dfhmdf
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/dfhmdf/convert_dfhmdf_spec.rb

@@ -11,16 +11,16 @@ describe ConvertDfhmdf do
       @screen_def.process_macro 'SURNAME  DFHMDF POS=(4,13),LENGTH=15,ATTRB=(ASKIP,NORM)'
       expect(@screen_def.dfhmdf?).to be(true)
       expect(@screen_def.field_label).to eq('surname')
-      expect(@screen_def.x_coordinate).to eq(5)
-      expect(@screen_def.y_coordinate).to eq(13)
+      expect(@screen_def.line_position).to eq(4)
+      expect(@screen_def.column_position).to eq(14)
       expect(@screen_def.field_length).to eq(15)
     end    
     it "ignores macros other than DFHMDF" do
       @screen_def.process_macro 'QCKSET   DFHMSD TYPE=MAP,STORAGE=AUTO,MODE=OUT,LANG=COBOL,TIOAPFX=YES'
       expect(@screen_def.dfhmdf?).to be(false)
       expect(@screen_def.field_label).to eq('x0y0')
-      expect(@screen_def.x_coordinate).to eq(0)
-      expect(@screen_def.y_coordinate).to eq(0)
+      expect(@screen_def.line_position).to eq(0)
+      expect(@screen_def.column_position).to eq(0)
       expect(@screen_def.field_length).to eq(0)
     end  
   end  
@@ -32,7 +32,7 @@ describe ConvertDfhmdf do
       expect(@screen_def.macro_source).to eq('SURNAME DFHMDF POS=(4,13),LENGTH=15,ATTRB=(ASKIP,NORM)')
     end
 
-    it "stores macro source coded on multiple lines" do
+    it "stores macro source coded on multiple lines, POS first" do
       allow(@screen_def).to receive(:read_line).and_return(
 #                 1         2         3         4         5         6         7         8           
 #        12345678901234567890123456789012345678901234567890123456789012345678901234567890      
@@ -44,6 +44,19 @@ describe ConvertDfhmdf do
       expect(@screen_def.macro_source)
         .to eq('SURNAME DFHMDF POS=(4,13),LENGTH=15,ATTRB=(ASKIP,NORM),INITIAL=\'Name here\'')
     end  
+
+    it "stores macro source coded on multiple lines, INITIAL first" do
+      allow(@screen_def).to receive(:read_line).and_return(
+#                 1         2         3         4         5         6         7         8           
+#        12345678901234567890123456789012345678901234567890123456789012345678901234567890      
+        'SURNAME  DFHMDF INITIAL=\'Name here\',                                   X',
+        '                LENGTH=15,                                             X',
+        '                ATTRB=(ASKIP,NORM),                                    X',
+        '                POS=(4,13)')
+      @screen_def.ingest_macro
+      expect(@screen_def.macro_source)
+        .to eq('SURNAME DFHMDF INITIAL=\'Name here\',LENGTH=15,ATTRB=(ASKIP,NORM),POS=(4,13)')
+    end  
   end  
 
 end

data/spec/lib/dfhmdf/dfhmdf_spec.rb

@@ -25,8 +25,8 @@ describe ScreenDef do
       expect(@screen_def.dfhmdf?).to be(false)
       expect(@screen_def.field_length).to eq(0)
       expect(@screen_def.field_label).to eq('x0y0')
-      expect(@screen_def.x_coordinate).to eq(0)
-      expect(@screen_def.y_coordinate).to eq(0)
+      expect(@screen_def.line_position).to eq(0)
+      expect(@screen_def.column_position).to eq(0)
     end    
   end  
 
@@ -43,8 +43,13 @@ describe ScreenDef do
       end
 
       it "splits properly when the last operand is a quoted string with a space" do
-        expect(@screen_def.tokenize_line("abc de,'fg hi',jkl"))
-          .to eq([ "abc", "de,'fg hi',jkl" ])
+        expect(@screen_def.tokenize_line("abc de,fghi,'jkl mnop'"))
+          .to eq([ "abc", "de,fghi,'jkl mnop'" ])
+      end
+
+      it "splits properly when an operand has multiple embedded spaces" do
+        expect(@screen_def.tokenize_line("abc de,'fg hi jk',lmn"))
+          .to eq([ "abc", "de,'fg hi jk',lmn" ])
       end
     end
   end    
@@ -55,31 +60,23 @@ describe ScreenDef do
         @screen_def.parse_tokens([ 'DFHMDF', 'POS=(4,5),LENGTH=15', 'baz' ])
         expect(@screen_def.dfhmdf?).to be(true)
       end
-    end
 
-    describe "#parse_tokens" do
       it "clears the previous value of field label when none is specified" do
         @screen_def.field_label = 'aardvaark'
         @screen_def.parse_tokens([ 'DFHMDF', 'foo', 'bar' ])
         expect(@screen_def.field_label).to eql('x0y0')
       end
-    end
 
-    describe "#parse_tokens" do
       it "recognizes a DFHMDF macro with a label" do
         @screen_def.parse_tokens([ 'FIELDNAME', 'DFHMDF', 'POS=(4,5),LENGTH=15', 'bar' ])
         expect(@screen_def.dfhmdf?).to be(true)
       end
-    end
 
-    describe "#parse_tokens" do
       it "populates the field label when one is specified" do
         @screen_def.parse_tokens([ 'FIELDNAME', 'DFHMDF', 'POS=(4,5),LENGTH=15', 'bar' ])
         expect(@screen_def.field_label).to eq('fieldname')
       end
-    end
 
-    describe "#parse_tokens" do
       it "ignores source lines that do not contain a DFHMDF macro" do
         @screen_def.parse_tokens [ 'foo', 'bar', 'DFHMDF', 'baz' ]
         expect(@screen_def.dfhmdf?).to eq(false)
@@ -104,10 +101,15 @@ describe ScreenDef do
           .to eq({ :key1 => [ "one", "two" ], :key2 => [ "three", "four" ] })
       end
 
-      it "handles a mix of operand formats" do
+      it "handles operands in the order pos, length, attrb, initial" do
         expect(@screen_def.parse_operands("POS=(6,18),LENGTH=14,ATTRB=(ASKIP,NORM),INITIAL='Hello there'"))
           .to eq({ :pos => [ "6", "18" ], :length => "14", :attrb => [ "ASKIP", "NORM" ], :initial => "Hello there" })
       end
+
+      it "handles operands in the order length, attrb, initial, pos" do
+        expect(@screen_def.parse_operands("LENGTH=14,ATTRB=(ASKIP,NORM),INITIAL='Hello there',POS=(6,18)"))
+          .to eq({ :pos => [ "6", "18" ], :length => "14", :attrb => [ "ASKIP", "NORM" ], :initial => "Hello there" })
+      end
     end    
   end  
 
@@ -118,44 +120,44 @@ describe ScreenDef do
         expect(@screen_def.field_label).to eq('NAME')  
       end  
 
-      it "derives a field label based on x and y coordinates when no label was specified" do
+      it "derives a field label based on line and column positions when no label was specified" do
         @screen_def.field_label = nil
         @screen_def.operands_hash( { :pos => [ "5", "18" ] })
-        expect(@screen_def.field_label).to eq('x6y18')  
+        expect(@screen_def.field_label).to eq('x5y19')  
       end  
     end    
   end  
 
   context "determining field position" do
-    describe "#x_coordinate" do
-      it "returns 0 as the x coordinate if the position has not been determined" do
-        expect(@screen_def.x_coordinate).to eq(0)
+    describe "#line_position" do
+      it "returns 0 as the line if the position has not been determined" do
+        expect(@screen_def.line_position).to eq(0)
       end  
 
-      it "returns 0 as the x coordinate if POS=(x,y) was not specified" do
+      it "returns 0 as the line if POS=(line,column)) was not specified" do
         @screen_def.operands_hash( { :foo => "bar" } )
-        expect(@screen_def.x_coordinate).to eq(0)
+        expect(@screen_def.line_position).to eq(0)
       end  
 
-      it "calculates the x coordinate value skipping the attribute byte" do
+      it "calculates the column position value skipping the attribute byte" do
         @screen_def.operands_hash( { :pos => ["5", "28"] } )
-        expect(@screen_def.x_coordinate).to eq(6)
+        expect(@screen_def.line_position).to eq(5)
       end
     end
 
-    describe "#y_coordinate" do
+    describe "#column_position" do
       it "returns 0 as the y coordinate if the position has not been determined" do
-        expect(@screen_def.y_coordinate).to eq(0)
+        expect(@screen_def.column_position).to eq(0)
       end  
 
-      it "returns 0 as the y coordinate if POS=(x,y) was not specified" do
+      it "returns 0 as the column position if POS=(line,column)) was not specified" do
         @screen_def.operands_hash( { :foo => "bar" } )
-        expect(@screen_def.y_coordinate).to eq(0)
+        expect(@screen_def.column_position).to eq(0)
       end  
 
-      it "returns the y coordinate value from the POS=(x,y) parameter" do
+      it "returns the column position value from the POS=(line,column)) parameter" do
         @screen_def.operands_hash( { :pos => ["5", "28"] } )
-        expect(@screen_def.y_coordinate).to eq(28)
+        expect(@screen_def.column_position).to eq(29)
       end
     end
   end  
@@ -189,19 +191,19 @@ describe ScreenDef do
     it "generates a text_field definition for a field with a LENGTH= specification" do
       @screen_def.field_label = 'myfield'
       @screen_def.operands_hash({ :pos => [ "23", "6" ], :length => "14" })  
-      expect(@screen_def.te3270_text_field).to eql('text_field(:myfield, 24, 6, 14)')
+      expect(@screen_def.te3270_text_field).to eql('text_field(:myfield, 23, 7, 14)')
     end
 
     it "generates a text_field definition for a field with a PICOUT= specification" do
       @screen_def.field_label = 'otherfld'
       @screen_def.operands_hash({ :pos => [ "8", "16" ], :picout => "$$,$$0.00" })  
-      expect(@screen_def.te3270_text_field).to eql('text_field(:otherfld, 9, 16, 9)')      
+      expect(@screen_def.te3270_text_field).to eql('text_field(:otherfld, 8, 17, 9)')      
     end    
 
     it "generates a text_field definition for a field with INITIAL= and no LENGTH=" do
       @screen_def.field_label = 'otherfld'
       @screen_def.operands_hash({ :pos => [ "8", "16" ], :initial => "Hello" })  
-      expect(@screen_def.te3270_text_field).to eql('text_field(:otherfld, 9, 16, 5)')      
+      expect(@screen_def.te3270_text_field).to eql('text_field(:otherfld, 8, 17, 5)')      
     end    
   end 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dfhmdf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dave Nicolette
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Generate text_field specifications for te3270 based on DFHMDF source
 email:
 - davenicolette@gmail.com