auction_fun_core 0.8.7 → 0.8.10

data/lib/auction_fun_core/repos/auction_context/auction_repository.rb

@@ -3,7 +3,30 @@
 module AuctionFunCore
   module Repos
     module AuctionContext
-      # SQL repository for auctions.
+      # Repository for handling repository operations related to auctions.
+      #
+      # This repository provides methods to interact with auction data in the database,
+      # including creating, updating, deleting, and retrieving auctions.
+      #
+      # @example
+      #   auction_repo = AuctionFunCore::Repos::AuctionContext::AuctionRepository.new
+      #
+      #   # Retrieve all auctions
+      #   all_auctions = auction_repo.all
+      #
+      #   # Get the total number of auctions
+      #   total_auctions = auction_repo.count
+      #
+      #   # Find an auction by its ID
+      #   auction = auction_repo.by_id(123)
+      #
+      #   # Find an auction by its ID and raise an error if not found
+      #   auction = auction_repo.by_id!(123)
+      #
+      # @see AuctionFunCore::Entities::Auction Struct representing auction data
+      # @see https://rom-rb.org/learn/sql/3.3/queries/
+      # @see https://api.rom-rb.org/rom-sql/ROM/SQL/Relation/Reading
+      #
       class AuctionRepository < ROM::Repository[:auctions]
         include Import["container"]
 
@@ -11,28 +34,34 @@ module AuctionFunCore
         commands :create, update: :by_pk, delete: :by_pk
 
         # Returns all auctions in the database.
-        # @return [Array<ROM::Struct::Auction>, []]
+        # @return [Array<ROM::Struct::Auction>]
         def all
           auctions.to_a
         end
 
-        # Returns the total number of auctions in database.
-        # @return [Integer]
+        # Returns the total number of auctions in the database.
+        #
+        # @return [Integer] Total number of auctions.
+        #
         def count
           auctions.count
         end
 
-        # Search auction in database by primary key.
-        # @param id [Integer] Auction ID
-        # @return [ROM::Struct::Auction, nil]
+        # Retrieves an auction from the database by its primary key.
+        #
+        # @param id [Integer] The ID of the auction to retrieve.
+        # @return [ROM::Struct::Auction, nil] The retrieved auction, or nil if not found.
+        #
         def by_id(id)
           auctions.by_pk(id).one
         end
 
-        # Search auction in database by primary key.
-        # @param id [Integer] Auction ID
-        # @raise [ROM::TupleCountMismatchError] if not found on database
-        # @return [ROM::Struct::Auction]
+        # Retrieves an auction from the database by its primary key, raising an error if not found.
+        #
+        # @param id [Integer] The ID of the auction to retrieve.
+        # @raise [ROM::TupleCountMismatchError] if the auction is not found.
+        # @return [ROM::Struct::Auction] The retrieved auction.
+        #
         def by_id!(id)
           auctions.by_pk(id).one!
         end

data/lib/auction_fun_core/repos/bid_context/bid_repository.rb

@@ -3,21 +3,43 @@
 module AuctionFunCore
   module Repos
     module BidContext
-      # SQL repository for bids.
+      # Repository for handling repository operations related to bids.
+      #
+      # This repository provides methods to interact with bid data in the database,
+      # including creating, updating, deleting, and retrieving bids.
+      #
+      # @example
+      #   bid_repo = AuctionFunCore::Repos::BidContext::BidRepository.new
+      #
+      #   # Get the total number of bids
+      #   total_bids = bid_repo.count
+      #
+      #   # Checks if a bid exists based on the provided conditions.
+      #   bid_repo.exists?(id: 123)
+      #
+      # @see AuctionFunCore::Entities::Bid Struct representing bid data
+      # @see https://rom-rb.org/learn/sql/3.3/queries/
+      # @see https://api.rom-rb.org/rom-sql/ROM/SQL/Relation/Reading
+      #
       class BidRepository < ROM::Repository[:bids]
         include Import["container"]
 
         struct_namespace Entities
         commands :create, update: :by_pk, delete: :by_pk
 
-        # Returns the total number of bids in database.
-        # @return [Integer]
+        # Returns the total number of bids in the database.
+        #
+        # @return [Integer] Total number of bids.
+        #
         def count
           bids.count
         end
 
-        # @param conditions [Hash] DSL Dataset
-        # @return [Boolean]
+        # Checks if a bid exists based on the provided conditions.
+        #
+        # @param conditions [Hash] The conditions to check (DSL Dataset).
+        # @return [Boolean] true if a bid exists that matches the conditions, otherwise false.
+        #
         def exists?(conditions)
           bids.exist?(conditions)
         end

data/lib/auction_fun_core/repos/staff_context/staff_repository.rb

@@ -3,7 +3,41 @@
 module AuctionFunCore
   module Repos
     module StaffContext
-      # SQL repository for staffs.
+      # Repository for handling repository operations related to staffs.
+      #
+      # This repository provides methods to interact with staff data in the database,
+      # including creating, updating, deleting, and retrieving staffs.
+      #
+      # @example
+      #   staff_repo = AuctionFunCore::Repos::StaffContext::StaffRepository.new
+      #
+      #   # Retrieve all staffs
+      #   all_staffs = staff_repo.all
+      #
+      #   # Get the total number of staffs
+      #   total_staffs = staff_repo.count
+      #
+      #   # Search staffs based on certain conditions
+      #   conditions = {name: 'Staff'}
+      #   search = staff_repo.query(conditions)
+      #
+      #   # Find an staff by its ID
+      #   staff = staff_repo.by_id(123)
+      #
+      #   # Find an staff by its ID and raise an error if not found
+      #   staff = staff_repo.by_id!(123)
+      #
+      #   # Search for a staff by email or phone
+      #   staff_by_login = staff_repo.by_login('example@example.com')
+      #
+      #   # Check if a staff exists based on certain conditions
+      #   conditions = { name: 'John Doe' }
+      #   staff_exists = staff_repo.exists?(conditions)
+      #
+      # @see AuctionFunCore::Entities::Staff Struct representing staff data
+      # @see https://rom-rb.org/learn/sql/3.3/queries/
+      # @see https://api.rom-rb.org/rom-sql/ROM/SQL/Relation/Reading
+      #
       class StaffRepository < ROM::Repository[:staffs]
         include Import["container"]
 
@@ -11,50 +45,58 @@ module AuctionFunCore
         commands :create, update: :by_pk, delete: :by_pk
 
         # Returns all staffs in database.
-        # @return [Array<ROM::Struct::Staff>, []]
+        # @return [Array<ROM::Struct::Staff>]
         def all
           staffs.to_a
         end
 
-        # Returns the total number of staffs in database.
-        # @return [Integer]
+        # Returns the total number of staffs in the database.
+        #
+        # @return [Integer] Total number of staffs.
         def count
           staffs.count
         end
 
-        # Mount SQL conditions in query for search in database.
-        # @param conditions [Hash] DSL Dataset
-        # @return [AuctionFunCore::Relations::Staffs]
+        # Constructs SQL conditions for querying staffs in the database.
+        #
+        # @param conditions [Hash] The conditions to be used in the query (DSL Dataset).
+        # @return [AuctionFunCore::Relations::Staff] The relation containing the staffs that match the given conditions.
         def query(conditions)
           staffs.where(conditions)
         end
 
-        # Search staff in database by primary key.
-        # @param id [Integer] Staff ID
-        # @return [ROM::Struct::Staff, nil]
+        # Retrieves an staff from the database by its primary key.
+        #
+        # @param id [Integer] The ID of the staff to retrieve.
+        # @return [ROM::Struct::Staff, nil] The retrieved staff, or nil if not found.
+        #
         def by_id(id)
           staffs.by_pk(id).one
         end
 
-        # Search staffs in database by primary key.
-        # @param id [Integer] Staff ID
-        # @raise [ROM::TupleCountMismatchError] if not found on database
-        # @return [ROM::Struct::Auction]
+        # Retrieves an staff from the database by its primary key, raising an error if not found.
+        #
+        # @param id [Integer] The ID of the staff to retrieve.
+        # @raise [ROM::TupleCountMismatchError] if the staff is not found.
+        # @return [ROM::Struct::Staff] The retrieved staff.
+        #
         def by_id!(id)
           staffs.by_pk(id).one!
         end
 
-        # Search staff in database by email of phone keys.
-        # @param login [String] Staff email or phone
-        # @return [ROM::Struct::Staff, nil]
+        # Searches for a staff in the database by email or phone keys.
+        #
+        # @param login [String] The email or phone of the staff.
+        # @return [ROM::Struct::Staff, nil] The staff found with the provided email or phone,
+        #   or nil if not found.
         def by_login(login)
           staffs.where(Sequel[email: login] | Sequel[phone: login]).one
         end
 
-        # Checks if it returns any staff given one or more conditions.
-        # @param conditions [Hash] DSL Dataset
-        # @return [true] when some staff is returned from the given condition.
-        # @return [false] when no staff is returned from the given condition.
+        # Checks if a bid exists based on the provided conditions.
+        #
+        # @param conditions [Hash] The conditions to check (DSL Dataset).
+        # @return [Boolean] true if a staff exists that matches the conditions, otherwise false.
         def exists?(conditions)
           staffs.exist?(conditions)
         end

data/lib/auction_fun_core/repos/user_context/user_repository.rb

@@ -3,7 +3,40 @@
 module AuctionFunCore
   module Repos
     module UserContext
-      # SQL repository for users.
+      # Repository for handling repository operations related to users.
+      #
+      # This repository provides methods to interact with user data in the database,
+      # including creating, updating, deleting, and retrieving users.
+      #
+      # @example
+      #   user_repo = AuctionFunCore::Repos::UserContext::UserRepository.new
+      #
+      #   # Retrieve all users
+      #   all_users = user_repo.all
+      #
+      #   # Get the total number of users
+      #   total_users = user_repo.count
+      #
+      #   # Find a user by its ID
+      #   user = user_repo.by_id(123)
+      #
+      #   # Find a user by its ID and raise an error if not found
+      #   user = user_repo.by_id!(123)
+      #
+      #   # Search for a user by email or phone
+      #   user = user_repo.by_login('example@example.com')
+      #   user = user_repo.by_login('1234567890')
+      #
+      #   # Search for a user by email confirmation token
+      #   user = user_repo.by_email_confirmation_token('email_confirmation_token')
+      #
+      #   # Search for a user by phone confirmation token
+      #   user = user_repo.by_phone_confirmation_token('phone_confirmation_token')
+      #
+      # @see AuctionFunCore::Entities::User Struct representing user data
+      # @see https://rom-rb.org/learn/sql/3.3/queries/
+      # @see https://api.rom-rb.org/rom-sql/ROM/SQL/Relation/Reading
+      #
       class UserRepository < ROM::Repository[:users]
         include Import["container"]
 
@@ -11,7 +44,7 @@ module AuctionFunCore
         commands :create, update: :by_pk, delete: :by_pk
 
         # Returns all users in database.
-        # @return [Array<ROM::Struct::User>, []]
+        # @return [Array<ROM::Struct::User>]
         def all
           users.to_a
         end
@@ -22,53 +55,64 @@ module AuctionFunCore
           users.count
         end
 
-        # Mount SQL conditions in query for search in database.
-        # @param conditions [Hash] DSL Dataset
-        # @return [AuctionFunCore::Relations::Users]
+        # Constructs SQL conditions for querying users in the database.
+        #
+        # @param conditions [Hash] The conditions to be used in the query (DSL Dataset).
+        # @return [AuctionFunCore::Relations::Users] The relation containing the users that match the given conditions.
         def query(conditions)
           users.where(conditions)
         end
 
-        # Search user in database by primary key.
-        # @param id [Integer] User ID
-        # @return [ROM::Struct::User, nil]
+        # Retrieves a user from the database by its primary key.
+        #
+        # @param id [Integer] The ID of the user to retrieve.
+        # @return [ROM::Struct::User, nil] The retrieved user, or nil if not found.
+        #
         def by_id(id)
           users.by_pk(id).one
         end
 
-        # Search user in database by primary key.
-        # @param id [Integer] User ID
-        # @raise [ROM::TupleCountMismatchError] if not found on database
-        # @return [ROM::Struct::Auction]
+        # Retrieves a user from the database by its primary key, raising an error if not found.
+        #
+        # @param id [Integer] The ID of the user to retrieve.
+        # @raise [ROM::TupleCountMismatchError] if the user is not found.
+        # @return [ROM::Struct::User] The retrieved user.
+        #
         def by_id!(id)
           users.by_pk(id).one!
         end
 
-        # Search user in database by email of phone keys.
-        # @param login [String] User email or phone
-        # @return [ROM::Struct::User, nil]
+        # Searches for a user in the database by email or phone keys.
+        #
+        # @param login [String] The email or phone of the user.
+        # @return [ROM::Struct::User, nil] The user found with the provided email or phone,
+        #   or nil if not found.
         def by_login(login)
           users.where(Sequel[email: login] | Sequel[phone: login]).one
         end
 
-        # Search user in database by email_confirmation_token key.
-        # @param email_confirmation_token [String] User email confirmation token
-        # @return [ROM::Struct::User, nil]
+        # Searches for a user in the database by email confirmation token.
+        #
+        # @param email_confirmation_token [String] The email confirmation token of the user.
+        # @return [ROM::Struct::User, nil] The user found with the provided email confirmation token,
+        #   or nil if not found.
         def by_email_confirmation_token(email_confirmation_token)
           users.where(Sequel[email_confirmation_token: email_confirmation_token]).one
         end
 
-        # Search user in database by phone_confirmation_token of phone keys.
-        # @param phone [String] User phone confirmation token
-        # @return [ROM::Struct::User, nil]
+        # Searches for a user in the database by phone confirmation token.
+        #
+        # @param phone_confirmation_token [String] The phone confirmation token of the user.
+        # @return [ROM::Struct::User, nil] The user found with the provided phone confirmation token,
+        #   or nil if not found.
         def by_phone_confirmation_token(phone_confirmation_token)
           users.where(Sequel[phone_confirmation_token: phone_confirmation_token]).one
         end
 
-        # Checks if it returns any user given one or more conditions.
-        # @param conditions [Hash] DSL Dataset
-        # @return [true] when some user is returned from the given condition.
-        # @return [false] when no user is returned from the given condition.
+        # Checks if a user exists based on the provided conditions.
+        #
+        # @param conditions [Hash] The conditions to check (DSL Dataset).
+        # @return [Boolean] true if a user exists that matches the conditions, otherwise false.
         def exists?(conditions)
           users.exist?(conditions)
         end

data/lib/auction_fun_core/services/mail/auction_context/post_auction/participant_mailer.rb

@@ -5,12 +5,15 @@ module AuctionFunCore
     module Mail
       module AuctionContext
         module PostAuction
+          # Service class responsible for sending emails to auction participants.
           class ParticipantMailer
             include IdleMailer::Mailer
             include IdleMailer::TemplateManager
 
+            # Initializes a new ParticipantMailer instance.
+            #
             # @param auction [ROM::Struct::Auction] The auction object
-            # @param participant [ROM::Struct::User] The user object
+            # @param participant [ROM::Struct::User] The participant object
             # @param statistics [OpenStruct] Statistics object
             def initialize(auction, participant, statistics)
               @auction = auction
@@ -20,6 +23,9 @@ module AuctionFunCore
               mail.subject = I18n.t("mail.auction_context.post_auction.participant_mailer.subject", title: @auction.title)
             end
 
+            # Returns the template name for the ParticipantMailer.
+            #
+            # @return [String] The template name.
             def self.template_name
               IdleMailer.config.templates.join("auction_context/post_auction/participant")
             end

data/lib/auction_fun_core/services/mail/auction_context/post_auction/winner_mailer.rb

@@ -5,12 +5,15 @@ module AuctionFunCore
     module Mail
       module AuctionContext
         module PostAuction
+          # Service class responsible for sending emails to auction winners.
           class WinnerMailer
             include IdleMailer::Mailer
             include IdleMailer::TemplateManager
 
+            # Initializes a new WinnerMailer instance.
+            #
             # @param auction [ROM::Struct::Auction] The auction object
-            # @param winner [ROM::Struct::User] The user object
+            # @param winner [ROM::Struct::User] The winner object
             # @param statistics [OpenStruct] Statistics object
             def initialize(auction, winner, statistics)
               @auction = auction
@@ -20,6 +23,9 @@ module AuctionFunCore
               mail.subject = I18n.t("mail.auction_context.post_auction.winner_mailer.subject", title: @auction.title)
             end
 
+            # Returns the template name for the WinnerMailer.
+            #
+            # @return [String] The template name.
             def self.template_name
               IdleMailer.config.templates.join("auction_context/post_auction/winner")
             end

data/lib/auction_fun_core/services/mail/auction_context/pre_auction/auction_start_reminder_mailer.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module AuctionFunCore
+  module Services
+    module Mail
+      module AuctionContext
+        module PreAuction
+          # # Service class responsible for sending auction start reminder emails to participants.
+          class AuctionStartReminderMailer
+            include IdleMailer::Mailer
+            include IdleMailer::TemplateManager
+
+            # Initializes a new AuctionStartReminderMailer instance.
+            #
+            # @param auction [ROM::Struct::Auction] The auction object
+            # @param participant [ROM::Struct::User] The participant object
+            def initialize(auction, participant)
+              @auction = auction
+              @participant = participant
+              mail.to = participant.email
+              mail.subject = I18n.t("mail.auction_context.pre_auction.auction_start_reminder_mailer.subject", title: @auction.title)
+            end
+
+            # Returns the template name for the AuctionStartReminderMailer.
+            #
+            # @return [String] The template name.
+            def self.template_name
+              IdleMailer.config.templates.join("auction_context/pre_auction/auction_start_reminder")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/auction_fun_core/services/mail/templates/auction_context/post_auction/participant.html.erb

@@ -29,7 +29,7 @@
                               <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                 <div style="font-family:Helvetica, Arial, sans-serif;font-size:18px;font-weight:400;line-height:24px;text-align:left;color:#434245;">
                                   <h1 style="margin: 0; font-size: 24px; line-height: normal; font-weight: bold;">
-                                    <%= I18n.t("mail.general.hello", name: @participant.name) %>,
+                                    <%= I18n.t("application.general.hello", name: @participant.name) %>,
                                   </h1>
                                 </div>
                               </td>

data/lib/auction_fun_core/services/mail/templates/auction_context/post_auction/winner.html.erb

@@ -29,7 +29,7 @@
                               <td align="left" style="font-size:0px;padding:10px 25px;word-break:break-word;">
                                 <div style="font-family:Helvetica, Arial, sans-serif;font-size:18px;font-weight:400;line-height:24px;text-align:left;color:#434245;">
                                   <h1 style="margin: 0; font-size: 24px; line-height: normal; font-weight: bold;">
-                                    <%= I18n.t("mail.general.hello", name: @winner.name) %>,
+                                    <%= I18n.t("application.general.hello", name: @winner.name) %>,
                                   </h1>
                                 </div>
                               </td>