formotion 0.5.1 → 1.0

data/lib/formotion/model/formable.rb

@@ -0,0 +1,78 @@
+module Formotion
+  module Formable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      # Relates a property to a RowType.
+      # @param property is the name of the attribute to KVO
+      # @param row_type is the Formotion::RowType to use for that attribute
+      # @param options are the extra options for this model. Keys can include
+      #   any usual Formotion::Row keys to override, plus :transform, which is
+      #   a single-argument lambda for transforming the row's string value before
+      #   it's synced to your model.
+      # EX
+      # form_property :my_title => :string
+      # form_property :my_date => :date, :transform => lambda { |value| some_function(date) }
+      def form_property(property, row_type, options = {})
+        self.form_properties << { property: property, row_type: row_type}.merge(options)
+      end
+
+      def form_properties
+        @form_properties ||= []
+      end
+
+      # Sets the top bar title for this model
+      # EX
+      # form_title "Some Settings"
+      def form_title(title = -1)
+        @form_title = title if title != -1
+        @form_title
+      end
+    end
+
+    # Creates a Formotion::Form out of the model
+    def to_form
+      rows = self.class.form_properties.collect { |options|
+        {
+          title: options[:property].capitalize,
+          key: options[:property],
+          type: options[:row_type],
+          value: self.send(options[:property])
+        }.merge(options)
+      }
+      form_hash = {
+        title: self.class.form_title || self.class.to_s.capitalize,
+        sections: [{
+          rows: rows
+        }]
+      }
+
+      form = Formotion::Form.new(form_hash)
+      form.on_submit do
+        self.on_submit
+      end
+
+      # Use the :transform lambdas passed in form_property
+      form.sections.first.rows.each_with_index { |row, index|
+        row.instance_variable_set("@formable_options", self.class.form_properties[index])
+        if self.class.form_properties[index][:transform]
+          row.class.send(:alias_method, :old_value_setter, :value=)
+          row.instance_eval do
+            def value=(value)
+              old_value_setter(@formable_options[:transform].call(value))
+            end
+          end
+        end
+      }
+
+      form
+    end
+
+    # what happens when the form is submitted?
+    def on_submit
+      p "need to implement on_submit in your Formable model #{self.class.to_s}"
+    end
+  end
+end

data/lib/formotion/row/row.rb

@@ -16,6 +16,8 @@ module Formotion
       # Stores possible formatting information (used by date pickers, etc)
       #   if :type == :date, accepts values in [:short, :medium, :long, :full]
       :format,
+      # alternative title for row (only used in EditRow for now)
+      :alt_title,
 
       # The following apply only to text-input fields
 
@@ -38,8 +40,8 @@ module Formotion
       :clear_button,
       # row height as integer; used for heightForRowAtIndexPath
       # EX 200
-      # DEFAULT is nil, which is used as the tableView.rowHeight
-      :rowHeight,
+      # DEFAULT is nil, which is used as the tableView.row_height
+      :row_height,
       # range used for slider min and max value
       # EX (1..100)
       # DEFAULT is (1..10)
@@ -48,11 +50,30 @@ module Formotion
       # EX ['free', 'pro']
       # DEFAULT is []
       :items,
+      # A hash for a Form used for subforms
+      # DEFAULT is nil
+      :subform,
+      # A hash for a Row used for templates
+      # DEFAULT is nil
+      :template,
+      # Indents row when set to true
+      # DEFAULT is false
+      :indented,
+      # Shows a delete sign next to the row
+      # DEFAULT is false
+      :deletable,
+      # When a row is deleted, actually remove the row from UI
+      # instead of just nil'ing the value.
+      # DEFAULT is false EXCEPT for template-generated rows
+      :remove_on_delete
     ]
     PROPERTIES.each {|prop|
       attr_accessor prop
     }
