caisson 0.0.1 → 0.0.2

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

@@ -0,0 +1,85 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Builder::FieldBuilder
+  class Nature
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(record, name)
+      @record = record
+      @name = name.to_s
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC CLASS METHODS
+    #*************************************************************************************
+    def self.all
+      ['checkbox', 'password', 'percent', 'select', 'text', 'textarea']
+      #TODO
+      #'autocomplete', 'check-icon', 'country', 'file', 'money', 'static', 'switch', 'radio', 'upload', 'ticklist', 'time_field'
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def get(options={})
+      options.reverse_merge!(force: nil)
+
+      if options[:force]
+        return force(options[:force])
+      elsif @record.fields[@name]
+        return case @record.fields[@name].options[:type].to_s.downcase
+          when 'array' then 'ticklist'
+          when 'boolean' then 'checkbox'
+          when 'percent' then 'percent'
+          when 'time' then 'time_field'
+          else nature_by_name
+        end
+      else
+        return nature_by_name
+      end
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def field_has_options?(field_name)
+      model_obj = @record.class
+      if model_obj.respond_to?(:options_for)
+        return (not model_obj.options_for(field_name).empty?)
+      else
+        return false
+      end
+    end
+
+    def field_is_one_to_many?(field_name)
+      not @record.relations.select{ |k,v| v.key == field_name.to_s and v.macro == :referenced_in }.empty?
+    end
+
+    def field_is_select?(field_name)
+      field_has_options?(field_name) or field_is_one_to_many?(field_name)
+    end
+
+    def force(nature)
+      if Caisson::Helpers::Form::Builder::FieldBuilder::Nature.all.include?(nature)
+        return nature
+      else
+        raise "Caisson doesn't accept the field nature '#{nature}' for the field '#{@name}'. Accepted : #{Caisson::Helpers::Form::Builder::FieldBuilder::Nature.all}"
+      end
+    end
+
+    def nature_by_name
+      case
+        when @name.include?('country') then 'country'
+        when @name.include?('password') then 'password'
+        when field_is_select?(@name) then 'select'
+        else 'text'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+module Caisson::Helpers::Form::Builder
+  class Interpreti
+
+    def initialize(record)
+      @record = record
+    end
+
+    def field_choices(name, options={})
+      options.reverse_merge!(base_choices: nil, include_blank: false)
+
+      if options[:base_choices] and options[:base_choices][0].is_a? Array
+        choices = options[:base_choices]
+      elsif options[:base_choices] or model_obj.respond_to? :options_for
+        base_choices = [options[:base_choices] || model_obj.options_for(name.to_s)].compact.flatten
+        choices = base_choices.map { |k| [field_option(name, k), k] }
+      else
+        choices = []
+      end
+
+      choices.insert(0, blank_choice(name)) if options[:include_blank]
+
+      return choices
+    end
+
+    def field_errors(name)
+      []
+      #@core.errors[name].map{ |e| [I18n.translate_with_article('form.field'), field_label(name).downcase_utf8, e].join(' ')}
+    end
+
+    def field_hint(name)
+      field_translation(name, 'hint')
+    end
+
+    def field_label(name)
+      text = field_translation(name, 'label')
+      text = field_translation(name) if text.empty?
+
+      return text
+    end
+
+    def field_option(field_name, option_name, options={})
+      options.reverse_merge!(text: 'label')
+
+      text = field_translation(field_name, "options.#{option_name}.#{options[:text]}")
+      text = field_translation(field_name, "options.#{option_name}") if text.empty? and options[:text] == 'label'
+
+      return text
+    end
+
+    private
+
+    def base_path
+      "models.#{obj_name}"
+    end
+
+    def base_field_path
+      "#{base_path}.fields"
+    end
+
+    def blank_choice(name)
+      [I18n.translate('form.select'), '']
+    end
+
+    def field_translation(name, target=nil)
+      name_path = name.to_s.include?('[') ? name.gsub('[', '.hash.').gsub(']', '') : name
+      name_path = "#{name_path}.#{target}" if target
+
+      text = I18n.translate("#{base_field_path}.#{name_path}", default: '')
+      text = I18n.translate("#{parent_field_path}.#{name_path}", default: '') if translation_missing? text
+
+      return text
+    end
+
+    def has_parent?
+      false
+      #parent_object ? true : false
+    end
+
+    def model_obj
+      @record.class
+    end
+
+    def obj_name(class_obj=nil)
+      (class_obj ? class_obj : model_obj).to_s.pluralize.underscore
+    end
+
+    def parent_object
+      # TOFIX: This should be understood and fix.
+      position = @core.ancestors[1].to_s.include?('#<Module') ? 2 : 1
+      obj = @core.ancestors[position]
+
+      return ((not obj or obj.to_s.include?('Mongoid')) ? nil : obj)
+    end
+
+    def parent_path
+      "models." + (has_parent? ? obj_name(parent_object) : 'parent_undefined')
+    end
+
+    def parent_field_path
+      "#{parent_path}.fields"
+    end
+
+    def translation_missing?(text)
+      text.blank? or text.include? 'translation missing'
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+#*************************************************************************************
+# Build complex graphical button.
+#*************************************************************************************
+module Caisson::Helpers::Form
+  class Button
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(core)
+      @core = core
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(text, options={})
+      options.reverse_merge!(class: '', confirm: nil, default: true, disabled: false, url: nil)
+
+      if options[:url]
+        return link(text, options.delete(:url), options)
+      else
+        return button(text, options)
+      end
+    end
+
+    def build_button_to(text, url, options={})
+      options.reverse_merge!(class: '', confirm: nil, disabled: false, method: 'get', url: nil, vars: {})
+
+      vars = options.delete(:vars)
+
+      return form_tag(url, method: options[:method], class: "button_to") do
+        (vars.map{ |k,v| hidden_field_tag(k, v) }.join("\n") + button(text, options)).html_safe
+      end
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def build_options(options)
+      options['data-confirm'] = options.delete(:confirm) if options[:confirm]
+      options[:class] = ['button', (options[:default] ? 'default' : 'secondary'), options[:class]].compact.join(' ')
+      options.delete(:method)
+
+      return options
+    end
+
+    def button(text, options={})
+      options.reverse_merge!(class: '', confirm: nil, type: 'submit')
+
+      content_tag(:button, text, build_options(options)).html_safe
+    end
+
+    def link(text, url, options={})
+      link_to(text, url, build_options(options)).html_safe
+    end
+
+    def method_missing(*args, &block) return @core.send(*args, &block) end
+  end
+end

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

