ProMotion-form 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b922948c52029bb1454414b2e927d91b440d6e43
-  data.tar.gz: e10fcd0f56e5e7c26aa9a5734becfb985d5c7829
+  metadata.gz: a9e98a207439d8f6f934f0cf7e0ad64b0b856158
+  data.tar.gz: 35513b987a9c722aa6c4df7de95d5c0dbf5cd66e
 SHA512:
-  metadata.gz: 9d5cd76b789dff0ef1f5e0b4a3a2ac7817913bd30f84397daec58603373b50e911deefcf24506706c7654c2b014baa3704cb7b3a15342447e75a74b35b97909f
-  data.tar.gz: 58a88eb9ea2edf44d47c19b0e368c23d8c9afe1b6ba7f9ae666aa24b97927f0865cadfc2690066be1d3374405e1dd371f9623077bb6665568ea6f30f1f3f2529
+  metadata.gz: 2dc1a5e2e9fd723142c4fbd53de5412669a36a963b7a68fe758f2e21cf319f64d2f0138fffedd85830814ca7adba7ac9557cb3e14937321d7133abed1f4a4bf7
+  data.tar.gz: 57e88697ef4ce65a8d8b7b5df6023056dc89562223c7f8269f1222a2eda683b3fc349b674271e3b000058687d76c4a40063e6a333f296a96c1d18a301e74a7d5

data/README.md

@@ -1,11 +1,11 @@
 # ProMotion-form
 
-[![Gem Version](https://badge.fury.io/rb/ProMotion-form.svg)](http://badge.fury.io/rb/ProMotion-form) [![Build Status](https://travis-ci.org/clearsightstudio/ProMotion-form.svg)](https://travis-ci.org/clearsightstudio/ProMotion-form) [![Code Climate](https://codeclimate.com/github/clearsightstudio/ProMotion-form/badges/gpa.svg)](https://codeclimate.com/github/clearsightstudio/ProMotion-form)
+[![Gem Version](https://badge.fury.io/rb/ProMotion-form.svg)](http://badge.fury.io/rb/ProMotion-form) [![Build Status](https://travis-ci.org/clearsightstudio/ProMotion-form.svg?branch=master)](https://travis-ci.org/clearsightstudio/ProMotion-form) [![Code Climate](https://codeclimate.com/github/clearsightstudio/ProMotion-form/badges/gpa.svg)](https://codeclimate.com/github/clearsightstudio/ProMotion-form)
 
 ProMotion-form provides a PM::FormScreen for the
 popular RubyMotion gem [ProMotion](https://github.com/clearsightstudio/ProMotion).
 
-![form](http://clrsight.co/jh/Screen_Shot_2014-08-29_at_4.03.13_PM.png?+)
+![form](http://i.imgur.com/pQbGqK1.png)
 
 ## Installation
 
@@ -24,7 +24,7 @@ $ rake pod:install
 
 Easily create a form screen. Powered by the CocoaPod [FXForms](https://github.com/nicklockwood/FXForms).
 
-*Has all the methods of PM::Screen*
+#### Has all the methods of PM::Screen
 
 ```ruby
 class MyFormScreen < PM::FormScreen
@@ -51,6 +51,35 @@ class MyFormScreen < PM::FormScreen
 end
 ```
 
+#### Can also be driven by properties available in [FXForms](https://github.com/nicklockwood/FXForms) Docs.
+
+```ruby
+class MyFormScreen < PM::FormScreen
+  title "My Form"
+
+  def form_data
+    [{
+      title: "Account Information",
+      footer: "Some help text",
+      cells: [{
+        key: "email",
+        label: "ID",
+        type: :email,
+        "textLabel.font" => UIFont.fontWithName('Helvetica-Light', size: 25),
+        value: current_user.email,
+      }, {
+        key: "password",
+        label: "New Password",
+        type: :password,
+        "textLabel.color" => UIColor.blueColor,
+        value: "",
+      }]
+    }]
+  end
+
+end
+```
+
 ### What about Formotion?
 
 We have used and like Formotion for some form-heavy apps, but it's a rather bulky gem. ProMotion-form works better with ProMotion and is a lot smaller.
@@ -97,11 +126,20 @@ class AccountScreen < PM::FormScreen
 end
 ```
 
-All possible form field properties:
+All form field properties from FXForms are exposed.  A full listing can be found [here in their Readme](https://github.com/nicklockwood/FXForms#form-field-properties).
+
+Additional "helper" field properties have been started, and are listed below:
+  * `name` - a convenience alias to FXForms `key`. If no name is provided, title is converted to a symbol and used as the key.
+  * `title` - when no title is provided, label and then name are used respectively.
+  * `cell_class` - a convenience alias to FXForms `cell`, but with the ProMotion naming scheme.
+}
+```
+
+Here are sample form fields with some explanation
 
 ```ruby
 {
-  label: "Name", # or title:
+  label: "Name", # or title
   name: :name, # defaults to symbol of snake_cased label/title
   type: :string, # :default is default...like a button
   options: [ "Water", "Fire", "Wind" ], # for a subform select (`type` can be anything)
@@ -112,7 +150,7 @@ All possible form field properties:
 }
 ```
 
-##### Types of fields:
+##### Field types:
 
 * `:default`
 * `:label`
@@ -124,7 +162,7 @@ All possible form field properties:
 * `:password`
 * `:number`
 * `:integer`
-* `:unsigned` - Coming soon
+* `:unsigned`
 * `:float`
 * `:bitfield`
 * `:boolean`
@@ -134,10 +172,76 @@ All possible form field properties:
 * `:datetime`
 * `:image`
 
+##### Helper keys:
+
+* `:cell` or `:cell_class` - use a custom cell class
+* `:properties` - a flexible way to set cell properties (see Styling section below)
+*  string keys - you can also define styling parameters as top-level strings
+
+## Styling
+
+#### Method 1: Put them into a hash
+
+```
+  properties: {
+    "accessoryView"        => CustomAccessory.new,
+    "backgroundColor"      => UIColor.colorWhite,
+    "detailTextLabel.font" => UIFont.fontWithName("MyFont", size:20),
+  },
+}
+```
+
+#### Method 2: Use the `style` helper
+
+```
+def styles
+  {
+    basic: {
+      "accessoryView"        => CustomAccessory.new,
+      "detailTextLabel.font" => UIFont.fontWithName("MyFont", size:20),
+    },
+  }
+end
+
+...
+
+  properties: style(:basic),
+}
+```
+
+#### Method 3: Combine styles
+
+```
+def styles
+  {
+    basic: {
+      "accessoryView"        => CustomAccessory.new,
+      "detailTextLabel.font" => UIFont.fontWithName("MyFont", size:20),
+    },
+    alert: {
+      "backgroundColor"      => UIColor.redColor,
+    },
+  }
+end
+
+...
+
+  properties: style(:basic, :alert),
+}
+```
+
+#### Method 4: Combine styles, with overrides (using '+')
+
+```
+  properties: style(:basic, :alert) + {
+    "backgroundColor" => UIColor.yellowColor,
+  },
+}
+```
 
 #### update_form_data
 
-Forces a reload of the form.
+Forces a reload of the form.  This is useful when you have changed the hash you returned in your `form_data` method.
 
 #### render_form
 

data/lib/ProMotion-form.rb

@@ -7,7 +7,9 @@ require 'motion-cocoapods'
 Motion::Project::App.setup do |app|
   lib_dir_path = File.dirname(File.expand_path(__FILE__))
   app.files << File.join(lib_dir_path, "ProMotion/form/form_view_controller.rb")
+  app.files << File.join(lib_dir_path, "ProMotion/form/form_style.rb")
   app.files << File.join(lib_dir_path, "ProMotion/form/form.rb")
+  app.files << File.join(lib_dir_path, "ProMotion/form/form_screen_style.rb")
   app.files << File.join(lib_dir_path, "ProMotion/form/form_screen.rb")
 
   app.pods do

data/lib/ProMotion/form/form.rb

@@ -47,15 +47,20 @@ module ProMotion
 
     def input_data(input)
       data = {}
-      data[:key] = input[:name] || input[:title].downcase.gsub(/[^0-9a-z]/i, '_').to_sym
-      data[:type] = input[:type] if input[:type]
-      data[:title] = input[:label] || input[:title] || input[:name].to_s
-      data[:options] = input[:options] if input[:options]
-      data[:placeholder] = input[:placeholder] if input[:placeholder]
-      data[:default] = input[:default] if input[:default]
-      data[:value] = input[:value] if input[:value]
-      data[:action] = input[:action] if input[:action]
-      data[:cell] = input[:cell_class] if input[:cell_class]
+
+      # process "before" helper keys
+      data.update(FormStyle.to_style(input[:properties])) if input[:properties]
+      data.update(FormStyle.to_style(input[:style     ])) if input[:style     ]
+
+      # pass non-helper keys to FXForms
+      helpers = [ :cell_class, :name, :style, :properties ]
+      (input.keys - helpers).each {|key| data[key] = input[key] }
+
+      # process "after" helper keys
+      data[:key  ] ||= input[:name ] || input[:title].downcase.gsub(/[^0-9a-z]/i, '_').to_sym
+      data[:title] ||= input[:label] || input[:name ].to_s
+      data[:cell ] ||= input[:cell_class] if input[:cell_class]
+
       data
     end
 
@@ -71,41 +76,44 @@ module ProMotion
   end
 end
 
-# static NSString *const key = @"key";
-# static NSString *const FXFormFieldType = @"type";
-# static NSString *const FXFormFieldClass = @"class";
-# static NSString *const cell = @"cell";
-# static NSString *const title = @"title";
-# static NSString *const placeholder = @"placeholder";
-# static NSString *const default = @"default";
-# static NSString *const options = @"options";
-# static NSString *const FXFormFieldTemplate = @"template";
-# static NSString *const valueTransformer = @"valueTransformer";
-# static NSString *const action = @"action";
-# static NSString *const FXFormFieldSegue = @"segue";
-# static NSString *const header = @"header";
-# static NSString *const FXFormFieldFooter = @"footer";
-# static NSString *const FXFormFieldInline = @"inline";
-# static NSString *const FXFormFieldSortable = @"sortable";
-# static NSString *const FXFormFieldViewController = @"viewController";
-
-# static NSString *const FXFormFieldTypeDefault = @"default";
-# static NSString *const FXFormFieldTypeLabel = @"label";
-# static NSString *const FXFormFieldTypeText = @"text";
-# static NSString *const :longtext = @"longtext";
-# static NSString *const FXFormFieldTypeURL = @"url";
-# static NSString *const FXFormFieldTypeEmail = @"email";
-# static NSString *const FXFormFieldTypePhone = @"phone";
-# static NSString *const FXFormFieldTypePassword = @"password";
-# static NSString *const FXFormFieldTypeNumber = @"number";
-# static NSString *const FXFormFieldTypeInteger = @"integer";
-# static NSString *const FXFormFieldTypeUnsigned = @"unsigned";
-# static NSString *const FXFormFieldTypeFloat = @"float";
-# static NSString *const :bitfield = @"bitfield";
-# static NSString *const FXFormFieldTypeBoolean = @"boolean";
-# static NSString *const :option = @"option";
-# static NSString *const FXFormFieldTypeDate = @"date";
-# static NSString *const FXFormFieldTypeTime = @"time";
-# static NSString *const FXFormFieldTypeDateTime = @"datetime";
-# static NSString *const FXFormFieldTypeImage = @"image";
+# Fields
+# ======
+# NSString *const FXFormFieldKey              = @"key";
+# NSString *const FXFormFieldType             = @"type";
+# NSString *const FXFormFieldClass            = @"class";
+# NSString *const FXFormFieldCell             = @"cell";
+# NSString *const FXFormFieldTitle            = @"title";
+# NSString *const FXFormFieldPlaceholder      = @"placeholder";
+# NSString *const FXFormFieldDefaultValue     = @"default";
+# NSString *const FXFormFieldOptions          = @"options";
+# NSString *const FXFormFieldTemplate         = @"template";
+# NSString *const FXFormFieldValueTransformer = @"valueTransformer";
+# NSString *const FXFormFieldAction           = @"action";
+# NSString *const FXFormFieldSegue            = @"segue";
+# NSString *const FXFormFieldHeader           = @"header";
+# NSString *const FXFormFieldFooter           = @"footer";
+# NSString *const FXFormFieldInline           = @"inline";
+# NSString *const FXFormFieldSortable         = @"sortable";
+# NSString *const FXFormFieldViewController   = @"viewController";
 
+# Types
+# =====
+# NSString *const FXFormFieldTypeDefault      = @"default";
+# NSString *const FXFormFieldTypeLabel        = @"label";
+# NSString *const FXFormFieldTypeText         = @"text";
+# NSString *const FXFormFieldTypeLongText     = @"longtext";
+# NSString *const FXFormFieldTypeURL          = @"url";
+# NSString *const FXFormFieldTypeEmail        = @"email";
+# NSString *const FXFormFieldTypePhone        = @"phone";
+# NSString *const FXFormFieldTypePassword     = @"password";
+# NSString *const FXFormFieldTypeNumber       = @"number";
+# NSString *const FXFormFieldTypeInteger      = @"integer";
+# NSString *const FXFormFieldTypeUnsigned     = @"unsigned";
+# NSString *const FXFormFieldTypeFloat        = @"float";
+# NSString *const FXFormFieldTypeBitfield     = @"bitfield";
+# NSString *const FXFormFieldTypeBoolean      = @"boolean";
+# NSString *const FXFormFieldTypeOption       = @"option";
+# NSString *const FXFormFieldTypeDate         = @"date";
+# NSString *const FXFormFieldTypeTime         = @"time";
+# NSString *const FXFormFieldTypeDateTime     = @"datetime";
+# NSString *const FXFormFieldTypeImage        = @"image";

data/lib/ProMotion/form/form_screen.rb

@@ -1,6 +1,7 @@
 module ProMotion
-  class FormScreen < PM::FormViewController
+  class FormScreen < FormViewController
     include ProMotion::ScreenModule
+    include ProMotion::FormScreenStyle
 
     attr_reader :form_object
 
@@ -28,6 +29,5 @@ module ProMotion
     def render_form
       Hash[form_object.each_pair.to_a].tap{|h| h.delete(:fields) }
     end
-
   end
 end

data/lib/ProMotion/form/form_screen_style.rb

@@ -0,0 +1,21 @@
+module ProMotion
+  module FormScreenStyle
+    def style(*ary)
+      @form_styles ||= styles
+      @form_styles_cache ||= {}
+      @form_styles_cache[ary * ':'] ||= ary.inject(PM::FormStyle.new) do |all, one|
+        one ? (all << @form_styles[one]) : all
+      end
+    end
+
+    def style!(*ary)
+      @form_style_sticky = ary.empty? ? nil : ary
+      style(*ary)
+    end
+
+    def style?(*ary)
+      ary.unshift(*@form_style_sticky) if @form_style_sticky
+      style(*ary)
+    end
+  end
+end

data/lib/ProMotion/form/form_style.rb

@@ -0,0 +1,28 @@
+module ProMotion
+  class FormStyle < Hash
+    def initialize(obj=nil)
+      replace(obj) if obj.kind_of? Hash
+    end
+
+    def +(obj)
+      merge(obj || {})
+    end
+
+    def <<(obj)
+      merge!(obj || {})
+    end
+
+    def self.to_style(obj, out={}, ary=[])
+      obj.each do |key, val|
+        case val
+        when Hash  then next to_style(val, out, ary + [key.to_s])
+        when Class then val = val.new
+        when Proc  then val = val.call
+        end
+        all = (ary + [key.to_s]) * '.'
+        val ? (out[all] = val) : out.delete(all)
+      end
+      out
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-form
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Jamon Holmgren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ProMotion
@@ -91,6 +91,8 @@ files:
 - lib/ProMotion-form.rb
 - lib/ProMotion/form/form.rb
 - lib/ProMotion/form/form_screen.rb
+- lib/ProMotion/form/form_screen_style.rb
+- lib/ProMotion/form/form_style.rb
 - lib/ProMotion/form/form_view_controller.rb
 homepage: https://github.com/clearsightstudio/ProMotion-form
 licenses:
@@ -117,4 +119,3 @@ signing_key:
 specification_version: 4
 summary: Adds PM::FormScreen support to ProMotion, similar to Formotion but lighter.
 test_files: []
-has_rdoc: