Module: Apidepth::CLI::FrameworkDetector

Defined in:
lib/apidepth/cli/framework_detector.rb

Defined Under Namespace

Classes: DetectedFramework

Constant Summary collapse

FRAMEWORKS = 
%i[rails sinatra].freeze

Class Method Summary collapse

Class Method Details

._build_result(framework, api_key:, ignored_hosts:, collector_url:) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/apidepth/cli/framework_detector.rb', line 26

def self._build_result(framework, api_key:, ignored_hosts:, collector_url:)
  key_val     = api_key       || "YOUR_API_KEY"
  url_val     = collector_url || "https://collector.apidepth.io"
  hosts_val   = ignored_hosts.empty? ? "[]" : ignored_hosts.map { |h| %("#{h}") }.join(", ").then { |s| "[#{s}]" }

  case framework
  when :rails
    snippet = <<~RUBY
      # config/initializers/apidepth.rb
      Apidepth.configure do |config|
        config.api_key       = #{key_val.inspect}
        config.collector_url = #{url_val.inspect}
        config.ignored_hosts = #{hosts_val}
      end
    RUBY
    DetectedFramework.new(
      name: :rails,
      initializer_path: "config/initializers/apidepth.rb",
      initializer_snippet: snippet
    )
  when :sinatra
    snippet = <<~RUBY
      # Top of your main app file (e.g. app.rb), before any routes
      require "apidepth"
      Apidepth.configure do |config|
        config.api_key       = #{key_val.inspect}
        config.collector_url = #{url_val.inspect}
        config.ignored_hosts = #{hosts_val}
      end
      Apidepth.instrument!
    RUBY
    DetectedFramework.new(
      name: :sinatra,
      initializer_path: nil,
      initializer_snippet: snippet
    )
  else
    snippet = <<~RUBY
      # Add to your application startup file
      require "apidepth"
      Apidepth.configure do |config|
        config.api_key       = #{key_val.inspect}
        config.collector_url = #{url_val.inspect}
        config.ignored_hosts = #{hosts_val}
      end
      Apidepth.instrument!
    RUBY
    DetectedFramework.new(
      name: :generic,
      initializer_path: nil,
      initializer_snippet: snippet
    )
  end
end

._detect_framework(dir) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/apidepth/cli/framework_detector.rb', line 19

def self._detect_framework(dir)
  return :rails   if File.exist?(File.join(dir, "config/application.rb"))
  return :sinatra if File.exist?(File.join(dir, "config.ru"))

  :generic
end

.detect(dir: Dir.pwd, api_key: nil, ignored_hosts: [], collector_url: nil) ⇒ Object 



14
15
16
17
 
# File 'lib/apidepth/cli/framework_detector.rb', line 14

def self.detect(dir: Dir.pwd, api_key: nil, ignored_hosts: [], collector_url: nil)
  framework = _detect_framework(dir)
  _build_result(framework, api_key: api_key, ignored_hosts: ignored_hosts, collector_url: collector_url)
end