ProMotion-form 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdb34e3528a33aab68173408ba3e7c2f5b2735db
-  data.tar.gz: 1f345f26ddb88c497cd0137e37d1f093b4c57894
+  metadata.gz: 249ed0437919e6d2e6009b22b9fd5d8f0308e90d
+  data.tar.gz: 7aab1a9d1f85b7fbc1915991ac961700f6701778
 SHA512:
-  metadata.gz: 00841a64207cb44d75860a80c5555ceef8eadb1a23391a33cc1a3e72dc1e091f308c06a1519da02e438d89f5fca67e59e413db95c256a74077b44af42e04d029
-  data.tar.gz: bc8a5cc57d688f114271720fc070045a70ae5e30230233442a71a6733906c88356dc824f575062a41162e6fb2189aebfbaa205f7ad31a77700ae6d3500d72660
+  metadata.gz: 24382d8bfb44a856369711a19655f931d0fe09b6d49fba189e585eb17faee13d1d449c3900a8de2625643e5b35b02280ee92026735b1c4465ddff6cfb268ac73
+  data.tar.gz: f8ec1bf1e37cd5305be0fa663be32d8dd3fa428e7cda04d205ea8dd610b80eed030600479b633d148abcfcc5f2f4a1aeb9a35ff8c1f38422bf1d9b1c87661d00

data/README.md

@@ -5,6 +5,8 @@
 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?+)
+
 ## Installation
 
 ```ruby
@@ -29,7 +31,20 @@ class MyFormScreen < PM::FormScreen
   title "My Form"
 
   def form_data
-    []
+    [{
+      title: "Account Information",
+      cells: [{
+        name: "email",
+        title: "ID",
+        type: :email,
+        value: current_user.email,
+      }, {
+        name: "password",
+        title: "Password",
+        type: :password,
+        value: ""
+      }]
+    }]
   end
 
 end
@@ -48,8 +63,34 @@ We've used and like Formotion for some form-heavy apps, but it's a rather bulky
 Method that is called to build the form.
 
 ```ruby
-def form_data
-  []
+class AccountScreen < PM::FormScreen
+  title "Account Info"
+
+  def form_data
+    [{
+      title: "Account Information",
+      cells: [{
+        name: "email",
+        title: "ID",
+        type: :email,
+        value: current_user.email,
+      }, {
+        name: "password",
+        title: "Password",
+        type: :password,
+        value: ""
+      }, {
+        name: :submit,
+        title: "Submit",
+        action: "my_action:"
+      }]
+    }]
+  end
+
+  def my_action(cell)
+    # cell is the calling cell, in this case the Submit cell
+    render_form # use to save the data
+  end
 end
 ```
 
@@ -57,15 +98,56 @@ All possible properties:
 
 ```ruby
 {
-  label: "Name",
-  type: :string
+  label: "Name", # or title:
+  name: :name, # required
+  type: :string, # :default is default...
+  options: [ "Water", "Fire", "Wind" ], # for :option type
+  placeholder: "Your name",
+  default: "Jamon",
+  value: "Jamon Holmgren",
+  action: :"my_action:" # use symbol literal with trailing colon
 }
 ```
 
+##### Types of fields:
+
+* `:default`
+* `:label`
+* `:text`
+* `:longtext`
+* `:url`
+* `:email`
+* `:phone`
+* `:password`
+* `:number`
+* `:integer`
+* `:unsigned`
+* `:float`
+* `:bitfield`
+* `:boolean`
+* `:option`
+* `:date`
+* `:time`
+* `:datetime`
+* `:image`
+
+
 #### update_form_data
 
 Forces a reload of the form.
 
+#### render_form
+
+Returns a hash of the fields and values.
+
+```ruby
+render_form # => {:email=>"jkdflsljkdsfad", :password=>"asdfadsfadsf", :submit=>""}
+```
+
+#### dismiss_keyboard
+
+Dismisses the keyboard. Note that you may need to call this before `render_form` to ensure that you capture the input from the currently focused form element.
+
 ---
 
 ### Class Methods
@@ -76,7 +158,9 @@ None yet.
 
 ### Accessors
 
-None yet.
+#### form_object (read only)
+
+This is a Struct with a `#fields` method (what is used to build the form in FXForms) and writeable properties for each field.
 
 ## Contributing
 

data/lib/ProMotion-form.rb

@@ -5,6 +5,7 @@ end
 
 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.rb")
   app.files << File.join(lib_dir_path, "ProMotion/form/form_screen.rb")
 

data/lib/ProMotion/form/form.rb

@@ -1,27 +1,80 @@
 module ProMotion
   class Form
-    attr_accessor :form_data
+    attr_reader :form_data
 
     def initialize(form_data)
       @form_data = form_data
     end
 
+    # Smartly creates a "dumb" FXForms-compatible form object.
+    # It contains the values for every field and also has the
+    # instructions on how to build the form.
+    def build
+      props = properties
+      form_struct = Struct.new(:fields, *props) do
+        props.each do |p|
+          alias_method "set#{p.capitalize}:", "#{p}="
+        end
+      end
+      form_struct.new(form_fields, *values)
+    end
+
+  private
+
     def fields
-      example_fields
+      @fields ||= begin
+        header = nil
+        form_data.map do |section|
+          header = section[:title]
+          Array(section[:cells]).map do |input|
+            input_data(input, header).tap{|i| header = nil }
+          end
+        end.flatten
+      end
+    end
+
+    def properties
+      fields.map{ |f| f[:key] }
+    end
+
+    def values
+      fields.map{ |f| f[:value].to_s }
+    end
+
+    def form_fields
+      fields.map{ |f| f.dup.tap{|f2| f2.delete(:value) } }
+    end
+
+    def input_data(input, header)
+      data = {}
+      data[:header] = header if header
+      data[:key] = input.fetch(:name)
+      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
     end
 
     def example_fields
       [
         {
           key: "email",
-          header: "Account"
+          header: "Account",
+          type: :email
+        },
+        {
+          key: "password",
+          type: :password
         },
-        "password",
         "repeatPassword",
         {
           key: "name",
           header: "Details",
-          "textField.autocapitalizationType" => UITextAutocapitalizationTypeWords
+          # "textField.autocapitalizationType" => UITextAutocapitalizationTypeWords
         },
         {
           key: "gender",
@@ -33,24 +86,24 @@ module ProMotion
         {
           key: "country",
           options: [ "us", "ca", "gb", "sa", "be"],
-          default: "us",
-          valueTransformer: ISO3166CountryValueTransformer.alloc.init
+          # default: "us",
+          # valueTransformer: ISO3166CountryValueTransformer.alloc.init
         },
         {
           key: "language",
           options: [ "English", "Spanish", "French", "Dutch" ],
-          default: "English",
-          cell: FXFormOptionPickerCell
+          # default: "English",
+          # cell: FXFormOptionPickerCell
         },
         {
           key: "interests",
-          default: "Videogames",
+          # default: "Videogames",
           options: [ "Videogames", "Animals", "Cooking" ]
         },
         {
           key: "otherInterests",
           type: :bitfield,
-          default: "InterestComputers",
+          # default: "InterestComputers",
           options: [ "Computers", "Socializing", "Sports" ]
         },
         {
@@ -64,7 +117,7 @@ module ProMotion
           title: "",
           placeholder: "Free",
           options: [ "Micro", "Normal", "Maxi" ],
-          cell: FXFormOptionSegmentsCell
+          # cell: FXFormOptionSegmentsCell
         },
         {
           key: "termsAndConditions",
@@ -83,7 +136,6 @@ module ProMotion
         },
       ]
     end
-
   end
 end
 

data/lib/ProMotion/form/form_screen.rb

@@ -1,9 +1,30 @@
 module ProMotion
-  class FormScreen < FXFormController
+  class FormScreen < PM::FormViewController
     include ProMotion::ScreenModule
 
+    attr_reader :form_object
+
     def screen_setup
-      self.formController.form = PM::Form.new(self.form_data)
+      update_form_data
+    end
+
+    def form_data
+      PM.logger.info "You need to implement a `form_data` method in #{self.class.to_s}."
+      []
+    end
+
+    def update_form_data
+      @form_object = PM::Form.new(self.form_data).build
+      self.formController.form = @form_object
+      self.formController.delegate = self
+    end
+
+    def dismiss_keyboard
+      self.view.endEditing true
+    end
+
+    def render_form
+      Hash[form_object.each_pair.to_a].tap{|h| h.delete(:fields) }
     end
 
   end

data/lib/ProMotion/form/form_view_controller.rb

@@ -0,0 +1,54 @@
+module ProMotion
+  class FormViewController < FXFormViewController
+    def self.new(args = {})
+      s = self.alloc.init
+      s.screen_init(args) if s.respond_to?(:screen_init)
+      s
+    end
+
+    def loadView
+      self.respond_to?(:load_view) ? self.load_view : super
+    end
+
+    def viewDidLoad
+      super
+      self.view_did_load if self.respond_to?(:view_did_load)
+    end
+
+    def viewWillAppear(animated)
+      super
+      self.view_will_appear(animated) if self.respond_to?("view_will_appear:")
+    end
+
+    def viewDidAppear(animated)
+      super
+      self.view_did_appear(animated) if self.respond_to?("view_did_appear:")
+    end
+
+    def viewWillDisappear(animated)
+      self.view_will_disappear(animated) if self.respond_to?("view_will_disappear:")
+      super
+    end
+
+    def viewDidDisappear(animated)
+      self.view_did_disappear(animated) if self.respond_to?("view_did_disappear:")
+      super
+    end
+
+    def shouldAutorotateToInterfaceOrientation(orientation)
+      self.should_rotate(orientation)
+    end
+
+    def shouldAutorotate
+      self.should_autorotate
+    end
+
+    def willRotateToInterfaceOrientation(orientation, duration:duration)
+      self.will_rotate(orientation, duration)
+    end
+
+    def didRotateFromInterfaceOrientation(orientation)
+      self.on_rotate
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ProMotion-form
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jamon Holmgren
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ProMotion
@@ -77,6 +77,7 @@ files:
 - lib/ProMotion-form.rb
 - lib/ProMotion/form/form.rb
 - lib/ProMotion/form/form_screen.rb
+- lib/ProMotion/form/form_view_controller.rb
 homepage: https://github.com/clearsightstudio/ProMotion-form
 licenses:
 - MIT