due_summary 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0a098d668f78251fb98c10c4a23bbf4db8629dbd8461be87b3e7b2515b8e472
+  data.tar.gz: cef5fbe6a73f34acc4e4d8b822c7485fa66364677c33cf56934832ac0831be01
+SHA512:
+  metadata.gz: a205742f2600d648d8169de7e87cf4ad04fd12e57965c50af6befcb7e1be7a1c5c5ea1eef3bdbe7f286f4d7880a0fa81f12af10797b823449887541a251f33e6
+  data.tar.gz: 504a4389011b256567b33883d2e172c71e379d4ad388f0e552b82b3becb20f98d77b7789c53b8af5aab3807e89845f6861cb6105b7d0b2ec457281591c1dd706

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1 @@
+************ Due Summary Intro ************ 

data/Rakefile

@@ -0,0 +1,19 @@
+# Bring in a special type of rake task to run tests 
+require 'rake/testtask'
+# Bring in a special type of rake task to generate rdocs 
+require 'rdoc/task'
+
+# When we run rake, run our test
+task default: 'test'
+
+# Definition of our test task
+Rake::TestTask.new do |task|
+  task.pattern = 'test/test*.rb'
+ end
+
+# Definition of our rdoc generate task
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/*")
+  rdoc.rdoc_dir = 'doc'
+end

data/bin/due_summary

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'due_summary'
+due = Due::DueSummary.new(ARGV[0])
+due.summary_table

data/due_summary.gemspec

@@ -0,0 +1,30 @@
+# Gem specification file for duesummary gem
+require_relative 'lib/due_summary/version'
+
+Gem::Specification.new do |s|
+  # Required attributes:
+  s.name = 'due_summary'
+  s.version = Due::VERSION
+  s.summary = 'Due summary for a given date!'
+  s.authors = ['Rag Dhiman']
+  s.files = ['LICENSE', 'README.rdoc', 'Rakefile', 'due_summary.gemspec', 'lib/due_summary.rb', 'lib/due_summary/duetext.rb', 'test/testduesummary.rb']
+  # Additional attributes that are recommended:
+  s.description = 'Due summary for a given date including months, days and years till the date!'
+  s.email = 'rubycoder@example.com'
+  s.homepage = 'https://rubygems.org/gems/example'
+  s.licenses = ['MIT']
+  s.metadata = { 
+    'source_code_uri' => 'https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-',
+    "bug_tracker_uri"   => "https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/issues",
+    "changelog_uri"     => "https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/branches/all",
+    "documentation_uri" => "https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/tree/master",
+    "homepage_uri"      => "https://www.pluralsight.com/authors/rag-dhiman",
+    "mailing_list_uri"  => "https://www.pluralsight.com/authors/rag-dhiman",
+    "wiki_uri"          => "https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/wiki"
+  }
+  # Dependency information:
+  s.add_runtime_dependency 'colorize', '~> 0.8.1'
+  s.add_development_dependency 'minitest', '~> 5.14.1'
+  s.add_runtime_dependency 'tabulate', '~> 0.1.2'
+  s.executables << 'due_summary'
+end

data/lib/due_summary.rb

@@ -0,0 +1,110 @@
+require 'time'
+require 'tabulate'
+require_relative 'due_summary/duetext'
+
+# The due module contains all classes and data to provide due-summary functionality.
+module Due
+  # The due class takes a given date and provides several period measures until or since that date.
+  class DueSummary
+
+    # Date time field set via the constructor, and the date-time value the due summary stats are based around.
+    attr_accessor :date_time
+    # Date time field used to store the current date-time used as part of the due summary calculations.
+    attr_accessor :now_date_time
+    # The numeric field used to store the time difference between the provided date and the current date and time.
+    attr_accessor :difference
+
+    # Class constructor that takes in a DateTime argument to base the due-summary stats on.
+    def initialize(the_date_time)
+      @date_time = Time.parse(the_date_time)
+      @difference = 0.0
+    end
+
+    # Uses the puts command to output all the due-summary stats as a line separated text.
+    def print_summary
+      update_now_date_time
+      calc_difference
+      puts "#{DueText.minutes} #{till_or_since}: \t #{calc_mins_till.round(2)} #{DueText.minutes_suffix} \n
+      #{DueText.hours} #{till_or_since}: \t #{calc_hours_till.round(2)} #{DueText.hours_suffix} \n
+      #{DueText.days} #{till_or_since}: \t #{calc_days_till.round(2)} #{DueText.days_suffix} \n
+      #{DueText.weeks} #{till_or_since}: \t #{calc_weeks_till.round(2)} #{DueText.weeks_suffix} \n
+      #{DueText.months} #{till_or_since}: \t #{calc_months_till.round(2)} #{DueText.months_suffix} \n
+      #{DueText.years} #{till_or_since}: \t #{calc_years_till.round(2)} #{DueText.years_suffix}"
+    end
+
+    # This method returns an array containing the due-summary stats.
+    def summary_array
+      row = []
+      column = [DueText.minutes, till_or_since, calc_mins_till.round(2), DueText.minutes_suffix]
+      row << column
+      column = [DueText.hours, till_or_since, calc_hours_till.round(2), DueText.hours_suffix]
+      row << column
+      column = [DueText.days, till_or_since, calc_days_till.round(2), DueText.days_suffix]
+      row << column
+      column = [DueText.weeks, till_or_since, calc_weeks_till.round(2), DueText.weeks_suffix]
+      row << column
+      column = [DueText.months, till_or_since, calc_months_till.round(2), DueText.months_suffix]
+      row << column
+      column = [DueText.years, till_or_since, calc_years_till.round(2), DueText.years_suffix]
+      row << column
+    end
+
+    # This method uses the puts command to output all the due-summary stats as a formatted table.
+    def summary_table
+      update_now_date_time
+      calc_difference
+      labels = [DueText.period, ' ', DueText.duration, DueText.measure]
+      rows = summary_array
+      puts tabulate(labels, rows, { 'indent' => 4, 'style' => 'fancy' })
+    end
+
+    # This method updates the current date and time regarded as the now current date and time for the due-summary stats.
+    def update_now_date_time
+      @now_date_time = Time.new
+    end
+
+    # This method calculates the due summary time difference between the provided date and the now date.
+    def calc_difference
+      @difference = @date_time.to_f - @now_date_time.to_f
+    end
+
+    # This method returns 'since' or 'till' as a description to describe the time difference.
+    def till_or_since
+      if @difference.negative?
+        DueText.since
+      else
+        DueText.till
+      end
+    end
+
+    # This method calculates the due-summary time difference in minutes.
+    def calc_mins_till
+      (@difference.round(2) / 60.00).round(2)
+    end
+
+    # This method calculates the due-summary time difference in hours.
+    def calc_hours_till
+      (calc_mins_till / 60.00).round(2)
+    end
+
+    # This method calculates the due-summary time difference in days.
+    def calc_days_till
+      (calc_hours_till / 24.00).round(2)
+    end
+
+    # This method calculates the due-summary time difference in months.
+    def calc_months_till
+      (calc_days_till / 31.0).round(2)
+    end
+
+    # This method calculates the due-summary time difference in years.
+    def calc_years_till
+      (calc_months_till / 12.00).round(2)
+    end
+
+    # This method calculates the due-summary time difference in weeks.
+    def calc_weeks_till
+      (calc_days_till / 7.0).round(2)
+    end
+  end
+end

data/lib/due_summary/duetext.rb

@@ -0,0 +1,74 @@
+# The due module contains all classes and data to provide due-summary functionality.
+module Due
+  # The dueText class provides all the text for the due-summary functionality.
+  class DueText
+    # Method provides text for minutes measure name.
+    def self.minutes
+      'Minutes'
+    end
+    # Method provides text for hours measure name.
+    def self.hours
+      'Hours'
+    end 
+    # Method provides text for days measure name.
+    def self.days
+      'Days'
+    end 
+    # Method provides text for weeks measure name.
+    def self.weeks
+      'Weeks'
+    end 
+    # Method provides text for months measure name.
+    def self.months
+      'Months'
+    end 
+    # Method provides text for years measure name.
+    def self.years
+      'Years'
+    end 
+    # Method provides text for minutes suffix for a messure.
+    def self.minutes_suffix
+      'min(s)'
+    end
+    # Method provides text for hours suffix for a messure.
+    def self.hours_suffix
+      'hours(s)'
+    end 
+    # Method provides text for days suffix for a messure.
+    def self.days_suffix
+      'day(s)'
+    end 
+    # Method provides text for weeks suffix for a messure.
+    def self.weeks_suffix
+      'week(s)'
+    end 
+    # Method provides text for months suffix for a messure.
+    def self.months_suffix
+      'month(s)'
+    end 
+    # Method provides text for years suffix for a messure.
+    def self.years_suffix
+      'year(s)'
+    end
+    # Method provides text for period.
+    def self.period
+      'Period'
+    end
+    # Method provides text for duration.
+    def self.duration
+      'Duration'
+    end 
+    # Method provides text for measure.
+    def self.measure
+      'Measure'
+    end 
+    # Method provides text for since.
+    def self.since
+      'since'
+    end 
+    # Method provides text for till.
+    def self.till
+      'till'
+    end 
+  end
+end

data/test/testduesummary.rb

@@ -0,0 +1,69 @@
+require 'minitest/autorun'
+require_relative '../lib/due_summary'
+
+class TestDue < Minitest::Test
+
+  def test_due_difference_seconds_between_dates
+    due = Due::DueSummary.new('2020-10-11 12:00:00')
+    due.now_date_time = Time.parse('2020-10-12 12:00:00')
+    due.calc_difference
+
+    assert_equal(-86_400.0, due.difference)
+  end
+
+  def test_due_difference_minutes_between_dates
+    due = Due::DueSummary.new('2020-10-11 12:00:00')
+    due.now_date_time = Time.parse('2020-10-12 12:00:00')
+    due.calc_difference
+
+    assert_equal(-1440, due.calc_mins_till)
+  end
+
+  def test_due_difference_hours_between_dates
+    due = Due::DueSummary.new('2020-10-11 12:00:00')
+    due.now_date_time = Time.parse('2020-10-12 12:00:00')
+    due.calc_difference
+
+    assert_equal(-24, due.calc_hours_till)
+  end
+
+  def test_due_difference_days_between_dates
+    due = Due::DueSummary.new('2020-10-11 12:00:00')
+    due.now_date_time = Time.parse('2020-10-12 12:00:00')
+    due.calc_difference
+
+    assert_equal(-1, due.calc_days_till)
+  end
+
+  def test_due_difference_days_between_dates
+    due = Due::DueSummary.new('2020-10-11 12:00:00')
+    due.now_date_time = Time.parse('2020-10-12 12:00:00')
+    due.calc_difference
+
+    assert_equal(-1, due.calc_days_till)
+  end
+
+  def test_due_difference_months_between_dates
+    due = Due::DueSummary.new('2020-07-01 00:00:00')
+    due.now_date_time = Time.parse('2020-08-01 00:00:00')
+    due.calc_difference
+
+    assert_equal(-1, due.calc_months_till)
+  end
+
+  def test_due_difference_years_between_dates
+    due = Due::DueSummary.new('2019-07-01 00:00:00')
+    due.now_date_time = Time.parse('2020-07-02 00:00:00')
+    due.calc_difference
+
+    assert(due.calc_years_till >= -0.99)
+  end
+
+  def test_due_difference_weeks_between_dates
+    due = Due::DueSummary.new('2020-07-01 00:00:00')
+    due.now_date_time = Time.parse('2020-08-01 00:00:00')
+    due.calc_difference
+
+    assert(-4.43, due.calc_weeks_till)
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: due_summary
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Rag Dhiman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: tabulate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+description: Due summary for a given date including months, days and years till the
+  date!
+email: rubycoder@example.com
+executables:
+- due_summary
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/due_summary
+- due_summary.gemspec
+- lib/due_summary.rb
+- lib/due_summary/duetext.rb
+- test/testduesummary.rb
+homepage: https://rubygems.org/gems/example
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-
+  bug_tracker_uri: https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/issues
+  changelog_uri: https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/branches/all
+  documentation_uri: https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/tree/master
+  homepage_uri: https://www.pluralsight.com/authors/rag-dhiman
+  mailing_list_uri: https://www.pluralsight.com/authors/rag-dhiman
+  wiki_uri: https://github.com/RagDhiman/PS-DueSummaryGem-RubyGems-/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Due summary for a given date!
+test_files: []