gem_hadar 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 582e04fb1d52a458c63308e9e753752ce7511f19d4fa100ae2fd3e5d3b919a8f
-  data.tar.gz: c981660811b87179ed5b9cc0fb60d598febbeb6843ff627fb930119c1450e073
+  metadata.gz: 06ac4c24e96c6dd512c2134b60e0934f9e78e17e882d47a86b2e7645b56350f1
+  data.tar.gz: c2925c0239ce6e55f86f279514b5233bc0f1d634567fbe04768da6db578f9d29
 SHA512:
-  metadata.gz: af3255e5e8b71a017653aa1c779f38ef7fa520eb65852c7977c8547a50ead4aac890db39e64b460e4bda168a390bd1b06283dc0585af401b93546daffef87a43
-  data.tar.gz: ca5576fef1a2c7ac0fbb10311f46cd07590be65ed50282734bf4cc80e9d18ecec660da5d4e5ec59a3dc8bb6d34a18054d9623925876841ec2fdc718663c08f30
+  metadata.gz: 551be5a778cb8414180d6c97fba6b6d3616b7dba1d46a5921a053f435f14362bf326935627bf4191d4eca9d5439a0cf206ff00ecf69fcbf1218c37f2466ef91e
+  data.tar.gz: faacd697e4b04ec02a173269beaeefa9b3dfd5ee56f5ffeb96326e01c6c1d5595f4d73ae4e34ea261c4148656e20023af1c9f397331011dc615ded0189cb803c

data/.github/workflows/static.yml

@@ -0,0 +1,51 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: [ "master" ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+      - name: Generate Documentation
+        run: |
+          gem install gem_hadar
+          bundle install
+          rake doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/README.md

@@ -28,6 +28,10 @@ using rake tasks. It is a comprehensive Ruby gem automation tool that provides:
 - **Gemfile and .gitignore automation** - Automatic creation and management of
   essential project files with 📦dependency management
 
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/gem_hadar/)
+
 ## Workflow Diagrams
 
 ### Gem Build Process

data/Rakefile

@@ -18,6 +18,10 @@ GemHadar do
 
   executables << 'gem_hadar'
 
+  github_workflows(
+    'static.yml' => { branches: '[ "master" ]' }
+  )
+
   dependency 'tins',           '~> 1'
   dependency 'term-ansicolor', '~> 1.0'
   dependency 'ollama-ruby',    '~> 1.7'

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.5.0 ruby lib
+# stub: gem_hadar 2.7.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.5.0".freeze
+  s.version = "2.7.0".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 = ["gem_hadar".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/warn.rb".freeze]
-  s.files = ["Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/warn.rb".freeze, "spec/gem_hadar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.files = [".github/workflows/static.yml".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/github_workflows/static.yml.erb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/warn.rb".freeze, "spec/gem_hadar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
   s.homepage = "https://github.com/flori/gem_hadar".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "GemHadar - Library for the development of Ruby Gems".freeze, "--main".freeze, "README.md".freeze]
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.4".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.7".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.13".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.0".freeze])

data/lib/gem_hadar/github.rb

@@ -30,6 +30,17 @@ class GemHadar::GitHub::ReleaseCreator
   end
   self.github_api_url = 'https://api.github.com'
 
+  # The initialize method sets up the ReleaseCreator instance with required
+  # GitHub API configuration.
+  #
+  # This method stores the owner, repository, and authentication token needed
+  # to interact with the GitHub Releases API. It also accepts an optional API
+  # version parameter to specify which version of the GitHub API to use.
+  #
+  # @param owner [ String ] the GitHub username or organization name
+  # @param repo [ String ] the repository name
+  # @param token [ String ] the personal access token for authentication
+  # @param api_version [ String ] the GitHub API version to use (defaults to '2022-11-28')
   def initialize(owner:, repo:, token:, api_version: '2022-11-28')
     @owner       = owner
     @repo        = repo
@@ -37,6 +48,25 @@ class GemHadar::GitHub::ReleaseCreator
     @api_version = api_version
   end
 
