hackmac 1.8.3 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09d1c9d86b5f82faf58a2b4b86aff4a2bf315e81f2f30b4cf967e6fb6dfd33ca'
-  data.tar.gz: e642ea32afa25bcec1026b4e1d1cfb1ce71309aab7d32d42b55ad31b78d836fd
+  metadata.gz: 6e69904de91d7678019da3453c16e8553cd3de264dce2ff1fcfbc441569927f2
+  data.tar.gz: c265c3472238619b334ff42d77cfdd2e21c5255731fa0dedc4d26510269d1c5b
 SHA512:
-  metadata.gz: ce6b64440555a2236fa91cf059cfe8413bb6aa2361b453f694d6791fcd76a95ef397b3bd401bf9747936c3d85d46deb58e5eaed76e89600ffa9f7fe691764178
-  data.tar.gz: '092da979e7b49732c26ba139f36d58df9c11f22790bea9ff6bfa7289025562b751c5a77651632966aed4ab6cbbfacc441a1d8a97490fc43cdde6f4501c774b31'
+  metadata.gz: 39fe60b3de2e092ef2ce8a9ded9b2af554e25d30232072a8d04efd96908a573b924e27b5a2b324ea31849ec8849ef9ddbff7acfb847c8e7549084d78346fe9d5
+  data.tar.gz: 13cb1c8da6b8aba179beae4fee69dc49c3dd69ed8bdea5542ffaa1acd99c19fc10155245a193105b419a7ce1f767b3c821cfaac61ce73d0ccdfc3682df51a98d

data/CHANGES.md

@@ -1,5 +1,27 @@
 # Changes
 
+## 2025-09-20 v1.8.4
+
+- Added a new section titled "Documentation" to the README with a link to the
+  API documentation hosted at GitHub.io
+- Renamed `.context/code_comment.rb` to `.contexts/code_comment.rb` and updated
+  the directory structure for code comment context files while maintaining all
+  existing functionality
+- Added a new GitHub Actions workflow file `.github/workflows/static.yml` to
+  deploy static content to GitHub Pages
+- Updated the `Rakefile` to include the `.github` directory in the
+  `package_ignore` list and configured the workflow to run on push to the
+  master branch and manual dispatch
+- Set up permissions for deployment to GitHub Pages and installed the
+  `gem_hadar` gem to generate documentation using `rake doc`
+- Added `.yardoc` and `doc` directories to `.gitignore` and updated the
+  `Rakefile` to ignore these directories while removing `.byebug_history` from
+  both files
+- Fixed markdown escaping in documentation comments, specifically updating the
+  `@param` documentation tag in `asset_tools.rb` to yield instead of block and
+  escaping `\@format_value` and `\@plist` references in `graph.rb` and
+  `plist.rb` respectively
+
 ## 2025-09-19 v1.8.3
 
 - Enhanced README with improved formatting and detailed tool descriptions

data/README.md

@@ -7,6 +7,10 @@ customizing Hackintosh configurations. While primarily intended for users with
 Hackintosh setups, it may also be useful for ordinary Mac users who want to
 leverage its features for monitoring system performance using `gfxmon`.
 
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/hackmac/)
+
 ## Tools 🛠️
 
 ### `efi` - EFI Partition Management 📁

data/Rakefile

@@ -13,8 +13,8 @@ GemHadar do
   executables Dir['bin/*'].map(&File.method(:basename))
   test_dir    'tests'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.rvmrc', '.AppleDouble',
-    'tags', '.bundle', '.DS_Store', '.byebug_history'
-  package_ignore '.gitignore', '.contexts'
+    'tags', '.bundle', '.DS_Store', '.yardoc', 'doc'
+  package_ignore '.gitignore', '.contexts', '.github'
 
   readme      'README.md'
 

data/VERSION

@@ -1 +1 @@
-1.8.3
+1.8.4

