templet_rails 0.1.0 → 0.2.0

data/app/controllers/templet_rails/application_controller.rb

@@ -0,0 +1,5 @@
+module TempletRails
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/templet/constants.rb

@@ -0,0 +1,54 @@
+
+module Templet
+  # Bootstrap 3.6 HTML classes
+  module Constants
+    BS_SELECTED = 'active'
+
+    BS_FORM = 'form-horizontal'
+    BS_FORM_INLINE = 'form form-inline'
+
+    #BS_FORM_HELP_BLOCK = 'help-block'
+
+    BS_LIST_UNSTYLED = 'list-unstyled'
+    BS_LIST_INLINE = 'list-inline'
+
+    BS_PANEL = 'panel panel-danger'
+    BS_PANEL_HEADING = 'panel-heading'
+    BS_PANEL_TITLE = 'panel-title'
+    BS_PANEL_BODY = 'panel-body'
+
+    BS_BUTTON = 'btn'
+
+    BS_BUTTON_SUBMIT = "#{BS_BUTTON} #{BS_BUTTON}-primary"
+    BS_BUTTON_SUBMIT_SEARCH = "#{BS_BUTTON} #{BS_BUTTON}-default"
+
+    BS_BUTTON_TYPE = 'default'
+    BS_BUTTON_SIZE = 'md'
+
+    BS_BUTTON_GROUP = "#{BS_BUTTON}-group"
+    BS_BUTTON_GROUP_VERTICAL = "#{BS_BUTTON_GROUP}-vertical"
+    BS_BUTTON_GROUP_JUSTIFIED = "#{BS_BUTTON_GROUP}-justified"
+
+    BS_TOOLBAR = "toolbar"
+    BS_BUTTON_TOOLBAR = "#{BS_BUTTON}-#{BS_TOOLBAR}"
+
+    BS_BUTTON_DROPDOWN = "dropdown-menu"
+
+    BS_BUTTON_BLOCK = 'btn btn-info btn-md btn-block'
+
+    BS_LIST_GROUP = "list-group"
+    BS_LIST_GROUP_ITEM = "list-group-item"
+
+    BS_NAV = "nav"
+    BS_NAV_PILLS = "#{BS_NAV} nav-pills"
+    BS_NAV_TABS = "#{BS_NAV} nav-tabs"
+    BS_NAV_PILLS_STACKED = "nav-stacked"
+
+    BS_TABLE = 'table table-responsive table-hover table-condensed table-striped'
+
+    # TODO:
+    BS_COL = 'col-md-'
+    BS_COL_OFFSET = 'col-md-offset-'
+  end
+end
+

data/app/helpers/templet/forms/bs_form.rb

@@ -0,0 +1,73 @@
+
+module Templet
+  module Forms
+    # Entry point for rendering forms
+    # It writes out the HTML form tag, error meesages and hidden fields
+    class BsForm < Templet::Component::Partial
+      include Constants
+
+      # Renders the outside of an HTML form
+      # it renders the <form> tag, the model's errors, and two hiiden fields
+      def call(url: nil,
+               remote: false,
+               html_class: nil,
+               inline: false,
+               method: nil)
+        super() do
+          url, model = url.for_form if url.respond_to?(:for_form)
+
+          url = url_for(url) if Array === url or ActiveRecord::Base === url
+
+          atts = form_atts(html_class, remote, inline, method)
+
+          method ||= http_method(model)
+
+          hidden_form_fields = if get?(method)
+              []
+            else
+              [ hidden_field_tag(:authenticity_token, form_authenticity_token),
+                hidden_field_tag(:_method, method) ]
+            end
+
+          [ BsFormErrors.new(self).(model),
+            form(atts.merge action: url) { hidden_form_fields << yield(self) }
+          ]
+        end
+      end
+
+      # Shortcut method used in rendering a REST form with specified fields
+      def self.call(renderer, record, **form_group_options)
+        form_group = BsFormGroup.new(renderer, record, **form_group_options)
+
+        return BsFormField.new(form_group), form_group
+      end
+
+      private
+
+      def get?(method)
+        method&.to_s =~ /get/i
+      end
+
+      def form_atts(html_class, remote, inline, method)
+        html_class ||= form_class(inline)
+
+        atts = { class: html_class, role: 'form' }
+
+        atts[:method] = get?(method) ? 'get' : 'post'
+
+        atts[:"data-remote"] = 'true' if remote
+
+        atts
+      end
+
+      def form_class(inline=false)
+        inline ? BS_FORM_INLINE : BS_FORM
+      end
+
+      def http_method(record)
+        record&.persisted? ? 'patch' : 'post'
+      end
+    end
+  end
+end
+

data/app/helpers/templet/forms/bs_form_errors.rb

@@ -0,0 +1,38 @@
+
+module Templet
+  module Forms
+    # Shows error messages from validation failures
+    class BsFormErrors < Templet::Component::Partial
+      include Constants
+
+      def call(model)
+        if model and model.errors.any?
+          super() do
+            div id: "error_expl", class: BS_PANEL do
+              [ div(BS_PANEL_HEADING) { h3(error_title(model), BS_PANEL_TITLE) },
+
+                div(BS_PANEL_BODY) do
+                  ul(BS_LIST_UNSTYLED) do
+                    model.errors.full_messages.map {|msg| li msg }
+                  end
+                end
+              ]
+            end
+          end
+        end
+      end
+
+      private
+
+      def error_title(model)
+        compose do
+          error_count = model.errors.count
+          model_name = model.class.name.underscore
+
+          "#{pluralize error_count, "error"} on #{model_name}"
+        end
+      end
+    end
+  end
+end
+

data/app/helpers/templet/forms/bs_form_field.rb

@@ -0,0 +1,114 @@
+
+module Templet
+  module Forms
+    # Renders the different types of HTML input fields
+    class BsFormField < Struct.new(:form_group)
+      include Constants
+
+      def text(field_name, mandatory: false, help: nil)
+        field_class = field_class()
+
+        group_opts = { mandatory: mandatory, help: help }
+
+        form_group.(field_name, **group_opts) do |renderer, record_name|
+          renderer.call do
+            text_field record_name, field_name, class: field_class
+          end
+        end
+      end
+
+      def text_area(field_name, rows: 2, mandatory: false, help: nil)
+        field_class = field_class()
+
+        group_opts = { mandatory: mandatory, help: help }
+
+        form_group.(field_name, **group_opts) do |renderer, record_name|
+          renderer.call do
+            text_area record_name, field_name, class: field_class, rows: rows
+          end
+        end
+      end
+
+      def check_box(field_name, help: nil)
+        form_group.(field_name, help: help) do |renderer, record_name|
+          renderer.call do
+            check_box record_name, field_name
+          end
+        end
+      end
+
+      def check_box_inline(field_name, help: nil)
+        form_group.checkbox(field_name, help: help) do |renderer, record_name|
+          renderer.call do
+            check_box record_name, field_name
+          end
+        end
+      end
+
+      def select(field_name, selections, select_id: :id,
+                                         select_name: :name,
+                                         include_blank: false,
+                                         size: nil,
+                                         help: nil)
+        html_options = { class: field_class }
+
+        group_opts = { input_size: size, help: help }
+
+        options = { include_blank: include_blank }
+
+        form_group.(field_name, **group_opts) do |renderer, record_name|
+          renderer.call do
+            collection_select record_name, field_name,
+                              selections, select_id, select_name,
+                              options, html_options
+          end
+        end
+      end
+
+      DATE_INLINE_STYLE = 'display: inline; width: auto; float: left;'
+
+      def date(field_name, include_blank: true, help: nil)
+        html_options = { class: field_class, style: DATE_INLINE_STYLE }
+
+        options = { include_blank: include_blank }
+
+        form_group.(field_name, help: help) do |renderer, record_name|
+          renderer.call do
+            date_select record_name, field_name, options, html_options
+          end
+        end
+      end
+
+      def datetime(field_name, include_blank: true, help: nil)
+        html_options = { class: field_class, style: DATE_INLINE_STYLE }
+
+        options = { include_blank: include_blank,
+                    datetime_separator: '', time_separator: '' }
+
+        form_group.(field_name, help: help) do |renderer, record_name|
+          renderer.call do
+            datetime_select record_name, field_name, options, html_options
+          end
+        end
+      end
+
+      def submit(text: 'Submit', html_class: BS_BUTTON_SUBMIT,
+                 offset: nil, height: form_group.height)
+        html_class += " btn-#{height}" if height
+
+        offset ||= form_group.label_cols
+
+        form_group.renderer.call do
+          submit_button = button(text, html_class, type: 'submit')
+
+          div(:form_group) { div submit_button, "#{BS_COL_OFFSET}#{offset}" }
+        end
+      end
+
+      def field_class
+        form_group.field_class
+      end
+    end
+  end
+end
+

data/app/helpers/templet/forms/bs_form_group.rb

