shepherd 0.3.0 → 0.3.1

data/CHANGELOG.md

@@ -1,33 +1,37 @@
-# shepherd 0.3.0 (13-12-2011)
+# shepherd 0.3.1 (17 Jan 2012)
+
++ Listing all projects with `list` command and showing a specific project with `show`.
+
+# shepherd 0.3.0 (13 Dec 2011)
 
 + Made the `update` command and added the `updated_at` column in the database.
 + `check` command finds the sheep by its name, not id.
 
-# shepherd 0.2.0 (12-12-2011)
+# shepherd 0.2.0 (12 Dec 2011)
 
 + `check` command works.
 
-# shepherd 0.1.4 (24-11-2011)
+# shepherd 0.1.4 (24 Nov 2011)
 
 + Ability to `rm` some sheeps.
 
-# shepherd 0.1.3 (18-09-2011)
+# shepherd 0.1.3 (18 Sep 2011)
 
 + Now we can `show` some sheeps!
 + `init` command now saves the inited projects!
 + Provide setup utility.
 
-# shepherd 0.1.2 (18-07-2011)
+# shepherd 0.1.2 (18 July 2011)
 
 + Make the `Counter` class
 + The `init` command works-but-not-really - it's not saving projects at the moment
 + Provide `Db` connector
 
-# shepherd 0.1.1 (04-07-2011)
+# shepherd 0.1.1 (0 July 2011)
 
 + Ease in creating your own commands!
 + Let be t'e `Cli`!
 
-# shepherd 0.1.0 (18-06-2011)
+# shepherd 0.1.0 (18 June 2011)
 
 + Birthday!

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Szymon Urbaś
+Copyright (c) 2011 - 2012 Szymon Urbaś
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,34 +2,34 @@ Shepherd
 ========
 
 <table>
-	<tr>
-		<td><b>Homepage</b></td>
-		<td><a href="http://semahawk.github.com/shepherd">http://semahawk.github.com/shepherd</a></td>
-	</tr>
-	<tr>
-		<td><b>Author</b></td>
-		<td>Szymon Urbaś (szymon dot urbas at yahoo dot com)</td>
-	</tr>
-	<tr>
-		<td><b>Copyright</b></td>
-		<td>2011</td>
-	</tr>
-	<tr>
-		<td><b>License</b></td>
-		<td>MIT</td>
-	</tr>
-	<tr>
-		<td><b>Latest version</b></td>
-		<td>0.2.0</td>
-	</tr>
-	<tr>
-		<td><b>Release date</b></td>
-		<td>January 12th, 2011</td>
-	</tr>
-	<tr>
-		<td><b>Stage</b></td>
-		<td><i>Development</i></td>
-	</tr>
+  <tr>
+    <td><b>Homepage</b></td>
+    <td><a href="http://semahawk.github.com/shepherd">http://semahawk.github.com/shepherd</a></td>
+  </tr>
+  <tr>
+    <td><b>Author</b></td>
+    <td>Szymon Urbaś (szymon dot urbas at yahoo dot com)</td>
+  </tr>
+  <tr>
+    <td><b>Copyright</b></td>
+    <td>2011 - 2012</td>
+  </tr>
+  <tr>
+    <td><b>License</b></td>
+    <td>MIT</td>
+  </tr>
+  <tr>
+    <td><b>Latest version</b></td>
+    <td>0.3.1</td>
+  </tr>
+  <tr>
+    <td><b>Release date</b></td>
+    <td>January 17th, 2012</td>
+  </tr>
+  <tr>
+    <td><b>Stage</b></td>
+    <td><i>Development</i></td>
+  </tr>
 </table>
 
 ## A bit about
@@ -39,6 +39,11 @@ You just know, if your project got few kilobytes more on weight, how many more f
 
 ## Features
 
++ Files counting
++ Lines counting
++ Chars counting
++ Bytes counting
++ Project's weight in KB, MB ..
 + Easy own command creation.
 
 ## Dependencies

data/lib/shepherd.rb

@@ -1,58 +1,58 @@
 module Shepherd
-	ROOT = File.expand_path(File.dirname(__FILE__))
-	
-	autoload :Utils,      "#{ROOT}/shepherd/utils"
-	autoload :Setup,      "#{ROOT}/shepherd/setup"
-	autoload :Command,    "#{ROOT}/shepherd/command"
-	autoload :Counter,    "#{ROOT}/shepherd/counter"
-	autoload :Db,         "#{ROOT}/shepherd/db"
-	autoload :Cli,        "#{ROOT}/shepherd/cli"
-	autoload :Version,    "#{ROOT}/shepherd/version"
-	
-	# Stay DRY
-	extend Utils
-	
-	# Check if the setup was once done
-	if !Dir.exists? "#{Dir.home}/.shepherd"
-		# Setup was not done so we'll do it, but...
-		Setup.new
-		sleep 0.5
-		puts "Hello there!"
-		sleep 2 
-		puts "It's your first time using Shepherd, isn't it?"
-		sleep 4
-		puts "Knew it!"
-		sleep 1.5
-		puts "But before the first run, we would have to make some setup first..."
-		sleep 4.5
-		puts "Do you know who's the cousin of zebra?"
-		sleep 3
-		puts "You don't?? Phew.."
-		sleep 2
-		puts "Ghehe, I know, but I won't tell you.."
-		sleep 2.8
-		puts "Oh, no, the setup is *not* running now..."
-		sleep 2
-		puts "Okey, okey! Calm down and don't yell at me.."
-		sleep 3
-		puts "All right, as you wish, I am doing the setup. You have 10.."
-		sleep 3.7
-		puts "No, 5 seconds to abort."
-		sleep 2
-		print "5"; sleep 0.4; print "."; sleep 0.4; print "."; sleep 0.2; print " "
-		print "4"; sleep 0.4; print "."; sleep 0.4; print "."; sleep 0.2; print " "
-		print "3"; sleep 0.1; print "."; sleep 0.1; print "."; sleep 0.1; print " "
-		puts "Too late!"
-		sleep 10
-		puts "Oh my gosh.. I forgot to click this big, red button which says 'Stop annoying people and do the setup'. Sorry.."
-		sleep 6.5
-		puts "Well, I suppose you actually are a human.."
-		sleep 4
-		puts "Okey, okey!\n\n"
-		sleep 2.2
-		puts "*click*\n\n"
-		sleep 0.5
-		# Ghehe :)
-		# Setup.new
-	end
+  ROOT = File.expand_path(File.dirname(__FILE__))
+  
+  autoload :Utils,      "#{ROOT}/shepherd/utils"
+  autoload :Setup,      "#{ROOT}/shepherd/setup"
+  autoload :Command,    "#{ROOT}/shepherd/command"
+  autoload :Counter,    "#{ROOT}/shepherd/counter"
+  autoload :Db,         "#{ROOT}/shepherd/db"
+  autoload :Cli,        "#{ROOT}/shepherd/cli"
+  autoload :Version,    "#{ROOT}/shepherd/version"
+  
+  # Stay DRY
+  extend Utils
+  
+  # Check if the setup was once done
+  if !Dir.exists? "#{Dir.home}/.shepherd"
+    # Setup was not done so we'll do it, but...
+    Setup.new
+    sleep 0.5
+    puts "Hello there!"
+    sleep 2 
+    puts "It's your first time using Shepherd, isn't it?"
+    sleep 4
+    puts "Knew it!"
+    sleep 1.5
+    puts "But before the first run, we would have to make some setup first..."
+    sleep 4.5
+    puts "Do you know who's the cousin of zebra?"
+    sleep 3
+    puts "You don't?? Phew.."
+    sleep 2
+    puts "Ghehe, I know, but I won't tell you.."
+    sleep 2.8
+    puts "Oh, no, the setup is *not* running now..."
+    sleep 2
+    puts "Okey, okey! Calm down and don't yell at me.."
+    sleep 3
+    puts "All right, as you wish, I am doing the setup. You have 10.."
+    sleep 3.7
+    puts "No, 5 seconds to abort."
+    sleep 2
+    print "5"; sleep 0.4; print "."; sleep 0.4; print "."; sleep 0.2; print " "
+    print "4"; sleep 0.4; print "."; sleep 0.4; print "."; sleep 0.2; print " "
+    print "3"; sleep 0.1; print "."; sleep 0.1; print "."; sleep 0.1; print " "
+    puts "Too late!"
+    sleep 10
+    puts "Oh my gosh.. I forgot to click this big, red button which says 'Stop annoying people and do the setup'. Sorry.."
+    sleep 6.5
+    puts "Well, I suppose you actually are a human.."
+    sleep 4
+    puts "Okey, okey!\n\n"
+    sleep 2.2
+    puts "*click*\n\n"
+    sleep 0.5
+    # Ghehe :)
+    # Setup.new
+  end
 end

data/lib/shepherd/cli.rb

@@ -1,98 +1,98 @@
 require "trollop"
 
-module Shepherd	
-	
-	# Command Line Interface class
-	# 
-	# === Usage
-	# 
-	#     module Shepherd
-	#        Cli.new.run!
-	#     end
-	# 
-	# or
-	# 
-	#     Shepherd::Cli.new.run!
-	# 
-	# === Exit statuses
-	# 
-	# - *0* Everything went just fine :)
-	# - *1* User said ^C :]
-	# - *2* User wanted a UnknownCommand
-	# - *3* The database file was not found
-	# - *4* User wanted to init another sheep/project with the same name and/or path
-	# - *5* User wanted to init a project in a path that doesn't exist
-	# - *6* User wanted to see a sheep that was not inited
-	# 
-	class Cli
-		
-		# Kinda self explanatory
-		class UnknownCommand < RuntimeError; end
-		
-		# A command which is about to be run
-		attr_accessor :command
-		
-		# Require *all* command files
-		# TODO: Is it possible to make it use autoload? It'd be cool! :)
-		Dir[File.join(File.dirname(__FILE__), "commands", "*.rb")].each do |all_command_files|
-			require all_command_files
-		end
-		
-		# Handle the commands list
-		# 
-		# @return [Array] all available commands
-		COMMANDS = Command.constants.select { |c| Class === Command.const_get(c) }
-		
-		# Get a list of available commands to be printed. (Almost) every line is separated by new line mark - \n
-		# 
-		# @return [String] list of all available commands
-		def commands_list
-			out = ""
-			# If there are no commands set
-			if COMMANDS.empty?
-				out << "  ooops! commands are not here!"
-			else
-				# Get the longest command's name, so we can output it nice 'n' clean
-				# This '+ int' at the end is a distance (in spaces) from the longest
-				#                                            command to descriptions
-				longest = COMMANDS.max_by(&:size).size + 8
-				COMMANDS.each do |cmd|
-					# Calc, calc.
-					spaces = longest - cmd.size
-					# Check if there is a 'desc' method
-					desc = if eval "Command::#{cmd}.new.respond_to? 'desc'"
-						# If there is - execute it
-						eval "Command::#{cmd}.new.desc"
-					else
-						# If there is not
-						"---"
-					end
-					out << "  " << cmd.downcase.to_s << " " * spaces << desc
-					# If this command is the last one, don't make a new line
-					unless cmd == COMMANDS.last
-						out << "\n"
-					end
-				end
-			end
-			out
-		end # commands_list:Method
-		
-		# Check if command really exists
-		# 
-		# @return [Boolean] whether the command exists or not
-		def command_exists?
-			COMMANDS.include? @command
-		end
-		
-		# Rruns t'e Cli!
-		def run!
-			
-			# Nice, cool 'n' AWESOME --options parsing with Trollop[http://trollop.rubyforge.org/]!
-			# 
-			# @return [Hash] array full of options
-			$opts = Trollop::options do
-				version "shepherd version #{Version::STRING}"
-				banner <<-EOB
+module Shepherd 
+  
+  # Command Line Interface class
+  # 
+  # === Usage
+  # 
+  #     module Shepherd
+  #        Cli.new.run!
+  #     end
+  # 
+  # or
+  # 
+  #     Shepherd::Cli.new.run!
+  # 
+  # === Exit statuses
+  # 
+  # - *0* Everything went just fine :)
+  # - *1* User said ^C :]
+  # - *2* User wanted a UnknownCommand
+  # - *3* The database file was not found
+  # - *4* User wanted to init another sheep/project with the same name and/or path
+  # - *5* User wanted to init a project in a path that doesn't exist
+  # - *6* User wanted to see a sheep that was not inited
+  # 
+  class Cli
+    
+    # Kinda self explanatory
+    class UnknownCommand < RuntimeError; end
+    
+    # A command which is about to be run
+    attr_accessor :command
+    
+    # Require *all* command files
+    # TODO: Is it possible to make it use autoload? It'd be cool! :)
+    Dir[File.join(File.dirname(__FILE__), "commands", "*.rb")].each do |all_command_files|
+      require all_command_files
+    end
+    
+    # Handle the commands list
+    # 
+    # @return [Array] all available commands
+    COMMANDS = Command.constants.select { |c| Class === Command.const_get(c) }
+    
+    # Get a list of available commands to be printed. (Almost) every line is separated by new line mark - \n
+    # 
+    # @return [String] list of all available commands
+    def commands_list
+      out = ""
+      # If there are no commands set
+      if COMMANDS.empty?
+        out << "  ooops! commands are not here!"
+      else
+        # Get the longest command's name, so we can output it nice 'n' clean
+        # This '+ int' at the end is a distance (in spaces) from the longest
+        #                                            command to descriptions
+        longest = COMMANDS.max_by(&:size).size + 8
+        COMMANDS.each do |cmd|
+          # Calc, calc.
+          spaces = longest - cmd.size
+          # Check if there is a 'desc' method
+          desc = if eval "Command::#{cmd}.new.respond_to? 'desc'"
+            # If there is - execute it
+            eval "Command::#{cmd}.new.desc"
+          else
+            # If there is not
+            "---"
+          end
+          out << "  " << cmd.downcase.to_s << " " * spaces << desc
+          # If this command is the last one, don't make a new line
+          unless cmd == COMMANDS.last
+            out << "\n"
+          end
+        end
+      end
+      out
+    end # commands_list:Method
+    
+    # Check if command really exists
+    # 
+    # @return [Boolean] whether the command exists or not
+    def command_exists?
+      COMMANDS.include? @command
+    end
+    
+    # Rruns t'e Cli!
+    def run!
+      
+      # Nice, cool 'n' AWESOME --options parsing with Trollop[http://trollop.rubyforge.org/]!
+      # 
+      # @return [Hash] array full of options
+      $opts = Trollop::options do
+        version "shepherd version #{Version::STRING}"
+        banner <<-EOB
 usage: shep [options] <command>
   
 commands are:
