charter 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbdd2201e293d31ca060ac5282cac57f145a851a
-  data.tar.gz: fbf9314129688e853c429ad1ad6c8c2d299cdd0b
+  metadata.gz: d8499a80980f057511a5cbd8101f51bce30c9d50
+  data.tar.gz: 6dd597907ebb88b07b8658e957c6d2a4ceaae7c3
 SHA512:
-  metadata.gz: 6a43c9cc6978de481be21315028e628d3cd045597405c07869a0a96864d4ec2f63c1ac84b03bd4736f1e7c9a0433ec6a26e2783529da280f7e03e1f420e09905
-  data.tar.gz: 70be4ca1e6d7f946dc3ce3430de4610a0575792ac2d5afeffec1f859a8f26d754e5cfdd182384ac75254e1b2adf3f493dee40a2f369214c2001b0d65a3cc1511
+  metadata.gz: b29d08eb2bfb19895512eaaf3b85acb0818e61426d3152b15390a36d1e5745d9cd98e669d38b8a1240cb1608f73cad6da6dfbba17910bb742dc96c37d3071767
+  data.tar.gz: 035ab19ea04d67b0a3ad76f3f6def1d7d709405f422c8d359b8533dd105bac3e4a616cbfb3ff211720d8b8139a3376d0ed600956035c8a7ee7d9dcd2c82fb6a4

data/README.md

@@ -1,4 +1,4 @@
-Session
+Charter
 =======
 
 Command line interface for creating a test charter exported in markdown.
@@ -69,4 +69,4 @@ Mark Grossman
   - Refine code structure
   - Release to RubyGems.org
   - Add more fields to charter
-  - Add optional fields
+  - 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(args)
+    doc.create_charter(args)
   end
 end
 
@@ -22,23 +22,24 @@ 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.purpose(args[0])
+    doc.set_purpose(args[0])
   end
 end
 
-desc 'Describe environment here'
+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.env(args[0])
+    doc.set_env(args[0])
   end
 end
 
 desc 'Add a bug found during testing'
 arg_name 'Add a bug to the current session'
 command :bug do |c|
+  c.switch :s
   c.action do |global_options,options,args|
-    doc.bug(args[0])
+    doc.add_bug(args[0], options[:s])
   end
 end
 
@@ -46,16 +47,19 @@ 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.scenario(args[0])
+    doc.add_scenario(args[0])
   end
 end
 
 desc 'Final formatting to charter'
 arg_name 'Type of export'
 command :finish do |c|
+  c.switch :e
   c.action do |global_options,options,args|
-    c.flag :e
-    doc.finish
+    doc.finish_charter
+    if options[:e]
+      doc.export("finalCharter")
+    end
   end
 end
 

data/lib/charter/charter_template.md

@@ -6,7 +6,8 @@
 
 ##Length
 Start Time: <start_time>
-End Time: <end_time>
+End Time: <end_time>  
+Elapsed: <elapsed>
 
 ##Tester
 <tester>
@@ -16,7 +17,3 @@ End Time: <end_time>
 
 ##Defects Found:
 <defects>
-
-
-
-

data/lib/charter/doc.rb

@@ -6,48 +6,60 @@ class Doc
 		@config = read_config
 	end
 
-	def create(name)
+	def create_charter(name)
 		template = File.read(File.dirname(__FILE__) + '/charter_template.md')
 		charter = File.new("#{@config['session_folder']}/#{name[0]}.md", "w+")
 		charter.write(template)
 		charter.close
-		
+
 		@config['current_session'] = "#{@config['session_folder']}/#{name[0]}.md"
-		
-		replace_text('<start_time>', Time.now.strftime("%m/%d/%Y %H:%M") + "  \r\n")		
+		@config['start_time'] = Time.now.strftime("%l:%M %P")
+
+		replace_text('<start_time>', @config['start_time'] + "  \r\n")
 		replace_text('<tester>', @config['tester'])
 
 		write_config
 	end
 
-	def bug(text)
+	def add_bug(text, screenshot)
 		replace_text('<defects>', "1. #{text}  \r\n<defects>")
+		if screenshot
+			%x(screencapture -s "#{@config['session_folder']}/#{text}".jpg)
+			replace_text('<defects>', "    - Screenshot Attached  \r\n<defects>")
+		end
 	end
 
-	def scenario(text)
+	def add_scenario(text)
 		replace_text('<scenarios>', "1. #{text}  \r\n<scenarios>")
 	end
 
-	def env(text)
-		replace_text("<environment>", text)
+	def set_env(text)
+		replace_text('<environment>', "1. #{text}  \r\n<environment>")
 	end
 
-	def purpose(text)
-		replace_text("<purpose>", text)
+	def set_purpose(text)
+		replace_text('<purpose>', text)
 	end
 
-	def finish
-		replace_text('<end_time>', Time.now.strftime("%m/%d/%Y %H:%M"))
-		
+	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!(/\<(.*?)\>/, "")
+
 		file = File.open(@config['current_session'], "w")
 		file.puts aString
 		file.close
 	end
 
-	def export(name)
+	def export_charter(name)
 		renderer = Redcarpet::Render::HTML.new(render_options = {})
 		markdown = Redcarpet::Markdown.new(renderer, extensions = {})
 		text = File.read(@config['current_session'])
@@ -56,6 +68,7 @@ class Doc
 		html_file.write(html_text)
 	end
 
+private
 	def replace_text(find,replace)
 		aString = File.read(@config['current_session'])
 		aString.gsub!(find, replace)
@@ -64,16 +77,15 @@ class Doc
 		file.close
 	end
 
-private
 	def read_config
     	if File.exists? File.expand_path(SESSION_CONFIG)
       		return YAML.load_file(File.expand_path(SESSION_CONFIG))
     	else
       		return {}
     	end
-  	end
+    end
 
-  	def write_config
+    def write_config
   		File.open(File.expand_path(SESSION_CONFIG), 'w') { |yf| YAML::dump(@config, yf) }
   	end
 end

data/lib/charter/version.rb

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

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: charter
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Mark Grossman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -112,7 +112,6 @@ rdoc_options:
 - README.md
 - "--markup"
 - markdown
-- "-ri"
 require_paths:
 - lib
 - lib