motion-launchpad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d8475a91ccb4f9f7145fbe256abe129be4875fb
+  data.tar.gz: c3e2299b74b69312bfc1b00545dfde659c032dca
+SHA512:
+  metadata.gz: 4ac55aa3d16ce738f3aa5d2e92bdc3dde59fd3ad913b57049e874303427fdd3dde50d4e6caf7de30e3cbeff91824c73987d608b96a005aaa1ec867724dc2d8af
+  data.tar.gz: f732c2cf51d486640bcea82f1c9e3fa5ccf4ef75c82d10c7fff5320a6a5ee385a0e7948de8b2e88cd263985b7ffcd749dae86f5916136aaf15958ab2c86d18b5

data/README.md

@@ -0,0 +1,51 @@
+# motion-launchpad
+Provides a simple DSL to easily schedule events, on the 1st, 3rd, 500th, or every launch.  This gem requires [RubyMotion](http://www.rubymotion.com).
+
+## Installation
+
+Add the following to your project's Gemfile to work with bundler:
+
+```ruby
+gem 'motion-launchpad'
+```
+
+Install with bundler:
+
+```shell
+bundle install
+```
+
+## Using
+
+After installation, you can use the gem in your project like so:
+
+```ruby
+class AppDelegate
+  def application(app, didFinishLaunchingWithOptions: options)
+
+    setup_schedule
+    Motion::Launchpad.run!
+  end
+
+  private
+
+  def setup_schedule
+    Motion::Launchpad.configure do |config|
+      config.on :every do
+        # maybe track app launch with analytics?
+      end
+
+      config.on 1 do
+        # first launch, maybe show user a tutorial?
+      end
+    end
+  end
+
+  # You can call `configure` multiple times
+  Motion::Launchpad.configure do |config|
+    config.on 5 do
+      # ask user to rate your app? Hate doing that, but best I could come up with
+    end
+  end
+end
+```

data/lib/motion-launchpad.rb

@@ -0,0 +1,9 @@
+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|
+  gem_files = Dir.glob(File.join(lib_dir_path, "motion/**/*.rb"))
+  app.files.unshift(gem_files).flatten!
+end

data/lib/motion/launchpad.rb

@@ -0,0 +1,20 @@
+module Motion
+  module Launchpad
+    
+    class << self
+      attr_accessor :instance
+    end
+
+    def configure(*args, &block)
+      self.instance = Schedule.new(*args) if instance.nil?
+      instance.configure(&block) if block_given?
+      instance
+    end
+
+    def run!
+      instance.run!
+    end
+
+    module_function :configure, :run!
+  end
+end

data/lib/motion/launchpad/event.rb

@@ -0,0 +1,23 @@
+module Motion
+  module Launchpad
+    class Event
+      attr_reader :count, :callback
+
+      def initialize(count, callback)
+        @count, @callback = count, callback
+      end
+
+      def call
+        callback.call
+      end
+
+      def applicable?(launch)
+        every? || launch == count
+      end
+
+      def every?
+        count == :every
+      end
+    end
+  end
+end

data/lib/motion/launchpad/schedule.rb

@@ -0,0 +1,44 @@
+module Motion
+  module Launchpad
+    class Schedule
+      attr_accessor :preferences_key
+
+      def initialize(options={}, &block)
+        self.preferences_key = options.fetch(:preferences_key, :launch_count)
+        @events = []
+
+        handle_launch
+      end
+
+      def configure
+        yield(self) if block_given?
+      end
+
+      def on(count, &block)
+        @events << Event.new(count, block)
+      end
+
+      def run!
+        events.each { |e| e.call }
+      end
+
+      def events
+        @events.select { |e| e.applicable?(launch_count) }
+      end
+
+      private
+
+      def launch_count
+        NSUserDefaults.standardUserDefaults[preferences_key]
+      end
+
+      def handle_launch
+        if NSUserDefaults.standardUserDefaults[preferences_key].nil?
+          NSUserDefaults.standardUserDefaults[preferences_key] = 1
+        else
+          NSUserDefaults.standardUserDefaults[preferences_key] = NSUserDefaults.standardUserDefaults[preferences_key] + 1
+        end
+      end
+    end
+  end
+end

data/lib/motion/launchpad/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module Launchpad
+    VERSION = "0.0.1"
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,22 @@
+describe Motion::Launchpad do
+
+  it "should return an instance" do
+    Motion::Launchpad.configure.should.be.instance_of Motion::Launchpad::Schedule
+  end
+
+  it "should return the same instance twice" do
+    instance = Motion::Launchpad.configure
+    instance.should.be.equal Motion::Launchpad.configure
+  end
+
+  it "delegates #run! to an instance" do
+    @runner = nil
+
+    Motion::Launchpad.configure do |config|
+      config.on(:every) { @runner = true }
+    end
+
+    Motion::Launchpad.run!
+    @runner.should.be.true
+  end
+end

data/spec/event_spec.rb

@@ -0,0 +1,39 @@
+describe Motion::Launchpad::Event do
+
+  def event(count, callback=nil)
+    Motion::Launchpad::Event.new count, callback
+  end
+
+  describe '#every?' do
+    it "returns false if not a symbol matching :every" do
+      event(1).should.not.be.every
+    end
+
+    it "returns true if given :every" do
+      event(:every).should.be.every
+    end
+  end
+
+  describe '#applicable?' do
+    it "returns always returns true if #every? is true" do
+      event(:every).should.be.applicable(1)
+      event(:every).should.be.applicable(5)
+    end
+
+    it "returns false if count does not match" do
+      event(1).should.not.be.applicable(5)
+    end
+
+    it "returns true if count matches" do
+      event(1).should.be.applicable(1)
+    end
+  end
+
+  describe '#call' do
+    it "executes the given block" do
+      e = event :every, ->{ true }
+      e.call.should.be.true
+    end
+  end
+
+end

data/spec/schedule_spec.rb

@@ -0,0 +1,65 @@
+describe Motion::Launchpad::Schedule do
+
+  before do
+    NSUserDefaults.standardUserDefaults[:launch_count] = nil
+  end
+
+  describe '#configure' do
+    it "runs the block" do
+      instance = Motion::Launchpad::Schedule.new
+      instance.configure { true }.should.be.true
+    end
+  end
+
+  it "defaults the preferences key to :launch_count" do
+    instance = Motion::Launchpad::Schedule.new
+    instance.preferences_key.should.be.equal :launch_count
+  end
+
+  it "allows you to customize the preferences key" do
+    instance = Motion::Launchpad::Schedule.new preferences_key: :my_counter
+    instance.preferences_key.should.be.equal :my_counter
+  end
+
+  it "initializes NSUserDefaults store on #new" do
+    instance = Motion::Launchpad::Schedule.new
+    NSUserDefaults.standardUserDefaults[:launch_count].should.be.equal 1
+  end
+
+  it "adds a new event when call #on inside the configure block" do
+    instance = Motion::Launchpad::Schedule.new
+    instance.configure do |config|
+      config.on(:every) { true }
+    end
+
+    instance.events.should.not.be.empty
+    e = instance.events.first
+    e.count.should.be.equal :every
+  end
+
+  it "calling #configure multiple times continues to add events" do
+    instance = Motion::Launchpad::Schedule.new
+    instance.configure do |config|
+      config.on(:every) { true }
+    end
+
+    instance.configure do |config|
+      config.on(1) { true }
+    end
+
+    instance.events.count.should.be.equal 2
+  end
+
+  it "executes the events when calling #run!" do
+    instance = Motion::Launchpad::Schedule.new
+    instance.configure do |config|
+      config.on(:every) { NSUserDefaults.standardUserDefaults[:my_testing_key] = "test" }
+    end
+
+    NSUserDefaults.standardUserDefaults[:my_testing_key].should.be.nil
+
+    instance.run!
+
+    NSUserDefaults.standardUserDefaults[:my_testing_key].should.be.equal "test"
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: motion-launchpad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Brewer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-24 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: DSL to schedule events on app launch and keeps track of app launch for
+  you.
+email:
+- matt.brewer@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-launchpad.rb
+- lib/motion/launchpad.rb
+- lib/motion/launchpad/event.rb
+- lib/motion/launchpad/schedule.rb
+- lib/motion/launchpad/version.rb
+- spec/configuration_spec.rb
+- spec/event_spec.rb
+- spec/schedule_spec.rb
+homepage: https://github.com/macfanatic/motion-launchpad
+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: "[none]"
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides an easy DSL for scheduling events on app launch
+test_files:
+- spec/configuration_spec.rb
+- spec/event_spec.rb
+- spec/schedule_spec.rb