rm-extensions 0.0.1

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 rm-extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Noon
+
+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,32 @@
+# RMExtensions
+
+Extensions and helpers for dealing with various areas of rubymotion:
+
+- memory management
+- block/scope/local variable issues
+- GCD blocks
+- retaining objects through async procedures
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rm-extensions'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Read through the commented code.
+
+## Contributing
+
+If you have a better way to accomplish anything this library is doing, please share!
+
+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

data/Rakefile

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

data/lib/motion/rm-extensions.rb

@@ -0,0 +1,177 @@
+module RMExtensions
+
+  # this module is included on Object, so these methods are available from anywhere in your code.
+  module ObjectExtensions
+
+    def rmext_assert_main_thread!
+      raise "This method must be called on the main thread." unless NSThread.currentThread.isMainThread
+    end
+
+    # https://gist.github.com/mattetti/2951773
+    # https://github.com/MacRuby/MacRuby/issues/152
+    # blocks within blocks can be a problem with GCD (and maybe RM/MacRuby in general?).
+    # these helpers make it easy to use nested blocks with GCD, and also ensures those
+    # blocks will not be garbage collected until at least after they have been called.
+
+    def rmext_on_main_q(&block)
+      rmext_retained_context do |x|
+        x.block = -> do
+          block.call
+          x.detach!
+        end
+        Dispatch::Queue.main.async(&x.block)
+      end
+    end
+
+    def rmext_on_serial_q(q, &block)
+      Dispatch.once { $serial_qs = {} }
+      rmext_retained_context do |x|
+        x.block = -> do
+          block.call
+          x.detach!
+        end
+        x.key = "#{NSBundle.mainBundle.bundleIdentifier}.serial.#{q}"
+        $serial_qs[x.key] ||= Dispatch::Queue.new(x.key)
+        $serial_qs[x.key].async(&x.block)
+      end
+    end
+
+    def rmext_on_concurrent_q(q, &block)
+      rmext_retained_context do |x|
+        x.block = -> do
+          block.call
+          x.detach!
+        end
+        x.key = "#{NSBundle.mainBundle.bundleIdentifier}.concurrent.#{q}"
+        Dispatch::Queue.concurrent(x.key).async(&x.block)
+      end
+    end
+
+    # #rmext_retain! is different than a normal retain.  it adds the object(self) to a retained
+    # array, utilizing RM's underlying GC logic
+    #
+    # you most likely want to use #rmext_retained_context and not call this directly
+    #
+    def rmext_retain!
+      ::RMExtensions::RetainedContext.rmext_retains_queue.sync do
+        ::RMExtensions::RetainedContext.rmext_retains.push(self)
+      end
+    end
+
+    # #rmext_detach! is slightly similar to the concept of "release".  it removes the object(self)
+    # from a retained array (only one hit, in case the same object is #rmext_retain!'d multiple times),
+    # utilizing RM's underlying GC logic.  if nothing else has a strong reference to the object after
+    # it is detached, it will eventually be handled by RM's GC.
+    #
+    # you most likely want to use #rmext_retained_context and not call this directly
+    #
+    def rmext_detach!
+      ::RMExtensions::RetainedContext.rmext_retains_queue.async do
+        ::RMExtensions::RetainedContext.rmext_retains.delete_at(::RMExtensions::RetainedContext.rmext_retains.index(self) || ::RMExtensions::RetainedContext.rmext_retains.length)
+      end
+    end
+
+    # #rmext_retained_context yields an object you can treat like an openstruct.  you can get/set any
+    # property on it.  the context is globally retained, until #detach! is called on the context.
+    # this convention should fill the gap where local variables and scope bugs currently occur in RM,
+    # and it also solves the re-entrant problem of using instance variables for retaining purposes.
+    #
+    # always be sure to #detach! the context at the correct place in time.
+    #
+    # example:
+    #
+    # rmext_retained_context do |x|
+    #   rmext_on_serial_q("my_serial_q") do
+    #     some_async_http_request do |results1|
+    #       x.results1 = results1
+    #       rmext_on_serial_q("my_serial_q") do
+    #         some_other_async_http_request do |results2|
+    #           x.results2 = results2
+    #           rmext_on_main_q do
+    #             p "results1", x.results1
+    #             p "results2", x.results2
+    #             x.detach!
+    #           end
+    #         end
+    #       end
+    #     end
+    #   end
+    # end
+    #
+    # experimental feature:
+    #
+    # you can call #beginBackground! on the context, and it will check-out a background task identifier,
+    # and automatically end the background task when you call #detach! as normal.
+    def rmext_retained_context(&block)
+      ::RMExtensions::RetainedContext.retained(self, &block)
+    end
+
+  end
+
+  # You don't use this class directly.
+  class RetainedContext
+
+    class << self
+      def rmext_retains
+        Dispatch.once { @rmext_retains = [] }
+        @rmext_retains
+      end
+
+      def rmext_retains_queue
+        Dispatch.once { @rmext_retains_queue = Dispatch::Queue.new("#{NSBundle.mainBundle.bundleIdentifier}.rmext_retains_queue") }
+        @rmext_retains_queue
+      end
+
+      def retained(origin, &block)
+        x = new
+        x.hash["retained_origin"] = origin
+        x.hash["retained_block"] = block
+        x.rmext_retain!
+        block.call(x)
+        x
+      end
+    end
+
+    attr_accessor :hash
+
+    def initialize
+      self.hash = {}
+    end
+
+    # if you provide a block, you are responsible for calling #detach!,
+    # otherwise, the expiration handler will just call #detach!
+    def beginBackground!(&block)
+      hash["bgTaskExpirationHandler"] = block
+      hash["bgTask"] = UIApplication.sharedApplication.beginBackgroundTaskWithExpirationHandler(-> do
+        if hash["bgTaskExpirationHandler"]
+          hash["bgTaskExpirationHandler"].call
+        else
+          x.detach!
+        end
+      end)
+    end
+
+    def detach!
+      if hash["bgTask"] && hash["bgTask"] != UIBackgroundTaskInvalid
+        UIApplication.sharedApplication.endBackgroundTask(hash["bgTask"])
+      end
+      self.hash = nil
+      rmext_detach!
+    end
+
+    def method_missing(method, *args)
+      unless hash
+        raise "You detached this rmext_retained_context and then called: #{method}"
+      end
+      m = method.to_s
+      if m =~ /(.+)?=$/
+        hash[$1] = args.first
+      else
+        hash[m]
+      end
+    end
+
+  end
+
+end
+Object.send(:include, ::RMExtensions::ObjectExtensions)

data/lib/rm-extensions/version.rb

@@ -0,0 +1,3 @@
+module RMExtensions
+  VERSION = "0.0.1"
+end

data/lib/rm-extensions.rb

@@ -0,0 +1,11 @@
+require "rm-extensions/version"
+
+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/**/*.rb')).each do |file|
+    app.files.unshift(file)
+  end
+end

data/rm-extensions.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rm-extensions/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rm-extensions"
+  gem.version       = RMExtensions::VERSION
+  gem.authors       = ["Joe Noon"]
+  gem.email         = ["joenoon@gmail.com"]
+  gem.description   = %q{Extensions and helpers for dealing with various areas of rubymotion}
+  gem.summary       = %q{Extensions and helpers for dealing with various areas of rubymotion}
+  gem.homepage      = "https://github.com/joenoon/rm-extensions"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rm-extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Noon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies: []
+description: Extensions and helpers for dealing with various areas of rubymotion
+email:
+- joenoon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/motion/rm-extensions.rb
+- lib/rm-extensions.rb
+- lib/rm-extensions/version.rb
+- rm-extensions.gemspec
+homepage: https://github.com/joenoon/rm-extensions
+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.23
+signing_key: 
+specification_version: 3
+summary: Extensions and helpers for dealing with various areas of rubymotion
+test_files: []