jquard 0.0.1 → 0.2.0

data/lib/jquard/schemas/fields/field.rb

@@ -0,0 +1,79 @@
+module Jquard
+  module Schemas
+    module Fields
+      class Field
+        include Jquard::ComponentDispatch
+
+        UNSET = Object.new.freeze
+
+        attr_reader :name
+
+        def self.make(name)
+          new(name)
+        end
+
+        def initialize(name)
+          @name = name.to_sym
+        end
+
+        def label(value = nil)
+          return @label || name.to_s.humanize if value.nil?
+
+          @label = value
+          self
+        end
+
+        def placeholder(value = nil)
+          return @placeholder if value.nil?
+
+          @placeholder = value
+          self
+        end
+
+        def helper_text(value = nil)
+          return @helper_text if value.nil?
+
+          @helper_text = value
+          self
+        end
+
+        def default(value = UNSET)
+          return @default if value.equal?(UNSET)
+
+          @default = value
+          self
+        end
+
+        def required(value = true)
+          @required = value
+          self
+        end
+
+        def required?
+          !!@required
+        end
+
+        def disabled(value = true)
+          @disabled = value
+          self
+        end
+
+        def disabled?
+          !!@disabled
+        end
+
+        def column_span(count = nil)
+          return @column_span if count.nil?
+
+          @column_span = count
+          self
+        end
+
+        def column_span_full
+          @column_span = :full
+          self
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/fields/hidden.rb

@@ -0,0 +1,8 @@
+module Jquard
+  module Schemas
+    module Fields
+      class Hidden < Field
+      end
+    end
+  end
+end

data/lib/jquard/schemas/fields/select.rb

@@ -0,0 +1,18 @@
+module Jquard
+  module Schemas
+    module Fields
+      class Select < Field
+        def options(map = nil)
+          return @options || {} if map.nil?
+
+          @options = map
+          self
+        end
+
+        def choices
+          options.map { |value, label| [ label, value.to_s ] }
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/fields/text_input.rb

@@ -0,0 +1,33 @@
+module Jquard
+  module Schemas
+    module Fields
+      class TextInput < Field
+        def email(value = true)
+          @input_type = :email if value
+          self
+        end
+
+        def password(value = true)
+          @input_type = :password if value
+          self
+        end
+
+        def numeric(value = true)
+          @input_type = :number if value
+          self
+        end
+
+        def input_type
+          @input_type || :text
+        end
+
+        def max_length(count = nil)
+          return @max_length if count.nil?
+
+          @max_length = count
+          self
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/fields/textarea.rb

@@ -0,0 +1,14 @@
+module Jquard
+  module Schemas
+    module Fields
+      class Textarea < Field
+        def rows(count = nil)
+          return @rows || 4 if count.nil?
+
+          @rows = count
+          self
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/fields/toggle.rb

@@ -0,0 +1,8 @@
+module Jquard
+  module Schemas
+    module Fields
+      class Toggle < Field
+      end
+    end
+  end
+end

data/lib/jquard/schemas/layouts/grid.rb

@@ -0,0 +1,11 @@
+module Jquard
+  module Schemas
+    module Layouts
+      class Grid < Layout
+        def self.make(columns = 2)
+          new.columns(columns)
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/layouts/layout.rb

@@ -0,0 +1,23 @@
+module Jquard
+  module Schemas
+    module Layouts
+      class Layout
+        include Jquard::ComponentDispatch
+
+        def schema(components = nil)
+          return @schema ||= [] if components.nil?
+
+          @schema = components
+          self
+        end
+
+        def columns(count = nil)
+          return @columns || 1 if count.nil?
+
+          @columns = count
+          self
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/layouts/section.rb

@@ -0,0 +1,24 @@
+module Jquard
+  module Schemas
+    module Layouts
+      class Section < Layout
+        attr_reader :heading
+
+        def self.make(heading = nil)
+          new(heading)
+        end
+
+        def initialize(heading = nil)
+          @heading = heading
+        end
+
+        def description(value = nil)
+          return @description if value.nil?
+
+          @description = value
+          self
+        end
+      end
+    end
+  end
+end

data/lib/jquard/schemas/schema.rb

@@ -0,0 +1,61 @@
+module Jquard
+  module Schemas
+    class Schema
+      def components(list = nil)
+        return @components ||= [] if list.nil?
+
+        @components = list
+        self
+      end
+
+      def fields
+        collect_fields(components)
+      end
+
+      def field_names
+        fields.map(&:name)
+      end
+
+      def apply_defaults(record)
+        fields.each do |field|
+          next if field.default.nil? || !record[field.name].nil?
+
+          record[field.name] = field.default
+        end
+        record
+      end
+
+      def apply_default_fields(model)
+        return self if components.any?
+
+        skipped = [ model.primary_key, "created_at", "updated_at" ]
+        components(model.columns.reject { |column| skipped.include?(column.name) }.map { |column| default_field_for(model, column) })
+      end
+
+      private
+
+      def collect_fields(list)
+        list.flat_map do |component|
+          component.is_a?(Fields::Field) ? component : collect_fields(component.schema)
+        end
+      end
+
+      def default_field_for(model, column)
+        name = column.name.to_sym
+
+        if (enum = model.defined_enums[column.name])
+          Fields::Select.make(name).options(enum.keys.index_with(&:humanize))
+        else
+          case column.type
+          when :text then Fields::Textarea.make(name)
+          when :boolean then Fields::Toggle.make(name)
+          when :date then Fields::DatePicker.make(name)
+          when :datetime then Fields::DateTimePicker.make(name)
+          when :integer, :decimal, :float then Fields::TextInput.make(name).numeric
+          else Fields::TextInput.make(name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/actions/action.rb

@@ -0,0 +1,27 @@
+module Jquard
+  module Tables
+    module Actions
+      class Action
+        include Jquard::ComponentDispatch
+
+        def self.make
+          new
+        end
+
+        def label(value = nil)
+          return @label || default_label if value.nil?
+
+          @label = value
+          self
+        end
+
+        def icon(value = nil)
+          return @icon || default_icon if value.nil?
+
+          @icon = value
+          self
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/actions/delete_action.rb

@@ -0,0 +1,38 @@
+module Jquard
+  module Tables
+    module Actions
+      class DeleteAction < Action
+        def confirm(value = nil)
+          return @confirm || "Are you sure you would like to do this?" if value.nil?
+
+          @confirm = value
+          self
+        end
+
+        def confirm_heading(value = nil)
+          return @confirm_heading if value.nil?
+
+          @confirm_heading = value
+          self
+        end
+
+        def confirm_button(value = nil)
+          return @confirm_button || label if value.nil?
+
+          @confirm_button = value
+          self
+        end
+
+        private
+
+        def default_label
+          "Delete"
+        end
+
+        def default_icon
+          "trash"
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/actions/edit_action.rb

@@ -0,0 +1,17 @@
+module Jquard
+  module Tables
+    module Actions
+      class EditAction < Action
+        private
+
+        def default_label
+          "Edit"
+        end
+
+        def default_icon
+          "pencil-square"
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/columns/column.rb

@@ -0,0 +1,48 @@
+module Jquard
+  module Tables
+    module Columns
+      class Column
+        include Jquard::ComponentDispatch
+
+        attr_reader :name
+
+        def self.make(name)
+          new(name)
+        end
+
+        def initialize(name)
+          @name = name.to_sym
+        end
+
+        def label(value = nil)
+          return @label || name.to_s.humanize if value.nil?
+
+          @label = value
+          self
+        end
+
+        def searchable(value = true)
+          @searchable = value
+          self
+        end
+
+        def searchable?
+          !!@searchable
+        end
+
+        def sortable(value = true)
+          @sortable = value
+          self
+        end
+
+        def sortable?
+          !!@sortable
+        end
+
+        def state_for(record)
+          record.public_send(name)
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/columns/icon_column.rb

@@ -0,0 +1,16 @@
+module Jquard
+  module Tables
+    module Columns
+      class IconColumn < Column
+        def boolean(value = true)
+          @boolean = value
+          self
+        end
+
+        def boolean?
+          !!@boolean
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/columns/text_column.rb

@@ -0,0 +1,48 @@
+module Jquard
+  module Tables
+    module Columns
+      class TextColumn < Column
+        def format(&block)
+          @formatter = block
+          self
+        end
+
+        def date_time(pattern = "%b %-d, %Y %H:%M")
+          format { |state| state.strftime(pattern) }
+        end
+
+        def badge(value = true)
+          @badge = value
+          self
+        end
+
+        def badge?
+          !!@badge
+        end
+
+        def color(map)
+          @color_map = map.transform_keys(&:to_sym)
+          self
+        end
+
+        def color_for(state)
+          (@color_map || {}).fetch(state.to_s.to_sym, :gray)
+        end
+
+        def limit(count)
+          @limit = count
+          self
+        end
+
+        def display_value(record)
+          state = state_for(record)
+          return "" if state.nil?
+
+          value = @formatter ? @formatter.call(state) : state
+          value = value.to_s
+          @limit ? value.truncate(@limit) : value
+        end
+      end
+    end
+  end
+end

data/lib/jquard/tables/components.rb

@@ -0,0 +1,10 @@
+module Jquard
+  module Tables
+    module Components
+      TextColumn = Jquard::Tables::Columns::TextColumn
+      IconColumn = Jquard::Tables::Columns::IconColumn
+      EditAction = Jquard::Tables::Actions::EditAction
+      DeleteAction = Jquard::Tables::Actions::DeleteAction
+    end
+  end
+end

data/lib/jquard/tables/query.rb

@@ -0,0 +1,71 @@
+module Jquard
+  module Tables
+    class Query
+      PER_PAGE_OPTIONS = [ 10, 25, 50 ].freeze
+      DEFAULT_PER_PAGE = 10
+
+      Result = Struct.new(
+        :records, :total_count, :page, :pages, :per_page, :from, :to, :sort, :direction,
+        keyword_init: true
+      )
+
+      def initialize(table:, scope:, params:)
+        @table = table
+        @scope = scope
+        @params = params.to_h.symbolize_keys
+      end
+
+      def result
+        scope = search(@scope)
+        scope, sort, direction = order(scope)
+        total_count = scope.count
+        per_page = resolve_per_page
+        pages = [ (total_count.to_f / per_page).ceil, 1 ].max
+        page = @params[:page].to_i.clamp(1, pages)
+        records = scope.offset((page - 1) * per_page).limit(per_page)
+
+        Result.new(
+          records: records,
+          total_count: total_count,
+          page: page,
+          pages: pages,
+          per_page: per_page,
+          from: total_count.zero? ? 0 : (page - 1) * per_page + 1,
+          to: [ page * per_page, total_count ].min,
+          sort: sort,
+          direction: direction
+        )
+      end
+
+      private
+
+      def search(scope)
+        term = @params[:q].to_s.strip
+        return scope if term.empty? || @table.searchable_columns.empty?
+
+        pattern = "%#{ActiveRecord::Base.sanitize_sql_like(term)}%"
+        condition = @table.searchable_columns
+          .map { |column| scope.model.arel_table[column.name].matches(pattern) }
+          .reduce(:or)
+        scope.where(condition)
+      end
+
+      def order(scope)
+        direction = %w[asc desc].include?(@params[:direction].to_s) ? @params[:direction].to_s : "asc"
+
+        if (column = @table.sortable_column(@params[:sort]))
+          [ scope.order(column.name => direction), column.name.to_s, direction ]
+        elsif (default = @table.default_sort)
+          [ scope.order(default[0] => default[1]), nil, default[1].to_s ]
+        else
+          [ scope.order(scope.model.primary_key => :asc), nil, "asc" ]
+        end
+      end
+
+      def resolve_per_page
+        requested = @params[:per_page].to_i
+        PER_PAGE_OPTIONS.include?(requested) ? requested : DEFAULT_PER_PAGE
+      end
+    end
+  end
+end

data/lib/jquard/tables/table.rb

@@ -0,0 +1,44 @@
+module Jquard
+  module Tables
+    class Table
+      def columns(list = nil)
+        return @columns ||= [] if list.nil?
+
+        @columns = list
+        self
+      end
+
+      def default_sort(name = nil, direction = :asc)
+        return @default_sort if name.nil?
+
+        @default_sort = [ name.to_sym, direction.to_sym ]
+        self
+      end
+
+      def record_actions(list = nil)
+        return @record_actions ||= [] if list.nil?
+
+        @record_actions = list
+        self
+      end
+
+      def searchable_columns
+        columns.select(&:searchable?)
+      end
+
+      def searchable?
+        searchable_columns.any?
+      end
+
+      def sortable_column(name)
+        columns.find { |column| column.sortable? && column.name.to_s == name.to_s }
+      end
+
+      def apply_default_columns(model)
+        return self if columns.any?
+
+        columns(model.column_names.map { |name| Columns::TextColumn.make(name) })
+      end
+    end
+  end
+end