whisk 0.0.4 → 0.1.0

data/README.md

@@ -1,18 +1,23 @@
 Whisk
 =====
 
-Whisk is a simple cookbook manager for Chef, inspired by librarian.
-Unlike librarian, Whisk only concerns itself with fetching and preparing
-exactly what you tell it. 
+Whisk is a simple cookbook manager for Chef, inspired by librarian and
+berkshelf.
 
-Whisk currently does not support any direct interaction with the Chef Server.
+Unlike these tools, Whisk only concerns itself with fetching and preparing
+exactly what you tell it, and will not resolve dependencies for you or make any
+decisions about which code gets downloaded for you.
 
-Currently Whisk only supports fetching cookbooks directly from git, 
-although there are plans to include support for community cookbooks in the
-future.
+Whisk has been designed to work with git only and tries to help automating
+the more tedious aspects of working in with 'the single repository per
+cookbook' model.
+
+# Configuration #
 
 Whisk will prepare one or multiple 'bowls' of cookbooks as specified in your
-whisk.rb file. 
+Whiskfile.
+
+## Example Whiskfile ##
 
     cb_path = "/home/msf/hack/whisk/%s"
     github = "git://github.com/cookbooks/%s.git"
@@ -20,10 +25,61 @@ whisk.rb file.
     bowl "production" do
       path cb_path % name
 
-      ingredient "ntp",
-        :source => github % "ntp",
-	:options => { :ref => 'master' }
+      ingredient "ntp" do
+        source github % "ntp"
+        options { :ref => 'master' }
+      end
+    end
+
+# Commands #
+
+##  whisk prepare ##
+
+The prepare subcommand allows you to clone your ingredients and optional
+checkout a specified ref.
+
+    $ whisk prepare
+    Creating bowl 'production' with path /home/msf/hack/whisk/production
+    Preparing bowl 'production' with path /home/msf/hack/whisk/production
+    Cloning ingredient ntp, from git url git://github.com/cookbooks/ntp.git
+    Cloning into 'ntp'...
+    Checking out ref 'master' for ingredient ntp
+
+You can also use specify an optional filter to run prepare on a subset of
+cookbooks using ruby regexes.
+
+    # prepare the 'development' bowl
+    $ whisk prepare dev
+
+    # prepare the ntp cookbook in all configured bowls'
+    $ whisk prepare '.*' 'ntp'
+
+    # prepare a list of cookbooks
+    $ whisk prepare 'dev' '(ssh|ntp)'
+
+## whisk status ##
+
+Whisk status calls 'git status' on the specified set of ingredients.
+
+You can use the same filter mechanisms as described in 'whisk prepare'
+to run update on a subset of ingredients
+
+    # show status for all configured bowls
+    $ whisk status
+    Status for ingredient 'production/ntp'
+    # On branch master
+    nothing to commit (working directory clean)
+
+## whisk update ##
+
+Whisk update calls 'git remote update' on the specified set of ingredients
+on them. It does not attempt to merge any code from your remotes.
 
-    end 
+You can use the same filter mechanisms as described in 'whisk prepare'
+to run update on a subset of ingredients
 
+    # update all ingredients, in all bowls
+    $ whisk update
 
+    # only update the 'development bowl'
+    $ whisk update dev

data/bin/whisk

@@ -18,30 +18,6 @@
 #
 
 $:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'whisk/cli'
 
-require 'rubygems'
-require 'logger'
-require 'whisk/config'
-require 'whisk/log'
-
-# borrowed from chef/chef/lib/chef/application.rb
-logger = Logger.new(STDOUT)
-STDOUT.sync = true
-logger.formatter = Whisk::Log.logger.formatter
-Whisk::Log::Formatter.show_time = false
-Whisk::Log.loggers << logger
-
-if File.exists?("Whiskfile")
-  whiskfile = "Whiskfile"
-else
-  whiskfile = File.join(ENV['HOME'], '.chef', 'whisk.rb')
-end
-
-Whisk::Log.info "Loading configuration from Whiskfile: #{whiskfile}"
-
-Whisk::Config.from_file(whiskfile)
-
-bowls = Whisk::Config.bowls
-bowls.each do |name, bowl|
-  bowl.prepare
-end
+Whisk::CLI.start

data/lib/whisk/bowl.rb

@@ -17,7 +17,6 @@
 
 require 'pp'
 require 'fileutils'
-require 'whisk/log'
 require 'whisk/ingredient'
 
 class Whisk
@@ -40,22 +39,18 @@ class Whisk
       end
     end
 
-    def ingredient(iname, opts = {})
+    def ingredient(iname, &block)
       if ingredients.has_key? iname
-        raise ArgumentError "ingredient '#{iname}' has already added to bowl '#{name}'"
+        raise ArgumentError "Ingredient '#{iname}' has already added to bowl '#{name}'"
       else
-        source = opts.delete :source
-        flavour = opts.delete :flavour
-        options = opts.delete :options
-        i = Whisk::Ingredient.new(iname, source, flavour, options)
-        ingredients[iname] = i
+        ingredients[iname] = Whisk::Ingredient.new(iname, &block)
       end
     end
 
     def create!
-      if not path.nil? and Dir.exists? path
+      unless Dir.exists? path
         begin
-          Whisk::Log.info "creating bowl '#{name}' with path #{path}"
+          Whisk.ui.info "Creating bowl '#{name}' with path #{path}"
           ::FileUtils.mkdir_p path
         rescue Exception => e
           puts "#{e.backtrace} #{e.message}"
@@ -67,17 +62,33 @@ class Whisk
       self.create!
       ::Dir.chdir path
 
-      Whisk::Log.info "preparing bowl '#{name}' with path #{path}"
+      Whisk.ui.info "Preparing bowl '#{name}' with path #{path}"
 
       ingredients.each do |name, ingredient|
         begin
           ingredient.prepare
         rescue Exception => e
-          Whisk::Log.error "failed fetching ingredient #{name}! bailing"
+          Whisk.ui.error "Failed fetching ingredient '#{name}'"
           raise
           exit 1
         end
       end
     end
+
+    def status
+      ::Dir.chdir path
+      ingredients.each do |name, ingredient|
+        Whisk.ui.info "Status for ingredient '#{self.name}/#{name}'"
+        ingredient.status
+      end
+    end
+
+    def update
+      ::Dir.chdir path
+      ingredients.each do |name, ingredient|
+        Whisk.ui.info "Updating ingredient '#{self.name}/#{name}'"
+        ingredient.update
+      end
+    end
   end
 end

data/lib/whisk/cli.rb

@@ -0,0 +1,96 @@
+# Author:: Jamie Winsor <jamie@vialstudios.com>
+# Copyright:: Copyright (c) 2012 Jamie Winsor
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# this file is derived f
+
+require 'thor'
+require 'whisk'
+require 'whisk/whiskfile'
+
+def filter_bowls(bowls, bowl=nil, ingredient=nil)
+  if bowl
+    bowls.delete_if {|k,v| !k.to_s.match(/^#{bowl}$/)}
+    if ingredient
+      bowls.each do |name, b|
+        bowls[name].ingredients.delete_if {|k,v| !k.to_s.match(/^#{ingredient}$/)}
+      end
+    end
+  end
+
+  return bowls
+end
+
+class Whisk
+  class CLI < Thor
+    def initialize(*)
+      super
+      # JW TODO: Replace Chef::Knife::UI with our own UI class
+      ::Whisk.ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
+      @options = options.dup # unfreeze frozen options Hash from Thor
+    rescue Error => e
+      Whisk.ui.fatal e
+      exit e.status_code
+    end
+
+    namespace "whisk"
+
+    method_option :whiskfile,
+      type: :string,
+      default: File.join(Dir.pwd, Whisk::DEFAULT_FILENAME),
+      desc: "Path to a Whiskfile to operate off of.",
+      aliases: "-w",
+      banner: "PATH"
+    desc "prepare", "prepare a bowl by cloning any missing repositories"
+    def prepare(bowl=nil, ingredient=nil)
+      whiskfile = ::Whisk::WhiskFile.from_file(options[:whiskfile])
+      bowls = filter_bowls(whiskfile.bowls, bowl, ingredient)
+
+      bowls.each do |name, bowl|
+        bowl.prepare
+      end
+    end
+
+    method_option :whiskfile,
+      type: :string,
+      default: File.join(Dir.pwd, Whisk::DEFAULT_FILENAME),
+      desc: "Path to a Whiskfile to operate off of.",
+      aliases: "-w",
+      banner: "PATH"
+    desc "prepare", "prepare a bowl by cloning any missing repositories"
+    def status(bowl=nil, ingredient=nil)
+      whiskfile = ::Whisk::WhiskFile.from_file(options[:whiskfile])
+      bowls = filter_bowls(whiskfile.bowls, bowl, ingredient)
+      bowls.each do |name, bowl|
+        bowl.status
+      end
+    end
+
+    method_option :whiskfile,
+      type: :string,
+      default: File.join(Dir.pwd, Whisk::DEFAULT_FILENAME),
+      desc: "Path to a Whiskfile to operate off of.",
+      aliases: "-w",
+      banner: "PATH"
+    desc "prepare", "prepare a bowl by cloning any missing repositories"
+    def update(bowl=nil, ingredient=nil)
+      whiskfile = ::Whisk::WhiskFile.from_file(options[:whiskfile])
+      bowls = filter_bowls(whiskfile.bowls, bowl, ingredient)
+      bowls.each do |name, bowl|
+        bowl.update
+      end
+    end
+  end
+end

data/lib/whisk/flavour/git.rb

@@ -16,7 +16,6 @@
 # limitations under the License.
 
 require 'whisk/mixin/shellout'
-require 'whisk/log'
 require 'whisk/ingredient'
 
 class Whisk
@@ -26,41 +25,38 @@ class Whisk
       include Whisk::Mixin::ShellOut
 
       def clone
-        unless ::File.exists? File.join(Dir.pwd, name, ".git", "config")
-          Whisk::Log.info "cloning ingredient #{self.name}, " + "from git url #{self.source}"
+        if ::File.exists? File.join(Dir.pwd, name, ".git", "config")
+          Whisk.ui.info "Ingredient #{self.name} already prepared, moving on"
+        else
+          Whisk.ui.info "Cloning ingredient #{self.name}, " + "from git url #{self.source}"
           shell_out("git clone #{self.source} #{self.name}")
         end
       end
 
       def checkout(ref="master")
-          Whisk::Log.info "checking out ref '#{ref}' for ingredient #{self.name}"
+        if self.options and self.options.has_key? :ref
+          Whisk.ui.info "Checking out ref '#{ref}' for ingredient #{self.name}"
           shell_out("git checkout #{ref}", :cwd => self.name)
-      end
-
-      def post_fetch
-      end
-      def pre_fetch
-      end
-
-      def fetch
-          Whisk::Log.info "fetching ingredient '#{self.name}', from git url #{self.source}"
-          shell_out("git fetch --all")
+        end
       end
 
       def prepare
         begin
           self.clone
-          self.fetch
-          if self.options and self.options.has_key? :ref
-            self.checkout self.options[:ref]
-          else
-            self.checkout
-          end
+          self.checkout
         rescue Exception => e
-          Whisk::Log.error "#{e.message} #{e.backtrace}"
+          Whisk.ui.error "#{e.message} #{e.backtrace}"
           raise
         end
       end
+
+      def status
+          shell_out("git status", :cwd => self.name)
+      end
+
+      def update
+          shell_out("git remote update", :cwd => self.name)
+      end
     end
   end
 end

data/lib/whisk/ingredient.rb

@@ -15,24 +15,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'chef/mixin/params_validate'
 require 'whisk/flavours'
 
 class Whisk
   class Ingredient
 
-    attr_accessor :name, :source, :flavour, :options
+    include Chef::Mixin::ParamsValidate
 
-    def initialize(name, source=nil, flavour='git', options={})
+    attr_reader :name
+
+    def initialize(name, &block)
       @name = name
-      @source = source
-      @flavour = flavour || 'git'
-      @options = options
+      @flavour = 'git'
+      @source = nil
+      @options = {}
 
-      if source.nil?
-        raise ArgumentError, "must provide source for Ingredient #{name}"
-      end
+      instance_eval(&block) if block_given?
 
       self.class.send(:include, Whisk::FLAVOURS[@flavour])
     end
+
+    def source(arg=nil)
+      set_or_return(:source, arg, :required => true)
+    end
+
+    def flavour(arg=nil)
+      set_or_return(:flavour, arg, :default => 'git')
+    end
+
+    def options(arg=nil)
+      set_or_return(:options, arg, :default => {})
+    end
   end
 end

data/lib/whisk/version.rb

@@ -17,5 +17,5 @@
 #
 
 class Whisk
-  VERSION = '0.0.4'
+  VERSION = '0.1.0'
 end

data/lib/whisk/{config.rb → whiskfile.rb}

@@ -1,4 +1,5 @@
 #
+#
 # Author:: Adam Jacob (<adam@opscode.com>)
 # Author:: Mathieu Sauve-Frankel <msf@kisoku.net>
 # Copyright:: Copyright (c) 2008 Opscode, Inc.
@@ -18,38 +19,41 @@
 # limitations under the License.
 #
 # from_file is derived from chef/chef/lib/chef/mixin/from_file.rb
+#
+#
 
-require 'whisk/bowl'
+require 'whisk'
 
 class Whisk
-  class Config
-    attr_accessor :bowls
-
+  class WhiskFile
     @@bowls = {}
 
-    def self.add_bowl(bowl)
-      @@bowls[bowl.name] = bowl
-    end
-
-    def self.bowls
-      @@bowls
-    end
+    class << self
+      def add_bowl(bowl)
+        if @@bowls.has_key? name
+          raise ArgumentError "bowl #{name} already exists"
+        else
+          @@bowls[bowl.name] = bowl
+        end
+      end
 
-    def self.bowl(name, &block)
-      if self.bowls.has_key? name
-        raise ArgumentError "bowl #{name} already exists"
-      else
+      def bowl(name, &block)
         b = Whisk::Bowl.new(name)
         b.instance_eval(&block)
-        self.add_bowl(b)
+        add_bowl(b)
+      end
+
+      def bowls
+        @@bowls
       end
-    end
 
-    def self.from_file(filename)
-      if ::File.exists?(filename) && ::File.readable?(filename)
-        self.instance_eval(::IO.read(filename), filename, 1)
-      else
-        raise IOError, "Cannot open or read #{filename}!"
+      def from_file(filename)
+        if ::File.exists?(filename) && ::File.readable?(filename)
+          instance_eval(::IO.read(filename), filename, 1)
+          self
+        else
+          raise IOError, "Cannot open or read #{filename}!"
+        end
       end
     end
   end

data/lib/whisk.rb

@@ -16,4 +16,14 @@
 # limitations under the License.
 #
 
+require 'chef/knife'
 require 'whisk/version'
+require 'whisk/bowl'
+
+class Whisk
+  DEFAULT_FILENAME = 'Whiskfile'
+
+  class << self
+    attr_accessor :ui
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whisk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-07 00:00:00.000000000 Z
+date: 2012-08-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mixlib-log
-  requirement: &7955580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +37,15 @@ dependencies:
         version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *7955580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
-  requirement: &7954280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +53,31 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *7954280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &7951860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *7951860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple Chef cookbook dependency manager
 email: msf@kisoku.net
 executables:
@@ -53,15 +100,15 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/whisk.rb
+- lib/whisk/mixin/shellout.rb
+- lib/whisk/cli.rb
+- lib/whisk/flavours.rb
+- lib/whisk/whiskfile.rb
+- lib/whisk/ingredient.rb
 - lib/whisk/version.rb
 - lib/whisk/bowl.rb
-- lib/whisk/ingredient.rb
-- lib/whisk/mixin/shellout.rb
 - lib/whisk/flavour/git.rb
-- lib/whisk/flavours.rb
-- lib/whisk/config.rb
-- lib/whisk/log.rb
-- lib/whisk.rb
 - bin/whisk
 homepage: http://github.com/kisoku/whisk
 licenses: []
@@ -83,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A simple Chef cookbook dependency manager

data/lib/whisk/log.rb

@@ -1,37 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Author:: AJ Christensen (<@aj@opscode.com>)
-# Author:: Christopher Brown (<cb@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# this file is derived from chef/chef/lib/chef/log.rb
-
-require 'logger'
-require 'mixlib/log'
-
-class Whisk
-  class Log
-    extend Mixlib::Log
-
-    init
-
-    class Formatter
-      def self.show_time=(*args)
-        Mixlib::Log::Formatter.show_time = *args
-      end
-    end
-  end
-end