miti 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3046737d4f617e9117de445868dd35175bac198b1cec974171baf13d6152f3c1
-  data.tar.gz: 548fcde9debb5f4330a85339a77ef8f8f9e53a9324dd262d135c4b08a800a306
+  metadata.gz: 44383837579fa3f0fbca4203616117938adfcc02a39d383d448ec5a8d8fc3a6b
+  data.tar.gz: 9f9b9415bd30a4cb3c7007bf531f04f44173a2cd1a28afa901431f69026880d7
 SHA512:
-  metadata.gz: 6f911891efb4efbc8d82eb5e125cfc86d9ebf7efdea3dfafc881415370658076a895e139343b1a9de1f2397ea8551518d61ee975cc11a431c62389e60d749676
-  data.tar.gz: aba5f7ee0122b77d213afb349c5fd8424e606ca7a3ee72a07e7fdef8100fab24c85d143bec5bb5efcd858275ca82633f6ff26bb56d86452f19a34a80fade8083
+  metadata.gz: 8436ce93a8ba9b3fe57387ec6c6e240b821665e37a052dadf6ae87bfbfd477a7a5c2c37a1fbb351a7e13e5db900d684ae5c0a91124631e9f4bef3e4f8aaa63ed
+  data.tar.gz: 2c4efc488ab171d0765c78f65707ea66296a8affa5f39564747f0835d448717845b27676168b84152c91cb89035b8d04ab1dbef51c5531470dec191b2704d978

data/CHANGELOG.md

@@ -7,4 +7,9 @@
 ## [0.1.0] - 2023-05-21
 - Change Class method to constant for fetching date. Add corresponding date for Baisakh 1 and Jan 1.
 - Simplify logic for AD to BS conversion
-- Refactor and add comments
+- Refactor and add comments
+
+## [1.0.0] - 2023-06-27
+- New release 1.0.0
+- Integrate Miti CLI
+- Miti CLI now accepts arguments for date conversion

data/Gemfile

@@ -13,4 +13,6 @@ gem "rubocop", "~> 1.21"
 
 gem "byebug"
 
+gem "thor"
+
 gem "simplecov"

data/exe/miti

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "miti"
+require_relative "../lib/cli"
+
+Miti::CLI.start(ARGV)

data/lib/cli.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "thor"
+require "date"
+require_relative "miti"
+
+module Miti
+  # class to integrate CLI
+  class CLI < Thor
+    def initialize(*args)
+      super
+      @shell = Thor::Shell::Color.new
+      @output_color = :green
+    end
+
+    desc "today", "today's nepali miti"
+    def today
+      date = Date.today
+      current_nepali_miti = Miti.to_bs(date.to_s)
+      formatted_miti = "[#{current_nepali_miti} BS] #{current_nepali_miti.descriptive}"
+      formatted_date = "[#{date} AD] " + date.strftime("%B %d, %Y %A")
+
+      @shell.say("#{formatted_miti}\n#{formatted_date}", :green)
+    end
+
+    desc "on ENGLISH_DATE", "converts english date to nepali miti"
+    def to_bs(english_date)
+      converted_nepali_miti = Miti.to_bs(english_date)
+      output_txt = "[#{converted_nepali_miti} BS] #{converted_nepali_miti.descriptive}"
+    rescue ConversionUnavailableError => e
+      output_txt = e
+      @output_color = :red
+    ensure
+      @shell.say(output_txt, @output_color)
+    end
+
+    desc "to NEPALI_DATE", "converts nepali miti to english date"
+    def to_ad(nepali_date)
+      converted_english_date = Miti.to_ad(nepali_date)
+      output_txt = "[#{converted_english_date} AD] #{converted_english_date.strftime("%B %d, %Y %A")}"
+    rescue ConversionUnavailableError => e
+      output_txt = e
+      @output_color = :red
+    ensure
+      @shell.say(output_txt, @output_color)
+    end
+
+    no_commands do
+      def self.exit_on_failure?
+        true
+      end
+    end
+  end
+end

data/lib/miti/version.rb

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

data/lib/miti.rb

@@ -9,6 +9,7 @@ require_relative "miti/data/date_data"
 # Base module for the gem
 module Miti
   class Error < StandardError; end
+  class ConversionUnavailableError < StandardError; end
 
   class << self
     ##
@@ -16,6 +17,8 @@ module Miti
     # @param english_date [String], refers to date in string format
     # @return [<Miti::NepaliDate>], refers to the converted nepali date
     def to_bs(english_date)
+      validate_date_range(date: english_date, conversion: :to_bs)
+
       date = parse_english_date(english_date)
       Miti::AdToBs.new(date).convert
     rescue Date::Error
@@ -27,12 +30,37 @@ module Miti
     # @param nepali_date [String], refers to date in string format
     # @return [<Date>], refers to the converted english date from nepali date
     def to_ad(nepali_date)
+      validate_date_range(date: nepali_date, conversion: :to_ad)
+
       date = parse_nepali_date(nepali_date)
       Miti::BsToAd.new(date).convert
     end
 
     private
 
+    ##
+    # This method throws an exception if the conversion is not available
+    # for both BS and AD
+    # - For AD to BS conversion max conversion is supported upto 2044 AD
+    # - For BS to AD conversion max conversion is supported upto 2100 BS
+    # @param date [String], refers to date in string format '20XX-XX-XX'
+    # @param conversion, [Symbol], refers to the conversion either :to_ad or :to_bs
+    #
+    # @return ConversionUnavailableError
+
+    def validate_date_range(date:, conversion:)
+      max_conversion_year, min_conversion_year, date_format = if conversion == :to_bs
+                                                                [2044, 1919, :AD]
+                                                              else
+                                                                [2100, 1975, :BS]
+                                                              end
+      year_value = date.split("-")[0].to_i
+      return if year_value.between?(min_conversion_year, max_conversion_year)
+
+      raise ConversionUnavailableError,
+            "Conversion only available for #{min_conversion_year}-#{max_conversion_year} #{date_format}"
+    end
+
     ##
     # This method parses the provided parameter english date to Date object
     # It checks the class of the parameter and returns the Date object accordingly

data/miti.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
                    "miti.gemspec", ".github/*.md",
                    "Gemfile", "Rakefile"]
   spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables = ["miti"]
   spec.require_paths = ["lib"]
   spec.license = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miti
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - xkshitizx
@@ -9,13 +9,14 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies: []
 description: Convert English date(AD) to Nepali date(BS) and vice-versa.
 email:
 - kshitizlama03@gmail.com
 - sanzaymanandhar99@gmail.com
-executables: []
+executables:
+- miti
 extensions: []
 extra_rdoc_files: []
 files:
@@ -24,6 +25,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- exe/miti
+- lib/cli.rb
 - lib/miti.rb
 - lib/miti/ad_to_bs.rb
 - lib/miti/bs_to_ad.rb