RedAlert 0.3 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f57e36c4618ec386f9f961c6d09df821d1a46a2
-  data.tar.gz: 964e64e00ebe8b9ef7cdadaaf7b60fdbc5a7ac63
+  metadata.gz: d5b3222e32adab1455a1dbd9abce3f10ce3466e8
+  data.tar.gz: 8ef50348c2fae8fc4afca1b9d6265a255eb133e0
 SHA512:
-  metadata.gz: d7a8380d44268eb588f128a47c4dad23d2262f57d2b8ca4e61e2b474dfba15a1bd9bc78913fbe9252b5ea1824a45e558f274a582a9cd21fe722cf0199d6b1799
-  data.tar.gz: 0e78d9602a02a56ff10de0dc9988f53edf1fdc580b79e3eeb2b3720f402d776e673014c1488dfa209b7d674c21f97e2481139768f3221672fae027cb961504e3
+  metadata.gz: 92935d5c9fb5daa8135cc3db5e04bd9747209bae99f8d77754febd10fb425d1b27450b159003afc39d538523145280aecd323bdbf01263c6fa6fbc65f7776d80
+  data.tar.gz: 4e99da49d1942c5c9a27c86a060e10e88fe8a846988d015a61f1f560e0df707f5285c7cf6828af496b5d64601acf094884f15c3e2133aaaa67a980dce7a25964

data/README.md

@@ -1,22 +1,28 @@
 <img src="./_art/logo.png" alt="RedAlert Logo" width="100" />
