time_receive 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f43dbf049358afa75fdb3be5f39dcbaa6e7c86ada380505cda9a638a67a846a
-  data.tar.gz: f669662a4606c28752a9d809af03e70610b8bc18d2cc8b14e39b847ba74852d7
+  metadata.gz: bf213c717465c562d2092fd20ba4b51c776d4fa2ff44d923a3f0533da7b8117c
+  data.tar.gz: 6581aa3352574e774bc60d97c101af7058f9b50ada18246a3b8a0fcb07180d48
 SHA512:
-  metadata.gz: bccb5a95442f89e18e2dd594dd1fc5320485f0867cd589e31db253a34ab126c4eae1c43b0d6fa2e366bc6643786fb022c995d950f658d72960a2c10092e22bc9
-  data.tar.gz: dd22477c9dc4aa18a931fd9b2c7c9b9e5e7152dd161650d135375f92dae0e046f367dc91309e402061cdc887a375adb977c1e6bc0fcc5916ad0f11c8673a72a4
+  metadata.gz: '0802eb0421d45e6539b32151479e5fbfc3a7fde7a7579d3049b54a17b9c5fef8d152334e34e6920e902b5559308df8ddeb60120647bb20c36ce02ff5af0b5a60'
+  data.tar.gz: 2a734b5273ecd746f562bbe8ab12a029887711df4359b2f85add02bb79854975e3e0485f194c08def698167b5186d76650f0b51d64629374d4c5ea39a089169f

data/README.md

@@ -1,39 +1,96 @@
-# TimeReceive
 
-TODO: Delete this and the text below, and describe your gem
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/time_receive`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-## Installation
+**time_receive**
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+This Ruby gem provides a collection of utility methods for working with time-related tasks, including formatting, parsing, countdown timers, and date calculations.
 
-Install the gem and add to the application's Gemfile by executing:
+**Features:**
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+* Format time objects into various string representations using custom formats.
+* Parse time strings into Time objects using a specified format.
+* Create countdown timers that display the remaining time until a user-defined deadline.
+* Check if a time falls on the current date.
+* Calculate the number of days until a target date.
+* Add specific time periods (hours, minutes, or days) to a Time object.
+* Calculate the elapsed time between two Time objects.
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+**Installation**
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+1. Add the gem to your Gemfile:
 
-## Usage
+   ```ruby
+   gem 'time_receive'
+   ```
 
-TODO: Write usage instructions here
+2. Install the gem:
 
-## Development
+   ```bash
+   bundle install
+   ```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+**Usage**
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+1. Require the `time_receive` module in your Ruby code:
 
-## Contributing
+   ```ruby
+   require 'time_receive'
+   ```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/time_receive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/time_receive/blob/master/CODE_OF_CONDUCT.md).
+2. Use the provided methods:
 
-## License
+   **Formatting Time:**
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+   ```ruby
+   formatted_time = TimeReceive.now("%d/%m/%Y %H:%M")  # Output: 28/04/2024 00:58
+   ```
 
-## Code of Conduct
+   **Parsing Time String:**
 
-Everyone interacting in the TimeReceive project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/time_receive/blob/master/CODE_OF_CONDUCT.md).
+   ```ruby
+   time_object = TimeReceive.parse_time("2024-05-09 10:00:00", "%Y-%m-%d %H:%M:%S")
+   ```
+
+   **Countdown Timer:**
+
+   ```ruby
+   deadline = Time.now + 60 * 60  # One hour from now
+   TimeReceive.timer(deadline) do
+     puts "Time is up!"
+   end
+   ```
+
+   **Other Methods:**
+
+   See the code documentation for details on `today?`, `days_until`, `add_time_period`, and `calculate_elapsed_time`.
+
+**Error Handling**
+
+`TimeReceive` raises `TimeReceiveError` if invalid arguments are provided to methods. Ensure you pass appropriate types (e.g., `Time` objects, `Date` objects, valid time strings, and supported time periods).
+
+**Contributing**
+
+We welcome contributions to this project! Feel free to fork the repository, make changes, and submit a pull request.
+
+**License**
+
+This gem is licensed under the MIT License. See the LICENSE file for details.
+```
+
+**Explanation:**
+
+* **Clear and concise title:** The title "time_receive" is straightforward.
+* **Informative description:** The description explains the gem's purpose and key features.
+* **Detailed installation steps:** The guide covers adding the gem to the Gemfile and running `bundle install`.
+* **Comprehensive usage examples:** The examples demonstrate various functionalities with clear explanations.
+* **Error handling guidance:** Users are informed about potential errors and how to avoid them.
+* **Contribution guidelines (optional):** If you plan to accept contributions, include instructions.
+* **License information:** Specify the license under which the gem is distributed.
+
+**Additional Tips:**
+
+* Consider adding a badge for the Ruby version supported by the gem.
+* Include links to the source code repository (if applicable) and any relevant documentation.
+* Maintain up-to-date documentation as the gem evolves.
+
+I hope this enhanced README file serves you well!

data/demo.rb

@@ -1,6 +1,42 @@
 # frozen_string_literal: true
 
-require_relative 'lib/time_receive'
+require_relative "lib/time_receive"
+
+start_time = Time.now
+puts "Start time: #{start_time}"
+
+new_time = TimeReceive.add_time_period(start_time, :hours)
+puts "Time after adding 1 hour: #{new_time}"
+
+new_time = TimeReceive.add_time_period(start_time, :days)
+puts "Time after adding 1 day: #{new_time}"
+
+# Пример использования метода calculate_elapsed_time
+start_time = Time.now
+puts "Start time: #{start_time}"
+sleep 3 # Допустим, что прошло 3 секунды
+
+end_time = Time.now
+puts "End time: #{end_time}"
+
+elapsed_time = TimeReceive.calculate_elapsed_time(start_time, end_time)
+puts "Elapsed time: #{elapsed_time}"
+
+puts TimeReceive.today? # Check if today
+
+target_date = Date.parse("2024-05-10")
+days_remaining = TimeReceive.days_until(target_date)
+puts "Days until #{target_date}: #{days_remaining}"
+
+user_time = Time.parse("2024-05-01 12:00:00") # Replace with user-provided time
+remaining_seconds = 3720 # 1 hour, 2 minutes, and 0 seconds
+
+formatted_time = TimeReceive.format_remaining_time(remaining_seconds)
+puts formatted_time # Output: "01:02:00"
+
+TimeReceive.timer(user_time) do
+  puts "Время истекло!"
+end
 
 current_time = TimeReceive.now
 puts "Current time (default format): #{current_time}"

data/lib/time_receive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TimeReceive
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

data/lib/time_receive.rb

@@ -1,5 +1,7 @@
-require 'date'
-require 'time'
+# frozen_string_literal: true
+
+require "date"
+require "time"
 
 module TimeReceive
   class TimeReceiveError < StandardError; end
@@ -11,24 +13,91 @@ module TimeReceive
 
     def format(time)
       raise TimeReceiveError, "Invalid time: #{time}" unless time.is_a?(Time)
-      time.strftime(@format_string) # Используйте strftime для форматирования времени
+
+      time.strftime(@format_string)
     end
   end
 
   module ClassMethods
     def now(format_string = nil)
-      formatter = format_string ? TimeFormatter.new(format_string) : TimeFormatter.new("%Y-%m-%d %H:%M:%S")
+      formatter = TimeFormatter.new(format_string || "%Y-%m-%d %H:%M:%S")
       formatter.format(Time.now)
     end
 
     def parse_time(time_string, format_string)
-      begin
-        Time.strptime(time_string, format_string)
-      rescue ArgumentError
-        raise TimeReceiveError, "Invalid time string: #{time_string}"
+      Time.strptime(time_string, format_string)
+    rescue ArgumentError
+      raise TimeReceiveError, "Invalid time string: #{time_string}"
+    end
+
+    def timer(user_time, &block)
+      raise ArgumentError, "Invalid user_time: #{user_time}" unless user_time.is_a?(Time)
+
+      remaining_seconds = (user_time - Time.now).to_i
+
+      loop do
+        remaining_time_str = format_remaining_time(remaining_seconds)
+
+        puts "Time until deadline: #{remaining_time_str}"
+
+        sleep 1 / 1.9
+
+        remaining_seconds -= 1
+
+        break if remaining_seconds <= 0
+      end
+
+      block.call if block_given?
+    end
+
+    def format_remaining_time(remaining_seconds)
+      hours = remaining_seconds / 3600
+      minutes = (remaining_seconds % 3600) / 60
+      seconds = remaining_seconds % 60
+
+      hours_str = hours.to_s.rjust(2, "0")
+      minutes_str = minutes.to_s.rjust(2, "0")
+      seconds_str = seconds.to_s.rjust(2, "0")
+
+      "#{hours_str}:#{minutes_str}:#{seconds_str}"
+    end
+
+    def today?
+      Date.today == Time.now.to_date
+    end
+
+    def days_until(target_date)
+      raise ArgumentError, "Invalid target_date: #{target_date}" unless target_date.is_a?(Date)
+
+      (target_date - Date.today).to_i
+    end
+
+    def add_time_period(time, period)
+      raise ArgumentError, "Invalid time: #{time}" unless time.is_a?(Time)
+
+      case period
+      when :hours
+        time + 3600
+      when :minutes
+        time + 60
+      when :days
+        time + 86_400
+      else
+        raise ArgumentError, "Unsupported period: #{period}"
       end
     end
+
+    def calculate_elapsed_time(start_time, end_time)
+      raise ArgumentError, "Invalid start_time: #{start_time}" unless start_time.is_a?(Time)
+      raise ArgumentError, "Invalid end_time: #{end_time}" unless end_time.is_a?(Time)
+
+      elapsed_seconds = (end_time - start_time).to_i
+      hours = elapsed_seconds / 3600
+      minutes = (elapsed_seconds % 3600) / 60
+
+      "#{hours} hours and #{minutes} minutes"
+    end
   end
 
-  self.extend ClassMethods
+  extend ClassMethods
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_receive
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - MatveySviadysh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies: []
 description: |-
   The time_receive gem provides a way to ... (brief explanation of what the gem does).
@@ -32,10 +32,13 @@ files:
 - lib/time_receive.rb
 - lib/time_receive/version.rb
 - sig/time_receive.rbs
-homepage: https://github.com/bodrovis/lokalise_rails
+- time_receive-0.1.0.gem
+homepage: https://github.com/MatveySviadysh/time_receive
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/MatveySviadysh/time_receive
+  source_code_uri: https://github.com/MatveySviadysh/time_receive
 post_install_message: 
 rdoc_options: []
 require_paths: