glimmer-dsl-libui 0.9.6 → 0.10.0

data/lib/glimmer/libui/custom_shape.rb

@@ -0,0 +1,258 @@
+# Copyright (c) 2021-2023 Andy Maleh
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'super_module'
+require 'glimmer'
+require 'glimmer/error'
+require 'glimmer/proc_tracker'
+require 'glimmer/data_binding/observer'
+require 'glimmer/data_binding/observable_model'
+
+module Glimmer
+  module LibUI
+    module CustomShape
+      include SuperModule
+      include DataBinding::ObservableModel
+      
+      # This module was only created to prevent Glimmer from checking method_missing first
+      module GlimmerSupersedable
+        def method_missing(method_name, *args, &block)
+          # TODO Consider supporting a glimmer error silencing option for methods defined here
+          # but fail the glimmer DSL for the right reason to avoid seeing noise in the log output
+          if block && can_handle_listener?(method_name)
+            handle_listener(method_name, &block)
+          elsif @body_root.respond_to?(method_name, true)
+            @body_root.send(method_name, *args, &block)
+          else
+            super
+          end
+        end
+  
+        def respond_to?(method_name, *args, &block)
+          result = false
+          result ||= super
+          result ||= can_handle_listener?(method_name)
+          result ||= @body_root.respond_to?(method_name, *args, &block)
+        end
+      end
+
+      super_module_included do |klass|
+        # TODO clear memoization of Shape.libui_class_for for a keyword if a custom shape was defined with that keyword
+        klass.include(Glimmer)
+        klass.include(GlimmerSupersedable) # prevent Glimmer from running method_missing first
+        Glimmer::LibUI::CustomShape.add_custom_shape_namespaces_for(klass)
+      end
+      
+      class << self
+        def for(keyword)
+          unless flyweight_custom_shape_classes.keys.include?(keyword)
+            begin
+              extracted_namespaces = keyword.
+                to_s.
+                split(/__/).map do |namespace|
+                  namespace.camelcase(:upper)
+                end
+              custom_shape_namespaces.each do |base|
+                extracted_namespaces.reduce(base) do |result, namespace|
+                  if !result.constants.include?(namespace)
+                    namespace = result.constants.detect {|c| c.to_s.upcase == namespace.to_s.upcase } || namespace
+                  end
+                  begin
+                    flyweight_custom_shape_classes[keyword] = constant = result.const_get(namespace)
+                    return constant if constant.ancestors.include?(Glimmer::LibUI::CustomShape)
+                    flyweight_custom_shape_classes[keyword] = constant
+                  rescue => e
+                    # Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
+                    flyweight_custom_shape_classes[keyword] = result
+                  end
+                end
+              end
+              raise "#{keyword} has no custom shape class!"
+            rescue => e
+              Glimmer::Config.logger.debug {e.message}
+              Glimmer::Config.logger.debug {"#{e.message}\n#{e.backtrace.join("\n")}"}
+              flyweight_custom_shape_classes[keyword] = nil
+            end
+          end
+          flyweight_custom_shape_classes[keyword]
+        end
+        
+        # Flyweight Design Pattern memoization cache. Can be cleared if memory is needed.
+        def flyweight_custom_shape_classes
+          @flyweight_custom_shape_classes ||= {}
+        end
+        
+        # Returns keyword to use for this custom shape
+        def keyword
+          self.name.underscore.gsub('::', '__')
+        end
+        
+        # Returns shortcut keyword to use for this custom shape (keyword minus namespace)
+        def shortcut_keyword
+          self.name.underscore.gsub('::', '__').split('__').last
+        end
+        
+        def add_custom_shape_namespaces_for(klass)
+          Glimmer::LibUI::CustomShape.namespaces_for_class(klass).drop(1).each do |namespace|
+            Glimmer::LibUI::CustomShape.custom_shape_namespaces << namespace
+          end
+        end
+
+        def namespaces_for_class(m)
+          return [m] if m.name.nil?
+          namespace_constants = m.name.split(/::/).map(&:to_sym)
+          namespace_constants.reduce([Object]) do |output, namespace_constant|
+            output += [output.last.const_get(namespace_constant)]
+          end[1..-1].uniq.reverse
+        end
+
+        def custom_shape_namespaces
+          @custom_shape_namespaces ||= reset_custom_shape_namespaces
+        end
+
+        def reset_custom_shape_namespaces
+          @custom_shape_namespaces = Set[Object, Glimmer::LibUI]
+        end
+
+        # Allows defining convenience option accessors for an array of option names
+        # Example: `options :color1, :color2` defines `#color1` and `#color2`
+        # where they return the instance values `options[:color1]` and `options[:color2]`
+        # respectively.
+        # Can be called multiple times to set more options additively.
+        # When passed no arguments, it returns list of all option names captured so far
+        def options(*new_options)
+          new_options = new_options.compact.map(&:to_s).map(&:to_sym)
+          if new_options.empty?
+            @options ||= {} # maps options to defaults
+          else
+            new_options = new_options.reduce({}) {|new_options_hash, new_option| new_options_hash.merge(new_option => nil)}
+            @options = options.merge(new_options)
+            def_option_attr_accessors(new_options)
+          end
+        end
+
+        def option(new_option, default: nil)
+          new_option = new_option.to_s.to_sym
+          new_options = {new_option => default}
+          @options = options.merge(new_options)
+          def_option_attr_accessors(new_options)
+        end
+
+        def def_option_attr_accessors(new_options)
+          new_options.each do |option, default|
+            class_eval <<-end_eval, __FILE__, __LINE__
+              def #{option}
+                options[:#{option}]
+              end
+              
+              def #{option}=(option_value)
+                self.options[:#{option}] = option_value
+              end
+            end_eval
+          end
+        end
+
+        def before_body(&block)
+          @before_body_block = block
+        end
+
+        def body(&block)
+          @body_block = block
+        end
+
+        def after_body(&block)
+          @after_body_block = block
+        end
+      end
+
+      attr_reader :body_root, :parent, :parent_proxy, :args, :keyword, :content, :options
+
+      def initialize(keyword, parent, args, options, &content)
+        @parent_proxy = @parent = parent
+        options ||= {}
+        @options = self.class.options.merge(options)
+        @content = ProcTracker.new(content) if content
+        execute_hook('before_body')
+        body_block = self.class.instance_variable_get("@body_block")
+        raise Glimmer::Error, 'Invalid custom shape for having no body! Please define body block!' if body_block.nil?
+        @body_root = instance_exec(&body_block)
+        raise Glimmer::Error, 'Invalid custom shape for having an empty body! Please fill body block!' if @body_root.nil?
+        execute_hook('after_body')
+        # TODO deregister all observer_registrations on destroy of the shape once that listener is supported
+        # (on_destroy) unless it is the last window closing, in which case exit faster
+        post_add_content if content.nil?
+      end
+      
+      # Subclasses may override to perform post initialization work on an added child
+      def post_initialize_child(child)
+        # No Op by default
+      end
+
+      def post_add_content
+        # No Op by default
+      end
+      
+      def observer_registrations
+        @observer_registrations ||= []
+      end
+
+      def can_handle_listener?(listener)
+        body_root&.can_handle_listener?(listener.to_s)
+      end
+
+      def handle_listener(listener, &block)
+        body_root.handle_listener(listener.to_s, &block)
+      end
+      
+      # This method ensures it has an instance method not coming from Glimmer DSL
+      def has_instance_method?(method_name)
+        respond_to?(method_name) and
+          !@body_root.respond_to_libui?(method_name) and
+          (method(method_name) rescue nil) and
+          !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') and
+          !method(method_name)&.source_location&.first&.include?('glimmer/libui/shape.rb')
+      end
+
+      # Returns content block if used as an attribute reader (no args)
+      # Otherwise, if a block is passed, it adds it as content to this custom shape
+      def content(&block)
+        if block_given?
+          Glimmer::DSL::Engine.add_content(self, Glimmer::DSL::Libui::CustomShapeExpression.new, self.class.keyword, &block)
+        else
+          @content
+        end
+      end
+      
+      private
+
+      def execute_hook(hook_name)
+        hook_block = self.class.instance_variable_get("@#{hook_name}_block")
+        return if hook_block.nil?
+        temp_method_name = "#{hook_name}_block_#{hook_block.hash.abs}_#{(Time.now.to_f * 1_000_000).to_i}"
+        singleton_class.define_method(temp_method_name, &hook_block)
+        send(temp_method_name)
+        singleton_class.send(:remove_method, temp_method_name)
+      end
+    end
+  end
+end
+
+Dir[File.expand_path("./#{File.basename(__FILE__, '.rb')}/*.rb", __dir__)].each {|f| require f}

data/lib/glimmer/rake_task/scaffold.rb

@@ -219,7 +219,7 @@ module Glimmer
         end
     
         def custom_window_gem(custom_window_name, namespace)
-          gem_name = "glimmer-libui-cw-#{compact_name(custom_window_name)}"
+          gem_name = "glimmer-libui-cw-#{custom_window_name.underscore}"
           gem_summary = "#{human_name(custom_window_name)} - Glimmer Custom Window"
           begin
             custom_window_keyword = dsl_control_name(custom_window_name)
@@ -229,7 +229,7 @@ module Glimmer
             # No Op (keyword is not taken by a built in Ruby method)
           end
           if namespace
-            gem_name += "-#{compact_name(namespace)}"
+            gem_name += "-#{namespace.underscore}"
             gem_summary += " (#{human_name(namespace)})"
           else
             return puts('Namespace is required! Usage: glimmer scaffold:gem:customwindow[name,namespace]') unless `git config --get github.user`.to_s.strip == 'AndyObtiva'
@@ -292,10 +292,10 @@ module Glimmer
         end
     
         def custom_control_gem(custom_control_name, namespace)
-          gem_name = "glimmer-libui-cc-#{compact_name(custom_control_name)}"
+          gem_name = "glimmer-libui-cc-#{custom_control_name.underscore}"
           gem_summary = "#{human_name(custom_control_name)} - Glimmer Custom Control"
           if namespace
-            gem_name += "-#{compact_name(namespace)}"
+            gem_name += "-#{namespace.underscore}"
             gem_summary += " (#{human_name(namespace)})"
           else
             return puts('Namespace is required! Usage: glimmer scaffold:custom_control_gem[custom_control_name,namespace]') unless `git config --get github.user`.to_s.strip == 'AndyObtiva'
@@ -331,10 +331,10 @@ module Glimmer
         end
     
         def custom_shape_gem(custom_shape_name, namespace)
-          gem_name = "glimmer-libui-cs-#{compact_name(custom_shape_name)}"
+          gem_name = "glimmer-libui-cs-#{custom_shape_name.underscore}"
           gem_summary = "#{human_name(custom_shape_name)} - Glimmer Custom Shape"
           if namespace
-            gem_name += "-#{compact_name(namespace)}"
+            gem_name += "-#{namespace.underscore}"
             gem_summary += " (#{human_name(namespace)})"
           else
             return puts('Namespace is required! Usage: glimmer scaffold:custom_shape_gem[custom_shape_name,namespace]') unless `git config --get github.user`.to_s.strip == 'AndyObtiva'
@@ -414,10 +414,6 @@ module Glimmer
           app_name.underscore.titlecase
         end
     
-        def compact_name(gem_name)
-          gem_name.underscore.camelcase.downcase
-        end
-        
         def gemfile(window_type)
           APP_GEMFILE
         end
@@ -436,8 +432,6 @@ module Glimmer
             end
             
             class #{class_name(app_name)}
-              include Glimmer
-              
               APP_ROOT = File.expand_path('../..', __FILE__)
               VERSION = File.read(File.join(APP_ROOT, 'VERSION'))
               LICENSE = File.read(File.join(APP_ROOT, 'LICENSE.txt'))
@@ -645,12 +639,11 @@ require '#{window_type == :app ? current_dir_name : namespace}/model/greeting'
           
           margined true
           
-          vertical_box {
           MULTI_LINE_STRING
           
           if window_type == :gem
             custom_window_file_content += <<-MULTI_LINE_STRING
-            
+          vertical_box {
             button('Preferences...') {
               stretchy false
               
@@ -658,14 +651,21 @@ require '#{window_type == :app ? current_dir_name : namespace}/model/greeting'
                 display_preferences_dialog
               end
             }
-            MULTI_LINE_STRING
-          end
-          
-          custom_window_file_content += <<-MULTI_LINE_STRING
+            
             label {
               #{%i[gem app].include?(window_type) ? "text <= [@greeting, :text]" : "text '#{human_name(custom_window_name)}'"}
             }
           }
+            MULTI_LINE_STRING
+          else
+            custom_window_file_content += <<-MULTI_LINE_STRING
+          label {
+            #{%i[gem app].include?(window_type) ? "text <= [@greeting, :text]" : "text '#{human_name(custom_window_name)}'"}
+          }
+            MULTI_LINE_STRING
+          end
+          
+          custom_window_file_content += <<-MULTI_LINE_STRING
         }
       }
           MULTI_LINE_STRING
@@ -833,6 +833,7 @@ end
           namespace_type = class_name(namespace) == class_name(current_dir_name) ? 'class' : 'module'
     
           <<-MULTI_LINE_STRING
+# Delete this example model and replace with your own model
 #{namespace_type} #{class_name(namespace)}
   module Model
     class #{class_name(model_name)}

data/lib/glimmer/rake_task.rb

@@ -113,7 +113,7 @@ namespace :glimmer do
     task :cc, [:name, :namespace] => :customcontrol
     task :custom_control, [:name, :namespace] => :customcontrol
     task :"custom-control", [:name, :namespace] => :customcontrol
-#
+
 #     desc 'Scaffold Glimmer::UI::CustomShape subclass (part of a view) under app/views (namespace is optional) [alt: scaffold:cs]'
 #     task :customshape, [:name, :namespace] do |t, args|
 #       require_relative 'rake_task/scaffold'
@@ -123,7 +123,7 @@ namespace :glimmer do
 #     task :cs, [:name, :namespace] => :customshape
 #     task :custom_shape, [:name, :namespace] => :customshape
 #     task :"custom-shape", [:name, :namespace] => :customshape
-#
+
     namespace :gem do
       desc 'Scaffold Glimmer::UI::CustomWindow subclass (full window view) under its own Ruby gem + app project (namespace is required) [alt: scaffold:gem:cw]'
       task :customwindow, [:name, :namespace] do |t, args|
@@ -134,17 +134,17 @@ namespace :glimmer do
       task :cw, [:name, :namespace] => :customwindow
       task :custom_window, [:name, :namespace] => :customwindow
       task :"custom-window", [:name, :namespace] => :customwindow
-#
-#       desc 'Scaffold Glimmer::UI::CustomControl subclass (part of a view) under its own Ruby gem project (namespace is required) [alt: scaffold:gem:cc]'
-#       task :customcontrol, [:name, :namespace] do |t, args|
-#         require_relative 'rake_task/scaffold'
-#         Glimmer::RakeTask::Scaffold.custom_control_gem(args[:name], args[:namespace])
-#       end
-#
-#       task :cc, [:name, :namespace] => :customcontrol
-#       task :custom_control, [:name, :namespace] => :customcontrol
-#       task :"custom-control", [:name, :namespace] => :customcontrol
-#
+
+      desc 'Scaffold Glimmer::UI::CustomControl subclass (part of a view) under its own Ruby gem project (namespace is required) [alt: scaffold:gem:cc]'
+      task :customcontrol, [:name, :namespace] do |t, args|
+        require_relative 'rake_task/scaffold'
+        Glimmer::RakeTask::Scaffold.custom_control_gem(args[:name], args[:namespace])
+      end
+
+      task :cc, [:name, :namespace] => :customcontrol
+      task :custom_control, [:name, :namespace] => :customcontrol
+      task :"custom-control", [:name, :namespace] => :customcontrol
+
 #       desc 'Scaffold Glimmer::UI::CustomShape subclass (part of a view) under its own Ruby gem project (namespace is required) [alt: scaffold:gem:cs]'
 #       task :customshape, [:name, :namespace] do |t, args|
 #         require_relative 'rake_task/scaffold'

data/lib/glimmer-dsl-libui.rb

@@ -25,7 +25,7 @@ $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 require 'glimmer'
 require 'perfect-shape'
 # require 'logging'
-# require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
+require 'puts_debuggerer' if (ENV['PD'] || ENV['pd']).to_s.downcase == 'true'
 # require 'super_module'
 require 'color'
 require 'os'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.10.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-21 00:00:00.000000000 Z
+date: 2023-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -353,8 +353,9 @@ description: Glimmer DSL for LibUI (Fukuoka Award Winning Prerequisite-Free Ruby
   GUI that just works on Mac, Windows, and Linux! Glimmer DSL for LibUI aims to provide
   declarative DSL syntax that visually maps to GUI control hierarchy, convention over
   configuration via smart defaults, automation of low-level details, requiring the
-  least amount of syntax possible to build GUI, bidirectional data-binding, and custom
-  keyword support. If you liked Shoes, You'll love Glimmer!
+  least amount of syntax possible to build GUI, bidirectional data-binding, custom
+  control/window support, and application/gem/window/control scaffolding. If you liked
+  Shoes, You'll love Glimmer!
 email: andy.am@gmail.com
 executables:
 - glimmer
@@ -388,6 +389,7 @@ files:
 - examples/basic_child_window.rb
 - examples/basic_code_area.rb
 - examples/basic_composite_shape.rb
+- examples/basic_custom_shape.rb
 - examples/basic_draw_text.rb
 - examples/basic_draw_text2.rb
 - examples/basic_entry.rb
@@ -500,6 +502,7 @@ files:
 - lib/glimmer/dsl/libui/bind_expression.rb
 - lib/glimmer/dsl/libui/control_expression.rb
 - lib/glimmer/dsl/libui/custom_control_expression.rb
+- lib/glimmer/dsl/libui/custom_shape_expression.rb
 - lib/glimmer/dsl/libui/data_binding_expression.rb
 - lib/glimmer/dsl/libui/dsl.rb
 - lib/glimmer/dsl/libui/file_expression.rb
@@ -586,6 +589,7 @@ files:
 - lib/glimmer/libui/custom_control.rb
 - lib/glimmer/libui/custom_control/code_area.rb
 - lib/glimmer/libui/custom_control/refined_table.rb
+- lib/glimmer/libui/custom_shape.rb
 - lib/glimmer/libui/custom_window.rb
 - lib/glimmer/libui/data_bindable.rb
 - lib/glimmer/libui/image_path_renderer.rb