RedAlert 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb460bb7537e289c09e0a687625240722150b926
-  data.tar.gz: 8045ee75e15e7e3dd3b30d8f38e827ebc5b50c4e
+  metadata.gz: a17fdee3c942135d661b71f10e02a3fa7c897945
+  data.tar.gz: 3b1d14668db687b50e4f7f0005246f93dc08b52f
 SHA512:
-  metadata.gz: 934d7a4b369c1fab4587fb4f0c83ad32f6a508baf64389f8467d1735e601ca755e2e9dc58eba5935a87469003395ce87ac8dd0c2c32a5e03016b4a7a3e9e8da1
-  data.tar.gz: 1839259b6393176975b33e3ac73f1b9721ac6962b3dd2ff87e868c1796476486cdda401bc9e470b0670056bbabbd3b3e4d4631ce8815836d3a02679a54a6dc7d
+  metadata.gz: d9e215e14fa0911d4c5f5e10226ddf7867457637f255635f4f767faa80604afd86964c9d1dede48e5f0a7e1ea87cac7c281f3174f3eb3ad427e5c31c6b25ad5f
+  data.tar.gz: 3129e78629f9b47b6ef29dba0cc6e983dfda0cd322885b9a72b96e26325bf84b6e46759c37a9cca57a95dd8723c98db72f58251f3b7a1d20bfc4fa6afa5882d5

data/README.md

@@ -50,6 +50,18 @@ Add the **RedAlert** gem to your Gemfile.
     puts "You clicked #{action_type}"
   end
 
+  # Add input fields by setting the style
+  rmq.app.alert(title: "Text Field", message: "My style is :login", style: :login) do |action_type, fields|
+    puts "you entered '#{fields[:login].text}' as the login and '#{fields[:password].text}' as the password"
+  end
+
+  # Add input fields with settings for placeholder text, whether the field is secure, and the keyboard type by setting the style to :custom
+  rmq.app.alert(title: "Text Field", message: "My style is :custom", style: :custom, fields:
+               {phone: {placeholder: 'Phone', keyboard_type: :phone_pad},
+                email: {placeholder: 'Email', secure: false, keyboard_type: :email_address}}) do |action_type, fields|
+    puts "you entered '#{fields[:phone].text}' and '#{fields[:email].text}'"
+  end
+
   # Utilize common templates
   rmq.app.alert(message: "Would you like a sandwich?", actions: :yes_no_cancel, style: :sheet) do |action_type|
     case action_type
