unmagic-components 0.1.0

data/lib/unmagic/components/table_tag.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Unmagic
+  module Components
+    # Renders a `.UnmagicTable` from plain cells. This is the primitive Table is
+    # built on, and it is useful directly for a static table that wants the same
+    # look without the record/sort/pagination machinery.
+    #
+    # A cell is a value, or a { content:, **attrs } hash setting attributes on its
+    # th/td. A row is an array of cells, or a { cells:, **attrs } hash setting
+    # attributes on its <tr>.
+    class TableTag
+      ALIGN_CLASSES = { right: "is-right", center: "is-center" }.freeze
+
+      # A width is either a CSS length, which rides on the <col> as an inline
+      # style, or anything else, which is treated as a class name so a host can
+      # pin columns with its own utilities (e.g. Tailwind's "w-[40%]").
+      CSS_LENGTH = /\A-?[\d.]+(%|px|rem|em|ch|ex|vw|vh|fr)\z/
+
+      def initialize(view, headers, rows, aligns: [], widths: [], caption: nil, rows_id: nil, **attributes)
+        @view = view
+        @headers = headers
+        @rows = rows
+        @aligns = aligns
+        @widths = widths
+        @caption = caption
+        @rows_id = rows_id
+        @attributes = attributes
+      end
+
+      def render
+        attributes = @attributes.dup
+        attributes[:class] = class_names("UnmagicTable UnmagicTable--full",
+          ("UnmagicTable--fixed" if pinned?), attributes[:class])
+
+        tag.table(**attributes) do
+          safe_join [ caption, colgroup, (head if @headers.present?), body ].compact
+        end
+      end
+
+      # One <tr>, rendered on its own. A broadcast replacing or inserting a single
+      # row needs the same markup the table would have produced for it.
+      def render_row(row)
+        row = { cells: row } unless row.is_a?(Hash)
+        cells = Array(row[:cells]).each_with_index.map { |cell, index| render_cell(:td, cell, @aligns[index]) }
+        tag.tr safe_join(cells), **row.except(:cells)
+      end
+
+      private
+
+      attr_reader :view
+
+      delegate :tag, :safe_join, :class_names, to: :view, private: true
+
+      def pinned? = @widths.any?(&:present?)
+
+      def caption
+        tag.caption(@caption, class: "UnmagicTable__caption") if @caption
+      end
+
+      def colgroup
+        return unless pinned?
+
+        tag.colgroup safe_join(@widths.map { |width| col(width) })
+      end
+
+      def col(width)
+        if width.blank?
+          tag.col
+        elsif width.to_s.match?(CSS_LENGTH)
+          tag.col(style: "width: #{width}")
+        else
+          tag.col(class: width)
+        end
+      end
+
+      def head
+        tag.thead tag.tr(safe_join(@headers.each_with_index.map { |cell, index| render_cell(:th, cell, @aligns[index]) }))
+      end
+
+      def body
+        tag.tbody safe_join(@rows.map { |row| render_row(row) }), id: @rows_id
+      end
+
+      def render_cell(name, cell, align)
+        cell = { content: cell } unless cell.is_a?(Hash)
+        attributes = cell.except(:content)
+        attributes[:class] = class_names(ALIGN_CLASSES[align], attributes[:class]).presence
+        tag.public_send(name, cell[:content], **attributes)
+      end
+    end
+  end
+end

data/lib/unmagic/components/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Unmagic
+  module Components
+    VERSION = "0.1.0"
+  end
+end

data/lib/unmagic/components.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/object/try"
+require "active_support/core_ext/hash/except"
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/string/output_safety"
+
+require_relative "components/version"
+require_relative "components/configuration"
+require_relative "components/renderers/empty_state"
+require_relative "components/renderers/pagination"
+require_relative "components/table_tag"
+require_relative "components/table/column"
+require_relative "components/table"
+require_relative "components/form_builder"
+require_relative "components/detail_list/item"
+require_relative "components/detail_list"
+require_relative "components/action_view_helpers"
+# ActionView pulls in a partial Rails namespace, so this checks for the constant it
+# actually needs rather than for Rails.
+require_relative "components/engine" if defined?(Rails::Engine)
+
+module Unmagic
+  module Components
+    class << self
+      def configure
+        yield(configuration) if block_given?
+        configuration
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      # Drops every customisation, restoring the built-in seams. Intended for
+      # tests; an app configures once at boot.
+      def reset_configuration!
+        @configuration = nil
+      end
+    end
+  end
+end

data/lib/unmagic-components.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "unmagic/components"

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: unmagic-components
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Pitt
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Server-rendered view builders in the spirit of form_for. table_for for
+  index tables — sortable headers, deferred turbo-frame loading with a matching skeleton,
+  empty states, pagination, and rows a Turbo Stream can keep up to date. detail_list
+  for description lists, and a form builder for the chrome around a control. Plain
+  Rails helpers, themed through CSS custom properties.
+email:
+- keith@unreasonable-magic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- app/assets/javascripts/unmagic/components/upsert.js
+- app/assets/stylesheets/unmagic/components.css
+- config/importmap.rb
+- lib/unmagic-components.rb
+- lib/unmagic/components.rb
+- lib/unmagic/components/action_view_helpers.rb
+- lib/unmagic/components/configuration.rb
+- lib/unmagic/components/detail_list.rb
+- lib/unmagic/components/detail_list/item.rb
+- lib/unmagic/components/engine.rb
+- lib/unmagic/components/form_builder.rb
+- lib/unmagic/components/renderers/empty_state.rb
+- lib/unmagic/components/renderers/pagination.rb
+- lib/unmagic/components/table.rb
+- lib/unmagic/components/table/column.rb
+- lib/unmagic/components/table_tag.rb
+- lib/unmagic/components/version.rb
+homepage: https://github.com/unreasonable-magic/unmagic-components
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unreasonable-magic/unmagic-components
+  changelog_uri: https://github.com/unreasonable-magic/unmagic-components/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Declarative table, detail-list and form builders for Rails views
+test_files: []