msk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e83ebd96d0dc2a7c3e511e4d75e3ad3f1cad06b8
+  data.tar.gz: f6102d4c11f2b8e59ebdaad423429ea78fc222b4
+SHA512:
+  metadata.gz: 3a1f7e1533bff4acbd40f1ca143ffb266232a2b1cc93ccf9022647d7e29e24a2054f7b129fe77cdf5a5703cc619d91ad8e12cee03bf101518a0363e0847d033e
+  data.tar.gz: 6d5a9e5019044cfd2de31d4d9877498dc792097cf142e74b9cfb6d681bb0cff414c01c1c09ac2ad3a7ac8fe0c08854c54997932ff3d65c4ab2151f8a054b4c98

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jim Nanney
+
+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,170 @@
+# msk - Motion SlicK
+
+Motion SlicK is a wrapper of the SpriteKit api that helps make building SpriteKit based games easier.
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Contributing](#contributing)
+* [License](#license)
+* [API Documentation](#api-documentation)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'msk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install msk
+
+## Usage
+
+The Motion SlicK gem adds a convenience DSL for SKAction onto the SKNode class. This adds less verbose names for common SKActions, and provides an easy way to build sequences and grouped actions (even nested).
+
+For example:
+
+```ruby
+  def animate_swap(swap, &block)
+    from = swap.tile_b.sprite
+    to = swap.tile_a.sprite
+    fpos = from.position
+    tpos = to.position
+    from.zPosition = 90 
+    to.zPosition = 100
+
+    to.run_sequence do
+      move_to(fpos, 0.3).ease_out
+      run_block &block
+    end
+
+    from.run_action move_to(to.position,0.3).ease_out
+    run_action @swap_sound
+  end
+```
+
+Here we are creating and running a sequence of actions on the ```to``` node.
+
+The move_to action takes a position, and optional duration.
+
+The DSL adds some more syntactic sugar by adding timing mode additions, such as the ```ease_out`` timing mode above used above.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Jim Nanney
+
+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.
+
+## API Documentation
+
+### SKNode Action helper additions
+
+#### run_sequence(&block)
+
+Creates a Sequence action from the actions contained in the block and then starts the animation.
+
+#### run_group(&block)
+
+Creates a Group action from the actions contained in the block and then starts the animation.
+
+#### group(&block)
+
+Creates a Group action from the actions contained in the block and returns it.
+
+#### repeat(count, action = nil,  &block)
+
+Creates a Repeat action for either the action passed in, or a block containing actions to be performed on the node.
+
+#### sequence(&block)
+
+Creates a Sequence action from the actions contained in the block and returns it.
+
+#### move_to(location, duration)
+
+Returns a SKAction.moveTo:duration: action
+
+#### move_by(delta, duration=0.25)
+
+Returns a SKAction.moveBy:duration: action
+
+#### fade_in(duration = 0.25)
+
+Returns a SKAction.fadeInWithDuration: action
+
+#### fade_out(duration = 0.25)
+
+Returns a SKAction.fadeOutWithDuration: action
+
+#### run_block(&block)
+
+Returns a SKAction.runBlock action 
+
+#### wait(duration = 0.25, with_range = nil)
+
+Returns a SKAction.waitForDuration action or SKAction.waitForDuration:withRange action in with_range is specified
+
+#### scale_to(scale = 1.0, duration=0.25)
+
+Returns a SKAction.scaleTo:duration: action
+
+#### remove_from_parent
+
+Returns a SKAction.removeFromParent action
+
+#### other_action(other)
+
+Allows addition of an action that may not have a helper into a sequence
+
+### SKNode position helpers
+
+These methods allow easy inspection of the node's position and frame.
+
+#### mid_x
+#### mid_y
+#### height
+#### width
+#### top
+#### bottom
+#### left
+#### right
+
+### SKAction helper methods
+
+The following methods are added to SKAction to allow setting the timing mode easier. They all return self which allows easy chaining
+
+#### ease_in
+#### ease_out
+#### linear
+
+

data/lib/msk.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))
+end

data/lib/project/actions/content.rb

@@ -0,0 +1,4 @@
+module MSK::Actions
+  module Content
+  end
+end

data/lib/project/actions/delay.rb

@@ -0,0 +1,10 @@
+module MSK::Actions
+  module Delay
+
+    def wait(duration = 0.25, with_range = nil)
+      return SKAction.waitForDuration(duration) unless with_range
+      SKAction.waitForDuration(duration, with_range)
+    end
+
+  end
+end

data/lib/project/actions/kinematics.rb

@@ -0,0 +1,5 @@
+module MSK::Actions
+  module Kinematics
+
+  end
+end

data/lib/project/actions/movement.rb

@@ -0,0 +1,33 @@
+module MSK::Actions
+  module Movement
+    def move_to(location, duration)
+      SKAction.moveTo(location, duration: duration)
+    end
+
+    def move_by(delta, duration=0.25)
+      SKAction.moveBy(delta, duration: duration)
+    end
+
+    def move_by_delta(x, y, duration=0.25)
+      SKAction.moveByX(x, y: y, duration: duration)
+    end
+
+    def move_to_x(x, duration=0.25)
+      SKAction.moveToX(x, duration: duration)
+    end
+
+    def move_to_y(y, duration=0.25)
+      SKAction.moveToY(y, duration: duration)
+    end
+
+    def duration_path(path, duration=0.25, offset=true, orient=true)
+      SKAction.followPath(path, asOffset: offset, orientToPath: orient, duration: duration)
+    end
+
+    def speed_path(path, speed=1.0, offset=true, orient=true)
+      SKAction.followPath(path, asOffset: offset, orientToPath: orient, speed: speed)
+    end
+
+  end
+end
+

data/lib/project/actions/properties.rb

@@ -0,0 +1,5 @@
+module MSK::Actions
+  module Properties
+
+  end
+end

data/lib/project/actions/rotation.rb

@@ -0,0 +1,17 @@
+module MSK::Actions
+  module Rotation
+
+    def rotate_by(angle, duration=0.25)
+      SKAction.rotateBy(angle, duration: duration)
+    end
+
+    def rotate(angle, duration=0.25)
+      SKAction.rotateToAngle(angle, duration: duration)
+    end
+
+    def rotate_shortest(angle, duration=0.25, shortest=true)
+      SKAction.rotateToAngle(angle, duration: duration, shortestUnitArc: shortest)
+    end
+
+  end
+end

data/lib/project/actions/runners.rb

@@ -0,0 +1,37 @@
+module MSK::Actions
+  module Runners
+
+    def run_sequence(&block)
+      seq = sequence &block
+      runAction seq
+    end
+
+    def run_group(&block)
+      runAction group(block)
+    end
+
+    def group(&block)
+      grp = MSK::DSL::DSL.new(block, self)
+      SKAction.group(grp.actions)
+    end
+
+    def repeat(count, action = nil,  &block)
+      seq = (action) ? action : sequence(&block)
+      SKAction.repeatAction(seq, count)
+    end
+
+    def sequence(&block)
+      seq = MSK::DSL::DSL.new(block, self)
+      SKAction.sequence(seq.actions)
+    end
+
+    def other_action(other)
+      other
+    end
+
+    def run_block(&block)
+      SKAction.runBlock(block)
+    end
+  end
+end
+

data/lib/project/actions/scale.rb

@@ -0,0 +1,29 @@
+module MSK::Actions
+  module Scale
+
+    def scale_by(scale, duration=0.25)
+      SKAction.scaleBy(scale, duration: duration)
+    end
+
+    def scale_to(scale = 1.0, duration=0.25)
+      SKAction.scaleTo(scale, duration: duration)
+    end
+
+    def scale_xy_by(x, y, duation=0.25)
+      SKAction.scaleXBy(x, y: y, duration: duration)
+    end
+
+    def scale_xy_to(x, y, duration=0.25)
+      SKAction.scaleXTo(x, y: y, duration: duration)
+    end
+
+    def scale_x(x, duration=0.25)
+      SKAction.scaleXTo(x, duration: duration)
+    end
+
+    def scale_y(y, duration=0.25)
+      SKAction.scaleYTo(y, duration: duration)
+    end
+  end
+end
+

data/lib/project/actions/sound.rb

@@ -0,0 +1,4 @@
+module MSK::Actions
+  module Sound
+  end
+end

data/lib/project/actions/speed.rb

@@ -0,0 +1,13 @@
+module MSK::Actions
+  module Speed
+    def speed_by(speed, duration=0.25)
+      SKAction.speedBy(speed, duration: duration)
+    end
+
+    def speed_to(speed, duration=0.25)
+      SKAction.speedTo(speed, duration: duration)
+    end
+  end
+
+end
+

data/lib/project/actions/transparency.rb

@@ -0,0 +1,22 @@
+module MSK::Actions
+  module Transparency
+
+    def fade_in(duration=0.25)
+      SKAction.fadeInWithDuration duration
+    end
+
+    def fade_out(duration=0.25)
+      SKAction.fadeInWithDuration duration
+    end
+
+    def fadeBy(factor, duration=0.25)
+      SKAction.fadeAlphaBy(factor, duration: duration)
+    end
+
+    def fadeTo(alpha, duration=0.25)
+      SKAction.fadeAlphaTo(alpha, duration: duration)
+    end
+
+  end
+end
+

data/lib/project/actions/visibility.rb

@@ -0,0 +1,20 @@
+module MSK::Actions
+  module Visibility
+
+    def unhide
+      SKAction.unhide
+    end
+
+    def hide
+      SKAction.hide
+    end
+
+    def remove_from_parent
+      SKAction.removeFromParent
+    end
+
+    alias_method :show, :unhide
+
+  end
+end
+

data/lib/project/dsl.rb

@@ -0,0 +1,26 @@
+module MSK::DSL
+  class DSL
+    attr_accessor :actions
+
+    def initialize(block, parent)
+      @actions = []
+      @parent = parent
+      instance_eval(&block) if block
+    end
+
+    def method_missing(name, *args, &block)
+      if @parent.respond_to?(name)
+        act = @parent.send(name, *args, &block)
+      else
+        act = super
+      end
+      @actions << act if act.kind_of?(SKAction)
+      act
+    end
+
+    def respond_to?(name, include_all=false)
+      @parent.respond_to?(name) || super
+    end
+  end
+end
+

data/lib/project/helpers/frame_helpers.rb

@@ -0,0 +1,38 @@
+module MSK
+
+  module FrameHelpers
+
+    def mid_x
+      CGRectGetMidX(self.frame)
+    end
+
+    def mid_y
+      CGRectGetMidY(self.frame)
+    end
+
+    def height
+      CGRectGetHeight(self.frame)
+    end
+
+    def width
+      CGRectGetWidth(self.frame)
+    end
+
+    def top
+      CGRectGetMaxY(self.frame)
+    end
+
+    def bottom
+      CGRectGetMinY(self.frame)
+    end
+
+    def left
+      CGRectGetMinX(self.frame)
+    end
+
+    def right
+      CGRectGetMaxX(self.frame)
+    end
+  end
+
+end

data/lib/project/msk.rb

@@ -0,0 +1,24 @@
+module MSK::ActionDSL
+  include MSK::Actions::Movement
+  include MSK::Actions::Rotation
+  include MSK::Actions::Speed
+  include MSK::Actions::Scale
+  include MSK::Actions::Visibility
+  include MSK::Actions::Transparency
+  include MSK::Actions::Content
+  include MSK::Actions::Sound
+  include MSK::Actions::Delay
+  include MSK::Actions::Runners
+  include MSK::DSL
+end
+
+class SKNode
+  include MSK::ActionDSL
+  include MSK::FrameHelpers
+  alias_method :run_action, :runAction
+end
+
+class SKAction
+  include MSK::ActionTimings
+end
+

data/lib/project/timings/action_timings.rb

@@ -0,0 +1,19 @@
+module MSK::ActionTimings
+
+  def ease_in
+    timing_mode = SKActionTimingEaseIn
+    self
+  end
+
+  def ease_out
+    timing_mode = SKActionTimingEaseOut
+    self
+  end
+
+  def linear
+    timing_mode = SKActionTimingLinear
+    self
+  end
+
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: msk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jim Nanney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Motion SlicK is a wrapper of the SpriteKit api that helps make building
+  SpriteKit based games easier. The Motion SlicK gem adds a convenience DSL for SKAction
+  onto the SKNode class. This adds less verbose names for common SKActions, and provides
+  an easy way to build sequences and grouped actions (even nested). It also adds a
+  few convenience methods for determining SKNode size and boundaries.
+email:
+- jnanney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/msk.rb
+- lib/project/actions/content.rb
+- lib/project/actions/delay.rb
+- lib/project/actions/kinematics.rb
+- lib/project/actions/movement.rb
+- lib/project/actions/properties.rb
+- lib/project/actions/rotation.rb
+- lib/project/actions/runners.rb
+- lib/project/actions/scale.rb
+- lib/project/actions/sound.rb
+- lib/project/actions/speed.rb
+- lib/project/actions/transparency.rb
+- lib/project/actions/visibility.rb
+- lib/project/dsl.rb
+- lib/project/helpers/frame_helpers.rb
+- lib/project/msk.rb
+- lib/project/timings/action_timings.rb
+homepage: https://github.com/jimnanney/motion_slick
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Motion SlicK is a wrapper of the SpriteKit api that helps make building SpriteKit
+  based games easier.
+test_files: []