rbstruct 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDFiYzI0YjkyMDg3MzFjZmI4ZGI5ZTEyOGI4OThkMTA4MWRmM2VjNQ==
+  data.tar.gz: !binary |-
+    NjNkYmUxYjVkNGEwN2QxNGNmOWJmZWZkZjlmNGI4YzJjOGYzYzg5MQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTU3NmUwNzZlZjM5NTM0MTVlMjRlYmRlZTZjNTYyNmI3MTM1N2VmYWU2YjUx
+    ZDQ3NzZiYzRmNjhiMWZlMGE4NjI5YmQxY2QxODYxZGVlZjVhYmY1MTJiOGE5
+    MWJhZWM4YzRiMTJkMDU0ZTgxNjNkMjBhNWI2Njg3ZTY0NzJjYmM=
+  data.tar.gz: !binary |-
+    YzAxMWQ0MzIzZmU2Y2E5Mzg3NmNkMDY2NzI5ZGQ2OTA0ODg1MWJkOGU2Zjg3
+    OTEzODI5NmFhOWRkNzJmMWZmMTAyYjY1NjU0MTljZTBlZmIwNmRlNzFiMjNi
+    NjAxMjY0ZWQ4MmUyYTczYWVkNDc3ZGU2NWE4YzkxZDMxYzJlYjc=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+  - 2.2.3
+script: bundle exec rake spec
+before_deploy:
+  - bundle exec rake build
+  - export GEM_FILE="$(ls -1 pkg/*.gem | tail -n1)"
+deploy:
+  - provider: rubygems
+    api_key: $RUBYGEMS_KEY
+    gem: rbstruct
+    on:
+      tags: true
+      repo: kaffepanna/rbstruct
+  - provider: releases
+    api_key:
+      secure: $GITHUB_TOKEN
+    file: ${GEM_FILE}
+    file_glob: true
+    on:
+      tags: true
+      repo: kaffepanna/rbstruct

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Patrik Pettersson
+
+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,41 @@
+# Rbstruct
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbstruct`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbstruct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rbstruct
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbstruct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rbstruct"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/gpt.rb

@@ -0,0 +1,46 @@
+$:.unshift File.join(File.dirname(__FILE__),'../lib')
+require 'rbstruct'
+dev = ARGV[0]
+
+raise Exception.new('No dev') unless dev
+
+GptHeader = RbStruct do
+  unsigned_char :signature, 8
+  unsigned_int  :revision
+  unsigned_int  :header_size
+  unsigned_int  :crc32
+  unsigned_int  :revserved
+  unsigned_long :current_lba
+  unsigned_long :backup_lba
+  unsigned_long :first_lba
+  unsigned_long :last_lba
+  unsigned_char :guid, 16
+  unsigned_long :partition_array_lba
+  unsigned_int  :n_partition_array
+  unsigned_int  :partition_entry_size
+  unsigned_int  :partition_array_crc32
+end
+
+GptPartEntry = RbStruct do
+  unsigned_char :part_type_guid, 16
+  unsigned_char :part_guid, 16
+  unsigned_long :last_lba
+  unsigned_long :attributes
+  unsigned_char :name, 72
+end
+
+
+
+file = open(dev, 'r+')
+
+file.seek(512)
+header = RbStruct::read_struct(file, GptHeader).first
+
+file.seek(512*header.backup_lba)
+backup = RbStruct::read_struct(file, GptHeader).first
+
+puts "Primary header"
+puts header.inspect
+puts "----------------------------------------"
+puts "Backup header"
+puts backup.inspect

data/lib/rbstruct/rbstruct.rb

@@ -0,0 +1,153 @@
+module RbStruct
+
+TYPES = {
+					:float	=> {:size => 4, :str => 'f'},
+			    :int		=> {:size => 4, :str => 'i'},
+					:short  => {:size => 2, :str => 's'},
+					:char		=> {:size => 1, :str => 'c'},
+					:unsigned_char => {:size => 1, :str => "C"},
+					:unsigned_short => {:size => 2, :str => "S"},
+					:unsigned_int => {:size => 4, :str => "I"},
+					:unsigned_long => {:size => 8, :str => "L_"}
+				}
+
+
+
+class StructBase < Array
+	class << self; attr_reader :format_string, :fields, :bsize, :size end
+
+	protected
+
+	TYPES.each_key do |type|
+		class_eval  %{
+			def self.#{type}(name, size=1)
+				field_add(:#{type}, name, size)
+			end
+		}
+	end
+
+#  def initialize(*args)
+#    unless args.size > 0
+#      super self.class.size,0
+#    else
+#      super *args
+#    end
+#  end
+
+	def self.field_add(type, name, length)
+		@fields ||= Array.new
+		@bsize  ||= 0
+		@size 	||= 0
+		@format_string ||= String.new
+
+		#calculate offset in array
+		f = @fields.last
+			if f == nil
+				offset = 0
+			elsif f[:type].class == Symbol
+				offset = f[:offset] + f[:length]
+			else
+				offset = f[:offset] + f[:type].size * f[:length]
+			end
+
+
+		@fields << { :name => name, :type => type,
+               :length => length, :offset => offset }
+		if type.class == Symbol
+			@size += length
+			@bsize += TYPES[type][:size]*length
+			@format_string += "#{TYPES[type][:str]}#{length}"
+		else
+			@size += length * type.size
+			@bsize += type.bsize*length
+			@format_string += "#{type.format_string}"*length
+		end
+
+		#create getter/setters
+		class_eval %{
+			def #{name}()
+				get_field(#{@fields.size-1})
+			end
+
+			def #{name}=(val)
+				set_field(#{@fields.size-1}, val)
+			end
+		}
+	end
+
+	def self.struct(type, name, size=1)
+		self.field_add(type, name, size)
+	end
+
+	def get_field(index)
+		type = self.class.fields[index][:type]
+		length = self.class.fields[index][:length]
+		offset = self.class.fields[index][:offset]
+
+		if type.class == Symbol
+			return self[offset] if length == 1
+      return self[offset...offset+length].to_a
+		else
+			return type.new(self[offset...offset+type.size]) if length == 1
+			return (0...length).collect {|i|
+        type.new(self[offset+i*type.size...offset+(1+i)*type.size])
+      }
+		end
+	end
+
+	def set_field(index, val)
+		type = self.class.fields[index][:type]
+		length = self.class.fields[index][:length]
+		offset = self.class.fields[index][:offset]
+		if type.class == Symbol
+			self[offset...offset+length] = val
+		else
+			self[offset...offset+length*type.size] = val
+		end
+	end
+public
+  def to_s
+    pack(self.class.format_string)
+  end
+	def inspect(d=0)
+    self.class.to_s + " {\n" +
+    self.class.fields.each_with_index.map {|f,n|
+      field = self.get_field(n)
+      "\t"*(d+1) + "#{f[:type]} #{f[:name]} = " +
+        case field
+        when StructBase
+          "#{field.inspect(d+1)}"
+        else
+          field.inspect
+        end
+
+    }.join("\n") +
+    "\n" + "\t"*d + "}"
+	end
+
+  def write
+  end
+end
+
+def self.Struct(&block)
+	c = Class.new(StructBase)
+	c.class_eval &block
+	return c
+end
+
+def self.write_struct(f, *structs)
+	structs.each do |struct|
+		f.write(struct.pack(struct.class.format_string))
+	end
+end
+
+def self.read_struct(f, type, n=1)
+	format = type.format_string*n
+	len = type.bsize*n
+	array = f.read(len).unpack(format)
+	return Array.new(n) {
+		type.new(array.slice!(0, type.size))
+	}
+end
+
+end

data/lib/rbstruct.rb

@@ -0,0 +1,4 @@
+require "rbstruct/rbstruct"
+def RbStruct &block
+  RbStruct.Struct &block
+end

data/rbstruct.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rbstruct"
+  spec.version       = `git describe --abbrev=0 --tags`
+  spec.authors       = ["Patrik Pettersson"]
+  spec.email         = ["pettersson.pa@gmail.com"]
+
+  spec.summary       = %q{Create C like structs in ruby}
+  spec.description   = %q{C like structs for ruby allowing read/write from binary files"}
+  spec.homepage      = "https://github.com/kaffepanna/rbstruct"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rbstruct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrik Pettersson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: 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: C like structs for ruby allowing read/write from binary files"
+email:
+- pettersson.pa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/gpt.rb
+- lib/rbstruct.rb
+- lib/rbstruct/rbstruct.rb
+- rbstruct.gemspec
+homepage: https://github.com/kaffepanna/rbstruct
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Create C like structs in ruby
+test_files: []