glimmer-dsl-web 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c9bd6a7f085751de551a8eada611f25b6462c32f31019ebc31e296a98a7dbe7
-  data.tar.gz: cde631c346fddf15d48c52b85643f4f436761b059ccca0a8909cca56fdc7676e
+  metadata.gz: 84438bf8ca94283ebca35c684038f1ba326c9301782508bdf07b7c4e23ecb391
+  data.tar.gz: f7246af497c04e9c509457444ac9c17c8617aa881fca82adb4561473f1d18044
 SHA512:
-  metadata.gz: 036cbe077a6378e6fb18cf10060074b4a071b20f4293960ded842458069c4dfb5bc041eb909f0b7b3cfbb809f73a41605f2b97f101b338f1ee616e52f00445c3
-  data.tar.gz: 4441339edfaf2724324e4aa30c19b2afc7e0e9d673add6130882e1c3220e278a1be1d21be126bf9b8aaa7568c62a0c59ecbce9ca2d1103183263ae17deb2d15e
+  metadata.gz: b47263b248b7952d58d9fe8fb03f0614f8c917e025310839f7ab311f33fc31e292fe257ffec8f1c487843eab7814253829c00579ea2132385b4064b75e801890
+  data.tar.gz: 6be5e5bab5900605d78977e703d27ac95dac303fa3855d52bd4f7dd4a1e8c8f090d49b95c57a5abe3155dde9adece9a028cfa7afc3872b9fcead2ce1a417676d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 0.1.1
+
+- Upgrade to opal-jquery 0.5.1 (adds `# backtick_javascript: true` where needed to satisfy new Opal requirement)
+- Upgrade to opal-async 1.4.1 (adds `# backtick_javascript: true` where needed to satisfy new Opal requirement)
+- Update setup instructions to NOT disable Hotwire files, to allow running Hotwire/Turbo side by side with Glimmer DSL for Web (but not in the same pages)
+
 ## 0.1.0
 
 - Update rendering system to render HTML elements immediately instead of waiting for complete components to be rendered all at once.

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.1.0 (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.1.1 (Beta)
 ## Ruby in the Browser Web GUI Frontend Library
 [![Gem Version](https://badge.fury.io/rb/glimmer-dsl-web.svg)](http://badge.fury.io/rb/glimmer-dsl-web)
 [![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)
@@ -1146,7 +1146,7 @@ rails new glimmer_app_server
 Add the following to `Gemfile`:
 
 ```
-gem 'glimmer-dsl-web', '~> 0.1.0'
+gem 'glimmer-dsl-web', '~> 0.1.1'
 ```
 
 Run:
@@ -1191,26 +1191,28 @@ rails db:migrate
 Add the following to `config/routes.rb` inside the `Rails.application.routes.draw` block:
 
 ```ruby
-mount Glimmer::Engine => "/glimmer" # add on top
 root to: 'welcomes#index'
 ```
 
 Clear the file `app/views/welcomes/index.html.erb` completely from all content.
 
-Delete `app/javascript` directory
+Rename `app/assets/javascript/application.js.rb` file to `app/assets/javascript/opal_application.rb`.
 
 Rename `app/assets/javascript` directory to `app/assets/opal`.
 
-Add the following lines to `app/assets/config/manifest.js` (and delete their `javascript` equivalents):
+Edit `app/assets/config/manifest.js` and update `//= link_directory ../javascript .js` to `//= link_directory ../opal .js`:
 
 ```js
-//= link_tree ../../opal .js
 //= link_directory ../opal .js
 ```
 
-Rename `app/assets/opal/application.js.rb` to `app/assets/opal/application.rb`.
+Edit `app/views/layouts/application.html.erb` and update `<%= javascript_include_tag "application", "data-turbolinks-track": "reload" %>` to `<%= javascript_include_tag "opal_application", "data-turbolinks-track": "reload" %>`:
 
-Edit and replace `app/assets/opal/application.rb` content with code below (optionally including a require statement for one of the [samples](#samples) below):
+```erb
+<%= javascript_include_tag "opal_application", "data-turbolinks-track": "reload" %>
+```
+
+Edit and replace `app/assets/opal/opal_application.rb` content with code below (optionally including a require statement for one of the [samples](#samples) below):
 
 ```ruby
 require 'glimmer-dsl-web' # brings opal and other dependencies automatically
@@ -1317,6 +1319,7 @@ That produces:
 </div>
 ...
 ```
+
 You may insert a Glimmer component anywhere into a Rails View using `glimmer_component(component_path, *args)` Rails helper. Add `include GlimmerHelper` to `ApplicationHelper` or another Rails helper, and use `<%= glimmer_component("path/to/component", *args) %>` in Views.
 
 To use `glimmer_component`, edit `app/helpers/application_helper.rb` in your Rails application, add `require 'glimmer/helpers/glimmer_helper'` on top and `include GlimmerHelper` inside `module`.
@@ -1333,6 +1336,8 @@ module ApplicationHelper
 end
 ```
 
+Note that Turbo is disabled on Glimmer elements/components. You can still use Turbo/Hotwire side by side with Glimmer DSL for Web by using one of the two technologies in every page. But, mixing them in the same pages is not recommended at the moment, so any pages loaded with Glimmer DSL for Web must be loaded without Turbo (e.g. by putting "data-turbo"="false" on anchor "a" tag links to Glimmer pages).
+
 If you run into any issues in setup, refer to the [Sample Glimmer DSL for Web Rails 7 App](https://github.com/AndyObtiva/sample-glimmer-dsl-web-rails7-app) project (in case I forgot to include some setup steps by mistake).
 
 Otherwise, if you still cannot setup successfully (even with the help of the sample project, or if the sample project stops working), please do not hesitate to report an [Issue request](https://github.com/AndyObtiva/glimmer-dsl-web/issues) or fix and submit a [Pull Request](https://github.com/AndyObtiva/glimmer-dsl-web/pulls).
@@ -1362,7 +1367,7 @@ Disable the `webpacker` gem line in `Gemfile`:
 Add the following to `Gemfile`:
 
 ```ruby
-gem 'glimmer-dsl-web', '~> 0.1.0'
+gem 'glimmer-dsl-web', '~> 0.1.1'
 ```
 
 Run:
@@ -1407,10 +1412,8 @@ rails db:migrate
 Add the following to `config/routes.rb` inside the `Rails.application.routes.draw` block:
 
 ```ruby
-mount Glimmer::Engine => "/glimmer" # add on top
 root to: 'welcomes#index'
 ```
-```
 
 Also, delete the following line:
 
@@ -1420,18 +1423,23 @@ Also, delete the following line:
 
 Clear the file `app/views/welcomes/index.html.erb` completely from all content.
 
+Rename `app/assets/javascript/application.js.rb` file to `app/assets/javascript/opal_application.rb`.
+
 Rename `app/assets/javascript` directory to `app/assets/opal`.
 
-Add the following lines to `app/assets/config/manifest.js` (and delete their `javascript` equivalents):
+Edit `app/assets/config/manifest.js` and update `//= link_directory ../javascript .js` to `//= link_directory ../opal .js`:
 
 ```js
-//= link_tree ../../opal .js
 //= link_directory ../opal .js
 ```
 
-Rename `app/assets/opal/application.js.rb` to `app/assets/opal/application.rb`.
+Edit `app/views/layouts/application.html.erb` and update `<%= javascript_include_tag "application", "data-turbolinks-track": "reload" %>` to `<%= javascript_include_tag "opal_application", "data-turbolinks-track": "reload" %>`:
 
-Edit and replace `app/assets/opal/application.rb` content with code below (optionally including a require statement for one of the [samples](#samples) below inside a `Document.ready? do; end` block):
+```erb
+<%= javascript_include_tag "opal_application", "data-turbolinks-track": "reload" %>
+```
+
+Edit and replace `app/assets/opal/opal_application.rb` content with code below (optionally including a require statement for one of the [samples](#samples) below):
 
 ```ruby
 require 'glimmer-dsl-web' # brings opal and other dependencies automatically
@@ -1508,6 +1516,8 @@ module ApplicationHelper
 end
 ```
 
+Note that Turbo is disabled on Glimmer elements/components. You can still use Turbo/Hotwire side by side with Glimmer DSL for Web by using one of the two technologies in every page. But, mixing them in the same pages is not recommended at the moment, so any pages loaded with Glimmer DSL for Web must be loaded without Turbo (e.g. by putting "data-turbo"="false" on anchor "a" tag links to Glimmer pages).
+
 **NOT RELEASED OR SUPPORTED YET**
 
 If you run into any issues in setup, refer to the [Sample Glimmer DSL for Web Rails 6 App](https://github.com/AndyObtiva/sample-glimmer-dsl-web-rails6-app) project (in case I forgot to include some setup steps by mistake).

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

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.1.0 ruby lib
+# stub: glimmer-dsl-web 0.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-dsl-web".freeze
-  s.version = "0.1.0".freeze
+  s.version = "0.1.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -79,8 +79,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<glimmer-dsl-css>.freeze, ["~> 1.2.2".freeze])
   s.add_runtime_dependency(%q<opal>.freeze, ["= 1.8.2".freeze])
   s.add_runtime_dependency(%q<opal-rails>.freeze, ["= 2.0.3".freeze])
-  s.add_runtime_dependency(%q<opal-async>.freeze, ["~> 1.4.0".freeze])
-  s.add_runtime_dependency(%q<opal-jquery>.freeze, ["~> 0.5.0".freeze])
+  s.add_runtime_dependency(%q<opal-async>.freeze, ["~> 1.4.1".freeze])
+  s.add_runtime_dependency(%q<opal-jquery>.freeze, ["~> 0.5.1".freeze])
   s.add_runtime_dependency(%q<to_collection>.freeze, [">= 2.0.1".freeze, "< 3.0.0".freeze])
   s.add_development_dependency(%q<puts_debuggerer>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rake>.freeze, [">= 10.1.0".freeze, "< 14.0.0".freeze])

data/lib/glimmer/helpers/glimmer_helper.rb

@@ -7,24 +7,27 @@ module GlimmerHelper
   end
   
   def glimmer_component(component_asset_path, *component_args)
-    component_file = component_asset_path.split('/').last
-    component_class_name = component_file.classify
+    component_file = component_asset_path.split('/').last # TODO support namespaced components
+    component_class_name = component_file.classify # TODO support namespaced components
     next_id_number = GlimmerHelper.next_id_number
     component_id = "glimmer_component_#{next_id_number}"
     component_script_container_id = "glimmer_component_script_container_#{next_id_number}"
     component_args_json = JSON.dump(component_args)
-    opal_script = <<~Opal
+    opal_script = <<~OPAL
       require 'glimmer-dsl-web'
       component_args_json = '#{component_args_json}'
       component_args = JSON.parse(component_args_json)
       component_args << {} if !component_args.last.is_a?(Hash)
       component_args.last[:parent] = "##{component_id}"
       #{component_class_name}.render(*component_args)
-    Opal
-    content_tag(:div, id: component_script_container_id, class: ['glimmer_component_script_container', "#{component_file}_script_container"]) do
+    OPAL
+    js_script = <<~JAVASCRIPT
+      Opal.eval(`#{opal_script}`)
+    JAVASCRIPT
+    content_tag(:div, id: component_script_container_id, class: ['glimmer_component_script_container', "#{component_file}_script_container"], 'data-turbo': 'false') do
       content_tag(:div, '', id: component_id, class: ['glimmer_component', component_file]) +
       javascript_include_tag(component_asset_path, "data-turbolinks-track": "reload") +
-        content_tag(:script, raw(opal_script), type: 'text/ruby')
+      content_tag(:script, raw(js_script), type: 'application/javascript', "data-turbo-eval": "false")
     end
   end
 end

data/lib/glimmer/web/element_proxy.rb

@@ -253,7 +253,6 @@ module Glimmer
         brand_new = @dom.nil? || old_element.empty? || !options[:parent].to_s.empty? || brand_new
         build_dom(layout: !custom_parent_dom_element) # TODO handle custom parent layout by passing parent instead of parent dom element
         if brand_new
-          # TODO make a method attach to allow subclasses to override if needed
           attach(the_parent_dom_element)
         else
           reattach(old_element)
@@ -336,6 +335,7 @@ module Glimmer
         end
         html_options[:class] ||= ''
         html_options[:class] = "#{html_options[:class]} #{body_class}".strip
+        html_options['data-turbo'] = 'false' if parent.nil?
         html_options
       end
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-dsl-web
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andy Maleh
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: opal-jquery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: to_collection
   requirement: !ruby/object:Gem::Requirement