glimmer-dsl-web 0.8.8 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db73018239b32a5d5ef65132760f1df53fe162e8199468b674d0a3e4fd675863
-  data.tar.gz: f188ededffff10a18faebbdf370967fed8d0ffc1b220289524d659e61b694c31
+  metadata.gz: b97d0d0e09800873120d29ac0948ec4080ea88a183a6b949633deeaafd141d31
+  data.tar.gz: 0fa0e8210d1411317b504b643b5874e966bb38c580f45a7b6b54f5e56e248450
 SHA512:
-  metadata.gz: 9f1bc0048487b56d1b58a6f4ccf784b3ab3ceb8c5cc97aad007f2ae1a1aec666e09a18d4261109cb12dab99bbae3aae2bd111dcba25670ae94db24569e473266
-  data.tar.gz: f3715134efe3b06bb2677e15939a23d097a9d825afd99d42275fa350c0097b9bd4bf6f7fb0ed64e64193e2e44151b50caa92ce995e127aab389997cff9445046
+  metadata.gz: c2883556cc96742480f175155f6ac7dfe38467b4421211b12233ab6c3b8012db9b45646f0c9b01d9cf1c9f066ea4c80333e2d239507d0d4bf870e8fdf730cae1
+  data.tar.gz: e71fb15e206fe173253016e74e5ea5e85e5e72765a5a63303f332b853dfcc3f52a3b4cdb6f5d87472147409f89cfb702ce88933ebf4686a225460bd5c166ba15

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.8.9
+
+- `Rails::ResourceService.index` supports `root` argument to be able to handle responses that include resources + metadata (e.g. pagination info), providing |response, resources, metadata| to response handler block.
+- `Glimmer::Util::UrlQueryStringBuilder` supports `param`, `params`, and `query` to build a URL query string
+- Fix issue in `Rails::ResourceService.index`, `Rails::ResourceService.show`, `Rails::ResourceService.destroy` with incorrectly passing in query params via payload instead of query string
+
 ## 0.8.8
 
 - `Glimmer::Util::UrlBuilder` supports `params` to set multiple params at once as a hash

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.8.8 (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.8.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!!!
@@ -1411,7 +1411,7 @@ Please follow these steps to setup.
 Install a Rails 7 gem:
 
 ```
-gem install rails -v7.0.8.8
+gem install rails -v7.0.8.9
 ```
 
 Start a new Rails 7 app:
@@ -1423,7 +1423,7 @@ rails new glimmer_app_server
 Add the following to `Gemfile`:
 
 ```
-gem 'glimmer-dsl-web', '~> 0.8.8'
+gem 'glimmer-dsl-web', '~> 0.8.9'
 ```
 
 Run:
@@ -1726,7 +1726,7 @@ the `Rails::ResourceService` class source code to find out what its API is. It c
 if Developers would rather not write the Backend by hand.
 
 `Rails::ResourceService` API:
-- `index(resource: nil, resource_class: nil, singular_resource_name: nil, plural_resource_name: nil, index_resource_url: nil, params: nil) { |response, resources| ... }`
+- `index(resource: nil, resource_class: nil, singular_resource_name: nil, plural_resource_name: nil, index_resource_url: nil, params: nil, root: nil) { |response, resources, metadata| ... }`
 - `show(resource: nil, resource_class: nil, resource_id: nil, singular_resource_name: nil, plural_resource_name: nil, show_resource_url: nil, params: nil) { |response, resource| ... }`
 - `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| ... }`
@@ -1735,6 +1735,7 @@ if Developers would rather not write the Backend by hand.
 `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.
+If you are making an `index` request that receives pagination `metadata`, make sure to specify the `root` argument as `true` (to determine root key by convention) or by specifying a custom `root` explicitly.
 
 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:
 
@@ -1776,7 +1777,7 @@ Note that there are alternative ways of invoking the `Rails::ResourceService.upd
 
 ### Glimmer::Util::UrlBuilder
 
-`Glimmer::Util::UrlBuilder` is a convenience class that facilitate building URLs (with protocol scheme, host, path, query params, and fragment)
+`Glimmer::Util::UrlBuilder` is a convenience class that facilitates building URLs (with protocol scheme, host, path, query params, and fragment)
 
 First, make sure to require the class file:
 ```ruby
@@ -1796,6 +1797,21 @@ Glimmer::Util::UrlBuilder.current.param('year', '2036').to_url
 # => 'http://www.google.com/results?q=sports&year=2036'
 ```
 
+### Glimmer::Util::UrlQueryStringBuilder
+
+`Glimmer::Util::UrlQueryStringBuilder` is a convenience class that facilitates building URL query strings
+
+First, make sure to require the class file:
+```ruby
+require 'glimmer/util/url_builder'
+```
+
+Usage:
+```ruby
+subject.with_question_mark.param('q', 'sports').param('year', '2040').to_s
+# => '?q=sports&year=2040'
+```
+
 ## Supported Glimmer DSL Keywords
 
 [All HTML elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element), following the Ruby method name standard of lowercase and underscored names.

data/VERSION

@@ -1 +1 @@
-0.8.8
+0.8.9

data/glimmer-dsl-web.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-dsl-web 0.8.8 ruby lib
+# stub: glimmer-dsl-web 0.8.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-web".freeze
-  s.version = "0.8.8".freeze
+  s.version = "0.8.9".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -90,6 +90,7 @@ Gem::Specification.new do |s|
     "lib/glimmer/helpers/glimmer_helper.rb",
     "lib/glimmer/util/proc_tracker.rb",
     "lib/glimmer/util/url_builder.rb",
+    "lib/glimmer/util/url_query_string_builder.rb",
     "lib/glimmer/web.rb",
     "lib/glimmer/web/component.rb",
     "lib/glimmer/web/component/component_style_container.rb",

data/lib/glimmer/util/url_builder.rb

@@ -22,6 +22,8 @@
 # TODO consider extracting this class into its own Ruby gem
 require 'delegate'
 
+require 'glimmer/util/url_query_string_builder'
+
 module Glimmer
   module Util
     class UrlBuilder
@@ -113,9 +115,7 @@ module Glimmer
       alias build to_url
       
       def compute_query
-        computed_query = @params.reject { |name, value| value.nil? || value.to_s.empty? }.map { |name, value| "#{name}=#{value}" }.join('&')
-        computed_query = "?#{computed_query}" unless computed_query.empty?
-        computed_query
+        UrlQueryStringBuilder.new.with_prefix.params(@params).to_s
       end
     end
   end

data/lib/glimmer/util/url_query_string_builder.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2023-2026 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.
+
+# TODO consider extracting this class into its own Ruby gem
+require 'delegate'
+
+module Glimmer
+  module Util
+    class UrlQueryStringBuilder
+      class << self
+        def current
+          new.query($$.document.location.search) if RUBY_ENGINE == 'opal'
+        end
+      end
+    
+      def initialize
+        @params = {}
+      end
+      
+      def with_question_mark
+        @with_question_mark = true
+        self
+      end
+      alias with_prefix with_question_mark
+    
+      def param(name, value)
+        @params[name.to_s] = value
+        self
+      end
+      
+      def params(params_hash)
+        @params = @params.merge(params_hash)
+        self
+      end
+      
+      def query(value)
+        return self if value.nil?
+        
+        value = value.sub('?', '') if value.start_with?('?')
+        value.split('&').each do |param_pair|
+          name, value = param_pair.split('=')
+          @params[name.to_s] = value
+        end
+        self
+      end
+      
+      def to_query_string
+        computed_query = @params.reject { |name, value| value.nil? || value.to_s.empty? }.map { |name, value| "#{name}=#{value}" }.join('&')
+        computed_query = "?#{computed_query}" if @with_question_mark && !computed_query.empty?
+        computed_query
+      end
+      alias to_s to_query_string
+      alias build to_query_string
+    end
+  end
+end

data/lib/rails/resource_service.rb

@@ -1,4 +1,5 @@
 require 'facets/string/underscore'
+require 'glimmer/util/url_builder'
 
 module Rails
   # ResourceService supports index/show/create/update/destroy REST API calls for any Rails resources
@@ -8,19 +9,27 @@ module Rails
     TIMESTAMP_ATTRIBUTES = ['created_at', 'updated_at']
     
     class << self
-      def index(resource: nil, resource_class: nil, singular_resource_name: nil, plural_resource_name: nil, index_resource_url: nil, params: nil, &response_handler)
+      def index(resource: nil, resource_class: nil, singular_resource_name: nil, plural_resource_name: nil, index_resource_url: nil, params: nil, root: nil, &response_handler)
         resource_class ||= resource&.class
         singular_resource_name ||= singular_resource_name_for_resource_class(resource_class)
         plural_resource_name ||= "#{singular_resource_name}s"
         index_resource_url ||= "/#{plural_resource_name}.json"
-        HTTP.get(index_resource_url, payload: index_show_destroy_resource_params(params: params.to_h)) do |response|
+        root = plural_resource_name if root == true
+        index_resource_url = Glimmer::Util::UrlBuilder.new.url(index_resource_url).params(index_show_destroy_resource_params(params: params.to_h)).to_s
+        HTTP.get(index_resource_url) do |response|
           if response.ok? && !resource_class.nil?
             resource_response_objects = Native(response.body)
-            # TODO consider having index not make the assumpion that resource_response_objects is an array in case it isn't
-            # when including pagination information (maybe test if it is an array first)
-            resources = resource_response_objects.map { |resource_response_object| build_resource_from_response_object(resource_class:, resource_response_object:) }
+            metadata = {}
+            if root
+              resources = resource_response_objects[root].map { |resource_response_object| build_resource_from_response_object(resource_class:, resource_response_object:) }
+              populate_metadata_from_native_response(metadata:, native_response: resource_response_objects, root:)
+            else
+              resources = resource_response_objects.map { |resource_response_object| build_resource_from_response_object(resource_class:, resource_response_object:) }
+            end
           end
-          response_handler.call(response, resources)
+          puts 'metadata'
+          puts metadata
+          response_handler.call(response, resources, metadata) # TODO support 3rd argument for metadata
         end
       end
       
@@ -30,7 +39,8 @@ module Rails
         singular_resource_name ||= singular_resource_name_for_resource_class(resource_class)
         plural_resource_name ||= "#{singular_resource_name}s"
         show_resource_url ||= "/#{plural_resource_name}/#{resource_id}.json"
-        HTTP.get(show_resource_url, payload: index_show_destroy_resource_params(params: params.to_h)) do |response|
+        show_resource_url = Glimmer::Util::UrlBuilder.new.url(show_resource_url).params(index_show_destroy_resource_params(params: params.to_h)).to_s
+        HTTP.get(show_resource_url) 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:)
@@ -82,7 +92,8 @@ module Rails
         singular_resource_name ||= singular_resource_name_for_resource_class(resource_class)
         plural_resource_name ||= "#{singular_resource_name}s"
         destroy_resource_url ||= "/#{plural_resource_name}/#{resource_id}.json"
-        HTTP.delete(destroy_resource_url, payload: index_show_destroy_resource_params(params: params.to_h), &response_handler)
+        destroy_resource_url = Glimmer::Util::UrlBuilder.new.url(destroy_resource_url).params(index_show_destroy_resource_params(params: params.to_h)).to_s
+        HTTP.delete(destroy_resource_url, &response_handler)
       end
       
       def index_show_destroy_resource_params(params: nil)
@@ -114,6 +125,23 @@ module Rails
         resource
       end
       
+      def populate_metadata_from_native_response(metadata:, native_response:, root:)
+        native_response.each do |attribute, value|
+          next if attribute == root
+          begin
+            value.class
+            metadata[attribute] = value
+          rescue Exception => e
+            if `typeof #{value}` == 'object'
+              metadata[attribute] = {}
+              populate_metadata_from_native_response(metadata: metadata[attribute], native_response: Native(value), root: nil)
+            else
+              metadata[attribute] = value
+            end
+          end
+        end
+      end
+      
       # TODO consider offering generic Rails::ResourceService.get, Rails::ResourceService.put, Rails::ResourceService.post, Rails::ResourceService.patch, Rails::ResourceService.delete methods
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-web
 version: !ruby/object:Gem::Version
-  version: 0.8.8
+  version: 0.8.9
 platform: ruby
 authors:
 - Andy Maleh
@@ -357,6 +357,7 @@ files:
 - lib/glimmer/helpers/glimmer_helper.rb
 - lib/glimmer/util/proc_tracker.rb
 - lib/glimmer/util/url_builder.rb
+- lib/glimmer/util/url_query_string_builder.rb
 - lib/glimmer/web.rb
 - lib/glimmer/web/component.rb
 - lib/glimmer/web/component/component_style_container.rb