charter 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8499a80980f057511a5cbd8101f51bce30c9d50
-  data.tar.gz: 6dd597907ebb88b07b8658e957c6d2a4ceaae7c3
+  metadata.gz: a085bd115b8f668232dee0033a4176e4e1a284f3
+  data.tar.gz: 202b620213f13ba5268144a409c0fe21cea6cb26
 SHA512:
-  metadata.gz: b29d08eb2bfb19895512eaaf3b85acb0818e61426d3152b15390a36d1e5745d9cd98e669d38b8a1240cb1608f73cad6da6dfbba17910bb742dc96c37d3071767
-  data.tar.gz: 035ab19ea04d67b0a3ad76f3f6def1d7d709405f422c8d359b8533dd105bac3e4a616cbfb3ff211720d8b8139a3376d0ed600956035c8a7ee7d9dcd2c82fb6a4
+  metadata.gz: 5bcb0d03e7e0d2484f4b136b9f48e545e8f5d2d962ee043cc98732367eb07c96b8f5fd033b43986044ebf88d6fe4405acecd90e5e27ece86a39cc51be9fa13e4
+  data.tar.gz: a21a2ff6486a299dd7f09a92745496fe3bd0b238db99d1895cbb235b8e07b9b335ced0f6f780989496cca561e6818ea20102db95e775a407f263ecee42bf8a43

data/README.md

@@ -35,8 +35,18 @@ This will create a new charter in the specified folder specified in your ~/.char
 
 This will removing any remaining place holders and fill in the end time
 
-##The finished charter will look something like this:
----
+####Known Issues
+  -Currently, Charter only works on OS X/Linux
+  -Bug screenshot option only works on OS X  
+
+####TODO:
+- Refine code structure
+- <del>Release to RubyGems.org</del>
+- Add more fields to charter
+- Add optional fields
+
+
+##The finished charter will look something like this:  
 
 #Exploratory Test Charter
 
@@ -64,9 +74,3 @@ Mark Grossman
 1. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.  
 
 ---
-
-####TODO:
-  - Refine code structure
-  - Release to RubyGems.org
-  - Add more fields to charter
-  - Add optional fields

data/bin/charter

@@ -14,7 +14,7 @@ desc 'Starts a new session charter'
 arg_name 'SessionName'
 command :start do |c|
   c.action do |global_options,options,args|
-    doc.create_charter(args)
+    doc.create_charter(args * " ")
   end
 end
 
@@ -22,7 +22,7 @@ desc 'What are you testing'
 arg_name 'What is the purpose of this session'
 command :purpose, :p do |c|
   c.action do |global_options,options,args|
-    doc.set_purpose(args[0])
+    doc.set_purpose(args * " ")
   end
 end
 
@@ -30,7 +30,7 @@ desc 'Add an item to describe system under test'
 arg_name 'List your environment'
 command :env do |c|
   c.action do |global_options,options,args|
-    doc.set_env(args[0])
+    doc.set_env(args * " ")
   end
 end
 
@@ -39,7 +39,7 @@ arg_name 'Add a bug to the current session'
 command :bug do |c|
   c.switch :s
   c.action do |global_options,options,args|
-    doc.add_bug(args[0], options[:s])
+    doc.add_bug(args * " ", options[:s])
   end
 end
 
@@ -47,7 +47,15 @@ desc 'Describe a scenario here'
 arg_name 'Add a scenario to the current session'
 command :scenario, :s do |c|
   c.action do |global_options,options,args|
-    doc.add_scenario(args[0])
+    doc.add_scenario(args * " ")
+  end
+end
+
+desc 'Add a note'
+arg_name 'Add a note to the current session'
+command :note, :n do |c|
+  c.action do |global_options,options,args|
+    doc.add_note(args * " ")
   end
 end
 
@@ -58,7 +66,7 @@ command :finish do |c|
   c.action do |global_options,options,args|
     doc.finish_charter
     if options[:e]
-      doc.export("finalCharter")
+      doc.export_charter
     end
   end
 end

data/lib/charter/charter_template.md

@@ -1,4 +1,4 @@
-#Exploratory Testing Charter
+#Test Charter
 <purpose>
 
 ##Environment
@@ -6,7 +6,7 @@
 
 ##Length
 Start Time: <start_time>
-End Time: <end_time>  
+End Time: <end_time>
 Elapsed: <elapsed>
 
 ##Tester
@@ -17,3 +17,6 @@ Elapsed: <elapsed>
 
 ##Defects Found:
 <defects>
+
+##Notes:
+<notes>

data/lib/charter/doc.rb

@@ -8,14 +8,18 @@ class Doc
 
 	def create_charter(name)
 		template = File.read(File.dirname(__FILE__) + '/charter_template.md')
