shepherd 0.3.0 → 0.3.1

data/lib/shepherd/command.rb

@@ -1,65 +1,65 @@
 module Shepherd
 
-	# A (actually, very) simple class, which is used to determine whether is this class a command, or not.
-	# 
-	# == Creating a command
-	# A Shepherd's command is just a class, which is kept inside +Shepherd::Command+.
-	# Just create a ruby file inside +lib/shepherd/commands/+ called however you like, eg. foo.rb.
-	# This file should look kinda like this stuff:
-	# 
-	#     module Shepherd::Command
-	#        class Foobar # this is the commands name; that would be: shep foobar 
-	#           def init # when you call: shep <command>, init method here is executed.
-	#              puts "foobarinize!"
-	#           end
-	#        end
-	#     end
-	# 
-	# You can also specify some other method than +init+ (eg. ahoy) and then use an +alias+ method:
-	# 
-	#     module Shepherd::Command
-	#        class Pirate
-	#           def ahoy
-	#              puts "Ahoy, aad'enturre!"
-	#           end
-	#           alias :init :ahoy
-	#        end
-	#     end
-	# 
-	# == Options parsing
-	# For --options parsing, Shepherd uses Trollop[http://trollop.rubyforge.org/] (which by the way is AWESOME!):
-	# 
-	#     module Shepherd::Command
-	#        class Foobar
-	#           def init
-	#              opts = Trollop::options do
-	#                 opt :monkey, "Use monkey mode"                      # flag --monkey, default false
-	#                 opt :goat, "Use goat mode", :default => true        # flag --goat, default true
-	#                 opt :num_limbs, "Number of limbs", :default => 4    # integer --num-limbs <i>, default to 4
-	#                 opt :num_thumbs, "Number of thumbs", :type => :int  # integer --num-thumbs <i>, default nil
-	#              end
-	#           end
-	#        end
-	#     end
-	# 
-	# You can of course use for example +OptionParser+, if you want. But.. Trollop[http://trollop.rubyforge.org/] is AWESOME! THAT's why wise Shepherd is using it ;)
-	# 
-	# == Multiple commands 
-	# Also, yau can create more than one command inside one file:
-	# 
-	#     module Shepherd::Command
-	#        class Foobar 
-	#           def init
-	#              puts "foobarinize!"
-	#           end
-	#        end
-	# 
-	#        class Barbaz 
-	#           def init
-	#              puts "barbazinize!"
-	#           end
-	#        end
-	#     end  
-	# 
-	module Command; end
+  # A (actually, very) simple class, which is used to determine whether is this class a command, or not.
+  # 
+  # == Creating a command
+  # A Shepherd's command is just a class, which is kept inside +Shepherd::Command+.
+  # Just create a ruby file inside +lib/shepherd/commands/+ called however you like, eg. foo.rb.
+  # This file should look kinda like this stuff:
+  # 
+  #     module Shepherd::Command
+  #        class Foobar # this is the commands name; that would be: shep foobar 
+  #           def init # when you call: shep <command>, init method here is executed.
+  #              puts "foobarinize!"
+  #           end
+  #        end
+  #     end
+  # 
+  # You can also specify some other method than +init+ (eg. ahoy) and then use an +alias+ method:
+  # 
+  #     module Shepherd::Command
+  #        class Pirate
+  #           def ahoy
+  #              puts "Ahoy, aad'enturre!"
+  #           end
+  #           alias :init :ahoy
+  #        end
+  #     end
+  # 
+  # == Options parsing
+  # For --options parsing, Shepherd uses Trollop[http://trollop.rubyforge.org/] (which by the way is AWESOME!):
+  # 
+  #     module Shepherd::Command
+  #        class Foobar
+  #           def init
+  #              opts = Trollop::options do
+  #                 opt :monkey, "Use monkey mode"                      # flag --monkey, default false
+  #                 opt :goat, "Use goat mode", :default => true        # flag --goat, default true
+  #                 opt :num_limbs, "Number of limbs", :default => 4    # integer --num-limbs <i>, default to 4
+  #                 opt :num_thumbs, "Number of thumbs", :type => :int  # integer --num-thumbs <i>, default nil
+  #              end
+  #           end
+  #        end
+  #     end
+  # 
+  # You can of course use for example +OptionParser+, if you want. But.. Trollop[http://trollop.rubyforge.org/] is AWESOME! THAT's why wise Shepherd is using it ;)
+  # 
+  # == Multiple commands 
+  # Also, yau can create more than one command inside one file:
+  # 
+  #     module Shepherd::Command
+  #        class Foobar 
+  #           def init
+  #              puts "foobarinize!"
+  #           end
+  #        end
+  # 
+  #        class Barbaz 
+  #           def init
+  #              puts "barbazinize!"
+  #           end
+  #        end
+  #     end  
+  # 
+  module Command; end
 end

data/lib/shepherd/commands/init.rb

@@ -1,8 +1,8 @@
 module Shepherd::Command
-	class Init
-		def init
-			@opts = Trollop::options do
-				banner <<-EOB
+  class Init
+    def init
+      @opts = Trollop::options do
+        banner <<-EOB
 usage: shep init [options] [-h|--help]
 
 examples:
@@ -16,39 +16,39 @@ examples:
 
 options are:
 EOB
-				opt :path, "a root path to the project", :default => Dir.pwd
-				opt :name, "set a projects name (default: a top directory name from --path will be taken)", :type => :string
-				opt :quiet, "don't show what's going on"
-				opt :help, "show me and exit", :short => '-h'
-			end
-			
-			@state = {}
-			# delete the last '/' in path if present
-			@state[:path] = @opts[:path].chomp "/"
-			# use this top directory name unless --name is set
-			@state[:name] = @opts[:name] ? @opts[:name] : @opts[:path].split("/").last
-			
-			# let's check if the --path exists
-			if !Dir.exists? @state[:path]
-				puts "[shep] exit 5: no such directory: #{@state[:path]}"
-				exit 5
-			end
-			
-			# let's check if there already is a sheep with the same path and/or name
-			res = Shepherd::Db.new.get_first_row "select * from sheeps where name = ? or path = ?", @state[:name], @state[:path]
-			if res
-				puts "[shep] exit 4: there already is a sheep with that name and/or path"
-				exit 4
-			end
-			
-			Shepherd::Counter.new(@state[:path]) do |count|
-				@state[:files] = count.files
-				@state[:lines] = count.lines
-				@state[:chars] = count.chars
-				@state[:bytes] = count.bytes
-			end
-			
-			puts "Our brave-hearted Shepherd gained a new sheep!
+        opt :path, "a root path to the project", :default => Dir.pwd
+        opt :name, "set a projects name (default: a top directory name from --path will be taken)", :type => :string
+        opt :quiet, "don't show what's going on"
+        opt :help, "show me and exit", :short => '-h'
+      end
+      
+      @state = {}
+      # delete the last '/' in path if present
+      @state[:path] = @opts[:path].chomp "/"
+      # use this top directory name unless --name is set
+      @state[:name] = @opts[:name] ? @opts[:name] : @opts[:path].split("/").last
+      
+      # let's check if the --path exists
+      if !Dir.exists? @state[:path]
+        puts "[shep] exit 5: no such directory: #{@state[:path]}"
+        exit 5
+      end
+      
+      # let's check if there already is a sheep with the same path and/or name
+      res = Shepherd::Db.new.get_first_row "select * from sheeps where name = ? or path = ?", @state[:name], @state[:path]
+      if res
+        puts "[shep] exit 4: there already is a sheep with that name and/or path"
+        exit 4
+      end
+      
+      Shepherd::Counter.new(@state[:path]) do |count|
+        @state[:files] = count.files
+        @state[:lines] = count.lines
+        @state[:chars] = count.chars
+        @state[:bytes] = count.bytes
+      end
+      
+      puts "Our brave-hearted Shepherd gained a new sheep!
 
    path: \e[1;34m#{@state[:path]}\e[0;0m
    name: \e[1;32m#{@state[:name]}\e[0;0m
@@ -60,12 +60,12 @@ EOB
          #{Shepherd::Utils.nice_bytes(@state[:bytes])} (#{@state[:bytes].to_nice} bytes)
   
 " unless @opts[:quiet]
-			
-			Shepherd::Db.new.execute "insert into sheeps(id, name, path, files, lines, chars, bytes, inited_at, updated_at) values(NULL, ?, ?, ?, ?, ?, ?, datetime(), datetime())", @state[:name], @state[:path], @state[:files], @state[:lines], @state[:chars], @state[:bytes]
-		end
-		
-		def desc
-			"initialize a new project"
-		end
-	end
+      
+      Shepherd::Db.new.execute "insert into sheeps(id, name, path, files, lines, chars, bytes, inited_at, updated_at) values(NULL, ?, ?, ?, ?, ?, ?, datetime(), datetime())", @state[:name], @state[:path], @state[:files], @state[:lines], @state[:chars], @state[:bytes]
+    end
+    
+    def desc
+      "initialize a new project"
+    end
+  end
 end

data/lib/shepherd/commands/list.rb

@@ -0,0 +1,29 @@
+module Shepherd::Command
+  class List
+    def init
+      @opts = Trollop::options do
+        banner <<-EOB
+usage: shep list [options]
+EOB
+        
+        opt :one_line, "print each project in one line"
+        opt :help, "print me and exit", :short => '-h'
+      end
+
+      Shepherd::Db.new.execute "select * from sheeps" do |sheep|
+        if !@opts[:one_line]
+          puts "#{sheep[0]}. \e[1;32m#{sheep[1]}\e[0;0m in \e[1;34m#{sheep[2]}\e[0;0m
+          #{sheep[3].to_nice} files #{sheep[4].to_nice} lines #{sheep[5].to_nice} chars
+          #{Shepherd::Utils.nice_bytes(sheep[6])} (#{sheep[6].to_nice} bytes)
+          "
+        else
+          puts "#{sheep[0]}. \e[1;32m#{sheep[1]}\e[0;0m in \e[1;34m#{sheep[2]}\e[0;0m"
+        end
+      end
+    end
+
+    def desc
+      "show the projects you've inited"
+    end
+  end
+end

data/lib/shepherd/commands/rm.rb

@@ -1,34 +1,34 @@
 module Shepherd::Command
-	class Rm
-		def init
-			@opts = Trollop::options do
-				banner <<-EOB
+  class Rm
+    def init
+      @opts = Trollop::options do
+        banner <<-EOB
 usage: shep [options] rm <id>
 EOB
-				opt :quiet, "don't produce output"
-				opt :help, "show me and exit", :short => '-h'
-			end
+        opt :quiet, "don't produce output"
+        opt :help, "show me and exit", :short => '-h'
+      end
 
-			unless id = ARGV.first
-				puts "[shep] error: no sheep specified."
-				exit 1
-			end
+      unless id = ARGV.first
+        puts "[shep] error: no sheep specified."
+        exit 1
+      end
 
-			id = id.to_i
+      id = id.to_i
 
-			if Shepherd::Db.new.get_first_row "select * from sheeps where id = ? limit 1", id
-				if Shepherd::Db.new.execute "delete from sheeps where id = ?", id
-					puts "[shep] good: successfuly deleted sheep." unless @opts[:quiet]
-				else
-					puts "[shep] error: something went wrong." unless @opts[:quiet]
-				end
-			else
-				puts "[shep] error: no such sheep." unless @opts[:quiet]
-			end
-		end
+      if Shepherd::Db.new.get_first_row "select * from sheeps where id = ? limit 1", id
+        if Shepherd::Db.new.execute "delete from sheeps where id = ?", id
+          puts "[shep] good: successfuly deleted sheep." unless @opts[:quiet]
+        else
+          puts "[shep] error: something went wrong." unless @opts[:quiet]
+        end
+      else
+        puts "[shep] error: no such sheep." unless @opts[:quiet]
+      end
+    end
 
-		def desc
-			"remove a specific project"
-		end
-	end
+    def desc
+      "remove a specific project"
+    end
+  end
 end

data/lib/shepherd/commands/show.rb

@@ -1,53 +1,43 @@
 module Shepherd::Command
-	class Show
-		def init
-			@opts = Trollop::options do
-				banner <<-EOB
+  class Show
+    def init
+      @opts = Trollop::options do
+        banner <<-EOB
 usage: shep show [sheep] [options]
 
 options are:
 EOB
-				opt :oneline, "print one sheep by one line"
-				opt :help, "show me and exit"
-			end
-			
-			# This is what we should show. +:everyone+ means every sheep we got
-			# and ARGV[0] would be the name of the one specified sheep.
-			@what = ARGV[0] || :everyone
-			case @what
-				when :everyone
-					Shepherd::Db.new.execute "select * from sheeps" do |sheep|
-						if !@opts[:oneline]
-							puts "#{sheep[0]}. \e[1;32m#{sheep[1]}\e[0;0m in \e[1;34m#{sheep[2]}\e[0;0m
-   #{sheep[3].to_nice} files #{sheep[4].to_nice} lines #{sheep[5].to_nice} chars
-   #{Shepherd::Utils.nice_bytes(sheep[6])} (#{sheep[6].to_nice} bytes)
+        opt :help, "show me and exit"
+      end
+      
+      if name = ARGV.shift
+        sheep = Shepherd::Db.new.get_first_row "select * from sheeps where name = ?", name
+        if sheep
+          puts "
+     id: \e[1;35m#{sheep[0]}\e[0;0m
+   path: \e[1;34m#{sheep[1]}\e[0;0m
+   name: \e[1;32m#{sheep[2]}\e[0;0m
 
-"
-						else
-							puts "#{sheep[0]}. \e[1;32m#{sheep[1]}\e[0;0m in \e[1;34m#{sheep[2]}\e[0;0m"
-						end
-					end
-				else
-					sheep = Shepherd::Db.new.get_first_row "select * from sheeps where name = ?", @what
-					if sheep
-						puts <<-EOP
-#{sheep[0]}. \e[1;32m#{sheep[1]}\e[0;0m in \e[1;34m#{sheep[2]}\e[0;0m
-   #{sheep[3].to_nice} files #{sheep[4].to_nice} lines #{sheep[5].to_nice} chars
-   #{Shepherd::Utils.nice_bytes(sheep[6])} (#{sheep[6].to_nice} bytes)
-   
-   initialized at #{sheep[7]}
-       updated at #{sheep[8]}
-   
-EOP
-					else
-						puts "[shep] exit 6: there is no such sheep: #{@what}"
-						exit 6
-					end
-			end
-		end
-		
-		def desc
-			"list sheeps you have initialized"
-		end
-	end
+  state: #{sheep[3].to_nice} files
+         #{sheep[4].to_nice} lines
+         #{sheep[5].to_nice} chars
+
+         #{Shepherd::Utils.nice_bytes(sheep[6])} (#{sheep[6].to_nice} bytes)
+      
+  initialized at #{sheep[7]}
+      updated at #{sheep[8]}
+    "
+        else
+          puts "[shep] exit 6: there is no such sheep: #{name}"
+          exit 6
+        end
+      else
+        puts "no sheep specified"
+      end
+    end
+    
+    def desc
+      "show a specific project with some details"
+    end
+  end
 end

data/lib/shepherd/counter.rb

@@ -1,105 +1,105 @@
 require "find"
 
 module Shepherd
-	
-	# A simple class that counts all the needed data (like files, lines, bytes and so-on) in given destination path.
-	# 
-	# == Usage
-	# 
-	# Without using a block:
-	#     module Shepherd
-	#        count = Counter.new(/path/to/destination/dir)
-	#        count.files #=> 26
-	#        count.lines #=> 2319
-	#        count.chars #=> 79240
-	#     end
-	# 
-	# With a block:
-	#     module Shepherd
-	#        Counter.new(/path/to/destination/dir) do |count|
-	#           count.files #=> 26
-	#           count.lines #=> 2319
-	#           count.chars #=> 79240
-	#        end
-	#     end
-	# 
-	# Inside a +Shepherd::Command::Klass+ you should use it like so:
-	#     module Shepherd::Command
-	#        class Klass
-	#           Shepherd::Counter.new(/path/to/destination/dir) do |count|
-	#              count.files #=> 26
-	#              count.lines #=> 2319
-	#              count.chars #=> 79240
-	#           end
-	#        end
-	#     end
-	# 
-	# @return [Shepherd::Counter] a new instance of +Shepherd::Counter+
-	# @yield [Shepherd::Counter] a new instance of +Shepherd::Counter+
-	# 
-	class Counter
-		# A new instance of +Shepherd::Counter+
-		# 
-		# @param [String] path a path to the project
-		# @return [Shepherd::Counter] a new instance of +Shepherd::Counter+
-		# @yield [Shepherd::Counter] a new instance of +Shepherd::Counter+
-		def initialize path
-			# delete the last '/' in path if present, just to make sure :)
-			@path = path.chomp "/"
-			
-			yield self if block_given?
-		end
-		
-		# Count the files (excluding dotfiles).
-		# 
-		# @return [Array] list of all files (dotfiles are not included)
-		def files
-			@files = []
-			Find.find(@path) do |path|
-				if File.directory? path
-					if File.basename(path)[0] == ?.
-						Find.prune # don't look any further into this directory.
-					else
-						next
-					end
-				else
-					@files << path
-				end
-			end
-			@files.size
-		end
-		
-		# Count the lines.
-		# 
-		# @return [Integer] lines amount
-		def lines
-			@lines = 0
-			@files.each do |file|
-				@lines += `cat '#{file}' | wc -l`.to_i
-			end
-			@lines
-		end
-		
-		# Count the characters.
-		# 
-		# @return [Integer] characters amount
-		def chars
-			@chars = 0
-			@files.each do |file|
-				@chars += `cat '#{file}' | wc -m`.to_i
-			end
-			@chars
-		end
-		
-		# Count the bytes. This *wont* be converted all the time.
-		# 
-		# @return [Integer] bytes amount
-		def bytes
-			@bytes = 0
-			@files.each do |file|
-				@bytes += File.new("#{file}").size
-			end
-			@bytes
-		end
-	end
+  
+  # A simple class that counts all the needed data (like files, lines, bytes and so-on) in given destination path.
+  # 
+  # == Usage
+  # 
+  # Without using a block:
+  #     module Shepherd
+  #        count = Counter.new(/path/to/destination/dir)
+  #        count.files #=> 26
+  #        count.lines #=> 2319
+  #        count.chars #=> 79240
+  #     end
+  # 
+  # With a block:
+  #     module Shepherd
+  #        Counter.new(/path/to/destination/dir) do |count|
+  #           count.files #=> 26
+  #           count.lines #=> 2319
+  #           count.chars #=> 79240
+  #        end
+  #     end
+  # 
+  # Inside a +Shepherd::Command::Klass+ you should use it like so:
+  #     module Shepherd::Command
+  #        class Klass
+  #           Shepherd::Counter.new(/path/to/destination/dir) do |count|
+  #              count.files #=> 26
+  #              count.lines #=> 2319
+  #              count.chars #=> 79240
+  #           end
+  #        end
+  #     end
+  # 
+  # @return [Shepherd::Counter] a new instance of +Shepherd::Counter+
+  # @yield [Shepherd::Counter] a new instance of +Shepherd::Counter+
+  # 
+  class Counter
+    # A new instance of +Shepherd::Counter+
+    # 
+    # @param [String] path a path to the project
+    # @return [Shepherd::Counter] a new instance of +Shepherd::Counter+
+    # @yield [Shepherd::Counter] a new instance of +Shepherd::Counter+
+    def initialize path
+      # delete the last '/' in path if present, just to make sure :)
+      @path = path.chomp "/"
+      
+      yield self if block_given?
+    end
+    
+    # Count the files (excluding dotfiles).
+    # 
+    # @return [Array] list of all files (dotfiles are not included)
+    def files
+      @files = []
+      Find.find(@path) do |path|
+        if File.directory? path
+          if File.basename(path)[0] == ?.
+            Find.prune # don't look any further into this directory.
+          else
+            next
+          end
+        else
+          @files << path
+        end
+      end
+      @files.size
+    end
+    
+    # Count the lines.
+    # 
+    # @return [Integer] lines amount
+    def lines
+      @lines = 0
+      @files.each do |file|
+        @lines += `cat '#{file}' | wc -l`.to_i
+      end
+      @lines
+    end
+    
+    # Count the characters.
+    # 
+    # @return [Integer] characters amount
+    def chars
+      @chars = 0
+      @files.each do |file|
+        @chars += `cat '#{file}' | wc -m`.to_i
+      end
+      @chars
+    end
+    
+    # Count the bytes. This *wont* be converted all the time.
+    # 
+    # @return [Integer] bytes amount
+    def bytes
+      @bytes = 0
+      @files.each do |file|
+        @bytes += File.new("#{file}").size
+      end
+      @bytes
+    end
+  end
 end