Module: Pod::Specification::DSL::RootAttributesAccessors

Defined in:
lib/cocoapods-core/specification/root_attribute_accessors.rb

Overview

Provides the accessors methods for the root attributes. Root attributes do not support multi-platform values and inheritance.

Instance Method Summary collapse

Instance Method Details

#authors ⇒ Hash

Note:

The value is coerced to a hash with a nil email if needed.

Returns a hash containing the authors as the keys and their email address as the values.

Examples:

Possible values


{ 'Author' => '[email protected]' }
[ 'Author', { 'Author_2' => '[email protected]' } ]
[ 'Author', 'Author_2' ]
'Author'

Returns:

  • (Hash) —

    a hash containing the authors as the keys and their email address as the values.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 55

def authors
  authors = attributes_hash['authors']
  if authors.is_a?(Hash)
    authors
  elsif authors.is_a?(Array)
    result = {}
    authors.each do |name_or_hash|
      if name_or_hash.is_a?(String)
        result[name_or_hash] = nil
      else
        result.merge!(name_or_hash)
      end
    end
    result
  elsif authors.is_a?(String)
    { authors => nil }
  end
end

#base_name ⇒ String

Returns The name of the specification not including the names of the parents, in case of ‘sub-specifications’.

Returns:

  • (String) —

    The name of the specification not including the names of the parents, in case of ‘sub-specifications’.



11
12
13
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 11

def base_name
  attributes_hash['name']
end

#cocoapods_version ⇒ Requirement

Returns The CocoaPods version required to use the specification.

Returns:

  • (Requirement) —

    The CocoaPods version required to use the specification.



39
40
41
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 39

def cocoapods_version
  @cocoapods_version ||= Requirement.create(attributes_hash['cocoapods_version'])
end

#deprecated ⇒ Bool

Returns Whether the Pod has been deprecated.

Returns:

  • (Bool) —

    Whether the Pod has been deprecated.



151
152
153
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 151

def deprecated
  attributes_hash['deprecated']
end

#deprecated? ⇒ Bool

Returns Wether the pod is deprecated either in favor of some other pod or simply deprecated.

Returns:

  • (Bool) —

    Wether the pod is deprecated either in favor of some other pod or simply deprecated.



165
166
167
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 165

def deprecated?
  deprecated || !deprecated_in_favor_of.nil?
end

#deprecated_in_favor_of ⇒ String

Returns The name of the Pod that this one has been deprecated in favor of.

Returns:

  • (String) —

    The name of the Pod that this one has been deprecated in favor of.



158
159
160
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 158

def deprecated_in_favor_of
  attributes_hash['deprecated_in_favor_of']
end

#description ⇒ String

Note:

The indentation is stripped from the description.

Returns A longer description of the Pod.

Returns:

  • (String) —

    A longer description of the Pod.



121
122
123
124
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 121

def description
  description = attributes_hash['description']
  description.strip_heredoc.chomp if description
end

#documentation_url ⇒ String, Nil

Returns The documentation URL of the Pod if specified.

Returns:

  • (String, Nil) —

    The documentation URL of the Pod if specified.



138
139
140
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 138

def documentation_url
  attributes_hash['documentation_url']
end

#homepage ⇒ String

Returns The URL of the homepage of the Pod.

Returns:

  • (String) —

    The URL of the homepage of the Pod.



99
100
101
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 99

def homepage
  attributes_hash['homepage']
end

#license ⇒ Hash

Note:

The indentation is stripped from the license text.

Returns A hash containing the license information of the Pod.

Returns:

  • (Hash) —

    A hash containing the license information of the Pod.



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 84

def license
  license = attributes_hash['license']
  if license.is_a?(String)
    { :type => license }
  elsif license.is_a?(Hash)
    license = convert_keys_to_symbol(license)
    license[:text] = license[:text].strip_heredoc if license[:text]
    license
  else
    {}
  end
end

#module_map ⇒ String, Nil

Returns The custom module map file of the Pod, if specified.

Returns:

  • (String, Nil) —

    The custom module map file of the Pod, if specified.



172
173
174
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 172

def module_map
  attributes_hash['module_map']
end

#name ⇒ String

Returns The name of the specification including the names of the parents, in case of ‘sub-specifications’.

Returns:

  • (String) —

    The name of the specification including the names of the parents, in case of ‘sub-specifications’.



18
19
20
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 18

def name
  parent ? "#{parent.name}/#{base_name}" : base_name
end

#prepare_command ⇒ String, Nil

Returns The prepare command of the Pod if specified.

Returns:

  • (String, Nil) —

    The prepare command of the Pod if specified.



144
145
146
147
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 144

def prepare_command
  command = attributes_hash['prepare_command']
  command.strip_heredoc.chomp if command
end

#screenshots ⇒ Array<String>

Note:

The value is coerced to an array.

Returns The list of the URL for the screenshots of the Pod.

Returns:

  • (Array<String>) —

    The list of the URL for the screenshots of the Pod.



131
132
133
134
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 131

def screenshots
  value = attributes_hash['screenshots']
  [*value]
end

#social_media_url ⇒ String

Returns The social media URL.

Returns:

  • (String) —

    The social media URL.



76
77
78
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 76

def social_media_url
  attributes_hash['social_media_url']
end

#source ⇒ Hash{Symbol=>String}

Returns The location from where the library should be retrieved.

Returns:

  • (Hash{Symbol=>String}) —

    The location from where the library should be retrieved.



106
107
108
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 106

def source
  convert_keys_to_symbol(attributes_hash['source'])
end

#summary ⇒ String

Returns A short description of the Pod.

Returns:

  • (String) —

    A short description of the Pod.



112
113
114
115
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 112

def summary
  summary = attributes_hash['summary']
  summary.strip_heredoc.chomp if summary
end

#version ⇒ Version

TODO:

The version is memoized because the Resolvers sets the head state on it. This information should be stored in the specification instance and the lockfile should have a more robust handling of head versions (like a dedicated section).

Returns The version of the Pod.

Returns:

  • (Version) —

    The version of the Pod.



29
30
31
32
33
34
35
 
# File 'lib/cocoapods-core/specification/root_attribute_accessors.rb', line 29

def version
  if root?
    @version ||= Version.new(attributes_hash['version'])
  else
    @version ||= root.version
  end
end