-		charter = File.new("#{@config['session_folder']}/#{name[0]}.md", "w+")
+		charter = File.new("#{@config['session_folder']}/#{name}.md", "w+")
 		charter.write(template)
 		charter.close
 
-		@config['current_session'] = "#{@config['session_folder']}/#{name[0]}.md"
+		@config['session_name'] = name
+		@config['current_session'] = "#{@config['session_folder']}/#{name}.md"
 		@config['start_time'] = Time.now.strftime("%l:%M %P")
+		@config['defects'] = "false"
+		@config['notes'] = "false"
+		@config['scenarios'] = "false"
 
-		replace_text('<start_time>', @config['start_time'] + "  \r\n")
+		replace_text('<start_time>', @config['start_time'] + "  ")
 		replace_text('<tester>', @config['tester'])
 
 		write_config
@@ -23,47 +27,47 @@ class Doc
 
 	def add_bug(text, screenshot)
 		replace_text('<defects>', "1. #{text}  \r\n<defects>")
+		@config['defects'] = "true"
 		if screenshot
 			%x(screencapture -s "#{@config['session_folder']}/#{text}".jpg)
-			replace_text('<defects>', "    - Screenshot Attached  \r\n<defects>")
+			replace_text('<defects>', "    * ![Alt text](#{@config['session_folder']}/#{text}.jpg)  \r\n<defects>")
 		end
+		write_config
 	end
 
 	def add_scenario(text)
 		replace_text('<scenarios>', "1. #{text}  \r\n<scenarios>")
+		@config['scenarios'] = 'true'
+		write_config
 	end
 
 	def set_env(text)
-		replace_text('<environment>', "1. #{text}  \r\n<environment>")
+		replace_text('<environment>', "* #{text}  \r\n<environment>")
 	end
 
 	def set_purpose(text)
 		replace_text('<purpose>', text)
 	end
 
-	def finish_charter
-		@config['end_time'] = Time.now.strftime("%l:%M %P")
-		replace_text('<end_time>', @config['end_time'])
-
-		elapsed_time = (Time.parse(@config['end_time']) - Time.parse(@config['start_time']))/60
-
-		replace_text('<elapsed>',elapsed_time.to_i.to_s + ' minutes')
-
-		aString = File.read(@config['current_session'])
-
-		#remove remaining placeholders
-		aString.gsub!(/\<(.*?)\>/, "")
+	def add_note(text)
+		replace_text('<notes>', "1. #{text}  \r\n<notes>")
+		@config['notes'] = 'true'
+		write_config
+	end
 
-		file = File.open(@config['current_session'], "w")
-		file.puts aString
-		file.close
+	def finish_charter
+		set_default_text
+		
+		set_end_time
+		
+		remove_placeholders
 	end
 
-	def export_charter(name)
+	def export_charter
 		renderer = Redcarpet::Render::HTML.new(render_options = {})
 		markdown = Redcarpet::Markdown.new(renderer, extensions = {})
 		text = File.read(@config['current_session'])
-		html_file = File.new("#{@config['session_folder']}/#{name}.html", "w+")
+		html_file = File.new("#{@config['session_folder']}/#{@config['session_name'].gsub(" ", "-")}.html", "w+")
 		html_text = markdown.render(text)
 		html_file.write(html_text)
 	end
@@ -77,6 +81,32 @@ private
 		file.close
 	end
 
+	def set_default_text
+		@config['defects'] == 'false' ? replace_text('<defects>', 'No defects found during this session') : nil
+
+		@config['notes'] == 'false' ? replace_text('<notes>', 'No notes for this session') : nil
+
+		@config['scenarios'] == 'false' ? replace_text('<scenarios>', 'No scenarios for this session') : nil
+	end
+
+	def set_end_time
+		@config['end_time'] = Time.now.strftime("%l:%M %P")
+
+		replace_text('<end_time>', @config['end_time'] + "  ")
+
+		elapsed_time = (Time.parse(@config['end_time']) - Time.parse(@config['start_time']))/60
+
+		replace_text('<elapsed>',elapsed_time.to_i.to_s + ' minutes')
+	end
+
+	def remove_placeholders
+		aString = File.read(@config['current_session'])
+		aString.gsub!(/\<(.*?)\>/, "")
+		file = File.open(@config['current_session'], "w")
+		file.puts aString
+		file.close
+	end
+
 	def read_config
     	if File.exists? File.expand_path(SESSION_CONFIG)
       		return YAML.load_file(File.expand_path(SESSION_CONFIG))

data/lib/charter/version.rb

@@ -1,3 +1,3 @@
 module Charter
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: charter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Mark Grossman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake