sugarcube 0.18.12 → 0.18.16

data/README.md

@@ -727,9 +727,10 @@ view.fade_out { |completed|
 }
 
 # fade_out options
-view.fade_out(0.5, delay: 0,
-                  options: UIViewAnimationOptionCurveLinear,
-                  opacity: 0.5) {
+view.fade_out(duration: 0.5,
+                 delay: 0,
+               options: UIViewAnimationOptionCurveLinear,
+               opacity: 0.5) {
   view.removeFromSuperview
 }
 
@@ -737,6 +738,7 @@ view.move_to([0, 100])   # move to position 0, 100
 view.delta_to([0, 100])  # move over 0, down 100, from current position
 
 view.rotate_to Math::PI  # rotate view upside down
+view.rotate 45.degrees  # rotate *an additional* 45 degrees
 view.rotate_to(duration: 0.5, angle: 45.degrees)  # using options
 
 view.slide :left   # slides the entire view one "page" to the left, right, up, or down
@@ -774,43 +776,77 @@ view.slide(:left, 20) {
 }
 ```
 
-Those be some gnarly callbacks.  You can write this as a chain, but we need to
-tell the `slide` method to go ahead and run immediately (don't use an
-animation).  When you create an animation chain, the block you pass to each
-iteration is the block that gets passed to `UIView##animateWithDuration(...)`.
-If you try and run animations *within* that block they will not get queued up
-properly.
+Those be some gnarly callbacks.  You can write this as a chain instead!
 
-The easiest way to handle this:
+```ruby
+UIView.animation_chain {
+  view.slide(:left, 20)
+}.and_then {
+  view.slide(:up, 20)
+}.and_then {
+  view.slide(:right, 20)
+}.and_then {
+  view.slide(:down, 20)
+}.and_then {
+  view.fade_out
+}.start
+```
 
-1) don't use SugarCube animation methods, e.g. assign the frame manually (yeah, right!)
-2) use the `duration: 0` option, which runs the animation without setting calling
-   `animateWithDuration()`.
-3) For clarity (and some future-proofing, in case any of this rigamarole changes
-   in the future), you can use `chain: true`.
+Behind the scenes, any calls to a SugarCube animate method (`slide`, `fade`,
+`rotate`) will be setup to run *immediately* instead of in a
+`UIView#animateWithDuration(...)` block.  You can also do multiple animations
+within that block, as long as no two animations affect the same property:
 
 ```ruby
 UIView.animation_chain {
-  view.slide(:left, duration:0)
+  view.slide(:left, 20)
+  view.rotate(90.degrees)
 }.and_then {
-  view.slide(:up, chain:true)  # sets duration:0, delay:0
+  view.slide(:up, 20)
+  view.rotate(90.degrees)
 }.and_then {
-  view.fade_out  # in case you were wondering, the very LAST animation CAN be
-}.start          # called normally.
+  view.slide(:right, 20)
+  view.rotate(90.degrees)
+}.and_then {
+  view.slide(:down, 20)
+  view.rotate(90.degrees)
+}.and_then {
+  view.fade_out
+  view.rotate_to(0.degrees)
+}.start
 ```
 
 Chains can also be written like this:
 
 ```ruby
 chain = UIView.animation_chain
-chain << proc { view.slide(:left, 20) }
-chain << proc { view.slide(:up, 20) }
-chain << proc { view.slide(:right, 20) }
-chain << proc { view.slide(:down, 20) }
+chain << proc { view.slide(:left, 20, chain: true) }
+chain << proc { view.slide(:up, 20, chain: true) }
+chain << proc { view.slide(:right, 20, chain: true) }
+chain << proc { view.slide(:down, 20, chain: true) }
 chain << proc { view.fade_out }
 chain.start
 ```
 
+**AND** chains can be looped!  Either number of times, or call `stop` on the
+chain.
+
+```ruby
+chain = UIView.animation_chain {
+  view.slide(:left, 20)
+}.and_then {
+  view.slide(:right, 20)
+}.loop  # loop forever
+2.seconds.later { chain.stop }  # the animation will complete, but not loop again
+chain.loop(10)  # would loop 10 times
+
+# if you're impatient
+chain.abort
+# will stop the animation at the end of whatever block it is in, so it could be
+# in a strange position, depending on where in the chain it is.  better to call
+# `stop`
+```
+
 ##### View factories
 
 ###### UIButton

data/lib/sugarcube/animation_chain.rb

@@ -1,5 +1,6 @@
 module SugarCube
   class AnimationChain
+
     class << self
 
       def chains
@@ -7,17 +8,17 @@ module SugarCube
       end
 
       def start_chain(chain)
