starproxima_library 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e0482becdd96f5686269b12e189d7caefc695855e65369c1f773884f54e20af
+  data.tar.gz: '043708e140cfbd4bc64e136cad5edf3d5081bc801375929275e34fadc0c3106c'
+SHA512:
+  metadata.gz: 596c7d541ee529adc49b5195e7830e5862686bfc9e82471c8e91d4b28154625013f8e02544d95d2566e08b531f5b32d38041844ff3a9ac2560631f64cbb41dfd
+  data.tar.gz: fe863937eed29f397a70f63a52f0c9f72402806f245c82ab9acca91c51679fdadb7f044cad7f96af312590951218082160a879af3b74daebd5ef2a8ea13a1981

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "mysql2"
+gem "glimmer-dsl-libui", "~> 0.7.4"
+gem 'win32api'
+gem "minitest"
+gem 'rubocop', group: 'development'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    array_include_methods (1.4.0)
+    ast (2.4.2)
+    chunky_png (1.4.0)
+    color (1.8)
+    equalizer (0.0.11)
+    facets (3.1.0)
+    glimmer (2.7.3)
+      array_include_methods (~> 1.4.0)
+      facets (>= 3.1.0, < 4.0.0)
+    glimmer-dsl-libui (0.7.4)
+      chunky_png (~> 1.4.0)
+      color (~> 1.8)
+      equalizer (= 0.0.11)
+      glimmer (~> 2.7.3)
+      libui (~> 0.1.2.pre)
+      os (>= 1.0.0, < 2.0.0)
+      perfect-shape (~> 1.0.7)
+      rouge (>= 3.26.0, < 4.0.0)
+      super_module (~> 1.4.1)
+    json (2.6.3)
+    libui (0.1.2.pre-x64-mingw)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    mysql2 (0.5.5)
+    os (1.1.4)
+    parallel (1.22.1)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    perfect-shape (1.0.7)
+      equalizer (>= 0.0.11, < 1.1.0)
+      matrix (>= 0.4.2, < 1.1.0)
+    rainbow (3.1.1)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    rubocop (1.50.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    super_module (1.4.1)
+      method_source (>= 0.8.2, < 1.1.0)
+    unicode-display_width (2.4.2)
+    win32api (0.1.0)
+
+PLATFORMS
+  x64-mingw-ucrt
+
+DEPENDENCIES
+  glimmer-dsl-libui (~> 0.7.4)
+  minitest
+  mysql2
+  rubocop
+  win32api
+
+BUNDLED WITH
+   2.4.10

data/diagrams/add_uthor_seq.puml

@@ -0,0 +1,42 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+
+
+actor       Пользователь                        as user
+boundary    "ts: AuthorListView"                   as ts
+control     "tsс: AuthorListController"        as tsc
+boundary    "sif: AuthorInputForm"             as sif
+control     "sifcc: AuthorInputFormControllerCreate"  as sifcc
+entity      "srep: AuthorDBDataSource"           as srep
+
+user -> ts : Клик на <<Добавить>>
+ts -> tsc : show_modal_add
+tsc -> sifcc : <<new>>
+sifcc --> tsc
+tsc -> sif : <<new>>
+sif --> tsc
+tsc -> sifcc : set_view
+sifcc --> tsc
+tsc -> sif : create
+sif -> sifcc : on_view_created
+sifcc -> srep : <<new>>
+srep --> sifcc
+sifcc --> sif
+sif --> tsc
+tsc -> sif : show
+sif --> tsc
+tsc --> ts
+ts --> user
+
+user -> sif : Клик на <<Сохранить>>
+sif -> sifcc : process_fields
+sifcc -> srep : add_student
+srep --> sifcc
+sifcc -> sif : close
+sif --> sifcc
+sifcc --> sif
+sif --> user
+
+
+@enduml

data/diagrams/author.puml

@@ -0,0 +1,118 @@
+@startuml
+
+AuthorListView *-- AuthorListController
+AuthorListView --* AuthorListController
+
+AuthorListView -> AuthorInputForm
+AuthorListController o-- ListStateNotifier
+AuthorListController o-- AuthorDBDataSource
+
+AuthorInputFormControllerCreate o-- AuthorDBDataSource
+AuthorInputFormControllerEdit o-- AuthorDBDataSource
+
+AuthorInputForm *-- AuthorInputFormControllerCreate
+AuthorInputForm *-- AuthorInputFormControllerEdit
+AuthorInputForm --* AuthorInputFormControllerCreate
+AuthorInputForm --* AuthorInputFormControllerEdit
+AuthorDBDataSource o-- DBClient
+
+class AuthorDBDataSource {
+  + initialize()
+  + add(author: Author): Author
+  + change(author: Author): Author
+  + delete(id: Integer): void
+  + get(id: Integer): Author
+  + get_list(page_size: Integer, page_num: Integer, sort_field: String, sort_direction: String, has_father_name: Boolean): List<Author>
+  + count(): Integer
+}
+
+class DBClient {
+  + self.instance(): DBClient
+  + query(sql: String): Object
+  + last_id(): Integer
+}
+
+class AuthorListController {
+  - view: Object
+  - state_notifier: ListStateNotifier
+  - author_rep: AuthorDBDataSource
+  - sort_columns: Array<String>
+  - sort_by: String
+  - father_name_filter_columns: Array<Boolean>
+  - father_name_filter: Boolean
+  + on_view_created()
+  + show_view()
+  + show_modal_add()
+  + show_modal_edit(current_page: int, per_page: int, selected_row: int)
+  + delete_selected(current_page: int, per_page: int, selected_row: int)
+  + refresh_data(page: int, per_page: int)
+  + sort(page: int, per_page: int, sort_index: int)
+  + filter_father_name(page: int, per_page: int, filter_index: int)
+  - on_db_conn_error()
+}
+class ListStateNotifier {
+  - items: Array
+  - listeners: Array
+  + initialize()
+  + set_all(objects: Array)
+  + add(object: Object)
+  + get(number: Integer): Object
+  + delete(object: Object)
+  + replace(object: Object, new_object: Object)
+  + add_listener(listener: Object)
+  + delete_listener(listener: Object)
+  - notify_listeners()
+}
+class AuthorDBDataSource {
+  + get_list(limit: int, offset: int, sort_by: String, sort_order: String, father_name_filter: Boolean): Array<Author>
+  + add(item: Author): Author
+  + delete(id: int): void
+  + count(): int
+}
+class AuthorInputFormControllerCreate {
+  - parent_controller: AuthorListController
+  - author_rep: AuthorDBDataSource
+  - view: Object
+  + on_view_created()
+  + set_view(view: Object)
+  + process_fields(fields: Hash<String, String>): void
+  - on_db_conn_error()
+}
+class AuthorInputFormControllerEdit {
+  - parent_controller: AuthorListController
+  - item: Author
+  - author_rep: AuthorDBDataSource
+  - view: Object
+  + on_view_created()
+  + set_view(view: Object)
+  + populate_fields(item: Author): void
+  - on_db_conn_error()
+}
+class AuthorListView {
+  - PAGE_SIZE: integer = 20
+  - controller: AuthorListController
+  - current_page: integer = 1
+  - total_count: integer = 0
+  - items: Struct[]
+  - table: refined_table
+  - page_label: label
+  + initialize()
+  + on_create()
+  + update(authors: Author[])
+  + update_student_count(new_cnt: integer)
+  + create()
+}
+
+class AuthorInputForm {
+  - item: Hash
+  - controller: AuthorInputFormControllerCreate
+  - entries: Hash
+  + initialize(controller: AuthorInputFormControllerCreate, existing_student: Author)
+  + on_create()
+  + create()
+}
+
+
+
+
+@enduml

data/diagrams/core.puml

@@ -0,0 +1,103 @@
+@startuml
+@startuml
+class AuthorDBDataSource {
+- client: DBClient
++ initialize()
++ add(author: Author): Author
++ change(author: Author): Author
++ delete(id: int): void
++ get(id: int): Author
++ get_list(page_size: int, page_num: int, sort_field: string, sort_direction: string, has_father_name: bool = nil): Author[]
++ count(): int
+}
+
+class PublisherDBDataSource {
+- client: DBClient
++ initialize()
++ add(publisher: Publisher): Publisher
++ change(publisher: Publisher): Publisher
++ delete(id: int): void
++ get(id: int): Publisher
++ get_list(page_size: int, page_num: int, sort_field: string, sort_direction: string, has_email: bool = nil): Publisher[]
++ count(): int
+}
+
+class BookDBDataSource {
+- client: DBClient
++ initialize()
++ add(book: Book): Book
++ change(book: Book): Book
++ delete(id: int): void
++ get(id: int): Book
++ get_list(page_size: int, page_num: int, sort_field: string, sort_direction: string, author_id: int = nil, publisher_id: int = nil, min_year: int = nil, max_year: int = nil): Book[]
++ count(author_id: int = nil, publisher_id: int = nil, min_year: int = nil, max_year: int = nil): int
+}
+
+class DBClient {
+- connection: Mysql2::Client
+- last_id: int
+- initialize()
++ query(query: string): Mysql2::Result
++ last_id(): int
+}
+
+class Author {
+  - author_id
+  - first_name
+  - last_name
+  - father_name
+
+  + initialize(author_id, first_name, last_name, father_name = nil)
+  - validate_null(name, value)
+  - validate_name_length(first_name, last_name, father_name)
+}
+
+class Book {
+  - book_id
+  - title
+  - author_id
+  - publisher_id
+
+  + initialize(book_id, title, author_id, publisher_id)
+  - validate_null(name, value)
+  - validate_title_length(title)
+}
+
+class Publisher {
+  EMAIL_REGEX
+  - publisher_id
+  - name
+  - email
+
+  + initialize(publisher_id, name, email = nil)
+  - validate_null(name, value)
+  - validate_name_length(name)
+  - validate_email(email)
+}
+class ListStateNotifier {
+  - items: Array
+  - listeners: Array
+  + initialize()
+  + set_all(objects: Array)
+  + add(object: Object)
+  + get(number: Integer): Object
+  + delete(object: Object)
+  + replace(object: Object, new_object: Object)
+  + add_listener(listener: Object)
+  + delete_listener(listener: Object)
+  - notify_listeners()
+}
+
+Author  --o Book
+Book o-- Publisher
+AuthorDBDataSource o-- DBClient
+PublisherDBDataSource o-- DBClient
+BookDBDataSource o-- DBClient
+AuthorDBDataSource ..> Author
+PublisherDBDataSource ..> Publisher
+BookDBDataSource ..> Book
+
+
+
+
+@enduml

data/diagrams/delete_author.puml

@@ -0,0 +1,25 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+
+actor       Пользователь                        as user
+boundary    "ts: AuthorListView"                   as ts
+control     "tsс: AuthorListController"        as tsc
+entity      "srep: AuthorDBDataSource"           as srep
+
+user -> ts : Клик на <<Удалить>>
+ts -> tsc : delete_selected
+tsc -> srep : remove_student
+srep --> tsc
+tsc --> ts
+ts -> tsc : refresh_data
+tsc -> srep : paginated_short_students
+srep --> tsc
+tsc -> ts : update_student_count
+ts --> tsc
+tsc --> ts
+ts --> user
+
+@enduml
+
+

data/diagrams/edit_author.puml

@@ -0,0 +1,48 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+actor       Пользователь                        as user
+boundary    "ts: AuthorListView"                   as ts
+control     "tsс: AuthorListController"        as tsc
+boundary    "sif: AuthorInputForm"             as sif
+control     "sifce: AuthorInputFormControllerEdit"  as sifce
+entity      "srep: AuthorDBDataSource"           as srep
+
+user -> ts : Клик на <<Изменить>>
+ts -> tsc : show_modal_edit
+tsc -> sifce : <<new>>
+sifce --> tsc
+tsc -> sif : <<new>>
+sif --> tsc
+tsc -> sifce : set_view
+sifce --> tsc
+tsc -> sif : create
+sif -> sifce : on_view_created
+sifce -> srep : <<new>>
+srep --> sifce
+sifce -> srep : student_by_id
+srep --> sifce
+sifce -> sif : make_readonly
+sif --> sifce
+sifce -> sif : set_value
+sif --> sifce
+sifce --> sif
+sif --> tsc
+tsc -> sif : show
+sif --> tsc
+tsc --> ts
+ts --> user
+
+user -> sif : Клик на <<Сохранить>>
+sif -> sifce : process_fields
+sifce -> srep : replace_student
+srep --> sifce
+sifce -> sif : close
+sif --> sifce
+sifce --> sif
+sif --> user
+
+
+
+@enduml
+

data/diagrams/er.puml

@@ -0,0 +1,30 @@
+@startuml
+
+entity Author {
+  +AuthorID [PK]
+  --
+  FirstName
+  LastName
+  FatherName
+}
+
+entity Publisher {
+  +PublisherID [PK]
+  --
+  Name
+  Email
+}
+
+entity Book {
+  +BookID [PK]
+  --
+  Title
+  --
+  +AuthorID [FK]
+  +PublisherID [FK]
+}
+
+Author --{ Book
+Publisher --{ Book
+
+@enduml

data/diagrams/publisher.puml

@@ -0,0 +1,118 @@
+@startuml
+
+PublisherListView *-- PublisherListController
+PublisherListView --* PublisherListController
+
+PublisherListView -> PublisherInputForm
+PublisherListController o-- ListStateNotifier
+PublisherListController o-- PublisherDBDataSource
+
+PublisherInputFormControllerCreate o-- PublisherDBDataSource
+PublisherInputFormControllerEdit o-- PublisherDBDataSource
+
+PublisherInputForm *-- PublisherInputFormControllerCreate
+PublisherInputForm *-- PublisherInputFormControllerEdit
+PublisherInputForm --* PublisherInputFormControllerCreate
+PublisherInputForm --* PublisherInputFormControllerEdit
+PublisherDBDataSource o-- DBClient
+
+class PublisherDBDataSource {
+  + initialize()
+  + add(publisher: Publisher): Publisher
+  + change(publisher: Publisher): Publisher
+  + delete(id: Integer): void
+  + get(id: Integer): Publisher
+  + get_list(page_size: Integer, page_num: Integer, sort_field: String, sort_direction: String, has_father_name: Boolean): List<Publisher>
+  + count(): Integer
+}
+
+class DBClient {
+  + self.instance(): DBClient
+  + query(sql: String): Object
+  + last_id(): Integer
+}
+
+class PublisherListController {
+  - view: Object
+  - state_notifier: ListStateNotifier
+  - publisher_rep: PublisherDBDataSource
+  - sort_columns: Array<String>
+  - sort_by: String
+  - father_name_filter_columns: Array<Boolean>
+  - father_name_filter: Boolean
+  + on_view_created()
+  + show_view()
+  + show_modal_add()
+  + show_modal_edit(current_page: int, per_page: int, selected_row: int)
+  + delete_selected(current_page: int, per_page: int, selected_row: int)
+  + refresh_data(page: int, per_page: int)
+  + sort(page: int, per_page: int, sort_index: int)
+  + filter_father_name(page: int, per_page: int, filter_index: int)
+  - on_db_conn_error()
+}
+class ListStateNotifier {
+  - items: Array
+  - listeners: Array
+  + initialize()
+  + set_all(objects: Array)
+  + add(object: Object)
+  + get(number: Integer): Object
+  + delete(object: Object)
+  + replace(object: Object, new_object: Object)
+  + add_listener(listener: Object)
+  + delete_listener(listener: Object)
+  - notify_listeners()
+}
+class PublisherDBDataSource {
+  + get_list(limit: int, offset: int, sort_by: String, sort_order: String, father_name_filter: Boolean): Array<Publisher>
+  + add(item: Publisher): Publisher
+  + delete(id: int): void
+  + count(): int
+}
+class PublisherInputFormControllerCreate {
+  - parent_controller: PublisherListController
+  - publisher_rep: PublisherDBDataSource
+  - view: Object
+  + on_view_created()
+  + set_view(view: Object)
+  + process_fields(fields: Hash<String, String>): void
+  - on_db_conn_error()
+}
+class PublisherInputFormControllerEdit {
+  - parent_controller: PublisherListController
+  - item: Publisher
+  - publisher_rep: PublisherDBDataSource
+  - view: Object
+  + on_view_created()
+  + set_view(view: Object)
+  + populate_fields(item: Publisher): void
+  - on_db_conn_error()
+}
+class PublisherListView {
+  - PAGE_SIZE: integer = 20
+  - controller: PublisherListController
+  - current_page: integer = 1
+  - total_count: integer = 0
+  - items: Struct[]
+  - table: refined_table
+  - page_label: label
+  + initialize()
+  + on_create()
+  + update(publishers: Publisher[])
+  + update_student_count(new_cnt: integer)
+  + create()
+}
+
+class PublisherInputForm {
+  - item: Hash
+  - controller: PublisherInputFormControllerCreate
+  - entries: Hash
+  + initialize(controller: PublisherInputFormControllerCreate, existing_student: Publisher)
+  + on_create()
+  + create()
+}
+
+
+
+
+@enduml

data/diagrams/start.puml

@@ -0,0 +1,74 @@
+@startuml
+participant "main.rb"                       as main
+
+
+
+
+boundary    "mw: MainWindow"                as mw
+boundary    "ts: AuthorListView"               as ts
+control     "tsc: AuthorListController"    as tsc
+entity      "dlss: ListStateNotifier"    as dlss
+entity      "srep: AuthorDBDataSource"       as srep
+entity      "dbsa: DBSourceAdapter"         as dbsa
+entity      "DBClient"            as dbds
+
+database    DB                              as db
+
+main -> mw : <<new>>
+mw -> ts : <<new>>
+ts -> tsc : <<new>>(self)
+tsc -> dlss : <<new>>(Array)
+dlss --> tsc
+tsc -> dlss : add_listener(AuthorListView)
+dlss --> tsc
+tsc --> ts
+ts --> mw
+mw --> main
+
+main -> mw : create()
+mw -> ts : create()
+ts -> tsc : on_view_created()
+tsc -> dbsa : <<new>>
+dbsa -> dbds : <<instance>>
+dbds -> dbds : <<new>>
+dbds -> db : [connect]
+db --> dbds
+dbds --> dbsa
+dbsa --> tsc
+tsc -> srep : <<new>>(DBSourceAdapter)
+srep --> tsc
+tsc --> ts
+
+ts -> tsc : refresh_data(Integer, Integer)
+tsc -> srep : get_list(Integer, Integer, ListStateNotifier)
+srep -> dbsa : get_list(Integer, Integer, ListStateNotifier)
+dbsa -> dbds : prepare_exec(String, Integer, Integer)
+dbds -> db : [SELECT]
+db --> dbds
+dbds --> dbsa
+dbsa -> dlss : <<new>>(Array)
+dlss --> dbsa
+dbsa -> dlss : replace_objects(Array)
+dlss -> ts : update(ListStateNotifier)
+ts --> dlss
+dlss --> dbsa
+dbsa --> srep
+srep --> tsc
+
+tsc -> srep : student_count()
+srep -> dbsa : student_count()
+dbsa -> dbds: query(String)
+dbds -> db : [SELECT]
+db --> dbds
+dbds --> dbsa
+dbsa --> srep
+srep --> tsc
+tsc -> ts : update_student_count(Integer)
+ts --> tsc
+tsc --> ts
+ts --> mw
+mw --> main
+
+
+
+@enduml