Module: AppcastXML

Defined in:
lib/autosparkle/helpers/appcast_helpers.rb

Overview

AppcastXML module to generate the appcast XML file and items

Class Method Summary collapse

Class Method Details

.append_item_to_existing_appcast(ed_signature_fragment, deployed_appcast_xml) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/autosparkle/helpers/appcast_helpers.rb', line 29

def self.append_item_to_existing_appcast(ed_signature_fragment, deployed_appcast_xml)
  puts_if_verbose 'Appending the new item to the existing appcast file...'

  doc = Nokogiri::XML(deployed_appcast_xml)

  new_item_xml = generate_appcast_item(ed_signature_fragment)
  new_item_doc = Nokogiri::XML(new_item_xml)
  new_item = new_item_doc.root

  channel = doc.at_xpath('//channel')
  channel.add_child(new_item)

  doc.to_xml
end

.current_project_version(doc) ⇒ Object 



82
83
84
85
86
87
88
 
# File 'lib/autosparkle/helpers/appcast_helpers.rb', line 82

def self.current_project_version(doc)
  # find the latest versions in the item tag for sparkle:version child
  versions = doc.xpath('//item/sparkle:version', 'sparkle' => 'http://www.andymatuschak.org/xml-namespaces/sparkle')
                .map { |s| s.text.to_i }
  latest_version = versions.max + 1
  latest_version.to_s
end

.generate_appcast_item(ed_signature_fragment) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/autosparkle/helpers/appcast_helpers.rb', line 44

def self.generate_appcast_item(ed_signature_fragment)
  date = Time.now.strftime('%a %b %d %H:%M:%S %Z %Y')
  pkg_url = "#{Env.variables.marketing_version}/#{Env.variables.app_display_name}.dmg"
  "    <item>\n      <title>\#{Env.variables.sparkle_update_title}</title>\n      <link>\#{Env.variables.website_url}</link>\n      <sparkle:version>\#{Env.variables.current_project_version}</sparkle:version>\n      <sparkle:shortVersionString>\#{Env.variables.marketing_version}</sparkle:shortVersionString>\n      <description>\n        <![CDATA[\n        \#{Env.variables.sparkle_release_notes}\n        ]]>\n      </description>\n      <pubDate>\#{date}</pubDate>\n      <enclosure url=\"\#{pkg_url}\" type=\"application/octet-stream\" \#{ed_signature_fragment} />\n      <sparkle:minimumSystemVersion>\#{Env.variables.minimum_macos_version}</sparkle:minimumSystemVersion>\n    </item>\n  XML\nend\n"

.generate_appcast_xml(ed_signature_fragment, deployed_appcast_xml) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/autosparkle/helpers/appcast_helpers.rb', line 10

def self.generate_appcast_xml(ed_signature_fragment, deployed_appcast_xml)
  if deployed_appcast_xml
    append_item_to_existing_appcast(ed_signature_fragment, deployed_appcast_xml)
  else
    puts_if_verbose 'Creating a new appcast file...'
    "      <?xml version=\"1.0\" encoding=\"utf-8\"?>\n      <rss version=\"2.0\" xmlns:sparkle=\"http://www.andymatuschak.org/xml-namespaces/sparkle\"  xmlns:dc=\"http://purl.org/dc/elements/1.1/\">\n        <channel>\n          <title>Changelog</title>\n          <description>Most recent changes with links to updates.</description>\n          <language>en</language>\n          \#{generate_appcast_item(ed_signature_fragment)}\n        </channel>\n      </rss>\n    XML\n  end\nend\n"

.marketing_version(doc) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'lib/autosparkle/helpers/appcast_helpers.rb', line 72

def self.marketing_version(doc)
  method_name = Env.variables.sparkle_bump_version_method
  raise "Unsupported bump method name '#{method_name}'" unless %w[minor patch major same].include?(method_name)

  # bump the marketing version from @variables.sparkle_bump_version_method
  short_version_strings = doc.xpath('//item/sparkle:shortVersionString', 'sparkle' => 'http://www.andymatuschak.org/xml-namespaces/sparkle')
  latest_semantic_version = short_version_strings.map { |s| Gem::Version.new(s.text) }.max
  method_name == 'same' ? latest_semantic_version.to_s : Version.bump(latest_semantic_version, method_name)
end

.retreive_versions(deployed_appcast_xml) ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/autosparkle/helpers/appcast_helpers.rb', line 65

def self.retreive_versions(deployed_appcast_xml)
  return ['1.0.0', '1'] unless deployed_appcast_xml

  doc = Nokogiri::XML(deployed_appcast_xml)
  [marketing_version(doc), current_project_version(doc)]
end