glimmer-dsl-libui 0.4.22 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc2ebc159948cf7110cdc9113b219809789a6b73c5412435364998c5633afe26
-  data.tar.gz: f6f988f09d76f8cbe72bc76fc2440c426def14ecbd4405270d70d05012d4d183
+  metadata.gz: '08fe50ceac6ad2e11ec6599ba592d0a040cd4b7158a788dd8d001fddfa7e337e'
+  data.tar.gz: b10af93758d8b4141962c9b73c87f16419f302785b29b84cf62befe86181d507
 SHA512:
-  metadata.gz: f9d5a3a2232050cc372235a7e97d47ab26fdf5a39c87e1d77614e029b938c9d745f2ba01caf4d26158f0c2334035db63e5226fd6e1d9cf61df656a293c81c3b6
-  data.tar.gz: 77ff5efbc0945a2be47f0e2241025c6a9eb83e122c42581cb704c3a540d1d7ac6cd224d6a25b58e6894ccee852b32f3ba65daedaab6b27d53a4808bda163ed2a
+  metadata.gz: ffcf60fe7615eaac2109035a3ce64510ca2f76c5726c2c1c48fe0adba98ad1780c5f599fc9cb154ed789571710e5e2239f950e8dc16ec041f4727e5d0bfcef53
+  data.tar.gz: 4bb634aec81f105cd2de9aa9b2e0e3b4bd9c0eb1e715b8309cbdb4f7cd42113631e2f9d51e3db14ea9362bde930d6602ee23d7df6bb987edaf337a0d94f2756d

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Change Log
 
+## 0.5.3
+
+- Support `polyline` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+- Support `polygon` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+- Support `polybezier` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+
+## 0.5.2
+
+- Support `line` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+- Support `bezier` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+
+## 0.5.1
+
+- Upgrade to libui 0.0.14
+- Alter `Shape#contain?` to support `outline: ` and `distance_tolerance: ` options as per perfect-shape gem
+- Support `arc` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+- Support `circle` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+
+## 0.5.0
+
+- Upgrade to glimmer 2.6.0
+- Support `rectangle` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+- Support `square` `bounding_box` (minx, miny, width, height), `contain?` method (checking if shape contains point inside) and `include?` method (checking on outline if stroked and inside if filled?)
+
 ## 0.4.22
 
 - examples/tetris.rb "Show Next Block Preview" menu item under "View" menu

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.4.22
+# [<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.3
 ## 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)
@@ -330,7 +330,7 @@ Mac | Windows | Linux
 
 ![glimmer-dsl-libui-mac-tetris.gif](images/glimmer-dsl-libui-mac-tetris.gif)
 
