fxruby-enhancement 0.0.2

data/Rakefile

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'semver'
+
+def s_version
+  SemVer.find.format "%M.%m.%p%s"
+end
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "fxruby-enhancement"
+  gem.homepage = "http://github.com/flajann2/fxruby-enhancement"
+  gem.license = "MIT"
+  gem.summary = %Q{fxruby enhancements}
+  gem.description = %Q{The fxruby library is an excellent wrapper for the FOX toolkit. However, it reflects the
+  C++-ness of FOX, rather than being more Ruby-like. As such, creating composed objects with
+  it tends to be rather ugly and cumbersome.
+
+  fxruby-enhancement is a wrapper for the wrapper, to "rubyfy" it and make it more easy to 
+  use for Rubyists. 
+
+  fxruby-enhancement is basically a DSL of sorts, and every effort has been taken to make 
+  it intuitive to use. Once you get the hang of it, you should be able to look at the FXRuby
+  API documentation and infer the DSL construct for fxruby-enhancement.}
+  
+  gem.email = "fred.mitchell@gmx.de"
+  gem.authors = ["Fred Mitchell"]
+  gem.version = s_version
+  gem.required_ruby_version = '>= 2.3.1'
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+desc "Convert rdoc-sources to a static introspection for DSL."
+task :scrape do
+  ruby "build/scrape-rdoc.rb"
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/build/scrape-rdoc.rb

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+=begin rdoc
+= Scrape RDoc from FXRuby
+We need to scrape that and convert it to a form
+suitable for static introspection of the FXRuby
+API, with the implied parameters and their defaults
+for the many classes in FXRuby
+=end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+SOURCES = File.expand_path("../fxruby/rdoc-sources", File.dirname(__FILE__))
+SRC_DEFS = File.expand_path("../fxruby/fox-includes/fxdefs.h", File.dirname(__FILE__))
+TARGET = File.expand_path("../lib/fxruby-enhancement/api-mapper.rb", File.dirname(__FILE__))
+TEMPLATE = File.expand_path("api-mapper.rb.erb", File.dirname(TARGET))
+File.delete TARGET unless not File.exists? TARGET
+File.open(TARGET, 'w') {}
+
+require 'fxruby-enhancement'
+require 'erb'
+require 'pp'
+
+# Indeed we parse the rdoc-sources to glean the actual API
+# for FXRuby, since live introspection of the actual API
+# is underdeterimed, being a wrapper for the underlying C++
+# library, which does things, unsurpringly, in a very C++
+# way. And so, I fight evil with evil here. So let the evil
+# begin. 
+
+last_class = nil
+API = Dir.entries(SOURCES)                   
+      .select{ |f| /^FX.*\.rb$/ =~ f  }
+      .sort
+      .map{ |f| File.expand_path(f, SOURCES) }
+      .map{ |f| File.open(f, "r").readlines }
+      .flatten
+      .reject{ |s| /^\s*#/ =~ s }
+      .map{ |s| s
+            .split(/#|;/).first
+            .split('def').last
+            .strip }
+      .select{ |s| /class|initialize(?!d)/ =~ s }
+      .map{ |s| s.split(/ |\(/, 2) }
+      .map{ |type, rest| [type.to_sym, rest] }
+      .map{ |type, rest| case type
+                         when :class
+                           [type, rest.split(/\b*<\b*/)]
+                         when :initialize
+                           [type,
+                            (rest.nil?) ? nil
+                            : rest.chop.scan(/(?:\(.*?\)|[^,])+/)
+                              .map{ |s| s
+                                    .strip
+                                    .split('=')}]
+                         else
+                           raise "unknown type #{type} for #{rest}"
+                         end }
+      .map{ |type, inf| [type,
+                         case type
+                         when :class
+                           inf.map{ |s| s.strip.to_sym}
+                         when :initialize
+                           inf.map{ |var, deft|
+                             [var.to_sym, deft] }.to_h unless inf.nil?
+                         end ]}
+      .group_by{ |type, inf| case type
+                             when :class
+                               last_class = inf.first
+                             when :initialize
+                               last_class
+                             end }
+      .map{ |klass, details| [klass,
+                              details.group_by{ |type, inf| type }]}
+      .map{ |klass, details| [klass,
+                              details.map{ |type, inf| case type
+                                                      when :class
+                                                        inf.last
+                                                      when :initialize
+                                                        [type, inf.map{ |t, h| h }]
+                                                      end }.to_h
+                             ]}
+      .to_h
+
+# Scan for Selectors
+File.open(SRC_DEFS, 'r') do |fd|
+  SEL = fd.readlines
+        .select{ |s| s =~ /SEL_/ }
+        .map{ |s| /(SEL_)([A-Z_]+),(.*)/.match s }
+        .compact
+        .map{ |md| [md[1], md[2], /\b*\/\/\/(.*)/.match(md[3])] }
+        .map{ |s, f, c| [s+f, f.downcase.to_sym, c.nil? ? '' : c[1].strip] }
+end
+
+# Now that we have the entire FXRuby API description,
+# we now rely on the template to flesh out and create
+# the DSL. Total insanity that I would attempt to use
+# metaprograming to autogeneate a DSL. No worries. I've
+# done worse. :p I aplogize for the apperent "ugliness"
+# in this approach, but desperate times call for desperate
+# measures...
+#
+# NOTE WELL
+#   Please bear in mind that in the API structure, you will
+#   see both nil and "nil" listed as default parameters. The
+#   nil indicates a required parameter, whereas "nil" indicates
+#   a default value for a parameter. Perhaps I should've gone
+#   through the extra step of slapping in :required for
+#   the nil entries, but getting the logic above was tricky
+#   enough, and only those maintaning THIS code will ever
+#   need be concerned about the distinctions.
+
+File.open(TEMPLATE, 'r') do |template|
+  File.open(TARGET, 'w') do |target|
+    @api = API
+    @sel = SEL
+    target.write ERB.new(template.read).result(binding)
+  end
+end

data/examples/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/examples/bounce.rb

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+require 'fxruby-enhancement'
+
+include Fox
+include Fox::Enhancement::Mapper
+
+ANIMATION_TIME = 20
+
+class Ball
+  attr_reader :color
+  attr_reader :center
+  attr_reader :radius
+  attr_reader :dir
+  attr_reader :x, :y
+  attr_reader :w, :h
+  attr_accessor :worldWidth
+  attr_accessor :worldHeight
+
+  
+  def initialize r
+    @radius = r
+    @w = 2*@radius
+    @h = 2*@radius
+    @center = FXPoint.new(50, 50)
+    @x = @center.x - @radius
+    @y = @center.y - @radius
+    @color = FXRGB(255, 0, 0) # red
+    @dir = FXPoint.new(-1, -1)
+    setWorldSize(1000, 1000)
+  end
+  
+  # Draw the ball into this device context
+  def draw(dc)
+    dc.setForeground(color)
+    dc.fillArc(x, y, w, h, 0, 64*90)
+    dc.fillArc(x, y, w, h, 64*90, 64*180)
+    dc.fillArc(x, y, w, h, 64*180, 64*270)
+    dc.fillArc(x, y, w, h, 64*270, 64*360)
+  end
+
+  def bounce_x
+    @dir.x=-@dir.x
+  end
+
+  def bounce_y
+    @dir.y=-@dir.y
+  end
+
+  def collision_y?
+    (y<0 && dir.y<0) || (y+h>worldHeight && dir.y>0)
+  end
+
+  def collision_x?
+    (x<0 && dir.x<0) || (x+w>worldWidth && dir.x>0)
+  end
+
+  def setWorldSize(ww, wh)
+    @worldWidth = ww
+    @worldHeight = wh
+  end
+  
+  def move(units)
+    dx = dir.x*units
+    dy = dir.y*units
+    center.x += dx
+    center.y += dy
+    @x += dx
+    @y += dy
+    if collision_x?
+      bounce_x
+      move(units)
+    end
+    if collision_y?
+      bounce_y
+      move(units)
+    end
+  end
+end
+
+fx_app :app do
+  app_name "Bounce"
+  vendor_name "Example"
+
+  fx_image(:back_buffer) { opts IMAGE_KEEP }
+  
+  fx_main_window(:bounce_window) {
+    title "Bounce Demo"
+    opts DECOR_ALL
+    width 400
+    height 300
+    
+    instance { |w|
+      def w.ball
+        @ball ||= Ball.new(20)
+      end
+      
+      def w.drawScene(drawable)
+        FXDCWindow.new(drawable) { |dc|
+          dc.setForeground(FXRGB(255, 255, 255))
+          dc.fillRectangle(0, 0, drawable.width, drawable.height)
+          ball.draw(dc)
+        }
+      end
+      
+      def w.updateCanvas
+        ball.move(10)
+        drawScene(ref(:back_buffer))
+        ref(:canvas).update
+      end
+      
+      #
+      # Handle timeout events
+      #
+      def w.onTimeout(sender, sel, ptr)
+        # Move the ball and re-draw the scene
+        updateCanvas
+        
+        # Re-register the timeout
+        ref(:app).addTimeout(ANIMATION_TIME, ref(:bounce_window).method(:onTimeout))
+        
+        # Done
+        return 1
+      end
+      
+      w.show PLACEMENT_SCREEN
+      ref(:app).addTimeout(ANIMATION_TIME, w.method(:onTimeout))
+    }
+    
+    fx_canvas(:canvas) {
+      opts LAYOUT_FILL_X|LAYOUT_FILL_Y
+      
+      instance { |c|
+        c.sel_paint { |sender, sel, event|
+          FXDCWindow.new(sender, event) { |dc|
+            dc.drawImage(ref(:back_buffer), 0, 0)
+          }
+        }
+
+        c.sel_configure{ |sender, sel, event|
+          bb = ref(:back_buffer)
+          bb.create unless bb.created?
+          bb.resize(sender.width, sender.height)
+          ref(:bounce_window) do |bw|
+            bw.ball.setWorldSize(sender.width, sender.height)
+            bw.drawScene(bb)
+          end
+        }
+      }
+    }
+  }
+end
+
+if __FILE__ == $0
+  # alias for fox_component is fxc
+  fox_component :app do |app|
+    app.launch
+  end
+end

data/examples/hello.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'fxruby-enhancement'
+
+include Fox
+include Fox::Enhancement::Mapper
+
+fx_app :app do
+  app_name "Hello"
+  vendor_name "Example"
+
+  fx_main_window(:main) {
+    title "Hello"
+    opts DECOR_ALL
+
+    fx_button {
+      text "&Hello, World"
+      selector FXApp::ID_QUIT
+      
+      instance { |b|
+        b.target = ref(:app)
+      }
+    }
+
+    instance { |w|
+      w.show PLACEMENT_SCREEN
+    }
+  }
+end
+
+# alias for fox_component is fxc
+fox_component :app do |app|
+  app.launch
+end

data/fxruby-enhancement.gemspec

@@ -0,0 +1,112 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: fxruby-enhancement 0.0.2 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "fxruby-enhancement".freeze
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Fred Mitchell".freeze]
+  s.date = "2017-01-11"
+  s.description = "The fxruby library is an excellent wrapper for the FOX toolkit. However, it reflects the\n  C++-ness of FOX, rather than being more Ruby-like. As such, creating composed objects with\n  it tends to be rather ugly and cumbersome.\n\n  fxruby-enhancement is a wrapper for the wrapper, to \"rubyfy\" it and make it more easy to \n  use for Rubyists. \n\n  fxruby-enhancement is basically a DSL of sorts, and every effort has been taken to make \n  it intuitive to use. Once you get the hang of it, you should be able to look at the FXRuby\n  API documentation and infer the DSL construct for fxruby-enhancement.".freeze
+  s.email = "fred.mitchell@gmx.de".freeze
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.org"
+  ]
+  s.files = [
+    ".document",
+    ".gitmodules",
+    ".rspec",
+    ".ruby-version",
+    ".semver",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.org",
+    "Rakefile",
+    "build/scrape-rdoc.rb",
+    "examples/.ruby-version",
+    "examples/bounce.rb",
+    "examples/hello.rb",
+    "fxruby-enhancement.gemspec",
+    "lib/fxruby-enhancement.rb",
+    "lib/fxruby-enhancement/api-mapper.rb",
+    "lib/fxruby-enhancement/api-mapper.rb.erb",
+    "lib/fxruby-enhancement/core-monkey.rb",
+    "lib/fxruby-enhancement/enhancement.rb",
+    "lib/fxruby-enhancement/ostruct-monkey.rb",
+    "spec/fxruby-enhancement_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/flajann2/fxruby-enhancement".freeze
+  s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.3.1".freeze)
+  s.rubygems_version = "2.6.8".freeze
+  s.summary = "fxruby enhancements".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<semver2>.freeze, ["~> 3"])
+      s.add_runtime_dependency(%q<fxruby>.freeze, ["~> 1.6"])
+      s.add_runtime_dependency(%q<awesome_print>.freeze, [">= 1"])
+      s.add_runtime_dependency(%q<json>.freeze, [">= 2.0.2", "~> 2.0"])
+      s.add_runtime_dependency(%q<queue_ding>.freeze, ["~> 0"])
+      s.add_development_dependency(%q<rspec>.freeze, ["~> 3"])
+      s.add_development_dependency(%q<yard>.freeze, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 5"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_development_dependency(%q<juwelier>.freeze, ["~> 2"])
+      s.add_development_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>.freeze, [">= 3"])
+      s.add_development_dependency(%q<pry-doc>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry-remote>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry-rescue>.freeze, [">= 1"])
+      s.add_development_dependency(%q<pry-stack_explorer>.freeze, [">= 0"])
+    else
+      s.add_dependency(%q<semver2>.freeze, ["~> 3"])
+      s.add_dependency(%q<fxruby>.freeze, ["~> 1.6"])
+      s.add_dependency(%q<awesome_print>.freeze, [">= 1"])
+      s.add_dependency(%q<json>.freeze, [">= 2.0.2", "~> 2.0"])
+      s.add_dependency(%q<queue_ding>.freeze, ["~> 0"])
+      s.add_dependency(%q<rspec>.freeze, ["~> 3"])
+      s.add_dependency(%q<yard>.freeze, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 5"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+      s.add_dependency(%q<juwelier>.freeze, ["~> 2"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<pry>.freeze, [">= 0"])
+      s.add_dependency(%q<pry-byebug>.freeze, [">= 3"])
+      s.add_dependency(%q<pry-doc>.freeze, [">= 0"])
+      s.add_dependency(%q<pry-remote>.freeze, [">= 0"])
+      s.add_dependency(%q<pry-rescue>.freeze, [">= 1"])
+      s.add_dependency(%q<pry-stack_explorer>.freeze, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<semver2>.freeze, ["~> 3"])
+    s.add_dependency(%q<fxruby>.freeze, ["~> 1.6"])
+    s.add_dependency(%q<awesome_print>.freeze, [">= 1"])
+    s.add_dependency(%q<json>.freeze, [">= 2.0.2", "~> 2.0"])
+    s.add_dependency(%q<queue_ding>.freeze, ["~> 0"])
+    s.add_dependency(%q<rspec>.freeze, ["~> 3"])
+    s.add_dependency(%q<yard>.freeze, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 5"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.0"])
+    s.add_dependency(%q<juwelier>.freeze, ["~> 2"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<pry>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-byebug>.freeze, [">= 3"])
+    s.add_dependency(%q<pry-doc>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-remote>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-rescue>.freeze, [">= 1"])
+    s.add_dependency(%q<pry-stack_explorer>.freeze, [">= 0"])
+  end
+end
+