data/hackmac.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: hackmac 1.8.3 ruby lib
+# stub: hackmac 1.8.4 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "hackmac".freeze
-  s.version = "1.8.3".freeze
+  s.version = "1.8.4".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.email = "flori@ping.de".freeze
   s.executables = ["efi".freeze, "gfxmon".freeze, "usb".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/hackmac.rb".freeze, "lib/hackmac/asset_tools.rb".freeze, "lib/hackmac/config.rb".freeze, "lib/hackmac/disks.rb".freeze, "lib/hackmac/github_source.rb".freeze, "lib/hackmac/graph.rb".freeze, "lib/hackmac/graph/display.rb".freeze, "lib/hackmac/ioreg.rb".freeze, "lib/hackmac/kext.rb".freeze, "lib/hackmac/kext_upgrader.rb".freeze, "lib/hackmac/oc.rb".freeze, "lib/hackmac/oc_upgrader.rb".freeze, "lib/hackmac/oc_validator.rb".freeze, "lib/hackmac/plist.rb".freeze, "lib/hackmac/url_download.rb".freeze, "lib/hackmac/utils.rb".freeze, "lib/hackmac/version.rb".freeze]
-  s.files = [".context/code_comment.rb".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/efi".freeze, "bin/gfxmon".freeze, "bin/usb".freeze, "hackmac.gemspec".freeze, "img/gfxmon.png".freeze, "lib/hackmac.rb".freeze, "lib/hackmac/asset_tools.rb".freeze, "lib/hackmac/config.rb".freeze, "lib/hackmac/disks.rb".freeze, "lib/hackmac/github_source.rb".freeze, "lib/hackmac/graph.rb".freeze, "lib/hackmac/graph/display.rb".freeze, "lib/hackmac/hackmac.yml".freeze, "lib/hackmac/ioreg.rb".freeze, "lib/hackmac/kext.rb".freeze, "lib/hackmac/kext_upgrader.rb".freeze, "lib/hackmac/oc.rb".freeze, "lib/hackmac/oc_upgrader.rb".freeze, "lib/hackmac/oc_validator.rb".freeze, "lib/hackmac/plist.rb".freeze, "lib/hackmac/url_download.rb".freeze, "lib/hackmac/utils.rb".freeze, "lib/hackmac/version.rb".freeze]
+  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/efi".freeze, "bin/gfxmon".freeze, "bin/usb".freeze, "hackmac.gemspec".freeze, "img/gfxmon.png".freeze, "lib/hackmac.rb".freeze, "lib/hackmac/asset_tools.rb".freeze, "lib/hackmac/config.rb".freeze, "lib/hackmac/disks.rb".freeze, "lib/hackmac/github_source.rb".freeze, "lib/hackmac/graph.rb".freeze, "lib/hackmac/graph/display.rb".freeze, "lib/hackmac/hackmac.yml".freeze, "lib/hackmac/ioreg.rb".freeze, "lib/hackmac/kext.rb".freeze, "lib/hackmac/kext_upgrader.rb".freeze, "lib/hackmac/oc.rb".freeze, "lib/hackmac/oc_upgrader.rb".freeze, "lib/hackmac/oc_validator.rb".freeze, "lib/hackmac/plist.rb".freeze, "lib/hackmac/url_download.rb".freeze, "lib/hackmac/utils.rb".freeze, "lib/hackmac/version.rb".freeze]
   s.homepage = "http://github.com/flori/hackmac".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Hackmac - Some useful tools for working with a Hackintosh".freeze, "--main".freeze, "README.md".freeze]

data/lib/hackmac/asset_tools.rb

@@ -26,7 +26,7 @@ module Hackmac
     # the provided block within that context. After the block completes, it
     # ensures proper cleanup of the temporary directory.
     #
-    # @param block [ Block ] the block to execute within the temporary
+    # @yield [ dir ] the block to execute within the temporary
     # directory context
     #
     # @return [ Object ] the return value of the yielded block

data/lib/hackmac/graph.rb

@@ -317,7 +317,7 @@ class Hackmac::Graph
   # formatting strategy
   #
   # This method applies the appropriate formatting to a value based on the
-  # @format_value instance variable configuration It supports different
+  # \@format_value instance variable configuration It supports different
   # formatting approaches including custom Proc objects, Symbol-based method
   # calls, and default formatting
   #

data/lib/hackmac/plist.rb

@@ -23,7 +23,7 @@ module Hackmac
     #
     # This method executes a shell command and parses its XML output into a
     # Ruby hash using the Plist library. The resulting hash is stored in the
-    # @plist instance variable for later access through other methods.
+    # \@plist instance variable for later access through other methods.
     #
     # @param cmd [Array<String>] command and arguments to execute
     #

data/lib/hackmac/version.rb

@@ -1,6 +1,6 @@
 module Hackmac
   # Hackmac version
-  VERSION         = '1.8.3'
+  VERSION         = '1.8.4'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hackmac
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.8.4
 platform: ruby
 authors:
 - Florian Frank
@@ -176,7 +176,6 @@ extra_rdoc_files:
 - lib/hackmac/utils.rb
 - lib/hackmac/version.rb
 files:
-- ".context/code_comment.rb"
 - CHANGES.md
 - Gemfile
 - LICENSE

data/.context/code_comment.rb

@@ -1,15 +0,0 @@
-context do
-  namespace "bin" do
-    Dir['bin/*'].each do |filename|
-      file filename, tags: 'bin'
-    end
-  end
-
-  namespace "lib" do
-    Dir['lib/**/*.rb'].each do |filename|
-      file filename, tags: 'lib'
-    end
-  end
-
-  file 'README.md', tags: [ 'documentation' ]
-end