sparkle_appcast 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d53602018aca02ede32180faa6f1793ce88007cfe917f0b49dd8ff7569dbad34
-  data.tar.gz: 1cf9b9ac1d6674d4db17ab007da8e3ae9dd37e5ed7bd2d3f13db197358827c37
+  metadata.gz: 929419facdaf44c5ea9624ec0eb8229b099e5f63697bccffe903d077d9e90309
+  data.tar.gz: 0bb5d457ad0839d7896ebb3ed14a7343e2e6cfaa61da0d4e106e825e5c115ad5
 SHA512:
-  metadata.gz: 6c06b95f733b14eca7e27b2d7833946758b35c6a83dc3a8200eb062c0b2844d412582b5a86aabe985d3233376348439837a5d6d33e4d947e8ba98d813437b094
-  data.tar.gz: ab6beee04561fc1b42490b7e1b825fcdb3ff0dfe8ae8c4649126761717dbda0d49b9379e61d25026580e421960443547bbab22c5787ad73be9e6e24ddc511041
+  metadata.gz: a0ae0f9ab4b47e86b7fc1c87345e2d34e6d4d44ea87f26a16222bf32bcd64397a2188441a7ccbad57b2c89afe73928efb68ca1269ee8032170393782d36e11de
+  data.tar.gz: 6a4fb943634c2e70dbff76dcab3c36a0e5d0efcf57f444fff4b6cec046560456a65a6b4fa51b74dba81ce87ee48eb9932cc21755858e71aa0bec818705231080

data/README.md

@@ -27,6 +27,10 @@ to create and update `appcast.xml` for [Sparkle](https://sparkle-project.org).
 Create `appcast.xml` with an application archive at `FILE_PATH`.
 The application archive file must contain exact one application bundle.
 
+The value or content of each template-enabled key can include [Mustache](https://mustache.github.io/) style (``{{key}}``) template.
+Each template is replaced with the value with the information of application bundle.
+Use `info` command to list all possible template keys.
+
 * `--key=KEY`
 
     Path to DSA private key file. Required.
@@ -34,10 +38,12 @@ The application archive file must contain exact one application bundle.
 * `--url=URL`
 
     URL to the application archive file published. Required.
+    Template is enabled.
 
 * `--release-note=RELEASE_NOTE`
 
-    Path to a release note text file in Markdown format. Required.
+    Path to a release note text file in [Markdown](https://daringfireball.net/projects/markdown/syntax) format. Required.
+    Template is enabled on the content of text file.
 
 * `--output=OUTPUT`
 
@@ -47,7 +53,8 @@ The application archive file must contain exact one application bundle.
 * `--title=TITLE`
 
     Title for the release note. Optional.
-    Default to `"{{Bundle Name}} {Bundle Short Version String}} ({{Bundle Version}})"`.
+    Default to `{{bundle_name}} {{bundle_short_version_string}} ({{bundle_version}})`
+    Template is enabled.
 
 * `--publish-date=PUBLISH_DATE`
 
@@ -57,12 +64,27 @@ The application archive file must contain exact one application bundle.
 * `--channel-title=CHANNEL_TITLE`
 
     Title of the channel. Optional.
-    Default to `"Change log"`.
+    Default to `{{bundle_name}} Changelog`.
+    Template is enabled.
 
 * `--channel-description=CHANNEL_DESCRIPTION`
 
     Description of the channel. Optional.
-    Default to `"The most recent changes."`.
+    Default to `Most recent changes with links to updates.`.
+    Template is enabled.
+
+* `--channel-language=CHANNEL_LANGUAGE`
+
+    Language of the channel. Optional.
+    Default to `en`.
+    Template is enabled.
+
+### `info [OPTIONS...] [FILE_PATH]`
+
+Print information about the application bundle at `FILE_PATH`.
+`FILE_PATH` can be either an application archive or application bundle.
+
+Use `help info` for all possible options.
 
 ### `sign [OPTIONS...] [FILE_PATH]`
 

data/lib/sparkle_appcast/appcast.rb

@@ -1,3 +1,5 @@
+require "mustache"
+
 module SparkleAppcast
   class Appcast
     attr_reader :signer, :archive, :release_note, :url, :params
@@ -16,27 +18,50 @@ module SparkleAppcast
 
     private
 
+    PARAMS_EXCLUDED_FROM_TEMPLATE = [
+      # The template is applied already to `description` value. See `base_params`.
+      :description,
+      :dsa_signature
+    ]
+
     def rss_params
+      @rss_params ||= base_params.inject({}) do |params, (key, value)|
+        unless PARAMS_EXCLUDED_FROM_TEMPLATE.include?(key)
+          case value
+          when String
+            value = Mustache.render(value, context)
+          end
+        end
+        params[key] = value
+        params
+      end
+    end
+
+    def base_params
       {
-        channel_link: archive.bundle_info[:feed_url],
-        title: title,
-        description: release_note.html,
+        # channel
+        channel_link: "{{feed_url}}",
+
+        # item
+        description: release_note.html(context),
         publish_date: archive.created_at,
+
+        # enclosure
         url: url,
         length: archive.size,
-        version: archive.bundle_info[:bundle_version],
-        short_version_string: archive.bundle_info[:bundle_short_version_string],
-        minimum_system_version: archive.bundle_info[:minimum_system_version],
+        version: "{{bundle_version}}",
+        short_version_string: "{{bundle_short_version_string}}",
+        minimum_system_version: "{{minimum_system_version}}",
         dsa_signature: dsa_signature
       }.merge(params)
     end
 
-    def title
-      "#{archive.bundle_info[:bundle_name]} #{archive.bundle_info[:bundle_short_version_string]} (#{archive.bundle_info[:bundle_version]})"
-    end
-
     def dsa_signature
       @dsa_signature ||= signer.sign(archive.data)
     end
+
+    def context
+      @context ||= archive.bundle_info
+    end
   end
 end

data/lib/sparkle_appcast/cli.rb

@@ -10,25 +10,26 @@ module SparkleAppcast
     end
 
     desc "appcast FILE", "Create `appcast.xml` with an application archive file."
-    long_desc <<-END_OF_DESCRIPTION
-      Create `appcast.xml` with an application archive file.
-      The application archive file must contain exact one application bundle.
-    END_OF_DESCRIPTION
     option :key, type: :string, required: true, desc: "Path to a DSA private key."
     option :url, type: :string, required: true, desc: "URL to the application archive file published."
     option :release_note, type: :string, required: true, desc: "Path to a release note text file in Markdown format."
     option :output, type: :string, desc: "Path to an output `appcast.xml`."
-    option :title, type: :string, desc: "Title for the release note."
+    option :title, type: :string, default: "{{bundle_name}} {{bundle_short_version_string}} ({{bundle_version}})", desc: "Title for the release note."
     option :publish_date, type: :string, desc: "Publish date time in local timezone."
-    option :channel_title, type: :string, default: "Change log", desc: "Title of the channel."
-    option :channel_description, type: :string, default: "The most recent changes.", desc: "Description of the channel."
+    option :channel_title, type: :string, default: "{{bundle_name}} Changelog", desc: "Title of the channel."
+    option :channel_description, type: :string, default: "Most recent changes with links to updates.", desc: "Description of the channel."
+    option :channel_language, type: :string, default: "en", desc: "Language of the channel."
     def appcast(file)
-      params = {
-        channel_title: options[:channel_title],
-        channel_description: options[:channel_description]
-      }
-      params[:title] = options[:title] if options[:title]
-      params[:publish_date] = Time.parse(options[:publish_date]) if options[:publish_date]
+      params = {}
+      [
+        :title,
+        :publish_date,
+        :channel_title,
+        :channel_description,
+        :channel_language
+      ].each do |key|
+        params[key] = options[key] if options[key] && !options[key].empty?
+      end
 
       appcast = Appcast.new(
         Archive.new(file),
@@ -48,7 +49,7 @@ module SparkleAppcast
       end
     end
 
-    desc "info FILE", "Print info about the application bundle."
+    desc "info FILE", "Print information about the application bundle."
     Bundle::INFO_KEYS.each do |key|
       option key, type: :boolean, desc: "Print #{key}."
     end
@@ -63,7 +64,6 @@ module SparkleAppcast
       exclude_keys = []
       Bundle::INFO_KEYS.each do |key|
         case options[key]
-        when nil
         when true
           include_keys << key
         when false

data/lib/sparkle_appcast/release_note.rb

@@ -1,3 +1,5 @@
+require "mustache"
+
 module SparkleAppcast
   class ReleaseNote
     def self.markdown(text)
@@ -10,8 +12,8 @@ module SparkleAppcast
       @path = path
     end
 
-    def html
-      @html ||= self.class.markdown(text)
+    def html(context = {})
+      self.class.markdown(Mustache.render(text, context))
     end
 
     def text

data/lib/sparkle_appcast/rss.rb

@@ -50,7 +50,7 @@ module SparkleAppcast
             channel.add_element("title").add_text(params[:channel_title]) if params[:channel_title]
             channel.add_element("description").add_text(params[:channel_description]) if params[:channel_description]
             channel.add_element("link").add_text(params[:channel_link]) if params[:channel_link]
-            channel.add_element("language").add_text(params[:language]) if params[:language]
+            channel.add_element("language").add_text(params[:channel_language]) if params[:channel_language]
 
             # <item> ... </item>
             channel.add_element("item").tap do |item|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sparkle_appcast
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Yoshimasa Niwa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-17 00:00:00.000000000 Z
+date: 2018-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: plist
   requirement: !ruby/object:Gem::Requirement