ruby2d 0.11.0 → 0.11.3

data/lib/ruby2d/cli/build.rb

@@ -1,26 +1,30 @@
-# Build a Ruby 2D app natively and for the web
+# Build a compiled Ruby 2D app with mruby
 
+require 'ruby2d'
 require 'fileutils'
+require 'ruby2d/cli/colorize'
+require 'ruby2d/cli/platform'
 
-# The installed gem directory
-@gem_dir = "#{Gem::Specification.find_by_name('ruby2d').gem_dir}"
 
 # The Ruby 2D library files
-@lib_files = [
+@ruby2d_lib_files = [
   'cli/colorize',
   'exceptions',
   'renderable',
   'color',
   'window',
   'dsl',
+  'entity',
   'quad',
   'line',
   'circle',
   'rectangle',
   'square',
   'triangle',
+  'pixel',
   'image',
   'sprite',
+  'tileset',
   'font',
   'text',
   'sound',
@@ -31,30 +35,11 @@ require 'fileutils'
 ]
 
 
-# Check if source file provided is good
-def check_build_src_file(rb_file)
-  if !rb_file
-    puts "Please provide a Ruby file to build"
-    exit
-  elsif !File.exist? rb_file
-    puts "Can't find file: #{rb_file}"
-    exit
-  end
-end
-
-
-# Assemble the Ruby 2D library in one `.rb` file
-def make_lib
-  FileUtils.mkdir_p 'build'
-
-  lib_dir = "#{@gem_dir}/lib/ruby2d/"
-
-  lib = ''
-  @lib_files.each do |f|
-    lib << File.read("#{lib_dir + f}.rb") + "\n\n"
-  end
+# Helpers ######################################################################
 
-  File.write('build/lib.rb', lib)
+def run_cmd(cmd)
+  puts "#{'$'.info} #{cmd.bold}\n" if @debug
+  system cmd
 end
 
 
@@ -68,57 +53,256 @@ def strip_require(file)
 end
 
 
-# Build a native version of the provided Ruby application
-def build_native(rb_file)
-  check_build_src_file(rb_file)
+# Add linker flags
+def add_ld_flags(ld_flags, name, type, dir = nil)
+  case type
+  when :archive
+    ld_flags << "#{dir}/lib#{name}.a "
+  when :framework
+    ld_flags << "-Wl,-framework,#{name} "
+  end
+end
 
-  # Check if MRuby exists; if not, quit
-  if `which mruby`.empty?
-    puts "#{'Error:'.error} Can't find MRuby, which is needed to build native Ruby 2D applications.\n"
+
+# Build Tasks ##################################################################
+
+# Build the user's application
+def build(target, ruby2d_app)
+
+  # Check if source file provided is good
+  if !ruby2d_app
+    puts "Please provide a Ruby file to build"
+    exit
+  elsif !File.exist? ruby2d_app
+    puts "Can't find file: #{ruby2d_app}"
     exit
   end
 
   # Add debugging information to produce backtrace
   if @debug then debug_flag = '-g' end
 
-  # Assemble the Ruby 2D library in one `.rb` file and compile to bytecode
-  make_lib
-  `mrbc #{debug_flag} -Bruby2d_lib -obuild/lib.c build/lib.rb`
+  # Create build directory
+  FileUtils.mkdir_p 'build'
 
-  # Read the provided Ruby source file, copy to build dir and compile to bytecode
-  File.open('build/src.rb', 'w') { |file| file << strip_require(rb_file) }
-  `mrbc #{debug_flag} -Bruby2d_app -obuild/src.c build/src.rb`
+  # Assemble Ruby 2D library files into one '.rb' file
+
+  ruby2d_lib_dir = "#{Ruby2D.gem_dir}/lib/ruby2d/"
+
+  ruby2d_lib = ''
+  @ruby2d_lib_files.each do |f|
+    ruby2d_lib << File.read("#{ruby2d_lib_dir + f}.rb") + "\n\n"
+  end
+
+  File.write('build/ruby2d_lib.rb', ruby2d_lib)
+
+  # Assemble the Ruby 2D C extension files into one '.c' file
+
+  ruby2d_ext_dir = "#{Ruby2D.gem_dir}/ext/ruby2d/"
+
+  ruby2d_ext = "#define MRUBY 1" << "\n\n"
+  Dir["#{ruby2d_ext_dir}*.c"].each do |c_file|
+    ruby2d_ext << File.read(c_file)
+  end
+
+  File.write('build/ruby2d_ext.c', ruby2d_ext)
+
+  # Select `mrbc` executable based on platform
+  case $RUBY2D_PLATFORM
+  when :macos
+    mrbc = "#{Ruby2D.assets}/macos/universal/bin/mrbc"
+  when :windows
+    mrbc = "#{Ruby2D.assets}/windows/mingw-w64-x86_64/bin/mrbc.exe"
+  else
+    mrbc = 'mrbc'
+  end
+
+  # Compile the Ruby 2D lib (`.rb` files) to mruby bytecode
+  run_cmd "#{mrbc} #{debug_flag} -Bruby2d_lib -obuild/ruby2d_lib.c build/ruby2d_lib.rb"
+
+  # Read the user's provided Ruby source file, copy to build dir and compile to bytecode
+  File.open('build/ruby2d_app.rb', 'w') { |f| f << strip_require(ruby2d_app) }
+  run_cmd "#{mrbc} #{debug_flag} -Bruby2d_app -obuild/ruby2d_app.c build/ruby2d_app.rb"
 
   # Combine contents of C source files and bytecode into one file
   open('build/app.c', 'w') do |f|
-    f << "#define MRUBY 1" << "\n\n"
-    f << File.read("build/lib.c") << "\n\n"
-    f << File.read("build/src.c") << "\n\n"
-    f << File.read("#{@gem_dir}/ext/ruby2d/ruby2d.c")
+    ['ruby2d_app', 'ruby2d_lib', 'ruby2d_ext'].each do |c_file|
+      f << File.read("build/#{c_file}.c") << "\n\n"
+    end
   end
 
-  # Compile to a native executable
-  `cc build/app.c -lmruby -o build/app`
+  # Compile the final application based on the target platform
+  case target
+  when :native
+    compile_native
+  when :web
+    compile_web
+  end
 
-  # Clean up
+  # Remove files used in the build process
   clean_up unless @debug
 
-  # Success!
-  puts "Native app created at `build/app`"
 end
 
 
-# Build a web-based version of the provided Ruby application
-def build_web(rb_file)
-  puts "Warning: ".warn + "This feature is currently disabled while it's being upgraded."
+# Create a native executable using the available C compiler
+def compile_native
+
+  # Get include directories
+  incl_dir_ruby2d = "#{Ruby2D.gem_dir}/ext/ruby2d/"
+  incl_dir_deps = "#{Ruby2D.assets}/include/"
+
+  # Add compiler flags for each platform
+  case $RUBY2D_PLATFORM
+
+  when :macos
+    ld_dir = "#{Ruby2D.assets}/macos/universal/lib"
+
+    c_flags = '-arch arm64 -arch x86_64'
+
+    ld_flags = ''
+    ['mruby', 'SDL2', 'SDL2_image', 'SDL2_mixer', 'SDL2_ttf',
+     'jpeg', 'png16', 'tiff', 'webp',
+     'mpg123', 'ogg', 'FLAC', 'vorbis', 'vorbisfile', 'modplug',
+     'freetype', 'harfbuzz', 'graphite2'].each do |name|
+      add_ld_flags(ld_flags, name, :archive, ld_dir)
+    end
+
+    ld_flags << "-lz -lbz2 -liconv -lstdc++ "
+    ['Cocoa', 'Carbon', 'CoreVideo', 'OpenGL', 'Metal', 'CoreAudio', 'AudioToolbox',
+     'IOKit', 'GameController', 'ForceFeedback', 'CoreHaptics'].each do |name|
+      add_ld_flags(ld_flags, name, :framework)
+    end
+
+  when :linux, :linux_rpi, :bsd
+    # TODO: implement this
+    # ld_flags = '-lSDL2 -lSDL2_image -lSDL2_mixer -lSDL2_ttf -lm -lGL'
+
+  when :windows
+
+    if RUBY_PLATFORM =~ /ucrt/
+      ld_dir = "#{Ruby2D.assets}/windows/mingw-w64-ucrt-x86_64/lib"
+    else
+      ld_dir = "#{Ruby2D.assets}/windows/mingw-w64-x86_64/lib"
+    end
+
+    ld_flags = '-static -Wl,--start-group '
+    ['mruby',
+     'SDL2',
+     'SDL2_image', 'jpeg', 'png16', 'tiff', 'webp', 'jbig', 'deflate', 'lzma', 'zstd', 'Lerc',
+     'SDL2_mixer', 'mpg123', 'FLAC', 'vorbis', 'vorbisfile', 'ogg', 'modplug', 'opus', 'opusfile', 'sndfile',
+     'SDL2_ttf', 'freetype', 'harfbuzz', 'graphite2', 'bz2', 'brotlicommon', 'brotlidec',
+     'glew32', 'stdc++', 'z', 'ssp'
+    ].each do |name|
+      add_ld_flags(ld_flags, name, :archive, ld_dir)
+    end
+    ld_flags << '-lmingw32 -lopengl32 -lole32 -loleaut32 -limm32 -lversion -lwinmm -lrpcrt4 -mwindows -lsetupapi -ldwrite '\
+                '-lws2_32 -lshlwapi '
+    ld_flags << '-Wl,--end-group'
+  end
+
+  # Compile the app
+  run_cmd "cc #{c_flags} -I#{incl_dir_ruby2d} -I#{incl_dir_deps} build/app.c #{ld_flags} -o build/app"
+
+  create_macos_bundle if $RUBY2D_PLATFORM == :macos
 end
 
 
-# Build an app bundle for macOS
-def build_macos(rb_file)
+# Create a WebAssembly executable using Emscripten
+def compile_web
+
+  # Check for compiler toolchain issues
+  if doctor_web(:building)
+    puts "Fix errors before building.\n\n"
+  end
+
+  wasm_assets = "#{Ruby2D.assets}/wasm"
+
+  # Get include directories
+  incl_dir_ruby2d = "#{Ruby2D.gem_dir}/ext/ruby2d/"
+  incl_dir_deps = "#{Ruby2D.assets}/include/"
+
+  optimize_flags = '-Os --closure 1'
+  ld_flags = "#{wasm_assets}/libmruby.a"
+
+  # Compile using Emscripten
+  run_cmd "emcc -s WASM=1 -I#{incl_dir_ruby2d} -I#{incl_dir_deps} "\
+          "-s USE_SDL=2 -s USE_SDL_IMAGE=2 -s USE_SDL_MIXER=2 -s USE_SDL_TTF=2 "\
+          "build/app.c #{ld_flags} -o build/app.html"
+
+  # TODO: Copy HTML template from gem assets to build directory
+  # FileUtils.cp "#{wasm_assets}/template.html", 'build/app.html'
+
+  exit(1) unless $?.success?
+end
+
+
+def doctor_native
+  # Check if MRuby exists; if not, quit
+  if `which mruby`.empty?
+    puts "#{'Error:'.error} Can't find `mruby`, which is needed to build native Ruby 2D applications.\n"
+    exit
+  end
+end
+
+
+# Check for problems with web build
+def doctor_web(mode = nil)
+
+  errors = false
+  mruby_errors = false
+  emscripten_errors = false
+
+  puts "\nChecking for mruby"
+
+  # Check for `mrbc`
+  print '  mrbc...'
+  if `which mrbc`.empty?
+    puts 'not found'.error
+    mruby_errors = true
+  else
+    puts 'found'.success
+  end
 
-  # Build native app for macOS
-  build_native(rb_file)
+  puts "\nChecking for Emscripten tools"
+
+  # Check for `emcc`
+  print '  emcc...'
+  if `which emcc`.empty?
+    puts 'not found'.error
+    emscripten_errors = true
+  else
+    puts 'found'.success
+  end
+
+  # Check for `emar`
+  print '  emar...'
+  if `which emar`.empty?
+    puts 'not found'.error
+    emscripten_errors = true
+  else
+    puts 'found'.success
+  end
+
+  if mruby_errors || emscripten_errors then errors = true end
+
+  if errors
+    puts "\nErrors were found!\n\n"
+    if mruby_errors
+      puts "* Did you install mruby?"
+    end
+    if emscripten_errors
+      puts "* Did you run \`./emsdk_env.sh\` ?", "  For help, check out the \"Getting Started\" guide on webassembly.org"
+    end
+    puts "\n"
+    exit(1)
+  else
+    puts "\n👍 Everything looks good!\n\n"
+  end
+end
+
+
+# Build an app bundle for macOS
+def create_macos_bundle
 
   # Property list source for the bundle
   info_plist = %(
@@ -153,10 +337,10 @@ def build_macos(rb_file)
   #   FileUtils.cp "#{@gem_dir}/assets/app.icns", 'build/App.app/Contents/Resources'
 
   # Clean up
-  FileUtils.rm_f 'build/app' unless @debug
+  # FileUtils.rm_f 'build/app' unless @debug
 
   # Success!
-  puts 'macOS app bundle created: `build/App.app`'
+  # puts 'macOS app bundle created: `build/App.app`'
 end
 
 
@@ -208,8 +392,7 @@ end
 # Clean up unneeded build files
 def clean_up(cmd = nil)
   FileUtils.rm(
-    Dir.glob('build/{src,lib}.{rb,c,js}') +
-    Dir.glob('build/app.c')
+    Dir.glob('build/*.{rb,c,js}')
   )
   if cmd == :all
     puts "cleaning up..."

data/lib/ruby2d/cli/colorize.rb

@@ -3,8 +3,9 @@
 # Extend `String` to include some fancy colors
 class String
   def ruby2d_colorize(c); "\e[#{c}m#{self}\e[0m" end
-  def bold;  ruby2d_colorize('1')    end
-  def info;  ruby2d_colorize('1;34') end
-  def warn;  ruby2d_colorize('1;33') end
-  def error; ruby2d_colorize('1;31') end
+  def bold;    ruby2d_colorize('1')    end
+  def info;    ruby2d_colorize('1;34') end
+  def warn;    ruby2d_colorize('1;33') end
+  def success; ruby2d_colorize('1;32') end
+  def error;   ruby2d_colorize('1;31') end
 end

data/lib/ruby2d/cli/platform.rb

@@ -0,0 +1,17 @@
+# Set the OS and platform
+
+case RUBY_PLATFORM
+when /darwin/
+  $RUBY2D_PLATFORM = :macos
+when /linux/
+  $RUBY2D_PLATFORM = :linux
+  if `cat /etc/os-release` =~ /raspbian/
+    $RUBY2D_PLATFORM = :linux_rpi
+  end
+when /bsd/
+  $RUBY2D_PLATFORM = :bsd
+when /mingw/
+  $RUBY2D_PLATFORM = :windows
+else
+  $RUBY2D_PLATFORM = nil
+end

data/lib/ruby2d/font.rb

@@ -2,6 +2,8 @@
 
 module Ruby2D
   class Font
+    FONT_CACHE_LIMIT = 100
+
     @@loaded_fonts = {}
 
     attr_reader :ttf_font
@@ -16,7 +18,11 @@ module Ruby2D
           raise Error, "Cannot find font file `#{path}`"
         end
 
-        @@loaded_fonts[[path, size, style]] ||= Font.new(path, size, style)
+        (@@loaded_fonts[[path, size, style]] ||= Font.new(path, size, style)).tap do |font|
+          if @@loaded_fonts.size > FONT_CACHE_LIMIT
+            @@loaded_fonts.shift
+          end
+        end
       end
 
       # List all fonts, names only

data/lib/ruby2d/sprite.rb

@@ -177,8 +177,13 @@ module Ruby2D
           unless @loop
             # Stop animation and play block, if provided
             stop
-            if @done_proc then @done_proc.call end
-            @done_proc = nil
+            if @done_proc
+              # allow proc to make nested `play/do` calls to sequence multiple
+              # animations by clearing `@done_proc` before the call
+              kept_done_proc = @done_proc
+              @done_proc = nil
+              kept_done_proc.call
+            end
           end
         end
 

data/lib/ruby2d/text.rb

@@ -66,9 +66,7 @@ module Ruby2D
     end
 
     def create_texture
-      if defined?(@texture)
-        @texture.delete
-      end
+      if @texture then @texture.delete end
 
       @texture = Texture.new(*Text.ext_load_text(@font.ttf_font, @text))
       @width = @texture.width

data/lib/ruby2d/texture.rb

@@ -1,28 +1,28 @@
-# Ruby2D::Text
+# Ruby2D::Texture
 
 module Ruby2D
-    class Texture
-      attr_reader :width, :height, :texture_id
+  class Texture
+    attr_reader :width, :height, :texture_id
 
-      def initialize(pixel_data, width, height)
-        @pixel_data = pixel_data
-        @width = width
-        @height = height
-        @texture_id = 0
-      end
-
-      def draw(coordinates, texture_coordinates, color)
-        if @texture_id == 0
-          @texture_id = ext_create(@pixel_data, @width, @height)
-          @pixel_data = nil
-        end
+    def initialize(pixel_data, width, height)
+      @pixel_data = pixel_data
+      @width = width
+      @height = height
+      @texture_id = 0
+    end
 
-        color = [color.r, color.g, color.b, color.a]
-        ext_draw(coordinates, texture_coordinates, color, @texture_id)
+    def draw(coordinates, texture_coordinates, color)
+      if @texture_id == 0
+        @texture_id = ext_create(@pixel_data, @width, @height)
+        @pixel_data = nil
       end
 
-      def delete
-        ext_delete(@texture_id)
-      end
+      color = [color.r, color.g, color.b, color.a]
+      ext_draw(coordinates, texture_coordinates, color, @texture_id)
+    end
+
+    def delete
+      ext_delete(@texture_id)
     end
-end
+  end
+end

data/lib/ruby2d/tileset.rb

@@ -2,6 +2,8 @@
 
 module Ruby2D
   class Tileset
+    DEFAULT_COLOR = Color.new([1.0, 1.0, 1.0, 1.0])
+
     include Renderable
 
     def initialize(path, opts = {})
@@ -46,42 +48,41 @@ module Ruby2D
     def clear_tiles
       @tiles = []
     end
-  end
-
-  def draw
-    Window.render_ready_check
-
-    render
-  end
-
-  private
 
+    def draw
+      Window.render_ready_check
 
-  def render
-    scaled_padding = @padding * @scale
-    scaled_spacing = @spacing * @scale
-    scaled_tile_width = @tile_width * @scale
-    scaled_tile_height = @tile_height * @scale
-    scaled_width = @width * @scale
-    scaled_height = @height * @scale
-
-    @tiles.each do |tile|
-      crop = {
-        x: scaled_padding + (tile.fetch(:tile_x) * (scaled_spacing + scaled_tile_width)),
-        y: scaled_padding + (tile.fetch(:tile_y) * (scaled_spacing + scaled_tile_height)),
-        width: scaled_tile_width,
-        height: scaled_tile_height,
-        image_width: scaled_width,
-        image_height: scaled_height,
-      }
-
-      color = defined?(@color) ? @color : Color.new([1.0, 1.0, 1.0, 1.0])
-
-      vertices = Vertices.new(tile.fetch(:x), tile.fetch(:y), scaled_tile_width, scaled_tile_height, tile.fetch(:tile_rotate), crop: crop, flip: tile.fetch(:tile_flip))
+      render
+    end
 
-      @texture.draw(
-        vertices.coordinates, vertices.texture_coordinates, color
-      )
+    private
+
+    def render
+      scaled_padding = @padding * @scale
+      scaled_spacing = @spacing * @scale
+      scaled_tile_width = @tile_width * @scale
+      scaled_tile_height = @tile_height * @scale
+      scaled_width = @width * @scale
+      scaled_height = @height * @scale
+
+      @tiles.each do |tile|
+        crop = {
+          x: scaled_padding + (tile.fetch(:tile_x) * (scaled_spacing + scaled_tile_width)),
+          y: scaled_padding + (tile.fetch(:tile_y) * (scaled_spacing + scaled_tile_height)),
+          width: scaled_tile_width,
+          height: scaled_tile_height,
+          image_width: scaled_width,
+          image_height: scaled_height,
+        }
+
+        color = defined?(@color) ? @color : DEFAULT_COLOR
+
+        vertices = Vertices.new(tile.fetch(:x), tile.fetch(:y), scaled_tile_width, scaled_tile_height, tile.fetch(:tile_rotate), crop: crop, flip: tile.fetch(:tile_flip))
+
+        @texture.draw(
+          vertices.coordinates, vertices.texture_coordinates, color
+        )
+      end
     end
   end
 end

data/lib/ruby2d/version.rb

@@ -1,5 +1,5 @@
 # Ruby2D::VERSION
 
 module Ruby2D
-  VERSION = '0.11.0'
+  VERSION = '0.11.3'
 end

data/lib/ruby2d/vertices.rb

@@ -30,10 +30,17 @@ module Ruby2D
     end
 
     def coordinates
-      x1, y1 = rotate(@x,          @y);           # Top left
-      x2, y2 = rotate(@x + @width, @y);           # Top right
-      x3, y3 = rotate(@x + @width, @y + @height); # Bottom right
-      x4, y4 = rotate(@x,          @y + @height); # Bottom left
+      if @rotate == 0
+        x1, y1 = @x,          @y;           # Top left
+        x2, y2 = @x + @width, @y;           # Top right
+        x3, y3 = @x + @width, @y + @height; # Bottom right
+        x4, y4 = @x,          @y + @height; # Bottom left
+      else
+        x1, y1 = rotate(@x,          @y);           # Top left
+        x2, y2 = rotate(@x + @width, @y);           # Top right
+        x3, y3 = rotate(@x + @width, @y + @height); # Bottom right
+        x4, y4 = rotate(@x,          @y + @height); # Bottom left
+      end
 
       [ x1, y1, x2, y2, x3, y3, x4, y4 ]
     end
@@ -57,8 +64,6 @@ module Ruby2D
     private
 
     def rotate(x, y)
-      return [x, y] if @rotate == 0
-
       # Convert from degrees to radians
       angle = @rotate * Math::PI / 180.0
 

data/lib/ruby2d.rb

@@ -24,35 +24,29 @@ unless RUBY_ENGINE == 'mruby'
   require 'ruby2d/music'
   require 'ruby2d/texture'
   require 'ruby2d/vertices'
-
-  if defined?(RubyInstaller)
-    s2d_dll_path = Gem::Specification.find_by_name('ruby2d').gem_dir + '/assets/mingw/bin'
-    RubyInstaller::Runtime.add_dll_directory(File.expand_path(s2d_dll_path))
-  end
-
   require 'ruby2d/ruby2d'  # load native extension
 end
 
 
 module Ruby2D
-
-  @assets = nil
-
-  class << self
-    def assets
-      unless @assets
-        if RUBY_ENGINE == 'mruby'
-          @assets = Ruby2D.ext_base_path + 'assets'
-        else
-          @assets = './assets'
-        end
-      end
-      @assets
+  def self.gem_dir
+    # mruby doesn't define `Gem`
+    if RUBY_ENGINE == 'mruby'
+      `ruby -e "print Gem::Specification.find_by_name('ruby2d').gem_dir"`
+    else
+      Gem::Specification.find_by_name('ruby2d').gem_dir
     end
+  end
+
+  def self.assets
+    "#{gem_dir}/assets"
+  end
 
-    def assets=(path); @assets = path end
+  def self.test_media
+    "#{gem_dir}/assets/test_media"
   end
 end
 
+
 include Ruby2D
 extend  Ruby2D::DSL