@@ -74,7 +86,7 @@ end
 ```
 
 
-You can even use the `make_button` helper to create custom UIAction buttons to add:
+You can even use the `make_button` helper to create custom buttons to add:
 ```ruby
   # Use custom UIAction buttons and add them
   taco = rmq.app.make_button("Taco") {
@@ -89,12 +101,18 @@ You can even use the `make_button` helper to create custom UIAction buttons to a
 
 ## Available Templates
 
-Templates are provided [HERE](https://github.com/GantMan/RedAlert/blob/master/lib/project/button_templates.rb)
+Button templates are provided [HERE](https://github.com/GantMan/RedAlert/blob/master/lib/project/button_templates.rb)
 * `:yes_no` = Simple yes and no buttons.
 * `:yes_no_cancel` = Yes/no buttons with a separated cancel button.
 * `:ok_cancel` = OK button with a separated cancel button.
 * `:delete_cancel` = Delete button (red) with a separated cancel button.
 
+Field templates are provided [HERE](https://github.com/GantMan/RedAlert/blob/master/lib/project/field_templates.rb)
+* `:input` = One plaintext input field.
+* `:secure` = One secure input field.
+* `:login` = Two fields, one plaintext with placeholder text 'Login' and the other secure with placeholder text 'Password'.
+* `:change_password` = Two fields, one secure with placeholder text 'Current Password' and the other secure with placeholder text 'New Password'.
+
 :heartbeat: _More to come:_ be sure to submit a pull-request with your button template needs.
 
 
@@ -113,7 +131,7 @@ Because capabilities of iOS 7 & 8 alert-components are different, just a few edg
 * `UIAlertView` cares about the order of your `:cancel` actions, so `[:ok, :cancel]` is shown different than `[:cancel, :ok]`.
 * `UIActionSheet` also cares about the order.  It's possible to put a `:cancel` first, which looks slightly awkward when shown.  Try to put `:cancel` last.
 * `UIAlertView`'s `alertViewStyles` are not available through RedAlert as they aren't compatible with iOS 8.  You'll have to call that directly.
-
+* `UIAlertView only supports up to 2 input fields.`
 
 ## Credits and Info
 
@@ -123,6 +141,8 @@ Because capabilities of iOS 7 & 8 alert-components are different, just a few edg
 
 **Automatic button building by [Jamon Holmgren](https://github.com/GantMan/RedAlert/pull/7)**
 
+**Ability to add textfields to alerts (Like Username/Password) by [Derek Greenberg](https://github.com/GantMan/RedAlert/pull/10) and notable work by [Jon Silverman](https://github.com/GantMan/RedAlert/pull/9)**
+
 Feel free to read up on UIAlertController to see what all is wrapped up in this gem.
 * [Hayageek](http://hayageek.com/uialertcontroller-example-ios/)
 * [NSHipster](http://nshipster.com/uialertcontroller/)

data/lib/project/action_sheet_provider.rb

@@ -5,7 +5,7 @@ module RubyMotionQuery
 
     attr_reader :action_sheet
 
-    def build(actions, opts={})
+    def build(actions, fieldset=nil, opts={})
       raise ArgumentError.new "At least 1 action is required." unless actions && actions.length > 0
       @actions = actions
       @opts = opts
@@ -53,7 +53,7 @@ module RubyMotionQuery
       # pull from the view controller instance
       @view_controller.dismissViewControllerAnimated @opts[:animated], completion: nil
       action = @actions_in_display_order[buttonIndex]
-      action.handler.call(action.tag) if action.handler
+      action.handler.call(action.tag, nil) if action.handler
       @view_controller = nil # forget the reference
     end
 

data/lib/project/alert_controller_provider.rb

@@ -5,7 +5,7 @@ module RubyMotionQuery
 
     attr_reader :alert_controller
 
-    def build(actions, opts={})
+    def build(actions, fieldset = nil, opts={})
       raise ArgumentError.new("At least 1 action is required.") unless actions && actions.length > 0
       @actions = actions
       @opts = opts
@@ -14,6 +14,21 @@ module RubyMotionQuery
       style = RubyMotionQuery::AlertConstants::ALERT_TYPES[@opts[:style]]
       @alert_controller = UIAlertController.alertControllerWithTitle @opts[:title], message:@opts[:message], preferredStyle: style
 
+      # add our text fields and build up the callback hash
+      @text_fields = {}
+      if fieldset
+        fieldset[:fields].each_with_index do |field, index|
+          handler = lambda do |text_field|
+            text_field.placeholder = field.placeholder
+            text_field.secureTextEntry = field.secure_text_entry
+            text_field.keyboardType = RubyMotionQuery::Stylers::KEYBOARD_TYPES[field.keyboard_type]
+          end
+          @alert_controller.addTextFieldWithConfigurationHandler(handler)
+          @text_fields[field.name] = @alert_controller.textFields[index]
+        end
+      end
+
+
       # load up the UIAlertController's actions
       @actions.each do |alert_action|
 
@@ -22,10 +37,10 @@ module RubyMotionQuery
 
         # convert the callback
         handler = lambda do |action|
-          alert_action.handler.call(alert_action.tag) unless alert_action.handler.nil?
+          alert_action.handler.call(alert_action.tag, @text_fields) unless alert_action.handler.nil?
         end if alert_action.handler
 
-        # create teh action
+        # create the action
         action = UIAlertAction.actionWithTitle alert_action.title, style: ios_style, handler: handler
 
         # add it to the UIAlertController

data/lib/project/alert_field.rb

@@ -0,0 +1,18 @@
+module RubyMotionQuery
+  class AlertField
+
+    attr_accessor :keyboard_type
+    attr_accessor :placeholder
+    attr_accessor :secure_text_entry
+    attr_accessor :name
+
+    def initialize(name, opts = {})
+      raise ArgumentError.new "A name parameter must be provided" unless name && name.length > 0
+      opts                = {placeholder: opts, keyboard_type: :default} if opts.is_a? String
+      @name               = name.is_a?(Symbol) ? name : name.strip.gsub(/\s+/,'_').to_sym
+      @keyboard_type      = RubyMotionQuery::Stylers::KEYBOARD_TYPES.has_key?(opts[:keyboard_type]) ? opts[:keyboard_type] : :default
+      @placeholder        = opts[:placeholder] || ''
+      @secure_text_entry  = opts[:secure_text_entry] || false
+    end
+  end
+end

data/lib/project/alert_view_provider.rb

@@ -5,7 +5,7 @@ module RubyMotionQuery
 
     attr_accessor :alert_view
 
-    def build(actions, opts={})
+    def build(actions, fieldset=nil, opts={})
       raise ArgumentError.new("At least 1 action is required.") unless actions && actions.length > 0
       @actions = actions
       @opts = opts
@@ -26,6 +26,20 @@ module RubyMotionQuery
       # mark where our special buttons are
       @alert_view.cancelButtonIndex = @actions_in_display_order.length-1 if cancel_action
 
+      # add our text fields and build up the callback hash
+      @text_fields = {}
+
+      if fieldset
+        @alert_view.alertViewStyle = fieldset[:alert_view_style]
+        fieldset[:fields].each_with_index do |field, index|
+          text_field = @alert_view.textFieldAtIndex index
+          text_field.placeholder = field.placeholder
+          text_field.secureTextEntry = field.secure_text_entry
+          text_field.keyboardType = RubyMotionQuery::Stylers::KEYBOARD_TYPES[field.keyboard_type]
+          @text_fields[field.name] = text_field
+        end
+      end
+
       self
     end
 
@@ -41,7 +55,7 @@ module RubyMotionQuery
     def alertView(alertView, didDismissWithButtonIndex:buttonIndex)
       @view_controller.dismissViewControllerAnimated @opts[:animated], completion: nil
       action = @actions_in_display_order[buttonIndex]
-      action.handler.call(action.tag) if action.handler
+      action.handler.call(action.tag, @text_fields) if action.handler
       @view_controller = nil # forget the reference
     end
 

data/lib/project/field_templates.rb

@@ -0,0 +1,48 @@
+module RubyMotionQuery
+  class App
+
+    # When adding a new template do the following:
+    # 1 - Add it here
+    # 2 - Add the test
+    # 3 - Add symbol to the README.md list
+
+    def self.add_template_fieldset(template)
+
+      login             = NSLocalizedString("Login", nil)
+      password          = NSLocalizedString("Password", nil)
+      current_password  = NSLocalizedString("Current Password", nil)
+      new_password      = NSLocalizedString("New Password", nil)
+
+      fieldset = {alert_view_style: UIAlertViewStyleDefault, fields: [] }
+      case template
+        when :input
+          fieldset[:alert_view_style] = UIAlertViewStylePlainTextInput
+          fieldset[:fields] =
+          [
+            rmq.app.make_field(:text, keyboard_type: :default, secure_text_entry: false, placeholder: '')
+          ]
+        when :secure
+          fieldset[:alert_view_style] = UIAlertViewStyleSecureTextInput
+          fieldset[:fields] =
+            [
+              rmq.app.make_field(:text, keyboard_type: :default, secure_text_entry: true, placeholder: '')
+            ]
+        when :login
+          fieldset[:alert_view_style] = UIAlertViewStyleLoginAndPasswordInput
+          fieldset[:fields] =
+            [
+              rmq.app.make_field(:login, keyboard_type: :email_address, secure_text_entry: false, placeholder: login),
+              rmq.app.make_field(:password, keyboard_type: :default, secure_text_entry: true, placeholder: password)
+            ]
+        when :change_password
+          fieldset[:alert_view_style] = UIAlertViewStyleLoginAndPasswordInput
+          fieldset[:fields] =
+            [
+              rmq.app.make_field(:current_password, keyboard_type: :default, secure_text_entry: true, placeholder: current_password),
+              rmq.app.make_field(:new_password, keyboard_type: :default, secure_text_entry: true, placeholder: new_password)
+            ]
+      end
+      fieldset
+    end
+  end
+end

data/lib/project/red_alert.rb

@@ -2,6 +2,11 @@ module RubyMotionQuery
   class App
     class << self
 
+      TEMPLATE_FIELD_STYLES = [:input, :secure, :change_password, :login]
+      ALL_FIELD_STYLES = TEMPLATE_FIELD_STYLES + [:custom]
+      ALERT_STYLES = ALL_FIELD_STYLES + [:alert]
+      VALID_STYLES = ALERT_STYLES + [:sheet]
+
       # Creates and shows the UIAlertController (iOS 8) or UIAlertView/UIActionSheet (iOS 7).
       # Usage Example:
       #   rmq.app.alert(message: "This is a test")
@@ -15,7 +20,8 @@ module RubyMotionQuery
         opts           = {message: opts} if opts.is_a? String
         opts           = {style: :alert, animated: true, show_now: true}.merge(opts)
         opts[:message] = opts[:message] ? opts[:message].to_s : NSLocalizedString("Alert!", nil)
-        opts[:style]   = :alert unless opts[:style] == :sheet
+        opts[:style]   = VALID_STYLES.include?(opts[:style]) ? opts[:style] : :alert
+        opts[:fields]  = opts[:style] == :custom && opts[:fields] ? opts[:fields] : {text: {placeholder: ''}}
         api            = rmq.device.ios_at_least?(8) ? :modern : :deprecated
         api            = :deprecated if rmq.device.ios_at_least?(8) && opts[:api] == :deprecated
         opts[:api]     = api
@@ -23,16 +29,31 @@ module RubyMotionQuery
         # -----------------------------------------
         # -- Who provides the alerts? -------------
         # -----------------------------------------
+
         if opts[:api] == :modern
           provider = AlertControllerProvider.new
         else
-          if opts[:style] == :alert
+          if ALERT_STYLES.include?(opts[:style])
             provider = AlertViewProvider.new
           else
             provider = ActionSheetProvider.new
           end
         end
 
+        # -------------------------------------------------
+        # -- Configure the input fields --------------
+        # -------------------------------------------------
+
+        fieldset = {alert_view_style: UIAlertViewStyleDefault, fields: []}
+
+        if TEMPLATE_FIELD_STYLES.include?(opts[:style])
+          fieldset = add_template_fieldset(opts[:style])
+        elsif opts[:style] == :custom
+          fieldset = custom_fieldset(opts[:api], opts[:fields])
+        end
+
+        opts[:style] = :alert if ALL_FIELD_STYLES.include?(opts[:style])
+
         # -------------------------------------------------
         # -- Configure the actions (choices) --------------
         # -------------------------------------------------
@@ -50,7 +71,7 @@ module RubyMotionQuery
           # no actions & no block makes alerts a dull boy
           actions << [AlertAction.new(NSLocalizedString("OK", nil))]
         end
-        provider.build(actions.flatten.compact, opts)
+        provider.build(actions.flatten.compact, fieldset, opts)
 
         # --------------------------------------------
         # -- Show the modal right away? --------------
@@ -66,13 +87,44 @@ module RubyMotionQuery
         provider
       end # alert
 
-      # Returns a UIAlertAction from given parameters
+      def custom_fieldset(api_version = :modern, fields)
+        raise ArgumentError.new "At least one field must be provided for a custom style" unless fields && fields.count > 0
+        fieldset = {alert_view_style: UIAlertViewStyleDefault, fields: [] }
+        if api_version == :deprecated
+          case fields.count
+            when 1
+              fieldset[:alert_view_style] = UIAlertViewStylePlainTextInput
+            when 2
+              fieldset[:alert_view_style] = UIAlertViewStyleLoginAndPasswordInput
+            else
+              raise ArgumentError.new "When running iOS < 8, up to two fields can be provided for a custom style"
+          end
+        end
+        alert_fields = []
+        fields.each do |k, v|
+          alert_fields << AlertField.new(k, v)
+        end
+        fieldset[:fields] = alert_fields
+        fieldset
+      end
+
+      # Returns an AlertField from given parameters
+      # Usage Example:
+      #   login = rmq.make_field("Login")
+      #   password = rmq.make_field(:password, secure: true, placeholder: 'Password')
+      # @return [AlertField]
+
+      def make_field(name, opts={})
+        AlertField.new(name, opts)
+      end
+
+      # Returns an AlertAction from given parameters
       # Usage Example:
       #   yes = rmq.make_button("Yes")
       #   cancel = rmq.make_button(title: "Cancel", style: :cancel) {
       #      puts "Cancel pressed"
       #   }
-      # @return [UIAlertAction]
+      # @return [AlertAction]
       def make_button(opts={}, &block)
         AlertAction.new(opts, &block)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RedAlert
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Gant Laborde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-16 00:00:00.000000000 Z
+date: 2015-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_motion_query
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion for
-  iOS 7 & 8
+description: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion Apps
+  on iOS 7 & 8
 email:
 - GantMan@gmail.com
 executables: []
@@ -52,8 +52,10 @@ files:
 - lib/project/alert_action.rb
 - lib/project/alert_constants.rb
 - lib/project/alert_controller_provider.rb
+- lib/project/alert_field.rb
 - lib/project/alert_view_provider.rb
 - lib/project/button_templates.rb
+- lib/project/field_templates.rb
 - lib/project/red_alert.rb
 - lib/red_alert.rb
 homepage: https://github.com/GantMan/RedAlert
@@ -79,6 +81,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion for iOS
-  7 & 8.
+summary: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion Apps on
+  iOS 7 & 8.
 test_files: []