ProMotion-XLForm 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f4516179e94ade36bb17161d5b1c0775dc98e22
-  data.tar.gz: b0e89a0b694883ed6d6e3e1e4a14ef3ef3605433
+  metadata.gz: 55924720d004b7e0a3e9bf60576b3803ef96cfbb
+  data.tar.gz: abf8c29c048a7db559d0decee91fdde5adaaf616
 SHA512:
-  metadata.gz: d54c52b617a102888760cb0be282046f8dfd8fe9cabc53f2f7524c5ce9c3b75be42ef4d001360f3837332c45e7447a2630145edbdff65bd253ad35b5962d0e4a
-  data.tar.gz: 10310f4f000a594e79ff2e3a0d13030c70c44bec98e11315ce6226079e4955c1c20400103d4441d646e5039139115e86ec2975c4c790feeb582305a4bb9474b3
+  metadata.gz: 89a3c12aa9d571911681e0b54a85a91602218c5534c3c7fceaea08d4dadddf691957478cfd6a4dad4af0eb826556118f328b75c88b19f109b7b015393aac4ff5
+  data.tar.gz: fe7a80cedbebf1ecfcf1c540744f2bb5519ae978ea136c5d4e659d72a2df18c0a15c661abd399cd86faedf011d332a01b429dd66cfd0fa7cc14bc9c792991bd7

data/README.md

@@ -5,7 +5,7 @@ ProMotion-XLForm provides a PM::XLFormScreen for [ProMotion](https://github.com/
 ## Warning
 This gem is currently in very early-stage. Use it at your own risk :)
 