@@ -0,0 +1,43 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Base
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(core)
+      @core = core
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def parse_text_options(options)
+      options[:class] = ['text-field', options.delete(:class), options.delete(:field_size)].compact.join(' ')
+
+      if options[:validates]
+        options["data-validations"] = options.delete(:validates)
+
+        case
+          when options["data-validations"].include?('max-') then options[:maxlength] = options["data-validations"].match(/max-[0-9]+/).to_s.split('-').last.to_i
+          when options["data-validations"].include?('within-') then options[:maxlength] = options["data-validations"].match(/within-([0-9]+)-([0-9]+)/).to_s.split('-').last.to_i
+          when options["data-validations"].include?('creditcard-') then options[:maxlength] = 19
+        end
+      end
+
+      return options
+    end
+
+
+    def method_missing(*args, &block)
+      if [:check_box_tag, :content_tag, :hidden_field_tag, :options_for_select, :password_field_tag, :select_tag, :text_area_tag, :text_field_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
+  end
+end

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

@@ -0,0 +1,39 @@
+#*************************************************************************************
+# TOCOMMENT
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Checkbox < Caisson::Helpers::Form::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, selected, options={})
+      content = []
+      content << hidden_field_tag(name, '0', id: nil)
+      content << check_box_tag(name, '1', parse_selected(selected), generate_attributes(name, options))
+      content << options.delete(:label)
+
+      return content_tag(:label, content.join("\n").html_safe, :for => name.parameterize.underscore)
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def generate_attributes(name, options)
+      attributes = { class: ['checkbox', 'customized', options.delete(:class)].compact.join(' ') }
+      attributes['title'] = options[:title] if options[:title]
+      attributes['data-submit'] = 1 if options[:submit]
+
+      return attributes
+    end
+
+    def parse_selected(selected)
+      case selected
+        when '0', 'false' then false
+        when '1', 'true' then true
+        else selected
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+#*************************************************************************************
+# Build complex graphical input field.
+#*************************************************************************************
+module FormCandy::Field
+  class Money < FormCandy::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, value, options={})
+      options = parse_text_options options
+
+      decimal = options[:decimal] ? options.delete(:decimal).to_i : 2
+      options[:class].gsub!('text-field', 'money-field')
+
+      options["data-validations"] = [options["data-validations"], 'numeric'].compact.join(' ')
+      options["data-decimal"] = decimal
+
+      content = text_field_tag('formatted-' + name, format_value(value, decimal), options)
+      content += content_tag(:span, '$', class: 'symbol currency')
+      content += hidden_field_tag(name, value, id: nil, class: 'dbdata')
+
+      return content.html_safe
+    end
+
+    def format_value(value, decimal)
+      value.blank? ? '' : sprintf("%0.0#{decimal}f", (value.to_f / (10 ** decimal)).round(decimal)).gsub('.', ',')
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+#*************************************************************************************
+# Build complex graphical password field.
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Password < Caisson::Helpers::Form::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, value, options={})
+      password_field_tag name, value, parse_text_options(options)
+    end
+
+  end
+end

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

