formular 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0a80c5927dbbece4b4e9a888d51497a4b03fb4d
-  data.tar.gz: 0598fe40cccca15f3e0542c5b77a47a89907e5f4
+  metadata.gz: e07c2e8826a8660e76871f7c8796643f2ce14af6
+  data.tar.gz: 5d890ae78955fe7e751c441eb52ef817d73822e1
 SHA512:
-  metadata.gz: baa976452c932d62cb3fc78ef2db818016695abb6e2a6b8084c24c42592a702ab39fd86fc2f0fed26b70bb28a03dfcaf9dae71c08618583c230121defb047fb0
-  data.tar.gz: bd365b3219770eaf4628cea94447ff9cb596b9aca07fb5f30b89a0f5d9f5ab92ce30844934e975250136afd31e0b0a3860a506df1dd947e2cade309288223d12
+  metadata.gz: 66b87984f1027e268b7af86abb863c40f3f55b0c7bbbe1c973ad98b27a200d34961b5c8113fd2fa1c7311cd691be10140c2bc3c28d202008217b07937691c86f
+  data.tar.gz: c1f1f2f559011007f56f9f3d3c7efebf87716c11c921f5cf039384d37db7867ee58ea5657fd9c9676a3cc4e729d1a8ea7646a4fadab9bc21a1e24c07044ce4ab

data/.travis.yml

@@ -7,17 +7,18 @@ script:
 rvm:
   - 2.0
   - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
   - rbx-2
