tileset_tooling 0.0.2

data/features/insert_bleed.feature

@@ -0,0 +1,56 @@
+Feature: App inserts bleed correctly
+  Simple test to validate that the bleed around tiles
+  is added correctly when running the full executable
+
+  Scenario: Insert bleed has help
+    When I get help for bleed insert
+    Then the exit status should be 0
+
+  Scenario: Insert bleed without margin
+    When I insert bleed to test data "simple_no_margin.png"
+    Then I type "16"
+    Then I type "16"
+    Then I type "0"
+    Then I type "0"
+    Then I type "0"
+    Then the exit status should be 1
+    Then the output should contain "Current implementation needs an existing margin"
+
+  Scenario: Insert bleed generate default output
+    When I insert bleed to test data "simple_with_margin.png"
+    Then I type "16"
+    Then I type "16"
+    Then I type "1"
+    Then I type "0"
+    Then I type "0"
+    Then the exit status should be 0
+    Then generated file should be the same as data result "simple_with_margin.png"
+
+  Scenario: Insert bleed specific output
+    When I insert bleed to test data "simple_with_margin.png" and output to "test_output.png"
+    Then I type "16"
+    Then I type "16"
+    Then I type "1"
+    Then I type "0"
+    Then I type "0"
+    Then the exit status should be 0
+    Then generated file should be the same as data result "simple_with_margin.png"
+
+  Scenario: Insert bleed with specs
+    When I insert bleed to test data "simple_with_specs.png"
+    Then the exit status should be 0
+    Then generated file should be the same as data result "simple_with_specs.png"
+
+  Scenario: Insert bleed with bad specs
+    When I insert bleed to test data "simple_with_bad_specs.png"
+    Then the exit status should be 1
+
+  Scenario: Insert bleed with skipped specs
+    When I insert bleed to test data "simple_with_bad_specs.png" and skip specs loading
+    Then I type "16"
+    Then I type "16"
+    Then I type "1"
+    Then I type "0"
+    Then I type "0"
+    Then the exit status should be 0
+    Then generated file should be the same as data result "simple_with_bad_specs.png"

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+Then(/^generated file should be the same as data result "([^"]*)"/) do |data_path_name|
+  expected_output_path = test_result_path(data_path_name)
+
+  # Try two paths: normal output, and hacked aruba tmp one
+  output_path = @output_path
+  aruba_output_path = "#{::Configuration.instance.working_directory}/#{@output_path}"
+  output_path = aruba_output_path unless ::File.exist?(output_path)
+
+  expect(::File.exist?(expected_output_path)).to be true
+  expect(::File.exist?(output_path)).to be true
+
+  expected_signature = image_signature(expected_output_path)
+  output_signature = image_signature(output_path)
+
+  expect(expected_signature).to eq output_signature
+end

data/features/step_definitions/help_steps.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+When(/^I get help/) do
+  step %(I run `#{::Configuration.instance.app_name} help`)
+end
+
+When(/^I get help for "([^"]*)"$/) do |command|
+  step %(I run `#{::Configuration.instance.app_name} #{command} help`)
+end

data/features/step_definitions/insert_bleed_steps.rb

@@ -0,0 +1,28 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+When(/^I insert bleed to test data "([^"]*)"$/) do |data_name|
+  image_path = test_data_path(data_name)
+  file_name = ::File.basename(image_path, '.*')
+  extension = ::File.extname(image_path)
+  directory = ::File.dirname(image_path)
+
+  @output_path = "#{directory}/#{file_name}_result#{extension}"
+  step %(I run `#{::Configuration.instance.app_name} bleed insert #{image_path}` interactively)
+end
+
+When(/^I insert bleed to test data "([^"]*)" and output to "([^"]*)"/) do |data_name, output_path|
+  @output_path = output_path
+  image_path = test_data_path(data_name)
+  step %(I run `#{::Configuration.instance.app_name} bleed insert --output #{@output_path} #{image_path}` interactively)
+end
+
+When(/^I insert bleed to test data "([^"]*)" and skip specs loading/) do |data_name|
+  image_path = test_data_path(data_name)
+  file_name = ::File.basename(image_path, '.*')
+  extension = ::File.extname(image_path)
+  directory = ::File.dirname(image_path)
+
+  @output_path = "#{directory}/#{file_name}_result#{extension}"
+  step %(I run `#{::Configuration.instance.app_name} bleed insert --skip-specs #{image_path}` interactively)
+end

data/features/support/configuration.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+class ::Configuration
+  include ::Singleton
+
+  def initialize
+    @app_name = 'tileset_tooling'
+    @working_directory = nil
+  end
+
+  attr_reader :app_name
+  attr_accessor :working_directory
+end
+
+::Aruba.configure do |config|
+  ::Configuration.instance.working_directory = config.working_directory
+end