+  # The perform method creates a new GitHub release using the GitHub API.
+  #
+  # This method sends a POST request to the GitHub Releases API to create a new
+  # release for the specified repository. It constructs the appropriate HTTP
+  # headers including authentication and content type, prepares the release
+  # data with the provided parameters, and handles the API response by parsing
+  # successful responses or raising an error for failed requests.
+  #
+  # @param tag_name [ String ] the name of the tag to associate with the release
+  # @param target_commitish [ String ] the commit SHA or branch name to use for the release
+  # @param body [ String ] the release notes or description content
+  # @param name [ String ] the name of the release (defaults to tag_name)
+  # @param draft [ Boolean ] whether to create a draft release (defaults to false)
+  # @param prerelease [ Boolean ] whether to mark the release as a pre-release (defaults to false)
+  #
+  # @return [ JSON::GenericObject ] the parsed response data from the GitHub API containing
+  #   details about the created release
+  #
+  # @raise [ RuntimeError ] if the GitHub API request fails with a non-success status code
   def perform(tag_name:, target_commitish:, body:, name: tag_name, draft: false, prerelease: false)
     uri = URI("#{self.class.github_api_url}/repos/#@owner/#@repo/releases")
 

data/lib/gem_hadar/github_workflows/static.yml.erb

@@ -0,0 +1,51 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: <%= github_workflows_variables.fetch(:branches, '[ "master" ]') %>
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+      - name: Generate Documentation
+        run: |
+          gem install gem_hadar
+          bundle install
+          rake doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'doc'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/lib/gem_hadar/template_compiler.rb

@@ -41,7 +41,7 @@ class GemHadar::TemplateCompiler
   def compile(src, dst)
     template = File.read(src)
     File.open(dst, 'w') do |output|
-      erb = ERB.new(template, nil, '-')
+      erb = ERB.new(template, trim_mode: ?-)
       erb.filename = src.to_s
       output.write erb.result binding
     end

data/lib/gem_hadar/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '2.5.0'
+  VERSION         = '2.7.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/gem_hadar.rb

@@ -140,11 +140,14 @@ class GemHadar
     [ name, version ] * '-'
   end
 
-  # The module_type attribute accessor for configuring the type of Ruby construct to generate for version code.
+  # The module_type attribute accessor for configuring the type of Ruby
+  # construct to generate for version code.
   #
-  # This method sets up a DSL accessor for the module_type attribute, which determines whether the generated code
-  # structure for the version module should be a :module or :class. This controls the type of Ruby construct
-  # created when generating code skeletons and version files. The value can be set to either:
+  # This method sets up a DSL accessor for the module_type attribute, which
+  # determines whether the generated code structure for the version module
+  # should be a :module or :class. This controls the type of Ruby construct
+  # created when generating code skeletons and version files. The value can be
+  # set to either:
   #
   # - :module (default) - Generates module-based structure
   # - :class - Generates class-based structure
@@ -342,10 +345,10 @@ class GemHadar
 
   # The test_dir attribute accessor for configuring the test directory.
   #
-  # This method sets up a DSL accessor for the test_dir attribute, which specifies
-  # the directory where test files are located. It provides a way to define the
-  # location of the test directory that will be used by various testing tasks and
-  # configurations within the gem project.
+  # This method sets up a DSL accessor for the test_dir attribute, which
+  # specifies the directory where test files are located. It provides a way to
+  # define the location of the test directory that will be used by various
+  # testing tasks and configurations within the gem project.
   #
   # @return [ String, nil ] the path to the test directory or nil if not set
   dsl_accessor :test_dir
@@ -552,9 +555,9 @@ class GemHadar
   # display after gem installation.
   #
   # This method sets up a DSL accessor for the post_install_message attribute,
-  # which specifies a message to be displayed to users after the gem is installed.
-  # This can be useful for providing additional information, usage instructions,
-  # or important warnings to users of the gem.
+  # which specifies a message to be displayed to users after the gem is
+  # installed. This can be useful for providing additional information, usage
+  # instructions, or important warnings to users of the gem.
   #
   # @return [ String, nil ] the post-installation message or nil if not set
   dsl_accessor :post_install_message
@@ -776,7 +779,13 @@ class GemHadar
     if args.empty?
       package_ignore_files
     else
-      args.each { |a| package_ignore_files << a }
+      args.each do |arg|
+        if File.directory?(arg)
+          package_ignore_files.merge FileList['%s/**/*' % arg]
+        else
+          package_ignore_files << arg
+        end
+      end
     end
   end
 
@@ -1214,10 +1223,10 @@ class GemHadar
   # namespace:
   #
   # - It creates subtasks in the :version:push namespace for each configured
-  # Git remote, allowing individual pushes to specific remotes.
+  #   Git remote, allowing individual pushes to specific remotes.
   # - It also defines a top-level :version:push task that depends on all the
