formular 0.2.0

data/lib/formular/builders/bootstrap3_inline.rb

@@ -0,0 +1,10 @@
+require 'formular/builders/bootstrap3'
+module Formular
+  module Builders
+    class Bootstrap3Inline < Formular::Builders::Bootstrap3
+      Form = Class.new(Formular::Element::Form) { set_default :class, ['form-inline'] }
+
+      element_set form: Form
+    end # class Bootstrap3Inline
+  end # module Builders
+end # module Formular

data/lib/formular/builders/bootstrap4.rb

@@ -0,0 +1,36 @@
+require 'formular/builders/basic'
+require 'formular/element/bootstrap4'
+require 'formular/element/bootstrap3'
+require 'formular/element/bootstrap3/input_group'
+
+module Formular
+  module Builders
+    class Bootstrap4 < Formular::Builders::Basic
+      element_set(
+        error_notification: Formular::Element::Bootstrap3::ErrorNotification,
+        error: Formular::Element::Bootstrap4::Error,
+        hint: Formular::Element::Bootstrap4::Hint,
+        input: Formular::Element::Bootstrap4::Input,
+        input_group: Formular::Element::Bootstrap3::InputGroup,
+        checkbox: Formular::Element::Bootstrap4::StackedCheckbox,
+        radio: Formular::Element::Bootstrap4::StackedRadio,
+        select: Formular::Element::Bootstrap3::Select,
+        custom_select: Formular::Element::Bootstrap4::CustomSelect,
+        custom_file: Formular::Element::Bootstrap4::CustomFile,
+        custom_radio: Formular::Element::Bootstrap4::Inline::CustomRadio,
+        custom_checkbox: Formular::Element::Bootstrap4::Inline::CustomCheckbox,
+        custom_stacked_radio: Formular::Element::Bootstrap4::CustomStackedRadio,
+        custom_stacked_checkbox: Formular::Element::Bootstrap4::CustomStackedCheckbox,
+        inline_radio: Formular::Element::Bootstrap4::InlineRadio,
+        inline_checkbox: Formular::Element::Bootstrap4::InlineCheckbox,
+        label: Formular::Element::Label,
+        checkable_group_label: Formular::Element::Legend,
+        textarea: Formular::Element::Bootstrap3::Textarea,
+        wrapper: Formular::Element::Bootstrap4::Wrapper,
+        error_wrapper: Formular::Element::Bootstrap4::ErrorWrapper,
+        submit: Formular::Element::Bootstrap4::Submit,
+        row: Formular::Element::Bootstrap3::Row
+      )
+    end # class Bootstrap4
+  end # module Builders
+end # module Formular

data/lib/formular/builders/bootstrap4_horizontal.rb

@@ -0,0 +1,39 @@
+require 'formular/builders/bootstrap4'
+require 'formular/element/bootstrap3/horizontal'
+require 'formular/element/bootstrap4/horizontal'
+module Formular
+  module Builders
+    class Bootstrap4Horizontal < Formular::Builders::Bootstrap4
+      element_set(
+        input: Formular::Element::Bootstrap4::Horizontal::Input,
+        custom_file: Formular::Element::Bootstrap4::Horizontal::CustomFile,
+        input_group: Formular::Element::Bootstrap3::Horizontal::InputGroup,
+        select: Formular::Element::Bootstrap3::Horizontal::Select,
+        custom_select: Formular::Element::Bootstrap4::Horizontal::CustomSelect,
+        checkbox: Formular::Element::Bootstrap4::Horizontal::Checkbox,
+        custom_stacked_checkbox: Formular::Element::Bootstrap4::Horizontal::CustomStackedCheckbox,
+        radio: Formular::Element::Bootstrap4::Horizontal::Radio,
+        custom_stacked_radio: Formular::Element::Bootstrap4::Horizontal::CustomStackedRadio,
+        inline_radio: Formular::Element::Bootstrap4::Horizontal::InlineRadio,
+        custom_radio: Formular::Element::Bootstrap4::Horizontal::CustomRadio,
+        inline_checkbox: Formular::Element::Bootstrap4::Horizontal::InlineCheckbox,
+        custom_checkbox: Formular::Element::Bootstrap4::Horizontal::CustomCheckbox,
+        label: Formular::Element::Bootstrap4::Horizontal::Label,
+        legend: Formular::Element::Bootstrap4::Horizontal::Legend,
+        checkable_group_label: Formular::Element::Bootstrap4::Horizontal::Legend,
+        textarea: Formular::Element::Bootstrap3::Horizontal::Textarea,
+        error_wrapper: Formular::Element::Bootstrap4::ErrorWrapper,
+        input_column_wrapper: Formular::Element::Bootstrap3::Horizontal::InputColumnWrapper,
+        submit: Formular::Element::Bootstrap4::Horizontal::Submit
+      )
+      inheritable_attr :column_classes
+
+      #these options should be easily configurable
+      self.column_classes = {
+        left_column: ['col-sm-2'],
+        right_column: ['col-sm-10'],
+        left_offset: ['offset-sm-2']
+      }
+    end # class Bootstrap4Horizontal
+  end # module Builders
+end # module Formular