data/features/support/env.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'aruba/cucumber'
+
+BIN_DIR = ::File.join(__dir__, '..', '..', 'bin')
+LIB_DIR = ::File.join(__dir__, '..', '..', 'lib')
+::ENV['PATH'] = "#{::File.expand_path(::BIN_DIR)}#{::File::PATH_SEPARATOR}#{::ENV['PATH']}"
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ::ENV['RUBYLIB']
+  ::ENV['RUBYLIB'] = ::LIB_DIR + ::File::PATH_SEPARATOR + ::ENV['RUBYLIB'].to_s
+end
+
+After do
+  ::ENV['RUBYLIB'] = @original_rubylib
+end

data/features/support/test_data.rb

@@ -0,0 +1,16 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'tileset_tooling/utils'
+
+def test_data_path(name)
+  "#{__dir__}/../../test/data/#{name}"
+end
+
+def test_result_path(name)
+  "#{__dir__}/../../test/data/expected/#{name}"
+end
+
+def image_signature(path)
+  ::TilesetTooling::Utils.image_signature(path)
+end

data/features/tileset_tooling.feature

@@ -0,0 +1,7 @@
+Feature: App executes correctly
+  Simple test to validate that the app starts correctly, makes
+  debugging of failing tests easier
+
+  Scenario: App just runs
+    When I get help
+    Then the exit status should be 0

data/lib/tileset_tooling.rb

@@ -0,0 +1,4 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'tileset_tooling/app'

data/lib/tileset_tooling/app.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'gli'
+require 'semantic_logger'
+
+require 'tileset_tooling/version'
+require 'tileset_tooling/commands'
+require 'tileset_tooling/utils'
+
+# Core module for the project
+module ::TilesetTooling
+end
+
+# Core application for the project; sets up the GLI configuration and such
+class ::TilesetTooling::App
+  extend ::GLI::App
+
+  program_desc 'Bits of tooling I use for working with tilesets'
+
+  version ::TilesetTooling::VERSION
+
+  subcommand_option_handling :normal
+  arguments :strict
+
+  pre do
+    # Set the global default log level and add appender
+    ::SemanticLogger.sync!
+    ::SemanticLogger.default_level = :trace
+    ::SemanticLogger.add_appender(io: $stdout, formatter: :color)
+
+    true
+  end
+
+  post do
+  end
+
+  on_error do |error|
+    puts(error)
+    puts(error.backtrace)
+    true
+  end
+
+  desc 'Commands relating to bleed around tiles'
+  command :bleed do |bleed_command|
+    bleed_command.arg(:input_file)
+    bleed_command.desc('Inserts a bleed around tiles')
+    bleed_command.command(:insert) do |insert_command|
+      insert_command.switch([:'skip-specs'], desc: 'Skips the reading of the specs')
+      insert_command.flag([:output], default_value: nil, desc: 'Path where to store result', arg_name: 'path')
+      insert_command.action do |_, options, args|
+        command = ::TilesetTooling::Commands::InsertBleed.new(options, args)
+        command.unpack!
+        command.run
+      end
+    end
+  end
+end

data/lib/tileset_tooling/commands.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'highline'
+require 'semantic_logger'
+
+# Module containing all commands
+module ::TilesetTooling::Commands
+end
+
+# Basis for all commands
+class ::TilesetTooling::Commands::Command
+  # Initializer for command basis
+  def initialize(options, args)
+    @logger = ::SemanticLogger[self.class.name.split('::').last]
+    @cli = ::HighLine.new
+    @options = options
+    @args = args
+  end
+end
+
+require 'tileset_tooling/commands/insert_bleed'

data/lib/tileset_tooling/commands/insert_bleed.rb

@@ -0,0 +1,126 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'tileset_tooling/data'
+
+require 'yaml'
+
+# Command used to insert bleed around tiles
+class ::TilesetTooling::Commands::InsertBleed < ::TilesetTooling::Commands::Command
+  # Validates arguments/options and unpacks them
+  def unpack!
+    raise(::StandardError, 'Missing argument') unless @args.count == 1
+
+    @image_path = @args.shift
+
+    raise(::StandardError, "Could not find image '#{@image_path}'") unless ::File.exist?(@image_path)
+  end
+
+  # Runs this command
+  def run
+    @logger.info("Adding bleed to tiles in image file '#{@image_path}'")
+    tileset = gather_image_information
+
+    raise(::StandardError, 'Current implementation needs an existing margin') unless tileset.margin.positive?
+
+    ::MiniMagick::Tool::Convert.new do |convert|
+      convert.background('none')
+      convert << tileset.original_image_path
+
+      tileset.for_each_tile do |tile|
+        copy_rect(convert, tile.left, tile.top, 1, tile.width, tile.left, tile.top - 1) unless tile.top <= 0
+        copy_rect(convert, tile.left, tile.bottom - 1, 1, tile.width, tile.left, tile.bottom) unless tile.bottom >= tileset.height
+        copy_rect(convert, tile.left, tile.top, tile.height, 1, tile.left - 1, tile.top) unless tile.left <= 0
+        copy_rect(convert, tile.right - 1, tile.top, tile.height, 1, tile.right, tile.top) unless tile.right >= tileset.width
+      end
+
+      convert.flatten
+      convert << result_path
+    end
+
+    @logger.info("Result stored in '#{result_path}'")
+  end
+
+  private
+
+  def result_path
+    return @options[:output] if @options[:output]
+
+    file_name = ::File.basename(@image_path, '.*')
+    extension = ::File.extname(@image_path)
+    directory = ::File.dirname(@image_path)
+
+    "#{directory}/#{file_name}_result#{extension}"
+  end
+
+  def ask_specs
+    tile_height =
+      @cli.ask('Tile height?  ', ::Integer) do |q|
+        q.default = 0
+        q.in = 1..256
+      end
+    tile_width =
+      @cli.ask('Tile width?  ', ::Integer) do |q|
+        q.default = 0
+        q.in = 1..256
+      end
+    margin = @cli.ask('Margin?  ', ::Integer) { |q| q.default = 0 }
+    offset_top = @cli.ask('Top Offset?  ', ::Integer) { |q| q.default = 0 }
+    offset_left = @cli.ask('Left Offset?  ', ::Integer) { |q| q.default = 0 }
+
+    [tile_height, tile_width, margin, offset_top, offset_left]
+  end
+
+  def load_specs_from_file(file_path)
+    @logger.info("Extracting specs from '#{file_path}'")
+    specs = ::YAML.load_file(file_path)
+
+    begin
+      tile_height = specs['specs']['details']['tile_height']
+      tile_width = specs['specs']['details']['tile_width']
+      margin = specs['specs']['details']['margin']
+      offset_top = specs['specs']['details']['offset_top']
+      offset_left = specs['specs']['details']['offset_left']
+    rescue ::NoMethodError
+      raise(::StandardError, 'Invalid specs file')
+    end
+    [tile_height, tile_width, margin, offset_top, offset_left]
+  end
+
+  def find_specs
+    specs_file = ::TilesetTooling::Utils.image_spec_file_path(@image_path)
+    if !@options[:'skip-specs'] && ::File.exist?(specs_file)
+      tile_height, tile_width, margin, offset_top, offset_left = load_specs_from_file(specs_file)
+    else
+      tile_height, tile_width, margin, offset_top, offset_left = ask_specs
+    end
+    [tile_height, tile_width, margin, offset_top, offset_left]
+  end
+
+  # Asks for information about the image and build a tileset
+  def gather_image_information
+    tile_height, tile_width, margin, offset_top, offset_left = find_specs
+
+    ::TilesetTooling::Data::TileSet.new(
+      image: ::MiniMagick::Image.open(@image_path),
+      original_image_path: @image_path,
+      tile_height: tile_height,
+      tile_width: tile_width,
+      margin: margin,
+      offset_top: offset_top,
+      offset_left: offset_left
+    )
+  end
+
+  def copy_rect(convert, x1, y1, height, width, x2, y2)
+    # convert image \( +clone -crop WxH+X1+Y1 +repage \) -geometry +X2+Y2 -compose over -composite result
+    convert.stack do |stack|
+      stack.clone.+ # rubocop:disable Lint/Void
+      stack.crop("#{width}x#{height}+#{x1}+#{y1}")
+      stack.repage.+
+    end
+    convert.geometry("+#{x2}+#{y2}")
+    convert.compose('Over')
+    convert.composite
+  end
+end

data/lib/tileset_tooling/data.rb

@@ -0,0 +1,13 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+require 'dry-struct'
+require 'mini_magick'
+
+# Module containing all data-types that are used across the project
+module ::TilesetTooling::Data
+end
+
+require 'tileset_tooling/data/types'
+require 'tileset_tooling/data/tile'
+require 'tileset_tooling/data/tileset'

data/lib/tileset_tooling/data/tile.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2020 Jean-Sebastien Gelinas, see LICENSE.txt
+# frozen_string_literal: true
+
+# Class representing a TileSet's information
+class ::TilesetTooling::Data::Tile < ::Dry::Struct
+  attribute :top, ::TilesetTooling::Data::Types::Integer
+  attribute :left, ::TilesetTooling::Data::Types::Integer
+  attribute :height, ::TilesetTooling::Data::Types::Integer
+  attribute :width, ::TilesetTooling::Data::Types::Integer
+
+  attribute :margin_top, ::TilesetTooling::Data::Types::Integer
+  attribute :margin_left, ::TilesetTooling::Data::Types::Integer
+  attribute :margin_bottom, ::TilesetTooling::Data::Types::Integer
+  attribute :margin_right, ::TilesetTooling::Data::Types::Integer
+
+  # Helper to print the information of the tile
+  def to_s
+    "#{top},#{left} [#{margin_top},#{margin_left},#{margin_bottom},#{margin_right}]"
+  end
+
+  # Helper to get the bottom coordinate
+  def bottom
+    top + height
+  end
+
+  # Helper to get the right coordinate
+  def right
+    left + width
+  end
+end