tileset_tooling 0.0.2

data/lib/tileset_tooling/data/tileset.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'tileset_tooling/data/tile'
+
+# Class representing a TileSet row
+class ::TilesetTooling::Data::TileSetRow
+  # Default constructor taking a list of tiles
+  def initialize(tiles)
+    @tiles = tiles
+  end
+
+  attr_reader :tiles
+end
+
+# Class representing a TileSet's information
+class ::TilesetTooling::Data::TileSet < ::Dry::Struct
+  attribute :image, ::TilesetTooling::Data::Types::ImageType
+  attribute :original_image_path, ::TilesetTooling::Data::Types::String
+  attribute :tile_height, ::TilesetTooling::Data::Types::Integer
+  attribute :tile_width, ::TilesetTooling::Data::Types::Integer
+  attribute :margin, ::TilesetTooling::Data::Types::Integer
+  attribute :offset_top, ::TilesetTooling::Data::Types::Integer
+  attribute :offset_left, ::TilesetTooling::Data::Types::Integer
+
+  # Helper to print all information in the image
+  def to_s
+    %(
+Image '#{original_image_path}'
+  Tile height: #{tile_height}
+  Tile width: #{tile_width}
+  Margin: #{margin}
+  Top offset: #{offset_top}
+  Left offset: #{offset_left}
+  Number of tiles: #{rows.count * rows[0].tiles.count})
+  end
+
+  # Runs the given bloc on each tile of the tileset
+  def for_each_tile(&block)
+    rows.each do |row|
+      row.tiles.each do |tile|
+        block.call(tile)
+      end
+    end
+  end
+
+  # Gets the height of the tileset/image
+  def height
+    image.height
+  end
+
+  # Gets the width of the tileset/image
+  def width
+    image.width
+  end
+
+  private
+
+  # Computes the tiles and returns them
+  def rows
+    return @rows unless @rows.nil?
+
+    @rows = []
+    top = offset_top
+    loop do
+      left = offset_left
+      tiles = []
+      margin_top = top.positive? ? margin : 0
+      margin_bottom = top + tile_height < height ? margin : 0
+
+      loop do
+        margin_left = left.positive? ? margin : 0
+        margin_right = left + tile_width < width ? margin : 0
+
+        tiles << ::TilesetTooling::Data::Tile.new(
+          top: top + margin_top,
+          left: left + margin_left,
+          height: tile_height,
+          width: tile_width,
+          margin_top: margin_top,
+          margin_left: margin_left,
+          margin_bottom: margin_bottom,
+          margin_right: margin_right
+        )
+        left += tile_width + margin_left + margin_right
+        break if left >= width
+      end
+
+      @rows << ::TilesetTooling::Data::TileSetRow.new(tiles)
+      top += tile_height + margin_top + margin_bottom
+      break if top >= height
+    end
+
+    @rows
+  end
+end

data/lib/tileset_tooling/data/types.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+# Module containing all types to be used for Dry::Struct structures
+module ::TilesetTooling::Data::Types
+  include ::Dry.Types()
+
+  ImageType = ::TilesetTooling::Data::Types.Instance(::MiniMagick::Image)
+
+  public_constant :ImageType
+end

data/lib/tileset_tooling/utils.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'mini_magick'
+
+# A few random utilities
+module ::TilesetTooling::Utils
+  module_function
+
+  # Generate a signature from the image data
+  def image_signature(image_path)
+    ::MiniMagick::Tool::Identify.new do |identity|
+      identity.quiet
+      identity.format('%#\\n')
+      identity << image_path
+    end
+  end
+
+  # Gets the path to the spec file that should go with the given image
+  def image_spec_file_path(image_path)
+    file_name = ::File.basename(image_path, '.*')
+    directory = ::File.dirname(image_path)
+
+    "#{directory}/#{file_name}.specs"
+  end
+end

data/lib/tileset_tooling/version.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+module ::TilesetTooling
+  VERSION = '0.0.2'
+  public_constant :VERSION
+end

data/test/commands/insert_bleed_test.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ::TestInsertBleed < ::Test::Unit::TestCase
+  def test_margin_required
+    input, = get_png_data('simple_no_margin.png')
+    command = ::TilesetTooling::Commands::InsertBleed.new({}, [input])
+    command.expects(:ask_specs).returns([16, 16, 0, 0, 0])
+    command.unpack!
+
+    assert_raise ::StandardError, 'Current implementation needs an existing margin' do
+      command.run
+    end
+  end
+
+  def test_simple_file
+    input, expected = get_png_data('simple_with_margin.png')
+    output = output_file_path
+    options = { output: output }
+    args = [input]
+    command = ::TilesetTooling::Commands::InsertBleed.new(options, args)
+    command.expects(:ask_specs).returns([16, 16, 1, 0, 0])
+    command.unpack!
+    command.run
+    assert ::File.exist?(expected)
+    assert ::File.exist?(output)
+    output_signature = ::TilesetTooling::Utils.image_signature(output)
+    expected_signature = ::TilesetTooling::Utils.image_signature(expected)
+    assert_equal(expected_signature, output_signature)
+  end
+
+  def test_simple_file_with_specs
+    input, expected = get_png_data('simple_with_specs.png')
+    output = output_file_path
+    options = { output: output }
+    args = [input]
+    command = ::TilesetTooling::Commands::InsertBleed.new(options, args)
+    command.unpack!
+    command.run
+    assert ::File.exist?(expected)
+    assert ::File.exist?(output)
+    output_signature = ::TilesetTooling::Utils.image_signature(output)
+    expected_signature = ::TilesetTooling::Utils.image_signature(expected)
+    assert_equal(expected_signature, output_signature)
+  end
+
+  def test_simple_file_with_bad_specs
+    input, = get_png_data('simple_with_bad_specs.png')
+    output = output_file_path
+    options = { output: output }
+    args = [input]
+    command = ::TilesetTooling::Commands::InsertBleed.new(options, args)
+    command.unpack!
+    assert_raise ::StandardError, 'Invalid specs file' do
+      command.run
+    end
+  end
+
+  def test_simple_file_with_skip_specs
+    input, expected = get_png_data('simple_with_bad_specs.png')
+    output = output_file_path
+    options = { output: output, 'skip-specs': true }
+    args = [input]
+    command = ::TilesetTooling::Commands::InsertBleed.new(options, args)
+    command.expects(:ask_specs).returns([16, 16, 1, 0, 0])
+    command.unpack!
+    command.run
+    assert ::File.exist?(expected)
+    assert ::File.exist?(output)
+    output_signature = ::TilesetTooling::Utils.image_signature(output)
+    expected_signature = ::TilesetTooling::Utils.image_signature(expected)
+    assert_equal(expected_signature, output_signature)
+  end
+end

data/test/data/simple_with_bad_specs.specs

@@ -0,0 +1,2 @@
+I'm not a YAML
+I'm nothing ...

data/test/data/simple_with_specs.specs

@@ -0,0 +1,7 @@
+specs:
+  details:
+    tile_height: 16
+    tile_width: 16
+    margin: 1
+    offset_top: 0
+    offset_left: 0

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'test/unit'
+require 'mocha/test_unit'
+
+require 'tileset_tooling/app'
+
+# In case we need debugging, uncomment the following
+# ::SemanticLogger.sync!
+# ::SemanticLogger.default_level = :trace
+# ::SemanticLogger.add_appender(io: $stdout, formatter: :color)
+
+def get_png_data(name)
+  input = "#{__dir__}/data/#{name}"
+  expected = "#{__dir__}/data/expected/#{name}"
+
+  [input, expected]
+end
+
+def output_file_path
+  "#{__dir__}/data/tmp_output.png"
+end

data/test/utils_test.rb

@@ -0,0 +1,12 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ::TestUtils < ::Test::Unit::TestCase
+  def test_image_signature
+    input, = get_png_data('simple_no_margin.png')
+    signature = ::TilesetTooling::Utils.image_signature(input)
+    assert_equal('7a61e5c691289afc9d6eb50b52ac7cac05241271775d20233e07ec431e24c9c7', signature)
+  end
+end

data/tileset_tooling.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__), 'lib', 'tileset_tooling', 'version.rb'])
+
+Gem::Specification.new do |s|
+  s.name = 'tileset_tooling'
+  s.version = TilesetTooling::VERSION
+  s.author = 'Jean-Sebastien Gelinas'
+  s.email = 'calestar@gmail.com'
+  s.homepage = 'https://github.com/calestar/tileset_tooling'
+  s.license = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.6.3'
+  s.summary = 'Bits of tooling I use for working with tilesets'
+  s.files = `git ls-files`.split('
+')
+  s.require_paths << 'lib'
+  s.extra_rdoc_files = ['README.rdoc', 'tileset_tooling.rdoc']
+  s.rdoc_options << '--title' << 'tileset_tooling' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'tileset_tooling'
+  s.add_development_dependency('aruba', '~> 1.0', '>= 1.0.3')
+  s.add_development_dependency('mocha', '~> 1.11', '>= 1.11.2')
+  s.add_development_dependency('rake', '~> 12.3', '>= 12.3.3')
+  s.add_development_dependency('rdoc', '~> 6.2', '>= 6.2.1')
+  s.add_development_dependency('rubocop', '~> 0.90', '>= 0.90.0')
+  s.add_development_dependency('test-unit', '~> 3.3', '>= 3.3.6')
+  s.add_runtime_dependency('dry-struct', '~> 1.3', '>= 1.3.0')
+  s.add_runtime_dependency('gli', '~> 2.19', '2.19.2')
+  s.add_runtime_dependency('highline', '~> 2.0', '>= 2.0.3')
+  s.add_runtime_dependency('mini_magick', '~> 4.10', '>= 4.10.1')
+  s.add_runtime_dependency('semantic_logger', '~> 4.7', '>= 4.7.2')
+end

data/tileset_tooling.rdoc

@@ -0,0 +1,48 @@
+== tileset_tooling - Bits of tooling I use for working with tilesets
+
+v0.0.1
+
+=== Global Options
+=== --help
+Show this message
+
+
+
+=== --version
+Display the program version
+
+
+
+=== Commands
+==== Command: <tt>bleed </tt>
+Commands relating to bleed around tiles
+
+
+===== Commands
+====== Command: <tt>insert </tt>
+Inserts a bleed around tiles
+
+
+======= Options
+======= --output path
+
+Path where to store result
+
+[Default Value] None
+
+
+======= --[no-]skip-specs
+Skips the reading of the specs
+
+
+
+==== Command: <tt>help  command</tt>
+Shows a list of commands or help for one command
+
+Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function
+===== Options
+===== -c
+List commands one per line, to assist with shell completion
+
+
+

metadata

@@ -0,0 +1,317 @@
+--- !ruby/object:Gem::Specification
+name: tileset_tooling
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jean-Sebastien Gelinas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.90.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.90'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.6
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.19.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.19.2
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.10.1
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.2
+description: 
+email: calestar@gmail.com
+executables:
+- tileset_tooling
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- tileset_tooling.rdoc
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".vscode/settings.json"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- bin/tileset_tooling
+- features/insert_bleed.feature
+- features/step_definitions/file_steps.rb
+- features/step_definitions/help_steps.rb
+- features/step_definitions/insert_bleed_steps.rb
+- features/support/configuration.rb
+- features/support/env.rb
+- features/support/test_data.rb
+- features/tileset_tooling.feature
+- lib/tileset_tooling.rb
+- lib/tileset_tooling/app.rb
+- lib/tileset_tooling/commands.rb
+- lib/tileset_tooling/commands/insert_bleed.rb
+- lib/tileset_tooling/data.rb
+- lib/tileset_tooling/data/tile.rb
+- lib/tileset_tooling/data/tileset.rb
+- lib/tileset_tooling/data/types.rb
+- lib/tileset_tooling/utils.rb
+- lib/tileset_tooling/version.rb
+- test/commands/insert_bleed_test.rb
+- test/data/UIpackSheet_transparent.png
+- test/data/expected/simple_with_bad_specs.png
+- test/data/expected/simple_with_margin.png
+- test/data/expected/simple_with_specs.png
+- test/data/simple_no_margin.png
+- test/data/simple_with_bad_specs.png
+- test/data/simple_with_bad_specs.specs
+- test/data/simple_with_margin.png
+- test/data/simple_with_specs.png
+- test/data/simple_with_specs.specs
+- test/data/source/simple_no_margin.xcf
+- test/data/source/simple_with_margin.xcf
+- test/test_helper.rb
+- test/utils_test.rb
+- tileset_tooling.gemspec
+- tileset_tooling.rdoc
+homepage: https://github.com/calestar/tileset_tooling
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- tileset_tooling
+- "--main"
+- README.rdoc
+- "-ri"
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Bits of tooling I use for working with tilesets
+test_files: []