itamae-plugin-recipe-highlight 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55a224b40eead43e2019b3a8544b475e34cb396b3a11d4630d6a52ff5cf30428
-  data.tar.gz: e13931058305a26dfe8f92254b766fd960b097ca44a16b8f4bc21c69889b00b9
+  metadata.gz: 2160685314e586f026eaf4e5f082bcb54e6b384f0b137ee7dc141825fe63c2ac
+  data.tar.gz: 212ac98b6198685f296f5f73ad047086b39b8e5bca74fc68a9a225dee7f03a95
 SHA512:
-  metadata.gz: 92c536b2c5bd7385911105f63033464ff5b105e23703369d01d0ffdb4785b194e79d6c054d32de273fb349ef920b17714e3ad5cfca5c025e4f1dfac848e6d5e9
-  data.tar.gz: a72add179fedb6db7722f5409dd4fa8d1f00fb24dbf2fe57f147295f4241d34c99a3564213ad86aabaddba9887bd16e1c1054ed0f3b3eed319d9850bfc9d85b7
+  metadata.gz: 8ad25864df90cf5ff7c36eb0f02c9e417a4c8ccca1e1d440451c08d2b40ca6e778e1648e13d2cb9e16f8307b38ee4b7c50905ee09e1213e07efcd55de7db592f
+  data.tar.gz: e71483e9ab2c9b6396db6e76eb09a42a3d885c0c5d210e353a4dc1a22d38b9c085186219b2d371ad1e1ce15e3def2c367790f92594ea1f627d4b2e7fa02e4fe6

data/CHANGELOG.md

@@ -1,5 +1,39 @@
-## [Unreleased]
+# Change log for Itamae plugin recipe Highlight
 
-## [0.1.0] - 2023-09-10
+## Unreleased
+
+## 0.3.0 - 2023-11-14
+
+### Changed
+
+* Update Highlight version to v4.10.
+* The role of `node[:highlight][:tmp]`.
+  It is now a prefix for temporary directory path, and the full path is auto generated.
+
+### Added
+
+* `highlight` / `commands` / `wget` node attribute.
+  [GNU Wget][wget] is used for downloading the archive file.
+
+[wget]: https://www.gnu.org/software/wget/
+
+### Fixed
+
+* Changed to use GNU Wget instead of the Itamae's HTTP request resource since updating archive files might somehow fail.
+
+## 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,96 +1,148 @@
 require 'shellwords'
 require 'uri'
 
-node['highlight']                 ||= {}
-node['highlight']['dependencies'] ||= {}
-node['highlight']['commands']     ||= {}
-
-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'
-
-verify = node['highlight']['verify']
-verify = true if verify.nil?
-verify = false if verify == 'false'
-
-version_grep_command = ['grep', "highlight version #{ version }"].shelljoin
-version_check_command = "highlight --version | #{ version_grep_command }"
-
-directory tmp do
-  not_if 'type highlight'
-  not_if version_check_command
+node.reverse_merge!(
+  {
+    highlight: {
+      tmp: '/tmp',
+      version: '4.10',
+      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',
+        wget: 'wget',
+      }
+    }
+  }
+)
+
+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,
+        wget: string,
+      }
+    }
+  }
 end
 
-archive_file_name = "highlight-#{ version }.tar.bz2"
-archive_file_path = File.join(tmp, archive_file_name)
-download_root_url = 'http://www.andre-simon.de/zip/'
+command_exists = [node[:highlight][:commands][:type], node[:highlight][:command]].shelljoin
 
-http_request archive_file_path do
-  url URI.join(download_root_url, archive_file_name).to_s
+grep_version = [node[:highlight][:commands][:grep], "highlight version #{ node[:highlight][:version] }"].shelljoin
+print_version = [node[:highlight][:command], '--version'].shelljoin
+updated = "#{ print_version } | #{ grep_version }"
 
-  not_if 'type highlight'
-  not_if version_check_command
-end
+Dir.mktmpdir(node[:highlight][:tmp]) do |tmp_dir|
+  source_dir = File.join(tmp_dir, "highlight-#{ node[:highlight][:version] }")
+  makefile_exists = [node[:highlight][:commands][:test], '-f', File.join(source_dir, 'makefile')].shelljoin
 
-if verify
-  signature_name = "highlight-#{ version }.tar.bz2.asc"
-  signature_path = File.join(tmp, signature_name)
+  archive_file_name = "highlight-#{ node[:highlight][:version] }.tar.bz2"
+  archive_file_path = File.join(tmp_dir, archive_file_name)
+  download_root_url = 'http://www.andre-simon.de/zip/'
 
-  http_request signature_path do
-    url URI.join(download_root_url, signature_name).to_s
+  directory tmp_dir
 
-    not_if 'type highlight'
-    not_if version_check_command
-  end
+  package 'wget'
 
-  execute 'receive key' do
-    command [gpg, '--keyserver', 'pgp.mit.edu', '--recv-key', 'D805A7C7'].shelljoin
+  execute 'download archive file' do
+    cwd tmp_dir
+    download = [node[:highlight][:commands][:wget], URI.join(download_root_url, archive_file_name).to_s].shelljoin
+    command download
 
-    not_if 'type highlight'
-    not_if version_check_command
+    not_if command_exists
+    not_if updated
+    not_if makefile_exists
   end
 
-  execute 'verify' do
-    command [gpg, '--verify', signature_path, archive_file_path].shelljoin
+  if node[:highlight][:verify]
+    signature_name = "highlight-#{ node[:highlight][:version] }.tar.bz2.asc"
+    signature_path = File.join(tmp_dir, signature_name)
 
-    not_if 'type highlight'
-    not_if version_check_command
-  end
-end
+    http_request signature_path do
+      url URI.join(download_root_url, signature_name).to_s
 
-execute 'extract' do
-  command ['tar', 'axf', archive_file_path].shelljoin
-  cwd tmp
+      not_if command_exists
+      not_if updated
+      not_if [node[:highlight][:commands][:test], '-f', signature_path].shelljoin
+    end
 
-  not_if 'type highlight'
-  not_if version_check_command
-end
+    execute 'receive key' do
+      key_id = 'D805A7C7'
+
+      fetch_key = [node[:highlight][:commands][:gpg], '--keyserver', 'pgp.mit.edu', '--recv-key', key_id].shelljoin
+      command fetch_key
+
+      not_if command_exists
+      not_if updated
+
+      export_public_key = [node[:highlight][:commands][:gpg], '--export', '--armor', key_id].shelljoin
+      check_not_yet_imported = [node[:highlight][:commands][:grep], 'nothing exported'].shelljoin
+      only_if "#{ export_public_key } | #{ check_not_yet_imported }"
+    end
 
-[lua, boost].each do |pack|
-  package pack do
+    execute 'verify' do
+      verify_archive = [node[:highlight][:commands][: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
-end
 
-source_dir = File.join(tmp, "highlight-#{ version }")
+  execute 'extract' do
+    extract_archive = [node[:highlight][:commands][:tar], 'axf', archive_file_path].shelljoin
+    command extract_archive
+    cwd tmp_dir
 
-execute 'compile' do
-  command [make, 'cli'].shelljoin
-  cwd source_dir
+    not_if command_exists
+    not_if updated
+    not_if makefile_exists
+  end
 
-  not_if 'type highlight'
-  not_if version_check_command
-end
+  [node[:highlight][:dependencies][:lua], node[:highlight][:dependencies][:boost]].each do |pack|
+    package pack do
+      not_if command_exists
+      not_if updated
+    end
+  end
 
-execute 'install' do
-  command [make, 'install'].shelljoin
-  cwd source_dir
+  execute 'compile' do
+    compile_cli = [node[:highlight][:commands][: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
+    install_files = [node[:highlight][:commands][:make], 'install'].shelljoin
+    command install_files
+    cwd source_dir
+
+    not_if command_exists
+    not_if updated
+  end
 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.3.0'
       end
     end
   end

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

@@ -5,7 +5,6 @@ module Itamae
     module Recipe
       module Highlight
         class Error < StandardError; end
-        # Your code goes here...
       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.3.0
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-10 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: itamae