-  - jruby-9.1.1.0
+  - jruby-9.1.13.0
   - ruby-head
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: jruby-9.1.1.0
+    - rvm: jruby-9.1.13.0
     - rvm: rbx-2
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# Master
+
+# v0.2.2 2017-09-13
+
+### Added
+
+* Select elements prompt and include_blank options now operate the same way as simple form
+* added procces_option to the Element API
+* Checkboxes now support `checked_value` option as an alias of `value`. Same as SimpleForm.
+* you can now set your own builders as the default in the helper
+
+### Fixed
+
+* Escape html (controls, labels errors hints) (fixes #29)
+* setting a default builder in the helper now actually works!
+* Select elements appends array signifier (`[]`) to element name attribute when `multiple: true` (fixes #40)
+* options should always override default values, even when nil. (fixes #39)
+
+### Internal
+
+* element#options now includes both elements and html attributes
+* elements#attributes only includes html attributes and can't be mutated. Change element#options instead
+* elements#normalize_options no longer tries to use the default value if an option is present
+* added a module for html_escape
+* renamed WrappedControl module to Wrapped and stopped including control
+* changes the order of default_hash to better respect inheritance ordering
+* provide an element module for easily escaping html values
+
 # v0.2.1 2016-09-29
 
 ### Fixed
@@ -5,7 +33,6 @@
 * Correctly require declarative heritage for Formular::Element::Module - (@fran-worley)
 * Update readme & include example gemgem links - (@fran-worley)
 
-
 # v0.2.0 2016-09-27
 
-First public release
+First public release

data/README.md

@@ -60,9 +60,10 @@ Our basic builder ships with the following elements:
 We also provide builders for Twitter Bootstrap (v.3&4) and Zurb's Foundation (v.6)
 
 To help you get started we've got some example Sinatra apps so you can see Formular in action:
-[Bootstrap3 (slim)](https://github.com/fran-worley/gemgem-sinatra/tree/formular-slim-bootstrap3)
-[Bootstrap4 (slim)](https://github.com/fran-worley/gemgem-sinatra/tree/formular-slim-bootstrap4)
-Foundation6 (slim)
+
+* [Bootstrap3 (slim)](https://github.com/fran-worley/gemgem-sinatra/blob/formular-slim-bootstrap3/concepts/post/view/new.slim)
+* [Bootstrap4 (slim)](https://github.com/fran-worley/gemgem-sinatra/blob/formular-slim-bootstrap4/concepts/post/view/new.slim)
+* Foundation6 (slim)
 
 Formular's API docs and information on how to extend it will be found on the [Trailblazer project page](http://trailblazer.to/gems/formular) once the page has been added 😉.
 
@@ -75,7 +76,7 @@ Formular's API docs and information on how to extend it will be found on the [Tr
 
 ## Limitations
 
-* Currently, nested hashes aren't suffixed with `_attributes`, as it's usually done in ActiveRecord.
+* Nested hashes aren't suffixed with active records `_attributes`.
 * Capturing only works with Slim and Hamlit. A 'blockless' API is provided to enable use in ERB but watch this space as improvements are coming for ERB
 
 ## Installation

data/formular.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency             "declarative",    '~> 0.0.4'
-  spec.add_dependency             "uber",           "~> 0.0.11"
+  spec.add_dependency             "uber",           ">= 0.0.11", "< 0.2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/formular/attributes.rb

@@ -5,32 +5,17 @@ module Formular
       super
     end
 
-    def merge(hash)
-      dup.merge!(hash)
-    end
-
-    def merge!(hash)
-      classes     = self[:class]
-      new_classes = hash[:class]
-      return super unless classes && new_classes
-
-      hash[:class] += classes
-      super
-    end
-
     # converts the hash into a string k1=v1 k2=v2
     # replaces underscores with - so we can use regular keys
-    # allows one layer of nestedhashes so we can define data options as a hash.
+    # allows one layer of nested hashes so we can define data options as a hash.
     def to_html
-      map do |key,val|
-        if val.is_a?(Hash)
-          val.map do |k,v|
-            %(#{key_to_attr_name(key)}-#{key_to_attr_name(k)}="#{val_to_string(v)}")
-          end.join(" ")
+      map { |key, value|
+        if value.is_a?(Hash)
+          value.map { |k,v| %(#{key_to_attr_name(key)}-#{attribute_html(k, v)}) }.join(' ')
         else
-           %(#{key_to_attr_name(key)}="#{val_to_string(val)}")
+          attribute_html(key, value)
         end
-      end.join(" ")
+      }.join(' ')
     end
 
     private
@@ -41,5 +26,9 @@ module Formular
     def val_to_string(value)
       value.is_a?(Array) ? value.join(' ') : value
     end
+
+    def attribute_html(key, value)
+      %(#{key_to_attr_name(key)}="#{val_to_string(value)}")
+    end
   end # class Attributes
 end # module Formular

data/lib/formular/builders/basic.rb

@@ -28,13 +28,14 @@ module Formular
         error_wrapper: Formular::Element::Div
       )
 
-      def initialize(model: nil, path_prefix: nil, errors: nil, elements: {})
+      def initialize(model: nil, path_prefix: nil, errors: nil, values: nil, elements: {})
         @model = model
         @path_prefix = path_prefix
         @errors = errors || (model ? model.errors : {})
+        @values = values || {}
         super(elements)
       end
-      attr_reader :model, :errors
+      attr_reader :model, :errors, :values
 
       def collection(name, models: nil, builder: nil, &block)
         models ||= model ? model.send(name) : []
@@ -57,7 +58,7 @@ module Formular
       end
 
       def reader_value(name)
-        model ? model.send(name) : nil
+        model ? model.send(name) : values[name.to_sym]
       end
     end # class Basic
   end # module Builders

data/lib/formular/builders/bootstrap3.rb

@@ -21,7 +21,8 @@ module Formular
         wrapper: Formular::Element::Bootstrap3::Wrapper,
         error_wrapper: Formular::Element::Bootstrap3::ErrorWrapper,
         submit: Formular::Element::Bootstrap3::Submit,
-        row: Formular::Element::Bootstrap3::Row
+        row: Formular::Element::Bootstrap3::Row,
+        icon: Formular::Element::Bootstrap3::Icon
       )
     end # class Bootstrap3
   end # module Builders

data/lib/formular/builders/bootstrap4.rb

@@ -1,7 +1,7 @@
 require 'formular/builders/basic'
 require 'formular/element/bootstrap4'
 require 'formular/element/bootstrap3'
-require 'formular/element/bootstrap3/input_group'
+require 'formular/element/bootstrap4/input_group'
 
 module Formular
   module Builders
@@ -11,10 +11,10 @@ module Formular
         error: Formular::Element::Bootstrap4::Error,
         hint: Formular::Element::Bootstrap4::Hint,
         input: Formular::Element::Bootstrap4::Input,
-        input_group: Formular::Element::Bootstrap3::InputGroup,
+        input_group: Formular::Element::Bootstrap4::InputGroup,
         checkbox: Formular::Element::Bootstrap4::StackedCheckbox,
         radio: Formular::Element::Bootstrap4::StackedRadio,
-        select: Formular::Element::Bootstrap3::Select,
+        select: Formular::Element::Bootstrap4::Select,
         custom_select: Formular::Element::Bootstrap4::CustomSelect,
         custom_file: Formular::Element::Bootstrap4::CustomFile,
         custom_radio: Formular::Element::Bootstrap4::Inline::CustomRadio,
@@ -25,7 +25,7 @@ module Formular
         inline_checkbox: Formular::Element::Bootstrap4::InlineCheckbox,
         label: Formular::Element::Label,
         checkable_group_label: Formular::Element::Legend,
-        textarea: Formular::Element::Bootstrap3::Textarea,
+        textarea: Formular::Element::Bootstrap4::Textarea,
         wrapper: Formular::Element::Bootstrap4::Wrapper,
         error_wrapper: Formular::Element::Bootstrap4::ErrorWrapper,
         submit: Formular::Element::Bootstrap4::Submit,

data/lib/formular/element.rb

@@ -13,10 +13,12 @@ module Formular
     inheritable_attr :html_context
     inheritable_attr :html_blocks
     inheritable_attr :default_hash
+    inheritable_attr :processing_hash
     inheritable_attr :option_keys
     inheritable_attr :tag_name
 
     self.default_hash = {}
+    self.processing_hash = {}
     self.html_blocks = {}
     self.html_context = :default
     self.option_keys = []
@@ -24,10 +26,21 @@ module Formular
     # 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
+    # to respect the order defaults are declared, rather than overriting existing defaults
+    # we should delete the existing and create a new k/v pair
     def self.set_default(key, value, condition = {})
+      self.default_hash.delete(key) # attempt to delete an existing key
       self.default_hash[key] = { value: value, condition: condition }
     end
 
+    # process an option value (i.e. escape html)
+    # This occurs after the value has been set (either by default or by user input)
+    # you can make this conditional by providing a condition
+    # e.g. if: :some_method or unless: :some_method
+    def self.process_option(key, processor, condition = {})
+      self.processing_hash[key] = { processor: processor, 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)
@@ -63,12 +76,19 @@ module Formular
 
     def initialize(**options, &block)
       @builder = options.delete(:builder)
-      normalize_attributes(options)
+      @options = options
+      normalize_options
+      process_options
       @block = block
       @tag = self.class.tag_name
       @html_blocks = define_html_blocks
     end
-    attr_reader :tag, :html_blocks, :builder, :attributes, :options
+    attr_reader :tag, :html_blocks, :builder, :options
+
+    def attributes
+      attrs = @options.select { |k, v| @options[k] || true unless option_key?(k) }
+      Attributes[attrs]
+    end
 
     def to_html(context: nil)
       context ||= self.class.html_context
@@ -84,32 +104,43 @@ module Formular
       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.
+    # Options passed into our element instance (@options) take precident over class level defaults
+    # Take each default value and merge it with 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])
+    def normalize_options
+      self.class.default_hash.each do |key, hash|
+        should_merge = key.to_s.include?('class') && !options[key].nil?
+
+        next if options.has_key?(key) && !should_merge
 
-        val = Uber::Options::Value.new(v[:value]).evaluate(self)
+        # if our default is conditional and the condition evaluates to false then skip
+        next unless evaluate_option_condition?(hash[:condition])
 
+        val = Uber::Options::Value.new(hash[:value]).evaluate(self)
+
+        # if our default value is nil then skip
         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
+        # otherwise perform the actual merge, classes get joined, otherwise we overwrite
+        should_merge ? @options[key] += val : @options[key] = val
+      end
+    end
+
+    # Options passed into our element instance (@options) take precident over class level defaults
+    # Take each default value and merge it with options.
+    # This way ordering is important and we can access values as they are evaluated
+    def process_options
+      self.class.processing_hash.each do |key, hash|
+        # we can't process if our option is nil
+        next if options[key].nil?
+        # don't process if our condition is false
+        next unless evaluate_option_condition?(hash[:condition])
+
+        # get our value
+        val = self.send(hash[:processor], options[key]) # TODO enable procs and blocks
+
+        # set our value
+        @options[key] = val
       end
     end
 

data/lib/formular/element/bootstrap3.rb

@@ -1,6 +1,6 @@
 require 'formular/element'
 require 'formular/elements'
-require 'formular/element/modules/wrapped_control'
+require 'formular/element/modules/wrapped'
 require 'formular/element/module'
 require 'formular/element/bootstrap3/checkable_control'
 require 'formular/element/bootstrap3/column_control'
@@ -13,6 +13,39 @@ module Formular
       Label = Class.new(Formular::Element::Label) { set_default :class, ['control-label'] }
       Row = Class.new(Formular::Element::Div) { set_default :class, ['row'] }
 
+      class Icon < Formular::Element::Span
+        add_option_keys :name
+        set_default :class, :icon_class
+
+        #returns the class of the bootstrap Glyphicons
+        #accepts the string or symbolized name of the glyphicon (see list below for available options)
+        #asterisk, plus, euro, minus, cloud, envelope, pencil, glass, music, search, heart, star, star-empty,
+        #user, film, th-large, th, th-list, ok, remove, zoom-in, zoom-out, off, signal, cog, trash, home, file,
+        #time, road, download-alt, download, upload, inbox, play-circle, repeat, refresh, list-alt, lock,
+        #flag, headphones, volume-off, volume-down, volume-up, qrcode, barcode, tag, tags, book, bookmark,
+        #print, camera, font, bold, italic, text-height, text-width, align-left, align-center, align-right,
+        #align-justify, list, indent-left, indent-right, facetime-video, picture, map-marker, adjust,
+        #tint, edit, share, check, move, step-backward, fast-backward, backward, play, pause, stop, forward,
+        #fast-forward, step-forward, eject, chevron-left, chevron-right, plus-sign, minus-sign, remove-sign,
+        #ok-sign, question-sign, info-sign, screenshot, remove-circle, ok-circle, ban-circle, arrow-left,
+        #arrow-right, arrow-up, arrow-down, share-alt, resize-full, resize-small, exclamation-sign, gift, leaf,
+        #fire, eye-open, eye-close, warning-sign, plane, calendar, random, comment, magnet, chevron-up,
+        #chevron-down, retweet, shopping-cart, folder-close, folder-open, resize-vertical, resize-horizontal,
+        #hdd, bullhorn, bell, certificate, thumbs-up, thumbs-down, hand-right, hand-left, hand-up, hand-down,
+        #circle-arrow-right, circle-arrow-left, circle-arrow-up, circle-arrow-down, globe, wrench, tasks,
+        #filter, briefcase, fullscreen, dashboard, paperclip, heart-empty, link, phone, pushpin, usd, gbp,
+        #sort, sort-by-alphabet, sort-by-alphabet-alt, sort-by-order, sort-by-order-alt, sort-by-attributes,
+        #sort-by-attributes-alt, unchecked, expand, collapse-down, collapse-up, log-in, flash, log-out, new-window,
+        #record, save, open, saved, import, export, send, floppy-disk, floppy-saved, floppy-remove, floppy-save,
+        #floppy-open, credit-card, transfer, cutlery, header, compressed, earphone, phone-alt, tower, stats,
+        #sd-video, hd-video, subtitles, sound-stereo, sound-dolby, sound-5-1, sound-6-1, sound-7-1,
+        #copyright-mark, registration-mark, cloud-download, cloud-upload, tree-conifer, tree-deciduous
+        def icon_class
+          icon_name = options[:name].to_s.gsub("_","-")
+          %(glyphicon glyphicon-#{icon_name})
+        end
+      end
+
       class Submit < Formular::Element::Button
         set_default :class, ['btn', 'btn-default']
         set_default :type, 'submit'
@@ -21,7 +54,6 @@ module Formular
       class ErrorNotification < Formular::Element::ErrorNotification
         set_default :class, ['alert alert-danger']
         set_default :role, 'alert'
-
       end
 
       class Error < Formular::Element::Error
@@ -34,25 +66,25 @@ module Formular
       end # class Hint
 
       class Input < Formular::Element::Input
-        include Formular::Element::Modules::WrappedControl
+        include Formular::Element::Modules::Wrapped
         include Formular::Element::Bootstrap3::ColumnControl
 
-        set_default :class, ['form-control'], unless: :file_input?
+        set_default :class, :input_class
 
-        def file_input?
-          attributes[:type] == 'file'
+        def input_class
+          'form-control' unless options[:type].to_s == 'file'
         end
       end # class Input
 
       class Select < Formular::Element::Select
-        include Formular::Element::Modules::WrappedControl
+        include Formular::Element::Modules::Wrapped
         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::Modules::Wrapped
         include Formular::Element::Bootstrap3::ColumnControl
 
         set_default :class, ['form-control']

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

@@ -1,5 +1,5 @@
 require 'formular/elements'
-require 'formular/element/modules/wrapped_control'
+require 'formular/element/modules/wrapped'
 require 'formular/element/module'
 
 module Formular
@@ -26,7 +26,7 @@ module Formular
         end # class InlineCheckable
 
         class InlineRadio < Formular::Element::Radio
-          include Formular::Element::Modules::WrappedControl
+          include Formular::Element::Modules::Wrapped
           include InlineCheckable
 
           add_option_keys :control_label_options
@@ -38,11 +38,10 @@ module Formular
         end# class InlineRadio
 
         class InlineCheckbox < Formular::Element::Checkbox
-          include Formular::Element::Modules::WrappedControl
+          include Formular::Element::Modules::Wrapped
           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
@@ -75,11 +74,9 @@ module Formular
         end # module StackedCheckable
 
         class Checkbox < Formular::Element::Checkbox
-          include Formular::Element::Modules::WrappedControl
+          include Formular::Element::Modules::Wrapped
           include StackedCheckable
 
-          set_default :value, '1' # instead of reader value
-
           html { closed_start_tag }
 
           def inner_wrapper_class
@@ -88,7 +85,7 @@ module Formular
         end # class Checkbox
 
         class Radio < Formular::Element::Radio
-          include Formular::Element::Modules::WrappedControl
+          include Formular::Element::Modules::Wrapped
           include StackedCheckable
 
           def inner_wrapper_class