rubbish_code 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4b21965f0130ca61a48365f3da378ad726bf29a211ee6d2327cc825e0eb8449
-  data.tar.gz: b19d9d9517f6a90fa30f7ac0e0426e71d34a0a3d80e29e59e1105f439884fb70
+  metadata.gz: 2dafe2051c5e2de11d72e00a434486b1bd66b1914411ac64b216918181f7fa8b
+  data.tar.gz: 0216bdf9531c3876cc9ee8667641e8178fb16c9f6427ee5c5f30fcc344510af5
 SHA512:
-  metadata.gz: eb08de61aa853a490678f922b6ef29ccbf30af3e00f3f9cd3a50ab98db4feae77b0a2f99f5301601712dd7f13112d1b9fb5c1fe6b6abf50148c8d006c435c8ee
-  data.tar.gz: b6e3c9963cc335cb5b957c7fbda8ce9e80d639b6021016b607a1a179131a2dfc5732217d1818879f24f7e41477846db7e5c573f5d2fa1923110bb8e34a2b39ab
+  metadata.gz: 81862c94d927737e281b8c0fb394a01f3a94ac9a496646ec24649a8cd0dc3b32b9134fbd220d5b56a2cc5027d2206ded5b443187e7f3013794451271fbf054d5
+  data.tar.gz: 5faf849675ce3e4d28408ea9375f20ecab248e10fa7eaa780fd4cf474f55d9a5bedf97b106684fdcf614d432096005bce44d78a3ba1b983d12733e5cee2fbb71

data/Documentation.md

@@ -0,0 +1,33 @@
+The TabStudentsController class is a controller for working with the interface for interacting with objects of the Student type.
+
+Methods of the class:
+
+1. initialize(view) - constructor of the class, takes a view object and creates an empty object of the type
+DataListStudentShort, which is assigned the add_listener method with the view argument, as a result of which the view
+is set as a listener for data state change events (data_list).
+2. on_view_created is a method that initializes an object of the StudentRepository type, which is used for interaction
+with the database, and if an error occurs connecting to the database displays a dialog box with an error message.
+3. show_view is a method that displays the main application window.
+4. show_modal_add is a method that displays a modal window for creating a new student record.
+Creates an instance of the StudentInputFormControllerCreate controller and passes it a reference to the current controller,
+creates an object of the StudentInputForm type and passes it a reference to the controller. Then it displays the modal window.
+5. show_modal_edit(current_page, per_page, selected_row) is a method that displays the modal window for
+editing a student record. Takes the values of the current page (current_page), the number of records on the page
+(per_page) and the selected row (selected_row). Calculates the number of the selected student and selects his id from
+the DataListStudentShort object, then passes it to the StudentInputFormControllerEdit controller, creates an object of the type
+StudentInputForm and passes it a link to the controller. After that, it displays a modal window.
+6. delete_selected(current_page, per_page, selected_row) is a method that deletes the selected student record.
+Takes the values of the current page (current_page), the number of records on the page (per_page)
+and the selected row (selected_row). Calculates the number of the selected student and selects his id from the DataListStudentShort object,
+then deletes the record using the remove_student method from the StudentRepository object.
+7. refresh_data(page, per_page) is a method that updates the data in the list of students. Takes the values
+of the current page (page) and the number of entries on the page (per_page).
+Calls a method of the StudentRepository paginated_short_students type to get data in the DataListStudentShort object format.
+Updates information about the number of students using the update_student_count method of the view.
+
+The Student_Input_Form_Controller_Edit controller and Student_Input_Form_Controller_Create are forms
+for modifying and creating students into the database, respectively.
+
+The student, student_base and student_short models are a student model with various fields and methods
+for setting, receiving and processing information. Student_base - super class,
+and student_short is the short information about the student.

data/LICENSE.txt

@@ -2,36 +2,20 @@ MIT License
 
 Copyright (c) 2023 NullExp
 
-Класс TabStudentsController представляет собой контроллер для работы с интерфейсом взаимодействия с объектами типа Student.
+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.
 
-1. initialize(view) - конструктор класса, принимает объект представления (view) и создает пустой объект типа
-DataListStudentShort, которому присваивается метод add_listener с аргументом view, в результате чего представление
-устанавливается в качестве слушателя событий изменения состояния данных (data_list).
-2. on_view_created - метод, инициализирующий объект типа StudentRepository, который используется для взаимодействия
-с базой данных, и при возникновении ошибки подключения к базе выводит диалоговое окно с сообщением об ошибке.
-3. show_view - метод, отображающий основное окно приложения.
-4. show_modal_add - метод, отображающий модальное окно для создания новой записи о студенте.
-Создает экземпляр контроллера StudentInputFormControllerCreate и передает ему ссылку на текущий контроллер,
-создает объект типа StudentInputForm и передает ему ссылку на контроллер. После чего отображает модальное окно.
-5. show_modal_edit(current_page, per_page, selected_row) - метод, отображающий модальное окно для
-редактирования записи о студенте. Принимает значения текущей страницы (current_page), количества записей на странице
-(per_page) и выбранной строки (selected_row). Вычисляет номер выбранного студента и выбирает его id из
-объекта DataListStudentShort, после чего передает его в контроллер StudentInputFormControllerEdit, создает объект типа
-StudentInputForm и передает ему ссылку на контроллер. После чего отображает модальное окно.
-6. delete_selected(current_page, per_page, selected_row) - метод, удаляющий выбранную запись о студенте.
-Принимает значения текущей страницы (current_page), количества записей на странице (per_page)
-и выбранной строки (selected_row). Вычисляет номер выбранного студента и выбирает его id из объекта DataListStudentShort,
-после чего удаляет запись с помощью метода remove_student из объекта типа StudentRepository.
-7. refresh_data(page, per_page) - метод, обновляющий данные в списке студентов. Принимает значения
-текущей страницы (page) и количества записей на странице (per_page).
-Вызывает метод типа StudentRepository paginated_short_students для получения данных в формате объекта DataListStudentShort.
-Обновляет информацию о количестве студентов с помощью метода update_student_count представления.
-
-Контроллер Student_Input_Form_Controller_Edit и Student_Input_Form_Controller_Create представляют собой формы
-для изменения и создания студентов в базу данных, соотвественно.
-
-Модели student, student_base и student_short представляет собой модель студента с различными полями и методами
-для установки, получения и обработки информации. Student_base - супер класс,
-а student_short - короктая информация о студенте.
+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/{lib/controllers → controllers}/tab_students_controller.rb

@@ -7,28 +7,29 @@ require './LabStudents/repositories/containers/data_list_student_short'
 require './LabStudents/views/student_input_form'
 require './LabStudents/controllers/student_input_form/student_input_form_controller_create'
 require './LabStudents/controllers/student_input_form/student_input_form_controller_edit'
+require './LabStudents/util/logger_holder'
 require 'win32api'
 
 class TabStudentsController
   def initialize(view)
+    LoggerHolder.instance.debug('TabStudentsController: init start')
     @view = view
     @data_list = DataListStudentShort.new([])
     @data_list.add_listener(@view)
+    LoggerHolder.instance.debug('TabStudentsController: init done')
   end
 
   def on_view_created
-    #begin
+    begin
       @student_rep = StudentRepository.new(DBSourceAdapter.new)
-    # rescue Mysql2::Error::ConnectionError
-    #   on_db_conn_error
-    # end
-  end
-
-  def show_view
-    @view.create.show
+      LoggerHolder.instance.debug('TabStudentsController: created student repository')
+    rescue Mysql2::Error::ConnectionError => e
+       on_db_conn_error(e)
+    end
   end
 
   def show_modal_add
+    LoggerHolder.instance.debug('TabStudentsController: showing modal (add)')
     controller = StudentInputFormControllerCreate.new(self)
     view = StudentInputForm.new(controller)
     controller.set_view(view)
@@ -36,6 +37,7 @@ class TabStudentsController
   end
 
   def show_modal_edit(current_page, per_page, selected_row)
+    LoggerHolder.instance.debug('TabStudentsController: showing modal (edit)')
     student_num = (current_page - 1) * per_page + selected_row
     @data_list.select_element(student_num)
     student_id = @data_list.selected_id
@@ -46,30 +48,35 @@ class TabStudentsController
   end
 
   def delete_selected(current_page, per_page, selected_row)
-    #begin
+    begin
+      LoggerHolder.instance.debug('TabStudentsController: deleting selected student')
       student_num = (current_page - 1) * per_page + selected_row
       @data_list.select_element(student_num)
       student_id = @data_list.selected_id
       @student_rep.remove_student(student_id)
-    # rescue
-    #   on_db_conn_error
-    # end
+    rescue Mysql2::Error::ConnectionError => e
+      on_db_conn_error(e)
+    end
   end
 
   def refresh_data(page, per_page)
-    #begin
+    begin
+      LoggerHolder.instance.debug('TabStudentsController: refreshing data...')
       @data_list = @student_rep.paginated_short_students(page, per_page, @data_list)
       @view.update_student_count(@student_rep.student_count)
-    # rescue
-    #   on_db_conn_error
-    # end
+    rescue Mysql2::Error::ConnectionError => e
+      on_db_conn_error(e)
+    end
   end
 
   private
 
