shepherd 0.1.2 → 0.1.3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# shepherd 0.1.3 (18-09-2011)
+
++ Now we can `show` some sheeps!
++ `init` command now saves the inited projects!
++ Provide setup utility.
+
 # shepherd 0.1.2 (18-07-2011)
 
 + Make the `Counter` class

data/README.md

@@ -24,11 +24,11 @@ Shepherd
 	</tr>
 	<tr>
 		<td><b>Latest version</b></td>
-		<td>0.1.1</td>
+		<td>0.1.3</td>
 	</tr>
 	<tr>
 		<td><b>Release date</b></td>
-		<td>July 4th, 2011</td>
+		<td>September 18th, 2011</td>
 	</tr>
 	<tr>
 		<td><b>Stage</b></td>

data/lib/shepherd.rb

@@ -1,9 +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
 end

data/lib/shepherd/cli.rb

@@ -3,6 +3,27 @@ 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
@@ -12,6 +33,7 @@ module Shepherd
 		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
@@ -43,7 +65,7 @@ module Shepherd
 						eval "Command::#{cmd}.new.desc"
 					else
 						# If there is not
-						"~ no description provided ~"
+						"---"
 					end
 					out << "  " << cmd.downcase.to_s << " " * spaces << desc
 					# If this command is the last one, don't make a new line
@@ -53,7 +75,7 @@ module Shepherd
 				end
 			end
 			out
-		end
+		end # commands_list:Method
 		
 		# Check if command really exists
 		# 
@@ -69,7 +91,7 @@ module Shepherd
 			# 
 			# @return [Hash] array full of options
 			$opts = Trollop::options do
-				version "Shepherd be t'e version #{Version::STRING}"
+				version "shepherd version #{Version::STRING}"
 				banner <<-EOB
 usage: shep [options] <command>
   
@@ -77,7 +99,7 @@ commands are:
   
 #{Cli.new.commands_list}
   
-  shep <command> --help for more info about specified command
+  shep <command> --help/-h for more info about specified command
   
 options are:  
 EOB
@@ -96,12 +118,12 @@ EOB
 				exit 0
 			rescue UnknownCommand => e
 				puts e.message
-				exit 1
+				exit 2
 			rescue Db::DatabaseNotFound => e
 				puts e.message
-				exit 1
+				exit 3
 			rescue Interrupt
-				puts "\n\n~> interrupted"
+				puts "\n\n!# interrupted"
 				exit 1
 			end
 		end # run!:Method

data/lib/shepherd/commands/init.rb

@@ -5,6 +5,15 @@ module Shepherd::Command
 				banner <<-EOB
 usage: shep [options] init [-h|--help]
 
+examples:
+  cd /my/awesome/program
+  shep init                              # name of that sheep would be 'program'
+  
+  shep init --path /my/awesome/program   # here as well
+  
+  shep init --path /my/awesome/program\\
+            --name yay                   # it's would be 'yay'
+
 options are:
 EOB
 				opt :path, "a root path to the project", :default => Dir.pwd
@@ -19,29 +28,40 @@ EOB
 			# 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
-				@state[:rawbytes] = count.rawbytes
 			end
 			
-			puts "Our brave-hearted Shepherd initializes a new project!
+			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
   
-  state: #{@state[:files].size} files
+  state: #{@state[:files]} files
          #{@state[:lines]} lines
          #{@state[:chars]} chars
          
-         #{@state[:bytes]} (#{@state[:rawbytes]} bytes)
+         #{Shepherd::Utils.nice_bytes(@state[:bytes])} (#{@state[:bytes]} bytes)
   
 " unless @opts[:quiet]
-
-			# TODO: save to database
-			# Shepherd::Db.new.execute "inserting query"
+			
+			Shepherd::Db.new.execute "insert into sheeps(id, name, path, files, lines, chars, bytes, inited_at) values(NULL, ?, ?, ?, ?, ?, ?, datetime())", @state[:name], @state[:path], @state[:files], @state[:lines], @state[:chars], @state[:bytes]
 		end
 		
 		def desc

data/lib/shepherd/commands/show.rb

@@ -0,0 +1,52 @@
+module Shepherd::Command
+	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)
+
+"
+						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]}
+   
+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
+end

data/lib/shepherd/counter.rb

@@ -50,34 +50,6 @@ module Shepherd
 			yield self if block_given?
 		end
 		
-		# Convert bytes into more human readable format.
-		# Found nice resolution here[http://www.ruby-forum.com/topic/119703] which was originally written by {Jeff Emminger}[http://www.ruby-forum.com/user/show/jemminger] and I just add this part to automaticly set the unit. Thank you!
-		# 
-		# @param [Integer] number a number to be formatted
-		# @return [String] a formatted number
-		def nice_bytes number
-			units = {:b => 1,
-						:kb => 2**10,
-						:mb => 2**20,
-						:gb => 2**30,
-						:tb => 2**40}
-			
-			unit = :b
-			case number
-				when 1...2**10
-					unit = :b
-				when 2**10...2**20
-					unit = :kb
-				when 2**20...2**30
-					unit = :mb
-				when 2**30...2**40
-					unit = :gb
-				when 2**40...2**50
-					unit = :tb
-			end
-			"#{sprintf("%.#{0}f", number / units[unit.to_s.downcase.to_sym])} #{unit.to_s.upcase}"
-		end
-		
 		# Count the files (excluding dotfiles).
 		# 
 		# @return [Array] list of all files (dotfiles are not included)
@@ -94,7 +66,7 @@ module Shepherd
 					@files << path
 				end
 			end
-			@files
+			@files.size
 		end
 		
 		# Count the lines.
@@ -122,19 +94,12 @@ module Shepherd
 		# Count the bytes. This *wont* be converted all the time.
 		# 
 		# @return [Integer] bytes amount
-		def rawbytes
-			@rawbytes = 0
+		def bytes
+			@bytes = 0
 			@files.each do |file|
-				@rawbytes += File.new("#{file}").size
+				@bytes += File.new("#{file}").size
 			end
-			@rawbytes
-		end
-		
-		# Count the bytes. This *will* be formatted into something like: 2898 KB
-		# 
-		# @return [String] formatted bytes
-		def bytes
-			@bytes = nice_bytes rawbytes
+			@bytes
 		end
 	end
 end

data/lib/shepherd/setup.rb

@@ -0,0 +1,37 @@
+require "fileutils"
+
+module Shepherd
+	class Setup
+		def initialize
+			@schema = <<-EOS
+create table if not exists sheeps (
+	id integer primary key autoincrement,
+	name varchar(128) not null,
+	path varchar(256) not null,
+	files integer(6) not null,
+	lines integer(7) not null,
+	chars integer(10) not null,
+	bytes integer(10) not null,
+	inited_at datetime not null
+);
+EOS
+
+			crdir "#{Dir.home}/.shepherd"
+			crfile "#{Dir.home}/.shepherd/herd.db"
+			puts "[shep] setup: making a real database: #{Dir.home}/.shepherd/herd.db"
+			Db.new.execute "#{@schema}"
+			exit 0
+		end
+		
+		private
+			def crdir dir
+				puts "[shep] setup: creating dir:  #{dir}"
+				::FileUtils.mkdir "#{Dir.home}/.shepherd"
+			end
+			
+			def crfile file
+				puts "[shep] setup: creating file: #{file}"
+				::FileUtils.touch "#{Dir.home}/.shepherd/herd.db"
+			end
+	end
+end

data/lib/shepherd/utils.rb

@@ -0,0 +1,60 @@
+module Shepherd
+	module Utils
+		def yes? msg = "Would you like to proceed?"
+			print "#{msg} [Yn]: "
+			case $stdin.gets
+			when /(y|yes)/i
+				true
+			when "\n"
+				true
+			when /(n|no)/i
+				false
+			else
+				false
+			end
+		end # yes?:Method
+		
+		# Convert bytes into more human readable format.
+		# I have found nice resolution here[http://www.ruby-forum.com/topic/119703]
+		#  which was originally written by Jeff Emminger and I just add this part
+		#  to automaticly set the unit. Thank you, Jeff!
+		# 
+		# @param [Integer] number of bytes to be formatted
+		# @return [String] a formatted number with the unit appended to it
+		def self.nice_bytes number
+			units = {:b => 1,
+						:kb => 2**10,
+						:mb => 2**20,
+						:gb => 2**30,
+						:tb => 2**40}
+			
+			unit = :b
+			case number
+				when 1...2**10
+					unit = :b
+				when 2**10...2**20
+					unit = :kb
+				when 2**20...2**30
+					unit = :mb
+				when 2**30...2**40
+					unit = :gb
+				when 2**40...2**50
+					unit = :tb
+			end
+			"#{sprintf("%.#{0}f", number / units[unit.to_s.downcase.to_sym])} #{unit.to_s.upcase}"
+		end
+	end
+end
+
+class Integer
+	def to_nice
+		s = self.to_s
+
+		if s.include? ?.
+			pre, post = s.split '.'
+			"#{pre.reverse.gsub( /\d{3}(?=\d)/, '\&,' ).reverse}.#{post}"
+		else
+			s.reverse.gsub( /\d{3}(?=\d)/, '\&.' ).reverse
+		end
+	end
+end

data/lib/shepherd/version.rb

@@ -2,7 +2,7 @@ module Shepherd
 	module Version
 		MAJOR = 0
 		MINOR = 1
-		PATCH = 2
+		PATCH = 3
 		BUILD = nil
 
 		STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join "."

metadata

@@ -2,7 +2,7 @@
 name: shepherd
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - "Szymon Urba\xC5\x9B"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-18 00:00:00 Z
+date: 2011-09-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sqlite3
@@ -66,8 +66,11 @@ files:
 - lib/shepherd/cli.rb
 - lib/shepherd/command.rb
 - lib/shepherd/commands/init.rb
+- lib/shepherd/commands/show.rb
 - lib/shepherd/counter.rb
 - lib/shepherd/db.rb
+- lib/shepherd/setup.rb
+- lib/shepherd/utils.rb
 - lib/shepherd/version.rb
 - lib/trollop.rb
 - shepherd.gemspec