RedAlert 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fdabf0f5f8e1bf91a9f0011a1364df64391e9e2
-  data.tar.gz: 9eba51d49bb9963101eaa8599f1b4fe7042436dc
+  metadata.gz: 24b9cea163ecc89a14bd430541cce2ef68d1b481
+  data.tar.gz: 523230fefd756501194b7fbce9f70543facacbf4
 SHA512:
-  metadata.gz: 309e8754b89b2bc44a2745e5ded3cface2b14a5831237ef98075491806843a2a29ef6647b7b85d009a89f9ff348a4d102d69f9c93988b5a23f0d43aaa6e8a4c8
-  data.tar.gz: db0d2a6c17c14d675fe34652895dd5be0a9718fbd003950cdb3d52a9e87f907352d18373f8db47854b535b4ba28a9f64567e74d38c2981ce3ea08b3b6f3a49c9
+  metadata.gz: 99ce20158fa93775969ec3b5aa88691cf30ca7f489b128821bbef3c819532b8acd126a2b8fbedd40ee5222557503bacba711be40697cb17df212cc26e6c912be
+  data.tar.gz: c95f987cdaa2c52662007c2fe942692d88475190179a8fbaa9f5e3f887878ba0d1c5cf0ec7aa8aaeb1392e3742c29050a0f975e42aaedb53dead289e5520e63f

data/README.md

@@ -1,64 +1,108 @@
-[![image](http://ir_wp.s3.amazonaws.com/wp-content/uploads/sites/19/2014/09/rmq_plugin.png)](http://rubymotionquery.com)
+<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) 
 
 # 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?**
+### Did you know that UIAlertView and UIActionSheet (as well as their respective delegate protocols) are deprecated in iOS 8?
 
-`UIAlertController` is used in this gem.   Gracefully falls back to `UIAlertView` for versions older than iOS8
+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.
+
+With an emphasis on ease of use, this gem allows you to quickly implement Alerts and Actionsheets in your RMQ RubyMotion applications.
+
+## Screenshot
+
+<img src="./_art/screen.png" alt="Screen Shot" width="500" />
 
 ## Installation
 
-**Requires RMQ 0.8.0 or later, and iOS 7 or later**#
+**Requires RMQ 1.2.0 or later, and iOS 8 or later**
 
-TODO: Write install instructions here
+Add the **RedAlert** gem to your Gemfile.
+```ruby
+  gem 'RedAlert'
+```
 
 ## Usage
+**Note:  If you're using [RedPotion](https://github.com/infinitered/redpotion) then `rmq.app` can be accessed by simply typing `app`, so `rmq.app.alert` would be simply `app.alert`.  The following examples are verbose and assume only [RMQ](https://github.com/infinitered/rmq).**
 
-TODO: Write usage instructions here
 ```ruby
 
-  rmq.alert("Are you alive?") do
-    p "He is alive!"
-  end
+  # Simply do an alert
+  rmq.app.alert("Minimal Alert")
+
+  # Alert with callback
+  rmq.app.alert("Alert with Block") {
+    puts "Alert with Block worked!"
+  }
 
-  rmq.alert(title: "foo", message: "Are you alive?") do
-    p "He is alive!"
+  # Modify some snazzy options
+  rmq.app.alert(title: "New Title", message: "Great message", animated: false)
+
+  # Switch it to look like an ActionSheet by setting the style
+  rmq.app.alert(title: "Hey there!", message: "My style is :sheet", style: :sheet) do |action_type|
+    puts "You clicked #{action_type}"
   end
 
-  rmq.alert(message: "Would you like a sandwich?", actions: :yes_no_cancel, style: :sheet) { |action_type|
+  # Utilize common templates
+  rmq.app.alert(message: "Would you like a sandwich?", actions: :yes_no_cancel, style: :sheet) do |action_type|
     case action_type
     when :yes
-      p "yes"
+      puts "Here's your Sandwich!"
     when :no
-      p "no"
+      puts "FINE!"
     end
-  }
-
-
-  rmq.alert(title: "foo", message: "Would you like a sandwich?", actions: []
-  }
-
+  end
+```
 
-  rmq.alert(title: "More Actions",
-            message: "UIViewController 2",
-            actions: [
-              {text: "OK", style: :default, handler: ->{}}
-              {text: "OK", style: :default, handler: ->{}}
-            ])
+You can even use the `make_button` helper to create custom UIAction buttons to add:
+```ruby
+  # Use custom UIAction buttons and add them
+  taco = rmq.app.make_button("Taco") {
+            puts "Taco pressed"
+          }
+  nacho = rmq.app.make_button(title: "Nacho", style: :destructive)  {
+            puts "Nacho pressed"
+          }
+  button_list = [taco, nacho]
+  rmq.app.alert(title: "Actions!", message: "Actions created with `make_button` helper.", actions: button_list)
 ```
 
+## Available Templates
+
+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.
 
-### Example using stylesheet:
+_More to come:_ be sure to submit a pull-request with your button template needs.
 
-TODO: stylesheet example here
+## More info
 
-### Example without stylesheet:
+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/)
 
-TODO: no stylesheet example here
+## Classic UIAlertView Helpers
 
-### Methods
+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.
 
-TODO: list methods available to user here
+**`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
 

data/lib/project/alert_constants.rb

@@ -0,0 +1,16 @@
+module RubyMotionQuery
+  module AlertConstants
+
+    ALERT_TYPES = {
+      alert: UIAlertControllerStyleAlert,
+      sheet: UIAlertControllerStyleActionSheet
+    }
+
+    ALERT_ACTION_STYLE = {
+      default: UIAlertActionStyleDefault,
+      cancel: UIAlertActionStyleCancel,
+      destructive: UIAlertActionStyleDestructive
+    }
+
+  end
+end

data/lib/project/button_templates.rb

@@ -0,0 +1,27 @@
+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_actions(uiac, template, &block)
+      case template
+      when :yes_no
+        uiac.addAction(rmq.app.make_button("Yes", &block))
+        uiac.addAction(rmq.app.make_button("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))
+      when :ok_cancel
+        uiac.addAction(rmq.app.make_button("OK", &block))
+        uiac.addAction(rmq.app.make_button({title: "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))
+      end
+    end
+
+  end
+end

data/lib/project/classic_alert.rb

@@ -0,0 +1,42 @@
+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

@@ -0,0 +1,44 @@
+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

data/lib/project/red_alert.rb

@@ -1,124 +1,48 @@
 module RubyMotionQuery
-  class RMQ
-
-    ALERT_TYPES = {
-      alert: UIAlertControllerStyleAlert,
-      sheet: UIAlertControllerStyleActionSheet
-    }
-
-    ALERT_ACTION_STYLE = {
-      default: UIAlertActionStyleDefault,
-      cancel: UIAlertActionStyleCancel,
-      destructive: UIAlertActionStyleDestructive
-    }
-
-
-    # Creates and shows the UIAlertController.
-    # Usage Example:
-    #   rmq.alert(message: "This is a test")
-    #   rmq.alert(title: "Hey there", message: "Are you happy?")
-    # @return [RMQ]
-    def alert(opts = {}, &block)
-
-      if opts.is_a? String
-        ok = make_button(&block)
-        core_alert(message: opts, actions: [ok])
-      else
-        core_alert(opts)
+  class App
+    class << self
+
+      # Creates and shows the UIAlertController.
+      # 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
 
-    end
-
-
-    def core_alert(opts = {})
-      # An alert is nothing without a message
-      raise(ArgumentError, "RedAlert alert requires a message") unless opts[:message]
-
-      opts = {
-        title: "Alert!",
-        style: :alert,
-        actions: [make_button],
-        animated: true,
-        show_now: true,
-      }.merge(opts)
-
-
-      # UIAlertController introduced in iOS8 only
-      if rmq.device.ios_at_least? 8
-        style = ALERT_TYPES[opts[:style]] || opts[:style]
-
-        ac = UIAlertController.alertControllerWithTitle(opts[:title], message:opts[:message], preferredStyle: style)
-
-        opts[:actions].each do |action|
-          if action.is_a? UIAlertAction
-            ac.addAction(action)
-          elsif action.is_a? Hash
-            p "Parse and use hash as action"
-          else
-            raise ArgumentError, "RedAlert actions must be of type UIAlertAction or Hash"
-          end
-        end
-
-        # Present it, if that's what we want
-        rmq.view_controller.presentViewController(ac, animated: opts[:animated], completion: nil) if opts[:show_now]
-
-        # return it wrapped in RMQ
-        rmq(ac)
-      else
-        alert_view(opts)
+      # Returns a UIAlertAction from given parameters
+      # Usage Example:
+      #   yes = rmq.make_button("Yes")
+      #   cancel = rmq.make_button(title: "Cancel", style: :cancel) {
+      #      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?
+        })
       end
-    end
-
-    def make_button (opts = {}, &block)
-      opts = {
-        title: "OK",
-        style: :default,
-      }.merge(opts)
-
-      style = ALERT_ACTION_STYLE[opts[:style]] || opts[:style]
-
-      UIAlertAction.actionWithTitle(opts[:title], style: style, handler: -> (action) {
-        block.call unless block.nil?
-      })
-    end
-
-
-    # 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.alert_view(message: "This is a test")
-    #   rmq.alert_view(title: "Hey there", message: "Are you happy?")
-    # @return [RMQ]
-    def 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]
-      rmq(alert_view)
-    end
+    end # close eigenclass
 
-  end
+  end # close App
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: RedAlert
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Gant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-21 00:00:00.000000000 Z
+date: 2015-03-23 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: 0.8.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Plugin adds efficient and dynamic alerts/sheets for RMQ
+description: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion
 email:
 - GantMan@gmail.com
 executables: []
@@ -46,6 +46,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/project/alert_constants.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
@@ -71,5 +75,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Plugin adds efficient and dynamic alerts/sheets for RMQ
+summary: RMQ Plugin adds efficient and dynamic alerts/sheets for RubyMotion.
 test_files: []