-        chains << chain
+        chains << chain unless chains.include?(chain)
       end
 
       def stop_chain(chain)
-        chains ||= []
-        @chains.delete(chain)
+        chains.delete(chain)
       end
 
     end
 
     def initialize
+      raise "animation chains cannot be nested" if Thread.current[:sugarcube_chaining]
       @blocks = []
     end
 
@@ -44,21 +45,57 @@ module SugarCube
 
       options, block = @blocks[@block_index]
       @after_block = ->(completed){
-        self.do_next || AnimationChain.stop_chain(self)
+        if @abort || ! self.do_next
+          @running = false
+          if @loop
+            start
+          else
+            AnimationChain.stop_chain(self)
+          end
+        end
       }
       options[:after] = @after_block
 
       UIView.animate(options) {
+        Thread.current[:sugarcube_chaining] = true
         block.call
+        Thread.current[:sugarcube_chaining] = nil
         @block_index += 1
       }
       true
     end
 
     def start
+      return if @running
       AnimationChain.start_chain(self)
+      @running = true
+      @abort = nil
       @block_index = 0
+      if Fixnum === @loop
+        @loop -= 1
+        @loop = nil if @loop == 0
+      end
       do_next
+      return self
+    end
+
+    # @param times [Fixnum,nil] number of times to loop, or any other truthy value to loop forever
+    def loop(times=true)
+      @loop = times
+      start
+    end
+
+    # Cancels a loop, but lets the chain finish
+    def stop
+      @loop = nil
+    end
+
+    # stops the animation immediately
+    def abort
+      return unless @running
+      @loop = nil
+      @abort = true
+      @running = false
     end
 
   end

data/lib/sugarcube/uiview.rb

@@ -34,9 +34,10 @@ class UIView
 
       # chain: true is used inside animation_chain blocks to prevent some weird
       # animation errors (nested animations do not delay/queue as you'd expect)
-      if options[:chain]
+      if options[:chain] || Thread.current[:sugarcube_chaining]
         duration = 0
         delay = 0
+        raise "Completion blocks cannot be used within an animation_chain block" if options[:after]
       end
 
       after_animations = options[:after]
@@ -56,7 +57,7 @@ class UIView
       else
         UIView.animateWithDuration( duration,
                              delay: delay,
-                           options: options[:options] || UIViewAnimationOptionCurveEaseInOut,
+                           options: options[:options] || (UIViewAnimationOptionCurveEaseInOut|UIViewAnimationOptionBeginFromCurrentState),
                         animations: animations,
                         completion: after_adjusted
                                   )
@@ -225,6 +226,8 @@ class UIView
     self
   end
 
+  # Changes the current rotation to `new_angle`
+  # (`rotate` rotates relative to the current rotation)
   def rotate_to(options={}, &after)
     if options.is_a? Numeric
       options = { angle: options }
@@ -237,6 +240,21 @@ class UIView
     }
   end
 
+  # Changes the current rotation by `new_angle`
+  # (`rotate` rotates to a specific angle)
+  def rotate(options={}, &after)
+    if options.is_a? Numeric
+      new_angle = options
+      options = {}
+    else
+      new_angle = options[:angle]
+    end
+
+    old_angle = valueForKeyPath('layer.transform.rotation.z')
+    options[:angle] = old_angle + new_angle
+    rotate_to(options, &after)
+  end
+
   def slide(direction, options={}, more_options=nil, &after)
     if options.is_a? Numeric
       size = options
@@ -312,7 +330,7 @@ class UIView
     end
 
     options[:duration] ||= default_duration
-    options[:options] ||= UIViewAnimationOptionCurveEaseIn
+    options[:options] ||= UIViewAnimationOptionCurveEaseIn|UIViewAnimationOptionBeginFromCurrentState
     reset_transform = self.transform
     reset_after = ->(finished) {
       self.transform = reset_transform

data/lib/sugarcube/version.rb

@@ -1,3 +1,3 @@
 module SugarCube
-  Version = '0.18.12'
+  Version = '0.18.16'
 end

data/spec/{uiview_animation_chain_spec.rb → animation_chain_spec.rb}

@@ -1,10 +1,6 @@
 describe "SugarCube::AnimationChain" do
   tests SugarCube::AnimationChainController
 
-  it "should have a view" do
-    controller.view.should != nil
-  end
-
   it "should support chains" do
     SugarCube::AnimationChain.chains.length.should == 0
     @variable_a = nil
@@ -73,4 +69,72 @@ describe "SugarCube::AnimationChain" do
     }
   end
 
+  it "should support looping" do
+    SugarCube::AnimationChain.chains.length.should == 0
+    @variable_a = 0
+    @num_loops = 2
+    UIView.animation_chain(duration:0.1){
+      @variable_a += 1
+    }.loop(@num_loops)
+    SugarCube::AnimationChain.chains.length.should == 1
+
+    wait 0.3 {
+      @variable_a.should == @num_loops
+      SugarCube::AnimationChain.chains.length.should == 0
+    }
+  end
+
+  it "should support stopping" do
+    SugarCube::AnimationChain.chains.length.should == 0
+    @variable_a = 0
+    @num_loops = 0
+    @chain = UIView.animation_chain(duration:0.1){
+      @variable_a += 1
+      f = controller.view.frame
+      f.origin.x -= 20
+      controller.view.frame = f
+    }.loop
+    SugarCube::AnimationChain.chains.length.should == 1
+
+    wait 0.2 {
+      SugarCube::AnimationChain.chains.length.should == 1
+      @variable_a.should > 1
+      @chain.stop
+    }
+
+    wait 0.4 {
+      SugarCube::AnimationChain.chains.length.should == 0
+      @variable_a.should < 4
+    }
+  end
+
+  it "should support aborting" do
+    SugarCube::AnimationChain.chains.length.should == 0
+    @variable_a = 0
+    @num_loops = 0
+    @chain = UIView.animation_chain(duration:0.1){
+      @variable_a += 1
+      f = controller.view.frame
+      f.origin.x -= 20
+      controller.view.frame = f
+    }.loop
+    SugarCube::AnimationChain.chains.length.should == 1
+
+    wait 0.21 {
+      SugarCube::AnimationChain.chains.length.should == 1
+      @variable_a.should == 2
+    }
+
+    wait 0.31 {
+      @chain.abort
+      SugarCube::AnimationChain.chains.length.should == 0
+      @variable_a.should > 1
+      @variable_a.should < 4
+      @num_loops = @variable_a
+    }
+    wait 0.51 {
+      @variable_a.should == @num_loops
+    }
+  end
+
 end

data/spec/uiview_animation_spec.rb

@@ -8,12 +8,20 @@ describe "UIView animation methods" do
   end
 
   it 'should rotate 45 degrees' do
-    angle = 45*Math::PI/180
+    angle = 45.degrees
     @view.rotate_to(angle)
     current_angle = Math.atan2(@view.transform.b, @view.transform.a)
     current_angle.should == angle
   end
 
+  it 'should rotate 45 degrees and then 45 degrees again' do
+    angle = 45.degrees
+    @view.rotate_to(angle)
+    @view.rotate(angle)
+    current_angle = Math.atan2(@view.transform.b, @view.transform.a)
+    current_angle.should == 90.degrees
+  end
+
   it 'should animate anything' do
     UIView.animate {
       @view.frame = [[0, 0], [0, 0]]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sugarcube
 version: !ruby/object:Gem::Version
-  version: 0.18.12
+  version: 0.18.16
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-22 00:00:00.000000000 Z
+date: 2013-02-26 00:00:00.000000000 Z
 dependencies: []
 description: ! '== Description
 
@@ -123,6 +123,7 @@ files:
 - runtests
 - spec/568_spec.rb
 - spec/activesupport_spec.rb
+- spec/animation_chain_spec.rb
 - spec/calayer_spec.rb
 - spec/core_graphics_spec.rb
 - spec/core_location_spec.rb
@@ -147,7 +148,6 @@ files:
 - spec/uicolor_spec.rb
 - spec/uiimage_color_at_spec.rb
 - spec/uiimage_scale_spec.rb
-- spec/uiview_animation_chain_spec.rb
 - spec/uiview_animation_spec.rb
 - spec/uiview_attr_updates_spec.rb
 - spec/uiview_spec.rb
@@ -181,6 +181,7 @@ summary: Extensions for Ruby to make Rubymotion development more enjoyable, and
 test_files:
 - spec/568_spec.rb
 - spec/activesupport_spec.rb
+- spec/animation_chain_spec.rb
 - spec/calayer_spec.rb
 - spec/core_graphics_spec.rb
 - spec/core_location_spec.rb
@@ -205,9 +206,7 @@ test_files:
 - spec/uicolor_spec.rb
 - spec/uiimage_color_at_spec.rb
 - spec/uiimage_scale_spec.rb
-- spec/uiview_animation_chain_spec.rb
 - spec/uiview_animation_spec.rb
 - spec/uiview_attr_updates_spec.rb
 - spec/uiview_spec.rb
 - spec/unholy_spec.rb
-has_rdoc: