tmx 0.0.1 → 0.1.0

data/lib/tmx/parsers/parsers.rb

@@ -0,0 +1,30 @@
+module Tmx
+
+  #
+  # This module defines the parsers for the formats of various
+  # TMX output formats.
+  #
+  module Parsers
+    extend self
+
+    def format(format)
+      parsers[format]
+    end
+
+    def parsers
+      @parsers ||= {}
+    end
+
+    def register(format,parser)
+      parsers[format] = parser
+    end
+
+    def default=(parser)
+      parsers.default = parser
+    end
+  end
+end
+
+require 'tmx/parsers/unknown'
+require 'tmx/parsers/json'
+require 'tmx/parsers/tmx'

data/lib/tmx/parsers/tmx.rb

@@ -0,0 +1,145 @@
+require 'nokogiri'
+require 'zlib'
+require 'base64'
+
+module Tmx
+  module Parser
+
+    #
+    # Parses the TMX formatted output from Tiled.
+    #
+    class Tmx
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def parse(contents)
+        results = Nokogiri::XML(contents)
+        convert_to_hash(results)
+      end
+
+      private
+
+      def convert_to_hash(xml)
+        {
+          "version" => map_attr(xml,"version").to_i,
+          "orientation" => map_attr(xml,"orientation"),
+          "width" => map_attr(xml,"width").to_i,
+          "height" => map_attr(xml,"height").to_i,
+          "tilewidth" => map_attr(xml,"tilewidth").to_i,
+          "tileheight" => map_attr(xml,"tileheight").to_i,
+          "properties" => properties(xml.xpath("/map")),
+          "layers" => map_layers(xml),
+          "tilesets" => map_tilesets(xml)
+        }
+      end
+
+      def map_attr(xml,name)
+        xml.xpath("/map/@#{name}").text
+      end
+
+      def properties(xml)
+        properties = {}
+        xml.xpath("properties/property").each do |property|
+          properties[property.xpath("@name").text] = property.xpath("@value").text
+        end
+        properties
+      end
+
+      def layer_attr(layer,name,options)
+        layer.xpath("@#{name}").text == "" ? options[:default] : layer.xpath("@#{name}").text
+      end
+
+      def map_layers(xml)
+        layers = []
+
+        xml.xpath("/map/layer").each do |layer|
+          layer_hash = {}
+
+          layer_hash["name"] = layer.xpath("@name").text
+          layer_hash["width"] = layer.xpath("@width").text.to_i
+          layer_hash["height"] = layer.xpath("@height").text.to_i
+
+          layer_hash["type"] = layer_attr(layer,"type",default: "tilelayer")
+          layer_hash["opacity"] = layer_attr(layer,"opacity",default: 1.0).to_f
+          layer_hash["visible"] = (layer.xpath("@visible").text =~ /^false$/ ? false : true)
+
+          layer_hash["x"] = layer.xpath("@x").text.to_i
+          layer_hash["y"] = layer.xpath("@y").text.to_i
+
+          layer_hash["data"] = data_from_layer(layer)
+
+          layers.push layer_hash
+        end
+        layers
+      end
+
+      def data_from_layer(layer)
+        layer_data = layer.xpath("data").text.strip
+
+        if layer.xpath("data/@encoding").text == "base64"
+          layer_data = Base64.decode64(layer_data)
+        end
+
+        if layer.xpath("data/@compression").text == "zlib"
+          data = unpack_data zlib_decompress(layer_data)
+        elsif layer.xpath("data/@compression").text == "gzip"
+          data = unpack_data gzip_decompress(layer_data)
+        elsif layer.xpath("data/@encoding").text == "base64"
+          data = unpack_data(layer_data)
+        elsif layer.xpath("data/@encoding").text == "csv"
+          data = layer_data.split(",").map(&:to_i)
+        else
+          data = layer.xpath("data/tile").map { |tile| tile.xpath("@gid").text.to_i }
+        end
+      end
+
+      def zlib_decompress(data)
+        Zlib::Inflate.inflate(data)
+      end
+
+      def gzip_decompress(data)
+        Zlib::GzipReader.new(StringIO.new(data)).read
+      end
+
+      #
+      # Convert the XML data format into a valid format in Ruby.
+      #
+      # @see http://sourceforge.net/apps/mediawiki/tiled/index.php?title=Examining_the_map_format
+      # @see http://www.ruby-doc.org/core-2.0/String.html#method-i-unpack
+      #
+      #     V         | Integer | 32-bit unsigned, VAX (little-endian) byte order
+      #
+      def unpack_data(data)
+        data.unpack("V" * (data.length / 4))
+      end
+
+      def map_tilesets(xml)
+        xml.xpath("map/tileset").map do |tileset|
+          image = tileset.xpath("image")
+
+          properties = {
+            "firstgid" => tileset.xpath("@firstgid").text.to_i,
+            "name" => tileset.xpath("@name").text,
+            "tilewidth" => tileset.xpath("@tilewidth").text.to_i,
+            "tileheight" => tileset.xpath("@tileheight").text.to_i,
+            "spacing" => tileset.xpath("@spacing").text.to_i,
+            "margin" => tileset.xpath("@margin").text.to_i,
+            "image" => image.xpath("@source").text,
+            "imageheight" => image.xpath("@height").text.to_i,
+            "imagewidth" => image.xpath("@width").text.to_i,
+            "properties" => properties(xml)
+          }
+        end
+
+
+      end
+
+    end
+
+  end
+
+  Parsers.register :tmx, Parser::Tmx
+end

data/lib/tmx/parsers/unknown.rb

@@ -0,0 +1,24 @@
+module Tmx
+  module Parser
+
+    #
+    # The Unknown Parser is used to generate an error when the format
+    # is not supported or unknown.
+    #
+    class Unknown
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def parse(contents)
+        raise "Unknown Parser Type: Could not find an available parser for format #{options[:format]}"
+      end
+    end
+
+  end
+
+  Parsers.default = Parser::Unknown
+
+end

data/lib/tmx/tile_set.rb

@@ -1,35 +1,5 @@
 module Tmx
-  # class TileSet
-  #   def initialize map
-  #     @map   = WeakRef.new map
-  #     @tiles = [ nil ]
-  #   end
-  #   
-  #   def load_tiles file_name_or_images, properties = {}
-  #     properties  = properties.dup
-  #     first_id    = properties.delete :firstgid
-  #     tile_width  = properties.delete :tilewidth
-  #     tile_height = properties.delete :tileheight
-  #     
-  #     @tiles[first_id..-1] = case file_name_or_images
-  #       when String then Gosu::Image.load_tiles(@map.window, file_name_or_images, tile_width, tile_height, true).freeze
-  #       when Array  then file_name_or_images.dup
-  #       else raise ArgumentError, "must supply a file name or an array of images"
-  #       end
-  #     
-  #   end # load_tiles
-  #   
-  #   def map; @map.__getobj__ end
-  #   
-  #   def [] tile_id
-  #     raise IndexError unless (0...@tiles.length).include? tile_id
-  #     @tiles[tile_id]
-  #   end
-  #   
-  #   def []= tile_id, image
-  #     raise IndexError unless (1...@tiles.length).include? tile_id
-  #     @tiles[tile_id] = image
-  #   end
-  #   
-  # end
-end
+  class TileSet < OpenStruct
+
+  end
+end

data/lib/tmx/version.rb

@@ -1,3 +1,3 @@
 module Tmx
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/features/json_format_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Tmx, "JSON Format" do
+
+  let(:fixture_file) { File.join File.dirname(__FILE__), "..", "fixtures", "map.json" }
+
+  let(:map) do
+    described_class.load(fixture_file)
+  end
+
+  let(:subject) { map }
+
+  its(:version) { should eq 1 }
+
+  its(:height) { should eq 12 }
+  its(:width) { should eq 16 }
+
+  its(:tileheight) { should eq 50 }
+  its(:tilewidth) { should eq 50 }
+
+  its(:orientation) { should eq "orthogonal" }
+
+  describe '#properties' do
+    it "has the correct number of properties" do
+      expect(subject.properties).to have(1).item
+    end
+
+    it "property values are correct" do
+      expect(subject.properties["hero.position"]).to eq "400,525,1"
+    end
+  end
+
+  describe '#layers' do
+    it "has the correct number of layers" do
+      expect(subject.layers).to have(1).item
+    end
+
+    context "when evaluating the first layer" do
+
+      let(:subject) { map.layers.first }
+
+      its(:name) { should eq "Tile Layer 1" }
+      its(:opacity) { should eq 1 }
+      its(:type) { should eq "tilelayer" }
+      its(:visible) { should be_true }
+      its(:height) { should eq 12 }
+      its(:width) { should eq 16 }
+      its(:x) { should eq 0 }
+      its(:y) { should eq 0 }
+
+      its(:data) { should eq [ 3, 3, 3, 3, 3, 3, 2, 5, 5, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 18, 9, 9, 17, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 15, 14, 4, 6, 7, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 4, 4, 4, 6, 7, 3, 3, 3, 3, 3, 18, 9, 17, 2, 4, 4, 10, 13, 4, 10, 11, 3, 3, 3, 3, 18, 14, 6, 7, 2, 4, 4, 7, 16, 8, 11, 3, 3, 3, 3, 3, 2, 4, 4, 15, 14, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 4, 4, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 16, 8, 8, 8, 13, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 12, 12, 12, 12, 16, 8, 8, 11, 3, 3, 3, 3, 3, 3] }
+    end
+  end
+
+  describe '#tilesets' do
+    it "has the correct number of tilesets" do
+      expect(subject.tilesets).to have(1).item
+    end
+
+    context "when evaluating the first tileset" do
+      let(:subject) { map.tilesets.first }
+
+      its(:firstgid) { should eq 1 }
+      its(:image) { should eq "tiles.png" }
+      its(:imageheight) { should eq 250 }
+      its(:imagewidth) { should eq 200 }
+      its(:margin) { should eq 0 }
+      its(:name) { should eq "tiles" }
+      its(:spacing) { should eq 0 }
+      its(:tileheight) { should eq 50 }
+      its(:tilewidth) { should eq 50 }
+      its(:properties) { should eq({}) }
+    end
+  end
+
+end

data/spec/features/xml_format_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Tmx, "TMX Formats" do
+
+  [ :zlib, :gzip, :uncompressed, :csv, :xml ].each do |format|
+
+    describe "#{format}" do
+
+      let(:fixture_file) { File.join File.dirname(__FILE__), "..", "fixtures", "map_#{format}.tmx" }
+
+      let(:map) do
+        described_class.load(fixture_file)
+      end
+
+      let(:subject) { map }
+
+      its(:version) { should eq 1 }
+
+      its(:height) { should eq 12 }
+      its(:width) { should eq 16 }
+
+      its(:tileheight) { should eq 50 }
+      its(:tilewidth) { should eq 50 }
+
+      its(:orientation) { should eq "orthogonal" }
+
+      describe '#properties' do
+        it "has the correct number of properties" do
+          expect(subject.properties).to have(1).item
+        end
+
+        it "property values are correct" do
+          expect(subject.properties["hero.position"]).to eq "400,525,1"
+        end
+      end
+
+      describe '#layers' do
+        it "has the correct number of layers" do
+          expect(subject.layers).to have(1).item
+        end
+
+        context "when evaluating the first layer" do
+
+          let(:subject) { map.layers.first }
+
+          its(:name) { should eq "Tile Layer 1" }
+          its(:opacity) { should eq 1 }
+          its(:type) { should eq "tilelayer" }
+          its(:visible) { should be_true }
+          its(:height) { should eq 12 }
+          its(:width) { should eq 16 }
+          its(:x) { should eq 0 }
+          its(:y) { should eq 0 }
+
+          its(:data) { should eq [ 3, 3, 3, 3, 3, 3, 2, 5, 5, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 18, 9, 9, 17, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 15, 14, 4, 6, 7, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 4, 4, 4, 6, 7, 3, 3, 3, 3, 3, 18, 9, 17, 2, 4, 4, 10, 13, 4, 10, 11, 3, 3, 3, 3, 18, 14, 6, 7, 2, 4, 4, 7, 16, 8, 11, 3, 3, 3, 3, 3, 2, 4, 4, 15, 14, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 4, 4, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 16, 8, 8, 8, 13, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 12, 12, 12, 12, 16, 8, 8, 11, 3, 3, 3, 3, 3, 3] }
+        end
+      end
+
+     describe '#tilesets' do
+      it "has the correct number of tilesets" do
+        expect(subject.tilesets).to have(1).item
+      end
+
+      context "when evaluating the first tileset" do
+        let(:subject) { map.tilesets.first }
+
+        its(:firstgid) { should eq 1 }
+        its(:image) { should eq "tiles.png" }
+        its(:imageheight) { should eq 250 }
+        its(:imagewidth) { should eq 200 }
+        its(:margin) { should eq 0 }
+        its(:name) { should eq "tiles" }
+        its(:spacing) { should eq 0 }
+        its(:tileheight) { should eq 50 }
+        its(:tilewidth) { should eq 50 }
+        its(:properties) { should eq({}) }
+      end
+    end
+
+
+    end
+
+  end
+end

data/spec/fixtures/map.json

@@ -0,0 +1,39 @@
+{ "height":12,
+ "layers":[
+        {
+         "data":[3, 3, 3, 3, 3, 3, 2, 5, 5, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 7, 18, 9, 9, 17, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 15, 14, 4, 6, 7, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 4, 4, 4, 6, 7, 3, 3, 3, 3, 3, 18, 9, 17, 2, 4, 4, 10, 13, 4, 10, 11, 3, 3, 3, 3, 18, 14, 6, 7, 2, 4, 4, 7, 16, 8, 11, 3, 3, 3, 3, 3, 2, 4, 4, 15, 14, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 2, 4, 4, 4, 4, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 16, 8, 8, 8, 13, 4, 4, 7, 3, 3, 3, 3, 3, 3, 3, 3, 12, 12, 12, 12, 16, 8, 8, 11, 3, 3, 3, 3, 3, 3],
+         "height":12,
+         "name":"Tile Layer 1",
+         "opacity":1,
+         "type":"tilelayer",
+         "visible":true,
+         "width":16,
+         "x":0,
+         "y":0
+        }],
+ "orientation":"orthogonal",
+ "properties":
+    {
+     "hero.position":"400,525,1"
+    },
+ "tileheight":50,
+ "tilesets":[
+        {
+         "firstgid":1,
+         "image":"tiles.png",
+         "imageheight":250,
+         "imagewidth":200,
+         "margin":0,
+         "name":"tiles",
+         "properties":
+            {
+
+            },
+         "spacing":0,
+         "tileheight":50,
+         "tilewidth":50
+        }],
+ "tilewidth":50,
+ "version":1,
+ "width":16
+}