student_mvp 0.1.7 → 0.1.9

data/lib/data_access/DB_client/DB_client.rb

@@ -1,21 +1,40 @@
 require 'mysql2'
 
+# == DB_client
+# Клиент базы данных MySQL
 class DB_client
     private_class_method :new
 
+    # Инициализация объекта класса БД.
+    #
+    # @param [Hash] db_config - конфигурация базы данных.
+    # @raise [Error] Не указана конфигурация базы данных.
     def initialize(db_config)
-        raise 'Database configuration is required' unless db_config
+        raise 'Не указана конфигурация базы данных' unless db_config
         self.client = Mysql2::Client.new(db_config)
     end
 
+    # Получение или создание объекта клиента базы данных.
+    # Конфигурацию БД достаточно задать 1 раз.
+    #
+    # @param [Hash] db_config - конфигурация базы данных.
+    # @raise [Error] Не указана конфигурация базы данных.
+    # @return [Mysql2::Client] - объект клиента базы данных.
     def self.instance(db_config = nil)
         @instance ||= new(db_config)
     end
 
+    # Выполнение SQL запроса.
+    #
+    # @param [String] query - SQL запрос.
+    # @param [Array] params - массив параметров для SQL запроса (необязательно)
+    # @return [Mysql2::Hash] - результат выполнения запроса.
     def query(query, params=[])
         self.client.prepare(query).execute(*params)
     end
 
+    # Закрытие объекта клиента базы данных.
+    #
     def close
         self.client.close
     end

data/lib/logger/logger.rb

@@ -1,11 +1,20 @@
 require 'logger'
 
+# == App_logger
+# Логгер приложения
 class App_logger
   private_class_method :new
 
+  # Инициализация объекта логгера.
+  #
+  # @param [String] file_path - путь к файлу логов.
+  # @raise [Error] Не указан путь к файлу логов.
   def initialize(file_path)
-    ensure_log_directory
+    if file_path.nil? || file_path.empty?
+      raise Error, 'Не указан путь к файлу логов'
+    end
     self.file_path = file_path
+    ensure_log_directory
     self.logger = Logger.new(self.file_path)
     self.logger.formatter = proc do |severity, datetime, progname, msg|
       "[#{datetime}] #{severity}: #{msg}\n"
@@ -13,30 +22,56 @@ class App_logger
     setup_log_level
   end
 
+  # Получение или создание объекта логгера
+  # Путь задать достаточно всего один раз. Если он не задан перед первым использованием логгера, то выбрасывается исключение.
+  # 
+  # @param [String, nil] file_path - путь к файлу логов.
+  # @raise [Error] Не указан путь к файлу логов.
+  # @return [App_logger] - объект логгера.
   def self.instance(file_path = nil)
     @instance ||= new(file_path)
   end
 
+  # Запись сообщения в лог
+  #
+  # @param [Symbol] severity - тип сообщения
+  # @param [String] message - сообщение
   def log(severity, message)
     self.logger.send(severity, message)
   end
 
+
+  # Запись информационного сообщения в лог
+  #
+  # @param [String] message - сообщение
   def info(message)
     log(:info, message)
   end
 
+  # Запись сообщения для дебага в лог
+  #
+  # @param [String] message - сообщение
   def debug(message)
     log(:debug, message)
   end
 
+  # Запись сообщения ошибки в лог
+  #
+  # @param [String] message - сообщение
   def error(message)
     log(:error, message)
   end
 
+  # Запись сообщения предупреждения в лог
+  #
+  # @param [String] message - сообщение
   def warn(message)
     log(:warn, message)
   end
 
+  # Запись сообщения фатальной ошибки в лог
+  #
+  # @param [String] message - сообщение
   def fatal(message)
     log(:fatal, message)
   end

data/lib/student_mvp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StudentMvp
-  VERSION = "0.1.7"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: student_mvp
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - ZaiiiRan
@@ -101,51 +101,72 @@ email:
 - a1b075753@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- doc/Add_student_presenter.html
+- doc/App_logger.html
+- doc/Base_presenter.html
+- doc/DB_client.html
+- doc/Edit_contacts_presenter.html
+- doc/Edit_git_presenter.html
+- doc/Edit_student_presenter.html
+- doc/Replace_student_presenter.html
+- doc/Student_list_presenter.html
+- doc/created.rid
+- doc/css/fonts.css
+- doc/css/rdoc.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/navigation.js
+- doc/js/navigation.js.gz
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/search_index.js.gz
+- doc/js/searcher.js
+- doc/js/searcher.js.gz
+- doc/table_of_contents.html
 files:
 - README.md
 - Rakefile
 - doc/Add_student_presenter.html
 - doc/App_logger.html
 - doc/Base_presenter.html
-- doc/Binary_tree.html
-- doc/Binary_tree_iterator.html
-- doc/Contact_sort_decorator.html
 - doc/DB_client.html
-- doc/Data_list.html
-- doc/Data_list_student_short.html
-- doc/Data_storage_strategy.html
-- doc/Data_table.html
-- doc/Deep_dup.html
 - doc/Edit_contacts_presenter.html
 - doc/Edit_git_presenter.html
 - doc/Edit_student_presenter.html
-- doc/Field_filter_decorator.html
-- doc/Filter.html
-- doc/Filter_decorator.html
-- doc/Full_name_filter_decorator.html
-- doc/Full_name_sort_decorator.html
-- doc/Gemfile.html
-- doc/Git_sort_decorator.html
-- doc/Has_not_field_filter_decorator.html
-- doc/JSON_storage_strategy.html
-- doc/Person.html
-- doc/README_md.html
-- doc/Rakefile.html
 - doc/Replace_student_presenter.html
-- doc/Sort_decorator.html
-- doc/Student.html
-- doc/StudentMvp.html
-- doc/StudentMvp/Error.html
 - doc/Student_list_presenter.html
-- doc/Student_short.html
-- doc/Students_list.html
-- doc/Students_list_DB.html
-- doc/Students_list_file.html
-- doc/Students_list_file_adapter.html
-- doc/Students_list_interface.html
-- doc/YAML_storage_strategy.html
-- doc/bin/setup.html
 - doc/created.rid
 - doc/css/fonts.css
 - doc/css/rdoc.css

data/doc/Binary_tree.html

@@ -1,300 +0,0 @@
-<!DOCTYPE html>
-
-<html>
-<head>
-<meta charset="UTF-8">
-<meta name="viewport" content="width=device-width, initial-scale=1" />
-
-<title>class Binary_tree - RDoc Documentation</title>
-
-  <meta name="keywords" content="ruby,class,Binary_tree">
-
-    <meta name="description" content="Documentation for the Binary_tree class">
-
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-  var index_rel_prefix = "./";
-</script>
-
-<script src="./js/navigation.js" defer></script>
-<script src="./js/search.js" defer></script>
-<script src="./js/search_index.js" defer></script>
-<script src="./js/searcher.js" defer></script>
-<script src="./js/darkfish.js" defer></script>
-
-<link href="./css/fonts.css" rel="stylesheet">
-<link href="./css/rdoc.css" rel="stylesheet">
-
-
-<body id="top" role="document" class="class">
-<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
-  <span aria-hidden="true">&#9776;</span>
-</div>
-
-
-<nav id="navigation" role="navigation">
-  <div id="project-navigation">
-    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
-  <h2>
-    <a href="./index.html" rel="home">Home</a>
-  </h2>
-
-  <div id="table-of-contents-navigation">
-    <a href="./table_of_contents.html#pages">Pages</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </div>
-</div>
-
-    <div id="search-section" role="search" class="project-section initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <div id="search-field-wrapper">
-      <input id="search-field" role="combobox" aria-label="Search"
-             aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </div>
-
-    <ul id="search-results" aria-label="Search Results"
-        aria-busy="false" aria-expanded="false"
-        aria-atomic="false" class="initially-hidden"></ul>
-  </form>
-</div>
-
-  </div>
-
-  
-  
-  <div id="parent-class-section" class="nav-section">
-  <h3>Ancestors</h3>
-  <ul><li>Object</li></ul>
-</div>
-
-  
-<div id="includes-section" class="nav-section">
-  <h3>Included Modules</h3>
-
-  <ul class="link-list">
-    <li><span class="include">Enumerable</span>
-  </ul>
-</div>
-
-  
-  
-  <div class="nav-section">
-    <h3>Class Methods</h3>
-    <ul class="link-list" role="directory">
-      <li ><a href="#method-c-new">new</a></li>
-    </ul>
-  </div>
-
-
-
-  <div class="nav-section">
-    <h3>Instance Methods</h3>
-    <ul class="link-list" role="directory">
-      <li ><a href="#method-i-add">add</a></li>
-      <li ><a href="#method-i-each">each</a></li>
-      <li ><a href="#method-i-find">find</a></li>
-    </ul>
-  </div>
-
-
-
-  <footer id="validator-badges" role="contentinfo">
-  <p><a href="https://validator.w3.org/check/referer">Validate</a>
-  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.8.1.
-  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
-</footer>
-
-</nav>
-
-<main role="main" aria-labelledby="class-Binary_tree">
-  <h1 id="class-Binary_tree" class="anchor-link class">
-    class Binary_tree
-  </h1>
-
-  <section class="description">
-    
-  </section>
-
-  <section id="5Buntitled-5D" class="documentation-section anchor-link">
-
-
-    <section class="constants-list">
-      <header>
-        <h3>Constants</h3>
-      </header>
-      <dl>
-        <dt id="BLACK">BLACK
-        <dd>
-          
-        <dt id="RED">RED
-        <dd>
-          
-      </dl>
-    </section>
-
-    <section class="attribute-method-details" class="method-section">
-      <header>
-        <h3>Attributes</h3>
-      </header>
-
-      <div id="attribute-i-root" class="method-detail anchor-link">
-        <div class="method-heading attribute-method-heading">
-          <a href="#attribute-i-root" title="Link to this attribute">
-            <span class="method-name">root</span>
-            <span class="attribute-access-type">[RW]</span>
-          </a>
-        </div>
-
-        <div class="method-description">
-        
-        </div>
-      </div>
-    </section>
-
-
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section anchor-link">
-       <header>
-         <h3>Public Class Methods</h3>
-       </header>
-
-      <div id="method-c-new" class="method-detail anchor-link ">
-        <div class="method-header">
-            <div class="method-heading">
-              <a href="#method-c-new" title="Link to this method">
-                <span class="method-name">new</span>
-                <span class="method-args">()</span>
-              </a>
-            </div>
-        </div>
-
-          <div class="method-controls">
-            <details class="method-source-toggle">
-              <summary>Source</summary>
-            </details>
-          </div>
-
-        <div class="method-description">
-          <div class="method-source-code" id="new-source">
-            <pre><span class="ruby-comment"># File lib/models/binary_tree/binary_tree.rb, line 23</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
-    <span class="ruby-keyword">self</span>.<span class="ruby-identifier">root</span> = <span class="ruby-keyword">nil</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-
-      </div>
-
-    </section>
-
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section anchor-link">
-       <header>
-         <h3>Public Instance Methods</h3>
-       </header>
-
-      <div id="method-i-add" class="method-detail anchor-link ">
-        <div class="method-header">
-            <div class="method-heading">
-              <a href="#method-i-add" title="Link to this method">
-                <span class="method-name">add</span>
-                <span class="method-args">(value)</span>
-              </a>
-            </div>
-        </div>
-
-          <div class="method-controls">
-            <details class="method-source-toggle">
-              <summary>Source</summary>
-            </details>
-          </div>
-
-        <div class="method-description">
-          <div class="method-source-code" id="add-source">
-            <pre><span class="ruby-comment"># File lib/models/binary_tree/binary_tree.rb, line 27</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add</span>(<span class="ruby-identifier">value</span>)
-    <span class="ruby-identifier">new_node</span> = <span class="ruby-constant">Node</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">value</span>)
-    <span class="ruby-keyword">self</span>.<span class="ruby-identifier">root</span> = <span class="ruby-identifier">insert</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">root</span>, <span class="ruby-identifier">new_node</span>)
-    <span class="ruby-keyword">self</span>.<span class="ruby-identifier">balance</span>(<span class="ruby-identifier">new_node</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-
-      </div>
-
-      <div id="method-i-each" class="method-detail anchor-link ">
-        <div class="method-header">
-            <div class="method-heading">
-              <a href="#method-i-each" title="Link to this method">
-                <span class="method-name">each</span>
-                <span class="method-args">(&amp;block)</span>
-              </a>
-            </div>
-        </div>
-
-          <div class="method-controls">
-            <details class="method-source-toggle">
-              <summary>Source</summary>
-            </details>
-          </div>
-
-        <div class="method-description">
-          <div class="method-source-code" id="each-source">
-            <pre><span class="ruby-comment"># File lib/models/binary_tree/binary_tree.rb, line 33</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-    <span class="ruby-identifier">iterator</span> = <span class="ruby-constant">Binary_tree_iterator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">root</span>)
-    <span class="ruby-identifier">iterator</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-
-      </div>
-
-      <div id="method-i-find" class="method-detail anchor-link ">
-        <div class="method-header">
-            <div class="method-heading">
-              <a href="#method-i-find" title="Link to this method">
-                <span class="method-name">find</span>
-                <span class="method-args">(key)</span>
-              </a>
-            </div>
-        </div>
-
-          <div class="method-controls">
-            <details class="method-source-toggle">
-              <summary>Source</summary>
-            </details>
-          </div>
-
-        <div class="method-description">
-          <div class="method-source-code" id="find-source">
-            <pre><span class="ruby-comment"># File lib/models/binary_tree/binary_tree.rb, line 38</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find</span>(<span class="ruby-identifier">key</span>)
-    <span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
-    <span class="ruby-keyword">self</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
-        <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">key</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">key</span>
-            <span class="ruby-identifier">result</span> = <span class="ruby-identifier">value</span>
-            <span class="ruby-keyword">break</span>
-        <span class="ruby-keyword">end</span>
-    <span class="ruby-keyword">end</span>
-    <span class="ruby-identifier">result</span>
-<span class="ruby-keyword">end</span></pre>
-          </div>
-          
-        </div>
-
-
-      </div>
-
-    </section>
-
-  </section>
-</main>
-