Class: Develoz::Generators::AgentsDocsGenerator

Inherits:
Base
  • Object
show all
Defined in:
lib/generators/develoz/agents_docs/agents_docs_generator.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#add_gem, #app_class, #app_name, #append_env, #apply_template, #ensure_gitignore, #inject_once, #insert_route, #migration_exists?, next_migration_timestamp

Class Method Details

.source_root ⇒ Object 



8
9
10
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 8

def self.source_root
  File.expand_path("templates", __dir__)
end

Instance Method Details

#add_api_gems ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 12

def add_api_gems
  add_gem "faraday"
  add_gem "faraday-retry"
  add_gem "vcr", group: %i[test]
  add_gem "webmock", group: %i[test]
end

#create_agents_md ⇒ Object 



19
20
21
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 19

def create_agents_md
  template "AGENTS.md.tt", "AGENTS.md"
end

#create_docs ⇒ Object 



23
24
25
26
27
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 23

def create_docs
  template "docs/development.md.tt", "docs/development.md"
  template "docs/testing.md.tt", "docs/testing.md"
  template "docs/performance.md.tt", "docs/performance.md"
end

#create_example_api_spec ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 42

def create_example_api_spec
  template "spec/requests/example_api_spec.rb.tt",
           "spec/requests/example_api_spec.rb"
  template "spec/cassettes/Example_API/fetches_data_from_an_external_API.yml.tt",
           "spec/cassettes/Example_API/fetches_data_from_an_external_API.yml"
end

#create_faraday_support ⇒ Object 



38
39
40
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 38

def create_faraday_support
  template "spec/support/faraday.rb.tt", "spec/support/faraday.rb"
end

#create_pr_template ⇒ Object 



29
30
31
32
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 29

def create_pr_template
  template ".github/pull_request_template.md.tt",
           ".github/pull_request_template.md"
end

#create_vcr_support ⇒ Object 



34
35
36
 
# File 'lib/generators/develoz/agents_docs/agents_docs_generator.rb', line 34

def create_vcr_support
  template "spec/support/vcr.rb.tt", "spec/support/vcr.rb"
end