students_list_yaml_silerhofe 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbbd30ecddec6dddd28cc35d5005c180a19a09a6b10c328231a2ddfae8e71bd2
+  data.tar.gz: 6b60b60f2d94c3093146bb20deb6e8a46af7937e47030595d0296f8e08395244
+SHA512:
+  metadata.gz: 63fa7c3053e504d20c3a3eaae366b472fdeb19ca02fbfce6fe392987b7eb97d87f9210cafe38f4196e8fd904b4cb84654b00b62dfaf9fb243b52c8f46fb17b53
+  data.tar.gz: '09e799ae055223e1f7d6a66442a36c927ff9b65a6b4dc009ade13adae873e48002a7fc4ec42c927058c3f09217a668ea5eb55feeb70027fa94c2dd5ca061a454'

data/README.md

@@ -0,0 +1,55 @@
+# StudentsListYAML Gem
+
+Простой gem для работы со списками студентов в формате YAML.
+
+## Установка
+
+```bash
+# Собрать gem
+gem build students_list_yaml.gemspec
+
+# Установить
+gem install students_list_yaml-0.1.2.gem
+```
+
+## Использование
+
+```ruby
+require 'students_list_yaml'
+
+# Создаем экземпляр
+list = StudentsListYAML::StudentsListYAML.new('test_students.yaml')
+
+# Записываем в файл
+list.write_to_file(students_data)
+puts "Данные записаны в test_students.yaml"
+
+# Читаем из файла
+loaded_data = list.read_from_file()
+puts "Прочитано #{list.count} студентов:"
+loaded_data.each { |s| puts "  - #{s[:name]} (#{s[:group]})" }
+
+# Добавляем нового студента
+list.add_student({ id: 3, name: "Сидорова А.В.", group: "ИВТ-303" })
+list.write_to_file()
+
+```
+
+## API
+
+### StudentsListYAML::StudentsListYAML
+
+Класс для управления списком студентов в YAML формате.
+
+#### Методы
+
+- `read_from_file(file_path)` - чтение из YAML файла
+- `write_to_file(file_path, data = @students)` - запись в YAML файл
+- `count` - получение количества студентов
+- `add_student(student_data)` - добавление студента
+- `find_by_id(id)` - поиск студента по ID
+- `filter_by_group(group)` - фильтрация студентов по группе
+
+## Лицензия
+
+MIT

data/lib/students_list_yaml/Data_list.rb

@@ -0,0 +1,56 @@
+require_relative 'Data_table'
+
+class Data_list
+  
+  def initialize(list)
+    @list = list
+    @selected =[]
+  end
+
+  def select(number)
+    check_bounds(number)
+    @selected << number if !@selected.include?(number)
+  end
+  
+  def get_selected
+    @selected.map{ |number| @list[number].id}
+  end
+  
+  def get_names
+    headers =["№ по порядку"]
+    headers.concat(get_fields || [])
+  end
+  
+  def get_data
+    list_clone = @list.dup
+    table = []
+    list_clone.each_with_index.map do |entity, index|
+      row = [index+1] + get_values(entity)
+      table << row
+    end
+    Data_table.new(table)
+  end
+
+  def clear_selected
+    @selected.clear
+  end
+  
+  private
+  
+  def list=(value)
+    @list = value
+  end
+
+  def get_values(entity)
+    raise NotImplementedError, "Метод должен быть реализован в подклассе"
+  end
+
+  def get_fields
+    raise NotImplementedError, "Метод должен быть реализован в подклассе"
+  end
+
+  def check_bounds(number)
+    raise IndexError, "Выход за границы строки"  if number<0 || number>=@list.size
+  end
+
+end

data/lib/students_list_yaml/Data_table.rb

@@ -0,0 +1,36 @@
+class Data_table
+  def initialize(matrix)
+    self.matrix = matrix
+  end
+
+  def countRow
+    @matrix.size
+  end
+  def countColumn
+    @matrix.empty? ? 0 : @matrix[0].size
+  end
+
+  def [](row, column = nil)
+    return @matrix[row] if column.nil?
+    @matrix[row,column]
+  end
+
+  def checkIndex(row,column)
+    raise IndexError, "Выход за границы строки" if row<0 || row>=countRow
+    raise IndexError, "Выход за границы столбца" if column<0 || column>=countColumn
+  end
+  private
+  def matrix=(value)
+    unless value.is_a?(Array) && value.all? { |row| row.is_a?(Array)}
+      raise ArgumentError, "Значение должно быть двумерным массивом"
+    end
+    unless value.empty?
+      length = value[0].length
+      unless value.all? { |row| row.length == length}
+        raise ArgumentError, "Строки должны быть одного размера"
+      end
+    end
+    @matrix = Marshal.load(Marshal.dump(value))
+  end
+
+end

