ruby2d 0.7.0 → 0.8.0

data/lib/ruby2d.rb

@@ -1,36 +1,59 @@
 # Ruby2D module and native extension loader, adds DSL
 
-require 'ruby2d/colorize'
-require 'ruby2d/exceptions'
-require 'ruby2d/renderable'
-require 'ruby2d/color'
-require 'ruby2d/window'
-require 'ruby2d/dsl'
-require 'ruby2d/quad'
-require 'ruby2d/line'
-require 'ruby2d/circle'
-require 'ruby2d/rectangle'
-require 'ruby2d/square'
-require 'ruby2d/triangle'
-require 'ruby2d/image'
-require 'ruby2d/sprite'
-require 'ruby2d/font'
-require 'ruby2d/text'
-require 'ruby2d/sound'
-require 'ruby2d/music'
-
-if RUBY_PLATFORM =~ /mingw/
-  # When using the Windows CI AppVeyor
-  if ENV['APPVEYOR']
-    s2d_dll_path = 'C:\msys64\usr\local\bin'
-  # When in a standard MinGW shell
-  else
-    s2d_dll_path = '~/../../usr/local/bin'
+unless RUBY_ENGINE == 'mruby'
+  require 'ruby2d/colorize'
+  require 'ruby2d/exceptions'
+  require 'ruby2d/renderable'
+  require 'ruby2d/color'
+  require 'ruby2d/window'
+  require 'ruby2d/dsl'
+  require 'ruby2d/quad'
+  require 'ruby2d/line'
+  require 'ruby2d/circle'
+  require 'ruby2d/rectangle'
+  require 'ruby2d/square'
+  require 'ruby2d/triangle'
+  require 'ruby2d/image'
+  require 'ruby2d/sprite'
+  require 'ruby2d/font'
+  require 'ruby2d/text'
+  require 'ruby2d/sound'
+  require 'ruby2d/music'
+
+  if RUBY_PLATFORM =~ /mingw/
+    # When using the Windows CI AppVeyor
+    if ENV['APPVEYOR']
+      s2d_dll_path = 'C:\msys64\usr\local\bin'
+    # When in a standard MinGW shell
+    else
+      s2d_dll_path = '~/../../usr/local/bin'
+    end
+    RubyInstaller::Runtime.add_dll_directory(File.expand_path(s2d_dll_path))
   end
-  RubyInstaller::Runtime.add_dll_directory(File.expand_path(s2d_dll_path))
+
+  require 'ruby2d/ruby2d'  # load native extension
 end
 
-require 'ruby2d/ruby2d'  # load native extension
+
+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
+    end
+
+    def assets=(path); @assets = path end
+  end
+end
 
 include Ruby2D
 extend  Ruby2D::DSL

data/lib/ruby2d/circle.rb

@@ -4,8 +4,7 @@ module Ruby2D
   class Circle
     include Renderable
 
-    attr_reader :color
-    attr_accessor :x, :y, :radius, :sectors
+    attr_accessor :radius, :sectors
 
     def initialize(opts = {})
       @x = opts[:x] || 25
@@ -14,13 +13,10 @@ module Ruby2D
       @radius = opts[:radius] || 25
       @sectors = opts[:sectors] || 20
       self.color = opts[:color] || 'white'
+      self.opacity = opts[:opacity] if opts[:opacity]
       add
     end
 
-    def color=(c)
-      @color = Color.from(c)
-    end
-
     def contains?(x, y)
       Math.sqrt((x - @x)**2 + (y - @y)**2) <= @radius
     end

data/lib/ruby2d/cli/build.rb

