caisson 0.0.1 → 0.0.2

data/lib/caisson/helpers/form/base.rb

@@ -0,0 +1,195 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form
+  class Base
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(core)
+      @core = core
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def button(text, options={})
+      Caisson::Helpers::Form::Button.new(@core).build(text, options)
+    end
+
+    def button_to(text, options={}, html_options={})
+      Caisson::Helpers::Form::Button.new(@core).build_button_to(text, options, html_options)
+    end
+
+    def buttons(&block)
+      content = '<div class="buttons row"><div class="large-12 columns">'
+      content << @core.capture(self, &block)
+      content << '</div></div>'
+
+      return content.html_safe
+    end
+
+    def label(text, options={})
+      options.reverse_merge!(content: '', placeholder: nil, separator: ' : ')
+
+      label_for = options[:content].scan(/<[input|textarea|select|span|div].+id="(.+?)"./).flatten.first
+
+      attributes = {}
+      attributes[:for] = label_for if label_for
+      attributes[:class] = 'placeholder' if options[:placeholder]
+
+      text = '&nbsp;'.html_safe if text.empty?
+      text += options[:separator].to_s if not options[:placeholder]
+
+      return content_tag(:label, text, attributes)
+    end
+
+    def line(label_str, content, options={})
+      options.reverse_merge!(class: nil, id: nil, label_separator: ' : ', placeholder: false)
+
+      css_class = ['row', 'form-line', options[:class]].compact.join(' ')
+
+      line_content = '<div class="' + css_class + '"><div class="large-12 columns field">'
+      line_content << label(label_str, content: content, separator: options[:label_separator], placeholder: options[:placeholder]) if not label_str.nil?
+      line_content << content
+      line_content << '</div></div>'
+
+      return line_content.html_safe
+    end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    def checkbox(name, selected=false, options={})
+      new_field('checkbox', name, selected, options)
+    end
+
+
+
+
+
+    def line_checkbox(label_str, field_name, selected=false, options={})
+      options.reverse_merge!(label_separator: nil, wrap_field: false)
+
+      options[:class] = [options[:class], 'line-checkbox'].compact.join(' ')
+
+      return line(label_str, checkbox(field_name, selected), options)
+    end
+
+    def line_password(label_str, field_name, value='', options={})
+      field_options = get_field_options(label_str, options)
+
+      line(label_str, password(field_name, value, field_options), options)
+    end
+
+    def line_select(label_str, field_name, choices, selection, options={})
+      line(label_str, select(field_name, choices, selection), options)
+    end
+
+    def line_static(label_str, value, options={})
+      options.reverse_merge!(wrap_field: false)
+
+      options[:class] = [options[:class], 'line-static'].compact.join(' ')
+
+      field_options = {}
+      field_options[:date_format] = options.delete(:date_format) if options[:date_format]
+
+      line(label_str, static(value, field_options), options)
+    end
+
+    def line_switch(label_str, field_name, choices, selection, options={})
+      line(label_str, switch(field_name, choices, selection), options)
+    end
+
+    def line_text(label_str, field_name, value='', options={})
+      options.reverse_merge!(wrap_field: false)
+
+      field_options = get_field_options(label_str, options)
+
+      line(label_str, text(field_name, value, field_options), options)
+    end
+
+    def line_time(label_str, field_name, value='', options={})
+      line(label_str, time(field_name, value), options)
+    end
+
+    def password(name, value='', options={})
+      new_field('password', name, value, options)
+    end
+
+    def select(name, choices, selection, options={})
+      options.reverse_merge!(submit: false, translate: false)
+
+      new_field('select', name, choices, selection, options)
+    end
+
+    def static(value, options={})
+      new_field('static', value, options)
+    end
+
+    def switch(name, choices, selection, options={})
+      options.reverse_merge!(submit: false, translate: false)
+
+      new_field('switch', name, choices, selection, options)
+    end
+
+    def text(name, value='', options={})
+      new_field('text', name, value, options)
+    end
+
+    def time(name, value, options={})
+      new_field('time_field', name, value, options)
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def get_field_options(label_str, line_options)
+      field_options = {}
+
+      if line_options[:placeholder]
+        field_options[:placeholder] = (line_options[:placeholder] == true) ? label_str : line_options[:placeholder]
+      end
+
+      field_options[:placeholder] = line_options[:placeholder_text] if line_options[:placeholder_text]
+      field_options[:validates] = line_options.delete(:validates) if line_options[:validates]
+      field_options[:maxlength] = line_options.delete(:maxlength) if line_options[:maxlength]
+      field_options[:field_size] = line_options.delete(:field_size) if line_options[:field_size]
+
+      return field_options
+    end
+
+    def line_options(options)
+      options[:class] = ['line', options[:class]].compact.flatten.join(' ')
+      options.delete(:label_separator)
+      options.delete(:wrap_field)
+      options.delete(:placeholder)
+      options.delete(:placeholder_text)
+
+      return options
+    end
+
+    def new_field(nature, *args)
+      wrap_field "Caisson::Helpers::Form::Field::#{nature.camelize}".constantize.new(@core).build(*args)
+    end
+
+    def wrap_field(content)
+      content_tag(:div, content, class: 'field')
+    end
+
+    def method_missing(*args, &block) return @core.send(*args, &block) end
+  end
+end

data/lib/caisson/helpers/form/builder/base.rb

@@ -0,0 +1,72 @@
+module Caisson::Helpers::Form::Builder
+  class Base
+    attr_reader :interpreti, :record
+
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(core, record)
+      @core = core
+      @record = record
+      @interpreti = Caisson::Helpers::Form::Builder::Interpreti.new(@record)
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def line(field_name, options={})
+      options.reverse_merge!(choices: nil, hint: true, id: 'undefined', label: 'undefined', nature: nil, placeholder: false, value: 'undefined')
+
+      field = field_builder(field_name, field_options(options))
+
+      label_str = line_label(field, force: options[:label])
+
+      return caisson.line(label_str, field.build, line_options(field, options))
+    end
+
+    def line_label(field, options={})
+      options.reverse_merge!(force: 'undefined')
+
+      return case
+        when options[:force] != 'undefined' then options[:force]
+        when field.checkbox? then nil
+        when field.hidden? then nil
+        else field.label
+      end
+    end
+
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def field_builder(name, options={})
+      Caisson::Helpers::Form::Builder::FieldBuilder::Base.new(self, name, options)
+    end
+
+    def field_options(full_options)
+      options = {}
+      options.reverse_merge! full_options
+      options.delete :class
+
+      return options
+    end
+
+    def line_options(field, full_options)
+      options = { class: ["line-#{field.nature}", full_options[:class]].join(' ') }
+      options[:class] << ' errors' if field.errors?
+      options[:id] = 'line-' + full_options[:id] if not [nil, 'undefined'].include?(full_options[:id])
+      options[:wrap_field] = false
+      options[:placeholder] = full_options[:placeholder]
+      options[:hint] = full_options[:hint]
+
+      options[:label_separator] = '' if field.nature == 'checkbox'
+
+      return options
+    end
+
+    def method_missing(*args, &block) return @core.send(*args, &block) end
+  end
+end

data/lib/caisson/helpers/form/builder/field/base.rb

