tmx 0.0.1 → 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGY5ZWFiM2U3NWQ1M2NjYzUxYzI3ODkxNTMyMTllZWFmZDA1YzM1Nw==
+  data.tar.gz: !binary |-
+    ZGZhODNjYzFjYWMzMjc5ZmZlZGMxNWVjODY4MGUzODYzZmNhZjRmYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjZjZDljYzVmZmM5ODJjNGYzNzRiNmEyMzZiYzcxOTRhZmZjODI0MjQ0MjA1
+    ZmYxMmNmOTA1Zjc5MmI1NGEzYWFjNWUxYTdjMjhiZTViYzg2Y2QyNzAyMjRh
+    OTUwZDk3NmQwOTViYWRlZjk2OWQwZWVhNjRlNzZhODA5OGJhYzk=
+  data.tar.gz: !binary |-
+    MWU1Y2QxMzEyOWY5MDJjOWUzMjU5NjcyZDY0ZWRmZWYxODNmNzU2MjczZTc1
+    N2QxNjQyZmU1MGZjNTQzZmVkY2I1NWI4MzBjNmY5NzkyMTQ0OWRlNWJkZTY3
+    MWZjMjRiM2MwMzFhOTkyNTNhMzI5YWNmNjM5NmIxZTAwZjNhNWM=

data/.gitignore

@@ -1,12 +1,17 @@
-pkg
-*.swp
-*.log
-doc
-coverage
-.DS_Store
+*.gem
+*.rbc
+.bundle
+.config
 .yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
 tmp
-tags
-ctags
-.bundle
-*.lock

data/.rspec

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

data/Gemfile

@@ -1,4 +1,10 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in gosu-tmx.gemspec
 gemspec
+
+group :test, :development do
+  gem 'debugger'
+  gem 'rspec'
+  gem 'guard-rspec'
+  gem 'rb-fsevent', '~> 0.9'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Shawn Anderson, Franklin Webber
+
+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,32 @@
+# Tmx
+
+A library for parsing the **[Tiled Map Editor](http://www.mapeditor.org/)** file format.
+
+## Support
+
+* JSON format
+* TMX file (XML)
+* TMX file (Base64)
+* TMX file (Base64 zlib compressed)
+* TMX file (Base64 gzip compressed)
+* TMX file (CSV)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tmx'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install tmx
+```

data/lib/tmx.rb

@@ -1,16 +1,55 @@
-autoload :Base64,   'base64'
-autoload :Nokogiri, 'nokogiri'
-autoload :WeakRef,  'weakref'
-# autoload :Zlib,     'zlib'
+require 'ostruct'
 
-# mysterious autoload failure
-require 'zlib'
-
-require 'tmx/nokogiri_additions'
+require "tmx/version"
+require "tmx/parsers/parsers"
+require "tmx/map"
 
 module Tmx
-  autoload :Coder,       'tmx/coder'
-  autoload :Layer,       'tmx/layer'
-  autoload :Map,         'tmx/map'
-  autoload :ObjectGroup, 'tmx/object_group'
-end
+  extend self
+
+  #
+  # Load the specified TMX file and return a Map that was found.
+  #
+  # @param [String] filename the name fo the Tiled Map file.
+  # @param [Hash] options
+  #
+  # @returns [Map] the map instance defined within the specified file
+  #
+  def load(filename,options={})
+    options = default_options(filename).merge(options)
+    parse contents(filename), options
+  end
+
+  #
+  # Parse the the string contents of a TMX file.
+  #
+  # @returns [Map] the map instance defined within the string
+  def parse(contents,options={})
+    contents = parser(options).parse contents
+    Map.new contents.merge(contents: contents)
+  end
+
+  private
+
+  def format(filename)
+    File.extname(filename)[1..-1]
+  end
+
+  def contents(filename)
+    File.read(filename)
+  end
+
+  def default_options(filename)
+    { format: format(filename) }
+  end
+
+  def parser(options)
+    format = options[:format].to_sym
+    parsers[format].new(options)
+  end
+
+  def parsers
+    Parsers.parsers
+  end
+
+end

data/lib/tmx/layer.rb

@@ -1,74 +1,5 @@
 module Tmx
-  class Layer
-    attr_reader :properties
-    attr_reader :columns, :rows
-    
-    def initialize map, data, properties
-      @map        = WeakRef.new map
-      @properties = properties.dup
-      
-      @columns = @properties.delete(:width)  or raise ArgumentError, "layer width is required"
-      @rows    = @properties.delete(:height) or raise ArgumentError, "layer height is required"
-            
-      @tile_ids = case data
-        when String then data.unpack('V*')
-        when Array  then data.dup
-        when nil    then Array.new @columns * @rows, 0
-        else raise ArgumentError, "data must be a binary string or an array of integers"
-        end
-    end # initialize
-    
-    def map; @map.__getobj__ end
-    
-    def [] x, y
-      raise IndexError unless x_range.include? x and y_range.include? y
-      @tile_ids[offset(x, y)]
-    end
-    
-    def []= x, y, id
-      raise IndexError unless x_range.include? x and y_range.include? y
-      @tile_ids[offset(x, y)] = id
-    end
-    
-    def each_tile_id &block
-      y_range.each do |y|
-        x_range.each do |x|
-          yield x, y, @tile_ids[offset(x, y)]
-        end
-      end
-    end # each_tile_id
-    
-    def x_range; 0...@columns end
-    def y_range; 0...@rows    end
-    
-    # def draw x_off, y_off, z_off, x_range, y_range
-    #   x_range = [x_range.min, 0].max .. [x_range.max, @columns  - 1].min
-    #   y_range = [y_range.min, 0].max .. [y_range.max, @rows     - 1].min
-    #   
-    #   tile_set    = @map.tile_set
-    #   tile_width  = @map.tile_width
-    #   tile_height = @map.tile_height
-    #   
-    #   y_range.each do |y|
-    #     tile_y_off = y_off + y * tile_height
-    #     
-    #     x_range.each do |x|
-    #       tile_x_off = x_off + x * tile_width
-    #       tile_index = @tile_ids[offset(x, y)]
-    #       
-    #       image = tile_set[tile_index]
-    #       next if image.nil?
-    #       
-    #       image.draw tile_x_off, tile_y_off, z_off, 1, 1, @color
-    #     end
-    #   end
-    # end
-    
-    private
-    
-    def offset x, y
-      x + y * @columns
-    end
-    
-  end # Layer
-end
+  class Layer < OpenStruct
+
+  end
+end

data/lib/tmx/map.rb

@@ -1,147 +1,15 @@
+require 'tmx/tile_set'
+require 'tmx/layer'
+
 module Tmx
-  class Map
-    # autoload :TileCache, 'tmx/map/tile_cache'
-    autoload :XMLLoader, 'tmx/map/xml_loader'
-    
-    include XMLLoader
-    
-    attr_reader :properties
-    attr_reader :columns,    :rows
-    attr_reader :width,      :height
-    attr_reader :tile_width, :tile_height
-    
-    attr_reader :layers, :object_groups#, :tile_set
-    
-    DEFAULT_OPTIONS = {
-      # Scales pixel units to tile units (if true) or user-defined scale (if
-      # numeric) when passing them to callbacks.
-      :scale_units => false,
-      
-      # Hooks for object, layer and tile set creation. Only on_object is
-      # implemented so far.
-      :on_tile_set => nil,
-      :on_layer    => nil,
-      :on_object   => nil,
-      
-      # This option discards all layer, object group and tile set info after
-      # building the tile cache; uses less memory if you don't intend to
-      # modify the map at run time.
-      :discard_structure   => false,
-      
-      # These three options allow finer grained control of what to throw away
-      # in case you intend to modify only certain aspects of the map.
-      :discard_layer_info  => false,
-      :discard_object_info => false,
-    }
-    
-    def initialize file_name, options = {}
-      options = DEFAULT_OPTIONS.merge options
-      
-      # TODO move this XML code to an external module
-      # TODO allow file name or xml document?
-      # TODO allow other map formats?
-      
-      mapdef = File.open(file_name) do |io|
-        doc = Nokogiri::XML(io) { |conf| conf.noent.noblanks }
-        
-        # TODO figure out why this always fails
-        # errors = doc.validate
-        
-        doc.root
-      end
-      
-      # TODO proper version check; learn about Tmx versions if there are any
-      raise "Only version 1.0 maps are currently supported" unless mapdef['version']     == '1.0'
-      raise "Only orthogonal maps are currently supported"  unless mapdef['orientation'] == 'orthogonal'
-      
-      # @cache  = TileCache.new self
-      
-      @tile_width  = mapdef['tilewidth'].to_i
-      @tile_height = mapdef['tileheight'].to_i
-      
-      @columns = mapdef['width'].to_i
-      @rows    = mapdef['height'].to_i
-      
-      @scale_units = case options[:scale_units]
-        when Numeric      then options[:scale_units].to_f
-        when :tile_width  then 1.0 / @tile_width
-        when :tile_height then 1.0 / @tile_height
-        when true         then 1.0 / [@tile_width, @tile_height].min
-        else false
-        end 
-      
-      if @scale_units
-        @width  = @columns.to_f * @scale_units
-        @height = @rows.to_f    * @scale_units
-      else
-        @width  = @columns * @tile_width
-        @height = @rows    * @tile_height
-      end
-      
-      @properties = mapdef.tmx_parse_properties
-      
-#      @tile_set = TileSet.new self
-      
-      @layers        = Hash[]
-      @object_groups = Hash[]
-      
-      # callback for custom object creation
-      @on_object = options[:on_object]
-      
-      # mapdef.xpath('tileset').each do |xml|
-      #   @tile_set.load_tiles *parse_tile_set_def(xml)
-      # end
-      
-      mapdef.xpath('layer').each do |xml|
-        layer = parse_layer_def xml
-        name  = layer.properties[:name]
-        @layers[name] = layer
-      end # layers
-      
 
-      mapdef.xpath('objectgroup').each do |xml|
-        group = parse_object_group_def xml
-        name  = group.name
-        @object_groups[name] = group
-      end # object groups
-      
-      # @cache.rebuild!
-      
-      discard_structure = @properties.delete(:discard_structure)
-      
-      @layers        = nil if @properties.delete(:discard_layer_info)  || discard_structure
-      # @tile_sets     = nil if @properties.delete(:discard_tile_info)   || discard_structure
-      @object_groups = nil if @properties.delete(:discard_object_info) || discard_structure
-      
-    end # initialize
-    
-    # def create_tile_set name, file_name_or_images, properties
-    #   raise NotImplementedError
-    # end
-    
-    def create_layer name, data, properties
-      raise NotImplementedError
+  class Map < OpenStruct
+    def layers
+      @layers ||= Array(contents['layers']).map {|layer| Layer.new layer.merge(contents: layer) }
     end
-    
-    def create_object_group name, properties
-      raise NotImplementedError
+
+    def tilesets
+      @tilesets ||= Array(contents['tilesets']).map {|set| TileSet.new set.merge(contents: set) }
     end
-    
-    def draw x_off, y_off, z_off = 0, x_range = 0...@columns, y_range = 0...@rows
-      # @cache.draw x_off, y_off, z_off, x_range, y_range
-      @layers.each_value.with_index do |layer, index|
-        layer.draw x_off, y_off, z_off + index, x_range, y_range
-      end
-    end # draw
-    
-    protected
-    
-    def on_object name, group, properties
-      if @on_object
-        @on_object.call name, group, properties
-      else
-        properties
-      end
-    end # on_object
-  end # Map
-end
+  end
+end

data/lib/tmx/parsers/json.rb

@@ -0,0 +1,24 @@
+require 'oj'
+
+module Tmx
+  module Parser
+
+    #
+    # Parses the JSON formatted output from Tiled.
+    #
+    class Json
+      attr_reader :options
+
+      def initialize(options)
+        @options = options
+      end
+
+      def parse(contents)
+        Oj.load(contents)
+      end
+    end
+
+  end
+
+  Parsers.register :json, Parser::Json
+end