charter 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c3c8a659fec87f6007ed0b5effb44796e5974c
-  data.tar.gz: d221a1bb32c56179c733dc5ac9f9b4df3d93c822
+  metadata.gz: 2ed848c8cf33280db48864918cb221b5e22c8129
+  data.tar.gz: 81b749c8221d89209511d47bce76ac786615c690
 SHA512:
-  metadata.gz: d73ab94b12da179ccb525a5ef2063c68dd2822597610d776a66b2e0f89797e99e6df277b633f79fb43427ce9a065ab78b7bea8534c654569ba985205a005d00f
-  data.tar.gz: 9a4e7277979fe9511f23ecbccb912e2d84e0ea08b2aac6671f9269d306e5d6a1df966b142cbe3c6d9814a3fe85ce43ebb78d46360cbbd3035d4effdd94729ab7
+  metadata.gz: 55d513e188876e13b5a9713cc32cf5ecd469c8d353c0c69f9b7407c5ab595fe7760d7881807114738c26fa36c3aba7736107558cbcf60e1e1283f67b27da8d1d
+  data.tar.gz: 036cdc29750c2a4e302fd0d8c3e56d12e8b3f71644878867f02810ff0468d28b11bb203839004f41e316700141e29ed71150c9f6dcdfb78a68d63ecc3417cc58

data/README.md

@@ -3,11 +3,11 @@
   <code>[sudo] gem install charter</code>
  	
 After installing the gem, create a ~/.charterrc file and add the following:
-	{% codeblock lang:yaml %}
-		---
-		session_folder: "/Where/The/Charters/Will/Save/To"
-		tester: Your Name Here
-	{% endcodeblock %}
+```
+    ---
+    session_folder: "/Where/The/Charters/Will/Save/To"
+    tester: Your Name Here
+```
 ##Usage
 	charter [global options] command [command options] [arguments...]
 
@@ -22,4 +22,4 @@ Creating a new charter is as easy as <code>charter start "My charter title here"
 <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/)
+See an example charter [here](http://testwith.me/charter-example/)

data/bin/charter

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 require 'gli'
 require 'charter'
+require_relative "../lib/charter/ConfigStore"
 
 include GLI::App
 
@@ -10,6 +11,20 @@ program_desc 'A command line tool for session based testing'
 
 version Charter::VERSION
 
+desc 'Configure Charter'
+arg_name 'config'
+command :config do |c|
+  c.action do |global_options, options, args|
+    store = ConfigStore.new
+    config = {} 
+    puts "What's your name?"
+    config['tester'] = gets.chomp
+    puts "What folder would you like the sessions stored in?"
+    config['session_folder'] = gets.chomp
+    store.write('config', config)
+  end
+end
+
 desc 'Starts a new session charter'
 arg_name 'SessionName'
 command :start do |c|
@@ -87,13 +102,10 @@ command :all do |c|
 end
 
 desc 'Final formatting to charter'
-arg_name 'Type of export'
+arg_name 'Finish the charter'
 command :finish do |c|
-  c.switch :e
   c.action do |global_options, options, args|
     doc.finish_charter
-    doc.export_charter if options[:e]
-      
   end
 end
 

data/lib/charter/doc.rb

@@ -1,17 +1,16 @@
 #!/usr/bin/ruby
+require "pstore"
+require_relative "ConfigStore"
 
 class Doc
 
   def initialize(input = nil)
+    @store = ConfigStore.new
     @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
-
+    write_template(name)  
     @config['session_name'] = name
     @config['current_session'] = "#{@config['session_folder']}/#{name}.md"
     @config['start_time'] = Time.now.strftime('%l:%M %P')
@@ -25,6 +24,13 @@ class Doc
     write_config
   end
 
+  def write_template(name)
+    template = File.read(File.dirname(__FILE__) + '/charter_template.md')
+    charter = File.new("#{@config['session_folder']}/#{name}.md", 'w+')
+    charter.write(template)
+    charter.close
+  end
+
   def add_bug(text)
     replace_text('<defects>', "1. #{text}  \r\n<defects>")
     @config['defects'] = 'true'
@@ -32,8 +38,12 @@ class Doc
   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>")
+    if Gem.win_platform?
+      %x(screencapture -s "#{@config['session_folder']}/#{text}".jpg)
+      replace_text('<defects>', "    * ![Alt text](#{@config['session_folder']}/#{text}.jpg)  \r\n<defects>")
+    else
+      puts "This isn't supported on you operating system"
+    end
   end
 
   def add_scenario(text)
@@ -68,15 +78,6 @@ class Doc
     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|
@@ -128,14 +129,10 @@ class Doc
   end
 
   def read_config
-    if File.exist? File.expand_path(SESSION_CONFIG)
-      return YAML.load_file(File.expand_path(SESSION_CONFIG))
-    else
-      return {}
-    end
+    @store.read('config')
   end
 
   def write_config
-    File.open(File.expand_path(SESSION_CONFIG), 'w') { |yf| YAML.dump(@config, yf) }
+    @store.write('config',@config)
   end
 end

data/lib/charter/version.rb

@@ -1,3 +1,3 @@
 module Charter
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/charter.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: charter
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Mark Grossman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,26 +66,6 @@ dependencies:
     - - '='
       - !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'
-    - - ">="
-      - !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'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.1
 description: A tool for creating exploratory test session charters
 email: mark@testwith.me
 executables: