custom_elements-rails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22d257cc2e8c052814180e03810ed19525ffaae2989826a5660dc0306dfc3df2
-  data.tar.gz: 2661b7ce42c1a797e0d52fd8deb91922e6af03b8045a31656ec4c59c2f392dc5
+  metadata.gz: 00a594ba7a841b984e65721f217af0248ba150fe032038db7d6501606900fc14
+  data.tar.gz: 9db69aa3b4a6f8e621631dc22dad1640af90aafc2b6ec2fbc090089cb28d69e4
 SHA512:
-  metadata.gz: c92ca66bdfd4c7a9bc5eb90bb383506716bf0efbe1ec977371695a45362578e15292bf22321381f04ba48ea4cb49699fa797b64ecf0d16f19f2d4c53316a5876
-  data.tar.gz: fa02fa675a3a96445063e0eb5a825c942c6e85658c587d6b70ca2ef6858c3e5eb892c11114715e42aebdee0d5418a46821054b01c2fa09e5ff827b76fdf9e77a
+  metadata.gz: 47d8050c6e7e08715d63169ed4040f3d422652ba69140d84d2d269941184d0270281115b77f5f1413e4de62b7ba1efffcc0f78da3004fa95095c1a83e4efd907
+  data.tar.gz: 6b52ed941852c7543bbf0f9f82d5f6631bf06ea956248ac828d8660511894a7e189a9f0a459439053f7fd461d228c097db6d5ad16481c50fca7ea59013d0053f

data/README.md

@@ -1,10 +1,11 @@
-# Custom Elements with Rails
+# Custom Elements Rails
 
-This gem provides a small helper and installation scripts to use custom elements in conjunction with `importmap-rails`.
+[![Tests](https://github.com/codergeek121/custom_elements-rails/actions/workflows/ruby.yml/badge.svg?branch=main)](https://github.com/codergeek121/custom_elements-rails/actions/workflows/ruby.yml)
 
-## Usage
+This gem adds a simple way to automatically register custom elements in your `importmap-rails` app. No build step required!
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -23,7 +24,7 @@ Run the initial setup:
 $ rails custom_elements:install
 ```
 
-This will setup and add the following files:
+This will setup and edit add the following files:
 
 ```
 app/javascript
@@ -33,14 +34,91 @@ app/javascript
     └── index.js
 ```
 
-You can now add the `<app-hello>` custom element in your app. No build step needed.
+The `<app-hello>` custom element can be used in the views now.
 
-## Add a custom element
+You can generate a new custom element with `rails g custom_element abc`.
 
-TODO
+## How it works
+
+The setup will add a JS function call `eagerDefineCustomElementsFrom` that parses the importmap rendered by the `importmap-rails` gem.
+It registers custom elements with `customElements.define(...)` in the browser's registry based on the filenames in the `custom_elements` folder automatically.
+
+```
+custom_elements/hello_element.js // will register <app-hello> automatically
+```
+
+Your `*_element.js` files have to `export default` custom elements for this to work properly.
+
+> [!WARNING]  
+> Only single word elements are supported currently. See https://github.com/codergeek121/custom_elements-rails/issues/1
+
+## Add a custom element with the built-in generator
+
+This gem adds a generator to generate new custom elements with:
+
+```bash
+$ rails generate custom_element test 
+```
+
+This will generate 
+
+```javascript
+// app/javascript/custom_elements/test_element.js
+export default class extends HTMLElement {
+  constructor() {
+    super()
+  }
+
+  connectedCallback() {
+    console.log("test_element.js")
+  }
+}
+```
+
+which in turn will register a `<app-test></app-test>` custom element automatically in your app.
+
+```bash
+$ rails generate custom_element test 
+```
+
+To observe changes in your custom element's attributes, you need to set a static array of attribute names. The generator also supports setting those automatically:
+
+```bash
+$ rails generate custom_element test attribute1
+```
+
+will generate
+
+```javascript
+export default class extends HTMLElement {
+  static observedAttributes = ["attribute1"]
+
+  constructor() {
+    super()
+  }
+
+  connectedCallback() {
+    console.log("test_element.js")
+  }
+
+  get attribute1() {
+    return this.getAttribute("attribute1")
+  }
+}
+```
+
+## Documentation
+
+`eagerDefineCustomElementsFrom(under, options)`
+
+Currently supported `options`:
+
+* `prefix`: The custom elements namespace/prefix.
 
 ## Contributing
-Contribution directions go here.
+
+TODO
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,6 @@
-require "bundler/setup"
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"

data/lib/custom_elements/rails/railtie.rb

@@ -2,7 +2,9 @@ module CustomElements
   module Rails
     class Railtie < ::Rails::Engine
       initializer "custom_elements-rails.assets.precompile" do |app|
-        app.config.assets.precompile += %w( custom_elements-rails.js )
+        if app.config.respond_to? :assets
+          app.config.assets.precompile += %w( custom_elements-rails.js )
+        end
       end
     end
   end

data/lib/custom_elements/rails/version.rb

@@ -1,5 +1,5 @@
 module CustomElements
   module Rails
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/generators/custom_element_generator.rb

@@ -0,0 +1,10 @@
+class CustomElementGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  argument :attributes, type: :array, default: [], banner: "Observed attributes"
+
+  def copy_custom_element
+    template "custom_element.js", "app/javascript/custom_elements/#{file_name}_element.js"
+  end
+end
+

data/lib/generators/templates/custom_element.js.tt

@@ -0,0 +1,18 @@
+export default class extends HTMLElement {
+<% if attributes.any? %>
+  static observedAttributes = <%= attributes.map { _1.name } %>
+<% end %>
+  constructor() {
+    super()
+  }
+
+  connectedCallback() {
+    console.log("<%= file_name %>")
+  }
+<% attributes.each do |attribute| -%>
+
+  get <%= attribute.name %>() {
+    return this.getAttribute("<%= attribute.name %>")
+  }
+<% end -%>
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: custom_elements-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Niklas Häusele
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'A simple way to use custom elements to your Rails app. #nobuild'
 email:
 - niklas.haeusele@hey.com
@@ -38,6 +52,8 @@ files:
 - lib/custom_elements/rails.rb
 - lib/custom_elements/rails/railtie.rb
 - lib/custom_elements/rails/version.rb
+- lib/generators/custom_element_generator.rb
+- lib/generators/templates/custom_element.js.tt
 - lib/install/install.rb
 - lib/tasks/custom_elements/rails_tasks.rake
 homepage: https://github.com/codergeek121/custom_elements-rails