-  # individual remote push tasks, enabling a single command to push the version
-  # tag to all remotes.
+  #   individual remote push tasks, enabling a single command to push the
+  #   version tag to all remotes.
   #
   # The tasks utilize the git_remotes method to determine which remotes are
   # configured and generate appropriate push commands for each one.
@@ -1240,13 +1249,14 @@ class GemHadar
   # The master_push_task method defines Rake tasks for pushing the master
   # branch to configured Git remotes.
   #
-  # This method sets up a hierarchical task structure under the :master namespace:
+  # This method sets up a hierarchical task structure under the :master
+  # namespace:
   #
   # - It creates subtasks in the :master:push namespace for each configured Git
   #   remote, allowing individual pushes to specific remotes.
-  # - It also defines a top-level :master:push task that depends on all the individual
-  #   remote push tasks, enabling a single command to push the master branch to
-  #   all remotes.
+  # - It also defines a top-level :master:push task that depends on all the
+  #   individual remote push tasks, enabling a single command to push the master
+  #   branch to all remotes.
   #
   # The tasks utilize the git_remotes method to determine which remotes are
   # configured and generate appropriate push commands for each one.
@@ -1459,7 +1469,8 @@ class GemHadar
   # The rvm_task method creates a .rvmrc file that configures RVM to use the
   # specified Ruby version and gemset for the project.
   #
-  # This task generates a .rvmrc file in the project root directory with commands to:
+  # This task generates a .rvmrc file in the project root directory with
+  # commands to:
   # - Use the Ruby version specified by the rvm.use accessor
   # - Create the gemset specified by the rvm.gemset accessor
   # - Switch to using that gemset
@@ -1479,9 +1490,20 @@ class GemHadar
     end
   end
 
+  # The yard_doc_task method configures and sets up a YARD documentation
+  # generation task.
+  #
+  # This method initializes a YARD::Rake::YardocTask that processes Ruby source
+  # files and generates comprehensive documentation including private and
+  # protected methods. It configures the output directory, handles README
+  # files, includes additional documentation files, and sets up a pre-execution
+  # cleanup routine.
+  #
+  # @return [ void ] This method does not return a value but defines a Rake task
+  #                   named :yard_doc with specific configuration options.
   def yard_doc_task
     YARD::Rake::YardocTask.new(:yard_doc) do |t|
-      t.files = doc_code_files.select { _1 =~ /\.rb\z/ }
+      t.files = doc_code_files.grep(%r(\.rb\z))
 
       output_dir = yard_dir
       t.options = [ "--output-dir=#{output_dir}" ]
@@ -1512,8 +1534,8 @@ class GemHadar
   #
   # It creates multiple subtasks under the :yard namespace, including tasks for
   # creating private documentation, viewing the generated documentation,
-  # cleaning up documentation files, and listing undocumented elements.
-  # If YARD is not available, the method returns early without defining any tasks.
+  # cleaning up documentation files, and listing undocumented elements. If YARD
+  # is not available, the method returns early without defining any tasks.
   def yard_task
     defined? YARD or return
     yard_doc_task
@@ -1551,6 +1573,14 @@ class GemHadar
     task :yard => %i[ yard:private yard:view ]
   end
 
+  # The config_task method creates a Rake task that displays the current
+  # GemHadar configuration.
+  #
+  # This method sets up a :gem_hadar:config task under the Rake namespace that
+  # outputs detailed information about the gem's configuration, including
+  # environment variables, API keys, Ollama settings, XDG configuration
+  # directory, general gem properties, build and development parameters, Git
+  # remotes, and AI prompt defaults.
   def config_task
     namespace :gem_hadar do
       desc "Display current gem_hadar configuration"
@@ -1644,6 +1674,7 @@ class GemHadar
     version_tag_task
     push_task
     release_task
+    github_workflows_task
     write_ignore_file
     write_gemfile
     if extensions.full?
@@ -1720,7 +1751,8 @@ class GemHadar
   # set. The method then constructs the full base URL and initializes an
   # Ollama::Client with appropriate timeouts for read and connect operations.
   #
-  # @return [Ollama::Client, nil] An initialized Ollama::Client instance if a valid base URL is present, otherwise nil.
+  # @return [Ollama::Client, nil] An initialized Ollama::Client instance if a
+  #   valid base URL is present, otherwise nil.
   def ollama_client
     base_url = ENV['OLLAMA_URL']
     if base_url.blank?
