charter 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a085bd115b8f668232dee0033a4176e4e1a284f3
-  data.tar.gz: 202b620213f13ba5268144a409c0fe21cea6cb26
+  metadata.gz: e1c3c8a659fec87f6007ed0b5effb44796e5974c
+  data.tar.gz: d221a1bb32c56179c733dc5ac9f9b4df3d93c822
 SHA512:
-  metadata.gz: 5bcb0d03e7e0d2484f4b136b9f48e545e8f5d2d962ee043cc98732367eb07c96b8f5fd033b43986044ebf88d6fe4405acecd90e5e27ece86a39cc51be9fa13e4
-  data.tar.gz: a21a2ff6486a299dd7f09a92745496fe3bd0b238db99d1895cbb235b8e07b9b335ced0f6f780989496cca561e6818ea20102db95e775a407f263ecee42bf8a43
+  metadata.gz: d73ab94b12da179ccb525a5ef2063c68dd2822597610d776a66b2e0f89797e99e6df277b633f79fb43427ce9a065ab78b7bea8534c654569ba985205a005d00f
+  data.tar.gz: 9a4e7277979fe9511f23ecbccb912e2d84e0ea08b2aac6671f9269d306e5d6a1df966b142cbe3c6d9814a3fe85ce43ebb78d46360cbbd3035d4effdd94729ab7

data/README.md

@@ -1,76 +1,25 @@
-Charter
-=======
-
-Command line interface for creating a test charter exported in markdown.
-
-#Installation
- 	[sudo] gem install charter
+##Installation  
+ Charter was created as a Ruby gem and is available through Rubygems.org. Installation is as simple as:  
+  <code>[sudo] gem install charter</code>
  	
 After installing the gem, create a ~/.charterrc file and add the following:
-	
-	---
-	session_folder: "/Where/The/Charters/Will/Save/To"
-	tester: Your Name Here
-#Usage
+	{% codeblock lang:yaml %}
+		---
+		session_folder: "/Where/The/Charters/Will/Save/To"
+		tester: Your Name Here
+	{% endcodeblock %}
+##Usage
 	charter [global options] command [command options] [arguments...]
-###Creating a new charter
-	charter start "Charter Name"
-	
-This will create a new charter in the specified folder specified in your ~/.charterrc file
-
-###Adding environment details
-	charter env "Windows 7, IE 10, point at QA"
-###Adding a purpose for the charter
-	charter purpose "I will be testing the login page"
-###Adding a scenario
-	charter scenario "Leave both fields blank and click login"
-	
-	or
-	
-	charter s "Leave both fields blank and click login"
-###Adding a defect 
-	charter bug "User able to login without inputting password"
-###Finishing the charter
-	charter finish
-
-This will removing any remaining place holders and fill in the end time
-
-####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
-
-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.
-
-##Environment
-
-OS X, Chrome
-
-##Length
-Start Time: 03/31/2014 21:20  
-
-End Time: 03/31/2014 21:22
-
-##Tester
-Mark Grossman
-
-##Scenarios:
-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.  
-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.  
 
+Creating a new charter is as easy as <code>charter start "My charter title here"</code>. This will create a new charter in the folder specified in your ~/.charterrc file.
 
-##Defects Found
-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.  
-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.  
+<code>charter purpose "This is my purpose!"</code> : What do you hope to accomplish with this charter  
+<code>charter env "Windows 7"</code> : Add a environment description  
+<code>charter scenario "Scenario goes here"</code> or <code>charter s "Scenario goes here"</code> : Add a scenario  
+<code>charter bug "This is my bug"</code> or <code>charter bug -s "My bug"</code> : Add a bug with or without a screenshot  
+<code>charter note</code> : Add a note  
+<code>charter tag "Login"</code> : Add a tag to the charter  
+<code>charter finish</code> or <code>charter finish -e</code> : Remove any remaining placeholders and optionally export the charter in HTML  
+<code>charter find Login</code> : Find all charters with a given tag
 
----
+See an example charter [here](http://testwith.me/charter-example/)

data/bin/charter

@@ -13,24 +13,24 @@ version Charter::VERSION
 desc 'Starts a new session charter'
 arg_name 'SessionName'
 command :start do |c|
-  c.action do |global_options,options,args|
-    doc.create_charter(args * " ")
+  c.action do |global_options, options, args|
+    doc.create_charter(args * ' ')
   end
 end
 
 desc 'What are you testing'
-arg_name 'What is the purpose of this session'
+arg_name 'purpose'
 command :purpose, :p do |c|
-  c.action do |global_options,options,args|
-    doc.set_purpose(args * " ")
+  c.action do |global_options, options, args|
+    doc.set_purpose(args * ' ')
   end
 end
 
 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 * " ")
+  c.action do |global_options, options, args|
+    doc.set_env(args * ' ')
   end
 end
 
@@ -38,24 +38,51 @@ 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.add_bug(args * " ", options[:s])
+  c.action do |global_options, options, args|
+    doc.add_bug(args * ' ')
+    doc.take_screenshot(args * ' ') if options[:s]
   end
 end
 
 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 * " ")
+  c.action do |global_options, options, args|
+    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 * " ")
+  c.action do |global_options, options, args|
+    doc.add_note(args * ' ')
+  end
+end
+
+desc 'Add a tag to your charter'
+arg_name 'tag'
+command :tag do |c|
+  c.action do |global_options, options, args|
+    args.each do |tag|
+      doc.add_tag(tag)
+    end
+  end
+end
+
+desc 'Find charters with tag'
+arg_name 'find'
+command :find do |c|
+  c.action do |global_options, options, args|
+    doc.find_files_with_tags(args * ' ')
+  end
+end
+
+desc 'Show all charters'
+arg_name 'all'
+command :all do |c|
+  c.action do |global_options, options, args|
+    doc.show_all_charters
   end
 end
 
@@ -63,15 +90,14 @@ 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.action do |global_options, options, args|
     doc.finish_charter
-    if options[:e]
-      doc.export_charter
-    end
+    doc.export_charter if options[:e]
+      
   end
 end
 
-pre do |global,command,options,args|
+pre do |global, command, options, args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the
   # chosen command
@@ -80,7 +106,7 @@ pre do |global,command,options,args|
   true
 end
 
-post do |global,command,options,args|
+post do |global, command, options, args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only

data/lib/charter/charter_template.md

@@ -20,3 +20,6 @@ Elapsed: <elapsed>
 
 ##Notes:
 <notes>
+
+###Tags:
+<tags>

data/lib/charter/doc.rb

@@ -2,120 +2,140 @@
 
 class Doc
 
-	def initialize(input=nil)
-		@config = read_config
-	end
-
-	def create_charter(name)
-		template = File.read(File.dirname(__FILE__) + '/charter_template.md')
-		charter = File.new("#{@config['session_folder']}/#{name}.md", "w+")
-		charter.write(template)
-		charter.close
-
-		@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'] + "  ")
-		replace_text('<tester>', @config['tester'])
-
-		write_config
-	end
-
-	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>', "    * ![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>', "* #{text}  \r\n<environment>")
-	end
-
-	def set_purpose(text)
-		replace_text('<purpose>', text)
-	end
-
-	def add_note(text)
-		replace_text('<notes>', "1. #{text}  \r\n<notes>")
-		@config['notes'] = 'true'
-		write_config
-	end
-
-	def finish_charter
-		set_default_text
-		
-		set_end_time
-		
-		remove_placeholders
-	end
-
-	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']}/#{@config['session_name'].gsub(" ", "-")}.html", "w+")
-		html_text = markdown.render(text)
-		html_file.write(html_text)
-	end
-
-private
-	def replace_text(find,replace)
-		aString = File.read(@config['current_session'])
-		aString.gsub!(find, replace)
-		file = File.open(@config['current_session'], "w")
-		file.puts aString
-		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))
-    	else
-      		return {}
-    	end
+  def initialize(input = nil)
+    @config = read_config
+  end
+
+  def create_charter(name)
+    template = File.read(File.dirname(__FILE__) + '/charter_template.md')
+    charter = File.new("#{@config['session_folder']}/#{name}.md", 'w+')
+    charter.write(template)
+    charter.close
+
+    @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'] + '  ')
+    replace_text('<tester>', @config['tester'])
+
+    write_config
+  end
+
+  def add_bug(text)
+    replace_text('<defects>', "1. #{text}  \r\n<defects>")
+    @config['defects'] = 'true'
+    write_config
+  end
+
+  def take_screenshot(text)
+    %x(screencapture -s "#{@config['session_folder']}/#{text}".jpg)
+    replace_text('<defects>', "    * ![Alt text](#{@config['session_folder']}/#{text}.jpg)  \r\n<defects>")
+  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>', "* #{text}  \r\n<environment>")
+  end
+
+  def set_purpose(text)
+    replace_text('<purpose>', text)
+  end
+
+  def add_note(text)
+    replace_text('<notes>', "1. #{text}  \r\n<notes>")
+    @config['notes'] = 'true'
+    write_config
+  end
+
+  def add_tag(text)
+    replace_text('<tags>', "@#{text} <tags>")
+  end
+
+  def finish_charter
+    set_default_text
+
+    set_end_time
+
+    remove_placeholders
+  end
+
+  def export_charter
+    renderer = Redcarpet::Render::HTML.new(render_options = {})
+    markdown = Redcarpet::Markdown.new(renderer, extensions = {})
+    markdown_text = File.read(@config['current_session'])
+    html_file = File.new("#{@config['session_folder']}/#{@config['session_name'].gsub(' ', '-')}.html", 'w+')
+    html_text = markdown.render(markdown_text)
+    html_file.write(html_text)
+  end
+
+  def find_files_with_tags(tag)
+    files = %x(grep -rnw -l --include=*.md #{@config['session_folder']} -e '@#{tag}').split('\n')
+    files.each do |file|
+      puts file.split('/')[-1]
     end
+  end
 
-    def write_config
-  		File.open(File.expand_path(SESSION_CONFIG), 'w') { |yf| YAML::dump(@config, yf) }
-  	end
+  def show_all_charters
+    files = Dir["#{@config['session_folder']}/*.md"]
+    files.each do |file|
+      puts file.split('/')[-1]
+    end
+  end
+
+  private
+
+  def replace_text(find, replace)
+    file_text = File.read(@config['current_session'])
+    file_text.gsub!(find, replace)
+    file = File.open(@config['current_session'], 'w')
+    file.puts file_text
+    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
+    file_text = File.read(@config['current_session'])
+    file_text.gsub!(/\<(.*?)\>/, '')
+    file = File.open(@config['current_session'], 'w')
+    file.puts file_text
+    file.close
+  end
+
+  def read_config
+    if File.exist? File.expand_path(SESSION_CONFIG)
+      return YAML.load_file(File.expand_path(SESSION_CONFIG))
+    else
+      return {}
+    end
+  end
+
+  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.7'
+  VERSION = '0.0.8'
 end

metadata

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