Module: Crab::Utilities

Includes:
Logging
Included in:
CucumberFeature, CucumberScenario, Rally, RallyToCucumberAdapter, Story, TestCase
Defined in:
lib/crab/utilities.rb

Instance Method Summary collapse

Methods included from Logging

#logger

Instance Method Details

#add_or_update_options(banner, args) ⇒ Object

TODO REFACTOR testcase related stuff that didn’t have a good home



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/crab/utilities.rb', line 44

def add_or_update_options(banner, args)
  Trollop::options(args) do
    banner banner
    opt :name,     "Name of this test case", :type => String, :short => '-n'
    opt :priority, "Priority (one of: #{Crab::TestCase::PRIORITIES.join(" ")}", :type => String, :default => "important",  :short => '-p'
    opt :risk,     "Risk (one of: #{Crab::TestCase::RISKS.join(" ")})", :type => String, :default => "medium",     :short => '-r'
    opt :method,   "Method (one of: #{Crab::TestCase::METHODS.join(" ")})", :type => String, :default => "manual",     :short => '-m'
    opt :type,     "Type (one of: #{Crab::TestCase::TYPES.join(" ")})", :type => String, :default => "acceptance", :short => '-t'
    opt :pre,      "Pre-conditions", :default => "N/A", :type => String
    opt :post,     "Post-conditions", :default => "N/A", :type => String
    opt :desc,     "Description", :default => "N/A", :short => '-d', :type => String

    opt :dry, "Dry-run (don't change anything)", :short => "-D", :default => false
  end
end

#credentials_file ⇒ Object 



6
7
8
 
# File 'lib/crab/utilities.rb', line 6

def credentials_file
  dotcrab_file 'credentials'
end

#current_project_name ⇒ Object 



21
22
23
24
 
# File 'lib/crab/utilities.rb', line 21

def current_project_name
  project_file = dotcrab_file('project')
  File.read(project_file).strip if File.exists?(project_file)
end

#dotcrab_file(file) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/crab/utilities.rb', line 89

def dotcrab_file(file)
  current_folder = File.expand_path '.'

  while current_folder != '/'

    dotcrab = "#{current_folder}/.crab"
    if File.exists? "#{dotcrab}/#{file}"
      return "#{dotcrab}/#{file}"
    end
    current_folder = File.expand_path "#{current_folder}/.."

  end

  File.expand_path "~/.crab/#{file}"
end

#sanitize(html) ⇒ Object

use a web service to seriously clean up Rally’s HTML – I could not find any HTML-to-text libraries that satisfied the following conditions:

  • displaying nested lists properly (indented, etc)

  • being easy to include into the project

  • had no licensing issues

  • understood UTF8 natively

  • understood entities (emdash etc)

  • allowed dashes as list item markers



83
84
85
86
87
 
# File 'lib/crab/utilities.rb', line 83

def sanitize(html)
  require 'net/http'
  require 'uri'
  Net::HTTP.post_form(URI.parse("http://html2text.herokuapp.com/"), {:html => html}).body
end

#sanitize_options(opts, creating = true) ⇒ Object

TODO REFACTOR testcase related stuff that didn’t have a good home



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/crab/utilities.rb', line 61

def sanitize_options(opts, creating=true)
  result = {}
  result[:priority] = opts[:priority].capitalize if creating || opts[:priority_given]
  result[:risk] = opts[:risk].capitalize if creating || opts[:risk_given]
  result[:method] = opts[:method].capitalize if creating || opts[:method_given]
  result[:type] = opts[:type].capitalize if creating || opts[:type_given]
  result[:pre_conditions] = opts[:pre] if creating || opts[:pre_given]
  result[:post_conditions] = opts[:post] if creating || opts[:post_given]
  result[:description] = opts[:desc] if creating || opts[:desc_given]
  result
end

#state_after(state) ⇒ Object 



37
38
39
40
41
 
# File 'lib/crab/utilities.rb', line 37

def state_after(state)
  i = (Crab::Story::VALID_STATES.index(state) || 0) + 1
  max = Crab::Story::VALID_STATES.size
  Crab::Story::VALID_STATES[i >= max ? max -1 : i]
end

#state_before(state) ⇒ Object 



32
33
34
35
 
# File 'lib/crab/utilities.rb', line 32

def state_before(state)
  i = (Crab::Story::VALID_STATES.index(state) || 0) - 1
  Crab::Story::VALID_STATES[i < 0 ? 0 : i]
end

#state_from(option) ⇒ Object 



26
27
28
29
30
 
# File 'lib/crab/utilities.rb', line 26

def state_from(option)
  fixed_option = option.gsub(/(^\w|[-_]\w)/) { $1.upcase.gsub(/_/, '-') }
  Trollop::die :state, "has an invalid value" unless Crab::Story::VALID_STATES.include? fixed_option
  fixed_option
end

#valid_credentials_file ⇒ Object 



10
11
12
13
 
# File 'lib/crab/utilities.rb', line 10

def valid_credentials_file
  Trollop::die "Please log in first" unless File.exists? credentials_file
  credentials_file
end

#valid_project_name(cmd_opts) ⇒ Object 



15
16
17
18
19
 
# File 'lib/crab/utilities.rb', line 15

def valid_project_name(cmd_opts)
  project_name = cmd_opts[:project_given] ? cmd_opts[:project] : current_project_name
  Trollop::die :project, "must be specified" if project_name.blank?
  project_name
end