ProMotion 1.2.1 → 2.0.0.rc1

data/lib/ProMotion/screen/nav_bar_module.rb

@@ -0,0 +1,126 @@
+module ProMotion
+  module NavBarModule
+
+    def nav_bar?
+      !!self.navigationController
+    end
+
+    def navigation_controller
+      self.navigationController
+    end
+
+    def navigation_controller=(nav)
+      self.navigationController = nav
+    end
+
+    def navigationController=(nav)
+      @navigationController = nav
+    end
+
+    def set_nav_bar_button(side, args={})
+      button = create_toolbar_button(args)
+      button.setTintColor args[:tint_color] if args[:tint_color]
+
+      self.navigationItem.leftBarButtonItem = button if side == :left
+      self.navigationItem.rightBarButtonItem = button if side == :right
+      self.navigationItem.backBarButtonItem = button if side == :back
+
+      button
+    end
+
+    # TODO: In PM 2.1+, entirely remove this deprecated method.
+    def set_nav_bar_left_button(title, args={})
+      PM.logger.deprecated "set_nav_bar_right_button and set_nav_bar_left_button have been removed. Use set_nav_bar_button :right/:left instead."
+    end
+    alias_method :set_nav_bar_right_button, :set_nav_bar_left_button
+
+    def set_toolbar_items(buttons = [], animated = true)
+      self.toolbarItems = Array(buttons).map{|b| b.is_a?(UIBarButtonItem) ? b : create_toolbar_button(b) }
+      navigationController.setToolbarHidden(false, animated:animated)
+    end
+    alias_method :set_toolbar_buttons, :set_toolbar_items
+    alias_method :set_toolbar_button,  :set_toolbar_items
+
+    def add_nav_bar(args = {})
+      self.navigationController ||= begin
+        self.first_screen = true if self.respond_to?(:first_screen=)
+        nav = NavigationController.alloc.initWithRootViewController(self)
+        nav.setModalTransitionStyle(args[:transition_style]) if args[:transition_style]
+        nav.setModalPresentationStyle(args[:presentation_style]) if args[:presentation_style]
+        nav
+      end
+      self.navigationController.toolbarHidden = !args[:toolbar] unless args[:toolbar].nil?
+    end
+
+  private
+
+    def create_toolbar_button(args = {})
+      button_type = args[:image] || args[:button] || args[:custom_view] || args[:title] || "Button"
+      bar_button_item button_type, args
+    end
+
+    def bar_button_item(button_type, args)
+      return PM.logger.deprecated("`system_icon:` no longer supported. Use `system_item:` instead.") if args[:system_icon]
+      return button_type if button_type.is_a?(UIBarButtonItem)
+      return bar_button_item_system_item(args) if args[:system_item]
+      return bar_button_item_image(button_type, args) if button_type.is_a?(UIImage)
+      return bar_button_item_string(button_type, args) if button_type.is_a?(String)
+      return bar_button_item_custom(button_type) if button_type.is_a?(UIView)
+      PM.logger.error("Please supply a title string, a UIImage or :system.") && nil
+    end
+
+    def bar_button_item_image(img, args)
+      UIBarButtonItem.alloc.initWithImage(img, style: map_bar_button_item_style(args[:style]), target: args[:target] || self, action: args[:action])
+    end
+
+    def bar_button_item_string(str, args)
+      UIBarButtonItem.alloc.initWithTitle(str, style: map_bar_button_item_style(args[:style]), target: args[:target] || self, action: args[:action])
+    end
+
+    def bar_button_item_system_item(args)
+      UIBarButtonItem.alloc.initWithBarButtonSystemItem(map_bar_button_system_item(args[:system_item]), target: args[:target] || self, action: args[:action])
+    end
+
+    def bar_button_item_custom(custom_view)
+      UIBarButtonItem.alloc.initWithCustomView(custom_view)
+    end
+
+    def map_bar_button_system_item(symbol)
+      {
+        done:         UIBarButtonSystemItemDone,
+        cancel:       UIBarButtonSystemItemCancel,
+        edit:         UIBarButtonSystemItemEdit,
+        save:         UIBarButtonSystemItemSave,
+        add:          UIBarButtonSystemItemAdd,
+        flexible_space: UIBarButtonSystemItemFlexibleSpace,
+        fixed_space:    UIBarButtonSystemItemFixedSpace,
+        compose:      UIBarButtonSystemItemCompose,
+        reply:        UIBarButtonSystemItemReply,
+        action:       UIBarButtonSystemItemAction,
+        organize:     UIBarButtonSystemItemOrganize,
+        bookmarks:    UIBarButtonSystemItemBookmarks,
+        search:       UIBarButtonSystemItemSearch,
+        refresh:      UIBarButtonSystemItemRefresh,
+        stop:         UIBarButtonSystemItemStop,
+        camera:       UIBarButtonSystemItemCamera,
+        trash:        UIBarButtonSystemItemTrash,
+        play:         UIBarButtonSystemItemPlay,
+        pause:        UIBarButtonSystemItemPause,
+        rewind:       UIBarButtonSystemItemRewind,
+        fast_forward: UIBarButtonSystemItemFastForward,
+        undo:         UIBarButtonSystemItemUndo,
+        redo:         UIBarButtonSystemItemRedo,
+        page_curl:    UIBarButtonSystemItemPageCurl
+      }[symbol] ||    UIBarButtonSystemItemDone
+    end
+
+    def map_bar_button_item_style(symbol)
+      {
+        plain:     UIBarButtonItemStylePlain,
+        bordered:  UIBarButtonItemStyleBordered,
+        done:      UIBarButtonItemStyleDone
+      }[symbol] || UIBarButtonItemStyleDone
+    end
+
+  end
+end

data/lib/ProMotion/screen/screen.rb

@@ -1,6 +1,3 @@
-motion_require '../cocoatouch/view_controller'
-motion_require 'screen_module'
-
 module ProMotion
   class Screen < ViewController
     # You can inherit a screen from any UIViewController if you include the ScreenModule

data/lib/ProMotion/screen/screen_module.rb

@@ -1,141 +1,35 @@
-motion_require 'screen_navigation'
-motion_require '../view/styling'
-motion_require '../containers/tabs'
-motion_require '../containers/split_screen'
-
 module ProMotion
   module ScreenModule
     include ProMotion::ScreenNavigation
     include ProMotion::Styling
+    include ProMotion::NavBarModule
     include ProMotion::Tabs
-    include ProMotion::SplitScreen if NSBundle.mainBundle.infoDictionary["UIDeviceFamily"].include?("2")
+    include ProMotion::SplitScreen if UIDevice.currentDevice.userInterfaceIdiom == UIUserInterfaceIdiomPad
 
     attr_accessor :parent_screen, :first_screen, :modal, :split_screen
 
-    def on_create(args = {})
-      unless self.is_a?(UIViewController)
-        raise StandardError.new("ERROR: Screens must extend UIViewController or a subclass of UIViewController.")
-      end
-
+    def screen_init(args = {})
+      check_ancestry
       resolve_title
-
-      self.tab_bar_item = self.class.send(:get_tab_bar_item)
-      self.refresh_tab_bar_item if self.tab_bar_item
-      self.class.send(:get_title)
-
-      args.each { |k, v| self.send("#{k}=", v) if self.respond_to?("#{k}=") }
-
-      self.add_nav_bar(args) if args[:nav_bar]
-      self.navigationController.toolbarHidden = !args[:toolbar] unless args[:toolbar].nil?
-      self.screen_setup
-      self.on_init if self.respond_to?(:on_init)
-      self
-    end
-
-    def screen_setup
+      tab_bar_setup
+      set_attributes self, args
+      add_nav_bar(args) if args[:nav_bar]
+      try :screen_setup
+      try :on_init
+      PM.logger.deprecated "In #{self.class.to_s}, #on_create has been deprecated and removed. Use #screen_init instead." if respond_to?(:on_create)
     end
 
     def modal?
       self.modal == true
     end
 
-    def nav_bar?
-      !!self.navigationController
-    end
-
-    def navigation_controller
-      self.navigationController
-    end
-
-    def navigation_controller=(nav)
-      @navigationController = nav
-    end
-
-    def navigationController=(nav)
-      @navigationController = nav
-    end
-
     def resolve_title
-      if self.class.send(:get_title).kind_of? String
-        self.title = self.class.send(:get_title)
-      elsif self.class.send(:get_title).kind_of? UIView
-        self.navigationItem.titleView = self.class.send(:get_title)
-      elsif self.class.send(:get_title).kind_of? UIImage
-        self.navigationItem.titleView = UIImageView.alloc.initWithImage(self.class.send(:get_title))
-      else
-        PM.logger.warn("title expects string, UIView, or UIImage, but #{self.class.send(:get_title).class.to_s} given.")
-      end
-    end
-
-    def add_nav_bar(args = {})
-      self.navigationController ||= begin
-        self.first_screen = true if self.respond_to?(:first_screen=)
-        nav = NavigationController.alloc.initWithRootViewController(self)
-        nav.setModalTransitionStyle(args[:transition_style]) if args[:transition_style]
-        nav.setModalPresentationStyle(args[:presentation_style]) if args[:presentation_style]
-        nav
-      end
-    end
-
-    def set_nav_bar_right_button(title, args={})
-      args[:title] = title
-      set_nav_bar_button :right, args
-    end
-
-    def set_nav_bar_left_button(title, args={})
-      args[:title] = title
-      set_nav_bar_button :left, args
-    end
-
-    def set_nav_bar_button(side, args={})
-      button = create_toolbar_button(args)
-
-      self.navigationItem.leftBarButtonItem = button if side == :left
-      self.navigationItem.rightBarButtonItem = button if side == :right
-      self.navigationItem.backBarButtonItem = button if side == :back
-
-      button
-    end
-
-    def create_toolbar_button(args = {})
-      args[:style] = map_bar_button_item_style(args[:style])
-      args[:target] ||= self
-      args[:action] ||= nil
-      args[:custom_view] = args[:custom_view] if args[:custom_view]
-      args[:system_item] ||= args[:system_icon] # backwards compatibility
-      args[:system_item] = map_bar_button_system_item(args[:system_item]) if args[:system_item] && args[:system_item].is_a?(Symbol)
-
-      button_type = args[:image] || args[:button] || args[:system_item] || args[:custom_view] || args[:title] || "Button"
-
-      bar_button_item button_type, args
-    end
-
-    def set_toolbar_items(buttons = [], animated = true)
-      buttons = Array(buttons)
-      self.toolbarItems = buttons.map{|b| b.is_a?(UIBarButtonItem) ? b : create_toolbar_button(b) }
-      navigation_controller.setToolbarHidden(false, animated:animated)
-    end
-    alias_method :set_toolbar_buttons, :set_toolbar_items
-    alias_method :set_toolbar_button,  :set_toolbar_items
-
-    # TODO: Make this better. Not able to do image: "logo", for example.
-    def bar_button_item(button_type, args)
-      case button_type
-      when UIBarButtonItem
-        button_type
-      when UIImage
-        UIBarButtonItem.alloc.initWithImage(button_type, style: args[:style], target: args[:target], action: args[:action])
-      when String
-        UIBarButtonItem.alloc.initWithTitle(button_type, style: args[:style], target: args[:target], action: args[:action])
+      case self.class.title_type
+      when :text then self.title = self.class.title
+      when :view then self.navigationItem.titleView = self.class.title
+      when :image then self.navigationItem.titleView = UIImageView.alloc.initWithImage(UIImage.imageNamed(self.class.title))
       else
-        if args[:custom_view]
-          UIBarButtonItem.alloc.initWithCustomView(args[:custom_view])
-        elsif args[:system_item]
-          UIBarButtonItem.alloc.initWithBarButtonSystemItem(args[:system_item], target: args[:target], action: args[:action])
-        else
-          PM.logger.error("Please supply a title string, a UIImage or :system.")
-          nil
-        end
+        PM.logger.warn("title expects string, UIView, or UIImage, but #{self.class.title.class.to_s} given.")
       end
     end
 
@@ -147,7 +41,9 @@ module ProMotion
       self.first_screen == true
     end
 
-    def view_did_load; end
+    def view_did_load
+      self.send(:on_load) if self.respond_to?(:on_load)
+    end
 
     def view_will_appear(animated)
       self.will_appear
@@ -206,10 +102,6 @@ module ProMotion
     def on_rotate
     end
 
-    def supported_orientation?(orientation)
-      NSBundle.mainBundle.infoDictionary["UISupportedInterfaceOrientations"].include?(orientation)
-    end
-
     def supported_orientations
       orientations = 0
       NSBundle.mainBundle.infoDictionary["UISupportedInterfaceOrientations"].each do |ori|
@@ -227,15 +119,16 @@ module ProMotion
       orientations
     end
 
+    def supported_orientation?(orientation)
+      NSBundle.mainBundle.infoDictionary["UISupportedInterfaceOrientations"].include?(orientation)
+    end
+
     def supported_device_families
       NSBundle.mainBundle.infoDictionary["UIDeviceFamily"].map do |m|
-        # TODO: What about universal apps?
-        case m
-        when "1"
-          :iphone
-        when "2"
-          :ipad
-        end
+        {
+          "1" => :iphone,
+          "2" => :ipad
+        }[m] || :unknown_device
       end
     end
 
@@ -251,63 +144,47 @@ module ProMotion
       return self.view_or_self.frame
     end
 
-    def map_bar_button_item_style(symbol)
-      symbol = {
-        plain:    UIBarButtonItemStylePlain,
-        bordered: UIBarButtonItemStyleBordered,
-        done:     UIBarButtonItemStyleDone
-      }[symbol] if symbol.is_a?(Symbol)
-      symbol || UIBarButtonItemStyleBordered
+  private
+
+    def tab_bar_setup
+      self.tab_bar_item = self.class.send(:get_tab_bar_item)
+      self.refresh_tab_bar_item if self.tab_bar_item
+    end
+
+    def check_ancestry
+      unless self.is_a?(UIViewController)
+        raise StandardError.new("ERROR: Screens must extend UIViewController or a subclass of UIViewController.")
+      end
     end
 
-    def map_bar_button_system_item(symbol)
-      {
-        done:         UIBarButtonSystemItemDone,
-        cancel:       UIBarButtonSystemItemCancel,
-        edit:         UIBarButtonSystemItemEdit,
-        save:         UIBarButtonSystemItemSave,
-        add:          UIBarButtonSystemItemAdd,
-        flexible_space: UIBarButtonSystemItemFlexibleSpace,
-        fixed_space:    UIBarButtonSystemItemFixedSpace,
-        compose:      UIBarButtonSystemItemCompose,
-        reply:        UIBarButtonSystemItemReply,
-        action:       UIBarButtonSystemItemAction,
-        organize:     UIBarButtonSystemItemOrganize,
-        bookmarks:    UIBarButtonSystemItemBookmarks,
-        search:       UIBarButtonSystemItemSearch,
-        refresh:      UIBarButtonSystemItemRefresh,
-        stop:         UIBarButtonSystemItemStop,
-        camera:       UIBarButtonSystemItemCamera,
-        trash:        UIBarButtonSystemItemTrash,
-        play:         UIBarButtonSystemItemPlay,
-        pause:        UIBarButtonSystemItemPause,
-        rewind:       UIBarButtonSystemItemRewind,
-        fast_forward: UIBarButtonSystemItemFastForward,
-        undo:         UIBarButtonSystemItemUndo,
-        redo:         UIBarButtonSystemItemRedo,
-        page_curl:    UIBarButtonSystemItemPageCurl
-      }[symbol] ||    UIBarButtonSystemItemDone
+    def try(method, *args)
+      send(method, *args) if respond_to?(method)
     end
 
     # Class methods
     module ClassMethods
-      def debug_mode
-        @debug_mode
+      def title(t=nil)
+        if t && t.is_a?(String) == false
+          PM.logger.deprecated "You're trying to set the title of #{self.to_s} to an instance of #{t.class.to_s}. In ProMotion 2+, you must use `title_image` or `title_view` instead."
+          return raise StandardError
+        end
+        @title = t if t
+        @title_type = :text if t
+        @title ||= self.to_s
       end
 
-      def debug_mode=(v)
-        @debug_mode = v
+      def title_type
+        @title_type || :text
       end
 
-      def title(t)
+      def title_image(t)
         @title = t
+        @title_type = :image
       end
-      def title=(t)
+
+      def title_view(t)
         @title = t
-      end
-      
-      def get_title
-        @title ||= self.to_s
+        @title_type = :view
       end
     end
 

data/lib/ProMotion/screen/screen_navigation.rb

@@ -2,39 +2,28 @@ module ProMotion
   module ScreenNavigation
 
     def open_screen(screen, args = {})
-      args = { in_detail: false, in_master: false, close_all: false, modal: false, in_tab: false, animated: true }.merge args
+      args = { animated: true }.merge(args)
 
       # Apply properties to instance
       screen = set_up_screen_for_open(screen, args)
       ensure_wrapper_controller_in_place(screen, args)
 
-      if args[:in_detail] && self.split_screen
-        self.split_screen.detail_screen = screen
-
-      elsif args[:in_master] && self.split_screen
-        self.split_screen.master_screen = screen
-
-      elsif args[:close_all]
-        open_root_screen screen
-
-      elsif args[:modal]
-        present_modal_view_controller screen, args[:animated], args[:completion]
-
-      elsif args[:in_tab] && self.tab_bar
-        present_view_controller_in_tab_bar_controller screen, args[:in_tab]
-
-      elsif self.navigationController
-        push_view_controller screen, self.navigationController, args[:animated].nil? ? true : args[:animated]
-
-      else
-        open_root_screen (screen.navigationController || screen)
-
-      end
-
+      opened ||= open_in_split_screen(screen, args) if self.split_screen
+      opened ||= open_root_screen(screen) if args[:close_all]
+      opened ||= present_modal_view_controller(screen, args) if args[:modal]
+      opened ||= open_in_tab(screen, args[:in_tab]) if args[:in_tab]
+      opened ||= push_view_controller(screen, self.navigationController, !!args[:animated]) if self.navigationController
+      opened ||= open_root_screen(screen.navigationController || screen)
       screen
     end
     alias :open :open_screen
 
+    def open_in_split_screen(screen, args)
+      self.split_screen.detail_screen = screen if args[:in_detail]
+      self.split_screen.master_screen = screen if args[:in_master]
+      args[:in_detail] || args[:in_master]
+    end
+
     def open_root_screen(screen)
       app_delegate.open_root_screen(screen)
     end
@@ -81,11 +70,12 @@ module ProMotion
         PM.logger.error "You need a nav_bar if you are going to push #{vc.to_s} onto it."
       end
       nav_controller ||= self.navigationController
+      return if nav_controller.topViewController == vc
       vc.first_screen = false if vc.respond_to?(:first_screen=)
       nav_controller.pushViewController(vc, animated: animated)
     end
 
-    protected
+  protected
 
     def set_up_screen_for_open(screen, args={})
 
@@ -117,24 +107,23 @@ module ProMotion
       end
     end
 
-    def present_modal_view_controller(screen, animated, completion)
-      self.presentViewController((screen.navigationController || screen), animated:animated, completion:completion)
+    def present_modal_view_controller(screen, args={})
+      self.presentViewController((screen.navigationController || screen), animated: args[:animated], completion: args[:completion])
     end
 
-    def present_view_controller_in_tab_bar_controller(screen, tab_name)
-      vc = open_tab tab_name
-      if vc
-
-        if vc.is_a?(UINavigationController)
-          push_view_controller(screen, vc)
-        else
-          # TODO: This should probably open the vc, shouldn't it?
-          # This isn't well tested and needs to work better.
-          self.tab_bar.selectedIndex = vc.tabBarItem.tag
-        end
-
+    def open_in_tab(screen, tab_name)
+      vc = open_tab(tab_name)
+      return PM.logger.error("No tab bar item '#{tab_name}'") && nil unless vc
+      if vc.is_a?(UINavigationController)
+        push_view_controller(screen, vc)
       else
-        PM.logger.error "No tab bar item '#{tab_name}'"
+        replace_view_controller(screen, vc)
+      end
+    end
+
+    def replace_view_controller(new_vc, old_vc)
+      self.tab_bar.viewControllers = self.tab_bar.viewControllers.map do |vc|
+        vc == old_vc ? new_vc : vc
       end
     end