@@ -0,0 +1,226 @@
+# Build a Ruby 2D app natively and for the web
+
+require 'fileutils'
+
+# The installed gem directory
+@gem_dir = "#{Gem::Specification.find_by_name('ruby2d').gem_dir}"
+
+# The Ruby 2D library files
+@lib_files = [
+  'colorize',
+  'exceptions',
+  'renderable',
+  'color',
+  'window',
+  'dsl',
+  'quad',
+  'line',
+  'circle',
+  'rectangle',
+  'square',
+  'triangle',
+  'image',
+  'sprite',
+  'font',
+  'text',
+  'sound',
+  'music',
+  '../ruby2d'
+]
+
+
+# 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
+
+  File.write('build/lib.rb', lib)
+end
+
+
+# Remove `require 'ruby2d'` from source file
+def strip_require(file)
+  output = ''
+  File.foreach(file) do |line|
+    output << line unless line =~ /require ('|")ruby2d('|")/
+  end
+  return output
+end
+
+
+# Build a native version of the provided Ruby application
+def build_native(rb_file)
+  check_build_src_file(rb_file)
+
+  # 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
+
+  # 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`
+
+  # 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`
+
+  # 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")
+  end
+
+  # Compile to a native executable
+  `cc build/app.c -lmruby \`simple2d --libs\` -o build/app`
+
+  # Clean up
+  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."
+end
+
+
+# Build an app bundle for macOS
+def build_macos(rb_file)
+
+  # Build native app for macOS
+  build_native(rb_file)
+
+  # Property list source for the bundle
+  info_plist = %(
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>CFBundleExecutable</key>
+  <string>app</string>
+  <key>CFBundleIconFile</key>
+  <string>app.icns</string>
+  <key>CFBundleInfoDictionaryVersion</key>
+  <string>6.0</string>
+  <key>CFBundlePackageType</key>
+  <string>APPL</string>
+  <key>CFBundleVersion</key>
+  <string>1</string>
+  <key>NSHighResolutionCapable</key>
+  <string>True</string>
+</dict>
+</plist>
+)
+
+  # Create directories
+  FileUtils.mkpath 'build/App.app/Contents/MacOS'
+  FileUtils.mkpath 'build/App.app/Contents/Resources'
+
+  # Create Info.plist and copy over assets
+  File.open('build/App.app/Contents/Info.plist', 'w') { |f| f.write(info_plist) }
+  FileUtils.cp 'build/app', 'build/App.app/Contents/MacOS/'
+  # Consider using an icon:
+  #   FileUtils.cp "#{@gem_dir}/assets/app.icns", 'build/App.app/Contents/Resources'
+
+  # Clean up
+  FileUtils.rm_f 'build/app' unless @debug
+
+  # Success!
+  puts 'macOS app bundle created: `build/App.app`'
+end
+
+
+# Build an iOS or tvOS app
+def build_ios_tvos(rb_file, device)
+  check_build_src_file(rb_file)
+
+  # Check for Simple 2D framework,
+  unless File.exist?('/usr/local/Frameworks/Simple2D/iOS/Simple2D.framework') && File.exist?('/usr/local/Frameworks/Simple2D/tvOS/Simple2D.framework')
+    puts "#{'Error:'.error} Simple 2D iOS and tvOS frameworks not found. Install them and try again.\n"
+    exit
+  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"
+    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`
+
+  # 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`
+
+  # Copy over iOS project
+  FileUtils.cp_r "#{@gem_dir}/assets/#{device}", "build"
+
+  # Combine contents of C source files and bytecode into one file
+  File.open("build/#{device}/main.c", 'w') do |f|
+    f << "#define RUBY2D_IOS_TVOS 1" << "\n\n"
+    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")
+  end
+
+  # Build the Xcode project
+  `simple2d build --#{device} build/#{device}/MyApp.xcodeproj`
+
+  # Clean up
+  clean_up unless @debug
+
+  # Success!
+  puts "App created: `build/#{device}`"
+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')
+  )
+  if cmd == :all
+    puts "cleaning up..."
+    FileUtils.rm_f 'build/app'
+    FileUtils.rm_f 'build/app.js'
+    FileUtils.rm_f 'build/app.html'
+    FileUtils.rm_rf 'build/App.app'
+    FileUtils.rm_rf 'build/ios'
+    FileUtils.rm_rf 'build/tvos'
+  end
+end

data/lib/ruby2d/cli/console.rb

@@ -0,0 +1,49 @@
+rb_file = ARGV[1]
+
+# Check if source file provided is good
+if !rb_file
+  puts "Provide a Ruby file to run"
+  exit 1
+elsif !File.exist? rb_file
+  puts "Can't find file: #{rb_file}"
+  exit 1
+end
+
+# Add libraries
+require 'open3'
+require 'readline'
+require 'io/wait'
+
+line = 1  # the current line number, to be incremented
+
+# Open a new process for the  Ruby file
+stdin, stdout, stderr, wait_thr = Open3.popen3("ruby -r 'ruby2d/cli/enable_console' #{rb_file}")
+
+loop do
+
+  # Read the next command
+  cmd = Readline.readline("ruby2d:#{line}> ", true)
+
+  # Quit if command is 'exit'
+  if cmd == 'exit'
+    Process.kill 'INT', wait_thr.pid
+    wait_thr.value
+    exit
+  end
+
+  # Skip if command is an empty string
+  unless cmd.empty?
+
+    # Send command to the Ruby file
+    stdin.puts cmd
+
+    # Read and print output from the Ruby file
+    puts stdout.gets
+    while stdout.ready? do
+      puts stdout.gets
+    end
+  end
+
+  # Advance to next line
+  line += 1
+end

data/lib/ruby2d/cli/enable_console.rb

@@ -0,0 +1,5 @@
+# Enable the interactive console
+
+require 'io/wait'
+
+$ruby2d_console_mode = true

data/lib/ruby2d/cli/launch.rb

@@ -0,0 +1,50 @@
+# Launch a built Ruby 2D app
+
+# Launch a native app
+def launch_native
+  if !File.exist? 'build/app'
+    puts "No native app built!"
+    exit
+  end
+  `( cd build && ./app )`
+end
+
+
+# Launch a web app
+def launch_web
+  if !File.exist? 'build/app.html'
+    puts "No web app built!"
+    exit
+  end
+  open_cmd = 'open'
+  case RUBY_PLATFORM
+  when /linux/
+    open_cmd = "xdg-#{open_cmd}"
+  when /mingw/
+    open_cmd = "start"
+  end
+  system "#{open_cmd} build/app.html"
+end
+
+
+# Launch an iOS or tvOS app in a simulator
+def launch_apple(device)
+  case device
+  when 'ios'
+    if !File.exist? 'build/ios/build/Release-iphonesimulator/MyApp.app'
+      puts "No iOS app built!"
+      exit
+    end
+    puts `simple2d simulator --open "iPhone XR" &&
+          simple2d simulator --install "build/ios/build/Release-iphonesimulator/MyApp.app" &&
+          simple2d simulator --launch "Ruby2D.MyApp"`
+  when 'tvos'
+    if !File.exist? 'build/tvos/build/Release-appletvsimulator/MyApp.app'
+      puts "No tvOS app built!"
+      exit
+    end
+    puts `simple2d simulator --open "Apple TV 4K" &&
+          simple2d simulator --install "build/tvos/build/Release-appletvsimulator/MyApp.app" &&
+          simple2d simulator --launch "Ruby2D.MyApp"`
+  end
+end

data/lib/ruby2d/color.rb

@@ -66,10 +66,23 @@ module Ruby2D
           end
         when Array
           @r, @g, @b, @a = [c[0], c[1], c[2], c[3]]
+        when Color
+          @r, @g, @b, @a = [c.r, c.g, c.b, c.a]
         end
       end
     end
 
+    # Return a color set if an array of valid colors
+    def self.set(colors)
+      # If a valid array of colors, return a `Color::Set` with those colors
+      if colors.is_a?(Array) && colors.all? { |el| Color.is_valid? el }
+        Color::Set.new(colors)
+      # Otherwise, return single color
+      else
+        Color.new(colors)
+      end
+    end
+
     # Check if string is a proper hex value
     def self.is_hex?(s)
       # MRuby doesn't support regex, otherwise we'd do:
@@ -79,6 +92,7 @@ module Ruby2D
 
     # Check if the color is valid
     def self.is_valid?(c)
+      c.is_a?(Color)   ||  # color object
       @@colors.key?(c) ||  # keyword
       self.is_hex?(c)  ||  # hexadecimal value
 
@@ -87,17 +101,6 @@ module Ruby2D
       c.all? { |el| el.is_a?(Numeric) }
     end
 
-    # Create a color from whatever is provided
-    def self.from(input)
-      # If a valid array of colors, return a `Color::Set` with those colors
-      if input.is_a? Array and input.all? { |el| Color.is_valid? el }
-        Color::Set.new(input)
-      # Otherwise, return single color
-      else
-        Color.new(input)
-      end
-    end
-
     # Convenience methods to alias `opacity` to `@a`
     def opacity; @a end
     def opacity=(opacity); @a = opacity end
@@ -105,7 +108,6 @@ module Ruby2D
     private
 
     # Convert from Fixnum (0..255) to Float (0.0..1.0)
-    #   TODO: Only `Number` is supported in JS
     def to_f(a)
       b = []
       a.each do |n|