nuri_game-tsx_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c4b8006d2c3562328037fbd925f9c85c02932d690117c6b0fbe5185ae99c1a5
+  data.tar.gz: 2bee46cacff8dc0bb8acdad254f86c18cdd7b1e37337b471d17d1fb2aa354d96
+SHA512:
+  metadata.gz: cfd6db6e7a381d833899c89fcfa6a31acfd198c2b3b3a80cca4690072279df9b6152b94518318ddbde27ca94a369ac5761f9a8a43123f92646ee0882a7489b47
+  data.tar.gz: fe3cefcd9144e3aea3e92eac03225df2e8e34b05bd98c9f8b7decc9b1402342ff71d4a06cd737f798427dd7f7e2e77163a00412e6a7c9b8bcff5aabb0da3444e

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

data/README.md

@@ -0,0 +1,50 @@
+# NuriGame::TsxReader
+
+TSXReader that convert .tsx files to a ruby object
+
+## Note
+
+Currently the following feature of tileset aren't supported :
+* animation
+* wangsets
+* grid
+* tile
+
+(I don't even know how some works and I couldn't understand so you're free to help for that ^^')
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuri_game-tsx_reader'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nuri_game-tsx_reader
+
+## Usage
+
+```ruby
+require 'nuri_game/tsx_reader'
+
+# [...]
+
+tileset = NuriGame::TsxReader.new('tilesetname.tsx')
+# access here to tileset properties (see doc)
+```
+
+## 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 at https://gitlab.com/NuriYuri/nuri_game-tsx_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/tsx_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/tsx_reader.rb

@@ -0,0 +1,120 @@
+require 'nuri_game/tsx_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 TSX file to Ruby object
+  class TsxReader
+    # Definition of an image
+    Image = Struct.new(:format, :source, :trans, :width, :height, :data)
+
+    # Constant holding the list of tileset information
+    TILESET_INFOS = %w[tilewidth tileheight tilecount columns spacing margin].freeze
+
+    # @return [String] name of the tileset
+    attr_reader :name
+
+    # @return [Integer] number of tiles in the tileset
+    attr_reader :tilecount
+
+    # @return [Integer] number of columns in the tileset
+    attr_reader :columns
+
+    # @return [Integer] width of a tile on the tileset
+    attr_reader :tilewidth
+
+    # @return [Integer] height of a tile on the tileset
+    attr_reader :tileheight
+
+    # @return [Integer] space in px between tiles in the tileset image
+    attr_reader :spacing
+
+    # @return [Integer] margin around the tile of the tileset
+    attr_reader :margin
+
+    # @return [Hash{String => Integer}] terrains of the tileset by name
+    attr_reader :terrains
+
+    # @return [Image] image used in the tileset
+    attr_reader :image
+
+    # 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)
+      tileset = REXML::Document.new(contents).root
+      @terrains = {}
+      validate_tileset(tileset)
+      load_tileset_infos(tileset)
+      load_tileset_image(tileset)
+      load_tileset_terrains(tileset)
+    end
+
+    private
+
+    # Validate the tileset informations
+    # @parma tileset [REXML::Element]
+    def validate_tileset(tileset)
+      raise 'Invalid TSX data, root element is not a <tileset>' if tileset.name != 'tileset'
+    end
+
+    # Load the tileset informations
+    # @param tileset [REXML::Element]
+    def load_tileset_infos(tileset)
+      @name = xml_value(tileset, 'name').to_s
+      TILESET_INFOS.each { |name| instance_variable_set(:"@#{name}", xml_value(tileset, name).to_i) }
+    end
+
+    # Load the image of the tileset
+    # @param tileset [REXML::Element]
+    def load_tileset_image(tileset)
+      image = REXML::XPath.first(tileset, 'image')
+      data = REXML::XPath.first(image, 'data')
+      data = load_image_data(data)
+      @image = Image.new(
+        xml_value(image, 'format'),
+        xml_value(image, 'source'),
+        xml_value(image, 'trans'),
+        xml_value(image, 'width').to_i,
+        xml_value(image, 'height').to_i,
+        data
+      )
+    end
+
+    # Load the terrains of the tileset
+    # @param tileset [REXML::Element]
+    def load_tileset_terrains(tileset)
+      tileset.each_element('terraintypes/terrain') do |terrain|
+        @terrains[xml_value(terrain, 'name')] = xml_value(terrain, 'tile').to_i
+      end
+    end
+
+    # Load the image data of the tileset
+    # @param data [REXML::Element]
+    def load_image_data(data)
+      return unless data
+      raw_data = data.text.strip
+      enc = xml_value(data, 'encoding')
+      comp = xml_value(data, 'compression')
+      raw_data = Base64.decode64(raw_data) if enc == 'base64'
+      case comp
+      when 'zlib'
+        return Zlib::Inflate.inflate(raw_data)
+      when 'gzip'
+        return Zlib::GzipReader.new(StringIO.new(raw_data)).read
+      end
+      return raw_data
+    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/lib/nuri_game/tsx_reader/version.rb

@@ -0,0 +1,5 @@
+module NuriGame
+  class TsxReader
+    VERSION = "0.1.0"
+  end
+end

data/nuri_game-tsx_reader.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nuri_game/tsx_reader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nuri_game-tsx_reader"
+  spec.version       = NuriGame::TsxReader::VERSION
+  spec.authors       = ["Nuri Yuri"]
+  spec.email         = ["hostmaster@pokemonworkshop.com"]
+
+  spec.summary       = %q{TSXReader that convert .tsx files to a ruby object}
+  spec.homepage      = "https://gitlab.com/NuriYuri/nuri_game-tsx_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-tsx_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nuri Yuri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-15 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/tsx_reader.rb
+- lib/nuri_game/tsx_reader/version.rb
+- nuri_game-tsx_reader.gemspec
+homepage: https://gitlab.com/NuriYuri/nuri_game-tsx_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: TSXReader that convert .tsx files to a ruby object
+test_files: []