data/lib/formular/builders/bootstrap4_inline.rb

@@ -0,0 +1,15 @@
+require 'formular/builders/bootstrap4'
+require 'formular/builders/bootstrap3_inline'
+require 'formular/element/bootstrap4/custom_control'
+
+module Formular
+  module Builders
+    class Bootstrap4Inline < Formular::Builders::Bootstrap4
+      element_set(
+        form: Bootstrap3Inline::Form,
+        custom_select: Formular::Element::Bootstrap4::CustomControl::Inline::CustomSelect,
+        custom_file: Formular::Element::Bootstrap4::CustomControl::Inline::CustomFile
+      )
+    end # class Bootstrap4Inline
+  end # module Builders
+end # module Formular

data/lib/formular/builders/foundation6.rb

@@ -0,0 +1,28 @@
+require 'formular/builders/basic'
+require 'formular/elements'
+require 'formular/element/foundation6'
+require 'formular/element/foundation6/input_group'
+module Formular
+  module Builders
+    class Foundation6 < Formular::Builders::Basic
+      element_set(
+        error_notification: Formular::Element::Foundation6::ErrorNotification,
+        checkable_group_label: Formular::Element::Legend,
+        checkbox: Formular::Element::Foundation6::Checkbox,
+        radio: Formular::Element::Foundation6::Radio,
+        stacked_checkbox: Formular::Element::Foundation6::StackedCheckbox,
+        stacked_radio: Formular::Element::Foundation6::StackedRadio,
+        input: Formular::Element::Foundation6::Input,
+        input_group: Formular::Element::Foundation6::InputGroup,
+        file: Formular::Element::Foundation6::File,
+        select: Formular::Element::Foundation6::Select,
+        textarea: Formular::Element::Foundation6::Textarea,
+        wrapper: Formular::Element::Label,
+        error_wrapper: Formular::Element::Foundation6::LabelWithError,
+        error: Formular::Element::Foundation6::Error,
+        hint: Formular::Element::Foundation6::Hint,
+        submit: Formular::Element::Foundation6::Submit,
+      )
+    end # class Foundation6
+  end # module Builders
+end # module Formular

data/lib/formular/element.rb

