intel_hex 0.5.1 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85e7256e202e9bd3721b5c2adb25c7b2b8d1072789e6bcb4a5567cf7c4f58a41
-  data.tar.gz: 0c7133a23e85031d8e9320356cf63019b1d14b7a98297f93be859926527da905
+  metadata.gz: 5f4dfc549e66964b205d64f063f38c1dc091e8bfc92755076c9f267d72f50422
+  data.tar.gz: 87e987fd8decf8520c5648ea524d0e79da09c0950a8713c887e8afc66ece629c
 SHA512:
-  metadata.gz: 2e34a69bdf175daef67c3ba8fc0ff78c4d293913abbf66e8d1b909f58c0ce9d205b41f73549ba852863ddc9257f3a54ad07a359d08edff3aec202f7e7277efe9
-  data.tar.gz: c346492af2d9fb5ac4b155cfcbd483be98fde9279f1fc08574327c1a1d9174cbfd855d76b71151bcd532fd1929e21d9ba62c041c90346cdc36b60eacfe86d72f
+  metadata.gz: ec5dd2ac67f7387f4602f2806633f0a26e717ed9a27b35f0ac01baee8a70856a485cbd63fb6a597841b0c29c14653d50daf8c1bb5a225bbd03d2106b73b65317
+  data.tar.gz: cfdace7c69d4f52cea5728b9d38851c6f0da2dc8f6e6e0669d05f99829296c17668e6fb0298d69b38673d5197c2c23a2205500e405a94cdce30b27b9efc2d819

data/README.md

@@ -1,5 +1,5 @@
 # An Intel hex file parser, for Ruby
 
-See the [Wikipedia page on Intel HEX](https://en.wikipedia.org/wiki/Intel_HEX).
+[![rspec test status](https://github.com/jeremycole/intel_hex/actions/workflows/rspec.yml/badge.svg)](https://github.com/jeremycole/intel_hex/actions/workflows/rspec.yml)
 
-[![Build Status](https://travis-ci.org/jeremycole/intel_hex.svg?branch=master)](https://travis-ci.org/jeremycole/intel_hex)
+See the [Wikipedia page on Intel HEX](https://en.wikipedia.org/wiki/Intel_HEX).

data/bin/intel_hex_reader

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'optparse'
 require 'intel_hex'
@@ -9,30 +10,27 @@ require 'pp'
 }
 
 OptionParser.new do |opts|
-  opts.on('--help', 'Print this help.') { puts; puts opts; puts; exit }
-  opts.on('-f', '--filename=FILE', 'Load the specified file.') { |o| @options[:file] = o }
+  opts.on('--help', 'Print this help.') do
+    puts
+    puts opts
+    puts
+    exit
+  end
+  opts.on('-f', '--filename=FILE', 'Load the specified file.') do |o|
+    @options[:file] = o
+  end
 end.parse!
 
-raise "No file specified" unless @options[:file]
+raise 'No file specified' unless @options[:file]
 
 intel_hex_file = IntelHex::FileReader.new(@options[:file])
 
 intel_hex_file.each_record do |record|
-  case record.type
-  when :data
-    record_data = "data=" + record.data.map { |b| "%02x" % b }.join(" ")
-  when :eof
-    record_data = ""
-  else
-    record_data = "value=" + record.send(data.type)
-  end    
-
-  puts "Record type=%-4s offset=%-4d length=%-4d checksum=%-4d %s" % [
+  puts 'Record type=%-4s offset=%-4d length=%-4d checksum=%-4d %s' % [
     record.type,
     record.offset,
     record.length,
     record.checksum,
-    record_data,
+    record.value_s,
   ]
 end
-

data/lib/intel_hex/file_reader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IntelHex
   class FileReader
     def initialize(filename)
@@ -12,7 +14,7 @@ module IntelHex
 
     def each_record
       return to_enum(:each_record) unless block_given?
-  
+
       file = File.open(@filename, 'r')
 
       begin
@@ -25,10 +27,10 @@ module IntelHex
 
       nil
     end
-  
+
     def each_byte_with_address
       return to_enum(:each_byte_with_address) unless block_given?
-  
+
       each_record do |record|
         case record.type
         when :data
@@ -49,4 +51,4 @@ module IntelHex
       nil
     end
   end
-end
+end

data/lib/intel_hex/record.rb

@@ -1,42 +1,51 @@
+# frozen_string_literal: true
+
 module IntelHex
   class MisformattedFileError < RuntimeError; end
-  class InvalidTypeError < RuntimeError; end
-  class InvalidLengthError < RuntimeError; end
-  class InvalidOffsetError < RuntimeError; end
-  class InvalidDataError < RuntimeError; end
-  class InvalidChecksumError < RuntimeError; end
+
+  class ValidationError < StandardError; end
+
+  class InvalidTypeError < ValidationError; end
+
+  class InvalidLengthError < ValidationError; end
+
+  class InvalidOffsetError < ValidationError; end
+
+  class InvalidDataError < ValidationError; end
+
+  class InvalidChecksumError < ValidationError; end
 
   class Record
-    TYPES = [
-      :data,
-      :eof,
-      :esa,
-      :ssa,
-      :ela,
-      :sla,
-    ]
-
-    TYPE_MAP = TYPES.each_with_index.inject({}) { |h, (k, i)| h[k] = i; h }
-  
+    TYPES = %i[
+      data
+      eof
+      esa
+      ssa
+      ela
+      sla
+    ].freeze
+
+    TYPE_MAP = TYPES.each_with_index.each_with_object({}) { |(k, i), h| h[k] = i }
+
     TYPE_DATA_LENGTH = {
       data: (1..255),
       eof: 0,
       esa: 2,
-      ssa: 2,
+      ssa: 4,
       ela: 2,
       sla: 4,
-    }
+    }.freeze
 
     def self.parse(line)
-      raise MisformattedFileError.new("Expected ':' at start of line") unless line[0] == ':'
-      raise MisformattedFileError.new("Line length incorrect") unless line.size >= (1 + 2 + 4 + 2)
+      raise MisformattedFileError, 'Expected \':\' at start of line' unless line[0] == ':'
+      raise MisformattedFileError, 'Line length incorrect' unless line.size >= (1 + 2 + 4 + 2)
 
       length = line[1..2].to_i(16)
-      data_end = (9 + length*2)
+      data_end = (9 + length * 2)
 
       offset = line[3..6].to_i(16)
       type = TYPES[line[7..8].to_i(16)]
-      data = line[9...data_end].split('').each_slice(2).map { |a| a.join.to_i(16) }
+      data = line[9...data_end].chars.each_slice(2).map { |a| a.join.to_i(16) }
       checksum = line[data_end..(data_end + 2)].to_i(16)
 
       Record.new(type, length, offset, data, checksum, line: line, validate: true)
@@ -54,7 +63,7 @@ module IntelHex
 
     def self.type_with_value(type, value)
       record = Record.new(type)
-      record.send((type.to_s + '=').to_sym, value)
+      record.send("#{type}=".to_sym, value)
       record
     end
 
@@ -74,14 +83,10 @@ module IntelHex
       type_with_value(:sla, value)
     end
 
-    attr_reader :length
-    attr_reader :offset
-    attr_reader :type
-    attr_reader :data
-    attr_reader :checksum
-    attr_reader :line
+    attr_reader :length, :offset, :type, :data, :checksum, :line
 
-    def initialize(type, length = 0, offset = 0, data = [], checksum=nil, line: nil, validate: false)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(type, length = 0, offset = 0, data = [], checksum = nil, line: nil, validate: false)
       @type = type
       @length = length
       @offset = offset
@@ -92,17 +97,28 @@ module IntelHex
 
       self.validate if validate
     end
+    # rubocop:enable Metrics/ParameterLists
+
+    def data_s
+      "[#{data.map { |b| '%02x' % b }.join(' ')}]"
+    end
+
+    def value_s
+      return '' if type == :eof
+
+      "#{type}=#{type == :data ? data_s : send(type)}"
+    end
 
     def to_s
-      "#<#{self.class.name} type=#{type} offset=#{offset} length=#{length}>"
+      "#<#{self.class.name} type=#{type} offset=#{offset} length=#{length} #{value_s}>"
     end
 
     def to_ascii
-      ":%02X%04X%02X%s%02X" % [
+      ':%02X%04X%02X%s%02X' % [
         length,
         offset,
         TYPE_MAP[type],
-        data.map { |b| "%02X" % b }.join,
+        data.map { |b| '%02X' % b }.join,
         checksum,
       ]
     end
@@ -111,7 +127,7 @@ module IntelHex
       return @calculated_checksum if @calculated_checksum
 
       sum = length + ((offset & 0xff00) >> 8) + (offset & 0x00ff) + TYPE_MAP[type]
-      sum += data.inject(0) { |s, n| s += n; s }
+      sum += data.sum
 
       @calculated_checksum = (((sum & 0xff) ^ 0xff) + 1) & 0xff
     end
@@ -122,12 +138,10 @@ module IntelHex
     end
 
     def valid?
-      begin
-        validate
-        return true
-      rescue
-        return false
-      end
+      validate
+      true
+    rescue ValidationError
+      false
     end
 
     def validate
@@ -139,12 +153,14 @@ module IntelHex
     end
 
     def validate_type
-      raise InvalidTypeError.new("Type #{type} is invalid") unless TYPE_MAP.include?(type)
+      return if TYPE_MAP.include?(type)
+
+      raise InvalidTypeError, "Type #{type} is invalid"
     end
 
     def validate_offset
-      raise InvalidOffsetError.new("Offset #{offset} is negative") unless offset >= 0
-      raise InvalidOffsetError.new("Offset #{offset} is too large") unless offset <= 255
+      raise InvalidOffsetError, "Offset #{offset} is negative" unless offset >= 0
+      raise InvalidOffsetError, "Offset #{offset} is too large" unless offset < 2**16
     end
 
     def validate_length
@@ -157,20 +173,24 @@ module IntelHex
         return if valid_length.include?(length)
       end
 
-      raise InvalidLengthError.new("Length for type #{type} must be #{valid_length}; #{length} given") 
+      raise InvalidLengthError, "Length for type #{type} must be #{valid_length}; #{length} given"
     end
 
     def validate_data
-      raise InvalidDataError.new("Data length #{data.size} does not match length #{length}") unless data.size == length
+      return if data.size == length
+
+      raise InvalidDataError, "Data length #{data.size} does not match length #{length}"
     end
 
     def validate_checksum
-      raise InvalidChecksumError.new("Checksum value #{checksum} does not match expected checksum #{calculate_checksum}") unless calculate_checksum == checksum
+      return if calculate_checksum == checksum
+
+      raise InvalidChecksumError, "Checksum value #{checksum} does not match expected checksum #{calculate_checksum}"
     end
 
     def each_byte_with_address
       return Enumerator.new(self, :each_byte_with_address) unless block_given?
-  
+
       data.each_with_index do |byte, i|
         yield byte, offset + i
       end
@@ -179,12 +199,12 @@ module IntelHex
     end
 
     def data=(value)
-      raise "Incorrect data type" unless value.is_a?(Array)
-      raise InvalidLengthError.new("Data length #{value.size} too large") unless value.size <= 255
+      raise 'Incorrect data type' unless value.is_a?(Array)
+      raise InvalidLengthError, "Data length #{value.size} too large" unless value.size <= 255
+
       @data = value
       @length = data.size
       @checksum = recalculate_checksum
-      nil
     end
 
     def data_to_uint16(offset = 0)
@@ -192,9 +212,9 @@ module IntelHex
     end
 
     def uint16_to_data(value, offset = 0)
-      self.data[(offset...(offset+2))] = [
+      data[(offset...(offset + 2))] = [
         (value & 0xff00) >> 8,
-        value & 0x00ff
+        value & 0x00ff,
       ]
       @length = data.size
       @checksum = recalculate_checksum
@@ -205,24 +225,24 @@ module IntelHex
     end
 
     def uint32_to_data(value, offset = 0)
-      self.data[(offset...(offset+4))] = [
+      data[(offset...(offset + 4))] = [
         (value & 0xff000000) >> 24,
         (value & 0x00ff0000) >> 16,
         (value & 0x0000ff00) >> 8,
-        value & 0x000000ff
+        value & 0x000000ff,
       ]
       @length = data.size
       @checksum = recalculate_checksum
     end
 
-    alias_method :esa, :data_to_uint16
-    alias_method :ssa, :data_to_uint16
-    alias_method :ela, :data_to_uint16
-    alias_method :sla, :data_to_uint32
+    alias esa data_to_uint16
+    alias ssa data_to_uint32
+    alias ela data_to_uint16
+    alias sla data_to_uint32
 
-    alias_method :esa=, :uint16_to_data
-    alias_method :ssa=, :uint16_to_data
-    alias_method :ela=, :uint16_to_data
-    alias_method :sla=, :uint32_to_data
+    alias esa= uint16_to_data
+    alias ssa= uint32_to_data
+    alias ela= uint16_to_data
+    alias sla= uint32_to_data
   end
-end
+end

data/lib/intel_hex/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IntelHex
-  VERSION = '0.5.1'
+  VERSION = '0.5.5'
 end

data/lib/intel_hex.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module IntelHex
 end
 
 require 'intel_hex/version'
 require 'intel_hex/record'
-require 'intel_hex/file_reader'
+require 'intel_hex/file_reader'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: intel_hex
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.5
 platform: ruby
 authors:
 - Jeremy Cole
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-17 00:00:00.000000000 Z
+date: 2021-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: An Intel hex file parser for (e.g. AVR) working with firmware files
 email: jeremy@jcole.us
 executables:
@@ -50,14 +78,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Parser for Intel hex files