kit 0.0.5 → 0.0.6

data/README

@@ -1,26 +1,52 @@
 = Kit
 
-Kit is a framework for making simple management tools called kits.
+Kit is a framework for making simple management tools called kits. Read about why I wrote kit below for an idea of what Kit can do for you.
 
-* Kit is brand new and still very much under construction (a lot of which still included documentation such as this README file).
-* The gem includes a skeleton kit for managing web projects: clone, deploy upgrades, and push git updates to your web apps.
+== What is Kit?
+
+Kit's in it's infant stage and still changing too much to document everything it does or will do. The best way to understand what Kit is about is to read the motivation behind it (see below). Of course, you can always read the yard docs or source code if you want to see how it's coming.
+
+=== Why I wrote kit
+
+Here are two independent problems Kit will solve (each will be a separate kit).
+
+==== Apache server running multiple virtual hosts (vhosts)
+
+* Each time a vhost is added things have to happen, e.g. config files need to be made, directories created, etc.
+* Depending on the type of vhost, these tasks may be different e.g. what directories are made, how the conifg files look, etc.
+* If vhosts are removed or moved from one type to another, things need to be archived, cleaned up, etc.
+* If the config file template changes, etc., the vhosts should all get updated.
+
+==== Web development server-side site management
+
+Unless you're strictly using a development framework, testing and deploying new code is non-trivial. Exporting your code from your git repo may be more complicated then running cp -R, e.g. compressing JavaScript and CSS. Sometimes, the only place to test a project on is in production environment . I needed a tool that made testing and updating a site running a mix of differnt web software, i.e.
+
+* Clone my production site to one of many testing sites.
+* Push update packages to any of the production or testing sites.
+* Push a git branch to any of the production or testing sites.
+* Allow other developers access to all of these functions without giving them shell access or elevated user privileges.
+
+== Building your own kit
+
+For instructions on how to build your own kit go to
+* https://github.com/razor-x/kit/wiki/Building-your-own-kit
 
 == Installation
 
 === Gem Installation
 
-Download and install kit with the following.
+Download and install Kit with the following.
 
-   gem install kit
+ gem install kit
 
 == Development
 
 === Source Repository
 
-kit is currently hosted at github. The github web page is
-https://github.com/razor-x/kit. The public git clone URL is
+Kit is currently hosted at github. The github web page is
+https://github.com/razor-x/kit. To clone the project run
 
-* git://github.com/razor-x/kit.git
+  git clone git://github.com/razor-x/kit.git
 
 == License
 

data/kits/my_kit/bit.rb

@@ -1,17 +1,34 @@
 class Bit
 
+	def lookup_id uniq
+		@@db.select_info_by_criteria :bits, [:rowid], uniq
+	end
+
 	def insert_new
-		@project_id = insert_new_project unless @project_id
 
-		data = { :name => @name, :project => @project_id, :root => @root, :commit => nil, :commit_time => nil }
+		if @project_id.nil?
+
+			p = @@db.select_info_by_name :projects, [ :rowid ], @project_name
+
+			@project_id = if p.nil? then insert_new_project else p[:rowid] end
+
+		end
+
+		uniq = { :name => @name, :project => @project_id }
+		data = { :root => @root, :commit => nil, :commit_time => nil }
+
+		fail DuplicateElement if lookup_id uniq
+
+		data.merge! uniq
+
 		@@db.insert_info :bits, data
 	end
 
 	def insert_new_project
 
-		fail DuplicateAttr if @@db.select_info_by_name :projects, [ :name ], @project_name
+		fail DuplicateElement if @@db.select_info_by_name :projects, [ :name ], @project_name
 
-		data = { :project => @project_name, :git => @git }
+		data = { :name => @project_name, :git => @git }
 		@@db.insert_info :projects, data
 	end
 
@@ -19,6 +36,8 @@ class Bit
 
 		info = @@db.select_info_by_id :bits, @@info[:bits], @id
 
+		fail NoElement unless info
+
 		@name = info[:name]
 		@project_id = info[:project]
 

data/kits/my_kit/clones/my_project.rb

@@ -2,7 +2,6 @@ module Actions
 
 	def clones options
 		src = Bit.new options[:src]
-# 		fail ProjectMismatch unless @project_id == src.project_id
 		puts "cloning #{src.project_name}.#{src.name} to #{@project_name}.#{@name}"
 	end
 

data/kits/my_kit/config.yml

@@ -27,10 +27,10 @@
   :projects: [ :rowid, :name, :git ]
 #
 # Each table in the :actions: database must be of the form
-#   :table_name: [ :rowid, :status, :column_name_1, :column_name_2 ]
-# where :rowid and :status are required columns.
+#   :table_name: [ :rowid, :bit, :status, :column_name_1, :column_name_2 ]
+# where :rowid, :bit, and :status are required columns.
 #
 :actions:
-  :clones: [ :rowid, :status, :src, :site ]
-  :upgrades: [ :rowid, :status, :site, :component, :file ]
-  :commits: [ :rowid, :status, :site, :requested_commit ]
+  :clones: [ :rowid, :bit, :status, :src ]
+  :upgrades: [ :rowid, :bit, :status, :component, :file ]
+  :commits: [ :rowid, :bit, :status, :commit ]

data/kits/my_kit/sqlite3_actions.sql

@@ -12,5 +12,5 @@ CREATE TABLE upgrades (
 CREATE TABLE commits (
 	"bit" INTEGER NOT NULL,
 	"status" TEXT NOT NULL DEFAULT ('pending'),
-	"requested_commit" TEXT
+	"commit" TEXT
 );

data/lib/kit.rb

@@ -1,11 +1,13 @@
-class Kit
+require 'yaml'
 
+class Kit
+	# Loads the settings for the kit.
+	# @param [String, Hash] config path to kit config file or hash of kit settings
 	def initialize config
 
 		config = load_config_file config if File.exists? config
 
-		fail StandardError unless config.is_a? Hash
-		fail StandardError unless config[:kits_path]
+		fail "No path to kit set" unless config[:kits_path]
 
 		@@kit_path = config[:kits_path]
 
@@ -21,64 +23,100 @@ class Kit
 		@@actions = config[:actions]
 	end
 
+	def action_types
+		@@actions.keys
+	end
+
+	# Converts a kit config file into a hash of kit settings.
+	# @param [String] file path to a kit config file in yaml format
+	# @return [Hash] kit settings
 	def load_config_file file
 
 		config = YAML.load File.read file
 		@@config_path = File.absolute_path File.dirname file
 
 		dir = config[:kits_path]
-		if config[:kits_path].nil?
-			dir = @@config_path
-		else
-			dir = File.absolute_path @@config_path + config[:kits_path] unless [ "/", "~" ].include? config[:kits_path][0]
-		end
+		dir = if config[:kits_path].nil?
+						@@config_path
+					else
+						File.absolute_path @@config_path + config[:kits_path] unless [ "/", "~" ].include? config[:kits_path][0]
+					end
 
 		config[:kits_path] = dir
 		return config
 	end
 
+	# Deletes the kit's databases
 	def delete_dbs
 		@@db.db_paths.each do |key, f|
 			File.delete f
 		end
 	end
 
+	# Creates bit object if it is unique enough.
+	# @param [Hash] info requested initial properties of the bit
+	# @return [Bit, nil] the new bit or nil if too similar to a bit that already exists
 	def add_bit info
-		Bit.new info
+		begin
+			Bit.new info
+		rescue Bit::DuplicateElement
+			nil
+		end
+	end
+
+	def get_bit info
+		begin
+			if info.is_a? Integer
+				Bit.new info
+			elsif info_is_a? Hash
+				Bit.new Bit::lookup_id info
+			end
+		rescue NoElement
+			nil
+		end
 	end
 
+	# Adds a new task to the corresponding action table.
+	# @param [Symbol] action name of the action type
+	# @param [Hash] options options for the corresponding action type
 	def add_task action, options
 		fail NoAction unless @@actions.include? action
 		@@db.insert_action action, options
 	end
 
+	# Runs all pending tasks.
 	def run_tasks
-
 		collect_tasks_by_bit.each do |bit, tasks|
-			s = Bit.new bit
+			b = Bit.new bit
 
 			actions = tasks.group_by { |t| t[:action] } . keys
 
 			actions.each do |a|
-				load @@kit_path + "/#{a}/#{s.project_name}.rb"
-				s.extend Actions
+				load @@kit_path + "/#{a}/#{b.project_name}.rb"
+				b.extend Actions
 			end
 
 			tasks.each do |t|
-				s.add_task t
+				b.queue_task t
 			end
 
-			s.run_all
-
+			b.run_all
+			# TODO try and use yields here to set status to running and then complete / failed as each task runs and finishes
 		end
 	end
 
+	def get_tasks_by_status action, status
+		@@db.select_all_actions_by_status action, @@actions[action], status
+	end
+
 	private
+	# Gets all tasks and groups them by bit.
+	# @return [Hash{Integer => Hash}] tasks grouped by bit id
 	def collect_tasks_by_bit
 
 		tasks = []
 		@@actions.each_key do |action|
-			tasks.push @@db.select_all_actions_by_status action, @@actions[action], :pending
+			tasks.push get_tasks_by_status action, :pending
 		end
 		tasks.flatten!
 
@@ -90,4 +128,4 @@ class Kit
 
 end
 
-require 'kit/bit'
+require 'kit/bit'

data/lib/kit/bit.rb

@@ -2,19 +2,22 @@ class Bit < Kit
 
 	attr_reader :id
 
+	# Loads all bit info from database, or attempts to add new bit to database
+	# @param [Integer, Hash] info id of bit or info for new bit
 	def initialize info
 
-		if info.is_a? Integer
-			@id = info
-		else
-			make_ivars info
-			@id = insert_new
-		end
+		@id = if info.is_a? Integer
+						info
+					else
+						make_ivars info
+						insert_new
+					end
 
 		load_info
 
 	end
 
+	# Sets instance variables for each key => value pair
 	def make_ivars hash
 		hash.each do |ivar, val|
 			self.class.send :attr_accessor, ivar unless respond_to? ivar
@@ -23,57 +26,43 @@ class Bit < Kit
 	end
 
 	# Add a task to the array of pending tasks in @tasks.
-	#
-	# ==== Attributes
-	#
-	# * +task+ - Hash that describes the task. Must contain the keys :rowid and :action.
-	#
-	# ==== Examples
-	#
-	# Adding a task to clone site 2 from site 1
-	#
-	#    s = Site.new 42
-	#    t = {:rowid=>1, :src=>1, :site=>2, :action=>:clones}
-	#    s.add_task t
-	def add_task task
+	# @param [Hash] task info for task
+	def queue_task task
 		@tasks = [] unless @tasks
 		@tasks << task
 	end
 
-	# Removes a task from list of pending tasks in @tasks
-	#
-	# ==== Attributes
-	#
-	# * +task+ - Hash that describes the task. Must contain the keys :rowid and :action.
-	#
-	# ==== Examples
-	#
-	# Removing a task to clone site 2 from site 1
-	#
-	#    s = Site.new 42
-	#    t = {:rowid=>1, :src=>1, :site=>2, :action=>:clones}
-	#    s.clear_task t
 	def clear_task task
-
-		action = task[:action]
-		id = task[:rowid]
-
-		@@db.delete_action_by_id action, id
+# 		action = task[:action]
+# 		id = task[:rowid]
+#
+# 		@@db.delete_action_by_id action, id
 	end
 
-	# Runs all tasks in the list of pending tasks in @tasks. Removes the task on sucess or BadTask.
+	# Runs all tasks in the list of pending tasks in @tasks and returns the status of each run task.
+	# @return [Hash] key is task id
 	def run_all
-
 		tasks = @tasks
-
+		status = {}
 
 		tasks.each do |t|
-			self.send t[:action], t
-			clear_task t
+			a = t[:action]
+			begin
+				self.send a, t
+				status[a] = "complete"
+			rescue
+				status[a] = "failed"
+			end
+			status
 		end
+
+
+	end
+
+	class DuplicateElement < RuntimeError
 	end
 
-	class DuplicateAttr < RuntimeError
+	class NoElement < RuntimeError
 	end
 
 end

data/lib/kit/db_sqlite3.rb

@@ -1,23 +1,51 @@
 require 'sqlite3'
 
+# Methods to make sqlite3 interation more consice
 module SQLite3Tools
 	class ::Array
+		# Converts an array of symbols to a string of backquoted strings for use in SELECT statement
+		# @return [String]
+		# @example
+		#  a = [ :col_1, :col_2 ]
+		#  a.sqlite3_to_str #=> "`col_1`, `col_2`"
 		def sqlite3_to_str
 			self.map { |sym| "`" + sym.to_s + "`" }.join(", ")
 		end
+
+		# Converts an sqlite3 result array to a hash.
+		# @param keys [Array]
+		# @return [Hash]
+		# @example
+		#  a = [ "val_1", 42 ]
+		#  k = [ :col_1, :col_2 ]
+		#  a.to_hash k #=> { :col_1 => "val_1", :col_2 => 42 }
+		def to_hash keys
+			Hash[ *( 0...self.size ).inject( [] ) { |arr, ix| arr.push( keys[ix], self[ix] ) } ]
+		end
 	end
 
-	class ::Array
-		def to_hash other
-			Hash[ *( 0...self.size() ).inject( [] ) { |arr, ix| arr.push( other[ix], self[ix] ) } ]
+	class ::Integer
+		# Generates placeholder string for INSERT statements.
+		# @return String placeholder
+		# @example
+		#  3.make_placeholders #=> "?, ?, ?"
+		def make_placeholders
+			n = self - 1
+			placeholders = "?"
+			n.times { placeholders << ", ?" }
+			placeholders
 		end
 	end
 
 	class SQLite3::Database
+		# Selects given columns using given query and converts results to to hashes.
+		# @param [Array<Symbol>] columns names of columns to select
+		# @param [String] query sqlite3 query fragment to append to SELECT part of query
+		# @return [Array<Hash>] results with each row a hash in :col => value form
 		def select columns, query
 			result = [];
 			self.execute "SELECT #{columns.sqlite3_to_str} #{query}" do |row|
-				result.push ( row.to_hash columns )
+				result.push row.to_hash columns
 			end
 			result
 		end
@@ -30,6 +58,7 @@ class Backend < Kit
 
 	attr_reader :db_paths
 
+	# (see #db_prepare)
 	def initialize db_paths
 		db_paths.each do |key, db|
 			name = File.basename db
@@ -46,8 +75,13 @@ class Backend < Kit
 	end
 
 	private
+	# Loads existing database files or creates new ones with kit database schema
+	# @param [Hash] db_paths absolute or relitive paths to database files
 	def db_prepare db_paths
 
+		# Makes kit database schema
+		# @param [Symbol] type name of database
+		# @param db [SQLite3::Database] database object to load schema into
 		def db_initialize type, db
 			sql = File.read @@kit_path + "/sqlite3_#{type}.sql"
 			db.execute_batch sql
@@ -79,14 +113,6 @@ class Backend < Kit
 
 	end
 
-	private
-	def make_placeholders n
-		n = n - 1
-		placeholders = "?"
-		n.times { placeholders << ", ?" }
-		placeholders
-	end
-
 	public
 	def select_all_actions_by_status action, fields, status
 		query = "FROM `#{action}` WHERE `status` = '#{status}'"
@@ -97,7 +123,8 @@ class Backend < Kit
 	end
 
 	def insert_action table, data
-		@action_db.execute "INSERT INTO #{table} VALUES ( ?, #{make_placeholders data.length} )", ( data.values.insert 1, "pending" )
+		data.merge! ( { :status => "pending" } )
+		@action_db.execute "INSERT INTO #{table} ( `#{data.keys.join "`, `"}` ) VALUES ( #{data.length.make_placeholders} )", data.values
 		@action_db.last_insert_row_id
 	end
 
@@ -115,8 +142,19 @@ class Backend < Kit
 		info.first
 	end
 
+	def select_info_by_criteria table, fields, criteria
+
+		q = []
+		criteria.each do |key, value|
+			q << "`#{key}` = '#{value}'"
+		end
+
+		info = @info_db.select fields, "FROM `#{table}` WHERE #{q.join " AND "}"
+		info.first
+	end
+
 	def insert_info table, data
-		@info_db.execute "INSERT INTO #{table} VALUES ( #{make_placeholders data.length} )", data.values
+		@info_db.execute "INSERT INTO #{table} ( `#{data.keys.join "`, `"}` ) VALUES ( #{data.length.make_placeholders} )", data.values
 		@info_db.last_insert_row_id
 	end
 end

data/spec/my_kit_spec.rb

@@ -8,7 +8,7 @@ describe Kit do
 		@kit = Kit.new MY_KIT_CONFIG
 	end
 
-	it "adds a new bit" do
+	it "adds a new bit to new project" do
 		new_bit = { :name => "live", :project_name => "my_project", :root => "./my_kit_spec/my_project", :git => "git path" }
 		b = @kit.add_bit new_bit
 
@@ -19,6 +19,46 @@ describe Kit do
 		end
 	end
 
+	it "doen not add a existing bit to project" do
+		new_bit = { :name => "live", :project_name => "my_project", :root => "./my_kit_spec/my_project/live" }
+		b = @kit.add_bit new_bit
+
+		b.should == nil
+
+	end
+
+	it "adds a new task of each type" do
+
+# 		old_bit = { :name => "live", :project_name => "my_project" }
+# 		puts Kit::Bit.lookup_id old_bit
+
+		new_bit_2 = { :name => "beta", :project_name => "my_project", :root => "./my_kit_spec/my_project/beta" }
+		b = @kit.add_bit new_bit_2
+
+		actions = {
+			:clones => { :bit => 1, :src => 2 },
+			:upgrades => { :bit => 1, :component => "my_component", :file => "my_file" },
+			:commits => { :bit => 1, :commit => "3456ABF" }
+		}
+
+		tasks = {}
+		actions.each do |key, value|
+			tasks[key] = @kit.add_task key, value
+		end
+
+		@kit.action_types.each do |t|
+			a = @kit.get_tasks_by_status t, :pending
+			actions[t].merge! ( { :rowid => tasks[t], :action => t, :status => "pending" } )
+			a.first.should == actions[t]
+		end
+
+	end
+
+	it "runs added tasks" do
+		@kit.run_tasks
+	end
+
+
 	after :all do
 		@kit.delete_dbs
 	end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Evan Boyd Sosenko
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 -07:00
+date: 2011-05-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,21 +32,6 @@ dependencies:
         version: 1.3.3
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: yaml
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        - 3
-        version: 1.3.3
-  type: :runtime
-  version_requirements: *id002
 description: "\t\tKit is a framework for making simple management tools called kits. Includes a skeleton kit for managing web projects: clone, deploy upgrades, and push git updates to your web apps.\n"
 email: 
 executables: []
@@ -56,19 +41,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/kit.rb
 - lib/kit/bit.rb
 - lib/kit/db_sqlite3.rb
-- lib/kit.rb
 - README
-- kits/my_kit/commits/my_project.rb
-- kits/my_kit/clones/my_project.rb
-- kits/my_kit/config.yml
-- kits/my_kit/sqlite3_actions.sql
-- kits/my_kit/bit.rb
 - kits/my_kit/sqlite3_info.sql
 - kits/my_kit/upgrades/my_project.rb
-- spec/my_kit_spec.rb
+- kits/my_kit/sqlite3_actions.sql
+- kits/my_kit/bit.rb
+- kits/my_kit/config.yml
+- kits/my_kit/commits/my_project.rb
+- kits/my_kit/clones/my_project.rb
 - spec/my_kit/my_kit.yml
+- spec/my_kit_spec.rb
 has_rdoc: true
 homepage: 
 licenses: