ivar 0.2.0 → 0.4.6

data/examples/check_all_block_example.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "ivar"
+
+# Define a class before enabling check_all
+class BeforeClass
+  def initialize
+    @name = "before"
+  end
+
+  def to_s
+    "Name: #{@naem}"  # Intentional typo to demonstrate lack of checking
+  end
+end
+
+# Define classes that will be used within the block
+class WithinBlockClass
+  def initialize
+    @name = "within block"
+  end
+
+  def to_s
+    "Name: #{@naem}"  # Intentional typo to demonstrate lack of checking yet
+  end
+end
+
+module WithinBlockModule
+  class NestedClass
+    def initialize
+      @name = "nested"
+    end
+
+    def to_s
+      "Name: #{@naem}"  # Intentional typo to demonstrate lack of checking yet
+    end
+  end
+end
+
+# Only classes loaded within this block will have Ivar::Checked included
+Ivar.check_all do
+  # Load the classes by referencing them
+  puts "Loading WithinBlockClass: #{WithinBlockClass}"
+  puts "Loading WithinBlockModule::NestedClass: #{WithinBlockModule::NestedClass}"
+
+  # We could also define anonymous classes here
+  @anonymous_class = Class.new do
+    def initialize
+      @name = "anonymous"
+    end
+
+    def to_s
+      "Name: #{@naem}"  # Intentional typo to demonstrate checking
+    end
+  end
+end
+
+# Define a class after the check_all block
+class AfterClass
+  def initialize
+    @name = "after"
+  end
+
+  def to_s
+    "Name: #{@naem}"  # Intentional typo to demonstrate lack of checking
+  end
+end
+
+# Create instances of each class
+puts "Creating BeforeClass instance:"
+before = BeforeClass.new
+puts before
+
+puts "\nCreating WithinBlockClass instance:"
+within = WithinBlockClass.new
+puts within
+
+puts "\nCreating WithinBlockModule::NestedClass instance:"
+nested = WithinBlockModule::NestedClass.new
+puts nested
+
+puts "\nCreating AfterClass instance:"
+after = AfterClass.new
+puts after

data/examples/check_all_example.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "ivar"
+
+# Enable checking for all classes and modules defined in the project
+Ivar.check_all
+
+# Now any class or module defined in the project will have Ivar::Checked included
+class Sandwich
+  # No need to include Ivar::Checked manually
+
+  def initialize
+    @bread = "wheat"
+    @cheese = "muenster"
+    @condiments = ["mayo", "mustard"]
+  end
+
+  def to_s
+    "A #{@bread} sandwich with #{@chese} and #{@condiments.join(", ")}"  # Intentional typo in @cheese
+  end
+end
+
+# Create a sandwich - this will automatically check instance variables
+sandwich = Sandwich.new
+puts sandwich
+
+# Define another class to demonstrate that it also gets Ivar::Checked
+class Drink
+  def initialize
+    @type = "soda"
+    @size = "medium"
+  end
+
+  def to_s
+    "A #{@sise} #{@type}"  # Intentional typo in @size
+  end
+end
+
+# Create a drink - this will also automatically check instance variables
+drink = Drink.new
+puts drink

data/examples/inheritance_with_kwarg_init.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require "ivar"
+
+# Base class for all food items
+class Food
+  include Ivar::Checked
+
+  # Declare common properties with keyword initialization and defaults
+  ivar :@name, init: :kwarg, value: "Unknown Food"
+  ivar :@calories, init: :kwarg, value: 0
+  ivar :@vegetarian, init: :kwarg, value: false
+  ivar :@vegan, init: :kwarg, value: false
+
+  # Declare extra_info
+  ivar :@extra_info
+
+  def initialize(extra_info: nil)
+    # The declared variables are already initialized from keyword arguments or defaults
+    @extra_info = :extra_info
+  end
+
+  def to_s
+    result = "#{@name} (#{@calories} calories)"
+    result += ", vegetarian" if @vegetarian
+    result += ", vegan" if @vegan
+    result += ", #{@extra_info}" if @extra_info
+    result
+  end
+end
+
+# Sandwich class that inherits from Food
+class Sandwich < Food
+  # Override name with a more specific default
+  ivar :@name, value: "Sandwich"
+
+  # Declare sandwich-specific properties
+  ivar :@bread, init: :kwarg, value: "white"
+  ivar :@fillings, init: :kwarg, value: []
+
+  # Override vegetarian with a different default
+  ivar :@vegetarian, value: true
+
+  def initialize(condiments: [], **kwargs)
+    # Pass any remaining kwargs to parent
+    super(**kwargs)
+
+    # Initialize fillings if needed
+    @fillings ||= []
+
+    # Add condiments to fillings
+    @fillings += condiments
+  end
+
+  def to_s
+    result = super
+    result += " on #{@bread} bread"
+    result += " with #{@fillings.join(", ")}" unless @fillings.empty?
+    result
+  end
+end
+
+# VeganSandwich class that inherits from Sandwich
+class VeganSandwich < Sandwich
+  # Override defaults for vegan properties
+  ivar :@name, value: "Vegan Sandwich"
+  ivar :@vegan, value: true
+
+  # Override bread default
+  ivar :@bread, value: "whole grain"
+
+  # Add vegan-specific properties
+  ivar :@plant_protein, init: :kwarg, value: "tofu"
+
+  def initialize(**kwargs)
+    super
+
+    # Initialize fillings if needed
+    @fillings ||= []
+
+    # Ensure no non-vegan fillings
+    @fillings.reject! { |filling| non_vegan_fillings.include?(filling) }
+
+    # Add plant protein if fillings are empty
+    @fillings << @plant_protein if @fillings.empty?
+  end
+
+  def non_vegan_fillings
+    ["cheese", "mayo", "ham", "turkey", "roast beef", "tuna"]
+  end
+
+  def to_s
+    result = super
+    result += " (#{@plant_protein} based)" if @fillings.include?(@plant_protein)
+    result
+  end
+end
+
+# Create a basic food item with defaults
+puts "Basic food with defaults:"
+food = Food.new
+puts food
+# => "Unknown Food (0 calories)"
+
+# Create a food item with custom properties
+puts "\nCustom food:"
+custom_food = Food.new(name: "Apple", calories: 95, vegetarian: true, vegan: true)
+puts custom_food
+# => "Apple (95 calories), vegetarian, vegan"
+
+# Create a sandwich with defaults
+puts "\nDefault sandwich:"
+sandwich = Sandwich.new
+puts sandwich
+# => "Sandwich (0 calories), vegetarian on white bread"
+
+# Create a sandwich with custom properties
+puts "\nCustom sandwich:"
+custom_sandwich = Sandwich.new(
+  name: "Club Sandwich",
+  calories: 450,
+  bread: "sourdough",
+  fillings: ["turkey", "bacon", "lettuce", "tomato"],
+  condiments: ["mayo", "mustard"],
+  extra_info: "triple-decker"
+)
+puts custom_sandwich
+# => "Club Sandwich (450 calories), vegetarian on sourdough bread with turkey, bacon, lettuce, tomato, mayo, mustard, triple-decker"
+
+# Create a vegan sandwich with defaults
+puts "\nDefault vegan sandwich:"
+vegan_sandwich = VeganSandwich.new
+puts vegan_sandwich
+# => "Vegan Sandwich (0 calories), vegetarian, vegan on whole grain bread with tofu (tofu based)"
+
+# Create a vegan sandwich with custom properties
+puts "\nCustom vegan sandwich:"
+custom_vegan = VeganSandwich.new(
+  name: "Mediterranean Vegan",
+  calories: 380,
+  bread: "pita",
+  fillings: ["hummus", "falafel", "lettuce", "tomato", "cucumber"],
+  plant_protein: "chickpeas",
+  extra_info: "with tahini sauce"
+)
+puts custom_vegan
+# => "Mediterranean Vegan (380 calories), vegetarian, vegan on pita bread with hummus, falafel, lettuce, tomato, cucumber, with tahini sauce"
+
+# Try to create a vegan sandwich with non-vegan fillings
+puts "\nVegan sandwich with non-vegan fillings (will be removed):"
+non_vegan_fillings = VeganSandwich.new(
+  fillings: ["cheese", "ham", "lettuce", "tomato"],
+  plant_protein: "seitan"
+)
+puts non_vegan_fillings
+# => "Vegan Sandwich (0 calories), vegetarian, vegan on whole grain bread with lettuce, tomato, seitan (seitan based)"

data/examples/inheritance_with_positional_init.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "ivar"
+
+# Base class for all food items
+class Food
+  include Ivar::Checked
+
+  # Declare common properties with positional initialization and defaults
+  ivar :@name, init: :positional, value: "Unknown Food"
+  ivar :@calories, init: :positional, value: 0
+  ivar :@vegetarian, init: :positional, value: false
+  ivar :@vegan, init: :positional, value: false
+
+  # Declare extra_info
+  ivar :@extra_info
+
+  def initialize(extra_info = nil)
+    # The declared variables are already initialized from positional arguments or defaults
+    @extra_info = extra_info
+  end
+
+  def to_s
+    result = "#{@name} (#{@calories} calories)"
+    result += ", vegetarian" if @vegetarian
+    result += ", vegan" if @vegan
+    result += ", #{@extra_info}" if @extra_info
+    result
+  end
+end
+
+# Sandwich class that inherits from Food
+class Sandwich < Food
+  # Override name with a more specific default
+  ivar :@name, value: "Sandwich"
+
+  # Declare sandwich-specific properties
+  ivar :@bread, init: :positional, value: "white"
+  ivar :@fillings, init: :positional, value: []
+
+  # Override vegetarian with a different default
+  ivar :@vegetarian, value: true
+
+  def initialize(condiments = [], *args)
+    # Pass any remaining args to parent
+    super(*args)
+
+    # Initialize fillings if needed
+    @fillings ||= []
+
+    # Add condiments to fillings
+    @fillings += condiments
+  end
+
+  def to_s
+    result = super
+    result += " on #{@bread} bread"
+    result += " with #{@fillings.join(", ")}" unless @fillings.empty?
+    result
+  end
+end
+
+# VeganSandwich class that inherits from Sandwich
+class VeganSandwich < Sandwich
+  # Override defaults for vegan properties
+  ivar :@name, value: "Vegan Sandwich"
+  ivar :@vegan, value: true
+
+  # Override bread default
+  ivar :@bread, value: "whole grain"
+
+  # Add vegan-specific properties
+  ivar :@plant_protein, init: :positional, value: "tofu"
+
+  def initialize(*args)
+    super
+
+    # Initialize fillings if needed
+    @fillings ||= []
+
+    # Ensure no non-vegan fillings
+    @fillings.reject! { |filling| non_vegan_fillings.include?(filling) }
+
+    # Add plant protein if fillings are empty
+    @fillings << @plant_protein if @fillings.empty?
+  end
+
+  def non_vegan_fillings
+    ["cheese", "mayo", "ham", "turkey", "roast beef", "tuna"]
+  end
+end
+
+# Create a basic food item with positional arguments
+# (name, calories, vegetarian, vegan)
+apple = Food.new("Apple", 95, true, true, "Fresh and crisp")
+puts "Food: #{apple}"
+# => "Food: Apple (95 calories), vegetarian, vegan, Fresh and crisp"
+
+# Create a sandwich with positional arguments
+# (bread, fillings, name, calories, vegetarian, vegan, extra_info)
+# Note: condiments is a separate parameter not part of the ivar declarations
+turkey_sandwich = Sandwich.new(
+  ["mustard", "mayo"],  # condiments
+  "wheat",              # bread
+  ["turkey", "lettuce", "tomato"], # fillings
+  "Turkey Sandwich",    # name
+  450,                  # calories
+  false,                # vegetarian
+  false,                # vegan
+  "Classic lunch option" # extra_info
+)
+puts "Sandwich: #{turkey_sandwich}"
+# => "Sandwich: Turkey Sandwich (450 calories), Classic lunch option on wheat bread with turkey, lettuce, tomato, mustard, mayo"
+
+# Create a vegan sandwich with positional arguments
+# (plant_protein, bread, fillings, name, calories, vegetarian, vegan, extra_info)
+vegan_sandwich = VeganSandwich.new(
+  ["hummus", "mustard"], # condiments
+  "tempeh",              # plant_protein
+  "rye",                 # bread
+  ["lettuce", "tomato", "avocado"], # fillings
+  "Tempeh Sandwich",     # name
+  350,                   # calories
+  true,                  # vegetarian
+  true,                  # vegan
+  "High protein option"  # extra_info
+)
+puts "Vegan Sandwich: #{vegan_sandwich}"
+# => "Vegan Sandwich: Tempeh Sandwich (350 calories), vegetarian, vegan, High protein option on rye bread with lettuce, tomato, avocado, hummus, mustard"
+
+# Create items with default values
+default_food = Food.new
+default_sandwich = Sandwich.new
+default_vegan = VeganSandwich.new
+
+puts "\nDefaults:"
+puts "Default Food: #{default_food}"
+# => "Default Food: Unknown Food (0 calories)"
+puts "Default Sandwich: #{default_sandwich}"
+# => "Default Sandwich: Sandwich (0 calories), vegetarian on white bread"
+puts "Default Vegan Sandwich: #{default_vegan}"
+# => "Default Vegan Sandwich: Vegan Sandwich (0 calories), vegetarian, vegan on whole grain bread with tofu"

data/examples/mixed_positional_and_kwarg_init.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "ivar"
+
+class Recipe
+  include Ivar::Checked
+
+  # Declare instance variables with positional initialization
+  ivar :@name, init: :positional, value: "Unnamed Recipe"
+  ivar :@servings, init: :positional, value: 4
+
+  # Declare instance variables with keyword initialization
+  ivar :@prep_time, init: :kwarg, value: 15
+  ivar :@cook_time, init: :kwarg, value: 30
+  ivar :@difficulty, init: :kwarg, value: "medium"
+
+  # Regular instance variables
+  ivar :@ingredients, value: []
+  ivar :@instructions, value: []
+
+  def initialize(ingredients = [], instructions = [])
+    # At this point, @name and @servings are set from positional args
+    # @prep_time, @cook_time, and @difficulty are set from keyword args
+    @ingredients = ingredients unless ingredients.empty?
+    @instructions = instructions unless instructions.empty?
+  end
+
+  def total_time
+    @prep_time + @cook_time
+  end
+
+  def to_s
+    result = "#{@name} (Serves: #{@servings})\n"
+    result += "Prep: #{@prep_time} min, Cook: #{@cook_time} min, Difficulty: #{@difficulty}\n"
+    result += "\nIngredients:\n"
+    @ingredients.each { |ingredient| result += "- #{ingredient}\n" }
+    result += "\nInstructions:\n"
+    @instructions.each_with_index { |instruction, i| result += "#{i + 1}. #{instruction}\n" }
+    result
+  end
+end
+
+class DessertRecipe < Recipe
+  # Additional positional parameters
+  ivar :@dessert_type, init: :positional, value: "cake"
+  # Additional keyword parameters
+  ivar :@sweetness, init: :kwarg, value: "medium"
+  ivar :@calories_per_serving, init: :kwarg, value: 300
+
+  def initialize(special_equipment = [], *args, **kwargs)
+    @special_equipment = special_equipment
+    super(*args, **kwargs)
+  end
+
+  def to_s
+    result = super
+    result += "\nDessert Type: #{@dessert_type}\n"
+    result += "Sweetness: #{@sweetness}, Calories: #{@calories_per_serving} per serving\n"
+    result += "\nSpecial Equipment:\n"
+    @special_equipment.each { |equipment| result += "- #{equipment}\n" } unless @special_equipment.empty?
+    result
+  end
+end
+
+# Create a basic recipe with positional and keyword arguments
+pasta_recipe = Recipe.new(
+  "Spaghetti Carbonara",  # name (positional)
+  2,                      # servings (positional)
+  [                       # ingredients (regular parameter)
+    "200g spaghetti",
+    "100g pancetta",
+    "2 large eggs",
+    "50g pecorino cheese",
+    "50g parmesan",
+    "Freshly ground black pepper"
+  ],
+  [                       # instructions (regular parameter)
+    "Cook the spaghetti in salted water.",
+    "Fry the pancetta until crispy.",
+    "Whisk the eggs and cheese together.",
+    "Drain pasta, mix with pancetta, then quickly mix in egg mixture.",
+    "Season with black pepper and serve immediately."
+  ],
+  prep_time: 10,          # prep_time (keyword)
+  cook_time: 15,          # cook_time (keyword)
+  difficulty: "easy"      # difficulty (keyword)
+)
+
+puts "Basic Recipe:\n#{pasta_recipe}\n\n"
+
+# Create a dessert recipe with positional and keyword arguments
+chocolate_cake = DessertRecipe.new(
+  ["Stand mixer", "9-inch cake pans", "Cooling rack"],  # special_equipment (regular parameter)
+  "chocolate",                                          # dessert_type (positional)
+  "Chocolate Layer Cake",                               # name (positional)
+  12,                                                   # servings (positional)
+  [                                                     # ingredients (regular parameter)
+    "2 cups all-purpose flour",
+    "2 cups sugar",
+    "3/4 cup unsweetened cocoa powder",
+    "2 tsp baking soda",
+    "1 tsp salt",
+    "2 large eggs",
+    "1 cup buttermilk",
+    "1/2 cup vegetable oil",
+    "2 tsp vanilla extract",
+    "1 cup hot coffee"
+  ],
+  [                                                     # instructions (regular parameter)
+    "Preheat oven to 350°F (175°C).",
+    "Mix dry ingredients in a large bowl.",
+    "Add eggs, buttermilk, oil, and vanilla; beat for 2 minutes.",
+    "Stir in hot coffee (batter will be thin).",
+    "Pour into greased and floured cake pans.",
+    "Bake for 30-35 minutes.",
+    "Cool completely before frosting."
+  ],
+  prep_time: 25,                                        # prep_time (keyword)
+  cook_time: 35,                                        # cook_time (keyword)
+  difficulty: "medium",                                 # difficulty (keyword)
+  sweetness: "high",                                    # sweetness (keyword)
+  calories_per_serving: 450                             # calories_per_serving (keyword)
+)
+
+puts "Dessert Recipe:\n#{chocolate_cake}"

data/examples/require_check_all_example.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Add lib directory to load path
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+# This automatically enables Ivar.check_all
+require "ivar/check_all"
+
+# Now all classes and modules defined in the project will have Ivar::Checked included
+class Sandwich
+  def initialize
+    @bread = "wheat"
+    @cheese = "muenster"
+  end
+
+  def to_s
+    "A #{@bread} sandwich with #{@chese}"  # Intentional typo in @cheese
+  end
+end
+
+# Create a sandwich - this will automatically check instance variables
+sandwich = Sandwich.new
+puts sandwich

data/examples/sandwich_inheritance.rb

@@ -24,7 +24,7 @@ class SpecialtySandwich < BaseSandwich
 
   def to_s
     result = "#{base_to_s} with #{@condiments.join(", ")}"
-    result += " and #{@special_sause}" # Typo here
+    result += " and #{@special_sause}"  # Intentional typo in @special_sauce
     result
   end
 end

data/examples/sandwich_with_accessors.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "ivar"
+
+class SandwichWithAccessors
+  include Ivar::Checked
+
+  # Declare instance variables with accessors
+  ivar :@bread, :@cheese, accessor: true, value: "default"
+
+  # Declare condiments with a reader
+  ivar :@condiments, reader: true, value: ["mayo", "mustard"]
+
+  # Declare pickles with a writer
+  ivar :@pickles, writer: true, value: true
+
+  # Declare a variable without any accessors
+  ivar :@side
+
+  def initialize(options = {})
+    # Override defaults if options provided
+    @bread = options[:bread] if options[:bread]
+    @cheese = options[:cheese] if options[:cheese]
+
+    # Add extra condiments if provided
+    @condiments += options[:extra_condiments] if options[:extra_condiments]
+
+    # Set pickles based on options
+    @pickles = options[:pickles] if options.key?(:pickles)
+
+    # Set side if provided
+    @side = options[:side] if options[:side]
+  end
+
+  def to_s
+    result = "A #{@bread} sandwich with #{@cheese}"
+    result += " and #{@condiments.join(", ")}" unless @condiments.empty?
+    result += " with pickles" if @pickles
+    result += " and a side of #{@side}" if defined?(@side) && @side
+    result
+  end
+
+  # Custom reader for side since we didn't create an accessor
+  attr_reader :side
+
+  # Custom method to toggle pickles
+  def toggle_pickles
+    @pickles = !@pickles
+  end
+end
+
+# Create a sandwich with default values
+sandwich = SandwichWithAccessors.new
+puts "Default sandwich: #{sandwich}"
+puts "Bread: #{sandwich.bread}"
+puts "Cheese: #{sandwich.cheese}"
+puts "Condiments: #{sandwich.condiments.join(", ")}"
+puts "Side: #{sandwich.side.inspect}"
+
+# Modify the sandwich using accessors
+sandwich.bread = "rye"
+sandwich.cheese = "swiss"
+sandwich.pickles = false
+puts "\nModified sandwich: #{sandwich}"
+
+# Create a sandwich with custom options
+custom = SandwichWithAccessors.new(
+  bread: "sourdough",
+  cheese: "provolone",
+  extra_condiments: ["pesto"],
+  pickles: false,
+  side: "chips"
+)
+puts "\nCustom sandwich: #{custom}"
+
+# Toggle pickles and show the result
+custom.toggle_pickles
+puts "After toggling pickles: #{custom}"