Module: UserDocs

Extended by:
Capybara::Node::Actions
Defined in:
lib/user_docs.rb,
lib/user_docs/railtie.rb,
lib/user_docs/version.rb,
lib/user_docs/capybara_extension.rb,
lib/generators/user_docs/install_generator.rb

Overview

Extends Capybara’s Actions to create end user documentation

Defined Under Namespace

Classes: InstallGenerator, Railtie

Constant Summary collapse

VERSION = 
"0.8.0"

Instance Method Summary collapse

Instance Method Details

#before_setup ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/user_docs/capybara_extension.rb', line 9

def before_setup
  super

  check_installation

  @class_name = class_name.chomp("Procedure")
  @method = name.sub("test_", "")
  make_version_data_directory
  make_version_index
  Capybara.save_path =
    Rails.root.join(".docs/assets/#{version}/#{klass_name}/#{@method}")

  @json = { name: @method.humanize, steps: [] }
end

#before_teardown ⇒ Object 



24
25
26
27
28
29
 
# File 'lib/user_docs/capybara_extension.rb', line 24

def before_teardown
  path = ".docs/_data/versions/#{version}/#{klass_name}/#{@method}.json"
  File.write(Rails.root.join(path), @json.to_json)

  super
end