glimmer-dsl-web 0.6.7 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a4d424a8d5ab44e419d2d859f2b0338bb676e84ab37756ef4721eee3cd70ae4
-  data.tar.gz: e19ad5b31ccc3a47838fa7a2e0ab0b30367fd342a4a9706d478c3702c8c03175
+  metadata.gz: c255e190aed253bf44917907d1fa39c17b71f795054dedb33ca6912b9c798562
+  data.tar.gz: 7448c70a081144086a1f0c9545c3e3f4dc8e17e0e03df4c1126f1a1b054e605d
 SHA512:
-  metadata.gz: eaa0f67301b67ba15a624c1a13f65f2bad31632a35940e9f767a70708919bec49ef740fceae499c3b49ba13c4e491cb575e6479ea4b2c276625bdaad71d677b8
-  data.tar.gz: 1d0f911b8748b454580c16eb56d28d8f1adc763a93559d42cde84037f2a224264ec813306cf28c28cf71ea698a635120e5f343b7202e3d025a1a9ef16a052658
+  metadata.gz: f39baaa90a81e981b57c9012ba6c2e07de039f340427075e5b08f988ac068e1dc6ccebe0213c23d4c7c86269b1bc80598065ac6f6478f8fa425e25304b1e6abd
+  data.tar.gz: 443bc0a99fed33be65e134077a26dfa1b19334b5d7a77ade6b0f7132f6efa256c1efc84571f97452c07d71077d8badbef6c7f0de2cad1add0a8e3d3342aad162

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Change Log
 
+## 0.6.9
+
+- Support Component Option Listeners (nest a `on_some_attribute_update { ... }` listener inside the content block of a consumed Glimmer Web Component for any attribute/option on the Component, like `on_full_name_update` listener for `full_name` attribute update)
+
+## 0.6.8
+
+- `Rails::ResourceService` provides `errors` as 3rd argument of `response_handler` block in erroneous web requests.
+- Refactor/simplify code of Contact Manager sample with `Rails::ResourceService` enhancements to provide `errors` as `response_handler` 3rd argument
+
 ## 0.6.7
 
-- `Rails::ResourceService` builds resource models using `resource_class` and provides `resources`/`resource` as 2nd argument of `response_handler` blocks in index/show/create/update calls.
+- `Rails::ResourceService` builds resource models using `resource_class` and provides `resources`/`resource` as 2nd argument of `response_handler` block in index/show/create/update calls.
 - Refactor/simplify code of Contact Manager sample with `Rails::ResourceService` enhancements to provide resource models in `response_handler` 2nd argument
 
 ## 0.6.6

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 Web 0.6.7 (Beta)
+# [<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 Web 0.6.9 (Beta)
 ## Ruby-in-the-Browser Web Frontend Framework
 ### The "Rails" of Frontend Frameworks!!! ([Fukuoka Award Winning](https://andymaleh.blogspot.com/2025/01/glimmer-dsl-for-web-wins-in-fukuoka.html))
 #### Finally, Ruby Developer Productivity, Happiness, and Fun in the Frontend!!!
@@ -1408,7 +1408,7 @@ rails new glimmer_app_server
 Add the following to `Gemfile`:
 
 ```
-gem 'glimmer-dsl-web', '~> 0.6.7'
+gem 'glimmer-dsl-web', '~> 0.6.9'
 ```
 
 Run:
@@ -1703,29 +1703,54 @@ you can use [Rails::ResourceService](/lib/rails/resource_service.rb) (`require '
 the `Rails::ResourceService` class source code to find out what its API is. It can work with a basic Rails Scaffold of a Resource
 if Developers would rather not write the Backend by hand.
 
-Example from [ContactPresenter](https://github.com/AndyObtiva/sample-glimmer-dsl-web-rails7-app/blob/master/app/assets/opal/contact_manager/presenters/contact_presenter.rb) in the [Contact Manager](#contact-manager) sample:
+`Rails::ResourceService` API:
+- `index(resource: nil, resource_class: nil, singular_resource_name: nil, plural_resource_name: nil, index_resource_url: nil, params: nil) { |response| ... }`
+- `show(resource: nil, resource_class: nil, resource_id: nil, singular_resource_name: nil, plural_resource_name: nil, show_resource_url: nil, params: nil) { |response| ... }`
+- `create(resource: nil, resource_class: nil, resource_attributes: nil, singular_resource_name: nil, plural_resource_name: nil, create_resource_url: nil, params: nil) { |response, created_resource, errors| ... }`
+- `update(resource: nil, resource_class: nil, resource_id: nil, resource_attributes: nil, singular_resource_name: nil, plural_resource_name: nil, update_resource_url: nil, params: nil) { |response, updated_resource, errors| ... }`
+- `destroy(resource: nil, resource_class: nil, resource_id: nil, singular_resource_name: nil, plural_resource_name: nil, destroy_resource_url: nil, params: nil) { |response| ... }`
 
-`form_contact` is an instance of the [Contact](https://github.com/AndyObtiva/sample-glimmer-dsl-web-rails7-app/blob/master/app/assets/opal/contact_manager/models/contact.rb) class.
+`Rails::ResourceService` follows the 'Convention over Configuration' Rails principle as it auto-derives the URL to call based on the `resource` class and data.
+`resource` can be a Ruby class with attribute method declarations or `attr_accessor` declarations, or a Ruby `Struct` class.
+`Rails::ResourceService` is flexible enough to work with all options.
+
+Examples from [ContactPresenter](https://github.com/AndyObtiva/sample-glimmer-dsl-web-rails7-app/blob/master/app/assets/opal/contact_manager/presenters/contact_presenter.rb) in the [Contact Manager](#contact-manager) sample:
+
+(note: `form_contact` is an instance of the [Contact](https://github.com/AndyObtiva/sample-glimmer-dsl-web-rails7-app/blob/master/app/assets/opal/contact_manager/models/contact.rb) class)
 
 ```ruby
-    Rails::ResourceService.update(resource: form_contact) do |response, updated_contact|
+  def add_contact
+    Rails::ResourceService.create(resource: form_contact) do |response, created_contact, errors|
+      if response.ok?
+        contacts << created_contact
+        form_contact.reset
+        form_contact.errors = nil
+      else
+        form_contact.errors = errors
+      end
+    end
+  end
+  
+  def update_contact
+    Rails::ResourceService.update(resource: form_contact) do |response, updated_contact, errors|
       if response.ok?
         contacts[edit_index].load_with(updated_contact)
         self.edit_index = nil
         form_contact.reset
         form_contact.errors = nil
       else
-        form_contact.errors = JSON.parse(response.body)
+        form_contact.errors = errors
       end
     end
+  end
 ```
 
 Note that there are alternative ways of invoking the `Rails::ResourceService.update` call:
-- `Rails::ResourceService.update(resource: form_contact) { |response| ... }`
-- `Rails::ResourceService.update(resource_class: Contact, resource_id: form_contact.id, resource_attributes: {first_name: form_contact.first_name, ...}) { |response| ... }`
-- `Rails::ResourceService.update(singular_resource_name: 'contact', resource_id: form_contact.id, resource_attributes: {first_name: form_contact.first_name, ...}) { |response| ... }`
-- `Rails::ResourceService.update(update_resource_url: "/contacts/#{form_contact.id}.json", resource_attributes: {first_name: form_contact.first_name, ...}) { |response| ... }`
-- `Rails::ResourceService.update(update_resource_url: "/contacts/#{form_contact.id}.json", params: {contact: {first_name: form_contact.first_name, ...}}) { |response| ... }`
+- `Rails::ResourceService.update(resource: form_contact) { |response, resource, errors| ... }`
+- `Rails::ResourceService.update(resource_class: Contact, resource_id: form_contact.id, resource_attributes: {first_name: form_contact.first_name, ...}) { |response, resource, errors| ... }`
+- `Rails::ResourceService.update(singular_resource_name: 'contact', resource_id: form_contact.id, resource_attributes: {first_name: form_contact.first_name, ...}) { |response, resource, errors| ... }`
+- `Rails::ResourceService.update(update_resource_url: "/contacts/#{form_contact.id}.json", resource_attributes: {first_name: form_contact.first_name, ...}) { |response, resource, errors| ... }`
+- `Rails::ResourceService.update(update_resource_url: "/contacts/#{form_contact.id}.json", params: {contact: {first_name: form_contact.first_name, ...}}) { |response, resource, errors| ... }`
 
 ## Supported Glimmer DSL Keywords
 

data/VERSION

@@ -1 +1 @@
-0.6.7
+0.6.9

data/glimmer-dsl-web.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-web 0.6.7 ruby lib
+# stub: glimmer-dsl-web 0.6.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-web".freeze
-  s.version = "0.6.7"
+  s.version = "0.6.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2025-02-18"
+  s.date = "2025-02-23"
   s.description = "Glimmer DSL for Web (Ruby in the Browser Web Frontend Framework) enables building Web Frontends using Ruby in the Browser, as per Matz's recommendation in his RubyConf 2022 keynote speech to replace JavaScript with Ruby. It aims at providing the simplest, most intuitive, most straight-forward, and most productive frontend framework in existence. The framework follows the Ruby way (with DSLs and TIMTOWTDI) and the Rails way (Convention over Configuration) in building Isomorphic Ruby on Rails Applications. It provides a Ruby HTML DSL, which uniquely enables writing both structure code and logic code in one language. It supports both Unidirectional (One-Way) Data-Binding (using <=) and Bidirectional (Two-Way) Data-Binding (using <=>). Dynamic rendering (and re-rendering) of HTML content is also supported via Content Data-Binding. Modular design is supported with Glimmer Web Components, Component Slots, and Component Custom Event Listeners. And, a Ruby CSS DSL is supported with the included Glimmer DSL for CSS. Many samples are demonstrated in the Rails sample app (there is a very minimal Standalone [No Rails] sample app too). You can finally live in pure Rubyland on the Web in both the frontend and backend with Glimmer DSL for Web! This gem relies on Opal Ruby.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [

data/lib/glimmer/web/component.rb

@@ -278,6 +278,8 @@ module Glimmer
       end
       # <- end of class methods
       
+      REGEX_LISTENER_OPTION_UPDATE = /^on_(.)+_update$/
+      
       attr_reader :markup_root, :parent, :args, :options, :style_block, :component_style, :slot_elements, :events, :default_slot
       alias parent_proxy parent
 
@@ -290,7 +292,6 @@ module Glimmer
           options = args
           args = []
         end
-        options ||= {}
         @slot_elements = {}
         @args = args
         options ||= {}
@@ -342,8 +343,8 @@ module Glimmer
       def can_handle_observation_request?(observation_request)
         observation_request = observation_request.to_s
         result = false
-        if observation_request.start_with?('on_update_') # TODO change to on_someprop_update & document this feature
-          property = observation_request.sub(/^on_update_/, '')
+        if observation_request.match(REGEX_LISTENER_OPTION_UPDATE)
+          property = observation_request.sub(/^on_/, '').sub(/_update$/, '')
           result = can_add_observer?(property)
         elsif observation_request.start_with?('on_')
           event = observation_request.sub(/^on_/, '')
@@ -354,8 +355,8 @@ module Glimmer
 
       def handle_observation_request(observation_request, block)
         observation_request = observation_request.to_s
-        if observation_request.start_with?('on_update_')
-          property = observation_request.sub(/^on_update_/, '') # TODO look into eliminating duplication from above
+        if observation_request.match(REGEX_LISTENER_OPTION_UPDATE)
+          property = observation_request.sub(/^on_/, '').sub(/_update$/, '')
           add_observer(DataBinding::Observer.proc(&block), property) if can_add_observer?(property)
         elsif observation_request.start_with?('on_')
           event = observation_request.sub(/^on_/, '') # TODO look into eliminating duplication from above
@@ -371,7 +372,14 @@ module Glimmer
       end
 
       def can_add_attribute_observer?(attribute_name)
-        has_instance_method?(attribute_name) || has_instance_method?("#{attribute_name}?")
+        has_option?(attribute_name) ||
+          has_instance_method?(attribute_name) ||
+          has_instance_method?("#{attribute_name}?")
+      end
+      
+      def has_option?(option_name)
+        normalized_option_name = option_name.to_s.to_sym
+        options.keys.include?(normalized_option_name)
       end
 
       def can_add_custom_event_listener?(event)
@@ -438,9 +446,10 @@ module Glimmer
 
       # This method ensures it has an instance method not coming from Glimmer DSL
       def has_instance_method?(method_name)
-        respond_to?(method_name) and
-          !markup_root&.respond_to?(method_name) and
-          !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') and
+        # TODO this carryover code from other Glimmer DSLs doesn't seem to be needed in this DSL (and probably doesn't work in Opal anyways)
+        respond_to?(method_name) &&
+          !markup_root&.respond_to?(method_name) &&
+          !method(method_name)&.source_location&.first&.include?('glimmer/dsl/engine.rb') &&
           !method(method_name)&.source_location&.first&.include?('glimmer/web/element_proxy.rb')
       end
 

data/lib/rails/resource_service.rb

@@ -41,11 +41,15 @@ module Rails
         plural_resource_name ||= "#{singular_resource_name}s"
         create_resource_url ||= "/#{plural_resource_name}.json"
         HTTP.post(create_resource_url, payload: create_update_resource_params(resource:, resource_class:, resource_attributes:, singular_resource_name:, params: params.to_h)) do |response|
-          if response.ok? && !resource_class.nil?
-            resource_response_object = Native(response.body)
-            resource = build_resource_from_response_object(resource_class:, resource_response_object:)
+          if response.ok?
+            if !resource_class.nil?
+              resource_response_object = Native(response.body)
+              resource = build_resource_from_response_object(resource_class:, resource_response_object:)
+            end
+          else
+            errors = JSON.parse(response.body)
           end
-          response_handler.call(response, resource)
+          response_handler.call(response, resource, errors)
         end
       end
       
@@ -56,11 +60,15 @@ module Rails
         plural_resource_name ||= "#{singular_resource_name}s"
         update_resource_url ||= "/#{plural_resource_name}/#{resource_id}.json"
         HTTP.patch(update_resource_url, payload: create_update_resource_params(resource:, resource_class:, resource_attributes:, singular_resource_name:, params: params.to_h)) do |response|
-          if response.ok? && !resource_class.nil?
-            resource_response_object = Native(response.body)
-            resource = build_resource_from_response_object(resource_class:, resource_response_object:)
+          if response.ok?
+            if !resource_class.nil?
+              resource_response_object = Native(response.body)
+              resource = build_resource_from_response_object(resource_class:, resource_response_object:)
+            end
+          else
+            errors = JSON.parse(response.body)
           end
-          response_handler.call(response, resource)
+          response_handler.call(response, resource, errors)
         end
       end
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-web
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.9
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-18 00:00:00.000000000 Z
+date: 2025-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer