pro_motion_slide_menu 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/
+*.gem
+.DS_Store
+/build/
+.repl_history
+vendor/Pods/

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+gem 'bubble-wrap'
+gem 'motion-cocoapods'
+gem 'ProMotion', '>= 0.5.2'
+gem 'pro_motion_slide_menu', :path => '.'

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    pro_motion_slide_menu (0.0.1)
+      ProMotion (~> 0.5)
+      bubble-wrap
+      motion-cocoapods
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ProMotion (0.5.2)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    addressable (2.3.3)
+    bubble-wrap (1.1.5)
+    cocoapods (0.16.2)
+      activesupport (~> 3.2.6)
+      colored (~> 1.2)
+      escape (~> 0.0.4)
+      faraday (~> 0.8.1)
+      json (~> 1.7.3)
+      octokit (~> 1.7)
+      open4 (~> 1.3.0)
+      rake (~> 0.9.4)
+      xcodeproj (~> 0.4.3)
+    colored (1.2)
+    escape (0.0.4)
+    faraday (0.8.5)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    hashie (1.2.0)
+    i18n (0.6.1)
+    json (1.7.7)
+    motion-cocoapods (1.2.1)
+      cocoapods (>= 0.14.0)
+    motion-stump (0.2.1)
+    multi_json (1.7.2)
+    multipart-post (1.1.5)
+    netrc (0.7.7)
+    octokit (1.23.0)
+      addressable (~> 2.2)
+      faraday (~> 0.8)
+      faraday_middleware (~> 0.9)
+      hashie (~> 1.2)
+      multi_json (~> 1.3)
+      netrc (~> 0.7.7)
+    open4 (1.3.0)
+    rake (0.9.6)
+    xcodeproj (0.4.3)
+      activesupport (~> 3.2.6)
+      colored (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ProMotion (>= 0.5.2)
+  bubble-wrap
+  motion-cocoapods
+  motion-stump
+  pro_motion_slide_menu!

data/README.md

@@ -0,0 +1,134 @@
+# ProMotion SlideMenu
+This gem provides an easier way to integrate a great open source toolkit, [RubyMotion](http://www.rubymotion.com), with another great Objective-C framework, [PKRevealController](https://github.com/pkluz/PKRevealController), allowing you to easily have a cool facebook or Path style slide navigation menu, complete with gestures.
+
+## Installation
+
+### Bundler
+
+Add the following to your project's `Gemfile` to work with bundler.
+
+```ruby
+gem "pro_motion_slide_menu"
+```
+
+Install with bundler:
+
+```ruby
+bundle install
+```
+
+### Dependenices
+This depends on motion-cocoapods, BubbleWrap and ProMotion.
+
+### Rakefile
+
+Currently there is a bug with [motion-cocoapods](https://github.com/HipByte/motion-cocoapods/issues/38) that doesn't allow us to automatically include an ObjC library automatically.  Because of this, you will need to edit your Rakefile as follows:
+
+```ruby
+app.pods do
+  pod 'PKRevealController'
+end
+```
+
+## Creating and Configuring a Slide Menu
+To create a slide menu in your application, you need to start in your AppDelegate:
+
+```ruby
+class AppDelegate < ProMotion::AppDelegateParent
+  
+  def on_load(app, options)
+
+    # Open the slide menu with your navigation view (initially hidden) and a content view (initially shown)
+    open_slide_menu NavigationScreen, MyGreatAppScreen.new(nav_bar: true)
+
+    # You can get to the instance of the slide menu at any time if you need to
+    slide_menu.menu_controller.class.name
+    # => NavigationScreen
+
+    # SlideMenuScreen is just an enhanced subclass of PKRevealController, so you can do all sorts of things with it
+    slide_menu.disablesFrontViewInteraction = true
+    slide_menu.animationDuration = 0.5
+    ...
+
+  end
+
+end
+```
+
+## Toggling the Slide Menu Current Screen
+To make the slide menu present the menu from anywhere in your app:
+
+```ruby
+
+# Show the menu
+App.delegate.slide_menu.show_menu
+
+# Equivalent to
+App.delegate.slide_menu.showViewController App.delegate.slide_menu.menu_controller, animated: true, completion: ->(c) { true }
+
+# Hide the menu
+App.delegate.slide_menu.hide_menu
+
+# Equivalent to
+App.delegate.slide_menu.showViewController App.delegate.slide_menu.content_controller, animated: true, completion: ->(c) { true }
+
+```
+
+## Setting up the Menu
+You can use any `UIViewController` subclass you want as the menu controller, but the easiest way to provide this would be to subclass `ProMotion::TableScreen` like below:
+
+```ruby
+class NavigationScreen < ProMotion::TableScreen
+
+  def table_data
+    [{
+      title: nil,
+      cells: [{
+        title: 'OVERWRITE THIS METHOD',
+        action: :swap_content_controller,
+        arguments: HomeScreen
+      }]
+    }]
+  end
+
+  def swap_content_controller(screen_class)
+    App.delegate.slide_menu.content_controller = screen_class
+  end
+
+end
+```
+
+## Showing the menu via gesture
+By default, `PKRevealController` supports showing the slide menu via a gesture recognizer.  To disable this feature, look at the documentation or use the following:
+
+```ruby
+App.delegate.slide_menu.recognizesPanningOnFrontView = false
+```
+
+## Creating a UIBarButtonItem to show the menu
+You may want to create a button for users to show the menu in addition to the gesture recognizer.  To do so, in your Screen class:
+
+```ruby
+class MyScreen < ProMotion::Screen
+  def on_load
+
+    # Create a button with a custom bg & image
+    swipe_btn = UIButton.custom
+    swipe_btn.setBackgroundImage("nav_bar_menu_show_bg".uiimage, forState: :normal.uicontrolstate)
+    swipe_btn.setImage("nav_bar_menu_show".uiimage, forState: :normal.uicontrolstate)
+    size = "nav_bar_menu_show_bg".uiimage.size
+    swipe_btn.frame = CGRectMake(0, 0, size.width, size.height)
+
+     # Create a Bar button item containing that button
+     # When tapping the button, show the menu (uses Sugarcube syntax)
+    @left_item = UIBarButtonItem.alloc.initWithCustomView(swipe_btn)    
+    swipe_btn.on(:touch.uicontrolevent) do
+      App.delegate.slide_menu.show_menu
+    end
+
+    # Assign the button item to the navigation item for it to appear in the top left
+    self.navigationItem.leftBarButtonItem = @left_item
+    
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+$:.unshift('/Library/RubyMotion/lib')
+require 'motion/project'
+require 'bundler'
+Bundler.require
+
+Motion::Project::App.setup do |app|
+  # Use `rake config' to see complete project settings.
+  app.name = 'ProMotionSlideMenu'
+  app.delegate_class = 'TestAppDelegate'    
+
+  app.pods do
+    pod 'PKRevealController'
+  end
+end

data/app/test_app_delegate.rb

@@ -0,0 +1,4 @@
+class TestAppDelegate < ProMotion::AppDelegateParent
+  def on_load(app, options)
+  end
+end

data/lib/pro_motion_slide_menu/app_delegate.rb

@@ -0,0 +1,21 @@
+module ProMotionSlideMenu
+  module AppDelegate
+
+    def self.included(base)
+      base.send :attr_accessor, :slide_menu
+    end
+
+    def has_slide_menu?
+      !slide_menu.nil?
+    end
+
+    def open_slide_menu(menu, content, options={})
+      self.slide_menu = SlideMenuScreen.new(menu, content, options)
+      load_root_screen slide_menu
+      slide_menu
+    end
+
+  end
+end
+
+ProMotion::AppDelegateParent.send :include, ProMotionSlideMenu::AppDelegate

data/lib/pro_motion_slide_menu/slide_menu_screen.rb

@@ -0,0 +1,61 @@
+module ProMotionSlideMenu
+  class SlideMenuScreen < PKRevealController
+
+    include ::ProMotion::ScreenModule
+
+    #
+    # SlideMenuScreen
+    #
+    # This is added as the root view controller when using the `open_slide_menu` method in your application delegate.
+    # 
+    # Several properties are defined to get the underlying PKRevealController instance for additional configuration, the 
+    # screen shown as the hidden menu, and the screen shown as the content controller.
+    #
+
+    def self.new(menu, content, options={})
+      screen = self.revealControllerWithFrontViewController(nil, leftViewController: nil, options: nil)
+      screen.on_create(options) if screen.respond_to?(:on_create)
+      screen.menu_controller = menu unless menu.nil?
+      screen.content_controller = content unless content.nil?
+      screen
+    end
+
+    def show_menu
+      self.showViewController menu_controller, animated: true, completion: default_completion_block
+    end
+
+    def hide_menu
+      self.showViewController content_controller, animated: true, completion: default_completion_block
+    end
+
+    def menu_controller=(c)
+      self.setLeftViewController prepare_controller_for_pm(c).main_controller, focusAfterChange: true, completion: default_completion_block
+    end
+
+    def menu_controller
+      self.leftViewController
+    end
+
+    def content_controller=(c)
+      self.setFrontViewController prepare_controller_for_pm(c).main_controller, focusAfterChange: true, completion: default_completion_block
+    end
+
+    def content_controller
+      self.frontViewController
+    end
+
+
+    protected
+
+    def prepare_controller_for_pm(controller)
+      controller = setup_screen_for_open(controller, {})
+      ensure_wrapper_controller_in_place(controller, {})
+      controller
+    end
+
+    def default_completion_block
+      -> (completed) { true }
+    end
+
+  end
+end

data/lib/pro_motion_slide_menu/version.rb

@@ -0,0 +1,3 @@
+module ProMotionSlideMenu
+  Version = '0.0.1'
+end

data/lib/pro_motion_slide_menu.rb

@@ -0,0 +1,22 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+Motion::Project::App.setup do |app|
+
+  # Add all the files in our lib folder
+  # WE ADD THESE AT THE END OF THE FILE LISTING!
+  # This way, we can be sure that ProMotion itself has been compiled, but before any of the app's files are compiled.
+  Dir.glob(File.join(File.dirname(__FILE__), 'pro_motion_slide_menu/**/*.rb')).each do |file|
+    app.files << file 
+  end
+
+  # We have a cocoapod that we rely on
+  # THIS WON'T WORK until the following issue is resolved with motion-cocoapods
+  # https://github.com/HipByte/motion-cocoapods/issues/38
+  #
+  # app.pods do
+    # pod 'PKRevealController'
+  # end
+
+end

data/pro_motion_slide_menu.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/pro_motion_slide_menu/version.rb', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'pro_motion_slide_menu'
+  s.version       = ProMotionSlideMenu::Version
+  s.authors       = ["Matt Brewer"]
+  s.email         = 'matt.brewer@me.com'
+
+  s.summary       = "Provides a facebook/Path style slide menu on the left for ProMotion RubyMotion apps."
+  s.description   = "Provides a facebook/Path style slide menu on the left for ProMotion RubyMotion apps."
+
+  s.homepage      = "https://github.com/macfanatic/pro_motion_slide_menu"
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^spec/})
+  s.require_paths = ['lib']
+
+  s.add_dependency "bubble-wrap"
+  s.add_dependency "motion-cocoapods"
+  s.add_dependency "ProMotion", '~> 0.5'
+  s.add_development_dependency "motion-stump"
+
+end

data/spec/app_delegate_spec.rb

@@ -0,0 +1,27 @@
+describe ProMotionSlideMenu::AppDelegate do
+
+  before do
+    @delegate = App.delegate
+  end
+
+  it "should have a 'slide_menu' attribute" do
+    @delegate.respond_to?(:slide_menu).should == true
+  end
+
+  it "should not have a slide menu by default" do
+    @delegate.has_slide_menu?.should == false
+  end
+
+  it "should respond to 'open_slide_menu'" do
+    @delegate.respond_to?(:open_slide_menu).should == true
+  end
+
+  it "#open_slide_menu should return a SlideMenuScreen" do
+    @delegate.open_slide_menu(nil, nil).should.be.instance_of ProMotionSlideMenu::SlideMenuScreen
+  end 
+
+  it "should have a SlideMenuScreen as the rootViewController" do
+    @delegate.window.rootViewController.should.be.instance_of ProMotionSlideMenu::SlideMenuScreen
+  end
+
+end

data/spec/helpers/blank_screen.rb

@@ -0,0 +1,2 @@
+class BlankScreen < ProMotion::Screen
+end

data/spec/helpers/left_nav_screen.rb

@@ -0,0 +1,10 @@
+class LeftNavScreen < ProMotion::TableScreen
+  def table_data
+    [{
+      title: nil,
+      cells: [{
+        title: 'OVERWRITE THIS METHOD'
+      }]
+    }]
+  end
+end

data/spec/slide_menu_screen_spec.rb

@@ -0,0 +1,50 @@
+describe ProMotionSlideMenu::SlideMenuScreen do
+
+  before do
+    @delegate = App.delegate
+    @menu = LeftNavScreen.new
+    @content = BlankScreen.new
+  end
+
+  it "should return an instance of SlideMenuScreen" do
+    screen = ProMotionSlideMenu::SlideMenuScreen.new nil, nil
+    screen.should.be.instance_of ProMotionSlideMenu::SlideMenuScreen
+  end
+
+  it "should store menu & content controllers" do
+    screen = ProMotionSlideMenu::SlideMenuScreen.new @menu, @content
+    screen.menu_controller.should == @menu
+    screen.content_controller.should == @content
+  end
+
+  it "should allow you to pass class instances" do
+    screen = ProMotionSlideMenu::SlideMenuScreen.new LeftNavScreen, BlankScreen
+    screen.menu_controller.should.be.instance_of LeftNavScreen
+    screen.content_controller.should.be.instance_of BlankScreen
+  end
+
+  it "should present the menu controller when requested" do
+    screen = ProMotionSlideMenu::SlideMenuScreen.new @menu, @content
+    screen.show_menu
+    wait(0.5) { screen.focusedController.should == @menu }
+  end
+
+  it "should present the content controller when requested" do
+    screen = ProMotionSlideMenu::SlideMenuScreen.new @menu, @content
+    screen.hide_menu
+    wait(0.5) { screen.focusedController.should == @content }
+  end
+
+  it "should let me wrap the content controller in a UINavigationController" do
+    content_controller = BlankScreen.new(nav_bar: true)
+    screen = ProMotionSlideMenu::SlideMenuScreen.new @menu, content_controller
+    screen.content_controller.should.be.instance_of ProMotion::NavigationController
+  end
+
+  it "should let me set the title on the content controller during creation" do
+    content_controller = BlankScreen.new(title: 'My Title')
+    screen = ProMotionSlideMenu::SlideMenuScreen.new @menu, content_controller
+    screen.content_controller.title.should == 'My Title'
+  end
+
+end

data/vendor/Podfile.lock

@@ -0,0 +1,11 @@
+
+PODS:
+- PKRevealController (1.0b2)
+
+DEPENDENCIES:
+- PKRevealController
+
+SPEC CHECKSUMS:
+  PKRevealController: 631e6a3db833a0c660203c2dba0963109549ec8a
+
+COCOAPODS: 0.16.2

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: pro_motion_slide_menu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matt Brewer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bubble-wrap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: motion-cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ProMotion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: motion-stump
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a facebook/Path style slide menu on the left for ProMotion RubyMotion
+  apps.
+email: matt.brewer@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/test_app_delegate.rb
+- lib/pro_motion_slide_menu.rb
+- lib/pro_motion_slide_menu/app_delegate.rb
+- lib/pro_motion_slide_menu/slide_menu_screen.rb
+- lib/pro_motion_slide_menu/version.rb
+- pro_motion_slide_menu.gemspec
+- spec/app_delegate_spec.rb
+- spec/helpers/blank_screen.rb
+- spec/helpers/left_nav_screen.rb
+- spec/slide_menu_screen_spec.rb
+- vendor/Podfile.lock
+homepage: https://github.com/macfanatic/pro_motion_slide_menu
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides a facebook/Path style slide menu on the left for ProMotion RubyMotion
+  apps.
+test_files:
+- spec/app_delegate_spec.rb
+- spec/helpers/blank_screen.rb
+- spec/helpers/left_nav_screen.rb
+- spec/slide_menu_screen_spec.rb
+has_rdoc: