ollama-ruby 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f94733ae4cc18ef88a39a47b7dc1722143e18fed62cdc578928adbea363c07
-  data.tar.gz: 575156188255b04799b2a43ecdd9392fdbda6b66e2901fdb9585444eabf09fb6
+  metadata.gz: 91ae1baa5bfbaca61fabd8b999527a323ba0ec345a62d7ba1d4fdd8a3f2afea0
+  data.tar.gz: d33bdaf8a42d9063acc125d90864fdf639e82a1362e51f731a85a3dd427bea60
 SHA512:
-  metadata.gz: cd2dbc16d23f0ea8d8a1d13038f45435a0805eccf041c40f8bd40ef86934bf88a57fcd060c8aba54b23ae97e0634b9f7e55ee7a4d11009e82b3a528da60c9f0b
-  data.tar.gz: 370140dfc8ce979853c65af9f7ca4b3ceb94f123e0372c6fcec96599a667e5f0888731509816cbd7c50f1265c1913c02aa69250ce1eae2cf07e43e7fd719c398
+  metadata.gz: e604e07547c56818453993713847d6ce769f328f2872c652f37940c02983c41d56de5c630f0b735eee71c141753f28c51b9f6f8303a47e554ced93ab0c7164f3
+  data.tar.gz: ba902456a6f6a674668b9c8c97bf7d2f9d06beebac239fe908bc8456b6b4681a23da54447424d287fa926b7a1ef75779a496d37627cce77e09419e4e111997a6

data/CHANGES.md

@@ -1,5 +1,39 @@
 # Changes
 
+## 2025-10-20 v1.9.0
+
+- Added `dimensions` parameter to `Ollama::Commands::Embed#initialize`
+  - Added `attr_reader :dimensions` for accessing the `dimensions` parameter
+  - Updated JSON serialization to include `dimensions` field
+  - Added specs for `dimensions` parameter instantiation and JSON conversion
+  - Parameter defaults to `nil` following same pattern as other optional params
+  - Supports truncating output embeddings to specified dimensions as per Ollama API
+  - Maintains backward compatibility with existing code
+  - Parameter type documented as `Integer, nil` in YARD comments
+- Added new GitHub Actions workflow file `.github/workflows/static.yml`
+  - Configured workflow to deploy static content to GitHub Pages
+  - Set up Ruby environment with version **3.4** for documentation generation
+  - Added steps to install `gem_hadar`, run `bundle install`, and execute `rake doc`
+  - Updated `README.md` to include documentation link at
+    https://flori.github.io/ollama-ruby/
+- Updated comment style guideline for `initialize` methods
+- Skip `say` handler tests on non-macOS systems
+  - Add conditional check for `say` command availability using `File.executable?`
+  - Skip `Ollama::Handlers::Say` tests when `say` command is not found
+  - Use `skip: skip_reason` metadata to control test execution
+- Update CI configuration
+  - Add `openssl-dev` and `ghostscript` dependencies to Dockerfile
+  - Change test command from `rake test` to `rake spec`
+  - Enable `fail_fast: true` in CI configuration
+  - Remove `rm -f Gemfile.lock` step from CI script
+  - Update `build-base` and `yaml-dev` apk packages in Dockerfile
+
+## 2025-09-13 v1.8.1
+
+- Added `.yardopts` and `tmp` to `package_ignore` in `Rakefile`
+- Updated `gem_hadar` development dependency from "~> 2.4" to "~> 2.6" in
+  gemspec
+
 ## 2025-09-12 v1.8.0
 
 - Changed `tins` dependency from `~> 1.41` to `~> 1` in both `Rakefile` and

data/README.md

@@ -6,6 +6,10 @@ Ollama is a Ruby library gem that provides a client interface to interact with
 an ollama server via the
 [Ollama API](https://github.com/ollama/ollama/blob/main/docs/api.md).
 
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/ollama-ruby/)
+
 ## Installation (gem & bundler)
 
 To install Ollama, you can use the following methods:
@@ -484,7 +488,7 @@ The homepage of this library is located at
 
 ## License
 
-This software is licensed under the <i>MIT</i> license.
+This software is licensed under the [MIT License](./LICENSE).
 
 ---
 

data/Rakefile

@@ -13,14 +13,17 @@ GemHadar do
   description 'Library that allows interacting with the Ollama API'
   test_dir    'spec'
   ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
-    '.yardoc', 'doc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp',
-    'yard'
+    '.yardoc', 'doc', 'tags', 'errors.lst', 'cscope.out', 'coverage', 'tmp'
   package_ignore '.all_images.yml', '.tool-versions', '.gitignore', 'VERSION',
-    '.rspec', '.github', '.contexts'
+    '.rspec', '.github', '.contexts', '.yardopts'
   readme      'README.md'
 
   executables << 'ollama_console' << 'ollama_update' << 'ollama_cli' << 'ollama_browse'
 
+  github_workflows(
+    'static.yml' => {}
+  )
+
   required_ruby_version  '~> 3.1'
 
   dependency             'excon',                 '~> 1.0'

data/lib/ollama/commands/embed.rb

@@ -36,9 +36,10 @@ class Ollama::Commands::Embed
   # @param options [ Ollama::Options, nil ] optional configuration parameters for the model
   # @param truncate [ Boolean, nil ] whether to truncate the input if it exceeds context length
   # @param keep_alive [ String, nil ] duration to keep the model loaded in memory
-  def initialize(model:, input:, options: nil, truncate: nil, keep_alive: nil)
-    @model, @input, @options, @truncate, @keep_alive =
-      model, input, options, truncate, keep_alive
+  # @param dimensions [ Integer, nil ] truncates the output embedding to the specified dimension.
+  def initialize(model:, input:, options: nil, truncate: nil, keep_alive: nil, dimensions: nil)
+    @model, @input, @options, @truncate, @keep_alive, @dimensions =
+      model, input, options, truncate, keep_alive, dimensions
     @stream = false
   end
 
@@ -67,6 +68,12 @@ class Ollama::Commands::Embed
   # @return [ String, nil ] duration to keep the model loaded in memory
   attr_reader :keep_alive
 
+  # The dimensions attribute reader returns the dimensions associated with the
+  # object.
+  #
+  # @return [ Integer, nil ] the dimensions value stored in the instance variable
+  attr_reader :dimensions
+
   # The stream attribute reader returns the streaming behavior setting
   # associated with the object.
   #
@@ -74,7 +81,6 @@ class Ollama::Commands::Embed
   #         streaming is enabled for the command execution (always false for embed commands)
   attr_reader :stream
 
-
   # The client attribute writer allows setting the client instance associated
   # with the object.
   #

data/lib/ollama/version.rb

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

