itamae-plugin-recipe-highlight 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a224b40eead43e2019b3a8544b475e34cb396b3a11d4630d6a52ff5cf30428
-  data.tar.gz: e13931058305a26dfe8f92254b766fd960b097ca44a16b8f4bc21c69889b00b9
+  metadata.gz: b1d2e267ae55d36488f4df5ae57d5c694ec8ce0d278d5d49b89b3c03815ea4d9
+  data.tar.gz: '098472c06e01065d04ec2d9a77e3dbdcc73025fc00910aad8a6de97b44fae4ea'
 SHA512:
-  metadata.gz: 92c536b2c5bd7385911105f63033464ff5b105e23703369d01d0ffdb4785b194e79d6c054d32de273fb349ef920b17714e3ad5cfca5c025e4f1dfac848e6d5e9
-  data.tar.gz: a72add179fedb6db7722f5409dd4fa8d1f00fb24dbf2fe57f147295f4241d34c99a3564213ad86aabaddba9887bd16e1c1054ed0f3b3eed319d9850bfc9d85b7
+  metadata.gz: c7afc0742d8d19f72904a5d23c2d1cda086a6f83bdaea22d063cc02e1decbf9772bd6029767a62abbef013db428a6d664be19bb29c58ca1096d515bdd2e93d93
+  data.tar.gz: 31b7c7c97f3b0877ca0298fb82bee46c5a39ad9a448a92c7761fe865a22822f16e5d38bae0707812f398f8009a0f538b407d222c7ddb2a941ec9f3993270b18e

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-09-11
+
+### Added
+
+* Node attributes: `highlight` / `command`, `highlight` / `commands` / `grep`, `highlight` / `commands` / `tar`, and `highlight` / `commands` / `type`.
+* Node attributes validation
+
+### Fixed
+
+* Skip some steps when the `makefile` exists.
+* Skip downloading the signature when it exists.
+* Skip fetching the public key when it's already imported.
+
 ## [0.1.0] - 2023-09-10
 
 - Initial release

data/README.md

@@ -1,8 +1,7 @@
 # Itamae::Plugin::Recipe::Highlight
 
-itamae-plugin-recipe-highlight gem installs [Highlight][], according to [its download page][dl].
+itamae-plugin-recipe-highlight gem installs [Highlight][].
 
-[dl]: http://www.andre-simon.de/zip/download.php
 [Highlight]: http://www.andre-simon.de/doku/highlight/en/highlight.php
 
 ## Installation
@@ -23,7 +22,10 @@ gem install itamae-plugin-recipe-highlight
 
 ## Usage
 
