frontpack 0.1.0

data/app/controllers/concerns/frontpack/searchable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Frontpack
+  # Adds dynamic search functionality
+  module Searchable
+    extend ActiveSupport::Concern
+
+    def basic_search(model, approximate_fields = [], exact_fields = [], include_list = nil)
+      search_conditions = prepare_search_fields model.arel_table, exact_fields, exact: true
+      search_conditions += prepare_search_fields model.arel_table, approximate_fields
+
+      query = include_list.present? ? model.includes(include_list) : model
+      query = query.where(*search_conditions) if search_conditions.length.positive?
+
+      query.page(params[:page]).per(params[:per_page])
+    end
+
+    def prepare_search_fields(arel_table, fields, **options)
+      [].tap do |search_conditions|
+        fields.each do |field|
+          val = params[field]
+          next if val.blank?
+
+          if options[:exact]
+            search_conditions.push(arel_table[field].eq(val))
+          else
+            search_conditions.push(arel_table[field].matches(Arel::Nodes::SqlLiteral.new("'%#{val}%'")))
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/frontpack/autocomplete_controller.rb

@@ -0,0 +1,33 @@
+module Frontpack
+  # Autocomplete controller
+  class AutocompleteController < ApplicationController
+    before_action :set_model
+
+    def show
+      query = @model.autocomplete(params[:keyword], **autocomplete_params)
+      data = query.map do |row|
+        if row.is_a? String
+          { id: row, value: row }
+        else
+          {
+            id: row.shift,
+            value: row.join(' ')
+          }
+        end
+      end
+      respond_to do |format|
+        format.json { render json: data }
+      end
+    end
+
+    private
+
+    def set_model
+      @model = params[:model].split('/').map(&:classify).join('::').constantize
+    end
+
+    def autocomplete_params
+      params.permit(*@model.autocomplete_fields)
+    end
+  end
+end

data/app/helpers/frontpack/application_helper.rb

@@ -0,0 +1,7 @@
+module Frontpack
+  module ApplicationHelper
+    def boolean_emoji(boolean)
+      boolean ? '✅' : '❌'
+    end
+  end
+end

data/app/helpers/frontpack/form_builder.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Frontpack
+  # Custom input builders
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    include Rails.application.routes.url_helpers
+    include ActionView::Helpers::UrlHelper
+
+    def enum_field(method, options = {})
+      excluded_keys = options.key?(:except) ? options[:except] : []
+
+      if @object
+        opts = { selected: @object.send(method) }
+        select method, @object.enum_options(method, excluded_keys), opts, options
+      elsif options.key?(:model)
+        model = options[:model]
+        select method, model.enum_options(method, excluded_keys), options.slice(:selected, :include_blank, :prompt), options
+      else
+        select method, [], opts, options
+      end
+    end
+
+    def autocomplete_field(method, options = {})
+      relation = @object.class.reflect_on_association(method)
+      uri = relation.class_name.underscore.sub('::', '/')
+      display_field = relation.klass.autocomplete_display_fields[1]
+      text_field(relation.foreign_key, options.merge('data-url': "/autocomplete/#{uri}", is: 'auto-complete', 'display-value': @object.send(method)&.send(display_field)))
+    end
+
+    def text_field(method, options = {})
+      set_options(method, options) if @object
+      super(method, options)
+    end
+
+    def password_field(method, options = {})
+      set_options(method, options) if @object
+      super
+    end
+
+    def email_field(method, options = {})
+      set_options(method, options) if @object
+      super
+    end
+
+    def text_area(method, options = {})
+      set_options(method, options) if @object
+      super
+    end
+
+    def label(method, text = nil, options = {}, &)
+      set_label_options method, options if @object
+      super(method, text, options, &)
+    end
+
+    def select(method, choices = nil, options = {}, html_options = {}, &)
+      set_options(method, html_options, css_class: Frontpack::FormBuilderOptions.select_class) if @object
+      super
+    end
+
+    def number_field(method, options = {})
+      set_options(method, options) if @object
+
+      super(method, options)
+    end
+
+    def date_field(method, options = {}, _html_options = {})
+      @template.text_field(@object_name, method, objectify_options(options.merge(type: :date)))
+    end
+
+    def switch_field(method, options = {})
+      @template.content_tag(:div, class: 'switch-toggle') do
+        toggle_box = check_box(method, { checked: @object.send(method) }.merge(options))
+        opts = options.merge(for: "#{@object_name}_#{method}")
+        opts[:style] = "--on-icon: '#{options[:'data-on-icon']}';" if options.key? :'data-on-icon'
+        opts[:style] += "--off-icon: '#{options[:'data-off-icon']}';" if options.key? :'data-off-icon'
+        toggle_box + @template.content_tag(:label, nil, opts)
+      end
+    end
+
+    private
+
+    def set_options(method, options, css_class: Frontpack::FormBuilderOptions.input_class)
+      @object.class.validators.map do |validator|
+        next unless validator.attributes.include?(method)
+
+        option_required(options) if validator.is_a? ::ActiveRecord::Validations::PresenceValidator
+        options[:maxlength] = validator.options[:maximum] if validator.is_a? ActiveRecord::Validations::LengthValidator
+        options[:size] = nil
+        set_numericality_options(validator, options) if validator.is_a? ActiveModel::Validations::NumericalityValidator
+      end
+      merge_css_classes(options, css_class)
+    end
+
+    def merge_css_classes(options, css_class)
+      classes = []
+      classes += options[:class].to_s.split if options.key? :class
+      classes << css_class
+      options[:class] = classes.join ' '
+    end
+
+    # @param [Hash] options
+    def option_required(options)
+      if options.key?(:required) && options[:required] == false
+        options.delete(:required)
+        return options
+      end
+
+      options[:required] = true
+    end
+
+    def set_numericality_options(validator, options)
+      if (gt = validator.options[:greater_than])
+        options[:min] = gt
+      end
+      if (lt = validator.options[:less_than])
+        options[:max] = lt
+      end
+      options[:step] = :any
+    end
+
+    def set_label_options(method, options)
+      @object.class.validators.map do |validator|
+        next unless validator.attributes.include?(method)
+
+        options[:'data-required'] = true if validator.is_a?(ActiveRecord::Validations::PresenceValidator)
+      end
+      merge_css_classes options, Frontpack::FormBuilderOptions.label_class
+    end
+  end
+end

data/app/models/concerns/frontpack/auto_completable.rb

@@ -0,0 +1,35 @@
+module Frontpack
+  module AutoCompletable
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_reader :autocomplete_keyword, :autocomplete_fields
+      @autocomplete_display_fields = []
+      @autocomplete_key = :id
+    end
+
+    class_methods do
+      def autocomplete_by(keyword, *extra_filters)
+        @autocomplete_keyword = keyword.to_sym
+        @autocomplete_fields = extra_filters.map(&:to_sym)
+      end
+
+      def autocomplete_with(key, *display_fields)
+        @autocomplete_key = key.to_sym
+        @autocomplete_display_fields = display_fields.map(&:to_sym)
+      end
+
+      def autocomplete(keyword, **params)
+        keyword_field = arel_table[@autocomplete_keyword]
+        condition = Arel::Nodes::SqlLiteral.new("'%#{keyword}%'")
+        query = where(keyword_field.matches(condition))
+        params.each { |key, value| query = query.where(arel_table[key].eq(value)) }
+        query.select(autocomplete_display_fields).pluck(autocomplete_display_fields)
+      end
+
+      def autocomplete_display_fields
+        [@autocomplete_key, *@autocomplete_display_fields]
+      end
+    end
+  end
+end

data/config/importmap.rb

@@ -0,0 +1 @@
+pin_all_from File.expand_path('../app/assets/javascripts/frontpack', __dir__), under: 'frontpack'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Frontpack::Engine.routes.draw do
+  get 'autocomplete/*model/:keyword', to: 'autocomplete#show', as: :autocomplete
+end

data/lib/frontpack/button_to_patch.rb

@@ -0,0 +1,64 @@
+module ActionView
+  module Helpers
+    module UrlHelper
+      def button_to(name = nil, options = nil, html_options = nil, &block)
+        html_options, options = options, name if block_given?
+        html_options ||= {}
+        html_options = html_options.stringify_keys
+
+        url = case options
+                when FalseClass then nil
+                else url_for(options)
+              end
+
+        remote = html_options.delete("remote")
+        params = html_options.delete("params")
+
+        authenticity_token = html_options.delete("authenticity_token")
+
+        method     = (html_options.delete("method").presence || method_for_options(options)).to_s
+        method_tag = BUTTON_TAG_METHOD_VERBS.include?(method) ? method_tag(method) : "".html_safe
+
+        form_id = html_options.delete("form_id") || SecureRandom.hex(8)
+        form_method  = method == "get" ? "get" : "post"
+        form_options = html_options.delete("form") || {}
+        form_options[:class] ||= html_options.delete("form_class") || "button_to"
+        form_options[:method] = form_method
+        form_options[:action] = url
+        form_options[:id] = form_id
+        form_options[:'data-remote'] = true if remote
+
+        request_token_tag = if form_method == "post"
+                              request_method = method.empty? ? "post" : method
+                              token_tag(authenticity_token, form_options: { action: url, method: request_method })
+                            else
+                              ""
+                            end
+
+        html_options = convert_options_to_data_attributes(options, html_options)
+        html_options["type"] = "submit"
+
+
+        html_options["form"] = form_id
+        button = if block_given?
+                   content_tag("button", html_options, &block)
+                 elsif button_to_generates_button_tag
+                   content_tag("button", name || url, html_options, &block)
+                 else
+                   html_options["value"] = name || url
+                   tag("input", html_options)
+                 end
+
+        inner_tags = method_tag.safe_concat(request_token_tag)
+        if params
+          to_form_params(params).each do |param|
+            inner_tags.safe_concat tag(:input, type: "hidden", name: param[:name], value: param[:value],
+                                       autocomplete: "off")
+          end
+        end
+        html = content_tag("form", inner_tags, form_options) + button
+        prevent_content_exfiltration(html)
+      end
+    end
+  end
+end

data/lib/frontpack/engine.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'importmap-rails'
+
+module Frontpack
+  class Engine < ::Rails::Engine
+    isolate_namespace Frontpack
+
+    initializer 'frontpack.importmap', before: 'importmap' do |app|
+      app.config.importmap.paths << root.join('config/importmap.rb')
+      app.config.importmap.cache_sweepers << root.join('app/assets/javascripts')
+    end
+
+    initializer 'frontpack.assets' do |app|
+      app.config.assets.precompile += %w[frontpack_manifest]
+    end
+
+    initializer 'frontpack.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper Frontpack::ApplicationHelper
+      end
+    end
+
+    initializer 'frontpack.active_record' do
+      ActiveRecord::Base.include Frontpack::ExtendedModelTranslations
+    end
+  end
+end

data/lib/frontpack/extended_model_translations.rb

@@ -0,0 +1,31 @@
+module Frontpack
+  module ExtendedModelTranslations
+    extend ActiveSupport::Concern
+    include ActiveModel::Naming
+
+    class_methods do
+      def human_enum_value(enum_name, enum_value)
+        I18n.t("#{i18n_scope}.attributes.#{model_name.i18n_key}.#{enum_name.to_s.pluralize}.#{enum_value}")
+      end
+
+      def enum_options(enum_name, excluded_keys = [])
+        keys = send(enum_name.to_s.pluralize).keys.reject { |item| excluded_keys.include? item.to_sym }
+        keys.collect { |item| [human_enum_value(enum_name, item), item] }
+      end
+    end
+
+    delegate :human_attribute_name, to: :class
+
+    def enum_options(enum_name, excluded_keys = [])
+      self.class.enum_options(enum_name, excluded_keys)
+    end
+
+    def human_enum_name(enum_name)
+      self.human_enum_name(enum_name)
+    end
+
+    def human_enum_value(enum_name)
+      self.class.human_enum_value(enum_name, self[enum_name])
+    end
+  end
+end

data/lib/frontpack/form_builder_options.rb

@@ -0,0 +1,5 @@
+module Frontpack
+  module FormBuilderOptions
+    mattr_accessor :input_class, :label_class, :select_class
+  end
+end