-[![image](http://ir_wp.s3.amazonaws.com/wp-content/uploads/sites/19/2014/09/rmq_plugin.png)](http://rubymotionquery.com) 
+[![image](http://ir_wp.s3.amazonaws.com/wp-content/uploads/sites/19/2014/09/rmq_plugin.png)](http://rubymotionquery.com)
 
 # RedAlert
 [![Gem Version](https://badge.fury.io/rb/RedAlert.svg)](http://badge.fury.io/rb/RedAlert) [![Build Status](https://travis-ci.org/GantMan/RedAlert.svg)](https://travis-ci.org/GantMan/RedAlert) _Alerts and ActionSheets with ease_
 
 ### Did you know that UIAlertView and UIActionSheet (as well as their respective delegate protocols) are deprecated in iOS 8?
 
-Apple requests you start using the new `UIAlertController`.  This gem is built on `UIAlertController` and RMQ, along with support for antiquated `UIAlertView`s for the gnostalgic.
+Apple requests you start using the new `UIAlertController`.  This gem is built on `UIAlertController` and RMQ, along with seemless support for antiquated `UIAlertView`s & `UIActionSheet`s for the gnostalgic.
 
 With an emphasis on ease of use, this gem allows you to quickly implement Alerts and Actionsheets in your RMQ RubyMotion applications.
 
+When run on iOS 8, RedAlert uses `UIAlertController` to present alerts and sheets.
+
+When run on iOS 7, RedAlert uses `UIAlertView` present alerts and `UIActionSheet` to present sheets.
+
+*:dart: RedAlert Means you don't have to worry about a thing!*
+
 ## Screenshot
 
 <img src="./_art/screen.png" alt="Screen Shot" width="500" />
 
 ## Installation
 
-**Requires RMQ 1.2.0 or later, and iOS 8 or later**
+**Requires RMQ 1.2.0 or later, and iOS 7 or later**
 
 Add the **RedAlert** gem to your Gemfile.
 ```ruby
@@ -76,33 +82,36 @@ Templates are provided [HERE](https://github.com/GantMan/RedAlert/blob/master/li
 * `:ok_cancel` = OK button with a separated cancel button.
 * `:delete_cancel` = Delete button (red) with a separated cancel button.
 
-_More to come:_ be sure to submit a pull-request with your button template needs.
+:heartbeat: _More to come:_ be sure to submit a pull-request with your button template needs.
+
+
+## iOS 7 Support
+
+If you still need iOS 7, RedAlert has your back.
+
+Instead of using iOS 8's UIAlertController, RedAlert will use UIActionSheet to display your sheets and
+UIAlertView to display your views.
+
+**With little-to-no changes to your code.**
+
+Because capabilities of iOS 7 & 8 alert-components are different, just a few edge cases that might sting you (but nothing critical):
+
+* `UIAlertView` doesn't have the concept of :destructive buttons.  These will fall back to :default.
+* `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.
+
 
 ## More info
 
+**i18n support by [Mark Rickert](https://github.com/GantMan/RedAlert/pull/2)**
+
+**iOS 7 support by [Steve Kellock](https://github.com/GantMan/RedAlert/pull/3)**
+
 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/)
 
-## Classic UIAlertView Helpers
-
-If you'd like to still support pre-iOS8, you can easily use `rmq.app.alert_view` with a similar syntax, and instead of actions you'll used the predefined delegates.
-
-**`UIAlertView` Classic:**
-```ruby
-  # support the elderly
-  rmq.app.alert_view("Hey look at this old trick")
- 
-  # Still feels like magic!
-  rmq.app.alert_view({
-    title: "Hey There",
-    message: "Check out this complex alert!",
-    cancel_button: 'Nevermind',
-    other_buttons: ['Log In'],
-    delegate: nil,
-    view_style: UIAlertViewStyleLoginAndPasswordInput
-  })  
-```
 
 ## Contributing
 
@@ -110,4 +119,5 @@ If you'd like to still support pre-iOS8, you can easily use `rmq.app.alert_view`
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Realize no one ever reads this section
+6. Create new Pull Request

data/lib/project/action_sheet_provider.rb

@@ -0,0 +1,62 @@
+module RubyMotionQuery
+
+  # Brings the "I'm not dead yet" iOS 7 UIActionSheet to RedAlert.
+  class ActionSheetProvider
+
+    attr_reader :action_sheet
+
+    def build(actions, opts={})
+      raise ArgumentError.new "At least 1 action is required." unless actions && actions.length > 0
+      @actions = actions
+      @opts = opts
+
+      # grab the first cancel action
+      cancel_action = actions.find { |action| action.cancel? }
+
+      # grab the first destructive action (UIActionSheet only supports one)
+      destructive_action = actions.find { |action| action.destructive? }
+
+      # let's put our actions in the correct display order for our callback
+      @actions_in_display_order = actions.find_all { |action| action.default? }
+      @actions_in_display_order << destructive_action if destructive_action
+      @actions_in_display_order << cancel_action if cancel_action
+
+      # create our action sheet
+      @action_sheet = UIActionSheet.alloc.initWithTitle(
+          @opts[:title] || @opts[:message],
+          delegate: self,
+          cancelButtonTitle: nil,
+          destructiveButtonTitle: nil,
+          otherButtonTitles: nil
+          )
+
+      # then append our other buttons in later
+      @actions_in_display_order.each { |action| @action_sheet.addButtonWithTitle(action.title) }
+
+      # mark where our special buttons are
+      @action_sheet.destructiveButtonIndex = @actions_in_display_order.index { |action| action.destructive? } || -1
+      @action_sheet.cancelButtonIndex = @actions_in_display_order.index { |action| action.cancel? } || -1
+
+      self
+    end
+
+    def show
+      # when we show, the view controller will disappear because a different _UIAlertOverlayWindow window will take its place
+      @view_controller = rmq.view_controller
+      @action_sheet.showInView(@view_controller.view)
+    end
+
+    private
+
+    # fires when we were dismissed <UIActionSheetDelegate>
+    def actionSheet(actionSheet, didDismissWithButtonIndex:buttonIndex)
+      # 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
+      @view_controller = nil # forget the reference
+    end
+
+  end
+
+end

data/lib/project/alert_action.rb

@@ -0,0 +1,32 @@
+module RubyMotionQuery
+  class AlertAction
+
+    VALID_STYLES = [:default, :destructive, :cancel]
+
+    attr_reader :title
+    attr_reader :tag
+    attr_reader :style
+    attr_reader :handler
+
+    def initialize(opts = {}, &block)
+      opts     = {title: opts} if opts.is_a? String
+      @title   = opts[:title] || NSLocalizedString("OK", nil)
+      @tag     = opts[:tag] || @title.gsub(/\s+/,"_").downcase.to_sym
+      @style   = VALID_STYLES.include?(opts[:style]) ? opts[:style] : VALID_STYLES.first
+      @handler = block if block_given?
+    end
+
+    def default?
+      @style == :default
+    end
+
+    def destructive?
+      @style == :destructive
+    end
+
+    def cancel?
+      @style == :cancel
+    end
+
+  end
+end

data/lib/project/alert_controller_provider.rb

@@ -0,0 +1,43 @@
+module RubyMotionQuery
+
+  # The new dual-purpose iOS 8 UIAlertControllerProvider
+  class AlertControllerProvider
+
+    attr_reader :alert_controller
+
+    def build(actions, opts={})
+      raise ArgumentError.new("At least 1 action is required.") unless actions && actions.length > 0
+      @actions = actions
+      @opts = opts
+
+      # create our alert controller
+      style = RubyMotionQuery::AlertConstants::ALERT_TYPES[@opts[:style]]
+      @alert_controller = UIAlertController.alertControllerWithTitle @opts[:title], message:@opts[:message], preferredStyle: style
+
+      # load up the UIAlertController's actions
+      @actions.each do |alert_action|
+
+        # convert the style
+        ios_style = RubyMotionQuery::AlertConstants::ALERT_ACTION_STYLE[alert_action.style]
+
+        # convert the callback
+        handler = lambda do |action|
+          alert_action.handler.call(alert_action.tag) unless alert_action.handler.nil?
+        end if alert_action.handler
+
+        # create teh action
+        action = UIAlertAction.actionWithTitle alert_action.title, style: ios_style, handler: handler
+
+        # add it to the UIAlertController
+        @alert_controller.addAction action
+      end
+
+      self
+    end
+
+    def show
+      rmq.view_controller.presentViewController(@alert_controller, animated: @opts[:animated], completion: nil)
+    end
+
+  end
+end

data/lib/project/alert_view_provider.rb

@@ -0,0 +1,50 @@
+module RubyMotionQuery
+
+  # Brings the venerable iOS 7 AlertView to RedAlert.
+  class AlertViewProvider
+
+    attr_accessor :alert_view
+
+    def build(actions, opts={})
+      raise ArgumentError.new("At least 1 action is required.") unless actions && actions.length > 0
+      @actions = actions
+      @opts = opts
+
+      # grab the first cancel action
+      cancel_action = actions.find { |action| action.cancel? }
+
+      # grab all the default & destructive buttons
+      @actions_in_display_order = actions.find_all { |action| action.default? || action.destructive? }
+      @actions_in_display_order << cancel_action if cancel_action
+
+      # create a buttonless UIAlertView
+      @alert_view = UIAlertView.alloc.initWithTitle @opts[:title], message: @opts[:message], delegate: self, cancelButtonTitle: nil, otherButtonTitles: nil
+
+      # then bring in our buttons in order
+      @actions_in_display_order.each { |action| @alert_view.addButtonWithTitle action.title }
+
+      # mark where our special buttons are
+      @alert_view.cancelButtonIndex = @actions_in_display_order.length-1 if cancel_action
+
+      self
+    end
+
+    def show
+      # NOTE: when we show, the view controller will disappear because a different _UIAlertOverlayWindow window will take its place
+      @view_controller = rmq.view_controller
+      @alert_view.show
+    end
+
+    private
+
+    # fires when it is time to dismiss <UIAlertViewDelegate>
+    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
+      @view_controller = nil # forget the reference
+    end
+
+  end
+
+end

data/lib/project/button_templates.rb

@@ -5,23 +5,41 @@ module RubyMotionQuery
     # 1 - Add it here
     # 2 - Add the test
     # 3 - Add symbol to the README.md list
-    def self.add_template_actions(uiac, template, &block)
+
+
+    def self.add_template_actions(template, &block)
+      yes    = NSLocalizedString("Yes", nil)
+      no     = NSLocalizedString("No", nil)
+      cancel = NSLocalizedString("Cancel", nil)
+      ok     = NSLocalizedString("OK", nil)
+      delete = NSLocalizedString("Delete", nil)
+
       case template
       when :yes_no
-        uiac.addAction(rmq.app.make_button("Yes", &block))
-        uiac.addAction(rmq.app.make_button("No", &block))
+        [
+          rmq.app.make_button(title: yes, tag: :yes, &block),
+          rmq.app.make_button(title: no, tag: :no, &block)
+        ]
       when :yes_no_cancel
-        uiac.addAction(rmq.app.make_button("Yes", &block))
-        uiac.addAction(rmq.app.make_button("No", &block))
-        uiac.addAction(rmq.app.make_button({title: "Cancel", style: :cancel}, &block))
+        [
+          rmq.app.make_button(title: yes, tag: :yes, &block),
+          rmq.app.make_button(title: no, tag: :no, &block),
+          rmq.app.make_button({title: cancel, tag: :cancel, style: :cancel}, &block)
+        ]
       when :ok_cancel
-        uiac.addAction(rmq.app.make_button("OK", &block))
-        uiac.addAction(rmq.app.make_button({title: "Cancel", style: :cancel}, &block))
+        [
+          rmq.app.make_button(ok, &block),
+          rmq.app.make_button({title: cancel, tag: :cancel, style: :cancel}, &block)
+        ]
       when :delete_cancel
-        uiac.addAction(rmq.app.make_button({title: "Delete", style: :destructive}, &block))
-        uiac.addAction(rmq.app.make_button({title: "Cancel", style: :cancel}, &block))
+        [
+          rmq.app.make_button({title: delete, tag: :delete, style: :destructive}, &block),
+          rmq.app.make_button({title: cancel, tag: :cancel, style: :cancel}, &block)
+        ]
+      else
+        []
       end
     end
 
   end
-end
+end

data/lib/project/red_alert.rb

@@ -2,21 +2,69 @@ module RubyMotionQuery
   class App
     class << self
 
-      # Creates and shows the UIAlertController.
+      # Creates and shows the UIAlertController (iOS 8) or UIAlertView/UIActionSheet (iOS 7).
       # Usage Example:
       #   rmq.app.alert(message: "This is a test")
       #   rmq.app.alert(title: "Hey there", message: "Are you happy?")
       # @return [UIAlertController]
-      def alert(opts = {}, &block)
-        # Shortcut: assume a string is the message
-        opts = {message: opts} if opts.is_a? String
-
-        # An alert is nothing without a message
-        raise(ArgumentError, "RedAlert alert requires a message") if RubyMotionQuery::RMQ.is_blank?(opts[:message])
-        # iOS8 and above only for UIAlertController
-        raise "RedAlert requires iOS8 for alerts.  Please try `rmq.app.alert_view`" unless rmq.device.ios_at_least? 8
-        core_alert(opts, &block)
-      end
+      def alert(opts={}, &block)
+
+        # ------------------------------------
+        # -- Setup sane defaults -------------
+        # ------------------------------------
+        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
+        api            = rmq.device.ios_at_least?(8) ? :modern : :deprecated
+        api            = :deprecated if rmq.device.ios_at_least?(8) && opts[:api] == :deprecated
+        opts[:api]     = api
+
+        # -----------------------------------------
+        # -- Who provides the alerts? -------------
+        # -----------------------------------------
+        if opts[:api] == :modern
+          provider = AlertControllerProvider.new
+        else
+          if opts[:style] == :alert
+            provider = AlertViewProvider.new
+          else
+            provider = ActionSheetProvider.new
+          end
+        end
+
+        # -------------------------------------------------
+        # -- Configure the actions (choices) --------------
+        # -------------------------------------------------
+        actions = []
+        if opts[:actions] && opts[:actions].is_a?(Array) && opts[:actions].length > 0
+          # caller has pre-defined actions
+          actions << opts[:actions]
+        elsif opts[:actions] && opts[:actions].is_a?(Symbol)
+          # caller wants a template
+          actions << add_template_actions(opts[:actions], &block)
+        elsif block_given?
+          # convert our block into the one & only action
+          actions << AlertAction.new(NSLocalizedString("OK", nil), &block)
+        else
+          # no actions & no block makes alerts a dull boy
+          actions << [AlertAction.new(NSLocalizedString("OK", nil))]
+        end
+        provider.build(actions.flatten.compact, opts)
+
+        # --------------------------------------------
+        # -- Show the modal right away? --------------
+        # --------------------------------------------
+        provider.show if opts[:show_now]
+
+        # TODO: find a better way to do this ugly housekeeping... right now, this never gets cleaned, so this is leaky.
+        if opts[:api] == :deprecated
+          @rmq_red_alert_providers ||= []
+          @rmq_red_alert_providers << provider
+        end
+
+        provider
+      end # alert
 
       # Returns a UIAlertAction from given parameters
       # Usage Example:
@@ -25,24 +73,11 @@ module RubyMotionQuery
       #      puts "Cancel pressed"
       #   }
       # @return [UIAlertAction]
-      def make_button (opts = {}, &block)
-        # shortcut sending a string
-        opts = {title: opts} if opts.is_a? String
-
-        opts = {
-          title: "OK",
-          style: :default,
-        }.merge(opts)
-
-        style = RubyMotionQuery::AlertConstants::ALERT_ACTION_STYLE[opts[:style]] || opts[:style]
-
-        UIAlertAction.actionWithTitle(opts[:title], style: style, handler: -> (action) {
-          title_symbol = action.title.gsub(/\s+/,"_").downcase.to_sym
-          block.call(title_symbol) unless block.nil?
-        })
+      def make_button(opts={}, &block)
+        AlertAction.new(opts, &block)
       end
 
     end # close eigenclass
 
   end # close App
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RedAlert
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '1.0'
 platform: ruby
 authors:
 - Gant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_motion_query
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion
+description: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion for
+  iOS 7 & 8
 email:
 - GantMan@gmail.com
 executables: []
@@ -47,10 +48,12 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/RedAlert.rb
+- lib/project/action_sheet_provider.rb
+- lib/project/alert_action.rb
 - lib/project/alert_constants.rb
+- lib/project/alert_controller_provider.rb
+- lib/project/alert_view_provider.rb
 - lib/project/button_templates.rb
-- lib/project/classic_alert.rb
-- lib/project/core_alert.rb
 - lib/project/red_alert.rb
 - lib/red_alert.rb
 homepage: https://github.com/GantMan/RedAlert
@@ -76,5 +79,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion.
+summary: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion for iOS
+  7 & 8.
 test_files: []

data/lib/project/classic_alert.rb

@@ -1,42 +0,0 @@
-module RubyMotionQuery
-  class App
-
-    # Creates and shows the old UIAlertView.  Added here for use in fallback.
-    # Fallback won't run actions, but the old system needed delegates anyhow.
-    # Usage Example:
-    #   rmq.app.alert_view("This is a test")
-    #   rmq.app.alert_view(title: "Hey there", message: "Enjoying this?")
-    # @return [UIAlertView]
-    def self.alert_view(opts = {})
-
-      # shortcut sending a string
-      opts = {message: opts} if opts.is_a? String
-      # An alert is nothing without a message
-      raise(ArgumentError, "RedAlert requires a message") if opts[:message].nil? || opts[:message].empty?
-
-      opts = {
-        title: "Alert!",
-        cancel_button: "OK",
-        other_buttons: [],
-        delegate: nil,
-        view_style: UIAlertViewStyleDefault,
-        show_now: true,
-      }.merge(opts)
-
-      alert_view = UIAlertView.alloc.initWithTitle(
-        opts[:title],
-        message: opts[:message],
-        delegate: opts[:delegate],
-        cancelButtonTitle: opts[:cancel_button],
-        otherButtonTitles: nil
-      )
-      Array(opts[:other_buttons]).each { |button| alert_view.addButtonWithTitle(button) }
-
-      alert_view.alertViewStyle = opts[:view_style]
-
-      alert_view.show if opts[:show_now]
-      alert_view
-    end
-
-  end
-end

data/lib/project/core_alert.rb

@@ -1,44 +0,0 @@
-module RubyMotionQuery
-  class App
-
-    class << self
-      # UIAlertController Magic
-      def core_alert(opts = {}, &block)
-
-        opts = {
-          title: "Alert!",
-          style: :alert,
-          actions: [make_button(&block)],
-          animated: true,
-          show_now: true,
-        }.merge(opts)
-        style = RubyMotionQuery::AlertConstants::ALERT_TYPES[opts[:style]] || opts[:style]
-
-        ac = UIAlertController.alertControllerWithTitle(opts[:title], message:opts[:message], preferredStyle: style)
-
-        # Add correct actions (buttons) to the UIAC
-        if opts[:actions].is_a? Symbol
-          template_symbol = opts[:actions]
-          add_template_actions(ac, template_symbol, &block)
-        elsif opts[:actions].is_a? Array
-          opts[:actions].each do |action|
-            if action.is_a? UIAlertAction
-              ac.addAction(action)
-            else
-              raise ArgumentError, "RedAlert actions array must contain UIAlertAction objects"
-            end
-          end
-        else
-          raise ArgumentError, "RedAlert actions parameter must be an Array or a Template symbol"
-        end
-
-        # Present it, if that's what we want
-        rmq.view_controller.presentViewController(ac, animated: opts[:animated], completion: nil) if opts[:show_now]
-
-        # return controller (should I wrap it in RMQ?)
-        ac
-      end
-    end # close eigenclass
-
-  end
-end