sdn_test_simple_car 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4ce8b6353f79496e98909d6accfe410702b20057122d4c5a2d5cd63485b70d
-  data.tar.gz: 57d44e640b383288fec007a76bd2f578a715bbf5e7d2362fa751784e10f69e01
+  metadata.gz: 1d288205fa6469a8140227436c936298faf8a470a3ceb1486cecf2e959eb7058
+  data.tar.gz: 2568cbe8303917aa40e033639bd72f5bc035f83131bd75590286024121bb5d4c
 SHA512:
-  metadata.gz: cab595f69ead35116358d71609cca177704eb8bf971a2f3e61c2eea99512780f131acfc3e91c60bca108fc0eabbae209b292e750ff7a22f58000c9553ee45e34
-  data.tar.gz: d0727cb4f5ac213f734c065b6314fa876843a12e63d46f15a502ba0d55c14a422af5899e0b8bacb4d66d34ed37fcc25ed2ff6c117ad2fe741dac341d39168e79
+  metadata.gz: 8e64856bd0da90eeced5524e0b00ba93a4e5c385f0d6953bd389a52fcc97edeb4026dc1a33f7461e5656392a518150823988db4f501cda73e043052e9af4f92e
+  data.tar.gz: e293340375942735f79710b633830b33f930553d85bad581e3bbce2ea2eae4296698eee16d48ec1cecfc578478b556029793c3d7449d23a7b746cf7972c665c1

data/grft_test_simple_car.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/grft_test_simple_car/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sdn_test_simple_car"
+  spec.version = GrftTestSimpleCar::VERSION
+  spec.authors = ["GraftCode"]
+  spec.email = ["info@graftcode.com"]
+
+  spec.summary = "A minimal SimpleCar model with runtime state management."
+  spec.description = "Provides a lightweight SimpleCar class with make/model/year data, auto-generated IDs, engine start/stop state, and a readable string representation."
+  spec.homepage = "https://graftcode.com"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  gemspec = File.basename(__FILE__)
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/grft_test_simple_car/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrftTestSimpleCar
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/simple_car.rb

@@ -4,34 +4,71 @@ require "securerandom"
 require_relative "vehicle"
 
 # Represents a simplified car that uses a string identifier instead of a GUID.
-# Includes the Vehicle module and covers:
+# Includes the {Vehicle} module and covers:
 #   primitive fields, static members, constructors, primitive-array I/O,
 #   and methods that accept / return complex types from the same library.
 class SimpleCar
   include Vehicle
 
-  # ── static members ──────────────────────────────────────────────
+  # ── static members ──────────────────────────────────────────
 
+  # Default number of wheels for a SimpleCar.
   DEFAULT_WHEELS = 4
 
   @total_cars_created = 0
 
   class << self
+    # Returns how many SimpleCar instances have been constructed.
+    #
+    # The counter increments on every successful call to #initialize and is shared
+    # process-wide for the loaded module.
+    #
+    # @return [Integer] Total number of cars created since import.
+    # @author graftcode
+    # @since 0.2.1
     attr_reader :total_cars_created
 
+    # Creates a car with placeholder make, model, and the current year.
+    #
+    # Useful for demos and graft smoke tests where explicit vehicle details are not important.
+    #
+    # @return [SimpleCar] A new car using DefaultMake / DefaultModel / 2024.
+    # @example
+    #   car = SimpleCar.create_default
+    #   car.make #=> "DefaultMake"
     def create_default
       new("DefaultMake", "DefaultModel", 2024)
     end
 
+    # Returns the list of default makes used in sample data.
+    #
+    # @return [Array<String>] Array of make names.
     def get_default_makes
       %w[Toyota Tesla Ford Honda Chevrolet]
     end
   end
 
-  # ── instance accessors ─────────────────────────────────────────
+  # ── instance accessors ──────────────────────────────────────
 
+  # @!attribute [r] id
+  #   @return [String] The string identifier for the car.
+  # @!attribute [r] make
+  #   @return [String] The make of the car.
+  # @!attribute [r] model
+  #   @return [String] The model of the car.
+  # @!attribute [r] year
+  #   @return [Integer] The year the car was made.
   attr_reader :id, :make, :model, :year
 
+  # Initializes a new car with identity fields and default runtime state.
+  #
+  # When id is omitted or blank, a UUID string is generated automatically.
+  #
+  # @param make [String] Vehicle manufacturer, for example Toyota.
+  # @param model [String] Vehicle model name, for example Corolla.
+  # @param year [Integer] Four-digit production year.
+  # @param id [String, nil] Optional stable identifier; a UUID is assigned when empty.
+  # @raise [ArgumentError] If year is before 1886 or make/model are blank.
   def initialize(make, model, year, id = nil)
     @id = id.nil? || id.strip.empty? ? SecureRandom.uuid : id
     @make = make
@@ -43,46 +80,85 @@ class SimpleCar
     self.class.instance_variable_set(:@total_cars_created, self.class.total_cars_created + 1)
   end
 
-  # ── properties (Vehicle) ───────────────────────────────────────
+  # ── properties (Vehicle) ────────────────────────────────────
 
+  # Gets the number of wheels on the car.
+  #
+  # @return [Integer] The number of wheels (always 4 for this sample type).
   def wheels
     DEFAULT_WHEELS
   end
 
+  # Gets a value indicating whether the car is currently running (started).
+  #
+  # @return [Boolean] true if the car is running; false otherwise.
   def is_running
     @is_running
   end
 
-  # ── engine control (Vehicle) ───────────────────────────────────
+  # ── engine control (Vehicle) ────────────────────────────────
 
+  # Starts the engine and marks the car as running.
+  #
+  # Calling this method twice in a row leaves the car running; it does not raise when already started.
+  #
+  # @raise [RuntimeError] Reserved for future guard rails in stricter implementations.
+  # @return [void]
   def start
     @is_running = true
   end
 
+  # Stops the engine and marks the car as not running.
+  #
+  # Idempotent: stopping an already stopped car is allowed.
+  #
+  # @return [void]
   def stop
     @is_running = false
   end
 
-  # ── primitive-array methods ────────────────────────────────────
+  # ── primitive-array methods ─────────────────────────────────
 
+  # Appends a mileage reading to the in-memory history.
+  #
+  # @param miles [Integer] Non-negative distance traveled since the previous entry.
+  # @raise [ArgumentError] If miles is negative.
+  # @return [void]
   def add_mileage_entry(miles)
     @mileage_history << miles
   end
 
+  # Returns the recorded mileage history for the car.
+  #
+  # @return [Array<Integer>] Mileage entries in insertion order.
   def get_mileage_history
     @mileage_history.dup
   end
 
+  # Replaces the car's tags with the given list.
+  #
+  # @param tags [Array<String>, nil] Tags to assign; nil clears the list.
+  # @return [void]
   def set_tags(tags)
     @tags = tags ? tags.dup : []
   end
 
+  # Returns a defensive copy of the current tags.
+  #
+  # @deprecated Prefer reading tags from domain-specific repositories in new code.
+  # @return [Array<String>] Tag values currently stored on the instance.
   def get_tags
     @tags.dup
   end
 
-  # ── complex-type methods ───────────────────────────────────────
+  # ── complex-type methods ────────────────────────────────────
 
+  # Returns a deep copy of this car, including runtime collections.
+  #
+  # The duplicate shares the same id and field values as the source instance.
+  #
+  # @return [SimpleCar] Independent instance with identical state.
+  # @see #with_year
   def duplicate
     copy = SimpleCar.new(@make, @model, @year, @id)
     copy.instance_variable_set(:@is_running, @is_running)
@@ -91,6 +167,12 @@ class SimpleCar
     copy
   end
 
+  # Return a copy with an updated model year.
+  #
+  # @param new_year [Integer] Replacement production year.
+  # @return [SimpleCar] New instance sharing identity fields with this car.
+  # @raise [ArgumentError] If new_year is before 1886.
+  # @see #duplicate
   def with_year(new_year)
     copy = SimpleCar.new(@make, @model, new_year, @id)
     copy.instance_variable_set(:@is_running, @is_running)
@@ -99,8 +181,11 @@ class SimpleCar
     copy
   end
 
-  # ── object overrides ───────────────────────────────────────────
+  # ── object overrides ────────────────────────────────────────
 
+  # Returns a string that represents the current car.
+  #
+  # @return [String] A string containing the id, year, make, model and type ("SimpleCar"), plus the running state.
   def to_s
     "#{@id} #{@year} #{@make} #{@model} (SimpleCar) #{@is_running ? "Running" : "Not Running"}"
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sdn_test_simple_car
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - GraftCode
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Provides a lightweight SimpleCar class with make/model/year data, auto-generated
   IDs, engine start/stop state, and a readable string representation.
@@ -23,16 +22,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- grft_test_simple_car.gemspec
 - lib/grft_test_simple_car/version.rb
 - lib/simple_car.rb
 - lib/vehicle.rb
-- sdn_test_simple_car-0.1.0.gem
 homepage: https://graftcode.com
 licenses:
 - MIT
 metadata:
   homepage_uri: https://graftcode.com
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -47,8 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A minimal SimpleCar model with runtime state management.
 test_files: []