mensa 0.1.0 → 0.1.3

data/app/tables/mensa/config/dsl_logic.rb

@@ -0,0 +1,90 @@
+module Mensa::Config
+  module DslLogic
+    extend ActiveSupport::Concern
+
+    attr_reader :config, :values
+
+    delegate :default_config, to: :class
+
+    def initialize(name, &)
+      @config = {}
+      @config[:name] = name if name
+      @config = @config.merge(default_config.deep_dup)
+
+      instance_eval(&) if block_given?
+    end
+
+    class_methods do
+      attr_reader :default_config
+
+      def option(name, default: nil, config_name: nil, dsl: nil, dsl_hash: nil, dsl_array: nil)
+        if dsl
+          dsl_option(name, dsl)
+        elsif dsl_hash
+          dsl_hash(name, dsl_hash, config_name: config_name)
+        elsif dsl_array
+          dsl_array(name, dsl_array, config_name: config_name)
+        else
+          simple_option(name, default: default)
+        end
+      end
+
+      ###
+      # Define a accessor method
+      #
+      # def name(value = nil, &)
+      #   config[:name] = block || value
+      # end
+      #
+      # by calling simple_option :name
+      #
+      def simple_option(option_name, default: nil)
+        @default_config ||= {}
+        @default_config[option_name.to_sym] = default
+
+        define_method(option_name) do |value = nil, &block|
+          config[option_name.to_sym] = block || value
+        end
+      end
+
+      ###
+      # Define a DSL method
+      #
+      # def render(name, &)
+      #   config[:render] = Mensa::RenderDsl.new(name, &).config
+      # end
+      #
+      # by calling define_dsl :render, Mensa::RenderDsl
+      #
+      def dsl_option(option_name, klass)
+        define_method(option_name) do |name = nil, &block|
+          config[option_name.to_sym] = block && klass.new(name, &block).config
+        end
+      end
+
+      def dsl_hash(option_name, klass, config_name:)
+        config_name = config_name || option_name.to_s.pluralize.to_sym
+
+        @default_config ||= {}
+        @default_config[option_name.to_sym] = {}
+
+        define_method(option_name) do |name = nil, &block|
+          config[config_name] ||= {}
+          config[config_name][name] = klass.new(nil, &block).config
+        end
+      end
+
+      def dsl_array(option_name, klass, config_name: option_name.to_s.pluralize.to_sym)
+        config_name = config_name || option_name.to_s.pluralize.to_sym
+
+        @default_config ||= {}
+        @default_config[name.to_sym] = []
+
+        define_method(option_name) do |name = nil, &block|
+          config[config_name] ||= []
+          config[config_name] << klass.new(name, &block).config
+        end
+      end
+    end
+  end
+end

data/app/tables/mensa/config/filter_dsl.rb

@@ -0,0 +1,8 @@
+module Mensa::Config
+  class FilterDsl
+    include DslLogic
+
+    option :collection
+    option :scope
+  end
+end

data/app/tables/mensa/config/render_dsl.rb

@@ -0,0 +1,8 @@
+module Mensa::Config
+  class RenderDsl
+    include DslLogic
+
+    option :html
+    option :xlsx
+  end
+end

data/app/tables/mensa/config/table_dsl.rb

@@ -0,0 +1,71 @@
+# class UsersTable < Mensa::Base
+#   definition do
+#     model User
+#
+#     render do # default Standard components
+#       html # Mensa::TableComponent::Default
+#       json # Mensa::JsonRenderer::Default
+#       xlsx # Mensa::XlsxRenderer::Default
+#     end
+#
+#     column(:first_name) do
+#       filter
+#       # render do
+#       #   html do |c|
+#       #     link_to(edit_contact_path(c)) do
+#       #       content_tag("i", nil, class: "fal fa-book")
+#       #     end
+#       #   end
+#       # end
+#     end
+#     column :last_name do
+#       filter
+#     end
+#     column :email
+#     column :phone_number
+#     column :state
+#     column :city
+#     column :created_at
+#
+#     order last_name: :asc
+#     link { |user| edit_user_path(user) }
+#
+#     supports_views true
+#
+#     action :activate do
+#       link { |user| edit_user_path(user) }
+#       icon "fa-check"
+#     end
+#     action :delete do
+#       link { |user| edit_user_path(user) }
+#       link_attributes "data-turbo-method" => "delete"
+#       icon "fa-xmark"
+#     end
+#   end
+
+module Mensa::Config
+  class TableDsl
+    include DslLogic
+
+    option :model, default: -> { self.class.name.demodulize.to_s.classify.constantize rescue raise "No model found for #{self.class.name}" }
+    option :column, dsl_hash: Mensa::Config::ColumnDsl
+    option :link
+
+    # Default sort order {column: direction, column: direction}
+    option :order, default: {}
+
+    # Order of columns in the table
+    option :column_order
+
+    # Actions
+    option :action, dsl_hash: Mensa::Config::ActionDsl
+
+    dsl_option :render, Mensa::Config::RenderDsl
+
+    option :supports_views, default: false
+    option :show_header, default: true
+    option :view_columns_sorting, default: true
+    option :view_condensed, default: false
+    option :view_condensed_toggle, default: true
+  end
+end

data/app/tables/mensa/config_readers.rb

@@ -0,0 +1,13 @@
+module Mensa
+  module ConfigReaders
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def config_reader(name)
+        define_method name do
+          config[name.to_s.gsub("?", "").to_sym]
+        end
+      end
+    end
+  end
+end

data/app/tables/mensa/filter.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mensa
+  class Filter
+    include ConfigReaders
+    attr_reader :column, :value, :config, :table
+
+    config_reader :scope
+
+    def initialize(value, column:, config:, table:)
+      @value = value
+      @column = column
+      @config = config
+      @table = table
+    end
+
+    def collection
+      return unless config&.key?(:collection)
+
+      if config[:collection].is_a? Proc
+        table.original_view_context.instance_exec(&config[:collection])
+      else
+        config[:collection]
+      end
+    end
+
+    def to_s
+      "#{column.human_name}: #{value}"
+    end
+  end
+end

data/app/tables/mensa/row.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Mensa
+  class Row
+    attr_reader :table, :view_context, :record
+
+    def initialize(table, record)
+      @table = table
+      @record = record
+    end
+
+    def value(column)
+      if column.attribute && record.respond_to?(column.attribute)
+        record.public_send(column.attribute)
+      elsif column.method && record.respond_to?(column.method)
+        record.public_send(column.method)
+      elsif record.respond_to?(column.name)
+        record.public_send(column.name)
+      elsif record.respond_to?(:[])
+        record[column.name]
+      else
+        "-"
+      end
+    end
+
+    def link_attributes
+      return {} unless link
+
+      { href: link, data: { controller: "satis-link",  action: "click->satis-link#follow tap->satis-link#follow" } }
+    end
+
+    def link
+      table.original_view_context.instance_exec(record, &table.link) if table.link
+    end
+  end
+end

data/app/tables/mensa/scope.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Mensa
+  module Scope
+    extend ActiveSupport::Concern
+
+    included do
+    end
+
+    # Returns the records we want to display, using the Active Record Query Interface
+    # By default it returns all records
+    def scope
+      model.all
+    end
+
+    # Returns the scope, but filtered
+    def filtered_scope
+      return @filtered_scope if @filtered_scope
+
+      @filtered_scope = scope
+      # See https://github.com/textacular/textacular
+      # This has problems - not all table fields are searched
+      @filtered_scope = @filtered_scope.basic_search(params[:query]) if params[:query]
+
+      if params[:filters]
+        params[:filters].each do |column_name, value|
+          next unless (column = column(column_name))
+
+          @filtered_scope = if column.filter&.scope
+                              @filtered_scope.instance_exec(Helper.normalize(value), &column.filter.scope)
+                            else
+                              @filtered_scope.where(column.attribute_for_condition => Helper.normalize(value))
+                            end
+        end
+      end
+
+      @filtered_scope
+    end
+
+    # Returns the filtered_columns, but ordered, we always reorder, scope shouldn't include ordering
+    def ordered_scope
+      return @ordered_scope if @ordered_scope
+
+      @ordered_scope = filtered_scope
+      @ordered_scope = @ordered_scope.reorder(order_hash)
+
+      @ordered_scope
+    end
+
+    # Return the ordered_scope, but with only the columns selected
+    def selected_scope
+      return @selected_scope if @selected_scope
+
+      @selected_scope = ordered_scope
+      @selected_scope = @selected_scope.select([:id] + columns.map(&:attribute).compact)
+
+      Rails.logger.debug("*" * 80)
+      Rails.logger.debug("Selected scope")
+      Rails.logger.debug(@selected_scope.to_sql)
+      Rails.logger.debug("*" * 80)
+
+
+      @selected_scope
+    end
+
+    def paged_scope
+      pagy_object
+      @records
+    end
+
+    def pagy_details
+      pagy_object
+      @pagy_details
+    end
+
+    private
+
+    def pagy_object
+      return if @pagy_details && @records
+
+      @pagy_details, @records = selected_scope.is_a?(Array) ? pagy_array(ordered_scope) : pagy(selected_scope)
+    end
+
+    # Though this works, perhaps moving this in column(s) is nicer
+    def order_hash(new_params = {})
+      (params[:order] || config[:order]).merge(new_params.symbolize_keys)
+                                        .reject { |name, direction| direction.blank? }
+                                        .transform_values { |value| value.to_sym }
+    end
+
+    module Helper
+      class << self
+        def normalize(query)
+          query.to_s.gsub(/\s(?![\&\!\|])/, '\\\\ ')
+        end
+      end
+    end
+  end
+end

