yiffspace-tables 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bebb3ea3cfa83ecf7855b951bd615710b0687fb45a1e43a7283b78ff64470755
+  data.tar.gz: 5b6bc96aacd6950716b12b090dc17f42b42a186344305f2fa2d7bc183de84e04
+SHA512:
+  metadata.gz: bf23e91575a639f2f189707270e817feee48cf4a118872f9cc22fdf1f173c69a9a3d5844633c650c06fcadeb39b12e59356cb7396c133a4098f9f0c0ab338760
+  data.tar.gz: 0a2f003542e6cc24a7162796d4292c3cb2a4145f7c4b9871a05aac47e7e07edcd58ab5cb48474fd0a675794b64ef4c3459ac05780f36f2c42303c7e3fa11d43d

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- Initial release, extracted from the `yiffspace` gem's `YiffSpace::Tables::Builder`.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright Donovan_DMC
+
+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.

data/README.md

@@ -0,0 +1,37 @@
+# YiffSpace::Tables
+
+HTML table-building DSL (`YiffSpace::Tables::Builder`), for
+https://yiff.space and related projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "yiffspace-tables"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+```ruby
+YiffSpace::Tables::Builder.new(@tags) do |table|
+  table.column(:name)
+  table.column(:post_count)
+end
+```
+
+See `YiffSpace::Tables::Builder` for the full API.
+
+## Contributing
+
+Go away
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require("bundler/gem_tasks")
+
+# CI releases from an already-tagged, already-pushed commit checked out at a detached HEAD, so
+# the default release task's git tag/push step has nothing to do and fails trying to push a
+# branch ref that does not exist in that checkout.
+Rake::Task["release"].clear
+task("release" => "release:rubygem_push")

data/lib/yiffspace/tables/builder.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Tables
+    # A helper class for building HTML tables. Used in views.
+    #
+    # @example
+    #   <%= table_for @tags do |table| %>
+    #     <% table.column :name do |tag| %>
+    #       <%= link_to_wiki "?", tag.name  %>
+    #       <%= link_to tag.name, posts_path(tags: tag.name) %>
+    #     <% end %>
+    #     <% table.column :post_count %>
+    #   <% end %>
+    #
+    # @see app/views/table_builder/_table.html.erb
+    class Builder
+      # Represents a single column in the table.
+      class Column
+        attr_reader(:attribute, :name, :block, :header_attributes, :body_attributes, :caption)
+
+        # Define a table column.
+        #
+        # @example
+        #   <% table.column :post_count %>
+        #
+        # @example
+        #   <% table.column :name do |tag| %>
+        #     <%= tag.pretty_name %>
+        #   <% end %>
+        #
+        # @param attribute [Symbol] The attribute in the model the column is for.
+        #   The column's name and value will come from this attribute by default.
+        # @param name [String] the column's name, if different from the attribute name.
+        # @param column [String] the column name
+        # @param th [Hash] the HTML attributes for the column's <th> tag.
+        # @param td [Hash] the HTML attributes for the column's <td> tag.
+        # @param width [String] the HTML width value for the <th> tag.
+        # @yieldparam item a block that returns the column value based on the item.
+        def initialize(attribute = nil, column: nil, th: {}, td: {}, width: nil, name: nil, &block)
+          @attribute = attribute
+          @column = column
+          @header_attributes = { width: width, **th }
+          @body_attributes = td
+          @block = block
+
+          @name = name || attribute
+          @name = @name.to_s.titleize unless @name.is_a?(String)
+
+          return unless @name.present? || @column.present?
+
+          if @column.present?
+            column_class = "#{@column}-column"
+          else
+            column_class = "#{@name.parameterize.dasherize}-column"
+          end
+          @header_attributes[:class] = "#{column_class} #{@header_attributes[:class]}".strip
+          @body_attributes[:class] = "#{column_class} #{@body_attributes[:class]}".strip
+        end
+
+        # Returns the value of the table cell.
+        # @param item [ApplicationRecord] the table cell item
+        # @param row [Integer] the table row number
+        # @param column [Integer] the table column number
+        # @return [#to_s] the value of the table cell
+        def value(item, row, column)
+          if block.present?
+            view = block.binding.receiver
+            if view.respond_to?(:capture)
+              view.capture { block.call(item, row, column, self) }
+            else
+              block.call(item, row, column, self)
+            end
+          elsif attribute.is_a?(Symbol)
+            item.send(attribute)
+          else
+            ""
+          end
+        end
+      end
+
+      # Represents a custom row in the table body.
+      class Row
+        attr_reader(:block, :row_attributes)
+
+        def initialize(row_attributes = {}, &block)
+          @row_attributes = row_attributes
+          @block = block
+        end
+
+        def custom?
+          true
+        end
+
+        def value(index)
+          view = block.binding.receiver
+          if view.respond_to?(:capture)
+            view.capture { block.call(index, self) }
+          else
+            block.call(index, self)
+          end
+        end
+      end
+
+      attr_reader(:columns, :table_attributes, :row_attributes, :items)
+
+      # Build a table for an array of objects, one object per row.
+      #
+      # The <table> tag is automatically given an HTML id of the form `{name}-table`.
+      # For example, `posts-table`, `tags-table`.
+      #
+      # The <tr> tag is automatically given an HTML id of the form `{name}-{id}`.
+      # For example, `post-1234`, `tag-4567`, etc. Each <tr> tag also gets a set of
+      # data attributes for each model; see #html_data_attributes in app/policies.
+      #
+      # @param items [Array<ApplicationRecord>] The list of ActiveRecord objects to
+      #   build the table for. One item per table row.
+      # @param tr [Hash] optional HTML attributes for the <tr> tag for each row
+      # @param table_attributes [Hash] optional HTML attributes for the <table> tag
+      # @yieldparam table [self] the table being built
+      def initialize(items, tr: {}, **table_attributes)
+        @items = items
+        @columns = []
+        @table_attributes = { class: "striped", **table_attributes }
+        @row_attributes = tr
+
+        @table_attributes[:id] ||= "#{items.model_name.plural.dasherize}-table" if items.respond_to?(:model_name)
+
+        yield(self) if block_given?
+      end
+
+      # Set the table caption
+      def caption
+        @caption = yield if block_given?
+        @caption
+      end
+
+      # Add a column to the table.
+      # @example
+      #   table.column(:name)
+      def column(*, **options, &)
+        opt = options.extract!(:if, :unless)
+        return if (opt.key?(:if) && !opt[:if]) || (opt.key?(:unless) && opt[:unless])
+
+        @columns << Column.new(*, **options, &)
+      end
+
+      def row(row_attributes = {}, &)
+        @items = @items.to_a unless @items.is_a?(Array)
+        @items << Row.new(row_attributes, &)
+      end
+
+      # Return the HTML attributes for each <tr> tag.
+      # @param item [ApplicationRecord] the item for this row
+      # @param _row [Integer] the row number (unused)
+      # @return [Hash] the <tr> attributes
+      def all_row_attributes(item, _row)
+        return item.row_attributes if item.is_a?(Row)
+        return {} unless item.is_a?(YiffSpace.config.application_record_class)
+
+        {
+          id: "#{item.model_name.singular.dasherize}-#{item.id}",
+          **row_attributes,
+          **YiffSpace.config.application_controller_class.helpers.data_attributes_for(item),
+        }
+      end
+    end
+  end
+end

data/lib/yiffspace/tables/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Tables
+    VERSION = "0.0.1"
+  end
+end

data/lib/yiffspace/tables.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require("yiffspace/core")
+require("zeitwerk")
+
+loader = Zeitwerk::Loader.for_gem_extension(YiffSpace)
+loader.setup

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: yiffspace-tables
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Donovan_DMC
+bindir: bin
+cert_chain: []
+date: 2026-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yiffspace-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: HTML table-building DSL (YiffSpace::Tables::Builder), for https://yiff.space
+  and related projects
+email:
+- hewwo@yiff.rocks
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/yiffspace/tables.rb
+- lib/yiffspace/tables/builder.rb
+- lib/yiffspace/tables/version.rb
+homepage: https://yiff.space
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://yiff.space
+  source_code_uri: https://github.com/YiffSpace/Gem/tree/master/yiffspace-tables
+  changelog_uri: https://github.com/YiffSpace/Gem/blob/master/yiffspace-tables/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.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: HTML table-building DSL (YiffSpace::Tables::Builder), for https://yiff.space
+  and related projects
+test_files: []