expiry_calculator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad6d87c333e5705c279b6e3748bb04ecf330d800639523d7d74e564b5c489bcf
+  data.tar.gz: 3185b744a8f58e03e2081ab989b830c1408103683c40a5d59e1ca1e7a9af95c6
+SHA512:
+  metadata.gz: 92c3278652f83e8eb201b5d7c7f52db31fc17025c645ec803127bd08b27c4660a15d4a8582fc29ea26448b188b76b5db5cf768a92ec92b6c11ab5d3bbd509617
+  data.tar.gz: 472bc6e4be4827d1030475a005c7f6fb132f4435a1c5597e5f21d15b5f084533b715f32f03041021439698b0757c72e909af6bf4470a384e876033b6c66b31d4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+expiry_calculator

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/.standard.yml

@@ -0,0 +1,7 @@
+# For available configuration options, see: https://github.com/standardrb/standard.
+ruby_version: 3.1
+
+ignore:
+  - '*.gemspec':
+    - Gemspec/DeprecatedAttributeAssignment
+    - Layout/ExtraSpacing

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2025-03-17
+
+- Initial release.

data/README.md

@@ -0,0 +1,75 @@
+# Expiry Calculator
+
+[![Gem Version](https://badge.fury.io/rb/expiry_calculator.svg)](https://rubygems.org/gems/expiry_calculator)
+[![Build](https://github.com/abarrak/expiry_calculator/actions/workflows/ci.yml/badge.svg)](https://github.com/abarrak/expiry_calculator/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
+A ruby library that determines how much time left till certain date and time.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add expiry_calculator
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install expiry_calculator
+```
+
+## Usage
+
+Add the library if gem auto loading is not available.
+
+```ruby
+require "expiry_calculator"
+```
+
+You can use the the extendable module method:
+
+```ruby
+ExpiryCalculator.calculate(2025, 10, 10)
+# => 201
+```
+
+Or mix in to use the calcuate function directly:
+
+```ruby
+include ExpiryCalculator
+
+calculate Date.new(2025, 10, 10)
+# => 201
+```
+
+```ruby
+calculate "2025-01-10"
+# => 0
+```
+
+Active record models and be called with the date field needed to calculate:
+
+```ruby
+user = User.first
+calculate user, :birth_day
+# => 15
+```
+
+
+The supported objects:
+
+- `Date`
+- `DateTime`
+- `string`: attempted to be parsed as datetime object.
+- `ActiveRecord`: given an attribute of of the model to read as date object.
+
+## API Docs
+
+The gem specs can [be found at RubyDocs.](https://www.rubydoc.info/gems/network-client/)
+
+## Contributing
+
+Bug reports and pull requests are welcome [on GitHub](https://github.com/abarrak/expiry_calculator).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/expiry_calculator/logic.rb

@@ -0,0 +1,33 @@
+module ExpiryCalculator
+  module Logic
+    ##
+    # A function to calculate the expiration from a given date.
+    #
+    # == Parameters:
+    #
+    # [*record*] +Date|DateTime|ApplicationRecord+: field of date and time to caluclate expiry for. Can be activerecord model containing a date field.
+    # [*record_attr*] +symbol|string+ The date attribute field in case of active record model is passed in first arguemtn. Default to nil.
+    #
+    # == Returns:
+    #
+    # The remaining days till the expiry, or zero if it already past.
+    #
+    #
+    def calculate record, record_attr = nil
+      expiry_date = case record
+      when Date
+        record
+      when DateTime
+        record
+      when String
+        DateTime.parse(record)
+      when ->(r) { defined?(ApplicationRecord) && r === ApplicationRecord }
+        record[record_attr.to_sym]
+      else
+        raise ArgumentError, "record type not supported."
+      end
+      days = (Date.today..expiry_date).count
+      days.zero? ? 0 : days - 1
+    end
+  end
+end

data/lib/expiry_calculator/version.rb

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

data/lib/expiry_calculator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "expiry_calculator/logic"
+require_relative "expiry_calculator/version"
+
+module ExpiryCalculator
+  include ExpiryCalculator::Logic
+end

data/sig/expiry_calculator.rbs

@@ -0,0 +1,4 @@
+module ExpiryCalculator
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: expiry_calculator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Abdullah Barrak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The library provides functionality to calculate the expiration from different
+  dates and time objects.
+email:
+- abdullah@abarrak.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/expiry_calculator.rb
+- lib/expiry_calculator/logic.rb
+- lib/expiry_calculator/version.rb
+- sig/expiry_calculator.rbs
+homepage: https://rubygems.org/gems/expiry_calculator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/expiry_calculator
+  source_code_uri: https://github.com/abarrak/expiry_calculator
+  changelog_uri: https://github.com/abarrak/expiry_calculator/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Determines how much time left till certain date.
+test_files: []