rvmbs 0.0.2 → 0.0.3

data/CHANGELOG.markdown

@@ -1,4 +1,10 @@
-## 0.0.2 (April 24, 2012)
+## 0.0.3 (March, 4, 2012)
+
+Features:
+
+  - Some internals improvements and better doc (man page)
+
+## 0.0.2 (February, 24, 2012)
 
 Features:
 

data/Gemfile.lock

@@ -1,14 +1,24 @@
 PATH
   remote: .
   specs:
-    rvmbs (0.0.1)
+    rvmbs (0.0.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    gem-man (0.3.0)
+    hpricot (0.8.6)
+    mustache (0.99.4)
+    rdiscount (1.6.8)
+    ronn (0.7.3)
+      hpricot (>= 0.8.2)
+      mustache (>= 0.7.0)
+      rdiscount (>= 1.5.8)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  gem-man
+  ronn
   rvmbs!

data/README.markdown

@@ -3,6 +3,12 @@ RVM Bootstrap
 
 Command to create a directory project with a configured .rvmrc into.
 
+Requirements
+------------
+
+Just RVM installed.
+
+
 Installation
 -----------
 
@@ -17,13 +23,13 @@ Generates a my_project directory with a trusted .rvmrc file contains:
     
     rvm use --create 1.9.2@my_project
   
-Run `rvmbs --help` for more options.
+Run `rvmbs --help` or `gem man rvmbs` for more options.
 
 To Do
 -----
 
 * Add tests. 
-* Bundler integration. 
+* Bundler integration.
 
 Copyright
 ---------

data/lib/rvmbs.rb

@@ -13,26 +13,34 @@ module RVMBS
 
       optparse = OptionParser.new do |opts|
         optsp = opts
-        opts.banner = "Usage: rvmbs [options] PROJECT_NAME"
+        opts.banner = "RVM Bootstrap - Command to create a project directory with a configured .rvmrc into.
+
+Usage: rvmbs -d PROJECT_NAME [options]"
         
         # This define the directory name.
         opts.on('-d', '--directory NAME', "The name of the project's directory.") do |name|
           options[:directory] = name
         end
          
-        # This define the ruby interpreter.
-        options[:ruby] = '1.9.2'
-        opts.on('-r', '--ruby-implementation NAME', "The name of the Ruby implementation.") do |name|
-          options[:ruby] = name
+        # This define the ruby implementation.
+        options[:implementation] = '1.9.2'
+        opts.on('-i', '--ruby-implementation NAME', "The name of the Ruby implementation.") do |name|
+          options[:implementation] = name
         end
 
-        # This define the ruby interpreter.
+        # This force to delete de directory if already exists. 
         options[:force] = false
         opts.on('-f', '--force', "Delete directory if already exists.") do 
           options[:force] = true
         end
 
-       # This will print an options summary.
+        # Verbose mode 
+        options[:verbose] = false
+        opts.on('-v', '--verbose', "Print extra info.") do 
+          options[:verbose] = true
+        end
+
+        # This will print an options summary.
         opts.on_tail("-h", "--help", "Show this message.") do
           puts opts
           exit
@@ -42,17 +50,18 @@ module RVMBS
       
       # Directory must be set.
       if options[:directory] == nil
-        puts optsp
+        puts optsp 
         exit
+      else
+        create_directory(options)
+        create_rvmrc(options)
+        set_rvmrc_trusted(options, Dir.pwd)
       end
-
-      create_directory(options)
-      create_rvmrc(options)
-      set_rvmrc_trusted(options, Dir.pwd)
     end
 
     # Creates the directory.
     def self.create_directory(options)
+      puts "Making new directory: #{options[:directory]}" if options[:verbose]
       begin
         Dir.mkdir options[:directory]
       rescue 
@@ -67,17 +76,29 @@ module RVMBS
   
     # Creates the .rvmrc file.
     def self.create_rvmrc(options)  
-      Dir.chdir(options[:directory])
+      puts "Creating rvmrc file" if options[:verbose]
+      Dir.chdir(options[:directory]) 
       File.open(".rvmrc", "w") do |f|
-        f.write("rvm use --create #{options[:ruby]}@#{options[:directory]}\n")
+        f.write("rvm use --create #{options[:implementation]}@#{options[:directory]}\n")
       end
-      Dir.chdir('..')
+      Dir.chdir('..') 
     end
 
     # Run rvm rvmrc trust command detached from console.
     def self.set_rvmrc_trusted(options, current_dir)
-      current_dir = 
-      pid = fork do
+      puts "Setting rvmrc file to trusted" if options[:verbose]
+      pid = daemonize do 
+        current_dir = current_dir + "/" + options[:directory] 
+        exit system "rvm rvmrc trust #{current_dir}/"
+      end
+      _, status = Process.waitpid2(pid)
+      puts "ERROR: rvm rvmrc trust command fail!" if status != 0
+    end
+    
+    private 
+
+    def self.daemonize
+       pid = fork do
         if RUBY_VERSION < "1.9"
           exit if fork
           Process.setsid
@@ -89,10 +110,8 @@ module RVMBS
         else
           Process.daemon
         end
-        exit system "rvm rvmrc trust #{current_dir}/#{options[:directory]}/"
+        yield
       end
-      _, status = Process.waitpid2(pid)
-      puts "ERROR: rvm rvmrc trust command fail!" if status != 0
     end
 
   end

data/lib/rvmbs/version.rb

@@ -1,3 +1,3 @@
 module RVMBS
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/man/rvmbs.1

@@ -0,0 +1,41 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "RVMBS" "1" "March 2012" "" ""
+.
+.SH "NAME"
+\fBrvmbs\fR \- RVM Bootstrap \- Command to create a project directory with a configured \.rvmrc into\.
+.
+.SH "SYNOPSIS"
+\fBrmvbs\fR \fB\-d\fR|\fB\-\-directory\fR \fIdirectory_name\fR \fB\-i\fR|\fB\-\-implementation\fR \fIruby_implementation\fR \fB\-f\fR|\fB\-\-force\fR \fB\-v\fR|\fB\-\-verbose\fR
+.
+.SH "DESCRIPTION"
+\fBrvmbs\fR is a simple command\-line tool for creating ruby project directorys with a basic rvm configuration\. By default (without any parameters) create and \.rvmrc file in the current directory with the 1\.9\.2 implementationr and a gemset named equal to de current directory name\. The \.rvmrc file is also trusted\.
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-d\fR, \fB\-\-directory\fR Directory name of the project\.
+.
+.IP "\(bu" 4
+\fB\-i\fR, \fB\-\-implementation\fR The ruby implementation name, e\.g\., 1\.9\.2, jruby
+.
+.IP "\(bu" 4
+\fB\-f\fR, \fB\-\-force\fR Delete directory if already exist\.
+.
+.IP "\(bu" 4
+\fB\-v\fR, \fB\-\-verbose\fR Prints extra info\.
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+Create a directory \'hello_world\' and a gemset named \'hello_world\' with implementation MRI 1\.9\.2 (default)
+.
+.P
+$ rvmbs \-d hello_world
+.
+.P
+Create a directory \'dog\' and a gemset named \'dog\' with implementation jruby
+.
+.P
+$ rvmbs \-d dog \-i jruby

data/man/rvmbs.1.html

@@ -0,0 +1,118 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>rvmbs(1) - RVM Bootstrap - Command to create a project directory with a configured .rvmrc into.</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#EXAMPLES">EXAMPLES</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>rvmbs(1)</li>
+    <li class='tc'></li>
+    <li class='tr'>rvmbs(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>rvmbs</code> - <span class="man-whatis">RVM Bootstrap - Command to create a project directory with a configured .rvmrc into.</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>rmvbs</code> <code>-d</code>|<code>--directory</code> <var>directory_name</var> <code>-i</code>|<code>--implementation</code> <var>ruby_implementation</var>  <code>-f</code>|<code>--force</code> <code>-v</code>|<code>--verbose</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p><strong>rvmbs</strong> is a simple command-line tool for creating ruby project directorys
+with a basic rvm configuration. By default (without any parameters) create
+and .rvmrc file in the current directory with the 1.9.2 implementationr and a
+gemset named equal to de current directory name. The .rvmrc file is also trusted.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<ul>
+<li><p><code>-d</code>, <code>--directory</code>
+Directory name of the project.</p></li>
+<li><p><code>-i</code>, <code>--implementation</code>
+The ruby implementation name, e.g., 1.9.2, jruby</p></li>
+<li><p><code>-f</code>, <code>--force</code>
+Delete directory if already exist.</p></li>
+<li><p><code>-v</code>, <code>--verbose</code>
+Prints extra info.</p></li>
+</ul>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Create a directory 'hello_world' and a gemset named 'hello_world' with implementation MRI 1.9.2 (default)</p>
+
+<p>  $ rvmbs -d hello_world</p>
+
+<p>Create a directory 'dog' and a gemset named 'dog' with implementation jruby</p>
+
+<p>  $ rvmbs -d dog -i jruby</p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'></li>
+    <li class='tc'>March 2012</li>
+    <li class='tr'>rvmbs(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>

data/man/rvmbs.1.ronn

@@ -0,0 +1,38 @@
+rvmbs(1) -- RVM Bootstrap - Command to create a project directory with a configured .rvmrc into.
+================================================================================================
+
+## SYNOPSIS
+
+`rmvbs` `-d`|`--directory` <directory_name> `-i`|`--implementation` <ruby_implementation>  `-f`|`--force` `-v`|`--verbose`
+
+## DESCRIPTION
+
+**rvmbs** is a simple command-line tool for creating ruby project directorys 
+with a basic rvm configuration. By default (without any parameters) create
+and .rvmrc file in the current directory with the 1.9.2 implementationr and a
+gemset named equal to de current directory name. The .rvmrc file is also trusted.
+
+## OPTIONS
+
+* `-d`, `--directory` 
+  Directory name of the project.
+
+* `-i`, `--implementation`
+  The ruby implementation name, e.g., 1.9.2, jruby
+
+* `-f`, `--force`
+  Delete directory if already exist.
+
+* `-v`, `--verbose`
+  Prints extra info.
+
+## EXAMPLES
+
+Create a directory 'hello_world' and a gemset named 'hello_world' with implementation MRI 1.9.2 (default)
+  
+  $ rvmbs -d hello_world
+
+Create a directory 'dog' and a gemset named 'dog' with implementation jruby
+
+  $ rvmbs -d dog -i jruby
+

data/rvmbs.gemspec

@@ -9,14 +9,15 @@ Gem::Specification.new do |s|
   s.email       = ["jolisper@gmail.com"]
   s.homepage    = "http://github.com/jolisper/rvmbs"
   s.summary     = %q{RVM Bootstrap}
-  s.description = %q{Command to create a project directory with a configured .rvmrc into.}
+  s.description = %q{RVM Bootstrap - Command to create a project directory with a configured .rvmrc into.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  # Development dependencies: 
+  s.add_development_dependency "gem-man"
+  s.add_development_dependency "ronn"
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rvmbs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,32 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000Z
-dependencies: []
-description: Command to create a project directory with a configured .rvmrc into.
+date: 2012-03-05 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem-man
+  requirement: &21910480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21910480
+- !ruby/object:Gem::Dependency
+  name: ronn
+  requirement: &21910060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21910060
+description: RVM Bootstrap - Command to create a project directory with a configured
+  .rvmrc into.
 email:
 - jolisper@gmail.com
 executables:
@@ -30,6 +53,9 @@ files:
 - bin/rvmbs
 - lib/rvmbs.rb
 - lib/rvmbs/version.rb
+- man/rvmbs.1
+- man/rvmbs.1.html
+- man/rvmbs.1.ronn
 - rvmbs.gemspec
 homepage: http://github.com/jolisper/rvmbs
 licenses: []