redrum 0.1.0 → 0.2.0

data/bin/redrum

@@ -1,2 +1,4 @@
 #!/usr/bin/env ruby
+require File.expand_path("../../lib/redrum", __FILE__)
 
+Redrum.start

data/features/command_line_interface.feature

@@ -0,0 +1,15 @@
+Feature: Command Line Interface
+  In order to use redrum from the command line
+  As a web designer
+  I want to be able to use redrum from the command line and have a little help there
+
+  Scenario: Starting redrum to create a project called MyBlog
+    Given there is no directory already existing at "MyBlog"
+    When I start redrum with "MyBlog"
+    Then I want to get a skeleton project at "MyBlog"
+    And I want to see what is beeing created from the command line
+
+  Scenario: Starting redrum with the -h or --help option
+    When I start redrum with "-h" or "--help"
+    Then I should be informed about its usage
+    And I should be informed about any options avaliable

data/lib/redrum.rb

@@ -3,3 +3,5 @@
 
 require File.expand_path("../redrum/skeleton", __FILE__)
 require File.expand_path("../redrum/redrum", __FILE__)
+require File.expand_path("../redrum/cli", __FILE__)
+

data/lib/redrum/cli.rb

@@ -0,0 +1,33 @@
+require "optparse"
+
+module Redrum
+  class CLI
+    def initialize(project, params={})
+      params = {:output_to => STDOUT}.merge params
+      @skeleton = Skeleton.new(project, params)
+    rescue Errno::EEXIST => e
+      params[:output_to].puts e.to_s
+    end
+
+    def self.parse(out=STDOUT)
+        options = {}
+        opt = OptionParser.new do |opts|
+          opts.banner = "Usage: redrum project_name [options]"
+          opts.on("-h", "--help", "You are reading it right now") do
+            out.puts opts
+            return false
+          end
+          opts.on_tail do
+            out.puts opts
+          end
+        end
+
+        opt.parse!
+        options
+      rescue OptionParser::InvalidOption => e
+        out.puts e.to_s
+        out.puts opt.to_s
+        false
+    end
+  end
+end

data/lib/redrum/redrum.rb

@@ -8,4 +8,14 @@ module Redrum
   def self.folder_structure
     FOLDER_STRUCTURE
   end
+
+  def self.start(out=STDOUT)
+    project = ARGV[0]
+    if (ARGV.size == 1) and (ARGV[0] =~ /^[^-].+/)
+      Redrum::CLI.new(project, :output_to => out) if project
+    elsif options = Redrum::CLI.parse(out)
+      options = { :output_to => out }.merge options
+      Redrum::CLI.new(project, options) if project
+    end
+  end
 end

data/lib/redrum/skeleton.rb

@@ -1,9 +1,12 @@
 module Redrum
   class Skeleton
-    def initialize(project_dir)
+    def initialize(project_dir, params={})
       Dir.mkdir(project_dir)
+      params[:output_to].puts "Creating " + project_dir if params[:output_to]
       FOLDER_STRUCTURE.each do |dir|
-        Dir.mkdir(project_dir + "/" + dir)
+        new_folder = project_dir + "/" + dir
+        Dir.mkdir(new_folder)
+        params[:output_to].puts "Creating " + new_folder if params[:output_to]
       end
     end
   end

data/spec/redrum/cli_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe Redrum::CLI do
+  describe "#new" do
+    it "creates a new Redrum::Skeleton instance" do
+      Redrum::Skeleton.should_receive(:new).with("temp", {:output_to => STDOUT})
+      Redrum::CLI.new("temp")
+    end
+
+    it "catches an error raised by Redrum::Skeleton.new if a directory already exists" do
+      messenger = StringIO.new
+      Redrum::CLI.new("temp", :output_to => messenger)
+      messenger.should_receive(:puts).with("File exists - temp")
+      Redrum::CLI.new("temp", :output_to => messenger)
+    end
+  end
+
+  describe "#self.parse" do
+    before do
+      no_warnings { ARGV = [] }
+      @messenger = StringIO.new
+    end
+
+    context "with valid parameters in ARGV" do
+      it "returns a hash with the options" do
+        no_warnings { ARGV = ["hmm"] }
+        Redrum::CLI.parse(@messenger).should be_kind_of(Hash)
+      end
+    end
+
+    context "with invalid parameters in ARGV" do
+      before do
+        no_warnings { ARGV = ["temp", "--crap"] }
+      end
+
+      it "shows an error message" do
+        Redrum::CLI.parse(@messenger)
+        @messenger.string.should include('invalid option: --crap')
+      end
+
+      it "shows the help text" do
+        Redrum::CLI.parse(@messenger)
+        @messenger.string.should include("Usage: redrum project_name [options]")
+      end
+    end
+
+    context "with no parameters" do
+      it "shows the help page" do
+        Redrum::CLI.parse(@messenger)
+        @messenger.string.should include("Usage: redrum project_name [options]")
+      end
+    end
+
+    context "with -h, --help" do
+      before { no_warnings { ARGV = ["-h"] } }
+
+      it "returns false" do
+        Redrum::CLI.parse(@messenger).should == false
+      end
+
+      it "shows the help text" do
+        Redrum::CLI.parse(@messenger)
+        @messenger.string.should include("Usage: redrum project_name [options]")
+      end
+    end
+
+  end
+end

data/spec/redrum/redrum_spec.rb

@@ -1,7 +1,11 @@
 require File.expand_path("../../spec_helper", __FILE__)
 
 describe Redrum do
-  before { @target = "temp" }
+  before do
+    @target = "temp" 
+    ARGV.stub(:[]) { @target }
+    @messenger = StringIO.new
+  end
 
   describe "#self.make" do
     it "wraps the Redrum::Skeleton.new call" do
@@ -16,4 +20,32 @@ describe Redrum do
       Redrum.folder_structure.should include("public", "haml", "public/css")
     end
   end
+
+  describe "#self.start" do
+    before { Dir.stub(:mkdir) }
+
+    it "wraps Redrum::CLI.new" do
+      Redrum::CLI.should_receive(:new)
+      Redrum.start(@messenger)
+    end
+
+    it "calls Redrum::CLI.parse when there seem to be parameters to parse" do
+      Redrum::CLI.should_receive(:parse)
+      Redrum::CLI.stub(:new)
+      Redrum.start(@messenger)
+    end
+
+    it "does not show the help page when a project name is defined without parameters" do
+      no_warnings { ARGV = [ @target ] }
+      Redrum.start(@messenger)
+      @messenger.string.should include("Creating #{@target}")
+      @messenger.string.should_not include("Usage: redrum project_name")
+    end
+
+    it "does not call Redrum::CLI.new if no project name was given" do
+      ARGV.stub(:[]) { }
+      Redrum::CLI.should_not_receive(:new)
+      Redrum.start(@messenger)
+    end
+  end
 end

data/spec/redrum/skeleton_spec.rb

@@ -1,7 +1,12 @@
 require File.expand_path("../../spec_helper", __FILE__)
 
 describe Redrum::Skeleton do
-  before { @target = "temp" }
+  before do
+    @target = "temp"
+    FileUtils.rm_rf(@target) rescue nil
+  end
+
+  after(:all) { FileUtils.rm_rf("temp") rescue nil }
 
   context "#new" do
     it "creates a new project folder at the target" do
@@ -15,5 +20,20 @@ describe Redrum::Skeleton do
       end
       Redrum::Skeleton.new(@target)
     end
+
+    it "informs us what folders it creates, if params[:output_to] is defined" do
+      STDOUT.as_null_object.should_receive(:puts).with("Creating temp")
+      Redrum::Skeleton.new(@target, :output_to => STDOUT)
+    end
+
+    it "does not print what it creates if params[:output_to] is not defined" do
+      STDOUT.as_null_object.should_not_receive(:puts).with("Creating temp")
+      Redrum::Skeleton.new(@target)
+    end
+
+    it "does raise an error if a directory with the projects name already exists" do
+      Redrum::Skeleton.new(@target)
+      lambda { Redrum::Skeleton.new(@target) }.should raise_error(Errno::EEXIST)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1 +1,11 @@
 require File.expand_path( "../../lib/redrum", __FILE__ )
+require "fileutils"
+require "stringio"
+
+def no_warnings
+  verbosity = $VERBOSE
+  $VERBOSE = nil
+  result = yield
+  $VERBOSE = verbosity
+  result
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: redrum
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - !binary |
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-26 00:00:00 +02:00
+date: 2010-10-28 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,13 +43,16 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/redrum/cli.rb
 - lib/redrum/redrum.rb
 - lib/redrum/skeleton.rb
 - lib/redrum.rb
+- spec/redrum/cli_spec.rb
 - spec/redrum/redrum_spec.rb
 - spec/redrum/skeleton_spec.rb
 - spec/spec_helper.rb
 - bin/redrum
+- features/command_line_interface.feature
 - features/create_folder_skeleton.feature
 has_rdoc: true
 homepage: http://darkno.de