@@ -104,40 +104,40 @@ commands are:
 options are:  
 EOB
 
-				opt :version, "show version and exit", :short => '-v'
-				opt :help, "show me and exit", :short => '-h'
-				
-				stop_on COMMANDS.collect { |e| e.downcase.to_s }
-			end
-			
-			# Get the command
-			@command = ARGV.shift.capitalize.to_sym
-			
-			begin
-				execute @command
-				exit 0
-			rescue UnknownCommand => e
-				puts e.message
-				exit 2
-			rescue Db::DatabaseNotFound => e
-				puts e.message
-				exit 3
-			rescue Interrupt
-				puts "\n\n!# interrupted"
-				exit 1
-			end
-		end # run!:Method
-		
-		# Executes a command
-		# 
-		# @return [Object] command to execute
-		# @raise [UnknownCommand] if there is no such a command
-		def execute command
-			if command_exists?
-				eval "Command::#{command}.new.init"
-			else
-				raise UnknownCommand, "Error: unknown command '#{command.downcase.to_s}'.\nTry --help for help."
-			end
-		end # execute_command:Method
-	end # Cli:Class
+        opt :version, "show version and exit", :short => '-v'
+        opt :help, "show me and exit", :short => '-h'
+        
+        stop_on COMMANDS.collect { |e| e.downcase.to_s }
+      end
+      
+      # Get the command
+      @command = ARGV.shift.capitalize.to_sym
+      
+      begin
+        execute @command
+        exit 0
+      rescue UnknownCommand => e
+        puts e.message
+        exit 2
+      rescue Db::DatabaseNotFound => e
+        puts e.message
+        exit 3
+      rescue Interrupt
+        puts "\n\n!# interrupted"
+        exit 1
+      end
+    end # run!:Method
+    
+    # Executes a command
+    # 
+    # @return [Object] command to execute
+    # @raise [UnknownCommand] if there is no such a command
+    def execute command
+      if command_exists?
+        eval "Command::#{command}.new.init"
+      else
+        raise UnknownCommand, "Error: unknown command '#{command.downcase.to_s}'.\nTry --help for help."
+      end
+    end # execute_command:Method
+  end # Cli:Class
 end # Shepherd:Module