nuri_game-tmx_reader 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bafedf74686bf3db56b4075b3ee9dba4474f255cc4fe3d08c46c5bd6d2dd588a
+  data.tar.gz: 55d792e678149e79724ce7e70313be8a0be4c400d603c501db60d756bd0da5de
+SHA512:
+  metadata.gz: 01ae0b8d7d024a892859268448299f17e2a597a8de4466f6057b44ac668a80c5489d3d77016f1db3d562b8cd92a939d37b9a18c271466a2523af36d1dc447cb1
+  data.tar.gz: 10d5816b916b005a63130674539a7eb7b04c1db9e5cc2eec7db60a17e60f52bb8a53656842733a543ba56cf8ac54926de4bbadb50a3df6d29730832f660669a4

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nuri_game-tmx_reader.gemspec
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+# NuriGame::TmxReader
+
+TMXReader that convert .tmx files to a ruby object
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuri_game-tmx_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nuri_game-tmx_reader
+
+## Usage
+
+```ruby
+require 'nuri_game/tmx_reader'
+
+# [...]
+
+map = NuriGame::TmxReader.new('mapname.tmx')
+# access here to map.layers, map.tilesets, map.width, map.height, map.tilewidth or map.tileheight
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 at https://gitlab.com/NuriYuri/nuri_game-tmx_reader.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nuri_game/tmx_reader"
+
+# 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/lib/nuri_game/tmx_reader/version.rb

@@ -0,0 +1,5 @@
+module NuriGame
+  class TmxReader
+    VERSION = "0.1.1"
+  end
+end

data/lib/nuri_game/tmx_reader.rb

@@ -0,0 +1,164 @@
+require 'nuri_game/tmx_reader/version'
+require 'rexml/document'
+require 'zlib'
+require 'base64'
+
+# NuriGame namespace containing all the utility made by Nuri Yuri in order to make Games.
+module NuriGame
+  # class that converts TMX file to Ruby object
+  class TmxReader
+
+    # Definition of a tileset
+    Tileset = Struct.new(:firstgid, :source)
+
+    # Constant holding the list of map information
+    MAP_INFOS = ['width', 'height', 'tilewidth', 'tileheight'].freeze
+
+    # @return [Integer] width of the map
+    attr_reader :width
+
+    # @return [Integer] height of the map
+    attr_reader :height
+
+    # @return [Integer] width of a tile on the map
+    attr_reader :tilewidth
+
+    # @return [Integer] height of a tile on the map
+    attr_reader :tileheight
+
+    # @return [Array<Tileset>] tilesets of the map
+    attr_reader :tilesets
+
+    # @return [Hash{String => Array<Integer>}] layers of the map (name => grid)
+    attr_reader :layers
+
+    # Create a new TmxReader
+    # @param filename [String] name of the tmx file to read
+    def initialize(filename)
+      contents = File.read(filename).force_encoding(Encoding::UTF_8)
+      map = REXML::Document.new(contents).root
+      @tilesets = []
+      @layers = {}
+      validate_map(map)
+      load_map_infos(map)
+      load_tilesets(map)
+      load_layers(map)
+    end
+
+    private
+
+    # Validate the map informations
+    # @parma map [REXML::Element]
+    def validate_map(map)
+      raise 'Invalid TMX data, root element is not a <map>' if map.name != 'map'
+      raise 'Invalid TMX orientation, expect orthogonal' if xml_value(map, 'orientation') != 'orthogonal'
+      raise 'Invalid TMX renderorder, expect left-up' if xml_value(map, 'renderorder') != 'left-up'
+      raise 'Invalid TMX map format, should not be infinite' if xml_value(map, 'infinite').to_i != 0
+    end
+
+    # Load the map informations
+    # @param map [REXML::Element]
+    def load_map_infos(map)
+      MAP_INFOS.each { |name| instance_variable_set(:"@#{name}", xml_value(map, name).to_i) }
+    end
+
+    # Load the map tilesets
+    # @param map [REXML::Element]
+    def load_tilesets(map)
+      tilesets = @tilesets
+      map.each_element('tileset') do |tileset|
+        tilesets << Tileset.new(xml_value(tileset, 'firstgid').to_i, xml_value(tileset, 'source').to_s)
+      end
+    end
+
+    # Load the map layers (flattened)
+    # @param map [REXML::Element]
+    def load_layers(map)
+      map.each_element_with_attribute('name') do |layer|
+        if layer.name == 'group'
+          load_layer_group(layer, xml_value(layer, 'name'))
+        elsif layer.name == 'layer'
+          @layers[xml_value(layer, 'name')] = load_layer(layer)
+        end
+      end
+    end
+
+    # Load the layer from a group
+    # @param group [REXML::Element]
+    # @param groupname [String]
+    def load_layer_group(group, groupname)
+      group.each_element do |layer|
+        if layer.name == 'group'
+          load_layer_group(layer, File.join(groupname, xml_value(layer, 'name')))
+        elsif layer.name == 'layer'
+          name = File.join(groupname, xml_value(layer, 'name'))
+          @layers[name] = load_layer(layer)
+        end
+      end
+    end
+
+    # Load the layer data
+    # @param layer [REXML::Element]
+    def load_layer(layer)
+      data = get_layer_data(layer)
+      # Perform stuff if there's offset & co (but shouldn't happen since we don't allow infinite maps)
+      return data
+    end
+
+    # Get the layer data
+    # @source https://github.com/shawn42/tmx/blob/master/lib/tmx/parsers/tmx-rexml.rb
+    # @param layer [REXML::Element]
+    def get_layer_data(layer)
+      data = REXML::XPath.first(layer, 'data')
+      enc = xml_value(data, 'encoding')
+      comp = xml_value(data, 'compression')
+      layer_data = REXML::XPath.first(layer, 'data').text.strip
+      layer_data = Base64.decode64(layer_data) if enc == 'base64'
+
+      case comp
+      when 'zlib'
+        return unpack_data(zlib_decompress(layer_data))
+      when 'gzip'
+        return unpack_data(gzip_decompress(layer_data))
+      else
+        case enc
+        when 'base64'
+          return unpack_data(layer_data)
+        when 'csv'
+          return layer_data.split(',').collect(&:to_i)
+        end
+      end
+      REXML::XPath.match(layer, "data/tile").map { |tile| tile.attributes["gid"].to_i }
+    end
+
+    # Decompress using Zlib
+    # @param data [String]
+    # @return [String]
+    def zlib_decompress(data)
+      Zlib::Inflate.inflate(data)
+    end
+
+    # Decompress using Gzip
+    # @param data [String]
+    # @return [String]
+    def gzip_decompress(data)
+      Zlib::GzipReader.new(StringIO.new(data)).read
+    end
+
+    # Convert data into valid Ruby Data
+    # @param data [String]
+    # @return [Array<Integer>]
+    def unpack_data(data)
+      data.unpack('V*')
+    end
+
+    # Return an xml value
+    # @param element [REXML::Element]
+    # @param value_name [String]
+    # @return [String, nil] nil means no value
+    def xml_value(element, value_name)
+      val = element.attribute(value_name)
+      return val ? val.value : nil
+    end
+  end
+end

data/nuri_game-tmx_reader.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nuri_game/tmx_reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nuri_game-tmx_reader"
+  spec.version       = NuriGame::TmxReader::VERSION
+  spec.authors       = ["Nuri Yuri"]
+  spec.email         = ["hostmaster@pokemonworkshop.com"]
+
+  spec.summary       = %q{TMXReader that convert .tmx files to a ruby object}
+  spec.homepage      = "https://gitlab.com/NuriYuri/nuri_game-tmx_reader"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: nuri_game-tmx_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nuri Yuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- hostmaster@pokemonworkshop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nuri_game/tmx_reader.rb
+- lib/nuri_game/tmx_reader/version.rb
+- nuri_game-tmx_reader.gemspec
+homepage: https://gitlab.com/NuriYuri/nuri_game-tmx_reader
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: TMXReader that convert .tmx files to a ruby object
+test_files: []