sdn_test_simple_car 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8dcd5c96a07178afc5ba18e84fb8231f899ecaa731719945a49d72bf95ae59d
-  data.tar.gz: 20bd7b6bd6eff1295c66fe644ef208b4c8a84e0f47eade6f874ebf1bbd72ecf4
+  metadata.gz: 1d288205fa6469a8140227436c936298faf8a470a3ceb1486cecf2e959eb7058
+  data.tar.gz: 2568cbe8303917aa40e033639bd72f5bc035f83131bd75590286024121bb5d4c
 SHA512:
-  metadata.gz: 8b288316b533e0afa20d351d49f80800d9b1e08259f21dcadde1b9ed5dca87b34303e168614ee33f5f85bdde5aac3d1077418b9d939cd0ae9615a761e392b990
-  data.tar.gz: bc61b866a39ad3d962c70177cd40c77a49870bc9d143955a1260d3d2e236d5e78dbe28b2b65244a1eaf923d0b6f2e77a3c306ea691b721681d9f9731665a2d59
+  metadata.gz: 8e64856bd0da90eeced5524e0b00ba93a4e5c385f0d6953bd389a52fcc97edeb4026dc1a33f7461e5656392a518150823988db4f501cda73e043052e9af4f92e
+  data.tar.gz: e293340375942735f79710b633830b33f930553d85bad581e3bbce2ea2eae4296698eee16d48ec1cecfc578478b556029793c3d7449d23a7b746cf7972c665c1

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
---color
---require spec_helper
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,8 +1,8 @@
-AllCops:
-  TargetRubyVersion: 3.1
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2026 Graftcode
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2026 Graftcode
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,74 +1,74 @@
-# SimpleCar
-
-A minimal Ruby class that represents a car and its running state.
-
-## What it provides
-
-- Auto-generated UUID `id` (or custom `id`)
-- Car metadata: `make`, `model`, `year`
-- Engine state control: `start`, `stop`, `is_running`
-- String representation via `to_s`
-
-## Requirements
-
-- Ruby 3.1+
-
-## Import
-
-Use one of the following approaches:
-
-```ruby
-require "simple_car"
-```
-
-or, when loading directly from the repository:
-
-```ruby
-require_relative "lib/simple_car"
-```
-
-## Quick Start
-
-```ruby
-require "simple_car"
-
-car = SimpleCar.new("Toyota", "Corolla", 2020)
-
-puts car.id          # generated UUID
-puts car.make        # "Toyota"
-puts car.model       # "Corolla"
-puts car.year        # 2020
-puts car.wheels      # 4
-puts car.is_running  # false
-
-car.start
-puts car.is_running  # true
-
-car.stop
-puts car.is_running  # false
-
-puts car.to_s
-# => "<id> 2020 Toyota Corolla (SimpleCar) Not Running"
-```
-
-## Custom ID
-
-```ruby
-car = SimpleCar.new("Ford", "Mustang", 1968, "car-001")
-puts car.id # "car-001"
-```
-
-If `id` is `nil` or empty, `SimpleCar` generates a UUID automatically.
-
-## API Reference
-
-- `SimpleCar.new(make, model, year, id = nil)`
-- `id` -> `String`
-- `make` -> `String`
-- `model` -> `String`
-- `year` -> `Integer` (or any value passed in)
-- `wheels` -> `4`
-- `is_running` -> `true` / `false`
-- `start` -> sets running state to `true`
-- `stop` -> sets running state to `false`
+# SimpleCar
+
+A minimal Ruby class that represents a car and its running state.
+
+## What it provides
+
+- Auto-generated UUID `id` (or custom `id`)
+- Car metadata: `make`, `model`, `year`
+- Engine state control: `start`, `stop`, `is_running`
+- String representation via `to_s`
+
+## Requirements
+
+- Ruby 3.1+
+
+## Import
+
+Use one of the following approaches:
+
+```ruby
+require "simple_car"
+```
+
+or, when loading directly from the repository:
+
+```ruby
+require_relative "lib/simple_car"
+```
+
+## Quick Start
+
+```ruby
+require "simple_car"
+
+car = SimpleCar.new("Toyota", "Corolla", 2020)
+
+puts car.id          # generated UUID
+puts car.make        # "Toyota"
+puts car.model       # "Corolla"
+puts car.year        # 2020
+puts car.wheels      # 4
+puts car.is_running  # false
+
+car.start
+puts car.is_running  # true
+
+car.stop
+puts car.is_running  # false
+
+puts car.to_s
+# => "<id> 2020 Toyota Corolla (SimpleCar) Not Running"
+```
+
+## Custom ID
+
+```ruby
+car = SimpleCar.new("Ford", "Mustang", 1968, "car-001")
+puts car.id # "car-001"
+```
+
+If `id` is `nil` or empty, `SimpleCar` generates a UUID automatically.
+
+## API Reference
+
+- `SimpleCar.new(make, model, year, id = nil)`
+- `id` -> `String`
+- `make` -> `String`
+- `model` -> `String`
+- `year` -> `Integer` (or any value passed in)
+- `wheels` -> `4`
+- `is_running` -> `true` / `false`
+- `start` -> sets running state to `true`
+- `stop` -> sets running state to `false`
 - `to_s` -> `"<id> <year> <make> <model> (SimpleCar) <Running|Not Running>"`

data/Rakefile

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/grft_test_simple_car.gemspec

