tailmix 0.1.0 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c517006187e0dda710f20903df6e442b7d6fd844384213b7e031c2c7681342b
-  data.tar.gz: 833dbd51ffbe9a84d9c7ac09057b1d6f7867495d1fc09ffd7339d2addd9ec4dd
+  metadata.gz: 6092dfded3153a41a28c7ca05e13fdbd52836c86b92576606aaafaabba030d12
+  data.tar.gz: 2abf62eb8efb4a6fa6e7bc42da9a55e7e09610c9ad4a688af9030fb5a94c2d26
 SHA512:
-  metadata.gz: c63e70ec35d7894f0600aca24b6b48d5b4690606e278d87da574cdcd2a7521bfa5cc0b4297123cefbf014ca56c3143feab7bcb52a23b5e2073115395d1174d15
-  data.tar.gz: e8eb45f22300c45e63aa0c47298c33ed8454f8940400ab945e99558e74e22a4c7adad5f5a30f6c45eed23648cf8a8384274255b496bf36edee7c82435451cee8
+  metadata.gz: ba691f44a9ae33dab521b918f89858cbd2d4d08ae867330845ff403764a24ae63c87eafc1a20b8b73b5a1b9c1c4762673398f0b4c79427186bb42e96e4d48f40
+  data.tar.gz: b7bb32552b876c9c59d3c2e82450e3200fe4fe3aa4267c4b6ef94f1151836bbfa10f74a10ac80f7044a0fe2fefd69cf8f8d0a0717d9749abe8dc8b1f99e2d42e

data/.rubocop.yml

@@ -1,3 +1,6 @@
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml
+
 AllCops:
   TargetRubyVersion: 3.1
 

data/README.md

@@ -1,148 +1,210 @@
-# tailmix
+# Tailmix
+
+**Tailmix** is a powerful, declarative, and interactive CSS class manager for building maintainable UI components in Ruby. It's designed to work seamlessly with utility-first CSS frameworks like **Tailwind CSS**, allowing you to co-locate your style logic with your component's code—in a clean, structured, and highly reusable way.
 
 [![Gem Version](https://badge.fury.io/rb/tailmix.svg)](https://badge.fury.io/rb/tailmix)
 [![Build Status](https://github.com/alexander-s-f/tailmix/actions/workflows/main.yml/badge.svg)](https://github.com/alexander-s-f/tailmix/actions/workflows/main.yml)
 
-**Tailmix** is a powerful, declarative, and interactive class manager for building maintainable UI components in Ruby. It's designed to work seamlessly with utility-first CSS frameworks like **Tailwind CSS**, allowing you to co-locate your style logic with your component's code in a clean, structured, and highly reusable way.
-
-Inspired by modern frontend tools like CVA (Class Variance Authority), `tailmix` brings a robust styling engine to your server-side components (like those built with Arbre, ViewComponent, or Phlex).
+Inspired by modern frontend tools like CVA (Class Variance Authority), Tailmix brings a robust styling engine to your server-side components (built with Arbre, ViewComponent, Phlex, etc.).
 
 ## Philosophy
 
 * **Co-location & Isolation:** Define all style variants for a component directly within its class. No more hunting for styles in separate files. Each component is fully self-contained.
-* **Declarative First:** A beautiful DSL to *declare* your component's visual appearance based on variants like `state`, `size`, etc.
-* **Imperative Power:** A rich runtime API to dynamically and imperatively `add`, `remove`, or `toggle` classes, perfect for server-side updates via Hotwire/Turbo.
+* **Declarative First:** A beautiful DSL to declaratively describe your component's appearance based on variants like state, size, etc.
+* **Imperative Power:** A rich runtime API to dynamically add, remove, or toggle classes, perfect for server-side updates via Hotwire/Turbo.
 * **Framework-Agnostic:** Written in pure Ruby with zero dependencies, ready to be used in any project.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the gem to your Gemfile:
 
 ```ruby
 gem 'tailmix'
+````
+
+Or install it from the command line:
+
+```bash
+bundle add tailmix
 ```
 
-And then execute: `$ bundle install`
+Next, run the installer to set up the JavaScript assets:
+
+```bash
+bin/rails g tailmix:install
+```
 
-Or install it yourself as: `$ gem install tailmix`
+## Core Concepts
 
-## The DSL: A Detailed Breakdown
+You define your component's appearance using a simple `tailmix do ... end` DSL inside your class.
 
-You define a component's style "schema" using the `tailmix` DSL within your class.
+- `element :name, "base classes"`: Defines a logical part of your component (e.g., `:wrapper`, `:panel`, `:icon`).
+- `dimension :name, default: :value`: Defines a variant or "dimension" (e.g., `size` or `color`).
+- `option :value, "classes"`: Defines the classes for a specific variant option.
+- `action :name, method: :add | :toggle | :remove`: Defines a named set of UI mutations that can be applied on the server (`.apply!`) or passed to the client (`action_payload`).
+- `stimulus`: A powerful nested DSL for declaratively describing Stimulus `data-*` attributes.
 
-* `element :name, "base classes" do ... end`: Defines a "part" of your component. Every component has at least one element.
-* `dimension_name do ... end` (e.g., `state do`, `size do`): Defines a variant "dimension". The name can be anything you choose.
-* `option :name, "classes", default: true`: Defines a specific option within a dimension and its corresponding CSS classes. One option per dimension can be marked as the default.
+## Usage Example
 
-### Full Example of the DSL
+Let's build a complex `ModalComponent` from scratch.
+#### 1. Define the Component (`app/components/modal_component.rb`)
+
+This is a plain Ruby class that contains all the style and behavior logic.
 
 ```ruby
-class MyButtonComponent
+class ModalComponent
   include Tailmix
+  attr_reader :ui
 
   tailmix do
-    # Define the main element and its base classes
-    element :button, "inline-flex items-center font-medium rounded-md" do
-      # Define the 'size' dimension
-      size do
-        option :sm, "px-2.5 py-1.5 text-xs", default: true
-        option :md, "px-3 py-2 text-sm"
-        option :lg, "px-4 py-2 text-base"
+    element :base, "fixed inset-0 z-50 flex items-center justify-center" do
+      dimension :open, default: false do
+        option true, "visible opacity-100"
+        option false, "invisible opacity-0"
       end
+      stimulus.controller("modal")
+    end
 
-      # Define the 'intent' dimension
-      intent do
-        option :primary, "bg-blue-600 text-white hover:bg-blue-700", default: true
-        option :secondary, "bg-gray-200 text-gray-800 hover:bg-gray-300"
-        option :danger, "bg-red-600 text-white hover:bg-red-700"
+    element :overlay, "fixed inset-0 bg-black/50 transition-opacity" do
+      stimulus.context("modal").action(click: :close)
+    end
+
+    element :panel, "relative bg-white rounded-lg shadow-xl" do
+      dimension :size, default: :md do
+        option :sm, "w-full max-w-sm p-4"
+        option :md, "w-full max-w-md p-6"
       end
     end
 
-    # Define another element, like an icon
-    element :icon, "inline-block" do
-      size do
-        option :sm, "h-4 w-4"
-        option :md, "h-5 w-5", default: true
-        option :lg, "h-6 w-6"
+    element :close_button, "absolute top-2 right-2 p-1 text-gray-400" do
+      stimulus.context("modal").action(click: :close)
+    end
+
+    element :confirm_button, "px-4 py-2 bg-blue-600 text-white rounded-md" do
+      stimulus.controller("form-submission")
+              .action(:click, :show_pending_state)
+              .action_payload(:show_pending_state, as: :pending_data)
+    end
+    
+    action :show_pending_state, method: :add do
+      element :confirm_button do
+        classes "is-loading"
+        data pending: true
       end
     end
   end
-  # ...
+
+  def initialize(open: false, size: :md)
+    @ui = tailmix(open: open, size: size)
+  end
 end
 ```
 
-## Usage
+#### 2. Use in a View (Arbre, ERB, etc.)
+
+Thanks to Tailmix's design, you can pass `ui` objects directly to many rendering helpers.
 
-### 1. Initialization
+##### Arbre
 
-Inside your component, call the `tailmix` helper to create an interactive style manager. You can pass initial variants to it.
+The API is seamless. The `ui` object behaves like an attributes hash automatically.
+
+Ruby
 
 ```ruby
-class MyButtonComponent
-  # ... (tailmix DSL from above)
+# app/views/components/my_modal.arb
+# 1. Instantiate the component with the desired variants
+modal = ModalComponent.new(open: true, size: :sm)
 
-  attr_reader :classes
+# 2. Render by passing the ui objects directly to Arbre's tag helpers
+div modal.ui.base do
+  div modal.ui.overlay
 
-  def initialize(intent: :primary, size: :md)
-    # The `tailmix` helper creates and returns the manager object
-    @classes = tailmix(intent: intent, size: size)
-  end
-  
-  def render
-    # The manager's methods map to your elements.
-    # Ruby's `to_s` is called implicitly when rendering.
-    "<button class='#{@classes.button}'>
-       <span class='#{@classes.icon}'></span>
-       Click me
-     </button>"
+  div modal.ui.panel do
+    # ... your content ...
+    button modal.ui.confirm_button, "Confirm"
   end
 end
+```
+
+##### ERB / Rails Tag Helpers
+
+In ERB, the idiomatic way to pass a hash-like object as attributes is with the double splat (`**`) operator.
 
-# Renders a medium primary button by default
-button = MyButtonComponent.new
-button.render
+Фрагмент кода
 
-# Renders a small danger button
-button = MyButtonComponent.new(intent: :danger, size: :sm)
-button.render
 ```
+<%# app/views/pages/home.html.erb %>
+<% modal = ModalComponent.new(open: true, size: :sm) %>
 
-### 2. Dynamic & Imperative Usage
+<%= tag.div **modal.ui.base do %>
+  <%= tag.div **modal.ui.overlay %>
 
-This is where `tailmix` truly shines. The `@classes` object is a live manager that you can modify. This is perfect for server-side re-rendering with Hotwire/Turbo.
+  <%= tag.div **modal.ui.panel do %>
+    <%# ... your content ... %>
+    <%= tag.button "Confirm", **modal.ui.confirm_button %>
+  <% end %>
+<% end %>
+```
 
-```ruby
-class MyButtonComponent
-  # ...
+#### 3. Bring it to Life with Stimulus
+
+The `action_payload` helper makes it easy to connect server-side definitions with client-side behavior.
+
+JavaScript
+
+```js
+// app/javascript/controllers/form_submission_controller.js
+import { Controller } from "@hotwired/stimulus"
+import Tailmix from "tailmix"
+
+export default class extends Controller {
+  static values = { pendingData: Object }
 
-  # A method that might be called during a Turbo Stream update
-  def set_loading_state!
-    # The `combine` method updates the declarative state
-    @classes.combine(intent: :secondary)
+  showPendingState(event) {
+    event.preventDefault()
     
-    # The imperative API allows for fine-grained control
-    @classes.button.add("cursor-wait opacity-75")
-    @classes.icon.add("animate-spin")
-  end
+    // Instantly apply UI changes from the payload
+    Tailmix.run({
+      config: this.pendingDataValue,
+      controller: this
+    });
+
+    // ... then submit the form or send an AJAX request
+  }
+}
+```
 
-  def remove_loading_state!
-    @classes.combine(intent: :primary) # Revert to original intent
-    @classes.button.remove("cursor-wait opacity-75")
-    @classes.icon.remove("animate-spin")
-  end
-end
+## Developer Tools
+
+Tailmix comes with built-in introspection tools to improve your development experience. Access them via the `.dev` namespace on your component class.
 
-button = MyButtonComponent.new(intent: :primary)
-button.set_loading_state!
-button.render # Renders the button in a loading state
+#### Component Documentation
 
-button.remove_loading_state!
-button.render # Renders the button back in its primary state
+Get a cheat sheet of all available `dimensions` and `actions` right in your console.
+
+```ruby
+puts ModalComponent.dev.docs
 ```
 
-### 3. The Bridge to JavaScript (Stimulus)
+#### Stimulus Controller Generator
+
+Tailmix can analyze your component and scaffold a perfect boilerplate Stimulus controller with all targets, values, and action methods.
+
+```ruby
+puts ModalComponent.dev.stimulus.scaffold("modal")
+```
 
-While `tailmix` is a server-side library, it enables clean integration with JavaScript controllers like Stimulus by providing the "source of truth" for classes. You can create a helper to export variants to `data-` attributes, keeping your JS free of hardcoded style strings.
+## Configuration
+
+You can configure Tailmix by creating an initializer:
+
+```ruby
+# config/initializers/tailmix.rb
+Tailmix.configure do |config|
+  # The attribute used by the universal JS selector.
+  config.element_selector_attribute = "data-tm-el"
+end
+```
 
 ## Contributing
 

data/app/javascript/tailmix/finder.js

@@ -0,0 +1,12 @@
+const SELECTOR_ATTRIBUTE = "data-tm-el";
+
+/**
+ * find element [data-tm-el="..."]
+ * @param {HTMLElement} rootElement
+ * @param {string} name
+ * @returns {HTMLElement|null}
+ */
+export function findElement(rootElement, name) {
+    const selector = `[${SELECTOR_ATTRIBUTE}="${name}"]`;
+    return rootElement.querySelector(selector);
+}

data/app/javascript/tailmix/index.js

@@ -0,0 +1,7 @@
+import { runFromStimulus } from './stimulus_adapter';
+
+const Tailmix = {
+    run: runFromStimulus
+};
+
+export default Tailmix;

data/app/javascript/tailmix/mutator.js

@@ -0,0 +1,28 @@
+/**
+ * @param {HTMLElement} element
+ * @param {object} command - { field: "classes", method: "toggle", payload: "hidden" }.
+ */
+export function applyCommand(element, command) {
+    const { field, method, payload } = command;
+
+    if (field === 'classes') {
+        payload.split(' ').forEach(klass => {
+            if (klass) element.classList[method](klass);
+        });
+    } else if (field === 'data') {
+        for (const key in payload) {
+            const attributeName = `data-${key.replace(/_/g, '-')}`;
+            const value = payload[key];
+
+            if (method === 'remove') {
+                element.removeAttribute(attributeName);
+            } else if (method === 'toggle') {
+                element.hasAttribute(attributeName)
+                    ? element.removeAttribute(attributeName)
+                    : element.setAttribute(attributeName, value);
+            } else { // 'add'
+                element.setAttribute(attributeName, value);
+            }
+        }
+    }
+}

data/app/javascript/tailmix/runner.js

@@ -0,0 +1,7 @@
+/**
+ * TailmixRunner
+ *
+ */
+export default class TailmixRunner {
+
+}

data/app/javascript/tailmix/stimulus_adapter.js

@@ -0,0 +1,37 @@
+import { findElement as findElementByAttribute } from './finder';
+import { applyCommand } from './mutator';
+
+/**
+ * @param {object} params
+ * @param {object} params.config
+ * @param {StimulusController} params.controller
+ */
+export function runFromStimulus({ config, controller }) {
+    if (!config?.mutations) {
+        console.error("Invalid Tailmix config:", config);
+        return;
+    }
+
+    for (const elementName in config.mutations) {
+        const targetElement = findElement(elementName, controller);
+
+        if (!targetElement) {
+            console.warn(`Tailmix: Element "${elementName}" not found.`);
+            continue;
+        }
+
+        const commands = config.mutations[elementName];
+
+        for (const command of commands) {
+            applyCommand(targetElement, command);
+        }
+    }
+}
+
+function findElement(name, controller) {
+    const targetName = `${name}Target`;
+    if (controller[targetName]) {
+        return controller[targetName];
+    }
+    return findElementByAttribute(controller.element, name);
+}

data/examples/_modal_component.arb

@@ -0,0 +1,36 @@
+# Arbre view:
+
+modal = SuperModalComponent.new(size: :lg, open: true)
+
+# modal.lock!
+ui = modal.ui
+
+div ui.base do
+  div ui.overlay
+  div ui.open do
+    "open"
+  end
+
+  div ui.panel do
+    button ui.close_button do
+      span "Close"
+    end
+
+    h3 ui.title do
+      "Payment Successful"
+    end
+
+    div ui.body do
+      "Your payment has been successfully submitted. We’ve sent you an email with all of the details of your order."
+    end
+
+    div ui.footer do
+      button ui.confirm_button do
+        span "Confirm Purchase"
+        div ui.spinner do
+          span "Loading..."
+        end
+      end
+    end
+  end
+end

data/examples/modal_component.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require_relative "../lib/tailmix"
+
+class ModalComponent
+  include Tailmix
+  attr_reader :ui
+
+  tailmix do
+    element :base, "fixed inset-0 z-50 flex items-center justify-center" do
+      dimension :open, default: true do
+        option true, "visible opacity-100"
+        option false, "invisible opacity-0"
+      end
+      stimulus.controller("modal").action_payload(:toggle, as: :toggle_data)
+    end
+
+    element :overlay, "fixed inset-0 bg-black/50 transition-opacity" do
+      stimulus.context("modal").action(:click, :close)
+    end
+
+    element :panel, "relative bg-white rounded-lg shadow-xl transition-transform transform" do
+      dimension :size, default: :md do
+        option :sm, "w-full max-w-sm p-4"
+        option :md, "w-full max-w-md p-6"
+        option :lg, "w-full max-w-lg p-8"
+      end
+      stimulus.context("modal").target("panel")
+    end
+
+    element :title, "text-lg font-semibold text-gray-900"
+    element :body, "mt-2 text-sm text-gray-600"
+    element :close_button, "absolute top-2 right-2 p-1 text-gray-400 rounded-full hover:bg-gray-100 hover:text-gray-600" do
+      stimulus.context("modal").action(:click, :close)
+    end
+
+    element :footer, "mt-4 pt-4 border-t flex justify-end"
+    element :confirm_button, "relative inline-flex items-center px-4 py-2 bg-blue-600 text-white font-semibold rounded-md hover:bg-blue-700" do
+      stimulus.controller("form-submission")
+              .action(:click, :submit)
+              .action_payload(:enter_pending_state, as: :pending_data)
+    end
+
+    element :spinner, "absolute inset-0 flex items-center justify-center hidden"
+
+    action :toggle, method: :toggle do
+      element :overlay do
+        classes "hidden"
+      end
+      element :panel do
+        classes "hidden"
+      end
+    end
+
+    action :lock, method: :add do
+      element :close_button do
+        classes "hidden"
+      end
+      element :panel do
+        data locked: true, reason: "processing"
+      end
+    end
+
+    action :enter_pending_state, method: :add do
+      element :confirm_button do
+        classes "opacity-75 cursor-not-allowed"
+      end
+      element :spinner do
+        classes "flex"
+      end
+    end
+  end
+
+  def initialize(size: :md, open: false)
+    @ui = tailmix(size: size, open: open)
+  end
+
+  def lock!
+    @ui.action(:lock).apply!
+  end
+end
+
+puts "-" * 100
+puts ModalComponent.dev.docs
+puts ""
+puts "Scaffolds:"
+puts ""
+puts ModalComponent.dev.stimulus.scaffold
+puts ""
+
+# >>>
+#
+# == Tailmix Docs for ModalComponent ==
+# Signature: `initialize(open: true, size: :md)`
+#
+# Dimensions:
+#   - open (default: true)
+#     - true: "visible opacity-100"
+#     - false: "invisible opacity-0"
+#   - size (default: :md)
+#     - :sm: "w-full max-w-sm p-4"
+#     - :md: "w-full max-w-md p-6"
+#     - :lg: "w-full max-w-lg p-8"
+#
+# Actions:
+#   - :toggle
+#   - :lock
+#   - :enter_pending_state
+#
+# Stimulus:
+#   - on `modal` controller:
+#     - Targets: panel
+#     - Actions: close
+#
+# Stimulus:
+#   - on `form-submission` controller:
+#     - Actions: submit
+#
+# Scaffolds:
+#
+# // Generated by Tailmix for the "modal" controller
+# // Path: app/javascript/controllers/modal_controller.js
+# import { Controller } from "@hotwired/stimulus"
+# import Tailmix from "tailmix"
+#
+# export default class extends Controller {
+#   static targets = ['panel']
+#   static values = { toggleData: Object }
+#
+#   connect() {
+#     console.log("modal controller connected to", this.element);
+#   }
+#   toggle(event) {
+#      if (event) event.preventDefault();
+#      Tailmix.run({ config: this.toggleDataValue, controller: this });
+#   }
+#
+#   close() {
+#     console.log('modal#close fired');
+#   }
+# }
+# ------------------------------------------------------------
+#
+# // Generated by Tailmix for the "form-submission" controller
+# // Path: app/javascript/controllers/form-submission_controller.js
+# import { Controller } from "@hotwired/stimulus"
+# import Tailmix from "tailmix"
+#
+# export default class extends Controller {
+#   static targets = []
+#   static values = { pendingData: Object }
+#
+#   connect() {
+#     console.log("form-submission controller connected to", this.element);
+#   }
+#   enterPendingState(event) {
+#      if (event) event.preventDefault();
+#      Tailmix.run({ config: this.pendingDataValue, controller: this });
+#   }
+#
+#   submit() {
+#     console.log('form-submission#submit fired');
+#   }
+# }
+# ------------------------------------------------------------
+
+
+
+
+# modal = ModalComponent.new(size: :lg, open: true)
+# modal.lock!
+# ui = modal.ui
+
+# puts "Definition:"
+# pp ModalComponent.tailmix_definition
+# pp ModalComponent.tailmix_definition.to_h
+# ui.overlay.each do |key, value|
+#   puts "#{key} :-> #{value.inspect.to_s[0, 75]}..."
+# end
+# ui.action(:lock).apply!

data/lib/generators/tailmix/install_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Tailmix
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      def add_javascript
+        say "Pinning Tailmix JavaScript", :green
+        append_to_file "config/importmap.rb", <<~RUBY
+          pin "tailmix", to: "tailmix/index.js"
+        RUBY
+
+        say "Adding Tailmix to asset manifest", :green
+        append_to_file "app/assets/config/manifest.js", "\n//= link tailmix/index.js.js\n"
+      end
+    end
+  end
+end