-NOTE: [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is 100% feature-complete and in beta mode (though the C [libui](https://github.com/andlabs/libui) is still mid-alpha). Please help make better by contributing, adopting for small or low risk projects, and providing feedback. The more feedback and issues you report the better.
+NOTE: [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) is 100% feature-complete with regards to covering the C [libui](https://github.com/andlabs/libui) library API and in beta mode (though the C [libui](https://github.com/andlabs/libui) is still mid-alpha, which is why [Glimmer DSL for LibUI](https://rubygems.org/gems/glimmer-dsl-libui) cannot be declared v1.0.0 yet). Please help make better by contributing, adopting for small or low risk projects, and providing feedback. The more feedback and issues you report the better.
 
 **[Glimmer](https://rubygems.org/gems/glimmer) DSL Comparison Table:**
 DSL | Platforms | Native? | Vector Graphics? | Pros | Cons | Prereqs
@@ -519,7 +519,7 @@ gem install glimmer-dsl-libui
 Or install via Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-libui', '~> 0.4.22'
+gem 'glimmer-dsl-libui', '~> 0.5.3'
 ```
 
 Test that installation worked by running the [Meta-Example](#examples):
@@ -985,6 +985,14 @@ Mac | Windows | Linux
 ----|---------|------
 ![glimmer-dsl-libui-mac-area-gallery.png](images/glimmer-dsl-libui-mac-area-gallery.png) | ![glimmer-dsl-libui-windows-area-gallery.png](images/glimmer-dsl-libui-windows-area-gallery.png) | ![glimmer-dsl-libui-linux-area-gallery.png](images/glimmer-dsl-libui-linux-area-gallery.png)
 
+##### Shape Methods
+
+- `::parameters`: returns parameters of a shape class
+- `#bounding_box`: returns `Array` containing `[min_x, min_y, width, height]`
+- `#contain?(*point, outline: false, distance_tolerance: 0)`: Returns if point (`[x, y]` `Array` or args) is inside the shape when `outline` is `false` or on the outline when `outline` is `true`. `distance_tolerance` is used when `outline` is `true` as a fuzz factor for declaring a point on the outline of the shape (e.g. helps users select a shape from its outline more easily).
+- `#include?(*point)`: Returns if point (`[x, y]` `Array` or args) is inside the shape when filled (having `fill` value) or on the outline when stroked (not having `fill` value yet `stroke` value only)
+- `#perfect_shape`: returns [PerfectShape](https://github.com/AndyObtiva/perfect-shape) object matching the [libui](https://github.com/andlabs/libui) shape.
+
 #### Area Text
 
 To draw `text` in an `area`, you simply nest a `text(x, y, width)` control directly under `area` or inside a `on_draw` listener, and then nest attributed `string {[attributes]; string_value}` controls underneath it returning an actual `String` (think of them as the `<span>` or `<p>` element in html, which contains a string of text). Alternatively, you can nest attributed `string(string_value) {[attributes]}` if `string_value` is a short single-line string. An attributed `string` value can be changed dynamically via its `string` property.
@@ -1008,15 +1016,49 @@ To draw `text` in an `area`, you simply nest a `text(x, y, width)` control direc
 Example (you may copy/paste in [`girb`](#girb-glimmer-irb)):
 
 ```ruby
+require 'glimmer-dsl-libui'
+
+include Glimmer
+
 window('area text drawing') {
   area {
     text {
       default_font family: 'Helvetica', size: 12, weight: :normal, italic: :normal, stretch: :normal
         
+      string('This ') {
+        font size: 20, weight: :bold, italic: :normal, stretch: :normal
+        color r: 128, g: 0, b: 0, a: 1
+      }
+        
+      string('is ') {
+        font size: 20, weight: :bold, italic: :normal, stretch: :normal
+        color r: 0, g: 128, b: 0, a: 1
+      }
+        
+      string('a ') {
+        font size: 20, weight: :bold, italic: :normal, stretch: :normal
+        color r: 0, g: 0, b: 128, a: 1
+      }
+        
+      string('short ') {
+        font size: 20, weight: :bold, italic: :italic, stretch: :normal
+        color r: 128, g: 128, b: 0, a: 1
+      }
+        
+      string('attributed ') {
+        font size: 20, weight: :bold, italic: :normal, stretch: :normal
+        color r: 0, g: 128, b: 128, a: 1
+      }
+        
+      string("string \n\n") {
+        font size: 20, weight: :bold, italic: :normal, stretch: :normal
+        color r: 128, g: 0, b: 128, a: 1
+      }
+        
       string {
         font family: 'Georgia', size: 13, weight: :medium, italic: :normal, stretch: :normal
-        color r: 230, g: 100, b: 50, a: 0.5
-        background r: 230, g: 200, b: 250, a: 0.8
+        color r: 0, g: 128, b: 255, a: 1
+        background r: 255, g: 255, b: 0, a: 0.5
         underline :single
         underline_color :spelling
         open_type_features {
@@ -1029,13 +1071,14 @@ window('area text drawing') {
         "attributed string\n" \
         "spanning multiple lines\n\n"
       }
-      
-      string('This is a short unattributed string')
     }
   }
 }.show
 ```
 
+![glimmer-dsl-libui-mac-area-text-drawing.png](/images/glimmer-dsl-libui-mac-area-text-drawing.png)
+
+
 You may checkout [examples/basic_draw_text.rb](#basic-draw-text) and [examples/custom_draw_text.rb](#custom-draw-text) for examples of using `text` inside `area`.
 
 Mac | Windows | Linux
@@ -1853,6 +1896,8 @@ For Mac, consider [Platypus](https://github.com/sveinbjornt/Platypus) (builds a
 
 For Linux, simply package your app as a [Ruby Gem](https://guides.rubygems.org/what-is-a-gem/) and [build rpm package from Ruby Gem](https://www.redpill-linpro.com/sysadvent/2015/12/07/building-rpms-from-gems.html) or [build deb package from Ruby Gem](https://openpreservation.org/blogs/building-debian-package-ruby-program/).
 
+Also, there is a promising project called [ruby-packer](https://github.com/pmq20/ruby-packer) that supports all platforms.
+
 ## Glimmer Style Guide
 
 **1 - Control arguments are always wrapped by parentheses.**
@@ -5496,7 +5541,7 @@ class ColorTheCircles
   
   def color_circle(x, y)
     clicked_circle_data = @circles_data.find do |circle_data|
-      circle_data[:fill].nil? && circle_data[:circle]&.include?(x, y)
+      circle_data[:fill].nil? && circle_data[:circle]&.contain?(x, y)
     end
     if clicked_circle_data
       clicked_circle_data[:fill] = clicked_circle_data[:stroke]

data/VERSION

@@ -1 +1 @@
-0.4.22
+0.5.3

data/examples/color_the_circles.rb

@@ -81,7 +81,7 @@ class ColorTheCircles
   
   def color_circle(x, y)
     clicked_circle_data = @circles_data.find do |circle_data|
-      circle_data[:fill].nil? && circle_data[:circle]&.include?(x, y)
+      circle_data[:fill].nil? && circle_data[:circle]&.contain?(x, y)
     end
     if clicked_circle_data
       clicked_circle_data[:fill] = clicked_circle_data[:stroke]

data/lib/glimmer/libui/shape/arc.rb

@@ -44,6 +44,23 @@ module Glimmer
           end
           super
         end
+        
+        def perfect_shape
+          perfect_shape_dependencies = [x_center, y_center, radius, start_angle, sweep, is_negative]
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            x_center, y_center, radius, start_angle, sweep, is_negative = @perfect_shape_dependencies = perfect_shape_dependencies
+            sign = is_negative ? 1 : -1
+            start = is_negative ? (360 - start_angle) : -1*start_angle
+            extent = is_negative ? (360 - sweep) : -1*sweep
+            @perfect_shape = PerfectShape::Arc.new(
+              type: :open,
+              center_x: x_center, center_y: y_center,
+              radius_x: radius, radius_y: radius,
+              start: start, extent: extent
+            )
+          end
+          @perfect_shape
+        end
       end
     end
   end

data/lib/glimmer/libui/shape/bezier.rb

@@ -49,6 +49,15 @@ module Glimmer
         def include_start_point?
           x && y
         end
+        
+        def perfect_shape
+          perfect_shape_dependencies = [x, y, c1_x, c1_y, c2_x, c2_y, end_x, end_y]
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            x, y, c1_x, c1_y, c2_x, c2_y, end_x, end_y = @perfect_shape_dependencies = perfect_shape_dependencies
+            @perfect_shape = PerfectShape::CubicBezierCurve.new(points: [[x, y], [c1_x, c1_y], [c2_x, c2_y], [end_x, end_y]])
+          end
+          @perfect_shape
+        end
       end
     end
   end

data/lib/glimmer/libui/shape/circle.rb

@@ -45,8 +45,13 @@ module Glimmer
           super
         end
         
-        def include?(x, y)
-          (x - x_center)**2 + (y - y_center)**2 < radius**2
+        def perfect_shape
+          perfect_shape_dependencies = [x_center, y_center, radius]
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            x_center, y_center, radius = @perfect_shape_dependencies = perfect_shape_dependencies
+            @perfect_shape = PerfectShape::Circle.new(center_x: x_center, center_y: y_center, radius: radius)
+          end
+          @perfect_shape
         end
       end
     end

data/lib/glimmer/libui/shape/line.rb

@@ -52,6 +52,15 @@ module Glimmer
           # start point
           !parent.is_a?(Figure) && end_x && end_y
         end
+        
+        def perfect_shape
+          perfect_shape_dependencies = [x, y, end_x, end_y]
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            x, y, end_x, end_y = @perfect_shape_dependencies = perfect_shape_dependencies
+            @perfect_shape = PerfectShape::Line.new(points: [[x, y], [end_x, end_y]])
+          end
+          @perfect_shape
+        end
       end
     end
   end

data/lib/glimmer/libui/shape/polybezier.rb

@@ -39,6 +39,18 @@ module Glimmer
           end
           super
         end
+        
+        def perfect_shape
+          perfect_shape_dependencies = PerfectShape::MultiPoint.normalize_point_array(point_array)
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            point_array = @perfect_shape_dependencies = perfect_shape_dependencies
+            path_shapes = [point_array.first]
+            bezier_shape_points = point_array.drop(1).each.with_index.to_a.group_by {|pair| pair.last/3}.values.map {|arr| arr.map(&:first)}
+            path_shapes += bezier_shape_points.map { |points| PerfectShape::CubicBezierCurve.new(points: points) }
+            @perfect_shape = PerfectShape::Path.new(closed: false, shapes: path_shapes)
+          end
+          @perfect_shape
+        end
       end
     end
   end

data/lib/glimmer/libui/shape/polygon.rb

@@ -40,6 +40,17 @@ module Glimmer
           end
           super
         end
+        
+        def perfect_shape
+          perfect_shape_dependencies = PerfectShape::MultiPoint.normalize_point_array(point_array)
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            point_array = @perfect_shape_dependencies = perfect_shape_dependencies
+            path_shapes = [point_array.first]
+            path_shapes += point_array.drop(1).map { |point| PerfectShape::Line.new(points: [point]) }
+            @perfect_shape = PerfectShape::Path.new(closed: true, shapes: path_shapes)
+          end
+          @perfect_shape
+        end
       end
     end
   end

data/lib/glimmer/libui/shape/polyline.rb

@@ -39,6 +39,17 @@ module Glimmer
           end
           super
         end
+        
+        def perfect_shape
+          perfect_shape_dependencies = PerfectShape::MultiPoint.normalize_point_array(point_array)
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            point_array = @perfect_shape_dependencies = perfect_shape_dependencies
+            path_shapes = [point_array.first]
+            path_shapes += point_array.drop(1).map { |point| PerfectShape::Line.new(points: [point]) }
+            @perfect_shape = PerfectShape::Path.new(closed: false, shapes: path_shapes)
+          end
+          @perfect_shape
+        end
       end
     end
   end

data/lib/glimmer/libui/shape/rectangle.rb

@@ -33,8 +33,13 @@ module Glimmer
           super
         end
         
-        def include?(x, y)
-          x.between?(self.x, self.x + width) && y.between?(self.y, self.y + height)
+        def perfect_shape
+          perfect_shape_dependencies = [x, y, width, height]
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            x, y, width, height = @perfect_shape_dependencies = perfect_shape_dependencies
+            @perfect_shape = PerfectShape::Rectangle.new(x: x, y: y, width: width, height: height)
+          end
+          @perfect_shape
         end
       end
     end

data/lib/glimmer/libui/shape/square.rb

@@ -33,8 +33,15 @@ module Glimmer
           super
         end
         
-        def include?(x, y)
-          x.between?(self.x, self.x + length) && y.between?(self.y, self.y + length)
+        # TODO look into refactoring/unifying code with Rectangle
+        
+        def perfect_shape
+          perfect_shape_dependencies = [x, y, length]
+          if perfect_shape_dependencies != @perfect_shape_dependencies
+            @perfect_shape_dependencies = perfect_shape_dependencies
+            @perfect_shape = PerfectShape::Square.new(x: @perfect_shape_dependencies[0], y: @perfect_shape_dependencies[1], length: @perfect_shape_dependencies[2])
+          end
+          @perfect_shape
         end
       end
     end

data/lib/glimmer/libui/shape.rb

@@ -145,6 +145,46 @@ module Glimmer
       end
       alias transform= transform
       alias set_transform transform
+    
+      # Returns if shape contains point on the inside when outline is false (default)
+      # or if point is on the outline when outline is true
+      # distance_tolerance is used when outline is true to enable a fuzz factor in
+      # determining if a point lies on the outline (e.g. makes it easier to select
+      # a shape by mouse)
+      def contain?(*point, outline: false, distance_tolerance: 0)
+        perfect_shape&.contain?(*point, outline: outline, distance_tolerance: distance_tolerance)
+      end
+      
+      # Returns if shape includes point on the inside when filled
+      # or if shape includes point on the outline when stroked
+      def include?(*point)
+        if fill.empty?
+          contain?(*point, outline: true, distance_tolerance: ((stroke[:thickness] || 1) - 1))
+        else
+          contain?(*point)
+        end
+      end
+      
+      # Returns bounding box Array consisting of
+      # [minx, miny, width, height]
+      def bounding_box
+        perfect_shape_bounding_box = perfect_shape&.bounding_box
+        return if perfect_shape_bounding_box.nil?
+        [
+          perfect_shape_bounding_box.x,
+          perfect_shape_bounding_box.y,
+          perfect_shape_bounding_box.width,
+          perfect_shape_bounding_box.height,
+        ]
+      end
+      
+      # Returns PerfectShape object matching this shape to enable
+      # executing computational geometry algorithms
+      #
+      # Subclasses must implement
+      def perfect_shape
+        # No Op
+      end
       
       def respond_to?(method_name, *args, &block)
         self.class.parameters.include?(method_name.to_s.sub(/=$/, '').sub(/^set_/, '').to_sym) or

data/lib/glimmer-dsl-libui.rb

@@ -23,6 +23,7 @@ $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 # External requires
 require 'glimmer'
+require 'perfect-shape'
 # require 'logging'
 # require 'puts_debuggerer' if ENV['pd'].to_s.downcase == 'true'
 # require 'super_module'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-libui
 version: !ruby/object:Gem::Version
-  version: 0.4.22
+  version: 0.5.3
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.5
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.5
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: perfect-shape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.13
+        version: 0.0.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.13
+        version: 0.0.14
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -205,12 +219,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.7.0
 description: Glimmer DSL for LibUI (Prerequisite-Free Ruby Desktop Development GUI
-  Library) - No need to pre-install any prerequisites. Just install the gem and have
-  platform-independent native GUI that just works! 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.
+  Library) - Winner of Fukuoka Ruby Award Competition 2022 Special Award - No need
+  to pre-install any prerequisites. Just install the gem and have platform-independent
+  native GUI that just works! 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.
 email: andy.am@gmail.com
 executables:
 - girb