phlexi-table 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e05e322aef835f61e4d9c75e678c54ed3abd96675b7eaedb7db6b8138f826450
+  data.tar.gz: 3d2e8b90865ab5e8e5b5b405046277a51177508187f3fde2d708612bed01dc6f
+SHA512:
+  metadata.gz: e9e99ffd0dff1b5e92cdc779c8cd3fd5dee46e20094916e50eeec337c1af2b88fd0b9fa637dd56f54ad3a12381e0d2b2434747d536a4bb5fff928d08ccd6dd1f
+  data.tar.gz: 4f97e0de92ea6e09b17d7e09c6d242ee968638c6d4766991515aa54d3e738a51219190ca4d1fd944205b06b627eb9c3a2b0e7125adf5cb22eda839f14a5c7668

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "default" do
+  # gem "phlex", "~> 1.10"
+end
+
+appraise "rails-7" do
+  gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+  gem "sqlite3", "~> 1.4"
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.2.0] - 2024-07-31
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Stefan Froelich
+
+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,13 @@
+# Phlexi::Table 
+
+Phlexi::Table is a flexible and powerful table builder for Ruby applications. It provides a more customizable and extensible way to create tables.
+
+[![Ruby](https://github.com/radioactive-labs/phlexi-display/actions/workflows/main.yml/badge.svg)](https://github.com/radioactive-labs/phlexi-display/actions/workflows/main.yml)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/radioactive-labs/phlexi-display.
+
+## 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,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+task default: %i[test standard]
+
+# https://juincc.medium.com/how-to-setup-minitest-for-your-gems-development-f29c4bee13c2
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/config.ru

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development

data/gemfiles/default.gemfile

@@ -0,0 +1,5 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gemspec path: "../"

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.3", ">= 7.1.3.4"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/lib/phlexi/table/base.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/string/inflections"
+
+module Phlexi
+  module Table
+    # A display component for rendering flexible and customizable data views.
+    #
+    # @example Basic usage
+    #   Phlexi::Table.new(user) do |d|
+    #     render d.field(:name).text
+    #     render d.field(:email).text
+    #   end
+    #
+    # @attr_reader [Symbol] key The display's key, derived from the record or explicitly set
+    # @attr_reader [ActiveModel::Model, nil] object The display's associated object
+    class Base < COMPONENT_BASE
+      class Namespace < Structure::Namespace; end
+
+      class FieldBuilder < Structure::FieldBuilder; end
+
+      attr_reader :key, :object
+
+      delegate :field, :nest_one, :nest_many, to: :@namespace
+
+      # Initializes a new Table instance.
+      #
+      # @param record [ActiveModel::Model, Symbol, String] The display's associated record or key
+      # @param attributes [Hash] Additional HTML attributes for the display container
+      # @param options [Hash] Additional options for display configuration
+      # @option options [String] :class CSS classes for the display
+      # @option options [Class] :namespace_klass Custom namespace class
+      # @option options [Class] :builder_klass Custom field builder class
+      def initialize(record, attributes: {}, **options)
+        @display_class = options.delete(:class)
+        @attributes = attributes
+        @namespace_klass = options.delete(:namespace_klass) || default_namespace_klass
+        @builder_klass = options.delete(:builder_klass) || default_builder_klass
+        @options = options
+
+        initialize_object_and_key(record)
+        initialize_namespace
+      end
+
+      # Renders the display template.
+      #
+      # @return [void]
+      def view_template
+        display_template
+      end
+
+      # Executes the display's content block.
+      # Override this in subclasses to define a static display.
+      #
+      # @return [void]
+      def display_template
+        instance_exec(&@_content_block) if @_content_block
+      end
+
+      protected
+
+      attr_reader :options, :attributes, :namespace_klass, :builder_klass
+
+      # Initializes the object and key based on the given record.
+      #
+      # @param record [ActiveModel::Model, Symbol, String] The display's associated record or key
+      # @return [void]
+      def initialize_object_and_key(record)
+        @key = options.delete(:key) || options.delete(:as)
+
+        case record
+        when String, Symbol
+          @object = nil
+          @key = record
+        else
+          @object = record
+          @key = if @key.nil? && object.respond_to?(:model_name) && object.model_name.respond_to?(:param_key) && object.model_name.param_key.present?
+            object.model_name.param_key
+          else
+            :object
+          end
+        end
+        @key = @key.to_sym
+      end
+
+      # Initializes the namespace for the display.
+      #
+      # @return [void]
+      def initialize_namespace
+        @namespace = namespace_klass.root(key, object: object, builder_klass: builder_klass)
+      end
+      # Retrieves the display's CSS classes.
+      #
+      # @return [String] The display's CSS classes
+      attr_reader :display_class
+
+      # Generates the display attributes hash.
+      #
+      # @return [Hash] The display attributes
+      def display_attributes
+        mix({
+          id: @namespace.dom_id,
+          class: display_class
+        }, attributes)
+      end
+
+      private
+
+      def default_namespace_klass
+        self.class::Namespace
+      end
+
+      def default_builder_klass
+        self.class::FieldBuilder
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/base.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Base < COMPONENT_BASE
+        attr_reader :field, :attributes
+
+        def initialize(field, **attributes)
+          @field = field
+          @attributes = attributes
+
+          build_attributes
+          append_attribute_classes
+        end
+
+        protected
+
+        def build_attributes
+          attributes.fetch(:id) { attributes[:id] = "#{field.dom.id}_#{component_name}" }
+        end
+
+        def append_attribute_classes
+          return if attributes[:class] == false
+
+          attributes[:class] = tokens(
+            component_name,
+            attributes[:class]
+          )
+        end
+
+        def component_name
+          @component_name ||= self.class.name.demodulize.underscore
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/concerns/displays_value.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      module Concerns
+        module TablesValue
+          def view_template
+            value = normalize_value(field.value)
+            if value.blank?
+              render field.placeholder_tag(**@placeholder_attributes)
+            else
+              render_value(value)
+            end
+          end
+
+          # Renders the field value for display.
+          #
+          # @return [String] the formatted field value for display.
+          def render_value(value)
+            raise NotImplementedError, "#{self.class}#render_value"
+            # format_value()
+          end
+
+          protected
+
+          def build_attributes
+            super
+
+            @placeholder_attributes = attributes.delete(:placeholder_attributes) || {}
+            attributes[:id] = field.dom.id if attributes[:id] == "#{field.dom.id}_#{component_name}"
+          end
+
+          # def format_value(value)
+          #   case value
+          #   when Array
+          #     format_array_value(value)
+          #   else
+          #     format_single_value(value)
+          #   end
+          # end
+
+          # def format_array_value(array)
+          #   array.map { |item| format_single_value(item) }.join(", ")
+          # end
+
+          def normalize_value(value)
+            value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/date_time.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class DateTime < Base
+        include Concerns::TablesValue
+
+        # Renders the date time value
+        #
+        # @param value [String, Date, Time, DateTime] The value to be rendered
+        # @return [void]
+        def render_value(value)
+          formatted_value = format_date_time(value)
+          p(**attributes) { formatted_value }
+        end
+
+        protected
+
+        def build_attributes
+          super
+
+          @options = {
+            format: default_format
+          }.merge(attributes.delete(:options) || {}).compact
+        end
+
+        private
+
+        def format_date_time(value)
+          I18n.l(value, **@options)
+        end
+
+        def default_format
+          :long
+        end
+
+        def normalize_value(value)
+          case value
+          when Date, DateTime, Time, nil
+            value
+          else
+            raise ArgumentError, "Value must be a Date, DateTime or Time object. #{value.inspect} given."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/description.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Description < Base
+        def view_template
+          p(**attributes) {
+            field.description
+          }
+        end
+
+        private
+
+        def render?
+          field.has_description?
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/hint.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Hint < Base
+        def view_template
+          p(**attributes) do
+            field.hint
+          end
+        end
+
+        private
+
+        def render?
+          field.has_hint?
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/label.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Label < Base
+        def view_template
+          h5(**attributes) {
+            field.label
+          }
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/number.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "active_support/number_helper"
+
+module Phlexi
+  module Table
+    module Components
+      class Number < Base
+        include Concerns::TablesValue
+
+        def render_value(value)
+          p(**attributes) {
+            format_number(value)
+          }
+        end
+
+        protected
+
+        def build_attributes
+          super
+
+          @options = attributes.delete(:options) || {}
+        end
+
+        private
+
+        def format_number(value)
+          ActiveSupport::NumberHelper.number_to_delimited(value, **@options)
+        end
+
+        def normalize_value(value)
+          Float(value.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/placeholder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Placeholder < Base
+        def view_template
+          p(**attributes) {
+            field.placeholder
+          }
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/string.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class String < Base
+        include Concerns::TablesValue
+
+        def render_value(value)
+          p(**attributes) {
+            value
+          }
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/components/wrapper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module Components
+      class Wrapper < Base
+        def view_template
+          div(**attributes) {
+            render field.label_tag
+            yield field if block_given?
+            render field.description_tag
+          }
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/field_options/associations.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module FieldOptions
+      module Associations
+        protected
+
+        def association_reflection
+          @association_reflection ||= find_association_reflection
+        end
+
+        def find_association_reflection
+          if object.class.respond_to?(:reflect_on_association)
+            object.class.reflect_on_association(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/field_options/attachments.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module FieldOptions
+      module Attachments
+        protected
+
+        def attachment_reflection
+          @attachment_reflection ||= find_attachment_reflection
+        end
+
+        def find_attachment_reflection
+          if object.class.respond_to?(:reflect_on_attachment)
+            object.class.reflect_on_attachment(key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/field_options/description.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module FieldOptions
+      module Description
+        def description(description = nil)
+          if description.nil?
+            options[:description]
+          else
+            options[:description] = description
+            self
+          end
+        end
+
+        def has_description?
+          description.present?
+        end
+      end
+    end
+  end
+end

data/lib/phlexi/table/field_options/hints.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Phlexi
+  module Table
+    module FieldOptions
+      module Hints
+        def hint(hint = nil)
+          if hint.nil?
+            options[:hint]
+          else
+            options[:hint] = hint
+            self
+          end
+        end
+
+        def has_hint?
+          hint.present?
+        end
+      end
+    end
+  end
+end