monk-shake 1.0.0.pre1 → 1.0.0.pre2

data/CHANGELOG

@@ -0,0 +1,15 @@
+v1.0.0.pre2
+-----------
+
+ * `monk install` shows what gemset it's being installed to.
+
+ * `monk add` now will stop you if you try to update the default skeleton.
+
+ * `monk init` will use the same RVM Ruby version patch level if RVM is installed.
+
+ * `monk lock` will back up your old .gems file if needed.
+
+v1.0.0.pre1
+-----------
+
+ * Initial.

data/README.md

@@ -1,29 +1,49 @@
-Monk
-====
+Monk-shake
+==========
 
-A feature-complete rewrite of Monk that uses Shake instead of Thor.
-It is modeled after Monk 1.0 beta.
+#### Monk lets you build Sinatra applications quickly and painlessly by letting it set up the directory structure for you.
 
-See more info in [monkrb.com](http://www.morkrb.com).
+----
 
-**NOTE:** This is NOT an official replacement for Monk, nor is it
-supported or endorsed by Citrusbyte.
+Monk-shake is an UNOFFICIAL feature-complete rewrite of Monk that uses the
+lightweight and superfast [Shake](http://github.com/rstacruz/shake)
+instead of Thor. It is modeled after Monk 1.0 beta. See more info
+at [monkrb.com](http://www.morkrb.com).
 
-### What is it?
+**NOTE:** *This is NOT an official replacement for Monk, nor is it
+supported or endorsed by Citrusbyte.*
 
- * Monk lets you start a Sinatra project painlessly with everything set
-   up for you.
+## Get started
 
-### Get started
+You may need to uninstall the original monk gem. \*
 
-You may need to uninstall the original monk gem.
+    $ rvm @global             # TIP: Recommended for RVM users
+    $ gem uninstall monk
 
-   $ rvm @global             # TIP: Recommended for RVM users
-   $ gem uninstall monk
-   $ gem install monk-shake --pre
-   $ monk
+Install it:
 
-### Differences from the real Monk in general
+    $ gem install monk-shake --pre
+
+Try it out! This should help you get started:
+
+    $ monk
+
+Now create your first project:
+
+    $ monk init myproject
+
+You'll get a new directory called `myproject/`. Start hacking!
+Monk-shake provides the following commands while in your
+project folder:
+
+    $ cd myproject/
+    $ monk install        # Install needed gems
+    $ monk start          # Starts the server
+    $ monk irb            # Starts a console session
+
+*(\* = Alternatively, you can install monk-shake in a new RVM gemset instead. This means you will need to install it in your Monk-shake projects's gemsets too, however!)*
+
+## Differences from the official Monk
 
  * *No more Thor!* The new Monkfile has deprecated the old Thorfile.
    This version uses Shake instead.
@@ -57,3 +77,16 @@ You may need to uninstall the original monk gem.
  * `monk install` will first check if a gem is installed. It will not
    try to reinstall gems you already have.
 
+Authors
+=======
+
+Monk-shake is a derivative work by [Rico Sta. Cruz](http://www.ricostacruz.com),
+heavily based on the original implementations of [Monk](http://www.monkrb.com).
+
+Released under the MIT license.
+
+Monk (the original [1.0 beta](http://github.com/monk/monk) and 
+[0.x](https://github.com/monkrb/monk) implementations) is
+copyright (c) 2009 Michel Martens and Damian Janowski. All credit
+goes out to their (and contributors) hard work for the original idea,
+the API and the Monk skeletons.

data/lib/monk.rb

@@ -4,15 +4,19 @@ require 'fileutils'
 require 'shake'
 
 class Monk < Shake
-  VERSION = "1.0.0.pre1"
+  VERSION = "1.0.0.pre2"
   PREFIX  = File.expand_path('../monk', __FILE__)
 
   autoload :Helpers,      "#{PREFIX}/helpers"
   autoload :InitHelpers,  "#{PREFIX}/init_helpers"
+  autoload :RvmHelpers,   "#{PREFIX}/rvm_helpers"
+  autoload :FileHelpers,  "#{PREFIX}/file_helpers"
   autoload :Config,       "#{PREFIX}/config"
 
   extend Helpers
   extend InitHelpers
+  extend FileHelpers
+  extend RvmHelpers
 
   task(:init) do
     name   = params.extract('-s') || 'default'
@@ -36,8 +40,13 @@ class Monk < Shake
     in_path (target) {
       rm_rf '.git'
       touch 'Monkfile'
-      system_q "rvm #{RUBY_VERSION}@#{target} --rvmrc --create"  if rvm?
-      system_q "rvm rvmrc trust"  if rvm?
+      if rvm?
+        rvm "#{rvm_ruby_version}@#{target} --rvmrc --create", :output => true
+        rvm "rvmrc trust", :output => true
+      else
+        puts
+        puts "RVM not installed, skipping creating .rvmrc."
+      end
     }
 
     puts 
@@ -49,25 +58,23 @@ class Monk < Shake
     puts
 
     if rvm?
-      puts "An RVM gemset @#{target} has been created for you."
+      puts "The RVM gemset #{rvm_ruby_version}@#{target} has been created for you."
       puts
     end
   end
 
   task(:install) do
-    manifest = '.gems'
-
-    pass "This project does not have a .gems manifest."  unless File.exists?(manifest)
-
-    gems = File.read(manifest).split("\n")
+    pass "This project does not have a .gems manifest."  unless File.exists?('.gems')
 
-    gems.reject! { |name| name =~ /^\s*(#|$)/ }
+    gems = gems_from_manifest
     pass "The .gems manifest is empty."  unless gems.any?
 
     gems.reject! { |name| has_gem? name }
     pass "All good! You have all needed gems installed."  unless gems.any?
 
-    unless rvm?
+    if rvm?
+      say_status :info, "Installing to RVM gemset #{rvm_gemset}."
+    else
       err "Tip: RVM is a great way to manage gems across multiple projects."
       err "See http://rvm.beginrescueend.com for more info."
       err
@@ -78,20 +85,23 @@ class Monk < Shake
 
   task(:unpack) do
     ensure_rvm or pass
-    system "rvm rvmrc load"
-    system "rvm gemset unpack vendor"
+    rvm "rvmrc load"
+    rvm "gemset unpack vendor"
   end
 
   task(:lock) do
     ensure_rvm or pass
-    system "rvm rvmrc load"
-    system "rvm gemset export .gems"
+    backup_gems_file  if File.exists?('.gems')
+    rvm "rvmrc load"
+    rvm "gemset export .gems"
   end
 
   task(:add) do
     wrong_usage  unless params.size == 2
     name, repo = params
 
+    pass "You can't update the default skeleton."  if name == 'default'
+
     existed = !!config.skeletons[name]
 
     config.skeletons[name] = repo

data/lib/monk/file_helpers.rb

@@ -0,0 +1,28 @@
+module Monk::FileHelpers
+  # File helpers
+  def touch(target)
+    say_status :touch, target
+    FileUtils.touch target
+  end
+
+  def mkdir_p(target)
+    return  if File.directory?(target)
+    say_status :mkdir, target
+    FileUtils.mkdir_p target
+  end
+
+  def cp_r(from, target)
+    say_status :copy, "#{from} -> #{target}"
+    FileUtils.cp_r from, target
+  end
+
+  def mv(from, target)
+    say_status :move, "#{from} -> #{target}"
+    FileUtils.mv from, target
+  end
+
+  def rm_rf(target)
+    say_status :delete, target
+    FileUtils.rm_rf target
+  end
+end

data/lib/monk/helpers.rb

@@ -1,6 +1,3 @@
-# All these functions are available as Monk.xxxx.
-# (eg, Monk.tasks_for)
-#
 module Monk::Helpers
   def config
     @config ||= Monk::Config.load
@@ -14,15 +11,10 @@ module Monk::Helpers
     tasks.select { |name, t| t.category.nil? }
   end
 
-  def rvm?
-    @has_rvm = (!! `rvm` rescue false)  if @has_rvm.nil?
-    @has_rvm
-  end
-
-  def ensure_rvm
-    return true  if rvm?
-    err "You need RVM installed for this command."
-    err "See http://rvm.beginrescueend.com for more info."
+  # Reads the gems manifest file and returns the gems to be installed.
+  def gems_from_manifest(manifest='.gems')
+    gems = File.read(manifest).split("\n")
+    gems.reject { |name| name =~ /^\s*(#|$)/ }
   end
 
   # Checks if a certain gem is installed.
@@ -99,31 +91,13 @@ module Monk::Helpers
     `#{cmd}`
   end
 
-  def say_status(what, cmd)
-    c1 = "\033[0;33m"
-    c0 = "\033[0;m"
-    puts "#{c1}%10s#{c0}  %s" % [ what, cmd ]
-  end
-
-  # File helpers
-  def touch(target)
-    say_status :touch, target
-    FileUtils.touch target
+  def say_info(str)
+    say_status '*', str, 30
   end
 
-  def mkdir_p(target)
-    return  if File.directory?(target)
-    say_status :mkdir, target
-    FileUtils.mkdir_p target
-  end
-
-  def cp_r(from, target)
-    say_status :copy, "#{from} -> #{target}"
-    FileUtils.cp_r from, target
-  end
-
-  def rm_rf(target)
-    say_status :delete, target
-    FileUtils.rm_rf target
+  def say_status(what, cmd, color=32)
+    c1 = "\033[0;#{color}m"
+    c0 = "\033[0;m"
+    puts "#{c1}%10s#{c0}  %s" % [ what, cmd ]
   end
 end

data/lib/monk/init_helpers.rb

@@ -31,4 +31,12 @@ module Monk::InitHelpers
   def git_clone(repo, path)
     system "git clone --depth 1 #{repo} #{path}"
   end
+
+  def backup_gems_file(manifest='.gems')
+    if File.exists?(manifest)
+      time = File.mtime(manifest).strftime('%Y%m%d')
+      say_info "#{manifest} file exists; moving aside to preserve."
+      mv manifest, "#{manifest}.#{time}"
+    end
+  end
 end

data/lib/monk/rvm_helpers.rb

@@ -0,0 +1,26 @@
+module Monk::RvmHelpers
+  def rvm?
+    @has_rvm = (!! `rvm` rescue false)  if @has_rvm.nil?
+    @has_rvm
+  end
+
+  # Returns the name of the current RVM gemset.
+  def rvm_gemset
+    File.basename(`rvm current`.strip)
+  end
+
+  def rvm_ruby_version
+    rvm_gemset.split('@').first
+  end
+
+  def rvm(cmd, options={})
+    return `rvm #{cmd}`  if options[:output]
+    system "rvm #{cmd}"
+  end
+
+  def ensure_rvm
+    return true  if rvm?
+    err "You need RVM installed for this command."
+    err "See http://rvm.beginrescueend.com for more info."
+  end
+end

data/test/init_test.rb

@@ -59,5 +59,19 @@ scope do
     assert cerr.include?('No such skeleton')
   end
 
+  test 'no rvm' do
+    monk 'init x'
+    assert cout.include?("skipping creating .rvmrc")
+    assert rvm_commands.empty?
+  end
+
+  test 'with rvm' do
+    $has_rvm = true
+    monk 'init x'
+    assert !cout.include?("skipping creating .rvmrc")
+    assert rvm_commands.to_s.include?('--rvmrc')
+    assert rvm_commands.to_s.include?('rvmrc trust')
+  end
+
   # TODO: git fail test
 end

data/test/lock_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../test_helper', __FILE__)
+
+scope do
+  test 'lock' do
+    monk 'lock'
+    assert cerr.include?('You need RVM')
+  end
+
+  scope do
+    prepare do
+      $has_rvm = true
+    end
+
+    test 'lock rvm' do
+      monk 'lock'
+      assert rvm_commands.include?('gemset export .gems')
+    end
+
+    test 'backup gems' do
+      FileUtils.touch '.gems'
+      monk 'lock'
+      assert cout.include?('moving aside to preserve')
+      assert Dir['.gems.*'].any?
+      assert rvm_commands.include?('gemset export .gems')
+    end
+  end
+end

data/test/mock.rb

@@ -25,6 +25,16 @@ module Monk::InitHelpers
   end
 end
 
+module Monk::RvmHelpers
+  def rvm?
+    $has_rvm
+  end
+
+  def rvm(cmd, options={})
+    $rvm << cmd
+  end
+end
+
 # Config will never load the config file
 class Monk::Config
   def self.load

data/test/test_helper.rb

@@ -10,6 +10,7 @@ require File.expand_path('../mock', __FILE__)
 def monk(cmd)
   $out = ''
   $err = ''
+  $rvm = Array.new
 
   Monk.load_monkfile
   Monk.run *Shellwords.shellsplit(cmd)
@@ -23,6 +24,10 @@ def cerr
   $err
 end
 
+def rvm_commands
+  $rvm
+end
+
 def assert_invalid
   assert cout.empty?
   assert cerr.include?('Invalid usage')
@@ -45,4 +50,5 @@ prepare do
   Dir.chdir tmp_path
   Monk.instance_variable_set :@config, nil
   FileUtils.rm_rf 'Monkfile'
+  $has_rvm = false
 end

metadata

@@ -2,7 +2,7 @@
 name: monk-shake
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 1.0.0.pre1
+  version: 1.0.0.pre2
 platform: ruby
 authors: 
 - Rico Sta. Cruz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +08:00
+date: 2011-02-16 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,15 +36,23 @@ extra_rdoc_files: []
 files: 
 - bin/monk
 - lib/monk/config.rb
+- lib/monk/file_helpers.rb
 - lib/monk/helpers.rb
 - lib/monk/init_helpers.rb
+- lib/monk/rvm_helpers.rb
 - lib/monk.rb
 - test/add_test.rb
 - test/help_test.rb
 - test/init_test.rb
+- test/lock_test.rb
 - test/mock.rb
 - test/test_helper.rb
+- test/tmp/default/init.rb
+- test/tmp/default/Monkfile
+- test/tmp/x/init.rb
+- test/tmp/x/Monkfile
 - README.md
+- CHANGELOG
 has_rdoc: true
 homepage: http://www.github.com/rstacruz/monk-shake
 licenses: []