Update docs

mikeblatter · Jul 16, 2017 · 3b2306d · 3b2306d
1 parent 7761435
commit 3b2306d
Show file tree

Hide file tree

Showing 12 changed files with 33 additions and 16 deletions.
diff --git a/docs/step_definition.rb b/docs/step_definition.rb
@@ -44,19 +44,31 @@ def examples
 end
 
 class StepDefinition
-  attr_accessor :name, :title
+  attr_accessor :path, :name, :title
 
   def initialize(path)
     $steps = []
 
+    self.path = path
     self.name = File.basename(path, '.rb')
-    self.title = "#{self.name.capitalize} Step Definitions\n"
+    self.title = "#{self.name.gsub('_', ' ').split.map(&:capitalize).join(' ')} Step Definitions\n"
 
     require path
   end
 
+  def description
+    contents = File.read(self.path)
+
+    description_match = contents.match(/\s*#\s*Description: ([^\n]+)/)
+
+    return '' unless description_match and description_match.length > 1
+
+    description_match[1]
+  end
+
   def output
     output = "# #{self.title}\n"
+    output += "#{self.description}\n"
 
     output += "## Steps: \n\n"
 

diff --git a/docs/step_definitions/README.md b/docs/step_definitions/README.md
@@ -1,5 +1,10 @@
 # Cucumber Step Definitions Overview
 
+The following documentation will demonstrate how to use AutomationObject in a Ruby/Cucumber context.
+We have created common step definitions that you can include for automating and testing a website or app.
+
+## Features
+
 * Using RSpec for Assertions
 
 ## Loading Step Definitions in Cucumber

diff --git a/docs/step_definitions/element.md b/docs/step_definitions/element.md
@@ -1,5 +1,6 @@
 # Element Step Definitions
 
+Use the following step definitions to interact with or test elements
 ## Steps: 
 
 ### Call an element method

diff --git a/docs/step_definitions/element_array.md b/docs/step_definitions/element_array.md
@@ -1,5 +1,6 @@
-# Element_array Step Definitions
+# Element Array Step Definitions
 
+Use the following step definitions to interact with or test element arrays
 ## Steps: 
 
 ### For: Call an element array method

diff --git a/docs/step_definitions/element_hash.md b/docs/step_definitions/element_hash.md
@@ -1,5 +1,6 @@
-# Element_hash Step Definitions
+# Element Hash Step Definitions
 
+Use the following step definitions to interact with or test element hashes
 ## Steps: 
 
 ### Call an element hash method

diff --git a/docs/step_definitions/modal.md b/docs/step_definitions/modal.md
@@ -1,5 +1,6 @@
 # Modal Step Definitions
 
+Use the following step definitions to interact with or test modals
 ## Steps: 
 
 ### Automatically navigate to the modal

diff --git a/docs/step_definitions/screen.md b/docs/step_definitions/screen.md
@@ -1,8 +1,9 @@
 # Screen Step Definitions
 
+Use the following step definitions to interact with or test screens
 ## Steps: 
 
-### Automatically navigate to the modal
+### Automatically navigate to the screen
 
 #### Examples: 
 

diff --git a/lib/automation_object/step_definitions/element.rb b/lib/automation_object/step_definitions/element.rb
@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 require_relative 'support/parse'
 
-# Element Step Definitions
-# Provides step definitions related to elements
+# Description: Use the following step definitions to interact with or test elements
 
 # Call an element method
 # Examples:

diff --git a/lib/automation_object/step_definitions/element_array.rb b/lib/automation_object/step_definitions/element_array.rb
@@ -2,8 +2,7 @@
 require_relative 'support/parse'
 require_relative 'support/element_array'
 
-# Title: Element Array Step Definitions
-# Description: Provides step definitions related to element arrays
+# Description: Use the following step definitions to interact with or test element arrays
 
 # For: Call an element array method
 # Examples:

diff --git a/lib/automation_object/step_definitions/element_hash.rb b/lib/automation_object/step_definitions/element_hash.rb
@@ -2,8 +2,7 @@
 require_relative 'support/parse'
 require_relative 'support/element_hash'
 
-# Title: Element Hash Step Definitions
-# Description: Provides step definitions related to element hashes
+# Description: Use the following step definitions to interact with or test element hashes
 
 # Call an element hash method
 # Examples:

diff --git a/lib/automation_object/step_definitions/modal.rb b/lib/automation_object/step_definitions/modal.rb
@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 require_relative 'support/parse'
 
-# Modal Step Definitions
-# Provides step definitions related to modals
+# Description: Use the following step definitions to interact with or test modals
 
 # Automatically navigate to the modal
 # Examples:

diff --git a/lib/automation_object/step_definitions/screen.rb b/lib/automation_object/step_definitions/screen.rb
@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 require_relative 'support/parse'
 
-# Screen Step Definitions
-# Provides step definitions related to screens
+# Description: Use the following step definitions to interact with or test screens
 
-# Automatically navigate to the modal
+# Automatically navigate to the screen
 # Examples:
 # - I go to the "home_screen" screen
 # - I go to "login_screen" screen