motion_blender 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66517bde47352d1d631eaf58b86b54846704e6ea
-  data.tar.gz: cbeb710b43f03f046f0cb3ca6491322059a0e3d8
+  metadata.gz: 1f62586a884e6abf4b6c8ae93a1d655764f28ad8
+  data.tar.gz: 4e7a196e3652339c6dc76a35a0b5fd8b78d7b4e7
 SHA512:
-  metadata.gz: 6e5f5ce23150e86b6e69381ae1a92e3c01ab2b18aec637a3b4f131d7892f8f9725c52a57553fd7943f541a4ce14aaf3f77b3f55a5d25a2355eea3bfc409dd28f
-  data.tar.gz: cfc18c3a8c9cfd5022385a0753cb406d544c6b6f48778bc56b072c4702ec04ec032e9a52bf7ed69c8107e0c0839e3d64befb867f4edcd31deecb6eb1c01e7a0b
+  metadata.gz: dcd57b42e5243744ae42c1f968c22c6b507d9a4240e5011a5e66bd19e20638c6768158c09c6afa09482f7680b38ed6d04739e97be15c5c4311b87c3c5c0cc9d7
+  data.tar.gz: 1cb179e24b2989a47e0c9b27dbc14f4e32895e6b52dcd33a4c1aee37b8acafa95c6d878c70a3c2b225192f330b3b84e26a3f43cd88cfa6b2f149088bb7dbe873

data/README.md

@@ -1,28 +1,125 @@
-# MotionBlender
+# MotionBlender [![Build Status](https://travis-ci.org/kayhide/motion_blender.svg?branch=master)](https://travis-ci.org/kayhide/motion_blender)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/motion_blender`. To experiment with that code, run `bin/console` for an interactive prompt.
+MotionBlender enables to:
 
-TODO: Delete this and the text above, and describe your gem
+- require *Ruby* files (must be RubyMotion-compatible) from RubyMotion files
+- require RubyMotion files from RubyMotion files as well
+
+and then:
+
+- add required files to `app.files`
+- resolve dependencies following require tree and put it to `app.files_dependencies`
+
+This is a sccessor of [motion-require](https://github.com/clayallsopp/motion-require) and [MotionBundler](https://github.com/archan937/motion-bundler).
+
+*motion-require* is to resolve dependencies between RubyMotion files with `motion_require` method.
+This is only for RubyMotion files and not for using Ruby gems.
+
+*MotionBundler* aims for using Ruby gems from RubyMotion.
+This is good for making an application but not for making a gem, because it requires to setup your application Gemfile explicitly.
+
+
+So, MotionBlender is good for making RubyMotion-compatible gem which depends on other RubyMotion-compatible gems.
+
+I made a fork of MotionSupport which is based on MotionBlender:
+
+- [motion_blender-support](https://github.com/kayhide/motion_blender-support)
+
+This is ready to use to make RubyMotion-compatible gems.
 
 ## Installation
 
+### When making a gem
+
+Add a dependency:
+
+```ruby
+# in .gemspec file
+
+Gem::Specification.new do |spec|
+  # ...
+  spec.add_runtime_dependency "motion_blender"
+  # ...
+end
+```
+
+### When making an application
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'motion_blender'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Add RubyMotion-compatible gem into your project (may be an application or a gem).
 
-Or install it yourself as:
+And just call `require` from anywhare:
 
-    $ gem install motion_blender
+```ruby
+require 'rubymotion_conpatible_gem'
 
-## Usage
+# your code goes on...
+```
+
+Writing a gem (*motion_hoge*), this idiom is handy:
+
+```ruby
+# in lib/motion_hoge.rb
+require 'motion_blender'
+MotionBlender.add __FILE__
+
+require 'motion_hoge/simsim'
+require 'motion_hoge/mishmish'
+require 'motion_hoge/version'
+# ...
+```
+
+This makes an app or a gem which depends on *motion_hoge* to load functionalities properly, even if it is compile-time.
+
+As a default, `motion_blender` lib files themselves are excluded for analyzing.
+So don't worry about requiring `motion_blender` in compile target files.
+
+### Limitation
+
+Currently, `require` has some limitation because of the way how to analyze the code.
+
+The argument must be a string or an eval-able expression:
+
+```ruby
+# Good
+require 'something'
+require File.join('path', 'to', 'feature')
+require File.expand_path('../otherthing', __FILE__) # __FILE__ works properly
+
+# Bad
+# analyzer does not eval outside of require method
+Dir.glob('lib/**/*.rb').each { |path| require path }
+```
+
+And required files must exist:
+
+```ruby
+# Bad
+begin
+  require 'may_not_exist'
+rescue LoadError
+  require 'alternative'
+end
+```
+
+## How does it work?
+
+In the RubyMotion application's Rakefile, `motion_blender` is to be required, typically via `Bundler.require`.
+Then it hooks `build` tasks.
+You can hit `rake -P` and see `motion_blender:analyze` task is hooked.
+
+At the analyze task, MotionBlender runs analyzer on all `Motion::Project::Config#files`.
+It uses [parser](https://github.com/whitequark/parser) and follows all `require` and `require_relative`.
+After that, add the newly encountered files to the head of `Motion::Project::Config#files` and put file dependencies to `Motion::Project::Config#dependencies`.
 
-TODO: Write usage instructions here
+When compiling, `require` and `require_relative` is overwritten as noop.
 
 ## Development
 
@@ -32,7 +129,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kayhide/motion_blender. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kayhide/motion_blender. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/motion_blender/analyzer/parser.rb

@@ -6,9 +6,9 @@ module MotionBlender
     class Parser
       REQUIREMENT_TOKENS = %i(motion_require require_relative require)
 
-      Require = Struct.new(:loader, :method, :arg, :file)
+      Require = Struct.new(:loader, :method, :arg, :file, :trace)
 
-      attr_reader :file, :requires
+      attr_reader :file, :requires, :last_trace
 
       def initialize file
         @file = file.to_s
@@ -22,16 +22,16 @@ module MotionBlender
 
       def traverse ast
         if ast && ast.type == :send && require_command?(ast)
+          @last_trace = trace_for ast
           req = parse_arg ast
           req.file = resolve_path req.method, req.arg
+          req.trace = @last_trace
           @requires << req
         elsif ast
           ast.children
             .select { |node| node.is_a?(::Parser::AST::Node) }
             .each { |node| traverse node }
         end
-      rescue LoadError => err
-        raise err, err.message, [trace_for(ast), *caller]
       end
 
       def require_command? ast
@@ -44,7 +44,7 @@ module MotionBlender
         Require.new(@file, ast.children[1], arg)
       rescue
         exp = ast.loc.expression.source
-        raise LoadError, "failed to parse `#{exp}'", caller(1)
+        raise LoadError, "failed to parse `#{exp}'"
       end
 
       def trace_for ast

data/lib/motion_blender/analyzer.rb

@@ -9,27 +9,32 @@ module MotionBlender
 
     def initialize
       @analyzed_files = Set.new
+      @exclude_files = Set.new
       @files = []
       @dependencies = {}
-      @exclude_files = []
     end
 
-    def analyze file
+    def analyze file, backtrace = []
       return if @exclude_files.include? file
       return if @analyzed_files.include? file
       @analyzed_files << file
 
       parser = Parser.new file
-      parser.parse
-      parser.requires.reject! do |req|
+      begin
+        parser.parse
+      rescue LoadError => err
+        err.set_backtrace [parser.last_trace, *backtrace].compact
+        raise err
+      end
+      requires = parser.requires.reject do |req|
         @exclude_files.include? req.file
       end
 
-      if parser.requires.any?
-        @dependencies[file] = parser.requires.map(&:file)
+      if requires.any?
+        @dependencies[file] = requires.map(&:file)
         @files = (@files + [file] + @dependencies[file]).uniq
-        @dependencies[file].each do |f|
-          analyze f
+        requires.each do |req|
+          analyze req.file, [req.trace, *backtrace]
         end
       end
     end

data/lib/motion_blender/version.rb

@@ -1,3 +1,3 @@
 module MotionBlender
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/motion_blender.rb

@@ -8,7 +8,7 @@ module MotionBlender
   def analyze
     Motion::Project::App.setup do |app|
       analyzer = Analyzer.new
-      analyzer.exclude_files = Dir[File.expand_path('../**/*.rb', __FILE__)]
+      analyzer.exclude_files += Dir[File.expand_path('../**/*.rb', __FILE__)]
       app.files.flatten.each do |file|
         analyzer.analyze file
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion_blender
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kayhide
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser