carb 0.0.4 → 0.0.5

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -1,3 +1,3 @@
 ### 0.0.4 / 2012-10-04 ###
 
-* Early release with create task, built upon `clamp`
+* Early release with create task, using `clamp` for option parsing

data/README.md

@@ -3,34 +3,44 @@
 Tool to help us set up our web apps faster. It can merge different subprojects
 and deliver a folder ready to start developing.
 
-Available setups are:
+# Install #
 
-- on-fire: [octaplus](https://github.com/proximitybbdo/octaplus) topped with [bearded-octo](https://github.com/proximitybbdo/bearded-octo) and [moreorless](https://github.com/rob-bar/moreorless) (default)
-- octaplus: octaplus installation
-- bearded-octo: frontend framework topped with moreorless
+    gem install carb
 
-## Installation
+### RMagick and OSX ###
+For all file/dir related tasks, the gem relies on FileUtils, which itself relies on the RMagick gem. If you are on OSX, and having trouble, please try to install RMagic:
 
-Add this line to your application's Gemfile:
+- through (homebrew)[http://mxcl.github.com/homebrew/], just run 
+  `$ brew update | brew install imagemagick`
+- by using [this great script](https://github.com/maddox/magick-installer)
 
-    gem 'carb'
+# Usage #
 
-And then execute:
+    $ carb create TYPE TARGET_FOLDER
+    => Installs a specific type, just run the command
 
-    $ bundle
+    $ carb [-h|--help]
+    => Display usage information
 
-Or install it yourself as:
+    # The possible types are
 
-    $ gem install carb
+    # - on-fire: octaplus topped with bearded-octo and moreorless (default)
+    # - octaplus: a fuelphp installation
+    # - bearded-octo: frontend framework topped with moreorless
 
-## Usage
+# Installation types #
 
-To install a specific type, just run the command
+Available setups are:
 
-    $ carb create TYPE TARGET_FOLDER
+- on-fire: [octaplus](https://github.com/proximitybbdo/octaplus) topped with [bearded-octo](https://github.com/proximitybbdo/bearded-octo) and [moreorless](https://github.com/rob-bar/moreorless) (default)
+- octaplus: octaplus installation, which is a basic FuelPHP installation
+- bearded-octo: frontend framework topped with moreorless
 
-The possible types are
+# Contributing #
 
-- on-fire: octaplus topped with bearded-octo and moreorless (default)
-- octaplus: a fuelphp installation
-- bearded-octo: frontend framework topped with moreorless
+Fork, alter, pull request!
+
+## Copyright ##
+
+Copyright (c) 2012 Proximity BBDO
+See LICENSE for details.

data/bin/carb

@@ -4,9 +4,6 @@
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
 require 'rubygems'
-require 'fileutils'
-require "clamp"
-
-require 'carb/cli'
+require 'carb'
 
 Carb::CLI.run

data/carb.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["jeroenbourgois@gmail.com"]
   gem.description   = %q{Boost the start of a Proximity BBDO Octaplus framework}
   gem.summary       = %q{Boost the start of a Proximity BBDO Octaplus framework}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/proximitybbdo/carb"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,6 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Carb::VERSION
   
+  gem.required_ruby_version = '>= 1.9'
+  
   gem.add_dependency "clamp"
   gem.add_dependency "fileutils"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "stringio"
 end

data/lib/carb/cli.rb

@@ -1,35 +1,53 @@
-require 'carb'
+require "clamp/command"
 
-require 'carb/config'
-require 'carb/logger'
-require 'carb/controller'
+require "carb/config"
+require "carb/controller"
+require "carb/logger"
+require "carb/version"
 
 module Carb
   module CLI
 
     class InstallCommand < Clamp::Command
-      parameter "TYPE", "The type of project, being one of: octaplus, bearded-octo, on-fire" do |s|
+      parameter "TYPE", "Type of project, one of:
+------------------------
+
+octaplus        a clean fuelphp installation, 
+                with no frontend classes merged
+
+bearded-octo    frontend only, merges our frontend framework
+                with the moreorless less package
+
+on-fire         [recommended] combo of octaplus and bearded-octo
+
+" do |s|
         raise ArgumentError.new('Not a correct project type.') unless Carb::Config::PROJECT_TYPES.include?(s)
         s # return the actual value
       end
 
-      parameter "[TARGET]", "The target folder", :default => "."
+      parameter "[TARGET]", "target folder", :default => "."
+
+      option ["--force", "-f"], :flag, "force overwrite of the target folder if it exists"
 
       def execute
-        Carb::Controller.assemble(type, target)
+        Carb::Controller.assemble(type, target, force?)
       end
     end
 
     class MainCommand < Clamp::Command
-      Logger::log('TODO: alter the default view, merge with index.html', Logger::WARNING)
-      Logger::log('TODO: add check if target exists', Logger::WARNING)
-      Logger::log('TODO: use FileUtils as much as possible', Logger::WARNING)
-      Logger::log('TODO: check if repos are there', Logger::WARNING)
+      option ["--version", "-v"], :flag, "show version" do
+        puts "Carb #{Carb::VERSION}"
+        exit(0)
+      end
 
       subcommand "install", "Install a new project", InstallCommand
     end
 
     def self.run(*a)
+      Logger::log('TODO: alter the default view, merge with index.html', Logger::WARNING)
+      Logger::log('TODO: check if repos are there', Logger::WARNING)
+      puts ''
+
       MainCommand.run(*a)
     end
   end

data/lib/carb/controller.rb

@@ -1,38 +1,63 @@
 # -*- encoding : utf-8 -*-
-require 'carb'
+
+require 'fileutils'
 
 module Carb
   class Controller
     class << self
 
-      type, pwd, target = '', '', ''
+      type, pwd, target, force = '', '', '', false
 
       ##################################
       # the chef
       ##################################
       
-      def assemble(type, target)
+      def assemble(type, target, force)
 
         @type = type
         @target = target || "."
+        @force = force || false
+
+        if check_target() == true
+          set_up()
+
+          case @type
+          when Config::TYPE_OCTAPLUS
+            cook_octaplus()
+          when Config::TYPE_BEARDED_OCTO
+            cook_bearded_octo()
+          when Config::TYPE_ON_FIRE
+            cook_on_fire()
+          end
+
+          tear_down()
+        else
+          exit(1)
+        end
+      end
 
-        set_up()
-
-        case @type
-        when Config::TYPE_OCTAPLUS
-          cook_octaplus()
-        when Config::TYPE_BEARDED_OCTO
-          cook_bearded_octo()
-        when Config::TYPE_ON_FIRE
-          cook_on_fire()
+      def check_target()
+        # check if target exists, if it does and
+        # force is false, stop right here
+        if File.directory?(@target)
+          if @force
+            FileUtils.rm_rf(Dir.glob("#{@target}/*")) 
+            return true
+          else
+            Logger::log("⚡ Target folder exists, use --force | -f to overwrite ⚡", Logger::ERROR)
+            return false
+          end
         end
 
-        tear_down()
+        return true
       end
 
       def set_up
         Logger::log("⚡ Preparing your package, hold on ⚡", Logger::INFO)
 
+        # clean up if the tear down left some crappers
+        FileUtils.remove_dir "#{Config::TMP_FOLDER}", :force => true
+
         # save pwd
         @pwd = Dir.pwd
 
@@ -52,7 +77,7 @@ module Carb
         Logger::log("⚡⚡⚡ Et voila! All set in the ./#{@target} folder ⚡⚡⚡ ", Logger::SUCCESS)
 
         # clean up
-        # FileUtils.remove_dir "#{Config::TMP_FOLDER}", :force => true
+        FileUtils.remove_dir "#{Config::TMP_FOLDER}", :force => true
       end
 
       ##################################
@@ -94,17 +119,25 @@ module Carb
         get_bearded_octo()
         get_moreorless()
 
-        FileUtils.remove_dir "#{Config::DIR_OCTAPLUS}/assets"
         FileUtils.mkdir_p "#{Config::DIR_COOKPOT}/assets"
 
-        FileUtils.cp_r "#{Config::DIR_BEARDED}/assets/.", "#{Config::DIR_COOKPOT}/assets"
+        FileUtils.cp_r "#{Config::DIR_BEARDED}/.", "#{Config::DIR_COOKPOT}/"
         FileUtils.remove_dir "#{Config::DIR_MOREORLESS}/tests"
         FileUtils.cp_r "#{Config::DIR_MOREORLESS}/.", "#{Config::DIR_COOKPOT}/assets/css"
       end
 
       def cook_on_fire
         get_octaplus()
-        cook_bearded_octo()
+        get_bearded_octo()
+        get_moreorless()
+
+        FileUtils.mkdir_p "#{Config::DIR_COOKPOT}/assets"
+
+        FileUtils.cp_r "#{Config::DIR_BEARDED}/assets", "#{Config::DIR_COOKPOT}/"
+        FileUtils.remove_dir "#{Config::DIR_MOREORLESS}/tests"
+        FileUtils.cp_r "#{Config::DIR_MOREORLESS}/.", "#{Config::DIR_COOKPOT}/assets/css"
+
+        FileUtils.remove_dir "#{Config::DIR_OCTAPLUS}/assets"
 
         FileUtils.cp_r "#{Config::DIR_OCTAPLUS}/.", "#{Config::DIR_COOKPOT}"
         FileUtils.cp_r "#{Config::DIR_BEARDED}/index.html", "#{Config::DIR_COOKPOT}/fuel/app/views/welcome"

data/lib/carb/version.rb

@@ -1,3 +1,3 @@
 module Carb
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/carb.rb

@@ -1,2 +1,4 @@
+require 'carb/cli'
+
 module Carb
 end

data/spec/carb/cli_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+describe Carb::CLI do
+
+  include OutputCapture
+
+  describe "MainCommand" do
+
+    before do
+      @command = Carb::CLI::MainCommand.new("")
+    end
+
+    describe "without parameters" do
+
+      it "shows the help" do
+
+        lambda do
+          @command.parse(%w(--help))
+        end.should raise_error(Clamp::HelpWanted)
+      end
+
+    end 
+
+  end
+
+  describe "InstallCommand" do
+
+    before do
+      @command = Carb::CLI::InstallCommand.new("")
+    end
+
+    describe "with an invalid type" do
+
+      it "fails and leaves you burning in hell" do
+        lambda do
+          @command.parse(['bogus'])
+        end.should raise_error(Clamp::UsageError, /TYPE/)
+      end
+
+    end
+
+    describe "with a valid type and target" do
+
+      it "will give you what you want, a package" do
+        @command.parse(['octaplus', '/tmp/carb-rspec'])
+        @command.execute()
+        stdout.should include("voila")
+
+        @command.parse(['bearded-octo', '/tmp/carb-rspec'])
+        @command.execute()
+        stdout.should include("voila")
+
+        @command.parse(['on-fire', '/tmp/carb-rspec'])
+        @command.execute()
+        stdout.should include("voila")
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'carb'
+require 'stringio' # capture streams
+
+module OutputCapture
+
+  def self.included(target)
+
+    target.before do
+      $stdout = @out = StringIO.new
+      $stderr = @err = StringIO.new
+    end
+
+    target.after do
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+
+  end
+
+  def stdout
+    @out.string
+  end
+
+  def stderr
+    @err.string
+  end
+
+end
+
+# RSpec.configure do |config|
+#   config.treat_symbols_as_metadata_keys_with_true_values = true
+#   config.run_all_when_everything_filtered = true
+#   config.filter_run :focus
+# 
+#   # Run specs in random order to surface order dependencies. If you find an
+#   # order dependency and want to debug it, you can fix the order by providing
+#   # the seed, which is printed after each run.
+#   #     --seed 1234
+#   config.order = 'random'
+# end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: carb
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jeroen Bourgois
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-04 00:00:00 Z
+date: 2012-10-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: clamp
@@ -45,6 +45,34 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: stringio
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Boost the start of a Proximity BBDO Octaplus framework
 email: 
 - jeroenbourgois@gmail.com
@@ -56,6 +84,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -70,7 +99,9 @@ files:
 - lib/carb/controller.rb
 - lib/carb/logger.rb
 - lib/carb/version.rb
-homepage: ""
+- spec/carb/cli_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/proximitybbdo/carb
 licenses: []
 
 post_install_message: 
@@ -83,10 +114,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 29
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 9
+      version: "1.9"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
@@ -103,5 +135,6 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Boost the start of a Proximity BBDO Octaplus framework
-test_files: []
-
+test_files: 
+- spec/carb/cli_spec.rb
+- spec/spec_helper.rb