@@ -0,0 +1,23 @@
+#*************************************************************************************
+# Build complex graphical input field.
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Percent < Caisson::Helpers::Form::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, value, options={})
+      #options = parse_text_options options
+
+
+      #return (text_field_tag(name, value.f_percent(symbol: false), options) + '<span class="postfix">%</span>'.html_safe).html_safe
+
+      content = '<div class="field-percent">'
+      content += text_field_tag(name, value.f_percent(symbol: false), options)
+      content += content_tag(:span, '%', class: 'postfix')
+      content += '</div>'
+
+      return content.html_safe
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+#*************************************************************************************
+# Build complex graphical input field.
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Select < Caisson::Helpers::Form::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, choices, selection, options={})
+      options.reverse_merge!(class: nil, submit: false, translate: true)
+
+      choices = get_choices(choices, options[:translate])
+
+      return select_tag(name, options_for_select(choices, selection), generate_attributes(options))
+    end
+
+    private
+
+    def generate_attributes(options)
+      attributes = { class: ['select-field', options.delete(:class)].flatten.compact.join(' ') }
+      attributes['data-submit'] = 1 if options[:submit]
+
+      return attributes
+    end
+
+    def get_choices(choices, translate)
+      case
+        when translate then choices # TODO: Translate the fields
+        when (not choices.is_a?(Array)) then choices.choices_for_select # choices are a list of records
+        else choices
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+#*************************************************************************************
+# Build complex graphical input field.
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Text < Caisson::Helpers::Form::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, value, options={})
+      options = parse_text_options options
+
+      value = value.join(';') if value.is_a? Array
+
+      return text_field_tag name, value, options
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+#*************************************************************************************
+# Build complex graphical input field.
+#*************************************************************************************
+module Caisson::Helpers::Form::Field
+  class Textarea < Caisson::Helpers::Form::Field::Base
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def build(name, value, options={})
+      value = options[:value] if options[:value]
+      value = value.join("\n") if value.is_a? Array
+
+      return text_area_tag(name, value, options)
+    end
+  end
+end

data/lib/caisson/helpers/form.rb

@@ -0,0 +1,30 @@
+module Caisson::Helpers
+  module Form
+
+  end
+end
+
+require 'caisson/helpers/form/base'
+require 'caisson/helpers/form/button'
+
+require 'caisson/helpers/form/builder/base'
+require 'caisson/helpers/form/builder/interpreti'
+
+require 'caisson/helpers/form/builder/field/base'
+require 'caisson/helpers/form/builder/field/checkbox'
+require 'caisson/helpers/form/builder/field/password'
+require 'caisson/helpers/form/builder/field/percent'
+require 'caisson/helpers/form/builder/field/select'
+require 'caisson/helpers/form/builder/field/text'
+require 'caisson/helpers/form/builder/field/textarea'
+
+require 'caisson/helpers/form/builder/field_builder/base'
+require 'caisson/helpers/form/builder/field_builder/nature'
+
+require 'caisson/helpers/form/field/base'
+require 'caisson/helpers/form/field/checkbox'
+require 'caisson/helpers/form/field/password'
+require 'caisson/helpers/form/field/percent'
+require 'caisson/helpers/form/field/select'
+require 'caisson/helpers/form/field/text'
+require 'caisson/helpers/form/field/textarea'

data/lib/caisson/helpers/grid.rb

@@ -0,0 +1,32 @@
+module Caisson::Helpers
+  class Grid
+    attr_reader :core
+
+    delegate :capture, to: :core
+    delegate :content_tag, to: :core
+
+    def initialize(core)
+      @core = core
+    end
+
+    def column(span, options={}, &block)
+      options.reverse_merge! class: nil, id: nil, small: nil, tag: :div
+
+      css_class = ['columns']
+      css_class << "large-#{span}"
+      css_class << "small-#{options[:small]}" if options[:small]
+      css_class << options[:class] if options[:class]
+
+      content_tag(options[:tag], capture(&block), class: css_class.join(' '), id: options[:id])
+    end
+
+    def row(options={}, &block)
+      options.reverse_merge! class: nil, id: nil, tag: :div
+
+      css_class = ['row']
+      css_class << options[:class] if options[:class]
+
+      content_tag(options[:tag], capture(&block), class: css_class.join(' '), id: options[:id])
+    end
+  end
+end

data/lib/caisson/helpers/orbit_slider.rb

@@ -19,6 +19,7 @@ module Caisson::Helpers
     private
 
     def build_options(options)
+      # DEPRECATED IN VERSION 4
       options.reverse_merge(
         advance_speed: 4000,
         animation: "horizontal-push",
@@ -41,21 +42,18 @@ module Caisson::Helpers
         timer: false)
     end
 
-    def build_item(item, last=false, &block)
-      css_class = ['column']
-      css_class << get_column_size
-      css_class << 'end' if last
 
-      '<li class="' + css_class.join(' ') + '">' + capture(item, &block).to_s + '</li>'
+    def build_item(item, last=false, &block)
+      '<li>' + capture(item, &block).to_s + '</li>'
     end
 
     def build_slides(&block)
       slides = []
 
       @items.each_slice @options[:columns_per_slide] do |slice|
-        content = '<div><ul class="row">'
+        content = '<li><div class="spacer"></div><ul class="wink small-block-grid-3 large-block-grid-' + @options[:columns_per_slide].to_s + '">'
         slice.each_with_index { |item,i| content << build_item(item, (i==slice.length-1), &block) }
-        content << '</ul></div>'
+        content << '</ul><div class="spacer"></div></li>'
 
         slides << content
       end
@@ -63,17 +61,6 @@ module Caisson::Helpers
       return slides.join("\n")
     end
 
-    def get_column_size
-      case @options[:columns_per_slide]
-        when 1 then 'twelve'
-        when 2 then 'six'
-        when 3 then 'four'
-        when 4 then 'three'
-        when 5,6 then 'two'
-        else 'one'
-      end
-    end
-
     def parse_attribute_value(raw_value)
       case raw_value
         when true then '1'
@@ -82,19 +69,27 @@ module Caisson::Helpers
       end
     end
 
+    def stringify_options
+      results = []
+
+      @options.each { |k,v| results << "#{k}:#{v};" }
+
+      return results.join
+    end
+
     def wrap_slider(content)
-      attributes = { 'data-caisson' => 'orbit-slider' }
+      attributes = { 'data-caisson' => 'orbit-slider', 'data-orbit' => '', 'data-options' => stringify_options }
 
       @options.each do |k,v|
         case k.to_s
           when 'id' then attributes[:id] = v
           when 'class' then attributes[:class] = ['slider', v].compact.join(' ')
           when 'columns_per_slide' then nil
-          else attributes["data-#{k}".gsub('_', '-')] = parse_attribute_value(v)
+          else nil #attributes["data-#{k}".gsub('_', '-')] = parse_attribute_value(v)
         end
       end
 
-      return content_tag(:div, content.html_safe, attributes)
+      return content_tag(:ul, content.html_safe, attributes)
     end
   end
 end

data/lib/caisson/helpers.rb

@@ -1,9 +1,35 @@
 module Caisson::Helpers
+  def caisson_header
+    '<meta name="viewport" content="width=device-width, initial-scale=1.0" />'.html_safe
+  end
+
+  def grid
+    @grid ||= Caisson::Helpers::Grid.new(self)
+  end
+
   def orbit_slider(items, options={}, &block)
     Caisson::Helpers::OrbitSlider.new(self, items, options).generate(&block)
   end
 
+  ActionView::Helpers::FormTagHelper.module_eval do
+    def caisson(record=nil)
+      if record
+        Caisson::Helpers::Form::Builder::Base.new(self, record)
+      else
+        Caisson::Helpers::Form::Base.new(self)
+      end
+    end
+  end
+
+  ActionView::Helpers::FormBuilder.module_eval do
+    def caisson
+      Caisson::Helpers::Form::Builder::Base.new(@template, @object)
+    end
+  end
+
   ::ActionView::Base.send :include, self
 end
 
+require 'caisson/helpers/form'
+require 'caisson/helpers/grid'
 require 'caisson/helpers/orbit_slider'