students_lab4_s0195941 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 98d9755635837a41233209956b536c3b7c4697c3da369d0533462255e0f61baa
4
- data.tar.gz: 0650577a2363c75d54296ba17d2ef4cc74f16f5f82b47351ef8ca2d0b45fa064
3
+ metadata.gz: 0ec74855088d24716dbc0df653f9f263395137d922815d58ee985ec0d158c6f1
4
+ data.tar.gz: 026ecb37a7dc3bab60fa7844418b5c37a0c608697785a6b52ccba4ea484157b8
5
5
  SHA512:
6
- metadata.gz: 84ec7b37b7c7deb70a67a039b2ffd0677943e794ada1dec85289e1d5075ee137c94bb73d6d2426032876e197caef25badb23c8bcda18d617e900961ea0bc7994
7
- data.tar.gz: c585038ba12535870e2915087c01582fb76c8b85fd04ce88a7d477efbbb1b26dbdf992b3209662e3f29090d42876c3a79089049279ee6bd8091144aac364e95a
6
+ metadata.gz: e7795f2f1e1fa1a814cfd6ddade51d93dd4c4815db6181590034af318c7a3a18ed61208cb3f509b978e2bda31f68b7e873a1ee5fcfce0d629d871520ed556a08
7
+ data.tar.gz: 782ce859db2f666bce04b2bf41d389618246b34e607ac5952596e4dfed69df14211c5947937eab4e3a9c247c61a75336a153e95ebee0a0c9dce5c2351393b53f
data/.yardopts ADDED
@@ -0,0 +1,7 @@
1
+ --markup markdown
2
+ --title "Students Lab 4 - API documentation"
3
+ --asset uml
4
+ student_list_app.rb
5
+ model/*.rb
6
+ controller/*.rb
7
+ view/*.rb
@@ -1,5 +1,6 @@
1
1
  require_relative 'student_form_controller'
2
2
 
3
+ # Открывает пустую форму и добавляет новую запись.
3
4
  class CreateStudentController < StudentFormController
4
5
  private
5
6
 
@@ -1,48 +1,56 @@
1
- require_relative 'student'
2
- require_relative 'students_list'
3
-
4
- class StudentFormController
5
- def initialize(view, students)
6
- @view = view
7
- @students = students
8
- end
9
-
10
- def open
11
- @view.open(self, initial_attributes)
12
- end
13
-
14
- def changed(attributes)
15
- @view.set_submit_enabled(!build_student(attributes).nil?)
16
- end
17
-
18
- def submit(attributes)
19
- student = build_student(attributes)
20
- return unless student
21
-
22
- @view.accept if persist(student)
23
- rescue Students_list::DuplicateContact => error
24
- @view.show_duplicate_contact(error.field)
25
- rescue Students_list::ConnectionLost
26
- @view.show_connection_error
27
- end
28
-
29
- private
30
-
31
- def initial_attributes
32
- {}
33
- end
34
-
35
- def persist(student)
36
- raise NotImplementedError
37
- end
38
-
39
- def build_student(attributes)
40
- normalized = attributes.transform_values do |value|
41
- text = value.strip
42
- text.empty? ? nil : text
43
- end
44
- Student.new(**normalized)
45
- rescue ArgumentError
46
- nil
47
- end
48
- end
1
+ require_relative '../model/students_list'
2
+
3
+ # Проверяет поля и задаёт общий порядок сохранения для контроллеров формы.
4
+ class StudentFormController
5
+ def initialize(view, students)
6
+ @view = view
7
+ @students = students
8
+ end
9
+
10
+ # Открывает модальную форму со значениями, выбранными текущей стратегией.
11
+ def open
12
+ @view.open(self, initial_attributes)
13
+ end
14
+
15
+ # Проверяет текущий ввод по правилам Student и обновляет доступность ОК.
16
+ def changed(attributes)
17
+ @view.set_submit_enabled(!build_student(attributes).nil?)
18
+ end
19
+
20
+ # Сохраняет корректные данные и закрывает форму при успехе.
21
+ # @param attributes [Hash{Symbol => String}] значения полей формы
22
+ def submit(attributes)
23
+ student = build_student(attributes)
24
+ return unless student
25
+
26
+ if persist(student)
27
+ @view.accept
28
+ else
29
+ @view.show_missing_student
30
+ end
31
+ rescue Students_list::DuplicateContact => error
32
+ @view.show_duplicate_contact(error.field)
33
+ rescue Students_list::ConnectionLost
34
+ @view.show_connection_error
35
+ end
36
+
37
+ private
38
+
39
+ def initial_attributes
40
+ {}
41
+ end
42
+
43
+ def persist(student)
44
+ raise NotImplementedError
45
+ end
46
+
47
+ def build_student(attributes)
48
+ normalized = attributes.transform_values do |value|
49
+ text = value.strip
50
+ text.empty? ? nil : text
51
+ end
52
+ Student.new(**normalized)
53
+ rescue ArgumentError
54
+ nil
55
+ end
56
+ end
@@ -1,89 +1,98 @@
1
- require_relative 'students_list'
2
- require_relative 'create_student_controller'
3
- require_relative 'update_student_controller'
4
-
5
- class StudentListController
6
- PAGE_SIZE = 2
7
- attr_reader :page
8
-
9
- def initialize(view, connection)
10
- @view = view
11
- @students = Students_list.new(connection)
12
- @page = 1
13
- @incomplete_only = false
14
- @data_list = Data_list_student_short.new([])
15
- @data_list.add_observer(@view)
16
- end
17
-
18
- def refresh_data
19
- load_page
20
- last_page = [total_pages, 1].max
21
- if @page > last_page
22
- @page = last_page
23
- load_page
24
- end
25
- @data_list.notify
26
- rescue Students_list::ConnectionLost
27
- @view.show_connection_error('Не удалось загрузить список. Когда база заработает, нажмите «Обновить».')
28
- end
29
-
30
- def show_incomplete_students(incomplete_only)
31
- @incomplete_only = incomplete_only
32
- @page = 1
33
- refresh_data
34
- end
35
-
36
- def delete_selected(row_numbers)
37
- ids = selected_student_ids(row_numbers)
38
- return if ids.empty?
39
-
40
- @students.delete_many(ids)
41
- refresh_data
42
- rescue Students_list::ConnectionLost
43
- @view.show_connection_error('Связь прервалась при удалении. Обновите список, чтобы проверить результат.')
44
- end
45
-
46
- def open_create_form
47
- form = @view.build_student_form
48
- CreateStudentController.new(form, @students).open
49
- refresh_data
50
- end
51
-
52
- def open_update_form(row_numbers)
53
- ids = selected_student_ids(row_numbers)
54
- return unless ids.one?
55
-
56
- student = @students.get_by_id(ids.first)
57
- if student
58
- form = @view.build_student_form('Изменить студента')
59
- UpdateStudentController.new(form, @students, student).open
60
- end
61
- refresh_data
62
- rescue Students_list::ConnectionLost
63
- @view.show_connection_error('Не удалось загрузить студента. Когда база заработает, нажмите «Обновить».')
64
- end
65
-
66
- def total_pages
67
- (@data_list.whole_entities_count + PAGE_SIZE - 1) / PAGE_SIZE
68
- end
69
-
70
- def change_page(step)
71
- next_page = @page + step
72
- return unless next_page.between?(1, total_pages)
73
-
74
- @page = next_page
75
- refresh_data
76
- end
77
-
78
- private
79
-
80
- def load_page
81
- @students.get_k_n_student_short_list(@page, PAGE_SIZE, @data_list, incomplete_only: @incomplete_only)
82
- end
83
-
84
- def selected_student_ids(row_numbers)
85
- @data_list.clear_selected
86
- row_numbers.each { |row| @data_list.select(row) }
87
- @data_list.get_selected
88
- end
89
- end
1
+ require_relative '../model/students_list'
2
+ require_relative 'create_student_controller'
3
+ require_relative 'update_student_controller'
4
+
5
+ # Управляет списком, фильтром и действиями над выбранными студентами.
6
+ class StudentListController
7
+ # Число студентов на странице.
8
+ PAGE_SIZE = 2
9
+ attr_reader :page
10
+
11
+ def initialize(view, connection)
12
+ @view = view
13
+ @students = Students_list.new(connection)
14
+ @page = 1
15
+ @incomplete_only = false
16
+ @data_list = Data_list_student_short.new([])
17
+ @data_list.add_observer(@view)
18
+ end
19
+
20
+ # Загружает страницу в существующий список и уведомляет представление.
21
+ def refresh_data
22
+ load_page
23
+ last_page = [total_pages, 1].max
24
+ if @page > last_page
25
+ @page = last_page
26
+ load_page
27
+ end
28
+ @data_list.notify
29
+ rescue Students_list::ConnectionLost
30
+ @view.show_connection_error('Не удалось загрузить список. Когда база заработает, нажмите «Обновить».')
31
+ end
32
+
33
+ # Переключает фильтр и возвращает список на первую страницу.
34
+ def show_incomplete_students(incomplete_only)
35
+ @incomplete_only = incomplete_only
36
+ @page = 1
37
+ refresh_data
38
+ end
39
+
40
+ # Преобразует индексы выделенных строк в ID и удаляет записи одной транзакцией.
41
+ def delete_selected(row_numbers)
42
+ ids = selected_student_ids(row_numbers)
43
+ return if ids.empty?
44
+
45
+ @students.delete_many(ids)
46
+ refresh_data
47
+ rescue Students_list::ConnectionLost
48
+ @view.show_connection_error('Связь прервалась при удалении. Обновите список, чтобы проверить результат.')
49
+ end
50
+
51
+ # Открывает пустую форму и перечитывает список после её закрытия.
52
+ def open_create_form
53
+ form = @view.build_student_form
54
+ CreateStudentController.new(form, @students).open
55
+ refresh_data
56
+ end
57
+
58
+ # Загружает выбранного студента по ID и открывает заполненную форму.
59
+ def open_update_form(row_numbers)
60
+ ids = selected_student_ids(row_numbers)
61
+ return unless ids.one?
62
+
63
+ student = @students.get_by_id(ids.first)
64
+ if student
65
+ form = @view.build_student_form('Изменить студента')
66
+ UpdateStudentController.new(form, @students, student).open
67
+ end
68
+ refresh_data
69
+ rescue Students_list::ConnectionLost
70
+ @view.show_connection_error('Не удалось загрузить студента. Когда база заработает, нажмите «Обновить».')
71
+ end
72
+
73
+ # @return [Integer] число страниц текущей выборки, для пустой выборки — ноль
74
+ def total_pages
75
+ (@data_list.whole_entities_count + PAGE_SIZE - 1) / PAGE_SIZE
76
+ end
77
+
78
+ # Загружает соседнюю страницу, если номер входит в границы выборки.
79
+ def change_page(step)
80
+ next_page = @page + step
81
+ return unless next_page.between?(1, total_pages)
82
+
83
+ @page = next_page
84
+ refresh_data
85
+ end
86
+
87
+ private
88
+
89
+ def load_page
90
+ @students.get_k_n_student_short_list(@page, PAGE_SIZE, @data_list, incomplete_only: @incomplete_only)
91
+ end
92
+
93
+ def selected_student_ids(row_numbers)
94
+ @data_list.clear_selected
95
+ row_numbers.each { |row| @data_list.select(row) }
96
+ @data_list.get_selected
97
+ end
98
+ end
@@ -1,5 +1,6 @@
1
1
  require_relative 'student_form_controller'
2
2
 
3
+ # Заполняет форму данными студента и сохраняет изменения по прежнему ID.
3
4
  class UpdateStudentController < StudentFormController
4
5
  def initialize(view, students, original_student)
5
6
  super(view, students)
@@ -1 +1 @@
1
- require_relative '../src/student_list_app'
1
+ require_relative '../student_list_app'
@@ -1,57 +1,64 @@
1
- require_relative 'data_table'
2
-
3
- class Data_list
4
- def initialize(list)
5
- @selected = []
6
- @names = get_names.map { |name| name.dup.freeze }.freeze
7
- self.list = list
8
- end
9
-
10
- def list=(list)
11
- @list = list.map { |element| element.dup.freeze }.freeze
12
- clear_selected
13
- nil
14
- end
15
-
16
- def select(number)
17
- unless number.is_a?(Integer) && number >= 0 && number < @list.length
18
- raise IndexError, 'Номер элемента находится за пределами списка'
19
- end
20
-
21
- @selected << number unless @selected.include?(number)
22
- nil
23
- end
24
-
25
- def get_selected
26
- @selected.map { |number| @list[number].id }
27
- end
28
-
29
- def get_names
30
- return @names.dup unless @names.nil?
31
-
32
- ['№ по порядку'] + get_attribute_names
33
- end
34
-
35
- def get_data
36
- rows = @list.each_with_index.map do |element, index|
37
- [index + 1] + get_object_data(element)
38
- end
39
-
40
- Data_table.new(rows)
41
- end
42
-
43
- def clear_selected
44
- @selected.clear
45
- nil
46
- end
47
-
48
- private
49
-
50
- def get_attribute_names
51
- raise NotImplementedError, 'Наследник должен реализовать get_attribute_names'
52
- end
53
-
54
- def get_object_data(element)
55
- raise NotImplementedError, 'Наследник должен реализовать get_object_data'
56
- end
57
- end
1
+ require_relative 'data_table'
2
+
3
+ # Общая модель таблицы с заголовками и выделением строк.
4
+ class Data_list
5
+ def initialize(list)
6
+ @selected = []
7
+ @names = get_names.map { |name| name.dup.freeze }.freeze
8
+ self.list = list
9
+ end
10
+
11
+ # Заменяет содержимое страницы и сбрасывает выделение.
12
+ def list=(list)
13
+ @list = list.map { |element| element.dup.freeze }.freeze
14
+ clear_selected
15
+ nil
16
+ end
17
+
18
+ # Добавляет строку по индексу с нуля, сохраняя предыдущие выделения.
19
+ def select(number)
20
+ unless number.is_a?(Integer) && number >= 0 && number < @list.length
21
+ raise IndexError, 'Номер элемента находится за пределами списка'
22
+ end
23
+
24
+ @selected << number unless @selected.include?(number)
25
+ nil
26
+ end
27
+
28
+ # @return [Array] ID выделенных объектов
29
+ def get_selected
30
+ @selected.map { |number| @list[number].id }
31
+ end
32
+
33
+ # @return [Array<String>] заголовки в порядке отображения столбцов
34
+ def get_names
35
+ return @names.dup unless @names.nil?
36
+
37
+ ['№ по порядку'] + get_attribute_names
38
+ end
39
+
40
+ # @return [Data_table] снимок текущей страницы с порядковыми номерами
41
+ def get_data
42
+ rows = @list.each_with_index.map do |element, index|
43
+ [index + 1] + get_object_data(element)
44
+ end
45
+
46
+ Data_table.new(rows)
47
+ end
48
+
49
+ # Снимает выделение со всех строк.
50
+ def clear_selected
51
+ @selected.clear
52
+ nil
53
+ end
54
+
55
+ private
56
+
57
+ def get_attribute_names
58
+ raise NotImplementedError, 'Наследник должен реализовать get_attribute_names'
59
+ end
60
+
61
+ def get_object_data(element)
62
+ raise NotImplementedError, 'Наследник должен реализовать get_object_data'
63
+ end
64
+ end
@@ -1,5 +1,6 @@
1
1
  require_relative 'data_list'
2
2
 
3
+ # Наблюдаемая страница кратких данных студентов.
3
4
  class Data_list_student_short < Data_list
4
5
  attr_reader :whole_entities_count
5
6
 
@@ -9,10 +10,14 @@ class Data_list_student_short < Data_list
9
10
  @observers = []
10
11
  end
11
12
 
13
+ # Подписывает объект, который отвечает на set_table_params и set_table_data.
14
+ # @param observer [Object] получатель уведомлений
12
15
  def add_observer(observer)
13
16
  @observers << observer unless @observers.include?(observer)
14
17
  end
15
18
 
19
+ # Передаёт подписчикам заголовки, число записей и строки текущей страницы.
20
+ # @return [nil]
16
21
  def notify
17
22
  column_names = get_names
18
23
  table = get_data
@@ -23,6 +28,10 @@ class Data_list_student_short < Data_list
23
28
  nil
24
29
  end
25
30
 
31
+ # Обновляет данные в том же объекте и очищает выделение строк.
32
+ # @param students [Array<StudentShort>] записи текущей страницы
33
+ # @param count [Integer] число записей во всей выборке
34
+ # @return [nil]
26
35
  def replace_page(students, count)
27
36
  self.list = students
28
37
  @whole_entities_count = count
@@ -1,30 +1,34 @@
1
- class Data_table
2
- def initialize(table)
3
- unless table.is_a?(Array) && table.all? { |row| row.is_a?(Array) }
4
- raise ArgumentError, 'Таблица должна быть двумерным массивом'
5
- end
6
-
7
- columns = table.empty? ? 0 : table.first.length
8
-
9
- unless table.all? { |row| row.length == columns }
10
- raise ArgumentError, 'Строки таблицы должны иметь одинаковую длину'
11
- end
12
-
13
- @table = table.map do |row|
14
- row.map { |element| element.dup.freeze }.freeze
15
- end.freeze
16
- end
17
-
18
- def get_element(row, column)
19
- @table.fetch(row).fetch(column)
20
- end
21
-
22
- def get_columns
23
- @table.empty? ? 0 : @table.first.length
24
- end
25
-
26
- def get_rows
27
- @table.length
28
- end
29
-
30
- end
1
+ # Двумерное представление строк и ячеек таблицы.
2
+ class Data_table
3
+ def initialize(table)
4
+ unless table.is_a?(Array) && table.all? { |row| row.is_a?(Array) }
5
+ raise ArgumentError, 'Таблица должна быть двумерным массивом'
6
+ end
7
+
8
+ columns = table.empty? ? 0 : table.first.length
9
+
10
+ unless table.all? { |row| row.length == columns }
11
+ raise ArgumentError, 'Строки таблицы должны иметь одинаковую длину'
12
+ end
13
+
14
+ @table = table.map do |row|
15
+ row.map { |element| element.dup.freeze }.freeze
16
+ end.freeze
17
+ end
18
+
19
+ # Возвращает значение ячейки по индексам строки и столбца.
20
+ def get_element(row, column)
21
+ @table.fetch(row).fetch(column)
22
+ end
23
+
24
+ # @return [Integer] ширина таблицы, для пустой таблицы — ноль
25
+ def get_columns
26
+ @table.empty? ? 0 : @table.first.length
27
+ end
28
+
29
+ # @return [Integer] число строк в таблице
30
+ def get_rows
31
+ @table.length
32
+ end
33
+
34
+ end
data/model/db.rb ADDED
@@ -0,0 +1,19 @@
1
+ require 'pg'
2
+
3
+ # Подключение приложения к PostgreSQL.
4
+ module DB
5
+ # Открывает соединение с настройками из переменных окружения PG*.
6
+ # При вызове с блоком драйвер закрывает соединение после его выполнения.
7
+ # @yieldparam connection [PG::Connection] открытое соединение
8
+ # @return [PG::Connection, Object] соединение или результат блока
9
+ def self.connect(&block)
10
+ PG.connect(
11
+ host: ENV.fetch('PGHOST', '127.0.0.1'),
12
+ port: ENV.fetch('PGPORT', '5432'),
13
+ dbname: ENV.fetch('PGDATABASE', 'students_lab4'),
14
+ user: ENV.fetch('PGUSER', 'postgres'),
15
+ connect_timeout: 5,
16
+ &block
17
+ )
18
+ end
19
+ end