oolite 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a7c6827b7924ebbeca80991a4ce8557f68796687
+  data.tar.gz: 1910d5718f908f7f3726c6307c4060fb808916d7
+SHA512:
+  metadata.gz: 8cf6dc36233b7896e6ae727a9190049d260c528249798d39ff242a21c95fa34fb627ed056d8927f9f6d108e031dac6ff3c294cf93db8d759bd9afbd569624e6e
+  data.tar.gz: ded361ce7720a382df492177d6c1bb55a6d1709ea7d31ed332682ef95529dc99e7452602713aee9413ddba63bc3610b12cf078e686f4b87d0df47bcb02d8cd86

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 oolite.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff McAffee
+
+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,125 @@
+# Oolite
+
+Utility scripts for monitoring the Oolite game's system markets and
+providing trading suggestions based on the market data.
+
+## Installation
+
+If you wish to clone the repository:
+
+    $ git clone https://github.com/jmcaffee/oolite.git
+    $ cd oolite
+    $ bundle
+
+    # Use rake to install the gem
+    rake install
+
+    # To start a pry console using the local version of the gem
+    rake console
+
+Or install it yourself as:
+
+    $ gem install oolite
+
+## Usage
+
+These scripts are provided as standalone utilities. Simply install
+the gem as detailed above to provide the following commands:
+
+    ooconfig - configure the scripts (ie. your save file location)
+    ootrader - suggest the best trades based on current location and destination
+    ooupdatemarket - update the market data (pulls from your save file)
+
+### ooconfig
+
+`ooconfig` displays and edits the configuration file.
+
+The oolite scripts will look for the config file starting in your current directory
+and ascending the directory tree until it reaches the root, then look in your _home_
+directory. I would suggest running your initial configuration from your home dir
+so the scripts can always find the config file no matter where you call them from.
+
+To get started, determine where your save file is located at and change to your
+home directory.
+
+    # Assuming your save file is at ~/oolite-saves/Jameson.oolite-save
+    cd ~
+    ooconfig save_file_path ~/oolite-saves/Jameson.oolite-save
+
+You can see where the config file is located at by running
+
+    ooconfig path
+
+To see the current configuration values, run
+
+    ooconfig show
+
+To see available commands/options, run
+
+    ooconfig
+
+### ooupdatemarket
+
+`ooupdatemarket` saves its data in the same directory as your game save file.
+It also generates a `CSV` dump of the most recent market data for all visited
+systems.
+
+Note that the data is only current for the system you are located at when you
+save your game. The other system data is retained from the last time you visited
+the system, saved your game, and ran `ooupdatemarket`.
+
+### ootrader
+
+`ootrader` will ask you for your destination system based on existing data
+(ie. you've visited the destination at least once, saved your game, and ran
+`ooupdatemarket`), then calculate and display all profitable trades, then
+display its suggested trades to make the most profit.
+
+It uses the current market data, your available credits and max cargo space
+to make its suggestions.
+
+## Workflow (Gameflow?)
+
+* Dock your ship in game
+* Sell your current cargo
+* Refuel you ship
+* Save your game
+
+In a terminal, update your market data
+
+    ooupdatemarket
+
+Now see what it suggests for trades
+
+    ootrader
+
+**Note:** you'll need to visit more than one system, save your game,
+and run `ooupdatemarket` before you'll be able to choose any destinations.
+
+* In game, make your trades/purchases
+* Travel to your destination
+* Profit
+
+## About This Project
+
+These scripts were thrown together over the course of a couple of days.
+As such, the code is not the prettiest, and I'm sure it's ripe for
+refactoring.
+
+I know that there are OXPs that can perform the same functionality (and
+they're in-game too!) but I'm just scratching my itch to code here.
+
+If you find errors, please create issues in the issue tracker. If you'd like
+to add additional features, fork the project and submit a pull request.
+
+## Roadmap
+
+* Refactor the code
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/oolite/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,40 @@
+require "bundler/gem_tasks"
+
+desc 'start a console'
+task :console do
+  require 'pry'
+  $LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+  require 'oolite'
+  ARGV.clear
+
+  def console_help
+    puts <<CONSOLE_HELP
+ CONSOLE HELP
+-------------
+
+Starts a pry console and requires the *local* version of Oolite.
+
+  Search and load the Oolite configuration (defaults will be set if
+  no configuration file is found)
+
+    Oolite.configure
+
+  OR
+
+    Oolite.configure do |config|
+      config.some_setting = some_value
+    end
+
+  After a configuration has been instantiated, you can retrieve the
+  current configuration with
+
+    Oolite.configuration
+
+
+CONSOLE_HELP
+  end
+
+  console_help
+  Pry.start
+end
+

data/bin/ooconfig

@@ -0,0 +1,168 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# vim: set ft=ruby
+##############################################################################
+# File::    ooconfig
+# Purpose:: Configure the oolite utility
+#
+# Author::    Jeff McAffee 05/20/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+begin
+  require 'oolite'
+rescue LoadError
+  $LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+  require 'oolite'
+end
+
+
+class Main
+
+  private
+
+  def usage
+    puts "Usage: #{File.basename($0)} [ CMD  |  OPTION  VALUE ]"
+    puts
+    puts "  Available commands:"
+    puts "    show:   show current configuration settings"
+    puts "    path:   show location of config file (if found)"
+    puts "    update CATEGORY VALUES: update a category item"
+    puts "      categories:"
+    puts "        systems: accepts (in order) NAME ECONOMY GOVERNMENT TECHLEVEL"
+    puts
+    puts "  Available options:"
+    puts "    save_file_path:   path to Oolite save file (~ is allowed)"
+    puts
+  end
+
+  def current_settings
+    puts "= Current Configuration Settings ="
+    puts
+    Oolite.configure do |config|
+      vars = config.instance_variables.map { |v| v.to_s.gsub('@','') }
+      vars.each do |var|
+        puts "#{var}: #{emit_value(config.send(var))}"
+      end
+    end
+  end
+
+  def emit_value val
+    case val
+    when Array
+      emit_array(val)
+    when Hash
+      emit_hash(val)
+    else
+      return val
+    end
+  end
+
+  def emit_array val
+    nl = "\n"
+    indent = "    "
+    output = nl.dup
+
+    val.each do |elem|
+      output << indent << elem << nl
+    end
+    output << nl
+  end
+
+  def emit_hash val
+    nl = "\n"
+    indent = "    "
+    output = nl.dup
+
+    val.each do |key,elem|
+      output << indent << "#{key}: " << indent << emit_value(elem) << nl
+    end
+    output
+  end
+
+  def set_config_values args
+    Oolite.configure do |config|
+      while args.count > 0
+        var = args.shift
+        val = args.shift
+        config.send("#{var}=", val)
+      end
+    end
+
+    Oolite.save_configuration
+  end
+
+  def system_data args
+    econ = args.shift
+    gov = args.shift
+    tech = args.shift
+
+    data = Hash.new
+    data[:economy] = econ unless econ.nil?
+    data[:government] = gov unless gov.nil?
+    data[:tech_level] = tech unless tech.nil?
+
+    data
+  end
+
+  def update args
+    category = args.shift
+    case category
+    when "systems"
+      Oolite.configure do |config|
+        name = args.shift
+        val = config.systems.fetch(name, Hash.new)
+        #val = val.merge( { name => system_data(args) } )
+        val = val.merge( system_data(args) )
+        config.systems[name] = val
+      end
+
+      Oolite.save_configuration
+    else
+      puts "Unknown category: #{category}"
+    end
+  end
+
+  def process_cmd args
+    return false unless args.count > 0
+
+    if args.first.downcase == 'show'
+      current_settings
+      return true
+    end
+
+    if args.first.downcase == 'path'
+      path = Oolite.find_config_path
+      path = 'Not found' if path.nil? || path.to_s.empty?
+      puts "path: #{path}"
+      return true
+    end
+
+    if args.first.downcase == 'update'
+      args.shift
+      update args
+      return true
+    end
+  end
+
+  public
+
+  def execute args
+    if process_cmd(args)
+      return 0
+    end
+
+    if args.count < 2
+
+      usage
+      return 1
+    end
+
+    set_config_values args
+  end
+end
+
+Main.new.execute ARGV
+

data/bin/ootrader

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# vim: set ft=ruby
+##############################################################################
+# File::    ootrader
+# Purpose:: Determine the best items to buy based on the current location
+#           and the next destination
+#
+# Author::    Jeff McAffee 05/20/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+begin
+  require 'oolite'
+rescue LoadError
+  $LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+  require 'oolite'
+end
+
+
+class Main
+
+  def execute
+    savefile = Oolite.configuration.save_file_path
+    if savefile.nil? || savefile.empty?
+      fail "save file path not set.\nUse 'ooconfig save_file_path YOUR_PATH' to set."
+    end
+
+    # Update the market file so we're working with the latest data.
+    market = Oolite::Market.new
+    market.update
+
+    # Display the best trades.
+    trader = Oolite::Trade.new.display
+  end
+end
+
+Main.new.execute

data/bin/ooupdatemarket

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# vim: set ft=ruby
+##############################################################################
+# File::    ooupdatemarket
+# Purpose:: Parse the Oolite save file and generate market info based on the
+#           current docked location's market
+#
+# Author::    Jeff McAffee 05/19/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+begin
+  require 'oolite'
+rescue LoadError
+  $LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+  require 'oolite'
+end
+
+
+class Main
+
+  def execute
+    savefile = Oolite.configuration.save_file_path
+    if savefile.nil? || savefile.empty?
+      fail "save file path not set.\nUse 'ooconfig save_file_path YOUR_PATH' to set."
+    end
+
+    market = Oolite::Market.new
+    market.update
+    market.write_csv
+  end
+end
+
+if ARGV.count > 0 && ARGV.first.downcase == 'upgrade'
+  market = Oolite::Market.new
+  market.upgrade
+elsif ARGV.count > 0 && ARGV.first.downcase == 'upgradeprice'
+  market = Oolite::Market.new
+  market.upgrade_price
+else
+  Main.new.execute
+end

data/lib/oolite.rb

@@ -0,0 +1,191 @@
+require "oolite/version"
+
+if ENV['DEBUG'].nil?
+  $debug = false
+else
+  $debug = true
+end
+
+module Oolite
+  CONFIG_FILE_NAME = '.oolite'
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  ##
+  # Setup oolite configuration
+  #
+  # Attempts to find and load a configuration file the first time
+  # it's requested. If a config file cannot be found in the current
+  # directory tree (moving towards trunk, not the leaves), the user's
+  # home directory will be searched. If still not found, a default
+  # configuration object is created.
+  #
+  # If a block is provided, the configuration object is yielded to the block
+  # after the configuration is loaded/created.
+  #
+
+  def self.configure
+    if self.configuration.nil?
+      unless self.load_configuration
+        self.configuration = Configuration.new
+      end
+    end
+    yield(configuration) if block_given?
+  end
+
+  ##
+  # Walk up the directory tree from current working dir (pwd) till a file
+  # named .oolite is found
+  #
+  # Returns file path if found, nil if not.
+  #
+
+  def self.find_config_path
+    path = Pathname(Pathname.pwd).ascend{|d| h=d+CONFIG_FILE_NAME; break h if h.file?}
+    if path.nil? && (Pathname(ENV['HOME']) + CONFIG_FILE_NAME).exist?
+      path = Pathname(ENV['HOME']) + CONFIG_FILE_NAME
+    end
+    path
+  end
+
+  ##
+  # Write configuration to disk
+  #
+  # Writes to current working dir (pwd) if path is nil
+  #
+  # Returns path of emitted file
+  #
+
+  def self.save_configuration(path = nil)
+    # If no path provided, see if we can find one in the dir tree.
+    if path.nil?
+      path = find_config_path
+    end
+
+    # Still no path? Use the current working dir.
+    if path.nil?
+      path = Pathname.pwd
+    end
+
+    unless path.to_s.end_with?('/' + CONFIG_FILE_NAME)
+      path = Pathname(path) + CONFIG_FILE_NAME
+    end
+
+    path = Pathname(path).expand_path
+    File.write(path, YAML.dump(configuration))
+
+    path
+  end
+
+  ##
+  # Load the configuration from disk
+  #
+  # Returns true if config file found and loaded, false otherwise.
+  #
+
+  def self.load_configuration(path = nil)
+    # If no path provided, see if we can find one in the dir tree.
+    if path.nil?
+      path = find_config_path
+    end
+
+    return false if path.nil?
+    return false unless Pathname(path).exist?
+
+    File.open(path, 'r') do |f|
+      self.configuration = YAML.load(f)
+      puts "configuration loaded from #{path}" if $debug
+    end
+
+    true
+  end
+
+  class Configuration
+    attr_accessor :save_file_path
+    attr_accessor :market_data_filename
+    attr_accessor :current_system_name
+    attr_accessor :current_credits
+    attr_accessor :cargo
+    attr_accessor :trade_contraband
+    attr_accessor :contraband
+    attr_accessor :economies
+    attr_accessor :governments
+    attr_accessor :systems
+
+
+    def initialize
+      reset
+    end
+
+    def reset
+      @save_file_path = ''
+
+      @market_data_filename = 'oolite.market'
+
+      @current_system_name = ''
+      @current_credits = 0
+      @cargo = 0
+
+      @trade_contraband = false
+
+      @contraband = [
+        "Slaves",
+        "Narcotics",
+        "Firearms",
+      ]
+
+      @economies = [
+        "Rich Industrial",
+        "Average Industrial",
+        "Poor Industrial",
+        "Mainly Industrial",
+        "Mainly Agricultural",
+        "Rich Agricultural",
+        "Average Agricultural",
+        "Poor Agricultural"
+      ]
+
+      @governments = [
+        "Anarchy",
+        "Feudal",
+        "Multi-Government",
+        "Dictatorship",
+        "Communist",
+        "Confederacy",
+        "Democracy",
+        "Corporate State"
+      ]
+
+      @systems = Hash.new
+    end
+
+    ##
+    # Control which instance vars are emitted when dumped to YAML.
+    #   Example - not used at this time.
+    #
+
+    def encode_with(coder)
+      vars = instance_variables.map { |x| x.to_s }
+      vars = vars - ["@dummy"]
+
+      vars.each do |var|
+        var_val = eval(var)
+        coder[var.gsub('@', '')] = var_val
+      end
+    end
+  end # Configuration
+end
+
+require 'yaml'
+
+# Initialize the configuration
+Oolite.configure
+
+require 'oolite/csv_doc'
+require 'oolite/save_file'
+require 'oolite/market_file'
+require 'oolite/market'
+require 'oolite/trade'
+

data/lib/oolite/csv_doc.rb

@@ -0,0 +1,68 @@
+##############################################################################
+# File::    csv_doc.rb
+# Purpose:: CSVDoc class for emitting formatted CSV documents
+#
+# Author::    Jeff McAffee 05/19/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+
+module Oolite
+  class CSVDoc
+    def lines
+      @lines ||= Array.new
+    end
+
+    def add line = []
+      new_line = Array.new
+
+      Array(line).each do |elem|
+        if elem.include?(',')
+          # Quote element if it contains a comma
+          new_line << "\"#{elem}\""
+        else
+          new_line << elem
+        end
+      end
+
+      lines << new_line
+    end
+
+    def write filepath
+      pad_lines
+      output_lines = Array.new
+      lines.each do |line|
+        output_lines << line.join(',')
+      end
+
+      File.open(filepath, 'w') do |f|
+        f.write(output_lines.join("\n"))
+      end
+    end
+
+    def pad_lines
+      max = 0
+      lines.each do |line|
+        len = line.count
+        if len > max
+          max = len
+        end
+      end
+
+      padded_lines = Array.new
+      lines.each do |line|
+        if line.count < max
+          pads = max = line.count
+          pads.times.each do
+            line << ''
+          end
+        end
+        padded_lines << line
+      end
+
+      @lines = padded_lines
+    end
+  end
+end
+

data/lib/oolite/market.rb

@@ -0,0 +1,143 @@
+##############################################################################
+# File::    market.rb
+# Purpose:: Write out a market data file
+#
+# Author::    Jeff McAffee 05/19/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+require 'yaml'
+
+module Oolite
+  class Market
+    def initialize
+      Oolite.configure do |config|
+        @save_file_path = Pathname(config.save_file_path)
+        path = @save_file_path.dirname
+        @market_data_path = path + (Pathname(config.market_data_filename).to_s + '.yml')
+        @market_data_csv = path + (Pathname(config.market_data_filename).to_s + '.csv')
+      end
+    end
+
+    def update filename = nil
+      filename ||= @save_file_path
+
+      savefile = SaveFile.new filename
+
+      add_credits_to_config savefile.credits
+      add_cargo_to_config savefile.cargo
+
+      system_name = savefile.current_system_name
+      add_system_to_config system_name
+      puts "Updating data for #{system_name} system"
+
+      data[system_name] = savefile.local_market_data
+
+      write_data_file
+    end
+
+    def upgrade
+      mf = MarketFile.new
+      old_data = mf.data
+
+      old_data.each do |key, d|
+        updated_hash = Hash.new
+        d.each do |item, price|
+          if price.class == Hash
+            updated_hash[item] = price
+          else
+            updated_hash[item] = { price: price, amount: 0 }
+          end
+        end
+
+        data[key] = updated_hash
+      end
+
+      write_data_file
+    end
+
+    def upgrade_price
+      mf = MarketFile.new
+      old_data = mf.data
+
+      old_data.each do |key, d|
+        updated_hash = Hash.new
+        d.each do |item, info|
+          updated_hash[item] = { price: (info[:price] * 10).to_i, amount: info[:amount] }
+        end
+
+        data[key] = updated_hash
+      end
+
+      write_data_file
+    end
+
+    def write_csv filename = nil
+      filename ||= @market_data_csv
+      csv_doc = CSVDoc.new
+      format_data csv_doc
+      csv_doc.write filename
+
+      puts "CSV file written to #{filename}"
+    end
+
+    private
+
+    def data
+      @data ||= MarketFile.new.data
+    end
+
+    def write_data_file
+      mf = MarketFile.new
+      mf.data = data
+      mf.write
+    end
+
+    def format_data csv_doc
+      line = Array.new
+      line << ''
+      line = line + data.keys
+      csv_doc.add line
+
+      data[data.keys.first].keys.each do |type|
+        line = Array(type)
+        data.each do |location, local_data|
+          line << (local_data[type][:price] / 10.0).to_s
+        end
+        csv_doc.add line
+      end
+    end
+
+    def add_system_to_config system
+      Oolite.configure do |config|
+        config.current_system_name = system
+
+        unless config.systems.key?(system)
+          details = { economy: nil,
+                      government: nil,
+                      tech_level: nil,
+          }
+          config.systems[system] = details
+        end
+      end
+      Oolite.save_configuration
+    end
+
+    def add_credits_to_config credits
+      Oolite.configure do |config|
+        config.current_credits = credits
+      end
+      Oolite.save_configuration
+    end
+
+    def add_cargo_to_config cargo
+      Oolite.configure do |config|
+        config.cargo = cargo
+      end
+      Oolite.save_configuration
+    end
+  end
+end
+

data/lib/oolite/market_file.rb

@@ -0,0 +1,55 @@
+##############################################################################
+# File::    market_file.rb
+# Purpose:: Store market data
+#
+# Author::    Jeff McAffee 05/20/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+require 'yaml'
+
+module Oolite
+  class MarketFile
+    def initialize
+      Oolite.configure do |config|
+        @save_file_path = Pathname(config.save_file_path)
+        path = @save_file_path.dirname
+        @market_data_path = path + (Pathname(config.market_data_filename).to_s + '.yml')
+      end
+    end
+
+    def data
+      @data ||= self.load
+    end
+
+    def data= new_data
+      @data = new_data
+    end
+
+    def systems
+      data.keys
+    end
+
+    def load
+      if @market_data_path.nil? || @market_data_path.to_s.empty? || !@market_data_path.exist?
+        Hash.new
+      else
+        input = YAML.load_file(@market_data_path)
+        input or Hash.new
+      end
+    rescue
+      Hash.new
+    end
+
+    def write
+      raise "Missing filename" if @market_data_path.nil? || @market_data_path.to_s.empty?
+
+      File.open(@market_data_path, 'w') do |f|
+        f.write data.to_yaml
+      end
+    end
+  end
+end
+

data/lib/oolite/save_file.rb

@@ -0,0 +1,71 @@
+##############################################################################
+# File::    save_file.rb
+# Purpose:: Parse the Oolite save file
+#
+# Author::    Jeff McAffee 05/19/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+require 'nokogiri'
+
+module Oolite
+  class SaveFile
+    def initialize filename
+      parse filename
+    end
+
+    def parse filename
+      raise "Cannot find save file #{filename}" unless Pathname(filename).exist?
+
+      @doc = Nokogiri::XML(File.open(filename)) do |config|
+        config.noblanks
+      end
+    end
+
+    def current_system_name
+      node = get_data_node_for_key 'current_system_name'
+      node.text
+    end
+
+    def cargo
+      node = get_data_node_for_key 'max_cargo'
+      node.text.to_i
+    end
+
+    def credits
+      node = get_data_node_for_key 'credits'
+      node.text.to_i
+    end
+
+    def local_market_data
+      node = get_data_node_for_key 'localMarket'
+
+      mdata = {}
+
+      node.children.each do |child|
+        type = child.children[0].text
+        amount = child.children[1].text.to_i
+        # Price is stored as an integer and displayed as price / 10.
+        price = child.children[2].text.to_i
+        mdata[type] = { amount: amount, price: price }
+      end
+
+      mdata
+    end
+
+    private
+
+    def get_data_node_for_key key
+      @doc.css('dict').children.each do |node|
+        if node.name == 'key' && node.text == key
+          return node.next
+        end
+      end
+
+      raise "No data found for key #{key}"
+    end
+  end
+end
+

data/lib/oolite/trade.rb

@@ -0,0 +1,213 @@
+##############################################################################
+# File::    trade.rb
+# Purpose:: Determine the best trades based on current location and the next
+#           destination
+#
+# Author::    Jeff McAffee 05/20/2015
+# Copyright:: Copyright (c) 2015, kTech Systems LLC. All rights reserved.
+# Website::   http://ktechsystems.com
+##############################################################################
+
+require 'pathname'
+require 'yaml'
+
+module Oolite
+  class Trade
+    def display
+      puts "= Oolite Trader ="
+      puts
+      puts "  Current Location: #{current_system_name}"
+      puts
+      puts "  Available destinations:"
+      puts
+
+      systems = market.systems
+      systems.delete current_system_name
+      systems.each_with_index do |sys,i|
+        puts "      #{i} - #{sys}"
+      end
+      puts
+      choice = ask "    Choose your destination (q to abort): "
+
+      return if choice.downcase == 'q'
+      puts
+
+      dest_system = systems[choice.to_i]
+
+      puts "  -- Suggested Trades (best to worst) for #{dest_system} --"
+      puts
+      puts "    #{'Item'.ljust(14)} #{'Amt Avail'.to_s.ljust(10)} #{'PricePerUnit'.to_s.rjust(8)} #{'ProfitPerUnit'.to_s.rjust(12)}"
+      puts
+
+      avail_trades = all_trades(dest_system)
+      avail_trades.each do |trade|
+        puts "    " + trade.to_s
+      end
+
+      puts
+
+      puts "  -- Suggested Transactions for #{dest_system} --"
+      puts
+      puts "    #{'Item'.ljust(14)} #{'Purch Amt'.to_s.ljust(10)} #{'Profit'.to_s.rjust(8)}"
+      puts
+
+      trans, total_profit = calc_best_trades avail_trades
+      trans.each do |tran|
+        name = tran[:item].name
+        revenue = tran[:item].revenue
+        amount = tran[:amount]
+        profit = revenue * amount
+
+        puts "    #{name.ljust(14)} #{amount.to_s.ljust(10)} #{(profit / 10.0).to_s.rjust(8)}"
+      end
+
+      puts
+      puts "Total Profit: #{(total_profit / 10.0).to_s}"
+      puts
+
+    end
+
+    private
+
+    def ask msg
+      print "#{msg}"
+      val = STDIN.getc
+    end
+
+    def current_system_name
+      Oolite.configuration.current_system_name
+    end
+
+    def market
+      if @market.nil?
+        @market = MarketFile.new
+        @market.data
+      end
+      @market
+    end
+
+    def all_trades dest_system
+      calculate_all_trades dest_system
+    end
+
+    class TradeItem
+      attr_accessor :name
+      attr_accessor :amount
+      attr_accessor :cost
+      attr_accessor :revenue
+
+      def initialize name, amount, cost, revenue
+        @name = name
+        @amount = amount
+        @cost = cost
+        @revenue = revenue
+      end
+
+      def to_s
+        "#{name.ljust(14)} #{amount.to_s.ljust(10)} #{(cost / 10.0).to_s.rjust(8)} #{(revenue / 10.0).to_s.rjust(12)}"
+      end
+    end
+
+    def calculate_all_trades dest_system
+      src = market.data[current_system_name]
+      dest = market.data[dest_system]
+
+      # Remove contraband if configured.
+      if Oolite.configuration.trade_contraband == false
+        Oolite.configuration.contraband.each do |contr|
+          src.delete contr
+        end
+      end
+
+      positive_trades = Array.new
+
+      src.keys.each do |item|
+        sprice = src[item][:price]
+        amount = src[item][:amount]
+        dprice = dest[item][:price]
+
+        revenue = dprice - sprice
+        if revenue > 0.0 && amount > 0
+          positive_trades << TradeItem.new(item, amount, sprice, revenue)
+        end
+      end
+
+      positive_trades.sort { |a,b| b.revenue <=> a.revenue }
+    end
+
+    def calc_best_trades trades
+      avail_cargo = Oolite.configuration.cargo
+      credits = Oolite.configuration.current_credits
+
+      if avail_cargo <= 0
+        return [[], 0]
+      end
+
+      affordable_trades = []
+      trades.each do |trade|
+        if trade.cost <= credits
+          affordable_trades << trade
+        end
+      end
+
+      if affordable_trades.count <= 0
+        return [[], 0]
+      end
+
+      balance = credits
+      cargo = avail_cargo
+      suggested_trades_expensive_first = []
+      affordable_trades.each do |trade|
+        max_amt_by_price = balance / trade.cost
+        max_amt_by_cargo = [cargo, trade.amount].min
+        max_amt = [max_amt_by_price, max_amt_by_cargo].min
+
+        balance = balance - (max_amt * trade.cost)
+        cargo = cargo - max_amt
+
+        if max_amt > 0
+          transaction = { item: trade, amount: max_amt }
+          suggested_trades_expensive_first << transaction.dup
+        end
+      end
+
+      expensive_first_total_profit = 0
+      suggested_trades_expensive_first.each do |transaction|
+        profit = transaction[:item].revenue * transaction[:amount]
+        expensive_first_total_profit += profit
+      end
+
+      balance = credits
+      cargo = avail_cargo
+      suggested_trades_cheap_first = []
+      # Sort the trades in ascending order.
+      cheap_affordable_trades = affordable_trades.sort { |a,b| a.revenue <=> b.revenue }
+      cheap_affordable_trades.each do |trade|
+        max_amt_by_price = balance / trade.cost
+        max_amt_by_cargo = [cargo, trade.amount].min
+        max_amt = [max_amt_by_price, max_amt_by_cargo].min
+
+        balance = balance - (max_amt * trade.cost)
+        cargo = cargo - max_amt
+
+        if max_amt > 0
+          transaction = { item: trade, amount: max_amt }
+          suggested_trades_cheap_first << transaction.dup
+        end
+      end
+
+      cheap_first_total_profit = 0
+      suggested_trades_cheap_first.each do |transaction|
+        profit = transaction[:item].revenue * transaction[:amount]
+        cheap_first_total_profit += profit
+      end
+
+      if expensive_first_total_profit > cheap_first_total_profit
+        return [suggested_trades_expensive_first, expensive_first_total_profit]
+      else
+        return [suggested_trades_cheap_first, cheap_first_total_profit]
+      end
+    end
+  end
+end
+

data/lib/oolite/version.rb

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

data/oolite.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oolite/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oolite"
+  spec.version       = Oolite::VERSION
+  spec.authors       = ["Jeff McAffee"]
+  spec.email         = ["jeff@ktechsystems.com"]
+  spec.summary       = %q{Utility scripts for the Oolite game}
+  spec.description   = %q{Utility scripts for tracking markets and assisting with trading in the Oolite game.}
+  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"
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: oolite
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff McAffee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Utility scripts for tracking markets and assisting with trading in the
+  Oolite game.
+email:
+- jeff@ktechsystems.com
+executables:
+- ooconfig
+- ootrader
+- ooupdatemarket
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ooconfig
+- bin/ootrader
+- bin/ooupdatemarket
+- lib/oolite.rb
+- lib/oolite/csv_doc.rb
+- lib/oolite/market.rb
+- lib/oolite/market_file.rb
+- lib/oolite/save_file.rb
+- lib/oolite/trade.rb
+- lib/oolite/version.rb
+- oolite.gemspec
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Utility scripts for the Oolite game
+test_files: []
+has_rdoc: