shepherd 0.1.0 → 0.1.2

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc/*
+spec/*

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# shepherd 0.1.2 (18-07-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)
+
++ Ease in creating your own commands!
++ Let be t'e `Cli`!
+
+# shepherd 0.1.0 (18-06-2011)
+
++ Birthday!

data/Gemfile

@@ -1,13 +1,3 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+source :gemcutter
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.6.1"
-  gem "rcov", ">= 0"
-end
+gemspec

data/README.md

@@ -1,13 +1,40 @@
-# Shepherd
+Shepherd
+========
 
-**Homepage**         [http://semahawk.github.com/shepherd](http://semahawk.github.com/shepherd)    
-**Author**           Szymon Urbaś <szymon.urbas@yahoo.com>    
-**Copyright**        2011    
-**License**          MIT License    
-
-**Latest version**   0.1.0    
-**Stage**            *Development*    
-**Release date**     June 9th, 2011    
+<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> </td>		
+		<td> </td>		
+	</tr>
+	<tr>
+		<td><b>Latest version</b></td>
+		<td>0.1.1</td>
+	</tr>
+	<tr>
+		<td><b>Release date</b></td>
+		<td>July 4th, 2011</td>
+	</tr>
+	<tr>
+		<td><b>Stage</b></td>
+		<td><i>Development</i></td>
+	</tr>
+</table>
 
 ## A bit about
 
@@ -16,13 +43,13 @@ You just know, if your project got few kilobytes more on weight, how many more f
 
 ## Features
 
-* Existence, at the moment :D
++ Easy own command creation.
+
+## Dependencies
 
-But the ideas are:
++ [sqlite3](http://rubygems.org/gems/sqlite3) (~> 1.3.0)
 
-* Files, lines and characters counting
-* Uh.. Emm...
-* Yeah..
+Shepherd also uses `cat` and `wc` UNIX commands, so if you are on UNIX(-like) system there should be no problem.
 
 ## Oh, NO - a BUG!
 

data/Rakefile

@@ -1,54 +1 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-require './lib/shepherd/version'
-Jeweler::Tasks.new do |gem|
-  gem.name = "shepherd"
-  gem.homepage = "http://github.com/semahawk/shepherd"
-  gem.license = "MIT"
-  gem.summary = %Q{Be a shepherd to your projects!}
-  gem.description = %Q{*BETA* Be a shepherd to your projects! Check out whether they grow up, get larger or something-else-shepherds-do!}
-  gem.version = Shepherd::Version::STRING
-  gem.email = "szymon.urbas@yahoo.com"
-  gem.authors = ["Szymon Urbaś"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "shepherd #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler/gem_tasks'

data/bin/shep

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+# Add the lib directory to $LOAD_PATH
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+# Require needed files
+require 'shepherd'
+require 'shepherd/cli'
+
+# We make the --help option the default (if no command passed, show help)
+ARGV << '--help' if ARGV.empty? && $stdin.tty?
+
+# Run Shepherd, ruuun!
+Shepherd::Cli.new.run!

data/lib/shepherd/cli.rb

@@ -0,0 +1,121 @@
+require "trollop"
+
+module Shepherd	
+	
+	# Command Line Interface class
+	class Cli
+		
+		# Kinda self explanatory
+		class UnknownCommand < RuntimeError; end
+		
+		# A command which is about to be run
+		attr_accessor :command
+		
+		# Require *all* command files
+		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
+						"~ no description provided ~"
+					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
+		
+		# 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 be t'e version #{Version::STRING}"
+				banner <<-EOB
+usage: shep [options] <command>
+  
+commands are:
+  
+#{Cli.new.commands_list}
+  
+  shep <command> --help for more info about specified command
+  
+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 1
+			rescue Db::DatabaseNotFound => e
+				puts e.message
+				exit 1
+			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

data/lib/shepherd/command.rb

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

data/lib/shepherd/commands/init.rb

@@ -0,0 +1,51 @@
+module Shepherd::Command
+	class Init
+		def init
+			@opts = Trollop::options do
+				banner <<-EOB
+usage: shep [options] init [-h|--help]
+
+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
+			
+			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!
+
+   path: \e[1;34m#{@state[:path]}\e[0;0m
+   name: \e[1;32m#{@state[:name]}\e[0;0m
+  
+  state: #{@state[:files].size} files
+         #{@state[:lines]} lines
+         #{@state[:chars]} chars
+         
+         #{@state[:bytes]} (#{@state[:rawbytes]} bytes)
+  
+" unless @opts[:quiet]
+
+			# TODO: save to database
+			# Shepherd::Db.new.execute "inserting query"
+		end
+		
+		def desc
+			"initialize a new project"
+		end
+	end
+end

data/lib/shepherd/counter.rb

@@ -0,0 +1,140 @@
+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
+		
+		# 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)
+		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
+		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 rawbytes
+			@rawbytes = 0
+			@files.each do |file|
+				@rawbytes += 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
+		end
+	end
+end

data/lib/shepherd/db.rb

@@ -0,0 +1,40 @@
+require "sqlite3"
+
+module Shepherd
+	
+	# A class through which you can connect to the database.
+	# 
+	# == Usage
+	# 
+	#     module Shepherd
+	#        Db.new.execute "sql query"
+	#     end
+	# 
+	# Inside a +Shepherd::Command::Klass+, it would look like:
+	# 
+	#     module Shepherd::Command
+	#        class Klass
+	#           def init
+	#              Shepherd::Db.new.execute "sql query"
+	#           end
+	#        end
+	#     end
+	# 
+	# Here is {SQLite3 documantation}[http://sqlite-ruby.rubyforge.org/sqlite3/faq.html]. +Shepherd::Db.new+ is equal to +SQLite3::Database.new+ so there you've got a complete documentation.
+	# 
+	class Db
+		
+		# When the database file was not found
+		class DatabaseNotFound < RuntimeError; end
+		
+		def initialize
+			raise DatabaseNotFound, "Error: database file not found: '#{Dir.home}/.shepherd/herd.db'\nTry running 'shep setup'." unless File.exists? "#{Dir.home}/.shepherd/herd.db"
+			# A new instance of +SQLite3::Database+
+			@db = SQLite3::Database.new "#{Dir.home}/.shepherd/herd.db"
+		end
+		
+		def method_missing m, *args, &block
+			@db.send m, *args, &block
+		end
+	end
+end

data/lib/shepherd/version.rb

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

data/lib/shepherd.rb

@@ -0,0 +1,9 @@
+module Shepherd
+	ROOT = File.expand_path(File.dirname(__FILE__))
+	
+	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"
+end