-  def on_db_conn_error
-    # api = Win32API.new('user32', 'MessageBox', ['L', 'P', 'P', 'L'], 'I')
-    # api.call(0, "No connection to DB =)", "Error", 0)
-    # exit(false)
+  def on_db_conn_error(error)
+    LoggerHolder.instance.error('TabStudentsController: DB connection error:')
+    LoggerHolder.instance.error(error.message)
+    api = Win32API.new('user32', 'MessageBox', ['L', 'P', 'P', 'L'], 'I')
+    api.call(0, "No connection to DB", "Error", 0)
+    # TODO: Возможность переключения на JSON помимо exit
+    exit(false)
   end
 end

data/db_config/config.yaml

@@ -0,0 +1,5 @@
+host: 'localhost'
+port: 3306
+username: 'root'
+password: '1234'
+database: 'university'

data/db_config/migrations/001_create_table_student.sql

@@ -0,0 +1,12 @@
+create table student (
+     id          int auto_increment,
+     last_name   varchar(128) not null,
+     first_name  varchar(128) not null,
+     father_name varchar(128) not null,
+     phone       varchar(20) null,
+     telegram    varchar(100) null,
+     email       varchar(100) null,
+     git         varchar(100) null,
+     constraint student_pk
+         primary key (id)
+);

data/models/student_test.rb

@@ -0,0 +1,71 @@
+require 'test/unit'
+require_relative 'student'
+
+class TestStudent < Test::Unit::TestCase
+  def setup
+    @student = Student.new('Иванов', 'Иван', 'Иванович')
+  end
+
+  def test_full_name
+    assert_equal('Иванов Иван Иванович', @student.to_s.split(', ')[0])
+  end
+
+  def test_contacts
+    @student = Student.new('Иванов', 'Иван', 'Иванович')
+    @student.set_contacts(phone: '+79991234567',  email: 'ivanov@example.com')
+    assert_equal('+79991234567', @student.phone)
+    assert_equal('ivanov@example.com', @student.email)
+  end
+
+  def test_valid_name
+    assert(Student.valid_name?('Иванов'))
+    assert(!Student.valid_name?('Сидоров-Петров'))
+    assert(!Student.valid_name?('X'))
+    assert(Student.valid_name?('Abcdefghijklmnopqrstuvwxyz'))
+    assert(!Student.valid_name?(''))
+    assert(!Student.valid_name?('Иванов 123'))
+    assert(!Student.valid_name?('Иванов.'))
+    assert(!Student.valid_name?('-Иванов'))
+  end
+
+  def test_from_hash
+    hash = {
+      first_name: 'Иван',
+      last_name: 'Иванов',
+      father_name: 'Иванович',
+      phone: '+79991234567',
+      telegram: 'ivanov',
+      email: 'ivanov@example.com',
+      git: 'ivanov'
+    }
+    student = Student.from_hash(hash)
+    assert_equal(hash[:first_name], student.first_name)
+    assert_equal(hash[:last_name], student.last_name)
+    assert_equal(hash[:father_name], student.father_name)
+    assert_equal(hash[:phone], student.phone)
+    assert_equal(hash[:telegram], student.telegram)
+    assert_equal(hash[:email], student.email)
+    assert_equal(hash[:git], student.git)
+  end
+
+  def test_from_json_str
+    hash = {
+      first_name: 'Иван',
+      last_name: 'Иванов',
+      father_name: 'Иванович',
+      phone: '+79991234567',
+      telegram: 'ivanov',
+      email: 'ivanov@example.com',
+      git: 'ivanov'
+    }
+    json_str = hash.to_json
+    student = Student.from_json_str(json_str)
+    assert_equal(hash[:first_name], student.first_name)
+    assert_equal(hash[:last_name], student.last_name)
+    assert_equal(hash[:father_name], student.father_name)
+    assert_equal(hash[:phone], student.phone)
+    assert_equal(hash[:telegram], student.telegram)
+    assert_equal(hash[:email], student.email)
+    assert_equal(hash[:git], student.git)
+  end
+end

data/repositories/student_repository.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class StudentRepository
+  def initialize(data_source_adapter)
+    @data_source_adapter = data_source_adapter
+  end
+
+  def student_by_id(student_id)
+    @data_source_adapter.student_by_id(student_id)
+  end
+
+  # Получить page по счету count элементов (страница начинается с 1)
+  def paginated_short_students(page, count, existing_data_list = nil)
+    @data_source_adapter.paginated_short_students(page, count, existing_data_list)
+  end
+
+  def add_student(student)
+    @data_source_adapter.add_student(student)
+  end
+
+  def replace_student(student_id, student)
+    @data_source_adapter.replace_student(student_id, student)
+  end
+
+  def remove_student(student_id)
+    @data_source_adapter.remove_student(student_id)
+  end
+
+  def student_count
+    @data_source_adapter.student_count
+  end
+end

data/util/logger_holder.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+class LoggerHolder
+  private_class_method :new
+  @instance_mutex = Mutex.new
+
+  attr_reader :logger
+
+  def initialize
+    @logger = Logger.new(STDOUT)
+  end
+
+  def self.instance
+    return @instance.logger if @instance
+
+    @instance_mutex.synchronize do
+      @instance ||= new
+    end
+
+    @instance.logger
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubbish_code
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Jake Epps
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: win32api
@@ -30,14 +30,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Documentation.md
 - LICENSE.txt
 - README.md
-- lib/controllers/student_input_form/student_input_form_controller_create.rb
-- lib/controllers/student_input_form/student_input_form_controller_edit.rb
-- lib/controllers/tab_students_controller.rb
-- lib/models/student.rb
-- lib/models/student_base.rb
-- lib/models/student_short.rb
+- controllers/tab_students_controller.rb
+- db_config/config.yaml
+- db_config/migrations/001_create_table_student.sql
+- models/student.rb
+- models/student_base.rb
+- models/student_short.rb
+- models/student_test.rb
+- repositories/student_repository.rb
+- util/logger_holder.rb
 homepage: https://github.com/Jakepps/Ruby_Moment
 licenses:
 - MIT
@@ -50,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/controllers/student_input_form/student_input_form_controller_create.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require 'win32api'
-
-class StudentInputFormControllerCreate
-  def initialize(parent_controller)
-    @parent_controller = parent_controller
-  end
-
-  def set_view(view)
-    @view = view
-  end
-
-  def on_view_created
-    begin
-      @student_rep = StudentRepository.new(DBSourceAdapter.new)
-    rescue Mysql2::Error::ConnectionError
-      on_db_conn_error
-    end
-  end
-
-  def process_fields(fields)
-    begin
-      last_name = fields.delete(:last_name)
-      first_name = fields.delete(:first_name)
-      father_name = fields.delete(:father_name)
-
-      return if last_name.nil? || first_name.nil? || father_name.nil?
-
-      student = Student.new(last_name, first_name, father_name, **fields)
-
-      @student_rep.add_student(student)
-
-      @view.close
-    rescue ArgumentError => e
-      api = Win32API.new('user32', 'MessageBox', ['L', 'P', 'P', 'L'], 'I')
-      api.call(0, e.message, 'Error', 0)
-    end
-  end
-
-  private
-
-  def on_db_conn_error
-    api = Win32API.new('user32', 'MessageBox', ['L', 'P', 'P', 'L'], 'I')
-    api.call(0, "No connection to DB говно", "Error", 0)
-    @view.close
-  end
-end

data/lib/controllers/student_input_form/student_input_form_controller_edit.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require 'win32api'
-
-class StudentInputFormControllerEdit
-  def initialize(parent_controller, existing_student_id)
-    @parent_controller = parent_controller
-    @existing_student_id = existing_student_id
-  end
-
-  def set_view(view)
-    @view = view
-  end
-
-  def on_view_created
-    begin
-      @student_rep = StudentRepository.new(DBSourceAdapter.new)
-    rescue Mysql2::Error::ConnectionError
-      on_db_conn_error
-    end
-    @existing_student = @student_rep.student_by_id(@existing_student_id)
-    #@view.make_readonly(:git, :telegram, :email, :phone)
-    populate_fields(@existing_student)
-  end
-
-  def populate_fields(student)
-    @view.set_value(:last_name, student.last_name)
-    @view.set_value(:first_name, student.first_name)
-    @view.set_value(:father_name, student.father_name)
-    @view.set_value(:git, student.git)
-    @view.set_value(:telegram, student.telegram)
-    @view.set_value(:email, student.email)
-    @view.set_value(:phone, student.phone)
-  end
-
-  def process_fields(fields)
-    begin
-      new_student = Student.from_hash(fields)
-
-      @student_rep.replace_student(@existing_student_id, new_student)
-
-      @view.close
-    rescue ArgumentError => e
-      api = Win32API.new('user32', 'MessageBox', ['L', 'P', 'P', 'L'], 'I')
-      api.call(0, e.message, 'Error', 0)
-    end
-  end
-
-  private
-
-  def on_db_conn_error
-    api = Win32API.new('user32', 'MessageBox', ['L', 'P', 'P', 'L'], 'I')
-    api.call(0, "No connection to DB", "Error", 0)
-    @view.close
-  end
-end