@@ -1,30 +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
+# 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.1"
-end
+# frozen_string_literal: true
+
+module GrftTestSimpleCar
+  VERSION = "0.2.2"
+end

data/lib/simple_car.rb

@@ -1,107 +1,192 @@
-# frozen_string_literal: true
-
-require "securerandom"
-require_relative "vehicle"
-
-# Represents a simplified car that uses a string identifier instead of a GUID.
-# 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 ──────────────────────────────────────────────
-
-  DEFAULT_WHEELS = 4
-
-  @total_cars_created = 0
-
-  class << self
-    attr_reader :total_cars_created
-
-    def create_default
-      new("DefaultMake", "DefaultModel", 2024)
-    end
-
-    def get_default_makes
-      %w[Toyota Tesla Ford Honda Chevrolet]
-    end
-  end
-
-  # ── instance accessors ─────────────────────────────────────────
-
-  attr_reader :id, :make, :model, :year
-
-  def initialize(make, model, year, id = nil)
-    @id = id.nil? || id.strip.empty? ? SecureRandom.uuid : id
-    @make = make
-    @model = model
-    @year = year
-    @is_running = false
-    @mileage_history = []
-    @tags = []
-    self.class.instance_variable_set(:@total_cars_created, self.class.total_cars_created + 1)
-  end
-
-  # ── properties (Vehicle) ───────────────────────────────────────
-
-  def wheels
-    DEFAULT_WHEELS
-  end
-
-  def is_running
-    @is_running
-  end
-
-  # ── engine control (Vehicle) ───────────────────────────────────
-
-  def start
-    @is_running = true
-  end
-
-  def stop
-    @is_running = false
-  end
-
-  # ── primitive-array methods ────────────────────────────────────
-
-  def add_mileage_entry(miles)
-    @mileage_history << miles
-  end
-
-  def get_mileage_history
-    @mileage_history.dup
-  end
-
-  def set_tags(tags)
-    @tags = tags ? tags.dup : []
-  end
-
-  def get_tags
-    @tags.dup
-  end
-
-  # ── complex-type methods ───────────────────────────────────────
-
-  def duplicate
-    copy = SimpleCar.new(@make, @model, @year, @id)
-    copy.instance_variable_set(:@is_running, @is_running)
-    copy.instance_variable_set(:@mileage_history, @mileage_history.dup)
-    copy.instance_variable_set(:@tags, @tags.dup)
-    copy
-  end
-
-  def with_year(new_year)
-    copy = SimpleCar.new(@make, @model, new_year, @id)
-    copy.instance_variable_set(:@is_running, @is_running)
-    copy.instance_variable_set(:@mileage_history, @mileage_history.dup)
-    copy.instance_variable_set(:@tags, @tags.dup)
-    copy
-  end
-
-  # ── object overrides ───────────────────────────────────────────
-
-  def to_s
-    "#{@id} #{@year} #{@make} #{@model} (SimpleCar) #{@is_running ? "Running" : "Not Running"}"
-  end
-end
+# frozen_string_literal: true
+
+require "securerandom"
+require_relative "vehicle"
+
+# Represents a simplified car that uses a string identifier instead of a GUID.
+# 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 ──────────────────────────────────────────
+
+  # 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 ──────────────────────────────────────
+
+  # @!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
+    @model = model
+    @year = year
+    @is_running = false
+    @mileage_history = []
+    @tags = []
+    self.class.instance_variable_set(:@total_cars_created, self.class.total_cars_created + 1)
+  end
+
+  # ── 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) ────────────────────────────────
+
+  # 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 ─────────────────────────────────
+
+  # 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 ────────────────────────────────────
+
+  # 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)
+    copy.instance_variable_set(:@mileage_history, @mileage_history.dup)
+    copy.instance_variable_set(:@tags, @tags.dup)
+    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)
+    copy.instance_variable_set(:@mileage_history, @mileage_history.dup)
+    copy.instance_variable_set(:@tags, @tags.dup)
+    copy
+  end
+
+  # ── 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
+end

data/lib/vehicle.rb

@@ -1,38 +1,38 @@
-# frozen_string_literal: true
-
-# Contract (mixin) for any vehicle with basic identity, state, and engine control.
-#
-# Including classes must provide: id, make, model, year, wheels, is_running, start, stop.
-module Vehicle
-  def id
-    raise NotImplementedError
-  end
-
-  def make
-    raise NotImplementedError
-  end
-
-  def model
-    raise NotImplementedError
-  end
-
-  def year
-    raise NotImplementedError
-  end
-
-  def wheels
-    raise NotImplementedError
-  end
-
-  def is_running
-    raise NotImplementedError
-  end
-
-  def start
-    raise NotImplementedError
-  end
-
-  def stop
-    raise NotImplementedError
-  end
-end
+# frozen_string_literal: true
+
+# Contract (mixin) for any vehicle with basic identity, state, and engine control.
+#
+# Including classes must provide: id, make, model, year, wheels, is_running, start, stop.
+module Vehicle
+  def id
+    raise NotImplementedError
+  end
+
+  def make
+    raise NotImplementedError
+  end
+
+  def model
+    raise NotImplementedError
+  end
+
+  def year
+    raise NotImplementedError
+  end
+
+  def wheels
+    raise NotImplementedError
+  end
+
+  def is_running
+    raise NotImplementedError
+  end
+
+  def start
+    raise NotImplementedError
+  end
+
+  def stop
+    raise NotImplementedError
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdn_test_simple_car
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - GraftCode