data/lib/students_list_yaml/contact.rb

@@ -0,0 +1,58 @@
+require_relative 'validated_setter'
+
+class ContactInfo
+  extend ValidatedSetter
+
+  validated_attr_writer :phone, validatedMethod: :valid_phone?, must_nil: true
+  validated_attr_writer :email, validatedMethod: :valid_email?, must_nil: true
+  validated_attr_writer :telegram, validatedMethod: :valid_telegram?, must_nil: true
+
+  private :phone=, :telegram=, :email=
+
+  def initialize(phone: nil, telegram: nil, email: nil)
+    self.phone = phone
+    self.telegram = telegram
+    self.email = email
+  end
+
+  def contact=(hash)
+    self.phone = hash[:phone]
+    self.telegram = hash[:telegram]
+    self.email = hash[:email]
+  end
+
+  def contact
+    return "telegram - #{@telegram}" if @telegram
+    return "email - #{@email}" if @email
+    return "phone - #{@phone}" if @phone
+  end
+
+  def has_contact?
+    !contact.nil?
+  end
+
+  def ==(other)
+    fields = [:@phone, :@telegram, :@email]
+    fields.any? do |field|
+      value1 = instance_variable_get(field)
+      value2 = other.instance_variable_get(field)
+      value1 && value2 && value1 == value2
+    end
+  end
+
+  def to_s
+    "phone: #{@phone || "нет"} telegram: #{@telegram || "нет"} email: #{@email || "нет"}"
+  end
+
+  def self.valid_phone?(phone)
+    phone.nil? || phone.match?(/^(\+7|8)?[\s\-]?\(?\d{3}\)?[\s\-]?\d{3}[\s\-]?\d{2}[\s\-]?\d{2}$/)
+  end
+  
+  def self.valid_telegram?(telegram)
+    telegram.nil? || telegram.match?(/^@[A-Za-z0-9_]{5,32}$/)
+  end
+  
+  def self.valid_email?(email)
+    email.nil? || email.match?(/^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$/)
+  end
+end

data/lib/students_list_yaml/data_list_student_short.rb

@@ -0,0 +1,17 @@
+require_relative 'Data_table'
+require_relative 'Data_list'
+require_relative 'student_short'
+
+class Data_list_student_short < Data_list
+  def get_fields
+    ["Фамилия И. О.", "Контакт", "Git"]
+  end
+
+  def get_values(student_short)
+    [
+      student_short.last_name_initials || "Null",
+      student_short.contact || "Null",
+      student_short.git || "Null"
+    ]
+  end
+end

data/lib/students_list_yaml/student.rb

@@ -0,0 +1,110 @@
+require_relative 'super_student'
+require_relative 'validated_setter'
+require_relative 'contact'
+
+class Student < SuperStudent
+  extend ValidatedSetter
+  include Comparable
+  attr_reader  :last_name, :first_name, :patronymic
+  validated_attr_writer :first_name, validatedMethod: :valid_name?
+  validated_attr_writer :last_name, validatedMethod: :valid_name?
+  validated_attr_writer :patronymic, validatedMethod: :valid_name?, must_nil: true
+  validated_attr_writer :git, validatedMethod: :valid_git?, must_nil: true
+
+  # Основной конструктор
+  def initialize(first_name:, last_name:, id: nil, patronymic: nil, git: nil, phone: nil, email: nil,telegram: nil)
+    if last_name.nil? or first_name.nil? then
+      raise ArgumentError, "Имя и Фамилия обезательны"
+    end
+  
+    super(id: id, git: git)
+    self.last_name = last_name
+    self.first_name = first_name
+    self.patronymic = patronymic
+    @contact_info = ContactInfo.new(phone: phone, telegram: telegram, email: email)
+  end
+
+  # Альтернативный конструктор, принимающий хеш
+  def self.from_hash(hash)
+    new(
+      id: hash[:id],
+      first_name: hash[:first_name],
+      last_name: hash[:last_name],
+      patronymic: hash[:patronymic],
+      git: hash[:git],
+      phone: hash[:phone],
+      email: hash[:email],
+      telegram: hash[:telegram]
+    )
+  end
+
+  def <=>(other)
+    [last_name, first_name, patronymic] <=> [other.last_name, other.first_name, other.patronymic]
+  end
+
+  def ==(other)
+    (@git && other.git && @git == other.git) || @contact_info == other.instance_variable_get(:@contact_info)
+  end
+
+  def contact=(hash)
+    @contact_info.contact = hash
+  end
+
+  def self.valid_name?(name)
+  !name.nil? && name.match?(/^[A-ZА-Я]+[a-zа-яё]+$/)
+  end
+  
+  def self.valid_phone?(phone)
+    ContactInfo.valid_phone?(phone)
+  end
+  
+  def self.valid_telegram?(telegram)
+    ContactInfo.valid_telegram?(telegram)
+  end
+  
+  def self.valid_email?(email)
+    ContactInfo.valid_email?(email)
+  end
+
+  def self.valid_git?(git)
+    git.match?(%r{^https://(github|gitlab)\.com/[A-Za-z0-9_\-]+$})
+  end
+
+  def contact
+    @contact_info.contact
+  end
+
+  def last_name_initials()
+    if patronymic then
+      result = "#{@last_name} " + "#{@first_name[0]}. " + "#{@patronymic[0]}."
+    else
+        result = "#{@last_name} " + "#{@first_name[0]}."
+    end
+    result
+  end
+
+  def to_s
+    result = "
+    id: #{format_field(@id)}, 
+    Имя: #{@first_name}, 
+    Фамилия: #{@last_name}, 
+    Отчество: #{format_field(@patronymic)}, 
+    #{@contact_info.to_s}, 
+    Git: #{format_field(@git)}
+    "
+    result
+  end
+
+  def to_hash()
+    {
+      id: self.id,
+      last_name: self.last_name,
+      first_name: self.first_name,
+      patronymic: self.patronymic,
+      git: self.git,
+      phone: @contact_info.instance_variable_get(:@phone),
+      email: @contact_info.instance_variable_get(:@email),
+      telegram: @contact_info.instance_variable_get(:@telegram)
+    }
+  end
+end

data/lib/students_list_yaml/student_base.rb

@@ -0,0 +1,122 @@
+require_relative 'student'
+require_relative 'student_short'
+require_relative 'data_list_student_short'
+
+class StudentsListBase
+  def initialize(file_path)
+    self.file_path = file_path
+    read_from_file
+  end
+  
+  def read_from_file
+    content = File.read(@file_path)
+    return [] if content.strip.empty?
+    @array_list = load(content).map { |element| Student.new(**element) }
+  end
+  
+  def write_to_file()
+    new_data = @array_list.map { |element| element.to_hash}
+    write_in(new_data)  
+  end
+  
+
+  def get_student_by_id(id)
+    @array_list.find { |e| e.id == id }
+  end
+  
+  def get_k_n_student_short_list(k, n, data_list = nil)
+    start_index = (k - 1) * n
+    end_index = start_index + n - 1
+    range = @array_list[start_index..end_index] || []
+
+    student_shorts = range.map { |student| StudentShort.from_student(student)}
+
+    if data_list
+      data_list.list = student_shorts
+      data_list
+    else
+      Data_list_student_short.new(student_shorts)
+    end
+  end
+  
+  def sort_by_fio
+    @array_list.sort_by! { |student| student.last_name_initials}
+  end
+  
+
+  def add_student(student)
+    if duplicate_exist?(student)
+      raise ArgumentError, "Студент с такими контактными данными (git, phone, telegram, email) уже существует"
+    end
+
+    new_id = @array_list.empty? ? 1 : @array_list.map { |student| student.id}.max + 1
+    student.instance_variable_set(:@id, new_id)
+    @array_list << student
+    new_id
+  end
+  
+
+  def replace_student_by_id(id, new_student)
+    index = @array_list.index { |student| student.id == id}
+
+    if duplicate_exist?(new_student, exclude_id: id)
+      raise ArgumentError, "Студент с такими контактными данными (git, phone, telegram, email) уже существует"
+    end
+
+    @array_list[index] = new_student.instance_variable_set(:@id, id)
+  end
+  
+
+  def delete_student_by_id(id)
+    @array_list.reject! { |student| student.id == id}
+  end
+
+  def get_student_short_count
+    @array_list.length
+  end
+  
+  protected
+  
+  def parse_student_data(data)
+    Student.new(
+      id: data['id'] || data[:id],
+      last_name: data['last_name'] || data[:last_name],
+      first_name: data['first_name'] || data[:first_name],
+      patronymic: data['patronymic'] || data[:patronymic],
+      git: data['git'] || data[:git],
+      phone: data['phone'] || data[:phone],
+      email: data['email'] || data[:email],
+      telegram: data['telegram'] || data[:telegram]
+    )
+  end
+  
+  private
+
+  def duplicate_exist?(student, exclude_id: nil)
+    @array_list.any? do |other|
+      next if exclude_id && other.id == exclude_id
+      student == other
+    end
+  end
+
+  def load(content)
+    raise ArgumentError, "Метод должен быть определен в потомках"
+  end
+
+  def write_in(extended_data)
+    raise ArgumentError, "Метод должен быть определен в потомках"
+  end
+
+  def file_path=(path)
+    normalized_path = File.expand_path(path.to_s)
+
+    unless File.exist?(normalized_path) || File.file?(normalized_path)
+      raise ArgumentError, "Файл: #{normalized_path} не существует лиюбо неправильно указан путь"
+    end
+    @file_path = path
+  end
+
+  def clear
+    File.write(@file_path, '')
+  end
+end

data/lib/students_list_yaml/student_short.rb

@@ -0,0 +1,25 @@
+require_relative 'super_student'
+class StudentShort < SuperStudent
+    attr_reader :last_name_initials, :contact, :git
+
+    def initialize(id:, git: nil, last_name_initials:, contact: nil)
+    if id.nil? then
+        raise ArgumentError, "ID обязательный"
+    end
+    if last_name_initials.nil? then
+        raise ArgumentError, "Фамилия и инициалы обязательны"
+    end
+        super(id:id, git:git)
+        @last_name_initials = last_name_initials
+        @contact = contact
+    end
+
+    def self.from_student(student)
+        new(
+            id: student.id,
+            last_name_initials: student.last_name_initials,
+            contact: student.contact,
+            git: student.git
+        )
+    end
+end

data/lib/students_list_yaml/super_student.rb

@@ -0,0 +1,48 @@
+class SuperStudent
+
+  attr_reader :id, :git
+  def initialize(id: nil, git: nil)
+    @id = id
+    @git = git
+  end
+
+  def has_git?
+    not_empty?(@git)
+  end
+
+  def has_contact?
+    !contact.nil?
+  end
+
+  def last_name_initials
+    raise NotImplementedError, "Метод должен быть реализован в подклассе"
+  end
+
+  def contact
+    raise NotImplementedError, "Метод должен быть реализован в подклассе"    
+  end
+
+  def short_info
+    result ="
+    ID: #{id}
+    Фамилия Инициалы: #{last_name_initials}
+    Гит: #{format_field(@git)}
+    Контакт: #{format_field(contact)}
+    "
+    result
+  end
+
+  def to_s
+    short_info    
+  end
+
+  private
+  def not_empty?(value)
+    !value.nil? && !value.to_s.empty?
+  end
+
+  def format_field(value)
+    value || 'Отсутствует'
+  end
+
+end

data/lib/students_list_yaml/validated_setter.rb

@@ -0,0 +1,20 @@
+module ValidatedSetter
+  private
+  def validated_attr_writer(attribute, validatedMethod: nil, must_nil:false)
+    define_method("#{attribute}=") do |value|
+      if value.nil?
+        if must_nil
+          instance_variable_set("@#{attribute}", value)
+          return
+        end
+        raise ArgumentError, "Поле #{attribute} обязательно"
+      end
+      unless validatedMethod.nil?
+        unless self.class.send(validatedMethod,value)
+          raise ArgumentError, "Некорректное значение #{attribute}"
+        end
+      end
+      instance_variable_set("@#{attribute}",value)
+    end
+  end
+end

data/lib/students_list_yaml/version.rb

@@ -0,0 +1,3 @@
+module StudentsListYAML
+  VERSION = "0.2.5"
+end

data/lib/students_list_yaml.rb

@@ -0,0 +1,16 @@
+require_relative 'students_list_yaml/version'
+require 'yaml'
+require_relative 'students_list_yaml/student_base'
+
+module StudentsListYAML
+  class StudentsList < StudentsListBase
+    
+    def load(content)
+      YAML.safe_load(content, permitted_classes: [Symbol], symbolize_names: true) || []
+    end
+
+    def write_in(extended_data)
+      File.write(@file_path, YAML.dump(extended_data))
+    end
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: students_list_yaml_silerhofe
+version: !ruby/object:Gem::Version
+  version: 0.2.5
+platform: ruby
+authors:
+- SilerHofe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Реализация паттерна Repository для работы с данными студентов
+email:
+- Siler.Hofe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/students_list_yaml.rb
+- lib/students_list_yaml/Data_list.rb
+- lib/students_list_yaml/Data_table.rb
+- lib/students_list_yaml/contact.rb
+- lib/students_list_yaml/data_list_student_short.rb
+- lib/students_list_yaml/student.rb
+- lib/students_list_yaml/student_base.rb
+- lib/students_list_yaml/student_short.rb
+- lib/students_list_yaml/super_student.rb
+- lib/students_list_yaml/validated_setter.rb
+- lib/students_list_yaml/version.rb
+homepage: https://zhuk.k-lab.su/SilerHofe/design-patterns-template/students_list_yaml
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: Класс для работы со списками студентов в формате YAML
+test_files: []