hex_file 0.0.1

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hex_file.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sean McCarthy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# HexFile
+
+Parses Intel HEX files and gives metadata about the file and records.
+
+See http://en.wikipedia.org/wiki/Intel_HEX for information on the file format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hex_file'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hex_file
+
+## Usage
+
+    info = HexFile::Info.new(File.open('myfile.hex', 'r'))
+
+    info.format
+    # I8HEX
+
+    info.binary_size
+    # 12134
+
+    info.records.each do |record|
+      puts record.data_size
+      puts record.byte_count
+      puts record.address
+      puts record.type
+      puts record.data
+      puts record.checksum
+      puts record.ok?
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/seandmccarthy/hex_file/fork )
+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`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*.rb'
+end

data/bin/hex_file_info

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'hex_file'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0}"
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts "Usage: #{$0}"
+    exit
+  end
+end.parse!
+
+opt = ARGV.pop
+if (opt.nil? || opt == '-h' || opt == '--help')
+  puts "Usage: #{$0} <hexfile.hex>"
+  puts
+  exit
+end
+
+unless File.exists?(opt)
+  $stderr.puts "#{opt} not found"
+  exit(1)
+end
+
+info = HexFile::Info.new(File.open(opt, 'r'))
+puts <<EOD
+Format: #{info.format}
+Records: #{info.records.count}
+Binary Size (bytes): #{info.binary_size}
+EOD

data/bin/hex_file_info.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib")
+require 'hex_file_reader'
+
+HexFileReader::Parse.new(File.open(ARGV[0]))

data/hex_file.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hex_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hex_file"
+  spec.version       = HexFile::VERSION
+  spec.authors       = ["Sean McCarthy"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/hex_file.rb

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

data/lib/hex_file/info.rb

@@ -0,0 +1,42 @@
+module HexFile
+  class Info
+    def initialize(input_stream)
+      @records = input_stream.readlines.map do |record_line|
+        Record.new(record_line.strip)
+      end
+    end
+
+    def records
+      @records.each
+    end
+
+    def binary_size
+      records.map { |r| r.data_size }.reduce(:+)
+    end
+
+    def format
+      if linear_record_types?(record_types)
+        'I32HEX'
+      elsif start_segment_record_type?(record_types)
+        'I16HEX'
+      else
+        'I8HEX'
+      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)
+    end
+
+    def start_segment_record_type?(record_types)
+      record_types.include?(Record::START_SEGMENT_ADDRESS)
+    end
+  end
+end

data/lib/hex_file/invalid_record.rb

@@ -0,0 +1,3 @@
+module HexFile
+  class InvalidRecord < Error; end
+end

data/lib/hex_file/record.rb

@@ -0,0 +1,46 @@
+module HexFile
+  class InvalidRecord < StandardError; end
+
+  class Record
+    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)
+    end
+
+    def data_size
+      @byte_count.to_i(16)
+    end
+
+    def ok?
+      @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]
+    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

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

data/test/test_info.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require 'hex_file/info'
+require 'hex_file/record'
+require 'stringio'
+
+class TestInfo < MiniTest::Unit::TestCase
+  def setup
+    string_io = StringIO.new(<<EOS)
+:100083000227EFE5C754F84401F5C77901220000C0
+:0300300002337A1E
+EOS
+    @info = HexFile::Info.new(string_io)
+  end
+
+  def test_records
+    assert_equal @info.records.count, 2
+  end
+
+  def test_record_iteration
+    @info.records.each do |record|
+      assert record.ok?
+    end
+  end
+
+  def test_binary_size
+    assert_equal @info.binary_size, 19
+  end
+
+  def test_format_i32hex
+    info = HexFile::Info.new(StringIO.new(':02000004FFFFFC'))
+    assert_equal info.format, 'I32HEX'
+  end
+
+  def test_format_i16hex
+    info = HexFile::Info.new(StringIO.new(':0400000300003800C1'))
+    assert_equal info.format, 'I16HEX'
+  end
+
+  def test_format_i8hex
+    assert_equal @info.format, 'I8HEX'
+  end
+end

data/test/test_record.rb

@@ -0,0 +1,46 @@
+require 'minitest/autorun'
+require 'hex_file/record'
+
+class TestRecord < MiniTest::Unit::TestCase
+  def setup
+    @record = HexFile::Record.new(':0300300002337A1E')
+  end
+
+  def test_type
+    assert_equal HexFile::Record::DATA, @record.type
+  end
+
+  def test_record_ok
+    assert @record.ok?
+  end
+
+  def test_data_size
+    assert_equal @record.data_size, 3
+  end
+
+  def test_byte_count
+    assert_equal @record.byte_count, '03'
+  end
+
+  def test_data
+    assert_equal @record.data, '02337A'
+  end
+
+  def test_address
+    assert_equal @record.address, '0030'
+  end
+
+  def test_checksum
+    assert_equal @record.checksum, '1E'
+  end
+
+  def test_bad_checksum
+    assert !HexFile::Record.new(':0300300002337AFF').ok?
+  end
+
+  def test_invalid_record
+    assert_raises HexFile::InvalidRecord do
+      HexFile::Record.new('')
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: hex_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean McCarthy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-19 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.
+email:
+- sean@clanmccarthy.net
+executables:
+- hex_file_info
+- hex_file_info.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/hex_file_info
+- bin/hex_file_info.rb
+- hex_file.gemspec
+- lib/hex_file.rb
+- lib/hex_file/info.rb
+- lib/hex_file/invalid_record.rb
+- lib/hex_file/record.rb
+- lib/hex_file/version.rb
+- test/test_info.rb
+- test/test_record.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Parses Intel HEX files and gives metadata about the file and records.
+test_files:
+- test/test_info.rb
+- test/test_record.rb