-It installs command line interface by default.
+It installs command line interface `highlight` by default.
+Some configulations can be done by setting [the node attributes][attrs].
+
+[attrs]: https://github.com/itamae-kitchen/itamae/wiki/Node-Attributes
 
 ```ruby
 include_recipe "highlight"
@@ -32,7 +34,6 @@ include_recipe "highlight"
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
-Then, run `rake test-unit` to run the tests.
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
@@ -46,6 +47,6 @@ Bug reports and pull requests are welcome on [Codeberg][].
 
 ## License
 
-This gem is provided under [the Apache License version 2.0][apache].
+This gem is released under [the Apache License version 2.0][apache].
 
 [apache]: https://www.apache.org/licenses/LICENSE-2.0

data/lib/itamae/plugin/recipe/highlight/default.rb

@@ -1,27 +1,75 @@
 require 'shellwords'
 require 'uri'
 
-node['highlight']                 ||= {}
-node['highlight']['dependencies'] ||= {}
-node['highlight']['commands']     ||= {}
+defaults = {
+  highlight: {
+    tmp: '/tmp',
+    version: '4.8',
+    command: 'highlight',
+    verify: true,
+    dependencies: {
+      lua: 'liblua5.4-dev',
+      boost: 'libboost-dev'
+    },
+    commands: {
+      gpg: 'gpg',
+      grep: 'grep',
+      make: 'make',
+      tar: 'tar',
+      test: 'test',
+      type: 'type',
+    }
+  }
+}
+
+node.replace(defaults.merge(node))
+
+node.validate! do
+  {
+    highlight: {
+      tmp: string,
+      version: string,
+      command: string,
+      verify: boolean,
+      dependencies: {
+        lua: string,
+        boost: string,
+      },
+      commands: {
+        gpg: string,
+        grep: string,
+        make: string,
+        tar: string,
+        type: string,
+      }
+    }
+  }
+end
+
+tmp = node.dig(:highlight, :tmp)
+
+command = node.dig(:highlight, :command)
+
+command_exists = [node.dig(:highlight, :commands, :type), command].shelljoin
+
+version = node.dig(:highlight, :version)
+
+grep = node.dig(:highlight, :commands, :grep)
 
-tmp     = node['highlight']['tmp']                   || '/tmp'
-version = node['highlight']['version']               || '4.8'
-lua     = node['highlight']['dependencies']['lua']   || 'liblua5.4-dev'
-boost   = node['highlight']['dependencies']['boost'] || 'libboost-dev'
-gpg     = node['highlight']['commands']['gpg']       || 'gpg'
-make    = node['highlight']['commands']['make']      || 'make'
+grep_version = [grep, "highlight version #{ version }"].shelljoin
+print_version = [command, '--version'].shelljoin
+updated = "#{ print_version } | #{ grep_version }"
 
-verify = node['highlight']['verify']
-verify = true if verify.nil?
-verify = false if verify == 'false'
+test = node.dig(:highlight, :commands, :test)
 
-version_grep_command = ['grep', "highlight version #{ version }"].shelljoin
-version_check_command = "highlight --version | #{ version_grep_command }"
+source_dir = File.join(tmp, "highlight-#{ version }")
+makefile = File.join(source_dir, 'makefile')
+makefile_exists = [test, '-f', makefile].shelljoin
 
 directory tmp do
-  not_if 'type highlight'
-  not_if version_check_command
+  not_if command_exists
+  not_if updated
+  not_if makefile_exists
 end
 
 archive_file_name = "highlight-#{ version }.tar.bz2"
@@ -31,66 +79,85 @@ download_root_url = 'http://www.andre-simon.de/zip/'
 http_request archive_file_path do
   url URI.join(download_root_url, archive_file_name).to_s
 
-  not_if 'type highlight'
-  not_if version_check_command
+  not_if command_exists
+  not_if updated
+  not_if makefile_exists
 end
 
-if verify
+if node.dig(:highlight, :verify)
   signature_name = "highlight-#{ version }.tar.bz2.asc"
   signature_path = File.join(tmp, signature_name)
 
   http_request signature_path do
     url URI.join(download_root_url, signature_name).to_s
 
-    not_if 'type highlight'
-    not_if version_check_command
+    not_if command_exists
+    not_if updated
+    not_if [test, '-f', signature_path].shelljoin
   end
 
+  gpg = node.dig(:highlight, :commands, :gpg)
+
   execute 'receive key' do
-    command [gpg, '--keyserver', 'pgp.mit.edu', '--recv-key', 'D805A7C7'].shelljoin
+    key_id = 'D805A7C7'
+
+    fetch_key = [gpg, '--keyserver', 'pgp.mit.edu', '--recv-key', key_id].shelljoin
+    command fetch_key
 
-    not_if 'type highlight'
-    not_if version_check_command
+    not_if command_exists
+    not_if updated
+
+    export_public_key = [gpg, '--export', '--armor', key_id].shelljoin
+    check_not_yet_imported = [grep, 'nothing exported'].shelljoin
+    only_if "#{ export_public_key } | #{ check_not_yet_imported }"
   end
 
   execute 'verify' do
-    command [gpg, '--verify', signature_path, archive_file_path].shelljoin
+    verify_archive = [gpg, '--verify', signature_path, archive_file_path].shelljoin
+    command verify_archive
 
-    not_if 'type highlight'
-    not_if version_check_command
+    not_if command_exists
+    not_if updated
   end
 end
 
 execute 'extract' do
-  command ['tar', 'axf', archive_file_path].shelljoin
+  extract_archive = [node.dig(:highlight, :commands, :tar), 'axf', archive_file_path].shelljoin
+  command extract_archive
   cwd tmp
 
-  not_if 'type highlight'
-  not_if version_check_command
+  not_if command_exists
+  not_if updated
+  not_if makefile_exists
 end
 
+lua = node.dig(:highlight, :dependencies, :lua)
+boost = node.dig(:highlight, :dependencies, :boost)
+
 [lua, boost].each do |pack|
   package pack do
 
-    not_if 'type highlight'
-    not_if version_check_command
+    not_if command_exists
+    not_if updated
   end
 end
 
-source_dir = File.join(tmp, "highlight-#{ version }")
+make = node.dig(:highlight, :commands, :make)
 
 execute 'compile' do
-  command [make, 'cli'].shelljoin
+  compile_cli = [make, 'cli'].shelljoin
+  command compile_cli
   cwd source_dir
 
-  not_if 'type highlight'
-  not_if version_check_command
+  not_if command_exists
+  not_if updated
 end
 
 execute 'install' do
-  command [make, 'install'].shelljoin
+  install_files = [make, 'install'].shelljoin
+  command install_files
   cwd source_dir
 
-  not_if 'type highlight'
-  not_if version_check_command
+  not_if command_exists
+  not_if updated
 end

data/lib/itamae/plugin/recipe/highlight/version.rb

@@ -2,7 +2,7 @@ module Itamae
   module Plugin
     module Recipe
       module Highlight
-        VERSION = '0.1.0'
+        VERSION = '0.2.0'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itamae-plugin-recipe-highlight
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: itamae