hex_file 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee016538fc7729772c64f95536e22e8a8d89628
-  data.tar.gz: 772609a03caa2d743c8feff434152919bf0bd3a5
+  metadata.gz: f77f0154856077426de2b1aa957d8fa12059bb8c
+  data.tar.gz: 7ae2a43b98054b3a4e6ae624dd90eeba2711f971
 SHA512:
-  metadata.gz: 55057f303c055979da2ba2373534934e4ff680e9e935fc0b4b791f1339ad23a6884400db9a2e8ada1eeb80f61812c2e37eeedc53e1ad473e91f2636ba563623a
-  data.tar.gz: 2b0b02349aec901b85a0d48bb31f67c86dd5c4fa2a1ba99240ed81daef1170678f940f3dc84afd844cb40010915d32b345abfb17435473c6b8502d6c93c2d6bb
+  metadata.gz: f3a37457b3590074ebb53fce05f518ae68a22ca2231e2a8b3f8b7b9d5f495f9fc4095b369a78a881c02c3b7d2d8ced387628c9295b2f6377850942f04f3ebe12
+  data.tar.gz: 1dee9a73afb8285e8f7758aa16a79cdf2fe2f5a76a4cabb63ba17f388b9995d8da0012294585816027d05f427be900f060d682bb36d1661bf6de4bb6fb1f3008

data/CONTRIBUTORS.txt

@@ -0,0 +1,3 @@
+Grateful for contributions from
+
+Rogier Lodewijks (https://github.com/eflukx)

data/README.md

@@ -37,12 +37,21 @@ Or install it yourself as:
       puts record.type
       puts record.data
       puts record.checksum
-      puts record.ok?
+      puts record.ok? # true if checksum correct
     end
 
+Also there is a bin script that gives a summary
+
+    $ hex_file_info myfile.hex
+    Format: I32HEX
+    Records: 7133
+    Binary Size (bytes): 113918
+
+Note if you're an rbenv user, don't forget to `rbenv rehash` after installing the gem to make the `hex_file_info` script available.
+
 ## Contributing
 
-1. Fork it ( https://github.com/seandmccarthy/hex_file/fork )
+1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/bin/hex_file_info

@@ -3,18 +3,15 @@
 require 'hex_file'
 require 'optparse'
 
+usage = "\nUsage: #{$0} <hexfile.hex>\n\n"
+
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{$0}"
-  opts.on_tail("-h", "--help", "Show this message") do
-    puts "Usage: #{$0}"
-    exit
-  end
+  opts.banner = usage
 end.parse!
 
 opt = ARGV.pop
-if (opt.nil? || opt == '-h' || opt == '--help')
-  puts "Usage: #{$0} <hexfile.hex>"
-  puts
+if opt.nil?
+  puts usage
   exit
 end
 

data/hex_file.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sean@clanmccarthy.net"]
   spec.summary       = %q{Parses Intel HEX files and gives metadata about the file and records.}
   spec.description   = %q{Parses Intel HEX files and gives metadata about the file and records.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/seandmccarthy/hex_file_info"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/hex_file.rb

@@ -1,6 +1,6 @@
-require 'hex_file/version'
-require 'hex_file/info'
-require 'hex_file/record'
+require_relative 'hex_file/version'
+require_relative 'hex_file/info'
+require_relative 'hex_file/record'
 
 module HexFile
 end

data/lib/hex_file/info.rb

@@ -10,6 +10,15 @@ module HexFile
       @records.each
     end
 
+    def find_record regex
+      regex = Regexp.new(regex, 'i') unless regex.is_a?(Regexp)
+      records.find { |rec| rec.data =~ regex }
+    end
+
+    def serialize
+      records.map(&:raw).join("\n")
+    end
+
     def binary_size
       records.map { |r| r.data_size }.reduce(:+)
     end
@@ -24,15 +33,13 @@ module HexFile
       end
     end
 
-    private
-
     def record_types
       @record_types ||= records.map { |r| r.type }.uniq
     end
 
     def linear_record_types?(record_types)
       record_types.include?(Record::EXTENDED_LINEAR_ADDRESS) ||
-         record_types.include?(Record::START_LINEAR_ADDRESS)
+          record_types.include?(Record::START_LINEAR_ADDRESS)
     end
 
     def start_segment_record_type?(record_types)

data/lib/hex_file/record.rb

@@ -1,18 +1,55 @@
 module HexFile
-  class InvalidRecord < StandardError; end
+  class InvalidRecord < StandardError;
+  end
 
   class Record
+
+    class InvalidLength < InvalidRecord
+    end
+
     DATA = '00'
     END_OF_FILE = '01'
     EXTENDED_SEGMENT_ADDRESS = '02'
     START_SEGMENT_ADDRESS = '03'
     EXTENDED_LINEAR_ADDRESS = '04'
     START_LINEAR_ADDRESS = '05'
-    
+
     attr_reader :type, :byte_count, :address, :data, :checksum
 
     def initialize(record_ascii)
-      parse(record_ascii)
+      fail HexFile::InvalidRecord, 'Missing start code' unless record_ascii.start_with?(':')
+      @byte_count = record_ascii[1..2]
+      @address = record_ascii[3..6]
+      @type = record_ascii[7..8]
+      @data = record_ascii[9..-3]
+      @checksum = record_ascii[-2..-1]
+    end
+    
+    def raw
+      ":#{content}#{@checksum}"
+    end
+
+    def content
+      "#{@byte_count}#{@address}#{@type}#{@data}"
+    end
+
+    def set_hex_data data
+      raise InvalidLength, "Data should be of length #{data_size}!" unless data.length == @data.length
+
+      @data = data
+      update_checksum
+      self
+    end
+
+    def set_data data
+      data = data.unpack('C*') if data.is_a? String # Assume binary string
+      hexdata = data.map{ |d| "%02X" % d }.join
+      
+      set_hex_data hexdata
+    end
+
+    def update_checksum
+      @checksum = "%02X" % calculate_checksum
     end
 
     def data_size
@@ -23,24 +60,14 @@ module HexFile
       @checksum.to_i(16) == calculate_checksum
     end
 
-    private
 
-    def parse(record_ascii)
-      @raw = record_ascii
-      fail HexFile::InvalidRecord, 'Missing start code' unless @raw.start_with?(':')
-      @byte_count = record_ascii[1..2]
-      @address = record_ascii[3..6]
-      @type = record_ascii[7..8]
-      @data = record_ascii[9..-3]
-      @checksum = record_ascii[-2..-1]
+    def calculate_checksum record_content = content
+      256 - (record_content
+                 .scan(/../)
+                 .map { |x| x.to_i(16) }
+                 .reduce(:+)
+      ) & 0xFF
     end
 
-    def calculate_checksum
-      256 -
-        (@raw[1...-2]
-          .scan(/../)
-          .map { |x| x.to_i(16) }
-          .inject(:+)) & 0xFF
-    end
   end
 end

data/lib/hex_file/version.rb

@@ -1,3 +1,3 @@
 module HexFile
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: hex_file
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sean McCarthy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2018-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 description: Parses Intel HEX files and gives metadata about the file and records.
@@ -47,7 +47,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CONTRIBUTORS.txt
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -62,7 +63,7 @@ files:
 - lib/hex_file/version.rb
 - test/test_info.rb
 - test/test_record.rb
-homepage: ''
+homepage: https://github.com/seandmccarthy/hex_file_info
 licenses:
 - MIT
 metadata: {}
@@ -72,17 +73,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: Parses Intel HEX files and gives metadata about the file and records.