data/lib/frontpack/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Frontpack
+  VERSION = '0.1.0'
+end

data/lib/frontpack.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'frontpack/extended_model_translations'
+require 'frontpack/version'
+require 'frontpack/engine'
+require 'frontpack/form_builder_options'
+require 'frontpack/button_to_patch'
+
+module Frontpack; end

data/lib/generators/frontpack/install_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Frontpack
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __dir__)
+
+    def patch_app_base_classes
+      inject_into_class 'app/controllers/application_controller.rb', ApplicationController, <<-RUBY
+  # Frontpack form builder
+  default_form_builder Frontpack::FormBuilder
+      RUBY
+      copy_file 'initializers/customize_form_with_errors.rb', 'config/initializers/customize_form_with_errors.rb'
+    end
+
+    def add_frontpack_assets
+      prepend_file 'app/assets/stylesheets/application.scss', <<~SCSS
+        @use 'frontpack/frontpack' with (
+          $theme-mode: 'dark',
+          $background: #2c0408,
+          $highlight: #dcac0b,
+        );
+
+      SCSS
+    end
+
+    def copy_layout
+      copy_file 'views/layouts/_form-errors.html.slim', 'app/views/layouts/_form-errors.html.slim'
+      copy_file 'views/layouts/_navigation.html.slim', 'app/views/layouts/_navigation.html.slim'
+      copy_file 'views/layouts/errors.html.slim', 'app/views/layouts/errors.html.slim'
+      template 'views/layouts/application.html.slim', 'app/views/layouts/application.html.slim'
+    end
+
+    def copy_locale
+      copy_file 'locales/frontpack.en.yml', 'config/locales/frontpack.en.yml'
+    end
+  end
+end

data/lib/generators/frontpack/locale_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Frontpack
+  class LocaleGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __dir__)
+
+    def install
+      copy_file 'locale/frontpack.en_US.yml', 'config/locale/frontpack.en_US.yml'
+    end
+  end
+end

data/lib/generators/templates/initializers/customize_form_with_errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Disable the form_with_errors feature
+module ActionView
+  module Helpers
+    module Tags
+      # Allows access to method name
+      class Base
+        attr_reader :method_name
+      end
+    end
+  end
+end
+
+ActionView::Base.field_error_proc = proc do |html_tag, instance|
+  if instance.is_a? ActionView::Helpers::Tags::Label
+    html_tag
+  else
+    class_attr_index = html_tag.index 'class="'
+
+    if class_attr_index
+      html_tag.insert class_attr_index + 7, 'error '
+    else
+      html_tag.insert html_tag.index('>'), ' class=error'
+    end
+
+    # rubocop:disable Rails/OutputSafety
+    html_tag.safe_concat "<i>#{instance.object.errors[instance.method_name][0].capitalize}</i>"
+    # rubocop:enable Rails/OutputSafety
+  end
+end

data/lib/generators/templates/locales/frontpack.en.yml

@@ -0,0 +1,43 @@
+---
+en:
+  sign_in: Sign in
+  sign_out: Sign out
+  sign_up: Create account
+  recover_password: Recover password
+  resend_confirmation: Resend confirmation instructions
+  resend_unlock: Resend unlock instructions
+  home: Home
+  new: New
+  edit: Edit
+  update: Update
+  save: Save
+  delete: Delete
+  cancel: Cancel
+  back: Back
+  copy: Copy
+  created_successfully: "%{resource_name} created"
+  updated_successfully: "%{resource_name} updated"
+  deleted_successfully: "%{resource_name} destroyed"
+  admin_privileges_required: This resource requires admin rights
+  are_you_sure?: Are you sure?
+  ago: ago
+
+  activerecord:
+    attributes:
+      default_fields: &default_fields
+        created_at: Created at
+        updated_at: Updated at
+  views:
+    pagination:
+      last: '>>'
+      next: '>'
+      previous: '<'
+      first: '<<'
+      truncate: ...
+  layouts:
+    application:
+      loading: Loading...
+
+  status:
+    404: The resource you are looking for does not exist
+    500: The server encountered an internal error and was unable to complete your request

data/lib/generators/templates/views/layouts/_form-errors.html.slim

@@ -0,0 +1,3 @@
+- if instance.errors.any?
+  - instance.errors.each do |error|
+    text-box.col-12.danger( icon = 'warning' )= "#{error.attribute} #{error.message}"

data/lib/generators/templates/views/layouts/_navigation.html.slim

@@ -0,0 +1 @@
+= link_to t(:home), root_url

data/lib/generators/templates/views/layouts/application.html.slim

@@ -0,0 +1,37 @@
+doctype html
+html
+  head
+    / TODO: Replace "Frontpack" with the desired default application title
+    title = content_for?(:title) ? yield(:title) : 'Frontpack'
+    meta(content = 'text/html;charset=UTF-8' http-equiv = 'Content-Type')
+    meta(content = 'width=device-width,initial-scale=1' name = 'viewport')
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag 'application', 'data-turbo-track': 'reload'
+    = javascript_importmap_tags
+  body
+    header#header
+      toggle-button#btn-menu.md-hidden.lg-hidden(type='toggle' data-icon="menu" target="main-menu" visible-class="-" hidden-class="sm-hidden")
+      = link_to root_url, id: :logo do
+        / TODO: Replace this image_tag with your logo
+        = image_tag 'logo.svg'
+      nav#main-menu.sm-hidden
+        = render 'layouts/navigation'
+      #profile
+    - if content_for? :breadcrumbs
+      nav#breadcrumbs
+        = link_to t(:home), root_url, class: 'no-underscore'
+        |  /
+        = yield :breadcrumbs
+    #messages
+      - flash.each do |type, message|
+        text-box(class=type) = message
+    section#content
+      - if content_for? :actions
+        #actions = yield :actions
+      = yield
+    footer#footer
+      / TODO: Replace "Frontpack" with the desired copyright text
+      | © #{Time.zone.today.year} - Frontpack
+
+    #loading= t('.loading')

data/lib/generators/templates/views/layouts/errors.html.slim

@@ -0,0 +1,19 @@
+html
+  head
+    meta(content = 'text/html;charset=UTF-8' http-equiv = 'Content-Type')
+    title Genesis
+    meta( content = 'width=device-width,initial-scale=1' name = 'viewport' )
+    = csrf_meta_tags
+    = csp_meta_tag
+    = stylesheet_link_tag 'application', 'data-turbo-track': 'reload'
+    = javascript_include_tag 'application', 'data-turbo-track': 'reload', defer: true
+  body
+    header#header
+      = link_to root_url do
+        = image_tag 'logo.svg', id: :logo
+      nav#main-menu
+      #profile
+    #messages
+    section#content= yield
+    footer#footer
+      | © #{Time.zone.today.year} - Genesis

data/lib/generators/templates/views/layouts/mailer.html.slim

@@ -0,0 +1,6 @@
+html
+  head
+    title Genesis
+    meta( content = 'text/html; charset=utf-8' http-equiv = 'Content-Type' )
+  body
+    = yield

data/lib/generators/templates/views/layouts/mailer.text.slim

@@ -0,0 +1 @@
+= yield

data/lib/tasks/frontpack_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :frontpack do
+#   # Task goes here
+# end

data/lib/templates/rails/file_utils/searchable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Adds dynamic search functionality
+module Searchable
+  extend ActiveSupport::Concern
+
+  def basic_search(model, approximate_fields = [], exact_fields = [], include_list = nil)
+    search_conditions = prepare_search_fields model.arel_table, exact_fields, exact: true
+    search_conditions += prepare_search_fields model.arel_table, approximate_fields
+
+    query = include_list.present? ? model.includes(include_list) : model
+    query = query.where(*search_conditions) if search_conditions.length.positive?
+
+    query.page(params[:page])
+  end
+
+  def prepare_search_fields(arel_table, fields, **options)
+    [].tap do |search_conditions|
+      fields.each do |field|
+        next if (val = params[field]).blank?
+
+        if options[:exact]
+          search_conditions.push(arel_table[field].eq(val))
+        else
+          search_conditions.push(arel_table[field].matches(Arel::Nodes::SqlLiteral.new("'%#{val}%'")))
+        end
+      end
+    end
+  end
+end