motion-rubygems 0.1.pre

data/README.md

@@ -0,0 +1,101 @@
+motion-rubygems adds (primitive and broken) support for (one or two) Rubygems to RubyMotion 
+
+Installation
+------------
+
+WARNING: By typing `--pre` you admit that *everything is broken*. Please don't even try using this if you want anything to work at all.
+
+```
+$ gem install motion-rubygems --pre
+```
+
+Usage
+-----
+
+To use motion-rubygems, first add `require 'motion-rubygems'` to the top of your Rakefile:
+
+```ruby
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+
+require 'motion-rubygems'
+```
+
+And then add gems to your app in the setup block:
+
+```ruby
+
+Motion::Project::App.setup do |app|
+  # ...
+  app.gems = %w(andand)
+end
+```
+
+Making gems motion-rubygems compatible
+--------------------------------------
+
+This is quite hard at the moment (see under "How does this even work?!!" for details).
+
+Essentially your gem will be required with the constant `RUBYMOTION_VERSION="1.6"` or similar.
+
+At compile time, you should `require` all the files that you need (note that at runtime, `require`s will be deferred to the end of the current file; so don't do anything that needs the result of the require later on in the current file). The `requires` are fully evaluated, so if you require a file from inside another file, that's fine.
+
+At runtime you should then run RubyMotion compatible ruby. There are a few restrictions (like, no `eval`, or `define_method`), and a few random strange quirks of the runtime. Good luck!
+
+(There's no way to tell the difference between compile time and run time yet, it's coming...)
+
+Snake Oil Warning
+-----------------
+
+Warning, most gems *do not work* with motion-rubygems. This is for a few reasons:
+
+1. The gem uses features of ruby that RubyMotion doesn't yet support (eval, define_method, autoload, etc.)
+2. The gem uses a C extension.
+3. The gem is highly load-order dependent.
+4. It just randomly segfaults and I don't know why.
+
+Success cases
+-------------
+
+Gems I've tested and seem to at least compile include:
+
+* andand, custom_boolean
+
+Uh, yeah, that's it. Sorry folks :(.
+
+How does this even work!?
+-------------------------
+
+As you'll know, RubyMotion doesn't support `require`, but Rubygems require it.
+
+To get round this we (at compile time) load the gem and write down all the files it requires. We then add all of these files to the app; and make RubyMotion compile them.
+
+At *runtime*, we temporarily override require to do nothing, hope that none of the bad things listed above happen, and then let RubyMotion load all the files in order.
+
+TODO
+----
+
+* Come up with conventions for writing RubyMotion gems so that they look like normal RubyGems. (not actually technically hard, but requires some people-skills!)
+
+* Work out how to include shared libraries. (In theory this is doable, but I need to talk to someone from the RubyMotion team about how to actually do it; I guess the main hard bit is supporting the ruby C API?).
+
+* Find common problems that stop lots of rubygems from working on RubyMotion, and work out sweeping solutions. (yeah, *dream on*)
+
+If everything doesn't work, Why did you do this?
+------------------------------------------------
+
+At the moment you can't use rubygems with RubyMotion at all, and that makes me really sad.
+
+The ideas being thrown around about packaging ruby motion gems make them totally incompatible with other ruby platforms, and that makes me quite sad too.
+
+Obviously there are going to be RubyMotion specific gems, and gems that RubyMotion doesn't support; however I assert that gems which work everywhere are *the most important*.
+
+It's incredibly awesome to be able to run the same code on the JVM and on an iPhone, and even (with mruby) on your dishwasher.
+
+Meta-fu
+-------
+
+This is released under the MIT license, pull-requests are very very welcome!
+
+
+

data/lib/motion-rubygems.rb

@@ -0,0 +1,70 @@
+module Motion::Project
+  
+  class Config
+    # Allow the user to do 'app.gems = %w(andand)'
+    variable :gems
+  end
+
+  class << App
+    # Override the original setup so that we can put gems before the user's own
+    # files.
+    def setup_with_motion_rubygems
+      setup_without_motion_rubygems do |app|
+        yield app
+
+        unless app.gems == []
+          app.files = MotionRubyGems.files(app.gems) + app.files
+        end
+      end
+    end
+
+    alias setup_without_motion_rubygems setup
+    alias setup setup_with_motion_rubygems
+  end
+
+  class MotionRubyGems
+    # Get a list of files that are required for the given gems.
+    #
+    # This includes a few meta-files to ensure that gems have a better
+    # chance of working.
+    def self.files(gems)
+      gem_files = []
+      gem_files << MotionRubyGems.version_file
+      gem_files <<  File.expand_path("../remove_require.rb", __FILE__)
+
+      gems.each do |gem|
+        gem_files += MotionRubyGems.files_for(gem)
+      end
+
+      gem_files << File.expand_path("../restore_require.rb", __FILE__)
+    end
+
+    # Get the files required by a given gem.
+    #
+    # At the moment this runs the gem with an overridden 'require'; it would be
+    # nice to add support for a `<gemname>.motion.rb` that can be used instead.
+    def self.files_for(gem)
+      require version_file
+      before = $".dup
+      require gem
+      files = $" - before
+
+      if (non_ruby = files - files.grep(/\.rb$/)) != []
+        raise "gem: #{gem} is not pure ruby: #{non_ruby.inspect}"
+      end
+
+      files
+    end
+
+    # This is a file that sets the RUBYMOTION_VERSION constant so that gems
+    # can alter their behaviour for Ruby Motion if necessary.
+    def self.version_file
+      File.expand_path("~/.motion-rubygems.version.rb").tap do |file|
+        File.open(file, 'w') do |f|
+          f.puts "RUBYMOTION_VERSION = #{Motion::Version.inspect}"
+        end
+      end
+    end
+  end
+end
+

data/lib/remove_require.rb

@@ -0,0 +1,6 @@
+# We want require to be a no-op when running gem code as that is full of
+# requires. Luckily RubyMotion will take care of requiring everything for us!
+module Kernel
+  alias require_without_motion_rubygems require
+  def require(*); end
+end

data/lib/restore_require.rb

@@ -0,0 +1,6 @@
+# Now that all the rubygems are loaded, re-instate the version of require that
+# raises an exception to the user.
+module Kernel
+  alias require require_without_motion_rubygems
+  undef require_without_motion_rubygems
+end

data/motion-rubygems.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = "motion-rubygems"
+  s.version = "0.1.pre"
+  s.platform = Gem::Platform::RUBY
+  s.author = "Conrad Irwin"
+  s.email = "conrad.irwin@gmail.com"
+  s.homepage = "http://github.com/ConradIrwin/motion-rubygems"
+  s.summary = "Provides primitive support for requiring some rubygems into RubyMotion"
+  s.description = "Not all (or even many) gems will work out of the box on RubyMotion. However some do, so it'd be nice to be able to use them."
+  s.files = `git ls-files`.lines.map(&:strip)
+  s.require_path = "lib"
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: motion-rubygems
+version: !ruby/object:Gem::Version
+  version: 0.1.pre
+  prerelease: 4
+platform: ruby
+authors:
+- Conrad Irwin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies: []
+description: Not all (or even many) gems will work out of the box on RubyMotion. However
+  some do, so it'd be nice to be able to use them.
+email: conrad.irwin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-rubygems.rb
+- lib/remove_require.rb
+- lib/restore_require.rb
+- motion-rubygems.gemspec
+homepage: http://github.com/ConradIrwin/motion-rubygems
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Provides primitive support for requiring some rubygems into RubyMotion
+test_files: []