@@ -0,0 +1,115 @@
+
+module Templet
+  module Forms
+    # Renders the various tags that surround a Bootstrap form field
+    class BsFormGroup < Templet::Component::Partial
+      include Constants
+
+      MANDATORY_MARKER = ' *'
+
+      NBSP = ' &nbsp; '
+
+      attr_accessor :record, :record_name
+
+      attr_accessor :field_cols, :input_cols, :height
+
+      attr_accessor :label_cols, :hide_label
+
+      def initialize(renderer, record, record_name: record.model_name.singular,
+                                       field_cols: 12,
+                                       input_cols: 8,
+                                       label_cols: 2,
+                                       height: nil,
+                                       hide_label: false)
+        super(renderer)
+
+        self.record = record
+
+        self.record_name = record_name
+
+        self.field_cols = field_cols
+        self.input_cols = input_cols
+
+        self.height = height
+
+        self.label_cols = label_cols
+
+        self.hide_label = hide_label
+      end
+
+      # An alternative constructor for plain (usually inline) forms
+      def self.call(renderer, model=nil, hide_label: true, height: 'md')
+        new renderer, model, record_name: '',
+                             field_cols: nil,
+                             input_cols: nil,
+                             label_cols: nil,
+                             height: height,
+                             hide_label: hide_label
+      end
+
+      def call(field_name, label_name: nil, field_size: nil,
+                           input_size: nil, label_size: nil,
+                           mandatory: false, help: nil)
+        label_name ||= field_name.to_s.sub(/_id$/, '').tr('_', ' ').capitalize
+
+        label_name += mandatory ? MANDATORY_MARKER : ''
+
+        field_class = "form-group #{col_class field_size || field_cols}"
+
+        if hide_label
+          label_class = "sr-only"
+        else
+          label_class = "control-label #{col_class label_size || label_cols}"
+
+          label_class += height ? " input-#{height}" : ''
+        end
+
+        input_class = col_class(input_size || input_cols)
+
+        inner_self = self
+
+        renderer.call do
+          div(field_class) do
+            [ label(record_name, field_name, label_name, class: label_class),
+              div(input_class) do
+                [ yield(self, record_name, inner_self), *help_block(help) ]
+              end
+            ]
+          end
+        end
+      end
+
+      # Checkboxes can be rendered with a different form-group layout
+      def checkbox(field_name, text=field_name.to_s.capitalize, help: nil)
+        inner_self = self
+
+        renderer.call do
+          div("form-group #{col_class field_cols}") do
+            div :checkbox do
+              _label col_class(label_cols, offset: true) do
+                [ NBSP,
+                  yield(self, record_name, inner_self),
+                  text,
+                  help_block(help) || '<br><br>'
+                ]
+              end
+            end
+          end
+        end
+      end
+
+      def help_block(help)
+        "<p class='help-block'>#{help}</p>" if help
+      end
+
+      def col_class(cols, offset=false)
+        "#{offset ? BS_COL_OFFSET : BS_COL}#{cols}" if cols
+      end
+
+      def field_class
+        'form-control' + (height ? " input-#{height}" : '')
+      end
+    end
+  end
+end
+

data/app/helpers/templet/layouts/html_rails.rb

@@ -0,0 +1,36 @@
+
+module Templet
+  module Layouts
+    # Renders a standard HTML layout
+    # Basically, it's the same layout that Rails uses
+    class HtmlRails < Templet::Component::Layout
+      APP = 'application'
+
+      TURBOS = { 'data-turbolinks-track' => true }
+
+      SCALE = '<meta name="viewport" content="width=device-width, initial-scale=1.0">'
+
+      DESC_TEMPLATE = '<meta name="description" content="%s">'
+
+      def call(title, description='', head_extras: nil)
+        super() do
+          header = [ SCALE,
+                     (DESC_TEMPLATE % description),
+                     _title(title),
+                     stylesheet_link_tag(APP, TURBOS.merge(media: 'all')),
+                     javascript_include_tag(APP, TURBOS),
+                     csrf_meta_tags,
+                     head_extras,
+                     rear_head ]
+
+          html { [ head(header), body(yield renderer) ] }
+        end
+      end
+
+      private
+
+      def rear_head
+      end
+    end
+  end
+end

data/app/helpers/templet/links.rb

@@ -0,0 +1,28 @@
+
+module Templet
+  # Some shortcut methods for the main library classes
+  module Links
+    extend self
+
+    def collection(*args)
+      BsLinkSetCollection.new *args
+    end
+
+    def navigation(*args)
+      BsLinkSetNavigation.new *args
+    end
+
+    def rest_link_procs(*args)
+      RestLinkProcs.new *args
+    end
+
+    def btn_class(*args)
+      BsBtnClass.new *args
+    end
+
+    def link_text(*args)
+      RestLinkText.new *args
+    end
+  end
+end
+