data/app/views/layouts/mensa/application.html.slim

@@ -0,0 +1,11 @@
+doctype html
+html
+  head
+    title Dummy
+    meta name="viewport" content="width=device-width,initial-scale=1"
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag "mensa"
+    = javascript_importmap_tags "mensa"
+  body
+    = yield

data/app/views/mensa/tables/filters/show.turbo_stream.slim

@@ -0,0 +1,8 @@
+= turbo_stream.update params[:target] do
+  = sts.form_for(Mensa::Tables::FiltersController::Filter.new, url: '#') do |f|
+    - if @column.filter.collection
+      = f.input :value, collection: @column.filter.collection, input_html: { "data-action"=> "keydown.esc->mensa-add-filter#reset keydown.enter->mensa-add-filter#filterValueEntered", autofocus: "autofocus" }, label: @column.human_name
+    - else
+      = f.input :value, input_html: { "data-action"=> "keydown.esc->mensa-add-filter#reset keydown.enter->mensa-add-filter#filterValueEntered", autofocus: "autofocus" }, label: @column.human_name
+  a.sts-table__add_filter__popover_container__clear
+    | Clear

data/app/views/mensa/tables/index.html.slim

@@ -0,0 +1,93 @@
+button data-controller="alert" data-action="alert#alert"
+  | Click me
+
+<ul role="list" class="divide-y divide-gray-100">
+  <li class="flex justify-between gap-x-6 py-5">
+    <div class="flex min-w-0 gap-x-4">
+      <img class="h-12 w-12 flex-none rounded-full bg-gray-50" src="https://images.unsplash.com/photo-1494790108377-be9c29b29330?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=facearea&facepad=2&w=256&h=256&q=80" alt="">
+      <div class="min-w-0 flex-auto">
+        <p class="text-sm font-semibold leading-6 text-gray-900">Leslie Alexander</p>
+        <p class="mt-1 truncate text-xs leading-5 text-gray-500">leslie.alexander@example.com</p>
+      </div>
+    </div>
+    <div class="hidden shrink-0 sm:flex sm:flex-col sm:items-end">
+      <p class="text-sm leading-6 text-gray-900">Co-Founder / CEO</p>
+      <p class="mt-1 text-xs leading-5 text-gray-500">Last seen <time datetime="2023-01-23T13:23Z">3h ago</time></p>
+    </div>
+  </li>
+  <li class="flex justify-between gap-x-6 py-5">
+    <div class="flex min-w-0 gap-x-4">
+      <img class="h-12 w-12 flex-none rounded-full bg-gray-50" src="https://images.unsplash.com/photo-1519244703995-f4e0f30006d5?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=facearea&facepad=2&w=256&h=256&q=80" alt="">
+      <div class="min-w-0 flex-auto">
+        <p class="text-sm font-semibold leading-6 text-gray-900">Michael Foster</p>
+        <p class="mt-1 truncate text-xs leading-5 text-gray-500">michael.foster@example.com</p>
+      </div>
+    </div>
+    <div class="hidden shrink-0 sm:flex sm:flex-col sm:items-end">
+      <p class="text-sm leading-6 text-gray-900">Co-Founder / CTO</p>
+      <p class="mt-1 text-xs leading-5 text-gray-500">Last seen <time datetime="2023-01-23T13:23Z">3h ago</time></p>
+    </div>
+  </li>
+  <li class="flex justify-between gap-x-6 py-5">
+    <div class="flex min-w-0 gap-x-4">
+      <img class="h-12 w-12 flex-none rounded-full bg-gray-50" src="https://images.unsplash.com/photo-1506794778202-cad84cf45f1d?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=facearea&facepad=2&w=256&h=256&q=80" alt="">
+      <div class="min-w-0 flex-auto">
+        <p class="text-sm font-semibold leading-6 text-gray-900">Dries Vincent</p>
+        <p class="mt-1 truncate text-xs leading-5 text-gray-500">dries.vincent@example.com</p>
+      </div>
+    </div>
+    <div class="hidden shrink-0 sm:flex sm:flex-col sm:items-end">
+      <p class="text-sm leading-6 text-gray-900">Business Relations</p>
+      <div class="mt-1 flex items-center gap-x-1.5">
+        <div class="flex-none rounded-full bg-emerald-500/20 p-1">
+          <div class="h-1.5 w-1.5 rounded-full bg-emerald-500"></div>
+        </div>
+        <p class="text-xs leading-5 text-gray-500">Online</p>
+      </div>
+    </div>
+  </li>
+  <li class="flex justify-between gap-x-6 py-5">
+    <div class="flex min-w-0 gap-x-4">
+      <img class="h-12 w-12 flex-none rounded-full bg-gray-50" src="https://images.unsplash.com/photo-1517841905240-472988babdf9?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=facearea&facepad=2&w=256&h=256&q=80" alt="">
+      <div class="min-w-0 flex-auto">
+        <p class="text-sm font-semibold leading-6 text-gray-900">Lindsay Walton</p>
+        <p class="mt-1 truncate text-xs leading-5 text-gray-500">lindsay.walton@example.com</p>
+      </div>
+    </div>
+    <div class="hidden shrink-0 sm:flex sm:flex-col sm:items-end">
+      <p class="text-sm leading-6 text-gray-900">Front-end Developer</p>
+      <p class="mt-1 text-xs leading-5 text-gray-500">Last seen <time datetime="2023-01-23T13:23Z">3h ago</time></p>
+    </div>
+  </li>
+  <li class="flex justify-between gap-x-6 py-5">
+    <div class="flex min-w-0 gap-x-4">
+      <img class="h-12 w-12 flex-none rounded-full bg-gray-50" src="https://images.unsplash.com/photo-1438761681033-6461ffad8d80?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=facearea&facepad=2&w=256&h=256&q=80" alt="">
+      <div class="min-w-0 flex-auto">
+        <p class="text-sm font-semibold leading-6 text-gray-900">Courtney Henry</p>
+        <p class="mt-1 truncate text-xs leading-5 text-gray-500">courtney.henry@example.com</p>
+      </div>
+    </div>
+    <div class="hidden shrink-0 sm:flex sm:flex-col sm:items-end">
+      <p class="text-sm leading-6 text-gray-900">Designer</p>
+      <p class="mt-1 text-xs leading-5 text-gray-500">Last seen <time datetime="2023-01-23T13:23Z">3h ago</time></p>
+    </div>
+  </li>
+  <li class="flex justify-between gap-x-6 py-5">
+    <div class="flex min-w-0 gap-x-4">
+      <img class="h-12 w-12 flex-none rounded-full bg-gray-50" src="https://images.unsplash.com/photo-1472099645785-5658abf4ff4e?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=facearea&facepad=2&w=256&h=256&q=80" alt="">
+      <div class="min-w-0 flex-auto">
+        <p class="text-sm font-semibold leading-6 text-gray-900">Tom Cook</p>
+        <p class="mt-1 truncate text-xs leading-5 text-gray-500">tom.cook@example.com</p>
+      </div>
+    </div>
+    <div class="hidden shrink-0 sm:flex sm:flex-col sm:items-end">
+      <p class="text-sm leading-6 text-gray-900">Director of Product</p>
+      <div class="mt-1 flex items-center gap-x-1.5">
+        <div class="flex-none rounded-full bg-emerald-500/20 p-1">
+          <div class="h-1.5 w-1.5 rounded-full bg-emerald-500"></div>
+        </div>
+        <p class="text-xs leading-5 text-gray-500">Online</p>
+      </div>
+    </div>
+  </li>
+</ul>

data/app/views/mensa/tables/show.html.slim

@@ -0,0 +1,5 @@
+/= turbo_stream.update "filters-#{@table.table_id}" do
+  = render Mensa::Filters::Component.new(table: @table)
+
+turbo-frame id=@table.table_id target="_top"
+  = render Mensa::View::Component.new(@table)

data/app/views/mensa/tables/show.turbo_stream.slim

@@ -0,0 +1,5 @@
+= turbo_stream.update "filters-#{@table.table_id}" do
+  = render Mensa::Filters::Component.new(table: @table)
+
+= turbo_stream.update @table.table_id do
+  = render Mensa::View::Component.new(@table)

data/bin/importmap

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative "../test/dummy/config/application"
+require "importmap/commands"

data/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/mensa/engine", __dir__)
+APP_PATH = File.expand_path("../test/dummy/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/config/importmap.rb

@@ -0,0 +1,8 @@
+pin "mensa", to: "mensa/application.js", preload: true
+pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true
+pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true
+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true
+pin '@fortawesome/fontawesome-free', to: 'https://ga.jspm.io/npm:@fortawesome/fontawesome-free@6.1.1/js/all.js'
+pin_all_from Mensa::Engine.root.join("app/javascript/mensa/controllers"), under: "mensa/controllers", to: "mensa/controllers", preload: false
+pin_all_from Mensa::Engine.root.join("app/components/mensa"), under: "mensa/components", to: "mensa", preload: false
+pin "@rails/request.js", to: "@rails--request.js.js" # @0.0.9

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  mensa:
+    views:
+      all: All
+    search:
+      component:
+        save: Save
+        cancel: Cancel

data/config/locales/nl.yml

@@ -0,0 +1,11 @@
+nl:
+  mensa:
+    add_filter:
+      component:
+        add_filter: Filter toevoegen
+    views:
+      all: Alles
+    search:
+      component:
+        save: Bewaar
+        cancel: Annuleer

data/config/routes.rb

@@ -0,0 +1,7 @@
+Mensa::Engine.routes.draw do
+  resources :tables do
+    scope module: :tables do
+      resources :filters
+    end
+  end
+end

data/db/migrate/20240201184752_create_mensa_table_views.rb

@@ -0,0 +1,15 @@
+class CreateMensaTableViews < ActiveRecord::Migration[7.1]
+  def change
+    create_table :mensa_table_views, id: :uuid do |t|
+      t.string :table_name
+      t.string :name
+      t.jsonb :data
+
+      t.references :user, null: true, foreign_key: true, type: :uuid
+
+      t.timestamps
+    end
+    add_index :mensa_table_views, :table_name, unique: false
+    add_index :mensa_table_views, :data, using: :gin
+  end
+end

data/lib/generators/mensa/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mensa
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def create_initializer_file
+      template "config/initializers/mensa.rb"
+    end
+
+    def add_route
+      return if Rails.application.routes.routes.detect { |route| route.app.app == Mensa::Engine }
+      route %(mount Mensa::Engine => "/mensa")
+    end
+
+    def copy_migrations
+      rake "mensa:install:migrations"
+    end
+
+    def tailwindcss_config
+      rake "mensa:tailwindcss:config"
+    end
+  end
+end

data/lib/generators/mensa/tailwind_config_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/base'
+
+module Mensa
+  module Generators
+    class TailwindConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Configures tailwind.config.js and application.tailwindcss.css'
+
+      def add_content_to_tailwind_config
+        inject_into_file "config/tailwind.config.js", before: "],\n  theme: {" do
+          "  // Mensa content\n" +
+            %w[/app/views/**/* /app/helpers/**/* /app/controllers/**/* /app/components/**/* /app/javascript/**/*.js /app/assets/**/*.css].map { |path| "    \"#{Mensa::Engine.root}#{path}\"" }.join(",\n") +
+            ",\n  "
+        end
+      end
+
+      def add_content_application_tailwind_css
+        inject_into_file "app/assets/stylesheets/application.tailwind.css", before: "@tailwind base;" do
+          "@import '#{Mensa::Engine.root}/app/assets/stylesheets/mensa/application.css';\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/mensa/templates/config/initializers/mensa.rb

@@ -0,0 +1,22 @@
+Mensa.setup do |config|
+  # Callbacks for exporting of tables
+  config.callbacks = {
+    export_started: lambda do |user_id, table_name|
+    end,
+    export_completed: lambda do |user_id, table_name, context, attachment|
+    end
+  }
+
+  # Override icons in use
+  config.icons = {
+    order_indicator_asc: "fa-solid fa-sort-up",
+    order_indicator_desc: "fa-solid fa-sort-down",
+    order_indicator: "fa-solid fa-sort",
+    control_bar_search: "fa-solid fa-magnifying-glass",
+    control_bar_filter: "fa-solid fa-filter",
+    control_bar_edit: "fa-solid fa-table-columns",
+    control_bar_compress: "fa-solid fa-compress",
+    control_bar_export: "fa-solid fa-file-export",
+    search: "fa-solid fa-magnifying-glass",
+  }
+end