fxruby-enhancement 0.0.2

data/lib/fxruby-enhancement/api-mapper.rb.erb

@@ -0,0 +1,93 @@
+# coding: utf-8
+=begin rdoc
+This is the detailed mapper constructs for
+FXRuby.
+
+== Internal Docs
+Note that normally you should not need to know these details.
+
+=== Excution Flow
+when you declare fx_app and all the nested delacrations,
+they are initially noted in a tree of OS (OpenStruct) objects,
+and then later the actual underlying FXRuby (and subsequently,
+FOX Objects) are created. At this point the resultant objects
+are plugged into the OS objects so they can be referenced.
+
+So there are 3 phases:
+# Construction of the OS tree (through your declaractions)
+# Construction of the FXRuby objects
+# Construction of the underlying FOX Objects at activation time.
+
+A stack-based method is used to keep track of all of this during
+the construction of the OS tree.
+
+=== Issues
+For many FOX / FXRuby operations, you will need the FXApp object.
+If you used full composition (via fx_app), the base object will be
+the FXApp object. If, on the other hand, you used compose inside
+of a declared FXRuby-derived class, base will be set to the first
+declared component. 
+
+Normally this is not a problem, unless you use ingress_handler,
+in which case it will not know how to find the FXApp object.
+
+=== Conventions
+* pos -- Parent OpenStruct object
+
+== NOTE WELL
+  This file is generated by fxruby-enhancement.
+  Do NOT modify this file. Modify the ERB template
+  file instead, and run 'rake scrape'.
+=end
+
+module Fox
+<% for @class, @details in @api %>
+   class <%= @class %>
+     include Enhancement
+     attr_accessor :_o     
+   end
+<% end %>
+  module Enhancement
+    module Mapper
+    <% for @class, @details in @api %>
+       def <%= @class.snake %> name = nil, ii: <%= (Fox::Enhancement::INITFORCE.member? @class) ? Fox::Enhancement::INITFORCE[@class] : 0 %>, pos: Enhancement.stack.last, &block
+         Enhancement.stack << (@os = os = OpenStruct.new(klass: <%= @class %>, op: [], ii: ii, fx: nil, kinder: [], inst: nil, instance_result: nil))
+         Enhancement.components[name] = os unless name.nil?
+         unless pos.nil?
+           pos.kinder << os 
+         else
+           Enhancement.base = os
+         end
+         <% @i=0 %>
+         <% for @iniparams in @details[:initialize].compact %>
+             <%= "@os.op[#{@i}]" %> = OpenStruct.new({<%= @iniparams.map{ |p,d| [p, d ? d : ":required"] }
+                                                                 .map{ |p,d| ":#{p} => #{d}"}
+                                                                 .join(', ') %>})
+             <% for @param, @default in @iniparams %>
+             def <%= "#{@param.snake}" %> var; @os.op[@os.ii].<%= "#{@param}" %> = var; end
+             <% end %>
+             def instance a=nil, &block
+                @os.instance_name = a
+                @os.instance_block = block
+             end
+         <% @i+=1; end unless @details[:initialize].nil? %>     
+         self.instance_eval &block
+         <% unless Fox::Enhancement::SPECIAL.member? @class %>
+         os.fx = ->(){ <%= @class %>.new(*([pos.inst] + os.op[os.ii].to_h.values[1..-1])) }
+         <% else %>
+         os.fx = ->(){ <%= @class %>.new(*(os.op[os.ii].to_h.values)) }
+         <% end %>
+         Enhancement.stack.pop                                                  
+         @os = Enhancement.stack.last
+         os
+       end
+    <% end %>
+    end
+    <% for @select, @meth, @comment in @sel %>
+    # <%= @comment %>
+    def <%= @select.downcase %>(&block)
+      self.connect(<%= @select %>, &block)
+    end
+    <% end %>                                                        
+  end                                                      
+end

data/lib/fxruby-enhancement/core-monkey.rb

@@ -0,0 +1,26 @@
+=begin rdoc
+= Core (Kernel) classes we monkeypatched.
+=end
+
+class String
+  def snake
+    self.gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+      .tr("-", "_")
+      .downcase
+  end
+end
+
+class Symbol
+  def snake
+    self.to_s.snake.to_sym
+  end
+end
+
+class Binding
+  def fx fxf, dir=File.dirname(self.eval("__FILE__"))
+    filepath = File.expand_path("#{fxf}.fx", dir)
+    self.eval(File.read(filepath), filepath)
+  end
+end

data/lib/fxruby-enhancement/enhancement.rb

@@ -0,0 +1,145 @@
+# coding: utf-8
+module Fox 
+
+  # Include this in your top class objects.
+  # If for a module, you want to extend, rather
+  # than include.
+  # FIXME: later we will clean this up.
+  module Enhancement
+    @stack = []
+    @base = nil
+    @components = {}
+    SPECIAL = [:FXApp,
+               :FXColorItem,
+               :FXRegion,
+               :FXRectangle,
+               :FXGradient,
+               :FXEvent,
+               :FXFileStream,
+               :FXExtentd]
+    INITFORCE = { FXMenuBar: 1 }
+    
+    # Module-level    
+    class << self
+      attr_accessor :stack,
+                    :base, # the very first component declared, usually the app.
+                    :components,
+                    :deferred_setups,
+                    :ms_ingress_delay_min,
+                    :ms_ingress_delay_max
+      
+      # queues for messages objects coming from and going to other threads.
+      attr_accessor :ingress, :egress, :ingress_map
+      
+      def included(klass)
+        @ingress ||= QDing.new
+        @egress  ||= QDing.new
+        @ingress_map ||= {}
+        @deferred_setups ||= []
+        @ms_ingress_delay_min = 100
+        @ms_ingress_delay_max = 1600
+        
+        klass.extend ClassMethods
+      end
+
+      def reset_components
+        @components = {}
+      end
+
+      # Sets up the mechanism by which the custom ingress is activated
+      def activate_ingress_handlers app = Enhancement.base
+        raise "Application Object not instantiated yet" if app.nil? || app.inst.nil?
+        raise "No ingress blocks set" if @ingress_map.empty?
+        
+        @ing_blk = ->(sender, sel, data) { 
+          begin
+            unless @ingress.empty?
+              @ingress_delay = @ms_ingress_delay_min
+              until @ingress.empty?
+                dispatch_to, payload = @ingress.next
+                raise "Unknown dispatch #{dispatch_to}" unless @ingress_map.member? dispatch_to
+                @ingress_map[dispatch_to].(dispatch_to, payload)
+              end
+            else
+              @ingress_delay *= 2 unless @ingress_delay >= @ms_ingress_delay_max
+            end
+          ensure
+            app.inst.addTimeout(@ingress_delay, &@ing_blk)
+          end
+        }
+        app.inst.addTimeout(@ingress_delay ||= @ms_ingress_delay_min, &@ing_blk)
+      end
+
+      def activate_deferred_setups common_ob, app: Enhancement.base
+        Enhancement.deferred_setups.each { |b| b.(common_ob, app) }
+      end
+    end
+
+    # class level
+    module ClassMethods
+      def compose &block #DSL
+        @composure = block
+      end      
+    end
+
+    # instance level
+    # Add it here.
+    
+    module Mapper
+      # Find the referenced component's instance
+      def ref sym, &block
+        raise "No reference for #{sym} found" if Enhancement.components[sym].nil?
+        raise "No instance for #{sym} allocated" if Enhancement.components[sym].inst.nil?
+        inst = Enhancement.components[sym].inst
+        if block_given?
+          block.(inst)
+        end
+        return inst
+      end
+      
+      # Find the referenced component's wrapper object
+      def refc sym, &block
+        raise "No reference component for #{sym} found" if Enhancement.components[sym].nil?
+        c = Enhancement.components[sym]
+        if block_given?
+          block.(c)
+        end
+        return c
+      end
+
+      # Wrapper component
+      def fox_component name, &block
+        if block_given?
+          block.(Enhancement.components[name])
+        else
+          Enhancement.components[name]
+        end
+      end
+      alias_method :fxc, :fox_component
+
+      # Actual FX Object instance
+      def fox_instance name, &block
+        if block_given?
+          block.(fox_component(name).inst)
+        else
+          fox_component(name).inst
+        end
+      end
+      alias_method :fxi, :fox_instance
+
+      # Handles incomming external messages of type given
+      # block, written by user, is called with |type, message|
+      def ingress_handler type = :all, &block
+        Enhancement.ingress_map[type] = block
+      end
+
+      # This is invoked after we have
+      # a real application in place. Invocation
+      # of this is held off until the last possible
+      # moment.
+      def deferred_setup &block
+        Enhancement.deferred_setups << block
+      end      
+    end
+  end
+end

data/lib/fxruby-enhancement/ostruct-monkey.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+class OpenStruct
+  extend Forwardable
+  def_delegator :inst, :create, :activate
+  def_delegator :inst, :run, :run_application  
+  
+  # This assumes this OpenStruct instance represents the base,
+  # and additionaly will take an optional object to use as the
+  # actual base to allow for composures.
+  #
+  # Returns the os base
+  def create_fox_components use_as_base = nil
+    if use_as_base.nil?
+      self.inst = fx.() if self.inst.nil?
+      self.kinder.each{ |os| os.create_fox_components }
+    else
+      OpenStruct.new(klass: use_as_base.class,
+                     kinder: [self],
+                     fx: ->() {use_as_base}).create_fox_components
+    end
+    self
+  end
+
+  def instance_final_activate
+    self.instance_result = self.instance_block.(self.inst) unless self.instance_block.nil?
+    self.kinder.each{ |os| os.instance_final_activate }
+    self
+  end
+
+  # launch the application
+  def launch ingress: false
+    create_fox_components
+    instance_final_activate
+    activate
+    Enhancement.activate_ingress_handlers self if ingress
+    run_application
+  end
+end

data/spec/fxruby-enhancement_spec.rb

@@ -0,0 +1,57 @@
+require_relative 'spec_helper'
+
+describe String do
+  it "supports snaking on strings" do
+    s = "FXToolBar"
+    expect(s.snake).to eq("fx_tool_bar")
+  end
+end
+
+describe Symbol do
+  it "supports snaking on symbols" do
+    s = :FXToolBar
+    expect(s.snake).to eq(:fx_tool_bar)
+  end
+end
+
+include Fox
+include Fox::Enhancement::Mapper
+
+describe "DSL" do
+  before :all do
+    @app = fx_app :foobase do
+      app_name "Foo Test"
+      vendor_name "RubyNEAT Spinoff tech"
+            
+      @osmw = fx_main_window :main do
+        title "test window"
+        width 700
+        height 300
+        instance :foo_instance do |mw|
+          mw.vSpacing = 2
+          mw.show PLACEMENT_CURSOR
+        end        
+      end
+      
+      instance :app_startup do |app|
+        :mission_accomplished
+      end      
+    end
+    @app.create_fox_components
+    @app.instance_final_activate
+    @app.activate
+  end
+  
+  it "allows creation of the FXApp and one window" do
+    expect(Fox::Enhancement.base).to_not be_nil
+    expect(Fox::Enhancement.base.klass).to eq Fox::FXApp
+    @app.run_application
+    expect(@app.instance_result).to eq(:mission_accomplished)
+  end
+
+  it "adds the components to the internal registry" do
+    expect(fox_get_instance(:main).class).to eq(Fox::FXMainWindow)
+  end
+  
+  it "checks fx_menu_bar :ii defaults to 1 instead of zero"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'fxruby-enhancement'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

metadata

@@ -0,0 +1,319 @@
+--- !ruby/object:Gem::Specification
+name: fxruby-enhancement
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Fred Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semver2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: fxruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: queue_ding
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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."
+email: fred.mitchell@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.org
+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
+homepage: http://github.com/flajann2/fxruby-enhancement
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: fxruby enhancements
+test_files: []