-    BOOLEAN_PROPERTIES = [:secure]
+    BOOLEAN_PROPERTIES = [:secure, :indented, :deletable, :remove_on_delete]
+    BOOLEAN_PROPERTIES.each { |prop|
+      alias_method "#{prop}?", prop
+    }
     SERIALIZE_PROPERTIES = PROPERTIES
 
     # Reference to the row's section
@@ -78,31 +99,27 @@ module Formotion
     # starts editing #text_field.
     attr_accessor :on_begin_callback
 
-    # row type object
+    # RowType object
     attr_accessor :object
 
+    # Owning template row, if applicable
+    attr_accessor :template_parent
+
     def initialize(params = {})
       super
 
-      BOOLEAN_PROPERTIES.each {|prop|
+      BOOLEAN_PROPERTIES.each { |prop|
         Formotion::Conditions.assert_nil_or_boolean(self.send(prop))
       }
     end
 
-    # Makes all ::BOOLEAN_PROPERTIES queriable with an appended ?
-    # these should be done with alias_method but there's currently a bug
-    # in RM which messes up attr_accessors with alias_method
-    # EX
-    # row.secure?
-    # => true
-    # row.checkable?
-    # => nil
-    def method_missing(method, *args, &block)
-      boolean_method = (method.to_s[0..-2]).to_sym
-      if BOOLEAN_PROPERTIES.member? boolean_method
-        return self.send(boolean_method)
+    # called after section and index have been assigned
+    def after_create
+      if self.type == :template and (self.value && self.value.any?)
+        self.value.each do |value|
+          new_row = self.object.build_new_row({:value => value})
+        end
       end
-      super
     end
 
     #########################
@@ -117,7 +134,7 @@ module Formotion
     end
 
     def reuse_identifier
-      @reuse_identifier || "SECTION_#{self.section.index}_ROW_#{self.index}"
+      @reuse_identifier || "Formotion_#{self.object_id}"
     end
 
     def next_row
@@ -139,8 +156,8 @@ module Formotion
       nil
     end
 
-    def submit_button?
-      object.submit_button?
+    def button?
+      object.button?
     end
 
     #########################
@@ -194,6 +211,22 @@ module Formotion
       super
     end
 
+    def subform=(subform)
+      @subform = subform
+      # enables you do to row.subform.to_form
+      @subform.instance_eval do
+        def to_form
+          return @hash_subform if @hash_subform
+          if self.is_a? Hash
+            @hash_subform = Formotion::Form.new(self)
+          elsif not self.is_a? Formotion::Form
+            raise Formotion::InvalidClassError, "Attempted subform = '#{self.inspect}' should be of type Formotion::Form or Hash"
+          end
+          @hash_subform ||= self
+        end
+      end
+    end
+
     private
     def const_int_get(base, value)
       return value if value.is_a? Integer

data/lib/formotion/row/row_cell_builder.rb

@@ -15,7 +15,7 @@ module Formotion
 
       cell = UITableViewCell.alloc.initWithStyle(row.object.cell_style, reuseIdentifier:row.reuse_identifier)
 
-      cell.accessoryType = UITableViewCellAccessoryNone
+      cell.accessoryType = cell.editingAccessoryType = UITableViewCellAccessoryNone
       cell.textLabel.text = row.title
       cell.detailTextLabel.text = row.subtitle
 

data/lib/formotion/row_type/back_row.rb

@@ -0,0 +1,11 @@
+module Formotion
+  module RowType
+    class BackRow < Button
+
+      def on_select(tableView, tableViewDelegate)
+        row.form.controller.pop_subform
+      end
+
+    end
+  end
+end

data/lib/formotion/row_type/base.rb

@@ -3,6 +3,8 @@ module Formotion
     class Base
       attr_accessor :row, :tableView
 
+      FIELD_BUFFER = Device.iphone? ? 20 : 64
+
       def tableView
         @tableView ||= self.row.form.table
       end
@@ -11,7 +13,7 @@ module Formotion
         @row = row
       end
 
-      def submit_button?
+      def button?
         false
       end
 
@@ -20,6 +22,16 @@ module Formotion
         UITableViewCellStyleSubtitle
       end
 
+      # Sets the UITableViewCellEditingStyle
+      def cellEditingStyle
+        row.deletable? ? UITableViewCellEditingStyleDelete : UITableViewCellEditingStyleNone
+      end
+
+      # Indents row while editing
+      def indentWhileEditing?
+        row.indented?
+      end
+
       # builder method for row cell specific implementation
       def build_cell(cell)
         # implement in row class
@@ -36,6 +48,35 @@ module Formotion
       def on_select(tableView, tableViewDelegate)
         # implement in row class
       end
+
+      # called when the delete editing style was triggered tableView:commitEditingStyle:forRowAtIndexPath:
+      def on_delete(tableView, tableViewDelegate)
+        if row.remove_on_delete?
+          row.section.rows.delete_at(row.index)
+          row.section.refresh_row_indexes
+          delete_row
+        else
+          row.value = nil
+          self.tableView.reloadData
+        end
+      end
+
+      def delete_row
+        tableView.beginUpdates
+        tableView.deleteRowsAtIndexPaths [row.index_path], withRowAnimation:UITableViewRowAnimationBottom
+        tableView.endUpdates
+      end
+
+      def break_with_semaphore(&block)
+        return if @semaphore
+        with_semaphore(&block)
+      end
+
+      def with_semaphore(&block)
+        @semaphore = true
+        block.call
+        @semaphore = false
+      end
     end
   end
 end

data/lib/formotion/row_type/button.rb

@@ -0,0 +1,30 @@
+module Formotion
+  module RowType
+    class Button < Base
+
+      def button?
+        true
+      end
+
+      # Does a clever little trick to override #layoutSubviews
+      # for just this one UITableViewCell object, in order to
+      # center it's labels horizontally.
+      def build_cell(cell)
+        cell.swizzle(:layoutSubviews) do
+          def layoutSubviews
+            old_layoutSubviews
+
+            center = lambda {|frame, dimen|
+              ((self.frame.size.send(dimen) - frame.size.send(dimen)) / 2.0)
+            }
+
+            self.textLabel.center = CGPointMake(self.frame.size.width / 2 - (FIELD_BUFFER / 2), self.textLabel.center.y)
+            self.detailTextLabel.center = CGPointMake(self.frame.size.width / 2 - (FIELD_BUFFER / 2), self.detailTextLabel.center.y)
+          end
+        end
+        nil
+      end
+
+    end
+  end
+end

data/lib/formotion/row_type/check_row.rb

@@ -1,13 +1,21 @@
 module Formotion
   module RowType
     class CheckRow < Base
+      include BW::KVO
+
+      def update_cell_value(cell)
+        cell.accessoryType = cell.editingAccessoryType = row.value ? UITableViewCellAccessoryCheckmark : UITableViewCellAccessoryNone
+      end
 
       # This is actually called whenever again cell is checked/unchecked
       # in the UITableViewDelegate callbacks. So (for now) don't
       # instantiate long-lived objects in them.
       # Maybe that logic should be moved elsewhere?
       def build_cell(cell)
-        cell.accessoryType = row.value ? UITableViewCellAccessoryCheckmark : UITableViewCellAccessoryNone
+        update_cell_value(cell)
+        observe(self.row, "value") do |old_value, new_value|
+          update_cell_value(cell)
+        end
         nil
       end
 
@@ -15,13 +23,9 @@ module Formotion
         if row.section.select_one and !row.value
           row.section.rows.each do |other_row|
             other_row.value = (other_row == row)
-
-            cell = tableView.cellForRowAtIndexPath(other_row.index_path)
-            other_row.object.build_cell(cell) if cell
           end
         elsif !row.section.select_one
           row.value = !row.value
-          build_cell(tableView.cellForRowAtIndexPath(row.index_path))
         end
       end
 

data/lib/formotion/row_type/date_row.rb

@@ -56,6 +56,11 @@ module Formotion
           picker
         end
       end
+
+      # Used when row.value changes
+      def update_text_field(new_value)
+        self.row.text_field.text = self.formatted_value
+      end
     end
   end
 end

data/lib/formotion/row_type/edit_row.rb

@@ -0,0 +1,14 @@
+module Formotion
+  module RowType
+    class EditRow < Button
+      def on_select(tableView, tableViewDelegate)
+        was_editing = tableView.isEditing
+        if row.alt_title
+          new_title = !was_editing ? row.alt_title : row.title
+          tableView.cellForRowAtIndexPath(row.index_path).textLabel.text = new_title
+        end
+        tableView.setEditing(!was_editing, animated: true)
+      end
+    end
+  end
+end

data/lib/formotion/row_type/image_row.rb

@@ -11,10 +11,10 @@ module Formotion
         observe(self.row, "value") do |old_value, new_value|
           @image_view.image = new_value
           if new_value
-            self.row.rowHeight = 200
-            cell.accessoryView = nil
+            self.row.row_height = 200
+            cell.accessoryView = cell.editingAccessoryView = nil
           else
-            self.row.rowHeight = 44
+            self.row.row_height = 44
             add_plus_accessory(cell)
           end
           row.form.reload_data
@@ -36,9 +36,9 @@ module Formotion
 
             field_frame = formotion_field.frame
             field_frame.origin.y = 10
-            field_frame.origin.x = self.textLabel.frame.origin.x + self.textLabel.frame.size.width + 20
-            field_frame.size.width  = self.frame.size.width - field_frame.origin.x - 20
-            field_frame.size.height = self.frame.size.height - 20
+            field_frame.origin.x = self.textLabel.frame.origin.x + self.textLabel.frame.size.width + FIELD_BUFFER
+            field_frame.size.width  = self.frame.size.width - field_frame.origin.x - FIELD_BUFFER
+            field_frame.size.height = self.frame.size.height - FIELD_BUFFER
             formotion_field.frame = field_frame
           end
         end
@@ -92,7 +92,7 @@ module Formotion
           end
           button
         end
-        cell.accessoryView = @add_button
+        cell.accessoryView = cell.editingAccessoryView = @add_button
       end
     end
   end

data/lib/formotion/row_type/options_row.rb

@@ -1,18 +1,28 @@
 module Formotion
   module RowType
     class OptionsRow < Base
-
-      SLIDER_VIEW_TAG = 1200
+      include BW::KVO
 
       def build_cell(cell)
         cell.selectionStyle = UITableViewCellSelectionStyleNone
-        slideView = UISegmentedControl.alloc.initWithItems(row.items || [])
-        slideView.selectedSegmentIndex = row.items.index(row.value) if row.value
-        slideView.segmentedControlStyle = UISegmentedControlStyleBar
-        cell.accessoryView = slideView
+        segmentedControl = UISegmentedControl.alloc.initWithItems(row.items || [])
+        segmentedControl.selectedSegmentIndex = row.items.index(row.value) if row.value
+        segmentedControl.segmentedControlStyle = UISegmentedControlStyleBar
+        cell.accessoryView = cell.editingAccessoryView = segmentedControl
 
-        slideView.when(UIControlEventValueChanged) do
-          row.value = row.items[slideView.selectedSegmentIndex]
+        segmentedControl.when(UIControlEventValueChanged) do
+          break_with_semaphore do
+            row.value = row.items[segmentedControl.selectedSegmentIndex]
+          end
+        end
+        observe(self.row, "value") do |old_value, new_value|
+          break_with_semaphore do
+            if row.value
+              segmentedControl.selectedSegmentIndex = row.items.index(row.value)
+            else
+              segmentedControl.selectedSegmentIndex = UISegmentedControlNoSegment
+            end
+          end
         end
 
         nil