@@ -0,0 +1,168 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Base
+    attr_reader :name
+
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(core, record, name, options={})
+      @core = core
+      @record = record
+      @name = name
+
+      @options = OptionParser.new(@record, @name, options).parse
+    end
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def field_id
+      "#{model_name}_#{@name}"
+    end
+
+    def field_name
+      "#{model_name}[#{@name}]"
+    end
+
+    def label
+      interpreti.field_label(@name)
+    end
+
+    def interpreti
+      @core.interpreti
+    end
+
+    def model_name
+      @record.class.to_s.underscore.downcase
+    end
+
+    def value(readable=false)
+      if @name.to_s.include?('[')
+        parsed_name = @name.gsub(']', '[').split('[')
+
+        return @record.read_attribute(parsed_name[0])[parsed_name[1]]
+      else
+        content = ''
+        content = interpreti.field_option(@name) if readable
+
+        if content.blank?
+          content = @record.respond_to?(@name) ? @record.send(@name) : @record.read_attribute(@name)
+        end
+
+        return content
+      end
+    end
+
+    def value_readable
+      value true
+    end
+
+    def method_missing(*args, &block)
+      if [:check_box, :content_tag].include?(args.first)
+        return @core.send(*args, &block)
+      else
+        raise NoMethodError.new("undefined local variable or method '#{args.first}' for #{self.class}")
+      end
+    end
+
+    class OptionParser
+      def initialize(record, field_name, options)
+        @field_name = field_name
+        @options = options
+        @record = record
+      end
+
+      def parse
+        parse_id
+        parse_class
+        parse_placeholder
+        parse_validations
+
+        delete_junk
+
+        return @options
+      end
+
+      private
+
+      def delete_junk
+        [:field_size, :nature].each { |n| @options.delete(n) }
+
+        @options.delete(:label) if @options[:label] == 'undefined'
+        @options.delete(:value) if @options[:value] == 'undefined'
+        @options.delete(:choices) if not @options[:choices]
+      end
+
+      def parse_class
+        @options[:class] = [@options[:class], @options[:field_size]].compact.join(" ") if @options[:field_size]
+      end
+
+      def parse_id
+        if @options[:id] == 'undefined'
+          model_name = @record.class.to_s.underscore.downcase
+
+          @options[:id] = "#{model_name}_#{@field_name}"
+        end
+      end
+
+      def parse_length_validator(opts)
+        case
+          when (opts[:minimum] and opts[:maximum]) then "within-#{opts[:minimum]}-#{opts[:maximum]}"
+          when opts[:minimum] then "min-#{opts[:minimum]}"
+          when opts[:maximum] then "max-#{opts[:maximum]}"
+          when opts[:is] then "length-#{opts[:is]}"
+        end
+      end
+
+      def parse_placeholder
+        if @options[:placeholder] == true
+          @options[:placeholder] = interpreti.field_label @field_name
+        elsif not @options[:placeholder]
+          @options.delete(:placeholder)
+        end
+      end
+
+      def parse_validations
+        validators = @record.class.validators_on(@field_name).map { |v| parse_validator v }
+        validators << 'email' if @field_name.to_s.include? 'email'
+        validators << set_other_validations
+
+        data = [validators, @options.delete(:validates)].flatten.compact
+
+        @options[:validates] = data.join(" ") if not data.empty?
+      end
+
+      def parse_validator(validator)
+        return nil if validator.options[:if] and not @record.send(validator.options[:if])
+        return nil if validator.options[:unless] and @record.send(validator.options[:unless])
+
+        case validator.class.to_s
+          when /ConfirmationValidator$/ then nil # TODO: Implement this feature
+          when /FormatValidator$/ then nil
+          when /LengthValidator$/ then parse_length_validator validator.options
+          when /PresenceValidator$/ then 'blank'
+          when /UniquenessValidator$/ then nil
+          else nil
+        end
+      end
+
+      def set_other_validations
+        validators = []
+
+        validators << 'numeric' if @record.fields[@field_name.to_s] and @record.fields[@field_name.to_s].options[:type] == Integer
+
+        return validators
+      end
+    end
+
+  end
+end

data/lib/caisson/helpers/form/builder/field/checkbox.rb

@@ -0,0 +1,15 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Checkbox < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      @options[:label] = label
+
+      Caisson::Helpers::Form::Field::Checkbox.new(@core).build(field_name, value, @options)
+    end
+  end
+end

data/lib/caisson/helpers/form/builder/field/money.rb

@@ -0,0 +1,13 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Money < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      Caisson::Helpers::Form::Field::Money.new(@core).build(field_name, value, @options)
+    end
+  end
+end

data/lib/caisson/helpers/form/builder/field/password.rb

@@ -0,0 +1,13 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Password < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      Caisson::Helpers::Form::Field::Password.new(@core).build(field_name, value, @options)
+    end
+  end
+end

data/lib/caisson/helpers/form/builder/field/percent.rb

@@ -0,0 +1,13 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Percent < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      Caisson::Helpers::Form::Field::Percent.new(@core).build(field_name, value, @options)
+    end
+  end
+end

data/lib/caisson/helpers/form/builder/field/select.rb

@@ -0,0 +1,41 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Select < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      @options.reverse_merge!(choices: nil, include_blank: false)
+
+      choices = parse_choices @options[:choices]
+
+      @options.delete(:choices)
+      @options.delete(:include_blank)
+      @options[:translate] = false
+
+      Caisson::Helpers::Form::Field::Select.new(@core).build(field_name, choices, value, @options)
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def parse_choices(choices)
+      if choices
+        if not choices.is_a? Array or not choices.first.is_a? Array
+          # choices are a list of records
+          choices = choices.choices_for_select
+          choices.insert(0, interpreti.blank_choice(name)) if @options[:include_blank]
+        end
+      else
+        choices = interpreti.field_choices(name, include_blank: @options[:include_blank])
+      end
+
+      return choices
+    end
+
+  end
+end

data/lib/caisson/helpers/form/builder/field/text.rb

@@ -0,0 +1,13 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Text < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      Caisson::Helpers::Form::Field::Text.new(@core).build(field_name, value, @options)
+    end
+  end
+end

data/lib/caisson/helpers/form/builder/field/textarea.rb

@@ -0,0 +1,13 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::Field
+  class Textarea < Caisson::Helpers::Form::Builder::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      Caisson::Helpers::Form::Field::Textarea.new(@core).build(field_name, value, @options)
+    end
+  end
+end

data/lib/caisson/helpers/form/builder/field_builder/base.rb

@@ -0,0 +1,81 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::FieldBuilder
+  class Base
+    attr_reader :nature
+    attr_reader :core
+
+    delegate :content_tag, to: :core
+    delegate :interpreti, to: :core
+
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(core, name, options={})
+      options.reverse_merge!(nature: nil, hint: true)
+
+      @core = core
+      @name = name
+      @options = options.dup
+      @record = core.record
+      @show_hint = options[:hint]
+
+      @nature = Caisson::Helpers::Form::Builder::FieldBuilder::Nature.new(@record, name).get(force: options[:nature])
+    end
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build
+      "Caisson::Helpers::Form::Builder::Field::#{@nature.camelize}".constantize.new(@core, @record, @name, @options).build
+    end
+
+    def checkbox?
+      nature == 'checkbox'
+    end
+
+    def errors?
+      not errors.empty?
+    end
+
+    def errors
+      interpreti.field_errors(@name)
+    end
+
+    def hidden?
+      @nature == 'hidden'
+    end
+
+    def hint?
+      not interpreti.field_hint(@name).blank? and @show_hint
+    end
+
+    def label
+      interpreti.field_label(@name)
+    end
+
+    def wrap_field(field_tags)
+      css_class = ['field']
+      css_class << 'errors' if errors?
+
+      content_tag(:div, field_tags + wrapper_hint + wrapper_errors, class: css_class.join(' '))
+    end
+
+    def wrapper_errors
+      if errors?
+        content_tag(:div, errors.map{|e| content_tag(:span, e)}.join.html_safe, class: 'error-messages')
+      else
+        ''
+      end
+    end
+
+    def wrapper_hint
+      if hint?
+        content_tag(:div, interpreti.field_hint(@name).html_safe, class: 'hint')
+      else
+        ''
+      end
+    end
+  end
+end