Class: Pantograph::Actions::OptOutUsageAction

Inherits:
Pantograph::Action show all
Defined in:
pantograph/lib/pantograph/actions/opt_out_usage.rb

Constant Summary

Constants inherited from Pantograph::Action

Pantograph::Action::AVAILABLE_CATEGORIES, Pantograph::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Pantograph::Action

action_name, author, available_options, deprecated_notes, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?

Class Method Details

.authors ⇒ Object 



21
22
23
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 21

def self.authors
  ['KrauseFx']
end

.category ⇒ Object 



41
42
43
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 41

def self.category
  :misc
end

.description ⇒ Object 



9
10
11
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 9

def self.description
  'This will stop uploading the information which actions were run'
end

.details ⇒ Object 



13
14
15
16
17
18
19
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 13

def self.details
  [
    'By default, _pantograph_ will track what actions are being used. No personal/sensitive information is recorded.',
    'Learn more at [https://urbanquakers.github.io/pantograph/#metrics](https://urbanquakers.github.io/pantograph/#metrics).',
    'Add `opt_out_usage` at the top of your Pantfile to disable metrics collection.'
  ].join("\n")
end

.example_code ⇒ Object 



29
30
31
32
33
34
35
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 29

def self.example_code
  [
    ' # add this to the top of your Pantfile
      opt_out_usage
    '
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



25
26
27
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 25

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



4
5
6
7
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 4

def self.run(params)
  ENV['PANTOGRAPH_OPT_OUT_USAGE'] = 'YES'
  UI.message('Disabled upload of used actions')
end

.step_text ⇒ Object 



37
38
39
 
# File 'pantograph/lib/pantograph/actions/opt_out_usage.rb', line 37

def self.step_text
  'Disabled Usage Data Tracking'
end