charter 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4e96719e4864c6ac6f1e4d678cb678428efea7e
+  data.tar.gz: 2ad3b415180f28d880c02e0bdc3c7c22b019a6e8
+SHA512:
+  metadata.gz: cb27ba1ce07226c0ff4125b1db19df0e78ce1ab553dcf3f99fbb246d05e7b5aa4c333f751c528adca786c60441ffd5eb7015760f4a0873e230b2552c5373205e
+  data.tar.gz: 7530defe081121d8bb0850299253ecfa46f6877ca95dcb69ce35200cb04e289a9a4d24f945f71f1e40c8864f050d766a5e11dcaa2a4580f991bdd15059d2020e

data/bin/charter

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'charter'
+
+include GLI::App
+
+doc = Doc.new
+
+program_desc 'A command line tool for session based testing'
+
+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(args)
+  end
+end
+
+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])
+  end
+end
+
+desc 'Describe environment here'
+arg_name 'List your environment'
+command :env do |c|
+  c.action do |global_options,options,args|
+    doc.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.action do |global_options,options,args|
+    doc.bug(args[0])
+  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.scenario(args[0])
+  end
+end
+
+desc 'Final formatting to charter'
+arg_name 'Type of export'
+command :finish do |c|
+  c.action do |global_options,options,args|
+    c.flag :e
+    doc.finish
+  end
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/lib/charter/charter_template.md

@@ -0,0 +1,22 @@
+#Exploratory Testing Charter
+<purpose>
+
+##Environment
+<environment>
+
+##Length
+Start Time: <start_time>
+End Time: <end_time>
+
+##Tester
+<tester>
+
+##Scenarios:
+<scenarios>
+
+##Defects Found:
+<defects>
+
+
+
+

data/lib/charter/doc.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/ruby
+
+class Doc
+
+	def initialize(input=nil)
+		@config = read_config
+	end
+
+	def create(name)
+		template = File.read('lib/charter/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")		
+		replace_text('<tester>', @config['tester'])
+
+		write_config
+	end
+
+	def bug(text)
+		replace_text('<defects>', "1. #{text}  \r\n<defects>")
+	end
+
+	def scenario(text)
+		replace_text('<scenarios>', "1. #{text}  \r\n<scenarios>")
+	end
+
+	def env(text)
+		replace_text("<environment>", text)
+	end
+
+	def purpose(text)
+		replace_text("<purpose>", text)
+	end
+
+	def finish
+		replace_text('<end_time>', Time.now.strftime("%m/%d/%Y %H:%M"))
+		
+		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)
+		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_text = markdown.render(text)
+		html_file.write(html_text)
+	end
+
+	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
+
+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
+
+  	def write_config
+  		File.open(File.expand_path(SESSION_CONFIG), 'w') { |yf| YAML::dump(@config, yf) }
+  	end
+end

data/lib/charter/version.rb

@@ -0,0 +1,3 @@
+module Charter
+  VERSION = '0.0.2'
+end

data/lib/charter.rb

@@ -0,0 +1,9 @@
+require 'charter/version.rb'
+require 'fileutils'
+require 'charter/doc.rb'
+require 'redcarpet'
+require 'yaml'
+require 'time'
+require 'date'
+
+SESSION_CONFIG = "~/.charterrc"

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: charter
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Mark Grossman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 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
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+description: 
+email: mark@testwith.me
+executables:
+- charter
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/charter
+- lib/charter.rb
+- lib/charter/charter_template.md
+- lib/charter/doc.rb
+- lib/charter/version.rb
+homepage: http://testwith.me
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- charter
+- "--main"
+- README.rdoc
+- "-ri"
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A CLI for creating a session based testing charter
+test_files: []