rtlsdr 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a684113fd7fab1a02eedacad523203bc20c1e88a3f4d4c8ef7ebddcf5e86b92b
-  data.tar.gz: 23950e66b5bf1b36133479ef9adf62bfee9b27de76a11969063926af7dd485bc
+  metadata.gz: de238a7cd49e550a69286832b36841c553650c097a31fd791337c48c8b1f9cc3
+  data.tar.gz: 5466c2e13efb99c9c39ea4a448aed2f4e9a827e10149116fc02f45ab39f9536c
 SHA512:
-  metadata.gz: 10696f54f07b1d4ecb534ce286245e111e9c8068d68ff08772e8587238fc6fafbbf95ab55de5c891d5c0470034b377b44b67c09eaf3f27cec1cdf69a677bffcb
-  data.tar.gz: fe96888f3c93aa4947c7275cc74caf7585b222a973fd4cca06be7758516c66d8bfa71af5b442f5213b5521a1d44810f47d6e0faf22d85cfdad320333d6a9e07a
+  metadata.gz: 2a48c2e10ced3a1ef70e3981e2673c1a5a8b9ad0a3254a9ca23128b75ec32ce448282b606ca02e1ce09432a08302aba9e8c6ab68fb82ef25661599c486696d75
+  data.tar.gz: dc4006cfbdb52e5043d38e0b9815a7feb4b32aee7c34940bae1690e0551dc940f265050ea69f9a641d6b143046349a32d6c21ee42509a46f4b8bcb14b94e77ed

data/.yardconfig

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/UselessAssignment
+
+# YARD Configuration file
+# This file contains advanced configuration for YARD documentation generation
+
+# Custom tags for RTL-SDR specific documentation
+define_tag :frequency, :text, "Frequency Range"
+define_tag :sample_rate, :text, "Sample Rate"
+define_tag :gain, :text, "Gain Range"
+define_tag :tuner, :text, "Tuner Support"
+define_tag :thread_safety, :text, "Thread Safety"
+
+# Plugin settings
+plugins = []
+
+# Custom CSS and templates
+template_paths = ["templates"]
+
+# Markup settings
+markup = "markdown"
+markup_provider = "redcarpet"
+
+# Output settings
+output_dir = "doc"
+list_undoc = true
+protected = true
+private = false
+
+# Source exclusions
+exclude = [
+  "spec/**/*",
+  "examples/**/*",
+  "bin/**/*",
+  "exe/**/*",
+  "vendor/**/*",
+  "tmp/**/*",
+  ".git/**/*"
+]
+
+# rubocop:enable Lint/UselessAssignment

data/.yardopts

@@ -0,0 +1,17 @@
+--markup markdown
+--markup-provider redcarpet
+--title "RTL-SDR Ruby Gem Documentation"
+--readme README.md
+--files CHANGELOG.md,LICENSE.txt
+--output-dir doc
+--protected
+--no-private
+--embed-mixins
+--verbose
+--exclude spec/
+--exclude examples/
+--exclude bin/
+--exclude exe/
+--exclude vendor/
+--exclude tmp/
+--exclude .git/

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## [Unreleased]
 
+## [0.1.1] - 2025-06-07
+
+### Added
+
+Docs
+
+### Changed
+
+NA
+
+### Fixed
+
+NA
+
 ## [0.1.0] - 2025-06-07
 
 - Initial release

data/Rakefile

@@ -4,6 +4,8 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rake/extensiontask"
 require "rubocop/rake_task"
+require "rdoc/task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
@@ -13,7 +15,142 @@ Rake::ExtensionTask.new("rtlsdr") do |ext|
   ext.lib_dir = "lib/rtlsdr"
 end
 
-task default: %i[spec rubocop]
+# RDoc documentation generation
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "doc"
+  rdoc.title = "RTL-SDR Ruby Gem Documentation"
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "CHANGELOG.md", "LICENSE.txt", "lib/**/*.rb")
+
+  # RDoc options for better output
+  rdoc.options << "--line-numbers"
+  rdoc.options << "--all"
+  rdoc.options << "--charset=UTF-8"
+  rdoc.options << "--exclude=spec/"
+  rdoc.options << "--exclude=examples/"
+  rdoc.options << "--exclude=bin/"
+  rdoc.options << "--exclude=exe/"
+  rdoc.options << "--template=hanna" if system("gem list hanna -i > /dev/null 2>&1")
+end
+
+# Clean documentation
+desc "Remove generated documentation"
+task :clean_doc do
+  rm_rf "doc"
+end
+
+YARD::Rake::YardocTask.new(:yard) do |yard|
+  yard.files = ["lib/**/*.rb", "-", "README.md", "CHANGELOG.md", "LICENSE.txt"]
+  yard.options = [
+    "--output-dir", "doc",
+    "--readme", "README.md",
+    "--title", "RTL-SDR Ruby Gem Documentation",
+    "--markup", "markdown",
+    "--markup-provider", "redcarpet",
+    "--protected",
+    "--no-private",
+    "--embed-mixins"
+  ]
+end
+
+# YARD server for live documentation browsing
+desc "Start YARD documentation server"
+task :yard_server do
+  system("yard server --reload")
+end
+
+# YARD statistics
+desc "Show YARD documentation statistics"
+task :yard_stats do
+  system("yard stats")
+end
+
+# Generate YARD documentation with coverage report
+desc "Generate YARD docs with coverage report"
+task :yard_coverage do
+  puts "Generating YARD documentation with coverage report..."
+  system("yard doc")
+
+  # Parse YARD output for coverage
+  if system("yard stats > /tmp/yard_stats.txt 2>&1")
+    stats = File.read("/tmp/yard_stats.txt")
+    if stats =~ /(\d+\.\d+)% documented/
+      coverage = Regexp.last_match(1).to_f
+      puts "\nYARD Documentation coverage: #{coverage}%"
+
+      if coverage < 90.0
+        puts "WARNING: YARD documentation coverage is below 90%"
+        exit 1 if ENV["REQUIRE_DOC_COVERAGE"]
+      else
+        puts "✓ YARD documentation coverage is good!"
+      end
+    end
+  end
+end
+
+# Comprehensive documentation check
+desc "Check documentation coverage and quality"
+task :doc_check do
+  puts "Running RDoc to check documentation coverage..."
+  system("rdoc --verbose lib/ > /tmp/rdoc_output.txt 2>&1")
+
+  # Parse output for coverage info
+  if File.exist?("/tmp/rdoc_output.txt")
+    output = File.read("/tmp/rdoc_output.txt")
+    if output =~ /(\d+\.\d+)% documented/
+      coverage = Regexp.last_match(1).to_f
+      puts "Documentation coverage: #{coverage}%"
+
+      if coverage < 90.0
+        puts "WARNING: Documentation coverage is below 90%"
+        exit 1 if ENV["REQUIRE_DOC_COVERAGE"]
+      else
+        puts "✓ Documentation coverage is good!"
+      end
+    end
+
+    # Check for undocumented items
+    if output.include?("undocumented")
+      puts "\nUndocumented items found:"
+      output.scan(/(\S+) \(undocumented\)/).each { |match| puts "  - #{match[0]}" }
+    end
+  end
+end
+
+# Documentation tasks
+desc "Generate all documentation (RDoc and YARD)"
+task docs: %i[rdoc yard]
+
+desc "Check all documentation coverage"
+task doc_coverage: %i[doc_check yard_coverage]
+
+desc "Clean all generated documentation"
+task clean_docs: [:clean_doc] do
+  rm_rf "doc"
+  rm_rf ".yardoc"
+end
+
+desc "Serve documentation locally"
+task :serve_docs do
+  puts "Choose documentation format:"
+  puts "1. RDoc (file://#{Dir.pwd}/doc/index.html)"
+  puts "2. YARD server (http://localhost:8808)"
+  print "Enter choice (1-2): "
+
+  choice = $stdin.gets.chomp
+  case choice
+  when "1"
+    Rake::Task[:rdoc].invoke unless File.exist?("doc/index.html")
+    system("open doc/index.html") if RUBY_PLATFORM =~ /darwin/
+    puts "RDoc documentation: file://#{Dir.pwd}/doc/index.html"
+  when "2"
+    Rake::Task[:yard_server].invoke
+  else
+    puts "Invalid choice"
+  end
+end
+
+task default: %i[spec rubocop doc_check]
 
 # Custom task to build librtlsdr if needed
 desc "Build librtlsdr from source (clones, configures, and compiles)"
