hexdata 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0266a1db395723ddaa44a482895c75513d7790c949a27635156ef99fb61578c6
-  data.tar.gz: 6add11f129b3610e7dc2fa5768084fa9ac40c2d8e1a533bb93d61d773139c704
+  metadata.gz: 413471f1ced54e42f6534fce8562a03775b4c6790a8fc42f197ee241b79a683d
+  data.tar.gz: b96f1a4906efe4c5d43fdab5a8602f75dc1523cdfcf3f305fbc6c9a819874a69
 SHA512:
-  metadata.gz: 37f47f6751bef3edd430e09c3f30a98289ca1259384c3c148fbaf384e7a19ca6229a5c838b6683d306abcd1a9429628b92a1cbff107eeb2eb659262890d451ce
-  data.tar.gz: 2fa7ae55ae148c31a74eb36b593f39aa23f98cd2188b3a0897533b9f221c860be6778dfba2aa46c3d675899e784ee521ea53ffea09afb58f28b8c4b5b93106f8
+  metadata.gz: e1a7dd9e589322959c086bf8f4d60a9ffdb1e78cd7c77d2d6c69db65828b6b65b8c24eb4336ac439254ebca4bb84dc74403803f93a9aa289751ab2b4b4a99c17
+  data.tar.gz: d46a1ff5f229e9ecdfe80f57a9a47ea6c83620813d871416080bcb78c509624a6c2a511395bbdce7fd438f431f2ce1959f5a6265e0d7470a8628306c10ef4d46

data/lib/hexdata.rb

@@ -2,63 +2,73 @@
 
 =begin
 
-    This program is free software: you can redistribute it and/or modify
+    This program is free software: yoe can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+    the Free Software Foendation, either version 3 of the License, or
+    (at yoer option) any later version.
 
     This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    but WITHoeT ANY WARRANTY; withoet even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
-    You should have received a copy of the GNU General Public License
+    Yoe shoeld have received a copy of the GNU General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-    Dieses Programm ist Freie Software: Sie können es unter den Bedingungen
-    der GNU General Public License, wie von der Free Software Foundation,
+    Dieses Programm ist Freie Software: Sie koennen es unter den Bedingungen
+    der GNU General Public License, wie von der Free Software Foendation,
     Version 3 der Lizenz oder (nach Ihrer Wahl) jeder neueren
-    veröffentlichten Version, weiter verteilen und/oder modifizieren.
+    veroeffentlichten Version, weiter verteilen und/oder modifizieren.
 
-    Dieses Programm wird in der Hoffnung bereitgestellt, dass es nützlich sein wird, jedoch
-    OHNE JEDE GEWÄHR,; sogar ohne die implizite
-    Gewähr der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
-    Siehe die GNU General Public License für weitere Einzelheiten.
+    Dieses Programm wird in der Hoffnung bereitgestellt, dass es nuetzlich sein wird, jedoch
+    OHNE JEDE GEWaeHR,; sogar ohne die implizite
+    Gewaehr der MARKTFaeHIGKEIT oder EIGNUNG FueR EINEN BESTIMMTEN ZWECK.
+    Siehe die GNU General Public License fuer weitere Einzelheiten.
 
     Sie sollten eine Kopie der GNU General Public License zusammen mit diesem
     Programm erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
 
 =end
 
-=begin
-Examlple:
-hex = HexData.new [":04001000746573742C", ":0D00000048656C6C6F20576F726C642100B6", ":10004000404142434445464748494A4B4C4D4E4F38", ":00000001FF"]  # Open to read
-hex.interpret  # Interpret data
-p hex.ascii  # return string result of the interpret
-p hex.checksum  # return checksum from the first data
-p hex.checksum 1 # return checksum from the second data
-
-hex = HexData.new  # Open to write/read
-hex.push "test"  # Write "test"
-hex.push_end  # Write End of File
-hex.interpret  # Interpret data
-p hex.ascii 0 # return string result of the interpret of the first data
-=end
-
+# 
+# @author Marek K. <mailto:m.k@mk16.de, http://mk16.de>
+# @example
+#   require "hexdata"
+#   hex = HexData.new [":04001000746573742C", ":0D00000048656C6C6F20576F726C642100B6", ":10004000404142434445464748494A4B4C4D4E4F38", ":00000001FF"] # Open to read
+#   hex.interpret # Interpret data
+#   p hex.ascii # return string result of the interpret
+#   p hex.checksum # return checksum from the first data
+#   p hex.checksum 1 # return checksum from the second data
+#   
+#   hex = HexData.new # Open to write/read
+#   hex.push "test" # Write "test"
+#   hex.push_end # Write End of File
+#   hex.interpret # Interpret data
+#   p hex.ascii 0 # return string result of the interpret of the first data 
+# @attr [Integer] push_address The address of the next record in the (Intel) hex file
+# @attr [String] enddef The "end of file" mark
+# @note The file hexdata.rb is available under the {https://www.gnu.org/licenses/gpl.txt GNU GPL v3}.
 class HexData
 
   attr_accessor :push_address, :enddef
 
+  # Initalies the cash register hexdata
+  # @param sets [Array] The (Intel) hex data to be read or edited. Default: []
   def initialize sets=[]
     @sets = sets
     @push_address = 16
     @enddef = ":00000001FF"
   end
   
+  # Returns the records
+  # @note No copy of the array is created. If you edit the arrays, this affects the HexData class. If you want a copy of the array, you can, for example, use the .clone method.
+  # @return [Array] The records returned as an array
   def data
     @sets
   end
   
+  # Evaluate the (Intel) Hex data (interpretation) and make it available for reading.
+  # @return [NilClass] nil
   def interpret
     @ascii = nil.to_a
     @sums = nil.to_a
@@ -95,48 +105,79 @@ class HexData
       @ascii << str if type == "00"
       @sums << sum
     }
+    nil
   end
   
+  # Resets the write address to the default value (16).
+  # @return [NilClass] nil
   def reset_address!
     @push_address = 16
+    nil
   end
   
+  # Writes a string passed by the user to the data.
+  # @param str [String] The user data to be written as a record.
+  # @return [NilClass] nil
   def push_user str
     @sets << str
+    nil
   end
   
+  # The string to be written.
+  # @param index [Integer] The index of the record to be deleted.
+  # @return [NilClass] nil
   def delete_data! index
     @sets.delete_at index
+    nil
   end
   
+  # Resets the hex data. All saved hex data will be deleted. Then HexData is ready to write.
+  # @return [NilClass] nil
   def clear!
     @sets = nil.to_a
     @sums = nil.to_a
     @push_address = 16
+    nil
   end
   
+  # Returns the number of records.
+  # @return [Integer] The number of records.
   def max_index?
     @sets.length
   end
   
+  # Returns the index of the first record that detected an "End of File" markup.
+  # @return [Integer] The index of the first element where an "End of file"-mark was detected.
   def data_end?
     for i in 0...@sets.length
       return i if @sets[i] == @enddef
     end
   end
   
+  # Reads the checksum of a record.
+  # @param index [Integer] The index of the record from which the checksum is to be read. Default: 0
+  # @return [Integer] The read checksum
   def checksum? index=0
     return @sums[index]
   end
   
+  # Reads the result, the ASCII / ANSI text, the evaluation (interpretation).
+  # @param index [Integer] The index of the record to be read. If all is to be read out, nil can be transferred. Default: nil
+  # @return The result of all records, if no index was specified, otherwise only the result of the record from which the index was specified.
   def ascii index=nil
     return (index ? @ascii[index] : @ascii.join(""))
   end
 
+  # Writes the "End of file" mark. This is appended to the end of the records.
+  # @return [NilClass] nil
   def push_end
     @sets << @enddef
+    nil
   end
   
+  # Write a user-entered text to the records as (Intel) Hex.
+  # @param str [String] The text to be written to the records.
+  # @return [NilClass] nil
   def push str
   
     if @push_address > 65535

data/test/hexdata_test.rb

@@ -0,0 +1,119 @@
+# Author: Marek K.
+
+=begin
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+    Dieses Programm ist Freie Software: Sie können es unter den Bedingungen
+    der GNU General Public License, wie von der Free Software Foundation,
+    Version 3 der Lizenz oder (nach Ihrer Wahl) jeder neueren
+    veröffentlichten Version, weiter verteilen und/oder modifizieren.
+
+    Dieses Programm wird in der Hoffnung bereitgestellt, dass es nützlich sein wird, jedoch
+    OHNE JEDE GEWÄHR,; sogar ohne die implizite
+    Gewähr der MARKTFÄHIGKEIT oder EIGNUNG FÜR EINEN BESTIMMTEN ZWECK.
+    Siehe die GNU General Public License für weitere Einzelheiten.
+
+    Sie sollten eine Kopie der GNU General Public License zusammen mit diesem
+    Programm erhalten haben. Wenn nicht, siehe <http://www.gnu.org/licenses/>.
+
+=end
+
+require "test/unit"
+require "hexdata"
+
+class HexDataTest < Test::Unit::TestCase
+    
+    def setup
+        @hd1 = HexData.new [":0C00000048656C6C6F20576F726C6421B7", ":00000001FF"]
+        @hd2 = HexData.new
+    end
+    
+    def test_basic1
+        @hd1.interpret
+        assert_equal @hd1.ascii, "Hello World!"
+        assert_equal @hd1.checksum?, 183
+        assert_equal @hd1.checksum?(1), 255
+        assert_equal @hd1.push_address, 16
+        assert_equal @hd1.enddef, ":00000001FF"
+        assert_equal @hd1.max_index?, 2
+        assert_equal @hd1.data_end?, 1
+    end
+    
+    def test_basic2
+        @hd2.interpret
+        assert_equal @hd2.ascii, ""
+        assert_equal @hd2.push_address, 16
+        assert_equal @hd2.enddef, ":00000001FF"
+        assert_equal @hd2.max_index?, 0
+        assert_equal @hd2.data_end?, 0...0
+    end
+    
+    def test_work1
+        @hd1.delete_data! 0
+        @hd1.interpret
+        
+        assert_equal @hd1.max_index?, 1
+        assert_equal @hd1.data_end?, 0
+        
+        assert_equal @hd1.ascii, ""
+    end
+    
+    def test_work2
+        @hd2.push "Test"
+        @hd2.push_user ":0C00000048656C6C6F20576F726C6421B7"
+        @hd2.push_end
+        @hd2.interpret
+        
+        assert_equal @hd2.ascii, "TestHello World!"
+        assert_equal @hd2.checksum?, 76
+        assert_equal @hd2.checksum?(1), 183
+        assert_equal @hd2.checksum?(2), 255
+    end
+    
+    def test_edit1
+        @hd1.reset_address!
+        assert_equal @hd1.push_address, 16
+    end
+    
+    def test_edit2
+        @hd1.enddef = ":0C00000048656C6C6F20576F726C6421B7"
+        assert_equal @hd1.data_end?, 0
+    end
+    
+    def test_work3
+        @hd1.push_address = 123
+        @hd1.clear!
+        @hd1.interpret
+        
+        assert_equal @hd1.max_index?, 0
+        assert_equal @hd1.data_end?, 0...0
+        assert_equal @hd1.push_address, 16
+        assert_equal @hd1.ascii, ""
+    end
+    
+    def test_work4
+        @hd2.enddef = ":0C00000148656C6C6F20576F726C6421B6"
+        @hd2.push "Test"
+        @hd2.push_end
+        @hd2.interpret
+        
+        assert_equal @hd2.max_index?, 2
+        assert_equal @hd2.data_end?, 1
+        assert_equal @hd2.ascii, "Test"
+        assert_equal @hd2.checksum?, 76
+        assert_equal @hd2.checksum?(1), 182
+        assert_equal @hd2.push_address, 17
+    end
+end

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: hexdata
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Marek K.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-23 00:00:00.000000000 Z
+date: 2018-12-12 00:00:00.000000000 Z
 dependencies: []
-description: |
-  With hexdata you can create and read (Intel) hex data.
-  hexdata also calculates the checksum and calls an exception if it gets wrong.
-  hexdata is available under the GNU GPL v3.0.
+description: With hexdata you can create and read (Intel) hex data.hexdata also calculates
+  the checksum and calls an exception if it gets wrong.hexdata is available under
+  the GNU GPL v3.0.
 email: m.k@mk16.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/hexdata.rb
+- test/hexdata_test.rb
 homepage: http://test.mk16.de/projects/hexdata-gem
 licenses:
 - GPL-3.0