data/ollama-ruby.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: ollama-ruby 1.8.0 ruby lib
+# stub: ollama-ruby 1.9.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ollama-ruby".freeze
-  s.version = "1.8.0".freeze
+  s.version = "1.9.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -13,18 +13,18 @@ Gem::Specification.new do |s|
   s.email = "flori@ping.de".freeze
   s.executables = ["ollama_console".freeze, "ollama_update".freeze, "ollama_cli".freeze, "ollama_browse".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/configuration/config.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/commands/version.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/json_loader.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/version.rb".freeze]
-  s.files = [".contexts/code_comment.rb".freeze, ".contexts/full.rb".freeze, ".contexts/info.rb".freeze, ".contexts/lib.rb".freeze, ".contexts/yard.md".freeze, ".yardopts".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ollama_browse".freeze, "bin/ollama_cli".freeze, "bin/ollama_console".freeze, "bin/ollama_update".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/configuration/config.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/commands/version.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/json_loader.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/version.rb".freeze, "ollama-ruby.gemspec".freeze, "spec/assets/client.json".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/options.json".freeze, "spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
+  s.files = ["CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ollama_browse".freeze, "bin/ollama_cli".freeze, "bin/ollama_console".freeze, "bin/ollama_update".freeze, "lib/ollama.rb".freeze, "lib/ollama/client.rb".freeze, "lib/ollama/client/command.rb".freeze, "lib/ollama/client/configuration/config.rb".freeze, "lib/ollama/client/doc.rb".freeze, "lib/ollama/commands/chat.rb".freeze, "lib/ollama/commands/copy.rb".freeze, "lib/ollama/commands/create.rb".freeze, "lib/ollama/commands/delete.rb".freeze, "lib/ollama/commands/embed.rb".freeze, "lib/ollama/commands/embeddings.rb".freeze, "lib/ollama/commands/generate.rb".freeze, "lib/ollama/commands/ps.rb".freeze, "lib/ollama/commands/pull.rb".freeze, "lib/ollama/commands/push.rb".freeze, "lib/ollama/commands/show.rb".freeze, "lib/ollama/commands/tags.rb".freeze, "lib/ollama/commands/version.rb".freeze, "lib/ollama/dto.rb".freeze, "lib/ollama/errors.rb".freeze, "lib/ollama/handlers.rb".freeze, "lib/ollama/handlers/collector.rb".freeze, "lib/ollama/handlers/concern.rb".freeze, "lib/ollama/handlers/dump_json.rb".freeze, "lib/ollama/handlers/dump_yaml.rb".freeze, "lib/ollama/handlers/markdown.rb".freeze, "lib/ollama/handlers/nop.rb".freeze, "lib/ollama/handlers/print.rb".freeze, "lib/ollama/handlers/progress.rb".freeze, "lib/ollama/handlers/say.rb".freeze, "lib/ollama/handlers/single.rb".freeze, "lib/ollama/image.rb".freeze, "lib/ollama/json_loader.rb".freeze, "lib/ollama/message.rb".freeze, "lib/ollama/options.rb".freeze, "lib/ollama/response.rb".freeze, "lib/ollama/tool.rb".freeze, "lib/ollama/tool/function.rb".freeze, "lib/ollama/tool/function/parameters.rb".freeze, "lib/ollama/tool/function/parameters/property.rb".freeze, "lib/ollama/version.rb".freeze, "ollama-ruby.gemspec".freeze, "spec/assets/client.json".freeze, "spec/assets/kitten.jpg".freeze, "spec/assets/options.json".freeze, "spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze, "tmp/.keep".freeze]
   s.homepage = "https://github.com/flori/ollama-ruby".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "Ollama-ruby - Interacting with the Ollama API".freeze, "--main".freeze, "README.md".freeze]
   s.required_ruby_version = Gem::Requirement.new("~> 3.1".freeze)
-  s.rubygems_version = "3.6.9".freeze
+  s.rubygems_version = "3.7.2".freeze
   s.summary = "Interacting with the Ollama API".freeze
   s.test_files = ["spec/ollama/client/doc_spec.rb".freeze, "spec/ollama/client_spec.rb".freeze, "spec/ollama/commands/chat_spec.rb".freeze, "spec/ollama/commands/copy_spec.rb".freeze, "spec/ollama/commands/create_spec.rb".freeze, "spec/ollama/commands/delete_spec.rb".freeze, "spec/ollama/commands/embed_spec.rb".freeze, "spec/ollama/commands/embeddings_spec.rb".freeze, "spec/ollama/commands/generate_spec.rb".freeze, "spec/ollama/commands/ps_spec.rb".freeze, "spec/ollama/commands/pull_spec.rb".freeze, "spec/ollama/commands/push_spec.rb".freeze, "spec/ollama/commands/show_spec.rb".freeze, "spec/ollama/commands/tags_spec.rb".freeze, "spec/ollama/commands/version_spec.rb".freeze, "spec/ollama/handlers/collector_spec.rb".freeze, "spec/ollama/handlers/dump_json_spec.rb".freeze, "spec/ollama/handlers/dump_yaml_spec.rb".freeze, "spec/ollama/handlers/markdown_spec.rb".freeze, "spec/ollama/handlers/nop_spec.rb".freeze, "spec/ollama/handlers/print_spec.rb".freeze, "spec/ollama/handlers/progress_spec.rb".freeze, "spec/ollama/handlers/say_spec.rb".freeze, "spec/ollama/handlers/single_spec.rb".freeze, "spec/ollama/image_spec.rb".freeze, "spec/ollama/message_spec.rb".freeze, "spec/ollama/options_spec.rb".freeze, "spec/ollama/tool_spec.rb".freeze, "spec/spec_helper.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.4".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.8".freeze])
   s.add_development_dependency(%q<all_images>.freeze, ["~> 0.6".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.2".freeze])
   s.add_development_dependency(%q<kramdown>.freeze, ["~> 2.0".freeze])

data/spec/ollama/commands/embed_spec.rb

@@ -36,6 +36,31 @@ describe Ollama::Commands::Embed do
     )
   end
 
+  it 'can be instantiated with dimensions' do
+    embed = described_class.new(
+      model: 'all-minilm',
+      input: 'Why is the sky blue?',
+      dimensions: 128
+    )
+    expect(embed).to be_a described_class
+    expect(embed.dimensions).to eq(128)
+  end
+
+  it 'can be converted to JSON with dimensions' do
+    embed = described_class.new(
+      model: 'all-minilm',
+      input: 'Why is the sky blue?',
+      dimensions: 128
+    )
+    expect(embed.as_json).to include(
+      model: 'all-minilm',
+      input: 'Why is the sky blue?',
+      dimensions: 128
+    )
+    expect(embed.to_json).to eq(
+      '{"model":"all-minilm","input":"Why is the sky blue?","dimensions":128,"stream":false}'
+    )
+  end
 
   it 'can perform' do
     embed = described_class.new(

data/spec/ollama/handlers/say_spec.rb

@@ -1,6 +1,11 @@
 require 'spec_helper'
 
-describe Ollama::Handlers::Say do
+skip_reason = nil
+unless File.executable?(`which say`.chomp)
+  skip_reason = 'Command say not in path'
+end
+
+describe Ollama::Handlers::Say, skip: skip_reason do
   let :say do
     described_class.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ollama-ruby
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement
@@ -277,12 +277,6 @@ extra_rdoc_files:
 - lib/ollama/tool/function/parameters/property.rb
 - lib/ollama/version.rb
 files:
-- ".contexts/code_comment.rb"
-- ".contexts/full.rb"
-- ".contexts/info.rb"
-- ".contexts/lib.rb"
-- ".contexts/yard.md"
-- ".yardopts"
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -389,7 +383,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Interacting with the Ollama API
 test_files:

data/.contexts/code_comment.rb

@@ -1,25 +0,0 @@
-context do
-  namespace "lib" do
-    Dir['lib/**/*.rb'].each do |filename|
-      file filename, tags: 'lib'
-    end
-  end
-
-  namespace "spec" do
-    Dir['spec/**/*.rb'].each do |filename|
-      file filename, tags: 'spec'
-    end
-  end
-
-  file 'README.md', tags: 'documentation'
-
-  file '.contexts/yard.md', tags: [ 'yard', 'cheatsheet' ]
-
-  meta guidelins: <<~EOT
-    # Guidelines for creating YARD documentation
-
-    - Look into the file, with tags yard and cheatsheet for how comment ruby
-      constructs.
-    - In comments above initialize methods never omit @return
-  EOT
-end

data/.contexts/full.rb

@@ -1,43 +0,0 @@
-context do
-  variable project_name: Pathname.pwd.basename
-
-  variable project_version: File.read('VERSION').chomp
-
-  variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
-
-  namespace "structure" do
-    command "tree", tags: %w[ project_structure ]
-  end
-
-  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
-
-  namespace "spec" do
-    Dir['spec/**/*.rb'].each do |filename|
-      file filename, tags: 'spec'
-    end
-  end
-
-  namespace "gems" do
-    file Dir['*.gemspec'].first
-    file 'Gemfile'
-    file 'Gemfile.lock'
-  end
-
-  file 'Rakefile',  tags: 'gem_hadar'
-
-  file 'README.md', tags: 'documentation'
-
-  meta ruby: RUBY_DESCRIPTION
-
-  meta code_coverage: json('coverage/coverage_context.json')
-end

data/.contexts/info.rb

@@ -1,17 +0,0 @@
-context do
-  variable project_name: Pathname.pwd.basename
-
-  variable project_version: File.read('VERSION').chomp
-
-  variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
-
-  namespace "structure" do
-    command "tree", tags: %w[ project_structure ]
-  end
-
-  file 'Rakefile',  tags: 'gem_hadar'
-
-  file 'README.md', tags: 'documentation'
-
-  meta ruby: RUBY_DESCRIPTION
-end

data/.contexts/lib.rb

@@ -1,27 +0,0 @@
-context do
-  variable branch: `git rev-parse --abbrev-ref HEAD`.chomp
-
-  namespace "structure" do
-    command "tree", tags: %w[ project_structure ]
-  end
-
-  namespace "lib" do
-    Dir['lib/**/*.rb'].each do |filename|
-      file filename, tags: 'lib'
-    end
-  end
-
-  namespace "gems" do
-    file Dir['*.gemspec'].first
-    file 'Gemfile'
-    file 'Gemfile.lock'
-  end
-
-  file 'Rakefile',  tags: 'gem_hadar'
-
-  file 'README.md', tags: 'documentation'
-
-  meta ruby: RUBY_DESCRIPTION
-
-  meta code_coverage: json('coverage/coverage_context.json')
-end

data/.contexts/yard.md

@@ -1,93 +0,0 @@
-# YARD CHEATSHEET http://yardoc.org
-
-## May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e
-
-cribbed from http://pastebin.com/xgzeAmBn
-
-Templates to remind you of the options and formatting for the different types of objects you might
-want to document using YARD.
-
-## Modules
-
-    # Namespace for classes and modules that handle serving documentation over HTTP
-    # @since 0.6.0
-
-## Classes
-
-    # Abstract base class for CLI utilities. Provides some helper methods for
-    # the option parser
-    #
-    # @author Full Name
-    # @abstract
-    # @since 0.6.0
-    # @attr [Types] attribute_name a full description of the attribute
-    # @attr_reader [Types] name description of a readonly attribute
-    # @attr_writer [Types] name description of writeonly attribute
-    # @deprecated Describe the reason or provide alt. references here
-
-## Methods
-
-    # An alias to {Parser::SourceParser}'s parsing method
-    #
-    # @author Donovan Bray
-    #
-    # @see http://example.com Description of URL
-    # @see SomeOtherClass#method
-    #
-    # @deprecated Use {#my_new_method} instead of this method because
-    #   it uses a library that is no longer supported in Ruby 1.9.
-    #   The new method accepts the same parameters.
-    #
-    # @abstract
-    # @private
-    #
-    # @param opts [Hash] the options to create a message with.
-    # @option opts [String] :subject The subject
-    # @option opts [String] :from ('nobody') From address
-    # @option opts [String] :to Recipient email
-    # @option opts [String] :body ('') The email's body
-    #
-    # @param (see User#initialize)
-    # @param [OptionParser] opts the option parser object
-    # @param [Array<String>] args the arguments passed from input. This
-    #   array will be modified.
-    # @param [Array<String, Symbol>] list the list of strings and symbols.
-    #
-    # The options parsed out of the commandline.
-    # Default options are:
-    #   :format => :dot
-    #
-    # @example Reverse a string
-    #   "mystring.reverse" #=> "gnirtsym"
-    #
-    # @example Parse a glob of files
-    #   YARD.parse('lib/**/*.rb')
-    #
-    # @raise [ExceptionClass] description
-    #
-    # @return [optional, types, ...] description
-    # @return [true] always returns true
-    # @return [void]
-    # @return [String, nil] the contents of our object or nil
-    #   if the object has not been filled with data.
-    #
-    # We don't care about the "type" here:
-    # @return the object
-    #
-    # @return [String, #read] a string or object that responds to #read
-    # @return description here with no types
-
-## Anywhere
-
-    # @todo Add support for Jabberwocky service
-    #   There is an open source Jabberwocky library available
-    #   at http://somesite.com that can be integrated easily
-    #   into the project.
-
-## Blocks
-
-    # for block {|a, b, c| ... }
-    # @yield [a, b, c] Description of block
-    #
-    # @yieldparam [optional, types, ...] argname description
-    # @yieldreturn [optional, types, ...] description

data/.yardopts

@@ -1 +0,0 @@
---markup markdown