@@ -0,0 +1,135 @@
+require "formular/attributes"
+require "formular/html_block"
+require 'uber/inheritable_attr'
+require 'uber/options'
+
+module Formular
+  # The Element class is responsible for defining what the html should look like.
+  # This includes default attributes, and the function to use to render the html
+  # actual rendering is done via a HtmlBlock class
+  class Element
+    extend Uber::InheritableAttr
+
+    inheritable_attr :html_context
+    inheritable_attr :html_blocks
+    inheritable_attr :default_hash
+    inheritable_attr :option_keys
+    inheritable_attr :tag_name
+
+    self.default_hash = {}
+    self.html_blocks = {}
+    self.html_context = :default
+    self.option_keys = []
+
+    # set the default value of an option or attribute
+    # you can make this conditional by providing a condition
+    # e.g. if: :some_method or unless: :some_method
+    def self.set_default(key, value, condition = {})
+      self.default_hash[key] = { value: value, condition: condition }
+    end
+
+    # define what your html should look like
+    # this block is executed in the context of an HtmlBlock instance
+    def self.html(context = :default, &block)
+      self.html_blocks[context] = block
+    end
+
+    # a convenient way of changing the key for a context
+    # useful for inheritance if you want to replace a context
+    # but still access the original function
+    def self.rename_html_context(old_context, new_context)
+      self.html_blocks[new_context] = self.html_blocks.delete(old_context)
+    end
+
+    # blacklist the keys that should NOT end up as html attributes
+    def self.add_option_keys(*keys)
+      self.option_keys += keys
+    end
+
+    # define the name of the html tag for the element
+    # e.g.
+    # tag :span
+    # tag 'input'
+    # Note that if you leave this out, the tag will be inferred
+    # based on the name of your class
+    # Also, this is not inherited
+    def self.tag(name)
+      self.tag_name = name
+    end
+
+    def self.call(**options, &block)
+      new(**options, &block)
+    end
+
+    def initialize(**options, &block)
+      @builder = options.delete(:builder)
+      normalize_attributes(options)
+      @block = block
+      @tag = self.class.tag_name
+      @html_blocks = define_html_blocks
+    end
+    attr_reader :tag, :html_blocks, :builder, :attributes, :options
+
+    def to_html(context: nil)
+      context ||= self.class.html_context
+      html_blocks[context].call
+    end
+    alias_method :to_s, :to_html
+
+    private
+
+    def define_html_blocks
+      self.class.html_blocks.each_with_object({}) do |(context, block), hash|
+        hash[context] = HtmlBlock.new(self, block)
+      end
+    end
+
+    # we split the options hash between options and attributes
+    # based on the option_keys defined on the class
+    # we then get the default_hash from the class
+    # and merge with the user options and attributes
+    def normalize_attributes(**options)
+      @attributes = Attributes[options]
+      @options = @attributes.select { |k, v| @attributes.delete(k) || true if option_key?(k) }
+      merge_default_hash
+    end
+
+    # Take each default value and merge it with attributes && options.
+    # This way ordering is important and we can access values as they are evaluated
+    def merge_default_hash
+      self.class.default_hash.each do |k, v|
+        next unless evaluate_option_condition?(v[:condition])
+
+        val = Uber::Options::Value.new(v[:value]).evaluate(self)
+
+        next if val.nil?
+
+        if option_key?(k)
+          @options[k] = val if @options[k].nil?
+        else
+          # make sure that we merge classes, not override them
+          k == :class && !@attributes[k].nil? ? @attributes[k] += val : @attributes[k] ||= val
+        end
+      end
+    end
+
+    def option_key?(k)
+      self.class.option_keys.include?(k)
+    end
+
+    # this evaluates any conditons placed on our defaults returning true or false
+    # e.g.
+    # set_default :checked, "checked", if: :is_checked?
+    # set_default :class, ["form-control"], unless: :file_input?
+    def evaluate_option_condition?(condition = {})
+      return true if condition.empty?
+      operator = condition.keys[0]
+      condition_result = Uber::Options::Value.new(condition.values[0]).evaluate(self)
+
+      case operator.to_sym
+      when :if     then condition_result
+      when :unless then !condition_result
+      end
+    end
+  end # class Element
+end # module Formular

data/lib/formular/element/bootstrap3.rb

@@ -0,0 +1,70 @@
+require 'formular/element'
+require 'formular/elements'
+require 'formular/element/modules/wrapped_control'
+require 'formular/element/module'
+require 'formular/element/bootstrap3/checkable_control'
+require 'formular/element/bootstrap3/column_control'
+
+module Formular
+  class Element
+    module Bootstrap3
+      include CheckableControl
+
+      Label = Class.new(Formular::Element::Label) { set_default :class, ['control-label'] }
+      Row = Class.new(Formular::Element::Div) { set_default :class, ['row'] }
+
+      class Submit < Formular::Element::Button
+        set_default :class, ['btn', 'btn-default']
+        set_default :type, 'submit'
+      end # class Submit
+
+      class ErrorNotification < Formular::Element::ErrorNotification
+        set_default :class, ['alert alert-danger']
+        set_default :role, 'alert'
+
+      end
+
+      class Error < Formular::Element::Error
+        tag :span
+        set_default :class, ['help-block']
+      end # class Error
+
+      class Hint < Formular::Element::Span
+        set_default :class, ['help-block']
+      end # class Hint
+
+      class Input < Formular::Element::Input
+        include Formular::Element::Modules::WrappedControl
+        include Formular::Element::Bootstrap3::ColumnControl
+
+        set_default :class, ['form-control'], unless: :file_input?
+
+        def file_input?
+          attributes[:type] == 'file'
+        end
+      end # class Input
+
+      class Select < Formular::Element::Select
+        include Formular::Element::Modules::WrappedControl
+        include Formular::Element::Bootstrap3::ColumnControl
+
+        set_default :class, ['form-control']
+      end # class Select
+
+      class Textarea < Formular::Element::Textarea
+        include Formular::Element::Modules::WrappedControl
+        include Formular::Element::Bootstrap3::ColumnControl
+
+        set_default :class, ['form-control']
+      end # class Textarea
+
+      class Wrapper < Formular::Element::Div
+        set_default :class, ['form-group']
+      end # class Wrapper
+
+      class ErrorWrapper < Formular::Element::Div
+        set_default :class, ['form-group', 'has-error']
+      end # class Wrapper
+    end # module Bootstrap3
+  end # class Element
+end # module Formular

data/lib/formular/element/bootstrap3/checkable_control.rb

@@ -0,0 +1,105 @@
+require 'formular/elements'
+require 'formular/element/modules/wrapped_control'
+require 'formular/element/module'
+
+module Formular
+  class Element
+    module Bootstrap3
+      module CheckableControl
+        module InlineCheckable
+          include Formular::Element::Module
+
+          html(:wrapped) do |input|
+            input.wrapper do
+              concat input.group_label
+              concat input.hidden_tag unless input.collection?
+              if input.has_group_label?
+                concat Formular::Element::Div.(content: input.to_html(context: :collection))
+              else
+                concat input.to_html(context: :collection)
+              end
+              concat input.hidden_tag if input.collection?
+              concat input.hint
+              concat input.error
+            end
+          end
+        end # class InlineCheckable
+
+        class InlineRadio < Formular::Element::Radio
+          include Formular::Element::Modules::WrappedControl
+          include InlineCheckable
+
+          add_option_keys :control_label_options
+          set_default :control_label_options, { class: ['radio-inline'] }
+
+          def hidden_tag
+            ''
+          end
+        end# class InlineRadio
+
+        class InlineCheckbox < Formular::Element::Checkbox
+          include Formular::Element::Modules::WrappedControl
+          include InlineCheckable
+
+          set_default :control_label_options, { class: ['checkbox-inline'] }
+          set_default :value, '1' # instead of reader value
+
+          html { closed_start_tag }
+        end # class InlineCheckbox
+
+        module StackedCheckable
+          include Formular::Element::Module
+
+          html(:wrapped) do |input|
+            input.wrapper do
+              concat input.group_label
+              concat input.hidden_tag unless input.collection?
+              concat input.to_html(context: :collection)
+              concat input.hidden_tag if input.collection?
+              concat input.hint
+              concat input.error
+            end
+          end
+
+          html(:collection) do |input|
+            input.collection.map { |control|
+              control.inner_wrapper { control.to_html(context: :checkable_label) }
+            }.join('')
+          end
+
+          module InstanceMethods
+            def inner_wrapper(&block)
+              Formular::Element::Div.(class: inner_wrapper_class, &block).to_s
+            end
+          end
+        end # module StackedCheckable
+
+        class Checkbox < Formular::Element::Checkbox
+          include Formular::Element::Modules::WrappedControl
+          include StackedCheckable
+
+          set_default :value, '1' # instead of reader value
+
+          html { closed_start_tag }
+
+          def inner_wrapper_class
+            ['checkbox']
+          end
+        end # class Checkbox
+
+        class Radio < Formular::Element::Radio
+          include Formular::Element::Modules::WrappedControl
+          include StackedCheckable
+
+          def inner_wrapper_class
+            ['radio']
+          end
+
+          def hidden_tag
+            ''
+          end
+        end # class Radio
+      end # module CheckableControl
+    end # module Bootstrap3
+  end # class Element
+end # module Formular