infotable 0.1.0

data/lib/infotable/formatters/currency_formatter.rb

@@ -0,0 +1,22 @@
+module Infotable
+  module Formatters
+    class CurrencyFormatter < BaseFormatter
+      def format(value, record, options = {})
+        return "" if value.blank?
+
+        unit = options[:unit] || "$"
+        precision = options[:precision] || 2
+        delimiter = options[:delimiter] || ","
+        separator = options[:separator] || "."
+
+        number_to_currency(
+          value,
+          unit: unit,
+          precision: precision,
+          delimiter: delimiter,
+          separator: separator
+        )
+      end
+    end
+  end
+end

data/lib/infotable/formatters/date_formatter.rb

@@ -0,0 +1,58 @@
+module Infotable
+  module Formatters
+    class DateFormatter < BaseFormatter
+      def format(value, record, options = {})
+        return "" if value.blank?
+
+        value = parse_value(value)
+        return value.to_s if value.is_a?(String)
+
+        format = options[:format] || :default
+
+        case format
+        when :short
+          value.strftime("%b %d, %Y")
+        when :long
+          value.strftime("%B %d, %Y")
+        when :time
+          value.strftime("%I:%M %p")
+        when :datetime
+          value.strftime("%b %d, %Y %I:%M %p")
+        when :relative
+          time_ago_in_words(value)
+        when :dot_date
+          value.strftime("%d.%m.%Y")
+        when :default
+          # Use Rails default
+          value.strftime("%Y-%m-%d %H:%M")
+        else
+          # Custom format string
+          if format.is_a?(String)
+            value.strftime(format)
+          else
+            # Try to use I18n localization
+            begin
+              view_context.l(value, format: format)
+            rescue
+              value.strftime("%Y-%m-%d %H:%M")
+            end
+          end
+        end
+      end
+
+      private
+
+      def parse_value(value)
+        return value unless value.is_a?(String)
+
+        Time.zone.parse(value) || value
+      rescue ArgumentError
+        value
+      end
+
+      def time_ago_in_words(value)
+        view_context.t("infotable.formatters.ago", time: view_context.time_ago_in_words(value))
+      end
+    end
+  end
+end

data/lib/infotable/formatters/link_formatter.rb

@@ -0,0 +1,48 @@
+module Infotable
+  module Formatters
+    # formatter: :link
+    #   formatter_options: {
+    #     url: ->(record) { user_path(record) },   # Proc (run in the view), Symbol (helper method) or String
+    #     label: ->(record) { record.email },      # optional, defaults to the cell value
+    #     external: true,                          # target=_blank rel="noopener noreferrer"
+    #     class: "..."                             # replaces the default classes
+    #   }
+    # Without url: the value itself is the URL (handy for website columns); mailto:/tel: work too.
+    class LinkFormatter < BaseFormatter
+      ALLOWED_SCHEMES = %w[http https mailto tel].freeze
+      DEFAULT_CLASSES = "text-indigo-600 hover:text-indigo-800 hover:underline".freeze
+
+      def format(value, record, options = {})
+        label = resolve(options[:label], record) || value
+        return "" if label.blank? && value.blank?
+
+        url = options.key?(:url) ? resolve(options[:url], record) : value
+        return label.to_s unless self.class.safe_url?(url)
+
+        attributes = { href: url.to_s, class: options[:class] || DEFAULT_CLASSES }
+        attributes.merge!(target: "_blank", rel: "noopener noreferrer") if options[:external]
+
+        link_to(label.to_s, url.to_s, attributes)
+      end
+
+      # Relative URLs, http(s), mailto and tel. Everything else (javascript:, data:, ...) is rendered as text.
+      def self.safe_url?(url)
+        return false if url.blank?
+
+        cleaned = url.to_s.gsub(/[[:cntrl:][:space:]]/, "")
+        scheme = cleaned[/\A([a-z][a-z0-9+.\-]*):/i, 1]
+        scheme.nil? || ALLOWED_SCHEMES.include?(scheme.downcase)
+      end
+
+      private
+
+      def resolve(option, record)
+        case option
+        when Proc then view_context.instance_exec(record, &option)
+        when Symbol then view_context.send(option, record)
+        else option
+        end
+      end
+    end
+  end
+end

data/lib/infotable/formatters/percent_formatter.rb

@@ -0,0 +1,27 @@
+module Infotable
+  module Formatters
+    # formatter: :percent
+    #   formatter_options: {
+    #     precision: 1,       # decimals, default 0
+    #     scale: :percent,    # :percent (value is 0-100, default) or :ratio (value is 0-1)
+    #     bar: true           # small progress bar next to the number
+    #   }
+    class PercentFormatter < BaseFormatter
+      def format(value, record, options = {})
+        return "" if value.nil? || value == ""
+
+        number = Float(value.to_s, exception: false)
+        return value.to_s if number.nil?
+
+        number *= 100 if options[:scale].to_s == "ratio"
+        text = view_context.number_to_percentage(number, precision: options.fetch(:precision, 0), strip_insignificant_zeros: false)
+        return text unless options[:bar]
+
+        width = number.clamp(0, 100).round
+        bar = content_tag(:div, content_tag(:div, "", class: "h-full rounded-full bg-indigo-500", style: "width: #{width}%"),
+                          class: "h-1.5 w-16 rounded-full bg-gray-200 flex-none", role: "presentation")
+        content_tag(:div, safe_join([ content_tag(:span, text, class: "tabular-nums"), bar ]), class: "flex items-center gap-2")
+      end
+    end
+  end
+end

data/lib/infotable/search_processor.rb

@@ -0,0 +1,42 @@
+module Infotable
+  # Global search: every whitespace-separated term must match (ILIKE) at least one
+  # searchable column. Non-text columns are matched on their text representation.
+  class SearchProcessor
+    MAX_TERMS = 5
+    MAX_TERM_LENGTH = 100
+
+    attr_reader :query, :table_class, :term
+
+    def initialize(query, table_class, term)
+      @query = query
+      @table_class = table_class
+      @term = term.to_s.delete("\u0000") # PostgreSQL rejects NUL bytes
+    end
+
+    def apply
+      columns = searchable_columns
+      return query if columns.empty?
+
+      terms.reduce(query) do |relation, word|
+        pattern = "%#{ActiveRecord::Base.sanitize_sql_like(word)}%"
+        conditions = columns.map { "CAST(#{column_ref(_1)} AS text) ILIKE :pattern" }
+        relation.where(conditions.join(" OR "), pattern: pattern)
+      end
+    end
+
+    private
+
+    def terms
+      term.split.first(MAX_TERMS).map { _1.first(MAX_TERM_LENGTH) }
+    end
+
+    # Aggregate (HAVING) columns can't be searched with WHERE
+    def searchable_columns
+      table_class.searchable_columns.reject { |col| col[:virtual] && col[:sql].blank? }
+    end
+
+    def column_ref(column)
+      column[:sql].presence || "#{query.model.table_name}.#{column[:name]}"
+    end
+  end
+end

data/lib/infotable/table_resolver.rb

@@ -0,0 +1,45 @@
+module Infotable
+  # Resolves a table name (:users_table, "cms_admins_users_table", "order_items_table")
+  # to its Infotable::Base subclass.
+  #
+  # Underscores are ambiguous (namespace separator or word separator), so every way of
+  # grouping the parts into namespaces is tried, flattest first:
+  #   order_items -> OrderItemsTable, Order::ItemsTable, OrderItems::Table ...
+  # Only classes inheriting from Infotable::Base are accepted.
+  module TableResolver
+    MAX_PARTS = 8
+
+    class NotFound < Infotable::Error; end
+
+    module_function
+
+    def resolve(table_name)
+      candidates(table_name).each do |class_name|
+        klass = class_name.safe_constantize
+        return klass if klass.is_a?(Class) && klass < Infotable::Base
+      end
+
+      raise NotFound, "Table '#{table_name}' not found. Make sure it's defined in app/infotable/"
+    end
+
+    def candidates(table_name)
+      return [] unless table_name.to_s.match?(/\A[a-z0-9]+(_[a-z0-9]+)*\z/i)
+
+      parts = table_name.to_s.sub(/_table\z/, "").split("_")
+      return [] if parts.empty? || parts.size > MAX_PARTS
+
+      (0...(2**(parts.size - 1))).map { |mask| segments(parts, mask) }
+        .sort_by(&:size)
+        .map { |segs| segs.map(&:camelize).join("::").sub(/([^:]+)\z/, '\1Table') }
+        .uniq
+    end
+
+    # Bit i of mask set => split between part i and i+1
+    def segments(parts, mask)
+      parts.each_with_index.each_with_object([ [] ]) do |(part, i), acc|
+        acc.last << part
+        acc << [] if i < parts.size - 1 && mask[i] == 1
+      end.map { |seg| seg.join("_") }
+    end
+  end
+end

data/lib/infotable/version.rb

@@ -0,0 +1,3 @@
+module Infotable
+  VERSION = "0.1.0"
+end

data/lib/infotable.rb

@@ -0,0 +1,54 @@
+require "infotable/version"
+require "infotable/configuration"
+require "infotable/engine"
+
+module Infotable
+  class Error < StandardError; end
+
+  # Autoload core components
+  autoload :Base, "infotable/base"
+  autoload :FilterProcessor, "infotable/filter_processor"
+  autoload :BatchActions, "infotable/batch_actions"
+  autoload :SearchProcessor, "infotable/search_processor"
+  autoload :TableResolver, "infotable/table_resolver"
+
+  # Formatters
+  module Formatters
+    autoload :BaseFormatter, "infotable/formatters/base_formatter"
+    autoload :DateFormatter, "infotable/formatters/date_formatter"
+    autoload :CurrencyFormatter, "infotable/formatters/currency_formatter"
+    autoload :BooleanFormatter, "infotable/formatters/boolean_formatter"
+    autoload :BadgeFormatter, "infotable/formatters/badge_formatter"
+    autoload :ActionFormatter, "infotable/formatters/action_formatter"
+    autoload :LinkFormatter, "infotable/formatters/link_formatter"
+    autoload :AvatarFormatter, "infotable/formatters/avatar_formatter"
+    autoload :PercentFormatter, "infotable/formatters/percent_formatter"
+  end
+
+  # Returns the root path of the InfoTable gem
+  def self.root
+    Engine.root
+  end
+
+  # Returns the path to InfoTable views directory
+  # For use in Tailwind CSS @source directives via ERB
+  def self.views_path
+    root.join("app/views/infotable").to_s
+  end
+
+  # Returns the path to InfoTable formatters directory
+  # For use in Tailwind CSS @source directives via ERB
+  def self.formatters_path
+    root.join("lib/infotable/formatters").to_s
+  end
+
+  # Returns paths that should be scanned by Tailwind CSS
+  # For use with Node-based Tailwind (tailwind.config.js)
+  def self.tailwind_content_paths
+    [
+      root.join("app/views/infotable/**/*.{erb,html,rb}").to_s,
+      root.join("lib/infotable/formatters/**/*.rb").to_s,
+      root.join("app/assets/javascripts/infotable/**/*.js").to_s
+    ]
+  end
+end

data/lib/tasks/infotable.rake

