motion-osx-cli 1.0

data/README.md

@@ -0,0 +1,112 @@
+# motion-osx-cli
+
+This gem helps you create command line tools for OSX using RubyMotion.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-osx-cli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-osx-cli
+
+And add this line to your Rakefile:
+
+    require 'motion-osx-cli'
+
+## Usage
+
+Define a `main` method in your AppDelegate class which will be the main entry point for your application.
+
+```Ruby
+class AppDelegate
+  def main(argc, argv)
+    # your code
+  end
+end
+```
+
+You can pass arguments to your app when executing it on the command line. `argc` is an integer repesenting the number of arguments passed to your application, and `argv` is an array containing each of these arguments. Let's see an example:
+
+```Ruby
+class AppDelegate
+  def main(argc, argv)
+    puts "Number of arguments:"
+    p argc
+    puts "Arguments:"
+    p argv
+  end
+end
+```
+
+```
+$ /Users/me/Desktop/my-app hello world
+Number of arguments:
+3
+Arguments:
+["/Users/me/Desktop/my-app", "hello", "world"]
+```
+
+As you can see, even if we don't pass any arguments, the first argument will always be the full path of the file we're executing. This is a standard behaviour for any command line application.
+
+## Frameworks
+
+By default, your app will only require the `Foundation` framework, which is required by the Rubymotion runtime. If you want to include other frameworks you can do so in your Rakefile:
+
+```Ruby
+Motion::Project::App.setup do |app|
+  app.frameworks << 'AppKit'
+end
+```
+
+If you want to add some UI to your application, you will need to create a NSApplication:
+
+```Ruby
+class AppDelegate
+  def main(argc, argv)
+    app = NSApplication.sharedApplication
+    app.delegate = self
+    NSApp.run
+  end
+
+  def applicationDidFinishLaunching(notification)
+    # This will be executed after NSApp.run
+  end
+end
+```
+
+## Distribution
+
+When the Rubymotion toolchain builds your application, it will generate a .app file. However in the case of a command line application we are only interested in the executable. To retrieve it, right click in the .app file and click `Show Package Contents`. The executable will be located in a path similar to this, inside your `build` directory:
+
+    build/MacOSX-10.9-Release/my-app.app/Contents/MacOS/my-app
+
+You can now copy it somewhere else and execute it on your terminal.
+
+## Testing
+
+If your app does does not require require the AppKit framework and doesn't call `NSApp.run` at any point, `rake spec` will fail. Currently, Rubymotion's test framework expects a run loop to be created by a NSApplication.
+
+## TODO
+
+- Find a way to make tests work.
+- Create a Rubymotion template.
+- Patch the toolchain to only create the executable and not the .app
+
+## Thanks
+
+  Thanks to [Jack Chen](http://twitter.com/chendo) for his article [Building a Command Line OS X app with RubyMotion](http://chen.do/blog/2013/10/04/building-a-command-line-os-x-app-with-rubymotion/) which saved me a lot of detective work.
+
+## 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

data/lib/motion-osx-cli.rb

@@ -0,0 +1,21 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+require_relative 'project/motion-osx-cli'
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.frameworks = ['Foundation']
+
+  platform = app.respond_to?(:template) ? app.template : :ios
+  if platform != :osx
+    raise <<EOS
+motion-osx-cli helps you create command line apps for OSX and does not work on iOS.
+Make sure you are requiring the OSX template in your Rakefile:
+
+require 'motion/project/template/osx'
+
+EOS
+  end
+end

data/lib/project/motion-osx-cli.rb

@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (c) 2012, HipByte SPRL and contributors
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+module Motion; module Project;
+  class OSXConfig < XcodeConfig
+    def main_cpp_file_txt(spec_objs)
+      main_txt = ""
+      if frameworks.include?('AppKit')
+        main_txt << "#import <AppKit/AppKit.h>"
+      else
+        main_txt << "#import <Foundation/Foundation.h>"
+      end
+      main_txt << <<EOS
+
+
+extern "C" {
+    void rb_define_global_const(const char *, void *);
+    void rb_rb2oc_exc_handler(void);
+    void rb_exit(int);
+    void RubyMotionInit(int argc, char **argv);
+EOS
+      if spec_mode
+        spec_objs.each do |_, init_func|
+          main_txt << "void #{init_func}(void *, void *);\n"
+        end
+      end
+      main_txt << <<EOS
+}
+EOS
+      if spec_mode
+        main_txt << <<EOS
+@interface SpecLauncher : NSObject
+@end
+
+@implementation SpecLauncher
+
+- (void)runSpecs
+{
+EOS
+        spec_objs.each do |_, init_func|
+          main_txt << "#{init_func}(self, 0);\n"
+        end
+        main_txt << <<EOS
+        [NSClassFromString(@\"Bacon\") performSelector:@selector(run)];
+}
+
+- (void)appLaunched:(NSNotification *)notification
+{
+    [self runSpecs];
+}
+
+@end
+EOS
+      end
+
+      main_txt << <<EOS
+int
+main(int argc, char **argv)
+{
+    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+EOS
+    if ENV['ARR_CYCLES_DISABLE']
+      main_txt << <<EOS
+    setenv("ARR_CYCLES_DISABLE", "1", true);
+EOS
+    end
+    main_txt << <<EOS
+    RubyMotionInit(argc, argv);
+EOS
+    if spec_mode && frameworks.include?('AppKit')
+      main_txt << "SpecLauncher *specLauncher = [[SpecLauncher alloc] init];\n"
+      main_txt << "[[NSNotificationCenter defaultCenter] addObserver:specLauncher selector:@selector(appLaunched:) name:NSApplicationDidFinishLaunchingNotification object:nil];\n"
+    end
+    main_txt << <<EOS
+    NSMutableArray * arguments = [[NSMutableArray alloc] initWithCapacity: argc];
+    for (int i = 0; i < argc; i++)
+    {
+        [arguments addObject: [NSString stringWithUTF8String: argv[i]]];
+    }
+    [[NSClassFromString(@"#{delegate_class}") new] performSelector:NSSelectorFromString(@"main:") withObject:[NSNumber numberWithInt:argc] withObject:arguments];
+    [pool release];
+    rb_exit(0);
+    return 0;
+}
+EOS
+    end
+  end
+end; end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: motion-osx-cli
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Mark Villacampa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' Easily create command line utilities for OSX with Rubymotion '
+email:
+- m@markvillacampa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-osx-cli.rb
+- lib/project/motion-osx-cli.rb
+homepage: ''
+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.25
+signing_key: 
+specification_version: 3
+summary: Easily create command line utilities for OSX with Rubymotion
+test_files: []