Class: Fastlane::Actions::GetInfoPlistValueAction

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

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, lane_context, method_missing, other_action, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorsObject


55
56
57
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 55

def self.authors
  ["kohtenko"]
end

.available_optionsObject


33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 33

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :key,
                                 env_name: "FL_GET_INFO_PLIST_PARAM_NAME",
                                 description: "Name of parameter",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :path,
                                 env_name: "FL_GET_INFO_PLIST_PATH",
                                 description: "Path to plist file you want to read",
                                 optional: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("Couldn't find plist file at path '#{value}'") unless File.exist?(value)
                                 end)
  ]
end

.categoryObject


73
74
75
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 73

def self.category
  :project
end

.descriptionObject


25
26
27
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 25

def self.description
  "Returns value from Info.plist of your project as native Ruby data structures"
end

.detailsObject


29
30
31
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 29

def self.details
  "Get a value from a plist file, which can be used to fetch the app identifier and more information about your app"
end

.example_codeObject


63
64
65
66
67
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 63

def self.example_code
  [
    'identifier = get_info_plist_value(path: "./Info.plist", key: "CFBundleIdentifier")'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


59
60
61
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 59

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

.outputObject


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

def self.output
  [
    ['GET_INFO_PLIST_VALUE_CUSTOM_VALUE', 'The value of the last plist file that was parsed']
  ]
end

.return_typeObject


69
70
71
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 69

def self.return_type
  :string
end

.run(params) ⇒ Object


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'fastlane/lib/fastlane/actions/get_info_plist_value.rb', line 8

def self.run(params)
  require "plist"

  begin
    path = File.expand_path(params[:path])

    plist = File.open(path) { |f| Plist.parse_xml(f) }

    value = plist[params[:key]]
    Actions.lane_context[SharedValues::GET_INFO_PLIST_VALUE_CUSTOM_VALUE] = value

    return value
  rescue => ex
    UI.error(ex)
  end
end