@@ -0,0 +1,55 @@
+namespace :infotable do
+  desc "Generate infotable.css from ERB template with resolved gem paths"
+  task generate_tailwind_sources: :environment do
+    # Find the ERB template
+    erb_path = if File.exist?("app/assets/stylesheets/infotable.css.erb")
+      "app/assets/stylesheets/infotable.css.erb"
+    elsif File.exist?("app/assets/tailwind/infotable.css.erb")
+      "app/assets/tailwind/infotable.css.erb"
+    else
+      puts "⚠️  infotable.css.erb not found. Run 'rails generate infotable:install' first."
+      next
+    end
+
+    output_path = erb_path.sub(".erb", "")
+
+    # Read and process the ERB template
+    require "erb"
+    template = File.read(erb_path)
+    result = ERB.new(template).result(binding)
+
+    # Write the generated CSS
+    File.write(output_path, result)
+
+    puts "✅ Generated #{output_path} from ERB template"
+    puts "   Views: #{Infotable.views_path}"
+    puts "   Formatters: #{Infotable.formatters_path}"
+  end
+
+  # Alias for backwards compatibility
+  task update_tailwind_paths: :generate_tailwind_sources
+
+  desc "Display InfoTable gem paths for Tailwind CSS (for debugging)"
+  task show_tailwind_paths: :environment do
+    puts "\n" + "=" * 60
+    puts "InfoTable Gem Paths"
+    puts "=" * 60
+    puts "Gem root:        #{Infotable.root}"
+    puts "Views path:      #{Infotable.views_path}"
+    puts "Formatters path: #{Infotable.formatters_path}"
+    puts "=" * 60 + "\n"
+  end
+end
+
+# Hook into Tailwind CSS build tasks
+if Rake::Task.task_defined?("tailwindcss:build")
+  Rake::Task["tailwindcss:build"].enhance([ "infotable:generate_tailwind_sources" ])
+end
+
+if Rake::Task.task_defined?("tailwindcss:watch")
+  Rake::Task["tailwindcss:watch"].enhance([ "infotable:generate_tailwind_sources" ])
+end
+
+if Rake::Task.task_defined?("assets:precompile")
+  Rake::Task["assets:precompile"].enhance([ "infotable:generate_tailwind_sources" ])
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: infotable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Cieślar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '43.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '43.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  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: InfoTable provides server-side datatable functionality with filtering,
+  sorting, searching, and pagination. Built with Hotwire, Stimulus, and Tailwind CSS
+  for a modern, no-reload user experience.
+email:
+- jakub@infovation.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/infotable/controllers/drawer_controller.js
+- app/assets/javascripts/infotable/controllers/table_controller.js
+- app/assets/javascripts/infotable/index.js
+- app/controllers/infotable/application_controller.rb
+- app/controllers/infotable/tables_controller.rb
+- app/helpers/infotable/application_helper.rb
+- app/helpers/infotable/tables_helper.rb
+- app/jobs/infotable/application_job.rb
+- app/mailers/infotable/application_mailer.rb
+- app/models/infotable/application_record.rb
+- app/views/infotable/tables/_column_visibility.html.erb
+- app/views/infotable/tables/_filter_drawer.html.erb
+- app/views/infotable/tables/_next_page_frame.html.erb
+- app/views/infotable/tables/_pagination.html.erb
+- app/views/infotable/tables/_side_panel.html.erb
+- app/views/infotable/tables/_table.html.erb
+- app/views/infotable/tables/_table_rows.html.erb
+- app/views/infotable/tables/filters/_boolean.html.erb
+- app/views/infotable/tables/filters/_date.html.erb
+- app/views/infotable/tables/filters/_number.html.erb
+- app/views/infotable/tables/filters/_select.html.erb
+- app/views/infotable/tables/filters/_text.html.erb
+- app/views/infotable/tables/show.html.erb
+- app/views/layouts/infotable/application.html.erb
+- config/importmap.rb
+- config/locales/en.yml
+- config/locales/pl.yml
+- config/routes.rb
+- lib/generators/infotable/install/install_generator.rb
+- lib/generators/infotable/install/templates/TAILWIND_CONFIG.md
+- lib/generators/infotable/install/templates/initializer.rb
+- lib/generators/infotable/install/templates/tailwind.config.js
+- lib/generators/infotable/table/table_generator.rb
+- lib/generators/infotable/table/templates/table.rb.tt
+- lib/infotable.rb
+- lib/infotable/base.rb
+- lib/infotable/batch_actions.rb
+- lib/infotable/configuration.rb
+- lib/infotable/engine.rb
+- lib/infotable/filter_processor.rb
+- lib/infotable/formatters/action_formatter.rb
+- lib/infotable/formatters/avatar_formatter.rb
+- lib/infotable/formatters/badge_formatter.rb
+- lib/infotable/formatters/base_formatter.rb
+- lib/infotable/formatters/boolean_formatter.rb
+- lib/infotable/formatters/currency_formatter.rb
+- lib/infotable/formatters/date_formatter.rb
+- lib/infotable/formatters/link_formatter.rb
+- lib/infotable/formatters/percent_formatter.rb
+- lib/infotable/search_processor.rb
+- lib/infotable/table_resolver.rb
+- lib/infotable/version.rb
+- lib/tasks/infotable.rake
+homepage: https://infotable.infovation.eu/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://infotable.infovation.eu/
+  source_code_uri: https://github.com/jcieslar/infotable
+  changelog_uri: https://github.com/jcieslar/infotable/blob/main/CHANGELOG.md
+post_install_message:
+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: 3.5.16
+signing_key:
+specification_version: 4
+summary: Modern, flexible datatable engine for Rails 8+ with Hotwire
+test_files: []