gem_hadar 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39502841eb210a03ac0cc4bd23daa71ecf89767a155d767c4d38bce9be0cc549
-  data.tar.gz: 17fa80cf6cf4ed8150a1a2e712df7cb6a6f3e379aac013865fe1356df604e316
+  metadata.gz: 9afac6aeee2cdaadc1ec6e896ba72deee0517321e2afb05258bce1c45b83c595
+  data.tar.gz: 7dcf1fa960040119aeea393e8ca9e82105f4ce72adde095ff050a4e518fdc93f
 SHA512:
-  metadata.gz: 70ce75b7be6a35c32c2545784d64a9dfcac98c0c0ca00ee81d7f596aa3f66371820a0de9d292d4b1d3b00d33751ae388ea70ab34a732ba415f69f2a0b5eac673
-  data.tar.gz: 368c29f2ad39ee6a10c1c68ef05389348bed13846f26a778fae509cf32cb606d7c7b9d5ad2e9168cdb36159e8f77e6af48eaa25e35866ee762d059a6fa0cbafa
+  metadata.gz: 2d7c1f2ec16839cc1dd2bb18950214bdd3513734e114868f085797860773e9bb09d42f43a24ae908237de12d45ed6eabd9e920e26be5832d171531606f0b7654
+  data.tar.gz: 9a678a6c007c88ae4c8b3ca06cede7a27ddf8bdaa741aefbd50cf7d0bc8adf60b78e09f66d4798241904991d5c4a656fde26b28b09f5a4be3c1af5fcb09a05d4

data/Rakefile

@@ -11,7 +11,8 @@ GemHadar do
   summary        'Library for the development of Ruby Gems'
   description    'This library contains some useful functionality to support the development of Ruby Gems'
   test_dir       'spec'
-  ignore         '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle', '.yardoc', 'tags'
+  ignore         '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble',
+                 '.bundle', '.yardoc', 'doc', 'tags'
   package_ignore '.gitignore', 'VERSION'
   readme         'README.md'
 

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.4.0 ruby lib
+# stub: gem_hadar 2.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.4.0".freeze
+  s.version = "2.6.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.3".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.5".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/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '2.4.0'
+  VERSION         = '2.6.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
@@ -398,6 +401,21 @@ class GemHadar
     end
   end
 
+  # The doc_code_files method manages the list of code files to be included in
+  # documentation generation.
+  #
+  # This method sets up a DSL accessor for the doc_code_files attribute, which
+  # specifies the Ruby source files that should be processed when generating
+  # YARD documentation. It defaults to using the files attribute and provides a
+  # way to customize which code files are included in the documentation build
+  # process.
+  #
+  # @return [ FileList ] a list of file paths to be included in YARD documentation generation
+  # @see GemHadar#files
+  dsl_accessor :doc_code_files do
+    files
+  end
+
   # The doc_files attribute accessor for configuring additional documentation
   # files.
   #
@@ -463,7 +481,7 @@ class GemHadar
   #
   # @return [ Array<String> ] an array of file paths to be included in the gem package
   dsl_accessor :files do
-    `git ls-files`.split("\n")
+    FileList[`git ls-files`.split("\n")]
   end
 
   # The package_ignore_files attribute accessor for configuring files to be
@@ -537,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
@@ -761,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
 
@@ -1229,9 +1253,9 @@ class GemHadar
   #
   # - 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.
@@ -1464,9 +1488,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 = files.select { _1 =~ /\.rb\z/ }
+      t.files = doc_code_files.grep(%r(\.rb\z))
 
       output_dir = yard_dir
       t.options = [ "--output-dir=#{output_dir}" ]
@@ -1497,8 +1532,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
@@ -1536,6 +1571,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"
@@ -1705,7 +1748,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?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement