motion-wizard 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b0eb05108f916b5e4a2379147a5517ab4f181dd
+  data.tar.gz: afcfe23fb17888d3afd67cb0170b0cf45cc6386b
+SHA512:
+  metadata.gz: ebdb9eb94f462dcddf59ad992f40dff1adc1f1b6384e313ecb03f15cbfd6e2ee61fbff466d1cc9c1a25949e15561d2a93db945525470df763b02c2f23b6b9066
+  data.tar.gz: e19250b87f2322a6f8f16c6a5f8e543f739a9d349359b733fffd4cc75300d8e388ee234f6b7a5051fde87c7ef85b3e8e9e058b35db8e08b0a02b524fc50b22de

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in motion-wizard-wizard.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ignacio Piantanida
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# Motion-Wizard
+
+A small gem to create clean wizard-like views
+
+![Sample 1](https://raw.github.com/ijpiantanida/motion-wizard/master/wizard-1.gif)
+![Sample 2](https://raw.github.com/ijpiantanida/motion-wizard/master/wizard-2.gif)
+
+#Installation
+#How to use it
+Your custom wizard view controller will inherit from `MotionWizard::WizardViewController`.
+
+With the `steps` class method, you specify which view controllers will describe your wizard.
+
+``` ruby
+class Wizard1ViewController < MotionWizard::WizardViewController
+  steps Step1ViewController,
+        Step2ViewController,
+        Step3ViewController,
+        Step4ViewController
+end
+```
+##Moving through steps
+The `WizardViewController` will create instances of your steps controllers which will then be extended with the `MotionWizard::ContentController` module. This module gives you the following methods which can be used inside your steps:
+* **#next(data)**: Will move to the next step. It will call `#finish` if there is no following step.
+* **#previous(data)**: Will move to the previous step. If already on the first step, this method will do nothing.
+* **#go_to_step(step_number, data)**: Will go to the selected step.
+* **#finish(data)**: Will call the `#when_finished` method on the wizard view controller
+
+When moving through steps, you can pass an optional hash parameter with custom data that will get merged into a common wizard hash. You can access this hash inside your steps with the `#wizard_data` method.
+
+``` ruby
+class Step1ViewController
+    ...
+
+    def viewWillAppear(animated)
+      super
+      @button.on(:touch){ self.next(step_1_text: "Awesome!") }
+    end
+
+    ...
+end
+```
+
+Your wizard view controller class can define a `#when_finished` method that will get called when any of the steps view controller call `#finish` or `#next` when already on the last step. Within this method you have also access to `wizard_data`.
+
+``` ruby
+class Wizard1ViewController < MotionWizard::WizardViewController
+    def when_finished
+        NSLog "You can access your data here #{wizard_data}"
+    end
+end
+```
+
+##Customizing Index Views
+By default, index views will be instances of `MotionWizard::IndexItem`. This view has a `label_wrapper` (`UIView`) subview, which has a `label` (`UILabel`) subview.
+
+It also defines two methods `when_selected` and `when_unselected` that allow to subscribe a block to be called whenever the current step changes.
+
+You can customize the default index view appearance and behaviour by defining the `set_up_index_item_at(index_item, index)` method inside your `WizardViewController` subclass ([see sample Nr 1](samples/wizard-1)).
+
+``` ruby
+class Wizard1ViewController < MotionWizard::WizardViewController
+  def setup_index_item_at(index_item, index)
+    layout(index_item, :index_item)
+    index_item.label.text = "ABCD"[index]
+  end
+end
+```
+
+If you would rather use a custom index item class instead of the default one, you can register it using the `index_item_view_class` class method inside your `WizardViewController` subclass definition.
+
+Your custom class can define the methods `#select` and `#unselect` to be called whenever the wizard changes the current step.
+
+([see sample Nr 2](samples/wizard-2))

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/motion-wizard.rb

@@ -0,0 +1,9 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+Motion::Project::App.setup do |app|
+  Dir.glob(File.join(File.dirname(__FILE__), 'motion-wizard/**/*.rb')).reverse.each do |file|
+    app.files.unshift file
+  end
+end

data/lib/motion-wizard/animation_strategy/base_animation_strategy.rb

@@ -0,0 +1,25 @@
+module MotionWizard
+  module AnimationStrategy
+    class BaseAnimationStrategy
+      attr_accessor :already_on_final_position, :duration
+
+      def initialize
+        @duration = 0.5
+      end
+
+      def show_view(view, &after_block)
+        @show_view = view
+        @show_view_after_block = after_block
+      end
+
+      def hide_view(view, &after_block)
+        @hide_view = view
+        @hide_view_after_block = after_block
+      end
+
+      def animate
+        raise "Subclass responsability"
+      end
+    end
+  end
+end

data/lib/motion-wizard/animation_strategy/ios7_slide_left_to_right.rb

@@ -0,0 +1,18 @@
+module MotionWizard
+  module AnimationStrategy
+    class Ios7SlideLeftToRight < SlideAnimation
+      def initialize
+        super
+        @duration = 0.25
+      end
+
+      def animate
+        show_view_index = @show_view.superview.subviews.index(@show_view)
+        hide_view_index = @show_view.superview.subviews.index(@hide_view)
+        @show_view.superview.exchangeSubviewAtIndex(hide_view_index, withSubviewAtIndex: show_view_index) if show_view_index > hide_view_index
+        do_slide_animation(@show_view, -70, 0, @show_view_after_block)
+        do_slide_animation(@hide_view, 0, App.frame.size.width, @hide_view_after_block)
+      end
+    end
+  end
+end

data/lib/motion-wizard/animation_strategy/ios7_slide_right_to_left.rb

@@ -0,0 +1,18 @@
+module MotionWizard
+  module AnimationStrategy
+    class Ios7SlideRightToLeft < SlideAnimation
+      def initialize
+        super
+        @duration = 0.25
+      end
+
+      def animate
+        show_view_index = @show_view.superview.subviews.index(@show_view)
+        hide_view_index = @show_view.superview.subviews.index(@hide_view)
+        @show_view.superview.exchangeSubviewAtIndex(hide_view_index, withSubviewAtIndex: show_view_index) if show_view_index < hide_view_index
+        do_slide_animation(@show_view, App.frame.size.width, 0, @show_view_after_block)
+        do_slide_animation(@hide_view, 0, -70, @hide_view_after_block)
+      end
+    end
+  end
+end

data/lib/motion-wizard/animation_strategy/left_to_right.rb

@@ -0,0 +1,10 @@
+module MotionWizard
+  module AnimationStrategy
+    class LeftToRight < SlideAnimation
+      def initialize
+        super
+        @direction = -1
+      end
+    end
+  end
+end

data/lib/motion-wizard/animation_strategy/none.rb

@@ -0,0 +1,11 @@
+module MotionWizard
+  module AnimationStrategy
+    class None < BaseAnimationStrategy
+      def initialize; end
+
+      def show_view(view); end
+      def hide_view(view); end
+      def animate; end
+    end
+  end
+end

data/lib/motion-wizard/animation_strategy/right_to_left.rb

@@ -0,0 +1,10 @@
+module MotionWizard
+  module AnimationStrategy
+    class RightToLeft < SlideAnimation
+      def initialize
+        super
+        @direction = 1
+      end
+    end
+  end
+end

data/lib/motion-wizard/animation_strategy/slide_animation.rb

@@ -0,0 +1,21 @@
+module MotionWizard
+  module AnimationStrategy
+    class SlideAnimation < BaseAnimationStrategy
+      attr_accessor :direction
+
+      def animate
+        do_slide_animation(@show_view, @direction*App.frame.size.width, 0, @show_view_after_block)
+        do_slide_animation(@hide_view, 0, -@direction*App.frame.size.width, @hide_view_after_block)
+      end
+
+      def do_slide_animation(view, initial_position, final_position, after_block)
+        view.origin = [initial_position, view.origin.y]
+        UIView.animateWithDuration(@duration, animations: -> {
+          view.origin = [final_position, view.origin.y]
+        },completion: ->(finished) {
+          after_block.call(view) if after_block
+        })
+      end
+    end
+  end
+end

data/lib/motion-wizard/controllers/content_controller.rb

@@ -0,0 +1,17 @@
+module MotionWizard
+  module ContentController
+    extend Forwardable
+
+    attr_reader :wizard_view_controller
+    delegate :@wizard_view_controller, :next, :previous, :go_to_step, :wizard_data, :reset!, :finish
+
+    def viewDidLoad
+      super
+      self.view.clipsToBounds = true
+    end
+
+    def wizard_view_controller=(wizard_view_controller)
+      @wizard_view_controller = WeakRef.new(wizard_view_controller)
+    end
+  end
+end

data/lib/motion-wizard/controllers/wizard_view_controller.rb

@@ -0,0 +1,143 @@
+module MotionWizard
+  class WizardViewController < UIViewController
+    attr_reader :navigation_bar_view, :content_view, :wizard_data
+
+    DEFAULT_NAVIGATION_BAR_HEIGHT = 44
+
+    def self.steps(*steps)
+      @_wizard_steps = steps
+    end
+
+    def self.forward_animation_strategy(animation_strategy_class)
+      @_forward_animation_strategy_class = animation_strategy_class
+    end
+
+    def self.backward_animation_strategy(animation_strategy_class)
+      @_backward_animation_strategy_class = animation_strategy_class
+    end
+
+    def self.index_item_view_class(index_item_view_class)
+      @_index_item_view_class = index_item_view_class
+    end
+
+    def init
+      super
+      @steps_controllers_classes = self.class.instance_variable_get(:@_wizard_steps) || []
+      @forward_animation_strategy_class = self.class.instance_variable_get(:@_forward_animation_strategy_class) || AnimationStrategy::RightToLeft
+      @backward_animation_strategy_class = self.class.instance_variable_get(:@_backward_animation_strategy_class) || AnimationStrategy::LeftToRight
+      @index_item_view_class = self.class.instance_variable_get(:@_index_item_view_class) || IndexItem
+      @current_step = 0
+      @wizard_data = {}
+      @steps_controllers = []
+      self
+    end
+
+    def viewDidLoad
+      super
+
+      @content_view = UIView.alloc.init
+      @content_view.origin = [0,0]
+      @content_view.size = self.view.size
+      self.view.addSubview(@content_view)
+
+      @navigation_bar_view = WizardNavigationBar.alloc.init_with_number_of_steps(number_of_steps, self)
+      @navigation_bar_view.origin = [0,0]
+      @navigation_bar_view.size = [self.view.size.width, DEFAULT_NAVIGATION_BAR_HEIGHT]
+      self.view.addSubview(navigation_bar_view)
+
+      add_new_step_view(AnimationStrategy::None.new)
+    end
+
+    def reset!
+      @wizard_data = {}
+      @steps_controllers = []
+      @navigation_bar_view.reset!
+      navigation_bar_view.select(@current_step)
+    end
+
+    def add_new_step_view(animation_strategy)
+      @current_view_controller = get_current_step_view_controller
+      self.addChildViewController(@current_view_controller)
+      @content_view.addSubview(@current_view_controller.view)
+
+      @current_view_controller.view.origin = [0,0]
+      animation_strategy.show_view(@current_view_controller.view)
+      navigation_bar_view.select(@current_step)
+    end
+
+    def get_current_step_view_controller
+      @steps_controllers[@current_step] ||= begin
+        new_view_controller = @steps_controllers_classes[@current_step].alloc.init
+        new_view_controller.extend(MotionWizard::ContentController)
+        new_view_controller.wizard_view_controller = self
+        new_view_controller.view.size = @content_view.size
+        new_view_controller
+      end
+    end
+
+    def remove_current_step_view(animation_strategy)
+      current_local_view = @current_view_controller
+      animation_strategy.hide_view(@current_view_controller.view) do |view|
+        view.removeFromSuperview
+        current_local_view.removeFromParentViewController
+      end
+    end
+
+    def number_of_steps
+      @steps_controllers_classes.size
+    end
+
+    def next(data = {})
+      @wizard_data.merge! data
+      @current_step+=1
+      if @current_step >= number_of_steps
+        @current_step = number_of_steps - 1
+        self.finish
+        return
+      end
+      change_step_view(@forward_animation_strategy_class)
+      self
+    end
+
+    def previous(data = {})
+      @wizard_data.merge! data
+      @current_step-=1
+      return if @current_step < 0
+      change_step_view(@backward_animation_strategy_class)
+      self
+    end
+
+    def go_to_step(step_number, data = {})
+      @wizard_data.merge! data
+      animation_klass = @current_step > step_number ? @backward_animation_strategy_class : @forward_animation_strategy_class
+      @current_step = step_number
+      change_step_view(animation_klass)
+      self
+    end
+
+    def finish(data = {})
+      @wizard_data.merge! data
+      self.when_finished
+    end
+
+    def change_step_view(animation_strategy_klass)
+      animation_strategy = animation_strategy_klass.new
+      remove_current_step_view(animation_strategy)
+      add_new_step_view(animation_strategy)
+      animation_strategy.animate
+    end
+
+    def create_index_item_at(index)
+      index_item = @index_item_view_class.alloc.init
+      index_item.label.text = "%02d" % (index+1)
+      index_item
+    end
+
+    def setup_index_item_at(index_item, index)
+      index_item.label_wrapper.size = index_item.size
+      index_item.label.size = index_item.size
+    end
+
+    def when_finished;end
+  end
+end

data/lib/motion-wizard/lib/forwardable.rb

@@ -0,0 +1,12 @@
+module MotionWizard
+  module Forwardable
+    def delegate(*methods)
+      to = methods.shift
+      methods.each do |method_name|
+        define_method(method_name) do |*args, &block|
+          self.instance_variable_get(to).send(method_name, *args, &block)
+        end
+      end
+    end
+  end
+end