Class: Fastlane::Actions::SlatherAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/slather.rb

Constant Summary collapse

ARGS_MAP = 
{
  build_directory: "--build-directory",
  input_format: "--input-format",
  scheme: "--scheme",
  buildkite: "--buildkite",
  jenkins: "--jenkins",
  travis: "--travis",
  circleci: "--circleci",
  coveralls: "--coveralls",
  simple_output: "--simple-output",
  gutter_json: "--gutter-json",
  cobertura_xml: "--cobertura-xml",
  html: "--html",
  show: "--show",
  source_directory: "--source-directory",
  output_directory: "--output-directory",
  binary_basename: "--binary-basename",
  binary_file: "--binary-file",
  ignore: "--ignore",
  workspace: "--workspace"
}.freeze

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, method_missing, other_action, return_value, sh, step_text

Class Method Details

.authors ⇒ Object 



208
209
210
211
 
# File 'lib/fastlane/actions/slather.rb', line 208

def self.authors
  # So no one will ever forget your contribution to fastlane :) You are awesome btw!
  ["mattdelves"]
end

.available_options ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/fastlane/actions/slather.rb', line 96

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :build_directory,
                                 env_name: "FL_SLATHER_BUILD_DIRECTORY", # The name of the environment variable
                                 description: "The location of the build output", # a short description of this parameter
                                 optional: true
                                ),
    FastlaneCore::ConfigItem.new(key: :proj,
                                 env_name: "FL_SLATHER_PROJ", # The name of the environment variable
                                 description: "The project file that slather looks at", # a short description of this parameter
                                 verify_block: proc do |value|
                                   UI.user_error!("No project file specified, pass using `proj: 'Project.xcodeproj'`") unless value and !value.empty?
                                 end,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :workspace,
                                 env_name: "FL_SLATHER_WORKSPACE",
                                 description: "The workspace that slather looks at",
                                 optional: true
                                ),
    FastlaneCore::ConfigItem.new(key: :scheme,
                                 env_name: "FL_SLATHER_SCHEME", # The name of the environment variable
                                 description: "Scheme to use when calling slather",
                                 optional: true
                                ),
    FastlaneCore::ConfigItem.new(key: :input_format,
                                 env_name: "FL_SLATHER_INPUT_FORMAT", # The name of the environment variable
                                 description: "The input format that slather should look for",
                                 optional: true
                                ),
    FastlaneCore::ConfigItem.new(key: :buildkite,
                                 env_name: "FL_SLATHER_BUILDKITE_ENABLED", # The name of the environment variable
                                 description: "Tell slather that it is running on Buildkite",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :jenkins,
                                 env_name: "FL_SLATHER_JENKINS_ENABLED", # The name of the environment variable
                                 description: "Tell slather that it is running on Jenkins",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :travis,
                                 env_name: "FL_SLATHER_TRAVIS_ENABLED", # The name of the environment variable
                                 description: "Tell slather that it is running on TravisCI",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :circleci,
                                 env_name: "FL_SLATHER_CIRCLECI_ENABLED",
                                 description: "Tell slather that it is running on CircleCI",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :coveralls,
                                 env_name: "FL_SLATHER_COVERALLS_ENABLED",
                                 description: "Tell slather that it should post data to Coveralls",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :simple_output,
                                 env_name: "FL_SLATHER_SIMPLE_OUTPUT_ENABLED",
                                 description: "Tell slather that it should output results to the terminal",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :gutter_json,
                                 env_name: "FL_SLATHER_GUTTER_JSON_ENABLED",
                                 description: "Tell slather that it should output results as Gutter JSON format",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :cobertura_xml,
                                 env_name: "FL_SLATHER_COBERTURA_XML_ENABLED",
                                 description: "Tell slather that it should output results as Cobertura XML format",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :html,
                                 env_name: "FL_SLATHER_HTML_ENABLED",
                                 description: "Tell slather that it should output results as static HTML pages",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :show,
                                 env_name: "FL_SLATHER_SHOW_ENABLED",
                                 description: "Tell slather that it should open static html pages automatically",
                                 is_string: false,
                                 default_value: false),
    FastlaneCore::ConfigItem.new(key: :source_directory,
                                 env_name: "FL_SLATHER_SOURCE_DIRECTORY",
                                 description: "Tell slather the location of your source files",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :output_directory,
                                 env_name: "FL_SLATHER_OUTPUT_DIRECTORY",
                                 description: "Tell slather the location of for your output files",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :ignore,
                                 env_name: "FL_SLATHER_IGNORE",
                                 description: "Tell slather to ignore files matching a path or any path from an array of paths",
                                 is_string: false,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
                                env_name: "FL_SLATHER_USE_BUNDLE_EXEC",
                                description: "Use bundle exec to execute slather. Make sure it is in the Gemfile",
                                is_string: false,
                                default_value: false),
    FastlaneCore::ConfigItem.new(key: :binary_basename,
                                env_name: "FL_SLATHER_BINARY_BASENAME",
                                description: "Basename of the binary file, this should match the name of your bundle excluding its extension (i.e. YourApp [for YourApp.app bundle])",
                                default_value: false),
    FastlaneCore::ConfigItem.new(key: :binary_file,
                                env_name: "FL_SLATHER_BINARY_FILE",
                                description: "Binary file name to be used for code coverage",
                                default_value: false)
  ]
end

.build_command(params) ⇒ Object 



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/fastlane/actions/slather.rb', line 56

def self.build_command(params)
  command = []
  command.push("bundle exec") if params[:use_bundle_exec]
  command << "slather coverage"

  ARGS_MAP.each do |key, cli_param|
    cli_value = params[key]
    if cli_value
      if cli_value.kind_of?(TrueClass)
        command << cli_param
      elsif cli_value.kind_of?(String)
        command << cli_param
        command << cli_value.shellescape
      elsif cli_value.kind_of?(Array)
        command << cli_value.map { |path| "#{cli_param} #{path.shellescape}" }
      end
    else
      next
    end
  end

  command << params[:proj].shellescape if params[:proj]
  command.join(" ")
end

.description ⇒ Object 



85
86
87
 
# File 'lib/fastlane/actions/slather.rb', line 85

def self.description
  "Use slather to generate a code coverage report"
end

.details ⇒ Object 



89
90
91
92
93
94
 
# File 'lib/fastlane/actions/slather.rb', line 89

def self.details
  return <<-eos
Slather works with multiple code coverage formats including Xcode7 code coverage.
Slather is available at https://github.com/SlatherOrg/slather
  eos
end

.has_config_file ⇒ Object 



44
45
46
 
# File 'lib/fastlane/actions/slather.rb', line 44

def self.has_config_file
  File.file?('.slather.yml')
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


213
214
215
 
# File 'lib/fastlane/actions/slather.rb', line 213

def self.is_supported?(platform)
  [:ios, :mac].include? platform
end

.output ⇒ Object 



204
205
206
 
# File 'lib/fastlane/actions/slather.rb', line 204

def self.output
  # Define the shared values you are going to provide
end

.run(params) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/fastlane/actions/slather.rb', line 31

def self.run(params)
  # This will fail if using Bundler. Skip the check rather than needing to
  # require bundler
  unless params[:use_bundle_exec]
    Actions.verify_gem!('slather')
  end

  validate_params!(params)

  command = build_command(params)
  sh command
end

.validate_params!(params) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/fastlane/actions/slather.rb', line 48

def self.validate_params!(params)
  if params[:proj] || has_config_file
    true
  else
    UI.user_error!("You have to provide a project with `:proj` or use a .slather.yml")
  end
end