@@ -31,3 +168,91 @@ end
 
 desc "Compile native extensions (depends on librtlsdr)"
 task compile: :build_librtlsdr
+
+# Version management tasks
+namespace :version do
+  desc "Bump patch version (x.y.z -> x.y.z+1)"
+  task :patch do
+    bump_version(:patch)
+  end
+
+  desc "Bump minor version (x.y.z -> x.y+1.0)"
+  task :minor do
+    bump_version(:minor)
+  end
+
+  desc "Bump major version (x.y.z -> x+1.0.0)"
+  task :major do
+    bump_version(:major)
+  end
+
+  desc "Show current version"
+  task :show do
+    require_relative "lib/rtlsdr/version"
+    puts "Current version: #{RTLSDR::VERSION}"
+  end
+end
+
+desc "Bump patch version (shortcut for version:patch)"
+task :bump do
+  Rake::Task["version:patch"].invoke
+end
+
+def bump_version(type) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+  version_file = "lib/rtlsdr/version.rb"
+  content = File.read(version_file)
+
+  # Extract current version
+  current_version = content.match(/VERSION = "([^"]+)"/)[1]
+  major, minor, patch = current_version.split(".").map(&:to_i)
+
+  # Calculate new version based on type
+  case type
+  when :patch
+    patch += 1
+  when :minor
+    minor += 1
+    patch = 0
+  when :major
+    major += 1
+    minor = 0
+    patch = 0
+  end
+
+  new_version = "#{major}.#{minor}.#{patch}"
+
+  # Update version file
+  new_content = content.gsub(/VERSION = "#{Regexp.escape(current_version)}"/, %(VERSION = "#{new_version}"))
+  File.write(version_file, new_content)
+
+  puts "Version bumped from #{current_version} to #{new_version}"
+
+  # Update CHANGELOG if it exists
+  if File.exist?("CHANGELOG.md")
+    changelog = File.read("CHANGELOG.md")
+    date = Time.now.strftime("%Y-%m-%d")
+
+    # Add new version entry at the top after the header
+    new_entry = "\n## [#{new_version}] - #{date}\n\n### Added\n\n### Changed\n\n### Fixed\n\n"
+
+    updated_changelog = if changelog.include?("## [Unreleased]")
+                          # Insert after Unreleased section
+                          changelog.sub(/(## \[Unreleased\].*?\n)/, "\\1#{new_entry}")
+                        elsif changelog.include?("# Changelog")
+                          # Insert after main header
+                          changelog.sub(/(# Changelog\s*\n)/, "\\1#{new_entry}")
+                        else
+                          # Prepend to file if no standard structure
+                          "# Changelog#{new_entry}#{changelog}"
+                        end
+
+    File.write("CHANGELOG.md", updated_changelog)
+    puts "Updated CHANGELOG.md with new version entry"
+  end
+
+  puts "Don't forget to:"
+  puts "1. Update CHANGELOG.md with your changes"
+  puts "2. Commit your changes: git add -A && git commit -m 'Bump version to #{new_version}'"
+  puts "3. Create a git tag: git tag v#{new_version}"
+  puts "4. Push changes: git push && git push --tags"
+end

data/doc_config.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Documentation configuration for RTL-SDR Ruby gem
+# This file contains documentation configuration notes
+
+# RDoc Configuration
+# The RDoc configuration is handled in the Rakefile RDoc::Task.
+# Key settings:
+# - Title: "RTL-SDR Ruby Gem Documentation"
+# - Main page: README.md
+# - Output directory: doc/
+# - Includes: README.md, CHANGELOG.md, LICENSE.txt, lib/**/*.rb
+# - Excludes: spec/, examples/, bin/, exe/
+
+# YARD Configuration
+# YARD configuration is handled via:
+# - .yardopts file for command line options
+# - .yardconfig file for advanced settings
+# - Rakefile YARD::Rake::YardocTask for task configuration
+
+# Documentation Standards
+# - 100% documentation coverage required
+# - All public methods must have @param and @return tags
+# - Examples should be provided using @example
+# - Version tracking with @since tags