glimmer-dsl-libui 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5ccd1c22e43fbb8401dff62f07008895ad88522452f079112998d0e10f58d72
-  data.tar.gz: 9820c416164d39189ca3d6cfc90076b566b68b3c5e50b293e85d97edd2d4d04b
+  metadata.gz: d99fb74f5b4aa47cf07f00cf6afb426a66cbac0947d1e854c859703b9158d635
+  data.tar.gz: 75a27219914e19011e47051b60312e11ac83980d98e18fcb387ea84bfbfb6dd5
 SHA512:
-  metadata.gz: 545d81430224a9e197ddc4cd15168af5a3cd5f0d24c20f405bb5db3bbe499e38fa0339697e254dd100d7a76aa733fc98f7c3d3f9a8f824dc45a0fc13c4651b24
-  data.tar.gz: 41f91f675dab3a0ecc4004ddc6670db3770127e03dce01143c5be0996894abe9960ee7c6c2ef89166f88faaa6529e24a437821f6b59ce4f764a6c3f7407313cd
+  metadata.gz: bf483f831272a8d2443a1b932ab2e25043377d3c349a6dbd1810055ed87b6b8409b78e74e7e8d938dda8945108258dd692626dcc2f859d8309066c7e6c1ef058
+  data.tar.gz: 94d01b95cab06dbab277fdd1e2478b5f49c635e07c0702fb51e3726594de6a76a55d3d15185abeed8064ab12cec9bd16bbee5f1aa131ebae9c6e22d5401c4584

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## 0.5.8
+
+- Support `code_area` class-based custom control as a code-syntax-highlighted `area` control using the `rouge` gem
+- `examples/basic_code_area.rb`
+- Handle hex colors that have a 3-digit shorthand
+- Stop annoying false negative logs when using `Glimmer::LibUI::CustomWindow`
+
 ## 0.5.7
 
 - Support Custom Window keywords (aka Applications) using `Glimmer::LibUI::CustomWindow` or alias of `Glimmer::LibUI::Application`

data/README.md

@@ -1,4 +1,4 @@
-# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.5.7
+# [<img src="https://raw.githubusercontent.com/AndyObtiva/glimmer/master/images/glimmer-logo-hi-res.png" height=85 />](https://github.com/AndyObtiva/glimmer) Glimmer DSL for LibUI 0.5.8
 ## Prerequisite-Free Ruby Desktop Development GUI Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-libui.svg)](http://badge.fury.io/rb/glimmer-dsl-libui)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -405,6 +405,7 @@ DSL | Platforms | Native? | Vector Graphics? | Pros | Cons | Prereqs
       - [Basic Image](#basic-image)
       - [Basic Transform](#basic-transform)
       - [Basic Draw Text](#basic-draw-text)
+      - [Basic Code Area](#basic-code-area)
     - [Advanced Examples](#advanced-examples)
       - [Area Gallery](#area-gallery)
       - [Button Counter](#button-counter)
@@ -577,7 +578,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.5.7'
+gem 'glimmer-dsl-libui', '~> 0.5.8'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -590,14 +591,40 @@ Mac | Windows | Linux
 ----|---------|------
 ![glimmer-dsl-libui-mac-meta-example.png](images/glimmer-dsl-libui-mac-meta-example.png) | ![glimmer-dsl-libui-windows-meta-example.png](images/glimmer-dsl-libui-windows-meta-example.png) | ![glimmer-dsl-libui-linux-meta-example.png](images/glimmer-dsl-libui-linux-meta-example.png)
 
-Now to use [glimmer-dsl-libui](https://rubygems.org/gems/glimmer-dsl-libui), add `require 'glimmer-dsl-libui'` at the top, and then `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
+Now to use [glimmer-dsl-libui](https://rubygems.org/gems/glimmer-dsl-libui), add `require 'glimmer-dsl-libui'` at the top.
 
-Example (you may copy/paste in [`girb`](#girb-glimmer-irb)):
+Afterwards, `include Glimmer` into the top-level main object for testing or into an actual class for serious usage.
+
+Alternatively, `include Glimmer::LibUI::Application` to conveniently declare the GUI `body` and run via the `::launch` method (`Glimmer::LibUI::Application` is an alias for `Glimmer::LibUI::CustomWindow` since that is what it represents).
+
+Example including `Glimmer::LibUI::Application` (you may copy/paste in [`girb`](#girb-glimmer-irb)):
+
+```ruby
+require 'glimmer-dsl-libui'
+
+class SomeGlimmerApp
+  include Glimmer::LibUI::Application
+  
+  body {
+    window('hello world', 300, 200) {
+      button('Button') {
+        on_clicked do
+          puts 'Button Clicked'
+        end
+      }
+    }
+  }
+end
+
+SomeGlimmerApp.launch
+```
+
+Example including `Glimmer` and manually implementing the `#launch` method (you may copy/paste in [`girb`](#girb-glimmer-irb)):
 
 ```ruby
 require 'glimmer-dsl-libui'
 
-class Application
+class SomeGlimmerApp
   include Glimmer
   
   def launch
@@ -611,7 +638,23 @@ class Application
   end
 end
 
-Application.new.launch
+SomeGlimmerApp.new.launch
+```
+
+Example including `Glimmer` at the top-level scope just for some prototyping/demoing/testing (you may copy/paste in [`girb`](#girb-glimmer-irb)):
+
+```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+  
+window('hello world', 300, 200) {
+  button('Button') {
+    on_clicked do
+      puts 'Button Clicked'
+    end
+  }
+}.show
 ```
 
 If you are new to [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui), check out [Girb](#girb-glimmer-irb) and [Examples](#examples) to quickly learn through copy/paste. You may refer to the [API](#api) later on once you have gotten your feet wet with [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) and need more detailed reference information.
@@ -675,6 +718,7 @@ Keyword(Args) | Properties | Listeners
 `checkbox_text_column(name as String)` | `editable` (Boolean), `editable_checkbox` (Boolean), `editable_text` (Boolean) | None
 `checkbox_text_color_column(name as String)` | `editable` (Boolean), `editable_checkbox` (Boolean), `editable_text` (Boolean) | None
 `check_menu_item(text as String)` | `checked` (Boolean) | `on_clicked`
+`code_area` | `language` (String) (default: `'ruby'`), `theme` (String) (default: `'glimmer'`), `code` (String) | None
 `combobox` | `items` (`Array` of `String`), `selected` (`Integer`), `selected_item` (`String`) | `on_selected`
 `color_button` | `color` (Array of `red` as `Float`, `green` as `Float`, `blue` as `Float`, `alpha` as `Float`), `red` as `Float`, `green` as `Float`, `blue` as `Float`, `alpha` as `Float` | `on_changed`
 `date_picker` | `time` (`Hash` of keys: `sec` as `Integer`, `min` as `Integer`, `hour` as `Integer`, `mday` as `Integer`, `mon` as `Integer`, `year` as `Integer`, `wday` as `Integer`, `yday` as `Integer`, `dst` as Boolean) | `on_changed`
@@ -4987,6 +5031,62 @@ end
 BasicDrawText.new.launch
 ```
 
+#### Basic Code Area
+
+[examples/basic_code_area.rb](examples/basic_code_area.rb)
+
+Run with this command from the root of the project if you cloned the project:
+
+```
+ruby -r './lib/glimmer-dsl-libui' examples/basic_code_area.rb
+```
+
+Run with this command if you installed the [Ruby gem](https://rubygems.org/gems/glimmer-dsl-libui):
+
+```
+ruby -r glimmer-dsl-libui -e "require 'examples/basic_code_area'"
+```
+
+Mac | Windows | Linux
+----|---------|------
+![glimmer-dsl-libui-mac-basic-code-area.png](images/glimmer-dsl-libui-mac-basic-code-area.png) | ![glimmer-dsl-libui-windows-basic-code-area.png](images/glimmer-dsl-libui-windows-basic-code-area.png) | ![glimmer-dsl-libui-linux-basic-code-area.png](images/glimmer-dsl-libui-linux-basic-code-area.png)
+
+New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version:
+
+```ruby
+require 'glimmer-dsl-libui'
+
+class BasicCodeArea
+  include Glimmer::LibUI::Application
+  
+  before_body do
+    @code = <<~CODE
+      # Greets target with greeting
+      def greet(greeting: 'Hello', target: 'World')
+        
+        puts "\#{greeting}, \#{target}!"
+      end
+      
+      greet
+      greet(target: 'Robert')
+      greet(greeting: 'Aloha')
+      greet(greeting: 'Aloha', target: 'Nancy')
+      greet(greeting: 'Howdy', target: 'Doodle')
+    CODE
+  end
+  
+  body {
+    window('Basic Code Area', 400, 300) {
+      margined true
+      
+      code_area(language: 'ruby', code: @code)
+    }
+  }
+end
+
+BasicCodeArea.launch
+```
+
 ### Advanced Examples
 
 #### Area Gallery
@@ -8967,8 +9067,6 @@ New [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) Version
 require 'glimmer-dsl-libui'
 require 'facets'
 
-include Glimmer
-
 Address = Struct.new(:street, :p_o_box, :city, :state, :zip_code)
 
 class FormField
@@ -9029,54 +9127,64 @@ class AddressView
   }
 end
 
-address1 = Address.new('123 Main St', '23923', 'Denver', 'Colorado', '80014')
-address2 = Address.new('2038 Park Ave', '83272', 'Boston', 'Massachusetts', '02101')
-
-window('Class-Based Custom Keyword') {
-  margined true
+class ClassBasedCustomControls
+  include Glimmer::LibUI::Application # alias: Glimmer::LibUI::CustomWindow
   
-  horizontal_box {
-    vertical_box {
-      label('Address 1') {
-        stretchy false
-      }
-      
-      address_form(address: address1)
-      
-      horizontal_separator {
-        stretchy false
-      }
-      
-      label('Address 1 (Saved)') {
-        stretchy false
-      }
-      
-      address_view(address: address1)
-    }
-    
-    vertical_separator {
-      stretchy false
-    }
-    
-    vertical_box {
-      label('Address 2') {
-        stretchy false
-      }
-      
-      address_form(address: address2)
-      
-      horizontal_separator {
-        stretchy false
-      }
+  before_body do
+    @address1 = Address.new('123 Main St', '23923', 'Denver', 'Colorado', '80014')
+    @address2 = Address.new('2038 Park Ave', '83272', 'Boston', 'Massachusetts', '02101')
+  end
+  
+  body {
+    window('Class-Based Custom Keyword') {
+      margined true
       
-      label('Address 2 (Saved)') {
-        stretchy false
+      horizontal_box {
+        vertical_box {
+          label('Address 1') {
+            stretchy false
+          }
+          
+          address_form(address: @address1)
+          
+          horizontal_separator {
+            stretchy false
+          }
+          
+          label('Address 1 (Saved)') {
+            stretchy false
+          }
+          
+          address_view(address: @address1)
+        }
+        
+        vertical_separator {
+          stretchy false
+        }
+        
+        vertical_box {
+          label('Address 2') {
+            stretchy false
+          }
+          
+          address_form(address: @address2)
+          
+          horizontal_separator {
+            stretchy false
+          }
+          
+          label('Address 2 (Saved)') {
+            stretchy false
+          }
+          
+          address_view(address: @address2)
+        }
       }
-      
-      address_view(address: address2)
     }
   }
-}.show
+end
+
+ClassBasedCustomControls.launch
 ```
 
 #### Area-Based Custom Controls

data/VERSION

@@ -1 +1 @@
-0.5.7
+0.5.8

data/examples/basic_code_area.rb

@@ -0,0 +1,31 @@
+require 'glimmer-dsl-libui'
+
+class BasicCodeArea
+  include Glimmer::LibUI::Application
+  
+  before_body do
+    @code = <<~CODE
+      # Greets target with greeting
+      def greet(greeting: 'Hello', target: 'World')
+        
+        puts "\#{greeting}, \#{target}!"
+      end
+      
+      greet
+      greet(target: 'Robert')
+      greet(greeting: 'Aloha')
+      greet(greeting: 'Aloha', target: 'Nancy')
+      greet(greeting: 'Howdy', target: 'Doodle')
+    CODE
+  end
+  
+  body {
+    window('Basic Code Area', 400, 300) {
+      margined true
+      
+      code_area(language: 'ruby', code: @code)
+    }
+  }
+end
+
+BasicCodeArea.launch

data/lib/glimmer/libui/control_proxy/area_proxy.rb

@@ -85,7 +85,7 @@ module Glimmer
         end
         
         def post_add_content
-          unless parent_proxy.is_a?(Box)
+          if OS.linux? && parent_proxy.is_a?(WindowProxy)
             unless @content_added
               original_parent_proxy = @parent_proxy
               @vertical_box_parent_proxy = ControlProxy.create('vertical_box', parent_proxy, []) {} # block prevents calling post add content

data/lib/glimmer/libui/control_proxy.rb

@@ -401,4 +401,4 @@ module Glimmer
   end
 end
 
-Dir[File.expand_path('./control_proxy/*.rb', __dir__)].each {|f| require f}
+Dir[File.expand_path("./#{File.basename(__FILE__, '.rb')}/*.rb", __dir__)].each {|f| require f}

data/lib/glimmer/libui/custom_control/code_area.rb

@@ -0,0 +1,65 @@
+class CodeArea
+  class << self
+    def languages
+      require 'rouge'
+      Rouge::Lexer.all.map {|lexer| lexer.tag}.sort
+    end
+    
+    def lexers
+      require 'rouge'
+      Rouge::Lexer.all.sort_by(&:title)
+    end
+  end
+  
+  include Glimmer::LibUI::CustomControl
+  
+  REGEX_COLOR_HEX6 = /^#([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/
+  
+  option :language, default: 'ruby'
+  option :theme, default: 'glimmer'
+  option :code
+  
+  body {
+    area {
+      rectangle(0, 0, 8000, 8000) {
+        fill :white
+      }
+      text {
+        default_font family: OS.mac? ? 'Consolas' : 'Courier', size: 13, weight: :medium, italic: :normal, stretch: :normal
+        
+        syntax_highlighting(code).each do |token|
+          style_data = Rouge::Theme.find(theme).new.style_for(token[:token_type])
+         
+          string(token[:token_text]) {
+            color style_data[:fg] || :black
+            background style_data[:bg] || :white
+          }
+        end
+      }
+    }
+  }
+  
+  def lexer
+    require 'rouge'
+    require 'glimmer-dsl-libui/ext/rouge/theme/glimmer'
+    # TODO Try to use Rouge::Lexer.find_fancy('guess', code) in the future to guess the language or otherwise detect it from file extension
+    @lexer ||= Rouge::Lexer.find_fancy(language)
+    @lexer ||= Rouge::Lexer.find_fancy('ruby') # default to Ruby if no lexer is found
+  end
+  
+  def syntax_highlighting(text)
+    return [] if text.to_s.strip.empty?
+    @syntax_highlighting ||= {}
+    unless @syntax_highlighting.keys.include?(text)
+      lex = lexer.lex(text).to_a
+      text_size = 0
+      @syntax_highlighting[text] = lex.map do |pair|
+        {token_type: pair.first, token_text: pair.last}
+      end.each do |hash|
+        hash[:token_index] = text_size
+        text_size += hash[:token_text].size
+      end
+    end
+    @syntax_highlighting[text]
+  end
+end

data/lib/glimmer/libui/custom_control.rb

@@ -232,9 +232,10 @@ module Glimmer
       end
 
       def respond_to?(method_name, *args, &block)
-        super or
-          can_handle_listener?(method_name) or
-          @body_root.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
       
       private
@@ -250,3 +251,5 @@ module Glimmer
     end
   end
 end
+
+Dir[File.expand_path("./#{File.basename(__FILE__, '.rb')}/*.rb", __dir__)].each {|f| require f}

data/lib/glimmer/libui/custom_window.rb

@@ -37,7 +37,11 @@ module Glimmer
       end
       
       def initialize(parent, *swt_constants, options, &content)
+        original_logger = Glimmer::Config.logger
+        require 'stringio'
+        Glimmer::Config.logger = Logger.new(StringIO.new)
         super
+        Glimmer::Config.logger = original_logger
         raise Glimmer::Error, 'Invalid custom window body root! Must be a window, another custom window, or a custom control with window as its body root!' unless body_root.is_a?(Glimmer::LibUI::ControlProxy::WindowProxy) || body_root.is_a?(Glimmer::LibUI::CustomWindow) || (body_root.is_a?(Glimmer::LibUI::CustomControl) && body_root.body_root.is_a?(Glimmer::LibUI::ControlProxy::WindowProxy))
       end
       

data/lib/glimmer/libui.rb

@@ -80,11 +80,9 @@ module Glimmer
     
       def hex_to_rgb(value)
         if value.is_a?(String)
-          value = "0x#{value[1..-1]}" if value.start_with?('#')
-          if !value.start_with?('0x')
-            value = value.chars.map {|char| [char, char]}.flatten.join if value.length == 3
-            value = "0x#{value}"
-          end
+          value = value[2..-1] if value.start_with?('0x')
+          value = value[1..-1] if value.start_with?('#')
+          value = value.chars.map {|char| [char, char]}.flatten.join if value.length == 3
           value = value.to_i(16)
         end
         if value.is_a?(Integer)

data/lib/glimmer-dsl-libui/ext/rouge/theme/glimmer.rb

@@ -0,0 +1,29 @@
+module Rouge
+  module Themes
+    # A port of the pastie style from Pygments.
+    # See https://bitbucket.org/birkenfeld/pygments-main/src/default/pygments/styles/pastie.py
+    class Glimmer < Github
+      name 'glimmer'
+      style Comment::Single, fg:      [106,115,125], italic: true # Also, Comments
+      style Keyword::Pseudo, fg:      [:dark_red]
+      style Keyword, fg:     [:blue]
+      style Literal::String::Single, fg:      [106,115,125] # Also, Comments
+      style Literal::String::Double, fg:     [0,92,197]
+      style Literal::String::Escape, fg:      [:red]
+      style Literal::Number::Integer, fg:     [:blue]
+      style Literal::String::Interpol, fg:    [:blue]
+      style Literal::String::Symbol, fg:      [:dark_green]
+      style Literal::String, fg:      [:dark_blue]
+      style Name::Builtin, fg:     [215,58,73]
+      style Name::Class, fg:       [3,47,98]
+      style Name::Namespace, fg: [3,47,98]
+      style Name::Constant, fg:    [0,92,197]
+      style Name::Function, fg:    [:blue]
+      style Name::Variable::Instance, fg:    [227,98,9]
+      style Name, fg:        [111,66,193] #purple
+      style Operator, fg:    [:red]
+      style Punctuation, fg: [:blue]
+      style Text, fg:        [75, 75, 75]
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -128,6 +128,26 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.11
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.26.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.26.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: juwelier
   requirement: !ruby/object:Gem::Requirement
@@ -265,6 +285,7 @@ files:
 - examples/basic_area3.rb
 - examples/basic_area4.rb
 - examples/basic_button.rb
+- examples/basic_code_area.rb
 - examples/basic_draw_text.rb
 - examples/basic_draw_text2.rb
 - examples/basic_entry.rb
@@ -359,6 +380,7 @@ files:
 - icons/glimmer.png
 - lib/glimmer-dsl-libui.rb
 - lib/glimmer-dsl-libui/ext/glimmer.rb
+- lib/glimmer-dsl-libui/ext/rouge/theme/glimmer.rb
 - lib/glimmer/dsl/libui/bind_expression.rb
 - lib/glimmer/dsl/libui/control_expression.rb
 - lib/glimmer/dsl/libui/custom_control_expression.rb
@@ -444,6 +466,7 @@ files:
 - lib/glimmer/libui/control_proxy/triple_column.rb
 - lib/glimmer/libui/control_proxy/window_proxy.rb
 - lib/glimmer/libui/custom_control.rb
+- lib/glimmer/libui/custom_control/code_area.rb
 - lib/glimmer/libui/custom_window.rb
 - lib/glimmer/libui/data_bindable.rb
 - lib/glimmer/libui/image_path_renderer.rb
@@ -486,7 +509,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.1
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Glimmer DSL for LibUI