dsp_blueprint_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a41b4aaec5e4a7a852d8e605bd7374f9e042adfdaa524927d3664e24dea3f66e
+  data.tar.gz: 2b729108186e6a73e2446dc415e8d19a2098b90f993bbbed0c4bfec1787699fd
+SHA512:
+  metadata.gz: 4adfcd16738fe259825577d67ad21312379d83de8e1b4a04950f5b6ddfe61d3f54ecaeec30b740181bfde33f0c716a7faa860205245bf1c92894c43fe327bd0f
+  data.tar.gz: c8e3cf285432a9d6db78415fd8bff050a427839ba6ec9e7829638cfc6797356e4f038ea187d846877f5400e01efe2bcbaaf3378cbf636d9e7d3f3d02452910f0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/dsp_blueprint_parser.iml

@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.22, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="coderay (v1.1.3, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.4.4, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.20.1, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.0.2.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="pry (v0.14.1, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.0.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rbs (v1.0.4, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.1.1, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.10.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.10.1, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.10.1, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-its (v1.3.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.10.2, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.10.2, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.18.4, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.8.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, ruby-3.0.2-p107) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.0.0, ruby-3.0.2-p107) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build dsp_blueprint_parser-0.1.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum if dsp_blueprint_parser-0.1.0.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install dsp_blueprint_parser-0.1.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install dsp_blueprint_parser-0.1.0.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.0 and build and push dsp_blueprint_parser-0.1.0.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RuboCop" fullCommand="rubocop" id="rubocop" />
+          <RakeTaskImpl id="rubocop">
+            <subtasks>
+              <RakeTaskImpl description="Auto-correct RuboCop offenses" fullCommand="rubocop:auto_correct" id="auto_correct" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-3.0.2-p107" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/dsp_blueprint_parser.iml" filepath="$PROJECT_DIR$/.idea/dsp_blueprint_parser.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/BlockLength:
+  Max: 30
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-31
+
+- Initial release

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dsp_blueprint_parser.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'pry', '~> 0.14.0'
+gem 'rspec-expectations', '~> 3.10.1'
+gem 'rspec-its', '~> 1.3.0'
+gem 'rubocop', '~> 1.7'

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    dsp_blueprint_parser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-its (1.3.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  dsp_blueprint_parser!
+  pry (~> 0.14.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-expectations (~> 3.10.1)
+  rspec-its (~> 1.3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Lucas Falk
+
+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 @@
+# DspBlueprintParser
+
+Small Ruby gem to handle parsing of Dyson Sphere Program's blueprint data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dsp_blueprint_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dsp_blueprint_parser
+
+## Usage
+
+Module `DspBlueprintParser` has a single static method `parse` which takes the DSP blueprint string to be parsed.
+
+```ruby
+DspBlueprintParser::parse(str_blueprint)
+```
+
+## 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 the created tag, 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/LRFalk01/dsp_blueprint_parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dsp_blueprint_parser'
+
+# 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(__FILE__)

data/bin/setup

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

data/dsp_blueprint_parser.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/dsp_blueprint_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dsp_blueprint_parser'
+  spec.version       = DspBlueprintParser::VERSION
+  spec.authors       = ['Lucas Falk']
+  spec.email         = ['LRFalk01@gmail.com']
+
+  spec.summary       = 'Parse Dyson Sphere Program blueprint string'
+  spec.description   = 'Parse Dyson Sphere Program blueprint string'
+  spec.homepage      = 'https://github.com/LRFalk01/DSP-Blueprint-Parser'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 3.0'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  # spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/dsp_blueprint_parser.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'zlib'
+require 'stringio'
+require 'base64'
+
+require_relative 'dsp_blueprint_parser/version'
+require_relative 'dsp_blueprint_parser/blueprint_data'
+require_relative 'dsp_blueprint_parser/icon_layout'
+require_relative 'dsp_blueprint_parser/area'
+require_relative 'dsp_blueprint_parser/building'
+require_relative 'dsp_blueprint_parser/binary_reader'
+require_relative 'dsp_blueprint_parser/parser'
+
+# module to receive a Dyson Sphere Program blueprint string and parse it
+module DspBlueprintParser
+  class Error < StandardError; end
+
+  # @param str_blueprint [String]
+  # @return [BlueprintData]
+  def self.parse(str_blueprint)
+    return if str_blueprint.size < 28
+    return unless str_blueprint.start_with? 'BLUEPRINT:'
+
+    parser = Parser.new(str_blueprint)
+    parser.parse
+  end
+end

data/lib/dsp_blueprint_parser/area.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  # data class for parsed area
+  class Area
+    # @return [Integer]
+    attr_accessor :index
+
+    # @return [Integer]
+    attr_accessor :parent_index
+
+    # @return [Integer]
+    attr_accessor :tropic_anchor
+
+    # @return [Integer]
+    attr_accessor :area_segments
+
+    # @return [Integer]
+    attr_accessor :anchor_local_offset_x
+
+    # @return [Integer]
+    attr_accessor :anchor_local_offset_y
+
+    # @return [Integer]
+    attr_accessor :width
+
+    # @return [Integer]
+    attr_accessor :height
+  end
+end

data/lib/dsp_blueprint_parser/binary_reader.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  # class to manage the position of byte array while parsing data out of it
+  class BinaryReader
+    # @param data [Array<byte>]
+    def initialize(data)
+      @data = data
+      @position = 0
+    end
+
+    def read_i32
+      get_integer(4, 'l<')
+    end
+
+    def read_i16
+      get_integer(2, 's<')
+    end
+
+    def read_i8
+      get_integer(1, 'c')
+    end
+
+    def read_single
+      get_integer(4, 'e')
+    end
+
+    private
+
+    # @param byte_count [Integer]
+    # @return [String]
+    def get_string(byte_count)
+      value = @data[@position..@position + byte_count].pack('C*').force_encoding('UTF-8')
+      @position += byte_count
+
+      value
+    end
+
+    # @param byte_count [Integer]
+    # @param format [String]
+    # @return [Integer]
+    def get_integer(byte_count, format)
+      get_string(byte_count).unpack1(format)
+    end
+  end
+end

data/lib/dsp_blueprint_parser/blueprint_data.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  # data class for parsed blueprint
+  class BlueprintData
+    def initialize
+      @areas = []
+      @buildings = []
+    end
+
+    # @return [DateTime]
+    attr_accessor :time
+
+    # @return [String]
+    attr_accessor :game_version
+
+    # @return [String]
+    attr_accessor :short_description
+
+    # @return [String]
+    attr_accessor :description
+
+    # Integer is a const value from IconLayout
+    # @return [Integer]
+    attr_accessor :icon_layout
+
+    # @return [Integer]
+    attr_accessor :icon0
+
+    # @return [Integer]
+    attr_accessor :icon1
+
+    # @return [Integer]
+    attr_accessor :icon2
+
+    # @return [Integer]
+    attr_accessor :icon3
+
+    # @return [Integer]
+    attr_accessor :icon4
+
+    # @return [Integer]
+    attr_accessor :cursor_offset_x
+
+    # @return [Integer]
+    attr_accessor :cursor_offset_y
+
+    # @return [Integer]
+    attr_accessor :cursor_target_area
+
+    # @return [Integer]
+    attr_accessor :drag_box_size_x
+
+    # @return [Integer]
+    attr_accessor :drag_box_size_y
+
+    # @return [Integer]
+    attr_accessor :primary_area_idx
+
+    # @return [Array<Area>]
+    attr_accessor :areas
+
+    # @return [Array<Building>]
+    attr_accessor :buildings
+
+    # @return [Integer]
+    attr_accessor :version
+  end
+end

data/lib/dsp_blueprint_parser/building.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  # data class for parsed building
+  class Building
+    def initialize
+      @parameters = []
+    end
+
+    # @return [Integer]
+    attr_accessor :index
+
+    # @return [Integer]
+    attr_accessor :area_index
+
+    # @return [Float]
+    attr_accessor :local_offset_x
+
+    # @return [Float]
+    attr_accessor :local_offset_y
+
+    # @return [Float]
+    attr_accessor :local_offset_z
+
+    # @return [Float]
+    attr_accessor :local_offset_x2
+
+    # @return [Float]
+    attr_accessor :local_offset_y2
+
+    # @return [Float]
+    attr_accessor :local_offset_z2
+
+    # @return [Float]
+    attr_accessor :yaw
+
+    # @return [Float]
+    attr_accessor :yaw2
+
+    # @return [Integer]
+    attr_accessor :item_id
+
+    # @return [Integer]
+    attr_accessor :model_index
+
+    # @return [Integer]
+    attr_accessor :temp_output_obj_idx
+
+    # @return [Integer]
+    attr_accessor :temp_input_obj_idx
+
+    # @return [Integer]
+    attr_accessor :output_to_slot
+
+    # @return [Integer]
+    attr_accessor :input_from_slot
+
+    # @return [Integer]
+    attr_accessor :output_from_slot
+
+    # @return [Integer]
+    attr_accessor :input_to_slot
+
+    # @return [Integer]
+    attr_accessor :output_offset
+
+    # @return [Integer]
+    attr_accessor :input_offset
+
+    # @return [Integer]
+    attr_accessor :recipe_id
+
+    # @return [Integer]
+    attr_accessor :filter_fd
+
+    # @return [Array<Integer>]
+    attr_accessor :parameters
+  end
+end

data/lib/dsp_blueprint_parser/icon_layout.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  module IconLayout
+    NONE = 0
+    NO_ICON = 1
+    ONE_ICON = 10
+    ONE_ICON_SMALL = 11
+    TWO_ICON_46 = 20
+    TWO_ICON_53 = 21
+    TWO_ICON_59 = 22
+    TWO_ICON_57 = 23
+    TWO_ICON_51 = 24
+    THREE_ICON_813 = 30
+    THREE_ICON_279 = 31
+    THREE_ICON_573 = 32
+    THREE_ICON_591 = 33
+    FOUR_ICON_7913 = 40
+    FOUR_ICON_8462 = 41
+    FIVE_ICON_57913 = 50
+    FIVE_ICON_PENTA = 51
+  end
+end

data/lib/dsp_blueprint_parser/parser.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  # class to orchestrate parsing
+  class Parser
+    SECONDS_AT_EPOC = 62_135_596_800
+
+    # @param [String] str_blueprint
+    def initialize(str_blueprint)
+      @str_blueprint = str_blueprint
+    end
+
+    # @return [BlueprintData]
+    def parse
+      blueprint = BlueprintData.new
+      reader = get_reader(@str_blueprint)
+
+      parse_metadata(blueprint, @str_blueprint, reader)
+      parse_areas(blueprint, reader)
+      parse_buildings(blueprint, reader)
+
+      blueprint
+    end
+
+    private
+
+    # @param ticks [Integer]
+    # @return [Time]
+    def ticks_to_epoch(ticks)
+      # 10mil ticks per second
+      seconds = ticks / 10_000_000
+
+      Time.at(seconds - SECONDS_AT_EPOC)
+    end
+
+    # @param str_blueprint [String]
+    # @return [Array<String>]
+    def get_header_segments(str_blueprint)
+      header_end = str_blueprint.index('"')
+      header = str_blueprint[10..header_end - 1]
+      header.split(',')
+    end
+
+    # @param str_blueprint [String]
+    # @return [BinaryReader]
+    def get_reader(str_blueprint)
+      header_end = str_blueprint.index('"')
+      blueprint_end = str_blueprint[header_end + 1..].index('"') + header_end
+      blueprint_compressed = str_blueprint[header_end + 1..blueprint_end]
+
+      gz = Zlib::GzipReader.new(StringIO.new(Base64.decode64(blueprint_compressed)))
+      blueprint_decompressed = gz.each_byte.to_a
+
+      BinaryReader.new(blueprint_decompressed)
+    end
+
+    # @param [BlueprintData] blueprint
+    # @param [BinaryReader] reader
+    def parse_areas(blueprint, reader)
+      reader.read_i8.times do
+        area = Area.new
+        area.index = reader.read_i8
+        area.parent_index = reader.read_i8
+        area.tropic_anchor = reader.read_i16
+        area.area_segments = reader.read_i16
+        area.anchor_local_offset_x = reader.read_i16
+        area.anchor_local_offset_y = reader.read_i16
+        area.width = reader.read_i16
+        area.height = reader.read_i16
+
+        blueprint.areas << area
+      end
+    end
+
+    # @param [BlueprintData] blueprint
+    # @param [BinaryReader] reader
+    def parse_buildings(blueprint, reader)
+      reader.read_i32.times do
+        building = Building.new
+        building.index = reader.read_i32
+        building.area_index = reader.read_i8
+        building.local_offset_x = reader.read_single
+        building.local_offset_y = reader.read_single
+        building.local_offset_z = reader.read_single
+        building.local_offset_x2 = reader.read_single
+        building.local_offset_y2 = reader.read_single
+        building.local_offset_z2 = reader.read_single
+        building.yaw = reader.read_single
+        building.yaw2 = reader.read_single
+        building.item_id = reader.read_i16
+        building.model_index = reader.read_i16
+        building.temp_output_obj_idx = reader.read_i32
+        building.temp_input_obj_idx = reader.read_i32
+        building.output_to_slot = reader.read_i8
+        building.input_from_slot = reader.read_i8
+        building.output_from_slot = reader.read_i8
+        building.input_to_slot = reader.read_i8
+        building.output_offset = reader.read_i8
+        building.input_offset = reader.read_i8
+        building.recipe_id = reader.read_i16
+        building.filter_fd = reader.read_i16
+
+        reader.read_i16.times do
+          building.parameters << reader.read_i32
+        end
+
+        blueprint.buildings << building
+      end
+    end
+
+    # @param [BlueprintData] blueprint
+    # @param [String] str_blueprint
+    # @param [BinaryReader] reader
+    def parse_metadata(blueprint, str_blueprint, reader)
+      header_segments = get_header_segments(str_blueprint)
+
+      blueprint.icon_layout = header_segments[1].to_i
+      blueprint.icon0 = header_segments[2].to_i
+      blueprint.icon1 = header_segments[3].to_i
+      blueprint.icon2 = header_segments[4].to_i
+      blueprint.icon3 = header_segments[5].to_i
+      blueprint.icon4 = header_segments[6].to_i
+
+      blueprint.time = ticks_to_epoch(header_segments[8].to_i)
+      blueprint.game_version = header_segments[9]
+      blueprint.short_description = CGI.unescape(header_segments[10])
+      blueprint.description = CGI.unescape(header_segments[11])
+
+      blueprint.version = reader.read_i32
+      blueprint.cursor_offset_x = reader.read_i32
+      blueprint.cursor_offset_y = reader.read_i32
+      blueprint.cursor_target_area = reader.read_i32
+      blueprint.drag_box_size_x = reader.read_i32
+      blueprint.drag_box_size_y = reader.read_i32
+      blueprint.primary_area_idx = reader.read_i32
+    end
+  end
+end

data/lib/dsp_blueprint_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DspBlueprintParser
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: dsp_blueprint_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lucas Falk
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-08-02 00:00:00.000000000 Z
+dependencies: []
+description: Parse Dyson Sphere Program blueprint string
+email:
+- LRFalk01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.gitignore"
+- ".idea/dsp_blueprint_parser.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dsp_blueprint_parser.gemspec
+- lib/dsp_blueprint_parser.rb
+- lib/dsp_blueprint_parser/area.rb
+- lib/dsp_blueprint_parser/binary_reader.rb
+- lib/dsp_blueprint_parser/blueprint_data.rb
+- lib/dsp_blueprint_parser/building.rb
+- lib/dsp_blueprint_parser/icon_layout.rb
+- lib/dsp_blueprint_parser/parser.rb
+- lib/dsp_blueprint_parser/version.rb
+homepage: https://github.com/LRFalk01/DSP-Blueprint-Parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LRFalk01/DSP-Blueprint-Parser
+  source_code_uri: https://github.com/LRFalk01/DSP-Blueprint-Parser
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Parse Dyson Sphere Program blueprint string
+test_files: []