-[![Build Status](https://travis-ci.org/bmichotte/ProMotion-XLForm.svg?branch=master)](https://travis-ci.org/bmichotte/ProMotion-XLForm)
+[![Build Status](https://travis-ci.org/bmichotte/ProMotion-XLForm.svg?branch=master)](https://travis-ci.org/bmichotte/ProMotion-XLForm) [![Gem Version](https://badge.fury.io/rb/ProMotion-XLForm.svg)](http://badge.fury.io/rb/ProMotion-XLForm)
 
 ## Installation
 
@@ -169,18 +169,23 @@ You can create a custom _subform_ with a few options
 
 ```ruby
 {
-  title: 'Custom',
-  name:  :custom,
+  title:  'Custom section',
   cells: [
     {
-        title: 'Some text',
-        name:  :some_text,
-        type:  :text
-    },
-    {
-        title: 'Other text',
-        name:  :some_other_text,
-        type:  :text
+      title: 'Custom',
+      name:  :custom,
+      cells: [
+        {
+            title: 'Some text',
+            name:  :some_text,
+            type:  :text
+        },
+        {
+            title: 'Other text',
+            name:  :some_other_text,
+            type:  :text
+        }
+      ]
     }
   ]
 }
@@ -211,6 +216,40 @@ end
 
 For a more advanced custom selector, you can set `view_controller_class:`. See [XLForm documentation](https://github.com/xmartlabs/XLForm/#custom-selectors---selector-row-with-a-custom-selector-view-controller) for more informations.
 
+### Validators
+
+You can add validators to cells.
+
+```ruby
+{
+  title:       'Email',
+  name:        :email,
+  type:        :email,
+  required:    true,
+  validators: {
+    email: true
+  }
+}
+```
+
+`:email` and `:url` are available out of the box, as well as `:regex`. You will have to provide a valid regex and a message.
+
+```ruby
+{
+  title:       'Only letters',
+  name:        :letters,
+  type:        :text,
+  required:    true,
+  validators: {
+    regex: { regex: /^[a-zA-Z]+$/, message: "Only letters please !" }
+  }
+}
+```
+
+Finally, you can provide a PM::Validator with a `valid?(cell)` method.
+
+
+
 ## Todo
 - Validations
 - Tests

data/lib/ProMotion-XLForm.rb

@@ -15,6 +15,9 @@ Motion::Project::App.setup do |app|
   app.files << File.join(lib_dir_path, "ProMotion/XLForm/xl_sub_form_screen.rb")
   app.files << File.join(lib_dir_path, "ProMotion/XLForm/xl_form_patch.rb")
   app.files << File.join(lib_dir_path, "ProMotion/XLForm/value_transformer.rb")
+  app.files << File.join(lib_dir_path, "ProMotion/XLForm/validators/validator.rb")
+  app.files << File.join(lib_dir_path, "ProMotion/XLForm/validators/url_validator.rb")
+  app.files << File.join(lib_dir_path, "ProMotion/XLForm/validators/regex_validator.rb")
 
   app.pods do
     pod 'XLForm', '~> 3.0.0'

data/lib/ProMotion/XLForm/validators/regex_validator.rb

@@ -0,0 +1,20 @@
+module ProMotion
+  class RegexValidator < ProMotion::Validator
+    attr_accessor :regex
+
+    def initialize(message, regex)
+      @message = message
+      @regex = regex
+    end
+
+    def valid?(row)
+      return nil if row.nil? or row.value.nil? or !row.value.is_a?(String)
+
+      !@regex.match(row.value).nil?
+    end
+
+    def self.validator(message, regex)
+      ProMotion::RegexValidator.new(message, regex)
+    end
+  end
+end

data/lib/ProMotion/XLForm/validators/url_validator.rb

@@ -0,0 +1,7 @@
+module ProMotion
+  class UrlValidator
+    def self.validator
+      ProMotion::RegexValidator.validator(NSLocalizedString("Invalid url", nil), /^https?:\/\/.*/)
+    end
+  end
+end

data/lib/ProMotion/XLForm/validators/validator.rb

@@ -0,0 +1,18 @@
+module ProMotion
+  class Validator
+    attr_accessor :message
+
+    def isValid(row)
+      is_valid = nil
+      is_valid = valid?(row) if self.respond_to?(:valid?)
+
+      return nil if is_valid.nil?
+      XLFormValidationStatus.formValidationStatusWithMsg(@message, status: is_valid, rowDescriptor: row)
+    end
+
+    def valid?(row)
+      mp "You have to override valid?", force_color: :red
+    end
+
+  end
+end

data/lib/ProMotion/XLForm/xl_form.rb

@@ -129,6 +129,40 @@ module ProMotion
 
           cell.disabled = !cell_data[:enabled] if cell_data[:enabled]
 
+          # validators
+          if cell_data[:validators]
+            validators = cell_data[:validators]
+            validators.each do |key, value|
+              validator = case key
+              when :email
+                XLFormValidator.emailValidator
+              when :regex
+                regex = value[:regex]
+                if regex.is_a?(String)
+                  XLFormRegexValidator.formRegexValidatorWithMsg(value[:message], regex: regex)
+                elsif regex.is_a?(Regexp)
+                  ProMotion::RegexValidator.validator(value[:message], regex)
+                else
+                  mp "Invalid regex : #{regex.inspect}. Please provides a Regexp or a String", force_color: :red
+                  nil
+                end
+              when :url
+                ProMotion::UrlValidator.validator
+              else
+                if value.is_a?(ProMotion::Validator) or value.respond_to?(:isValid)
+                  value
+                else
+                  mp "Invalid validator : #{key}", force_color: :red
+                  nil
+                end
+              end
+
+              if validator
+                cell.addValidator(validator)
+              end
+            end
+          end
+
           section.addFormRow(cell)
 
           # multi sections

data/lib/ProMotion/XLForm/xl_form_screen.rb

@@ -116,6 +116,60 @@ module ProMotion
       reloadFormRow(cell)
     end
 
+    def add_cell(cell, opts={})
+      if opts[:before]
+        row = opts[:before]
+        if row.is_a?(Symbol)
+          row = cell_with_tag(row)
+        end
+        self.form.addFormRow(cell, beforeRow: row)
+      elsif opts[:after]
+        row = opts[:after]
+        if row.is_a?(Symbol)
+          row = cell_with_tag(row)
+        end
+        self.form.addFormRow(cell, afterRow: row)
+      else
+        mp "Don't know where to add cell, please provides either :before or :after", force_color: :red
+      end
+    end
+
+    def add_section(section, opts={})
+      if opts[:index]
+        self.form.addFormSection(section, atIndex: opts[:index])
+      elsif opts[:after]
+        self.form.addFormSection(section, afterSection: opts[:after])
+      else
+        self.form.addFormSection(section)
+      end
+    end
+
+    def remove_section!(section_or_index)
+      if section_or_index.is_a?(XLFormSectionDescriptor)
+        self.form.removeFormSection(section_or_index)
+      else
+        self.form.removeFormSectionAtIndex(section_or_index)
+      end
+    end
+
+    def remove_cell!(cell)
+      if cell.is_a?(Symbol)
+        self.form.removeFormRowWithTag(cell.to_s)
+      elsif cell.is_a?(String)
+        self.form.removeFormRowWithTag(cell)
+      else
+        self.form.removeFormRow(cell)
+      end
+    end
+
+    def enabled=(value)
+      self.form.disabled = !value
+    end
+
+    def enabled?
+      !self.form.isDisabled
+    end
+
     protected
     def on_cancel(_)
       form_options = self.class.get_form_options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-XLForm
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Benjamin Michotte
@@ -76,6 +76,9 @@ files:
 - README.md
 - lib/ProMotion-XLForm.rb
 - lib/ProMotion/XLForm/cells/xl_form_image_selector_cell.rb
+- lib/ProMotion/XLForm/validators/regex_validator.rb
+- lib/ProMotion/XLForm/validators/url_validator.rb
+- lib/ProMotion/XLForm/validators/validator.rb
 - lib/ProMotion/XLForm/value_transformer.rb
 - lib/ProMotion/XLForm/xl_form.rb
 - lib/ProMotion/XLForm/xl_form_class_methods.rb