@@ -1991,6 +2023,71 @@ class GemHadar
       remotes_uris.find { |uri| uri.hostname == 'github.com' }
     end
   end
+
+  # The github_workflows attribute accessor for configuring GitHub Actions
+  # workflows.
+  #
+  # This method sets up a DSL accessor for the github_workflows attribute,
+  # which specifies the configuration for generating GitHub Actions workflow
+  # files from ERB templates. It provides a way to define which workflows to
+  # generate and the variables to use when rendering the templates.
+  #
+  # @return [ Hash ] a hash mapping workflow names to their configuration
+  #   variables
+  dsl_accessor :github_workflows do
+    {}
+  end
+
+  # The github_workflows_variables method retrieves the cached variables used
+  # for GitHub Actions workflow template compilation.
+  #
+  # This method returns the stored hash of variables that were previously set
+  # during the configuration of GitHub workflows. If no variables have been
+  # set, it returns an empty hash as a default value.
+  #
+  # @return [ Hash ] the hash of variables used for GitHub workflow template
+  #   rendering or an empty hash if none are set
+  def github_workflows_variables
+    @github_workflows_variables || {}
+  end
+
+  # The github_workflows_task method sets up Rake tasks for generating GitHub
+  # Actions workflow files from ERB templates.
+  #
+  # This method configures a hierarchical task structure under the :github namespace that:
+  # - Compiles configured workflow templates from ERB files into actual workflow YAML files
+  # - Creates a :workflows task that depends on all compiled template files
+  # - Sets up a :workflows:clean task to remove generated workflow files
+  # - Uses the github_workflows configuration to determine which workflows to generate
+  # - Applies template variables to customize the generated workflows
+  def github_workflows_task
+    namespace :github do
+      templates = []
+      src_dir = Pathname.new(__dir__).join('gem_hadar', 'github_workflows')
+      dst_dir = Pathname.pwd.join('.github', 'workflows')
+      github_workflows.each do |workflow, variables|
+        @github_workflows_variables = variables
+        src = src_dir.join(workflow + '.erb')
+        puts "Compiling #{src.to_s.inspect} to #{dst_dir.to_s.inspect} now."
+        unless src.exist?
+          warn "Workflow template #{src.to_s.inspect} doesn't exist! => Skipping."
+        end
+        mkdir_p dst_dir
+        dst = dst_dir.join(workflow)
+        templates << (template(src, dst) {}).to_s
+      end
+      desc "Create all configured github workflow tasks"
+      task :workflows => templates
+      namespace :workflows do
+        desc "Delete all created github workflows"
+        task :clean do
+          github_workflows.each_key do |workflow|
+            rm_f dst_dir.join(workflow), verbose: true
+          end
+        end
+      end
+    end
+  end
 end
 
 # The GemHadar method serves as the primary entry point for configuring and
@@ -2015,14 +2112,18 @@ end
 # using the provided block configuration. It ensures the source file has an
 # extension and raises an error if not.
 #
-# @param pathname [ String ] the path to the template file to be processed
+# @param src [ String ] the path to the template file to be processed
+# @param dst [ String ] the path to file that will be the product
 #
 # @yield [ block ] the configuration block for the template compiler
 #
 # @return [ Pathname ] the Pathname object representing the destination file path
-def template(pathname, &block)
-  template_src = Pathname.new(pathname)
-  template_dst = template_src.sub_ext('') # ignore ext, we just support erb anyway
+def template(src, dst = nil, &block)
+  template_src = Pathname.new(src)
+  template_dst = dst ? Pathname.new(dst) : template_src
+  if template_dst.extname == '.erb'
+    template_dst = template_dst.sub_ext('erb')
+  end
   template_src == template_dst and raise ArgumentError,
     "pathname #{pathname.inspect} needs to have a file extension"
   file template_dst.to_s => template_src.to_s do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +139,7 @@ extra_rdoc_files:
 - lib/gem_hadar/version.rb
 - lib/gem_hadar/warn.rb
 files:
+- ".github/workflows/static.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -147,6 +148,7 @@ files:
 - gem_hadar.gemspec
 - lib/gem_hadar.rb
 - lib/gem_hadar/github.rb
+- lib/gem_hadar/github_workflows/static.yml.erb
 - lib/gem_hadar/prompt_template.rb
 - lib/gem_hadar/setup.rb
 - lib/gem_hadar/simplecov.rb