traveler 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1ff89c249a9f86cae865f07b82adc05657b2a6e
-  data.tar.gz: ca6421f494b18df1f79e59765b1ef1c34e568496
+  metadata.gz: 71940c2f9e8689c2b08a8aa506f0582094179c22
+  data.tar.gz: 71c6d37800b031616d49097a1e3b38f5bccb74c5
 SHA512:
-  metadata.gz: c9bfac3282c9170bbebcbb0a122bff6735a2ce60f16d7b8545dc58e9cb9fcf9a7e2d491f24d7200cd1f2707b7d43ab208c526e6f465db25731da7c6caa0cf112
-  data.tar.gz: 1b90291047bfc8691a9e34ae715ece6b05d5436007f67320af30c000a3674bb7bbf271aca47b0da945e700ac64dd257de5b58e4c278a7b6e534db7cf813db694
+  metadata.gz: ae010579d972b51a4c08b61fdd0ec9ae67185b2c26aa2e724bf11bab1c62614a798be2d076a27c3f73c6df473780826ef4df02e1c58a04ec76372793fdc98299
+  data.tar.gz: 26cedddaf7eb74282b923d9df6ab6cb107f7885b1c6a90fd2d2aacd609e42c5f88692ed9be136887fb5582a0e1fc3db338cc05b2ca1fb2a4d8dc31f15909ffa7

data/README.md

@@ -1,8 +1,7 @@
 
-# Traveler
-**A nifty wrapper for Traveling Ruby**
+## Traveler
 
-Easily distribute your Ruby app to any Linux and/or OS X.
+**Easily distribute your Ruby apps to any Linux and/or OS X.**
 
 Traveler is about doing all hard work on packaging your Ruby apps into self-running containers using [Traveling Ruby](http://phusion.github.io/traveling-ruby/).
 
@@ -11,7 +10,7 @@ Here are some [introductory materials](https://github.com/phusion/traveling-ruby
 
 **Ok, what do i need to use Traveler?**
 
-You'll need Ruby 2.1.x or 2.2.x installed on your system.
+You'll need Ruby 2.1.x or 2.2.x on a Linux or OS X machine ([no windows support for now](https://github.com/sleewoo/traveler/issues/2)).
 
 Why so?
 
@@ -29,14 +28,14 @@ make sure to run `rbenv rehash` is you are using rbenv.
 
 ## Use
 
-Traveler acts inside your app folder. It creates a `Travelfile` file and the `traveler` folder(name is configurable).
+Traveler acts inside your app folder. It creates a `Travelfile` file and the `traveler` folder.
 
 `Travelfile` is a Ruby file containing few configurations:
 
-    - `platforms`:  specify what platforms your app should run on
-    - `wrapper`: define wrapper(s) that will allow to easily run your app
-    - `folder_name`: name of the folder that will hold the builds
-    - `traveling_ruby_version`: what version of Traveling Ruby to be used for builds
+- `platforms`  specify what platforms your app should run on
+- `wrapper` [define wrapper(s)](https://github.com/sleewoo/traveler/blob/master/skel/Travelfile#L12) that will allow to easily run your app
+- `folder_name` name of the folder that will hold the builds (`traveler` by default)
+- `traveling_ruby_version` what version of Traveling Ruby to be used for builds
 
 And that's pretty all about configuration.
 
@@ -71,11 +70,23 @@ So you can have multiple Ruby versions with same app.
 
 To make use of them simply define multiple wrappers, each using a specific Ruby version.
 
+
+## Rewrapping
+
+Sometimes you need to rebuild wrappers without actually rebuild the runtime/gems.
+
+For this simply run:
+
+`traveler wrap`
+
+It will reread your wrappers in Travelfile and rebuild them accordingly.
+
+
 ## Contributors are highly welcome!
 
 Would love to have some help with testing.
 
-1. Fork it ( https://github.com/[my-github-username]/traveler/fork )
+1. Fork it ( https://github.com/sleewoo/traveler/fork )
 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`)

data/lib/traveler/cli.rb

@@ -13,12 +13,19 @@ module Traveler
 
     desc 'build', "Build runtime for platforms specified in #{CONFIGFILE}"
     def build
-      require 'traveler/build'
+      load_configs
       build_world
       generate_wrappers
       puts '', bold_success(SUCCESS_ICONS.sample, '  All Done! You are ready to rock!')
     end
 
+    desc 'wrap', 'Only (re)build wrappers without '
+    def wrap
+      load_configs
+      generate_wrappers
+      puts bold_success(SUCCESS_ICONS.sample, '  Done!')
+    end
+
     private
     def build_world
       FileUtils.mkdir_p(Traveler.rubydir)
@@ -38,11 +45,12 @@ module Traveler
     end
 
     def generate_wrappers
-      return if WRAPPERS.empty?
+      return puts('', warn("  No wrappers defined in #{CONFIGFILE}"), '') if WRAPPERS.empty?
       puts '', warn(:wrapping.icon, '  Wrapping...')
       Dir.chdir Traveler.appdir do
-        WRAPPERS.each_pair do |name,(cmd_or_file,ruby_version)|
-          Wrapper.new(name, cmd_or_file, ruby_version)
+        WRAPPERS.each_pair do |name,(ruby_version,cmd_or_file,block)|
+          puts warn('   (re)building "%s" wrapper...' % name)
+          Wrapper.new(ruby_version, name, cmd_or_file, block)
         end
       end
     end
@@ -74,6 +82,10 @@ module Traveler
     def configfile_exists?
       File.exists?(CONFIGFILE_PATH)
     end
+
+    def load_configs
+      require 'traveler/config'
+    end
   end
 end
 Traveler::CLI.start(ARGV)

data/lib/traveler/config.rb

@@ -28,9 +28,9 @@ module Traveler
       OPTED_PLATFORMS.concat(platforms)
     end
 
-    def wrapper name, ruby_version, cmd_or_file
+    def wrapper name, ruby_version, cmd = nil, &block
       assert_ruby_version_supported!(ruby_version, caller[0])
-      WRAPPERS[name.to_s.freeze] = [cmd_or_file, ruby_version].map(&:to_s)
+      WRAPPERS[name.to_s.freeze] = [ruby_version.to_s.freeze, cmd.to_s.freeze, block].freeze
     end
 
     def traveling_ruby_version version
@@ -43,3 +43,9 @@ module Traveler
     end
   end
 end
+
+require 'traveler/prerequisites'
+require 'traveler/runtime'
+require 'traveler/bundler'
+require 'traveler/gem'
+require 'traveler/wrapper'

data/lib/traveler/wrapper.rb

@@ -2,43 +2,58 @@ module Traveler
   class Wrapper
     include Util
 
-    def initialize file, cmd_or_file, ruby_version
-      @file, @cmd_or_file, @ruby_version = file, cmd_or_file, ruby_version
+    def initialize ruby_version, name, cmd, block
+      @ruby_version, @name, @cmd, @block = ruby_version, name, cmd, block
       write if writeable?
     end
 
     def write
-      File.open(@file, 'w') {|f| f << render}
-      FileUtils.chmod('+x', @file)
+      File.open(file, 'w') {|f| f << render_wrapper}
+      FileUtils.chmod('+x', file)
     end
 
     def writeable?
-      if File.exists?(@file) && File.read(@file) !~ /#{SIGNATURE}/m
+      if File.exists?(file) && File.read(file) !~ /#{SIGNATURE}/m
         puts warn('
-          "%s" file exists and is not a Traveler wrapper.
-          If you still want to use it as a Traveler wrapper
-          please delete it and rerun `traveler`' % @file, '')
+        "%s" file exists and is not a Traveler wrapper.
+        Use another file or delete/rename this one and (re)run `traveler wrap`' % file)
         return false
       end
       true
     end
 
-    def wrapper
-      File.read(skeldir('wrapper.sh'))
-    end
-
     def locals
       {
-        signature: SIGNATURE,
-        folder_name: FOLDER_NAME,
+        signature:              SIGNATURE,
+        folder_name:            FOLDER_NAME,
         traveling_ruby_version: TRAVELING_RUBY_VERSION,
-        wrapper_ruby_version: @ruby_version,
-        cmd_or_file: @cmd_or_file
+        wrapper_ruby_version:   @ruby_version
       }
     end
 
-    def render
-      Mustache.render(wrapper, locals)
+    def cmd
+      return @block.call if @block
+      render_cmd(@cmd)
+    end
+
+    def render_wrapper
+      Mustache.render(wrapper_template, locals.merge(cmd: cmd))
+    end
+
+    def render_cmd cmd
+      Mustache.render(cmd_template, locals.merge(cmd: cmd))
+    end
+
+    def wrapper_template
+      File.read(skeldir('wrapper.sh'))
+    end
+
+    def cmd_template
+      File.read(skeldir('cmd.sh'))
+    end
+
+    def file
+      @name
     end
   end
 end

data/skel/Travelfile

@@ -18,7 +18,20 @@ platforms 'linux-x86_64'
 #
 # 3) third argument will be used to run your program.
 #    it can be a command or a file and will be used like:
-#    /path/to/ruby -r bundler/setup  your-file-or-command
+#    `exec /path/to/ruby -r bundler/setup  your-file-or-command`
+#    However this can be omitted if providing a block.
+#
+# 4)  A optional block.
+#     If given, returned string will be used as a un-prefixed cmd.
+#     Useful when you need full control over cmd to run.
+#     Will run like:
+#     `exec your-command-here`
+#
+# @note:  use $RUBY_ROOT to refer to the Ruby installation folder,
+#         e.g. '$RUBY_ROOT/bin/bundler'
+#         IMPORTANT: make sure to use it inside single quotes - '$RUBY_ROOT'
+#         or escape it if using inside double quotes - "\$RUBY_ROOT"
+#         Otherwise it will refer to a Ruby global variable and make your wrapper unusable.
 #
 # @note: MULTIPLE wrappers can be defined each using a specific Ruby version
 #
@@ -27,14 +40,20 @@ platforms 'linux-x86_64'
 # @note: you can comment this option if you do not need any wrappers
 #
 # @example  create "run" file that will execute "app.rb" on Ruby 2.1.5
+#           will run like:
+#           `exec "$RUBY_ROOT/bin/ruby" -r bundler/setup app.rb`
+#
 #   wrapper :run, '2.1.5', 'app.rb'
 #
 # @example  create "run" file that will run `puma` on Ruby 2.2.0
-#   wrapper :run, '2.2.0', 'puma'
+#
+#   wrapper :run, '2.2.0' do
+#     "\$RUBY_ROOT/bin/bundler exec puma"
+#   end
 #
 # @example  create two wrappers, one running on Ruby 2.2.0 and another on 2.1.5
-#   wrapper :run22, '2.2.0', 'puma'
-#   wrapper :run21, '2.1.5', 'puma'
+#   wrapper :run22, '2.2.0', 'config.ru'
+#   wrapper :run21, '2.1.5', 'config.ru'
 #
 wrapper :run, '2.1.5', 'your command or file here'
 

data/skel/cmd.sh

@@ -0,0 +1 @@
+exec "$RUBY_ROOT/bin/ruby" -r bundler/setup {{{cmd}}}

data/skel/wrapper.sh

@@ -4,14 +4,15 @@ set -e
 cd "$(cd $(dirname "$0") && pwd)"
 
 if [[ `uname -s` =~ inux ]]; then
-  TRAVELING_RUBY_PLATFORM="linux-$(uname -m)"
+  arch="linux-$(uname -m)"
 else
-  TRAVELING_RUBY_PLATFORM="osx"
+  arch="osx"
 fi
 
-TRAVELING_RUBY_ROOT="{{folder_name}}/traveling-ruby-{{traveling_ruby_version}}-{{wrapper_ruby_version}}-$TRAVELING_RUBY_PLATFORM/"
-
-export BUNDLE_GEMFILE="$TRAVELING_RUBY_ROOT/vendor/Gemfile"
 unset  BUNDLE_IGNORE_CONFIG
 
-exec "$TRAVELING_RUBY_ROOT/bin/ruby" -r bundler/setup {{cmd_or_file}}
+export RUBY_VERSION="{{wrapper_ruby_version}}"
+export RUBY_ROOT="{{folder_name}}/traveling-ruby-{{traveling_ruby_version}}-$RUBY_VERSION-$arch/"
+export BUNDLE_GEMFILE="$RUBY_ROOT/vendor/Gemfile"
+
+{{{cmd}}}

data/traveler.gemspec

@@ -1,12 +1,12 @@
 # coding: utf-8
 
-name, version = 'traveler 0.0.1'.split
+name, version = 'traveler 0.1.0'.split
 Gem::Specification.new do |spec|
   spec.name          = name
   spec.version       = version
   spec.authors       = ['Slee Woo']
   spec.email         = ['mail@sleewoo.com']
-  spec.description   = 'A nifty wrapper for Traveling Ruby'
+  spec.description   = 'Easily embrace Traveling Ruby awesomeness'
   spec.summary       = [name, version]*'-'
   spec.homepage      = 'https://github.com/sleewoo/' + name
   spec.license       = 'MIT'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: traveler
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Slee Woo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: A nifty wrapper for Traveling Ruby
+description: Easily embrace Traveling Ruby awesomeness
 email:
 - mail@sleewoo.com
 executables:
@@ -81,7 +81,6 @@ files:
 - Rakefile
 - bin/traveler
 - lib/traveler.rb
-- lib/traveler/build.rb
 - lib/traveler/bundler.rb
 - lib/traveler/cli.rb
 - lib/traveler/config.rb
@@ -94,6 +93,7 @@ files:
 - skel/Gemfile
 - skel/Travelfile
 - skel/bundle.config
+- skel/cmd.sh
 - skel/wrapper.sh
 - traveler.gemspec
 homepage: https://github.com/sleewoo/traveler
@@ -119,6 +119,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: traveler-0.0.1
+summary: traveler-0.1.0
 test_files: []
 has_rdoc: 

data/lib/traveler/build.rb

@@ -1,6 +0,0 @@
-require 'traveler/config'
-require 'traveler/prerequisites'
-require 'traveler/runtime'
-require 'traveler/bundler'
-require 'traveler/gem'
-require 'traveler/wrapper'