miti 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3046737d4f617e9117de445868dd35175bac198b1cec974171baf13d6152f3c1
-  data.tar.gz: 548fcde9debb5f4330a85339a77ef8f8f9e53a9324dd262d135c4b08a800a306
+  metadata.gz: d035a5fe63185b818bc645ef7aabf2121ba16d9ca1728b095f259fd9dabacd68
+  data.tar.gz: 4d014ff0cf964d26ccbea9e06e8848296be479f699dace666ff3fedba0281358
 SHA512:
-  metadata.gz: 6f911891efb4efbc8d82eb5e125cfc86d9ebf7efdea3dfafc881415370658076a895e139343b1a9de1f2397ea8551518d61ee975cc11a431c62389e60d749676
-  data.tar.gz: aba5f7ee0122b77d213afb349c5fd8424e606ca7a3ee72a07e7fdef8100fab24c85d143bec5bb5efcd858275ca82633f6ff26bb56d86452f19a34a80fade8083
+  metadata.gz: 8727ff45502749f7897688461127458ff6d19e047079108bc20111d26e9ee2d7d0ba97e2b7153cac80131a9cb09e218b9a67505f748e7a7a2433a3b85ba31c13
+  data.tar.gz: a7cacddd04ee8b2bd790edf5100bc1c6f55fb06343f7b2d6c119b5c39c12956a9f91499f4b6ae034d9c5938457318effdc2110921ee137d26729b055ac2f39d0

data/CHANGELOG.md

@@ -7,4 +7,13 @@
 ## [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
+
+## [1.0.1] - 2023-07-01
+- add gem dependency thor
+- Update documentation for CLI app usage and readme.md

data/Gemfile

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

data/README.md

@@ -1,7 +1,7 @@
 # Miti 
 [![Gem Version](https://badge.fury.io/rb/miti.svg)](https://badge.fury.io/rb/miti)
 
-This gem can help to convert English date to Nepali date and vice-versa.
+Converts English Date to Miti *(Nepali date)* and vice-versa. Also Miti provides built in CLI app which has date conversion features.
 
 ## Installation
 
@@ -13,36 +13,10 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install miti
 ## Usage
+  1. [Miti](docs/miti.md)
+  2. [Miti CLI](docs/cli.md)
 
-A Miti::NepaliDate(nepali miti) object is created with Miti.to_bs, while Date(english date) object is created with Miti.to_ad
-```ruby
-require 'miti'
 
-Miti.to_bs("2022/10/12") # args can also be sent as "2022-12-12"
-  #=> #<Miti::NepaliDate:0x00007fec31b93ac8 @barsa=2079, @gatey=26, @mahina=6>
-
-Miti.to_bs("2022/10/12").descriptive
-  #=> "Asoj 26, 2079 Wednesday"
-
-Miti.to_bs("2022/10/12").descriptive(nepali: true)
-  #=> "आश्विन 27, 2079 Thursday(बिहिबार)"
-
-Miti.to_bs("2022/10/12").tarik
-  #=> #<Date: 2022-10-12 ((2459865j,0s,0n),+0s,2299161j)>
-
-Miti.to_bs("2022/10/12").to_h
-  #=> {:barsa=>2079, :mahina=>6, :gatey=>26, :bar=>3, :tarik=>#<Date: 2022-10-12 ((2459865j,0s,0n),+0s,2299161j)>}
-
-Miti.to_bs("2022/10/12").to_s
-  #=> "2079-06-26"
-
-Miti.to_bs("2022/10/12").to_s(separator: "/") # separator can be [" ", "/"]
-  #=> "2079/06/26" when (separator: "/")
-  #=> "2079 06 26" when (separator: " ")
-
-Miti.to_ad("2079/06/26")
-  #=> #<Date: 2022-10-12 ((2459865j,0s,0n),+0s,2299161j)>
-```
 ## Development
 
 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.

data/docs/cli.md

@@ -0,0 +1,45 @@
+
+## MITI CLI
+Open your terminal or command prompt and run the `miti` command to access the available features.
+
+    $ miti
+
+The MITI CLI app will display the available commands. To execute a specific command, type the command followed by any required arguments.
+
+## Available Commands
+
+#### ***(Note: All the date argument must be provided in YYYY/MM/DD OR YYYY-MM-DD format)***
+
+### **today**
+
+The `today` command displays current day's miti as well as date. To use the `today` command, run the following:
+
+    $ miti today
+
+Output:
+```ruby
+[2080-03-13 BS] Ashadh 13, 2080 Wednesday
+[2023-06-28 AD] June 28, 2023 Wednesday
+
+```
+### **to_bs**
+The `to_bs` command converts an English date to the Miti (Nepali Date). Takes a argument ***ENGLISH DATE*** for conversion from English Date to Miti.
+
+    $ miti to_bs 2023-06-28
+
+
+Output:
+```ruby
+[2080-03-13 BS] Ashadh 13, 2080 Wednesday
+```
+
+### **to_ad**
+
+The `to_ad` command converts a Miti to the English date. Takes a argument ***NEPALI MITI*** for conversion from Miti to English Date.
+
+    $ miti to_ad 2080-03-13
+
+Output:
+```ruby
+[2023-06-28 AD] June 28, 2023 Wednesday
+```

data/docs/miti.md

@@ -0,0 +1,33 @@
+
+A **Miti::NepaliDate** (nepali miti) object is created with **Miti.to_bs**, while **Date**(english date) object is created with **Miti.to_ad**
+
+#### ***(Note: All the date argument must be provided in YYYY/MM/DD OR YYYY-MM-DD format)***
+
+```ruby
+require 'miti'
+
+Miti.to_bs("2022/10/12") # args can also be sent as "2022-12-12"
+  #=> #<Miti::NepaliDate:0x00007fec31b93ac8 @barsa=2079, @gatey=26, @mahina=6>
+
+Miti.to_bs("2022/10/12").descriptive
+  #=> "Asoj 26, 2079 Wednesday"
+
+Miti.to_bs("2022/10/12").descriptive(nepali: true)
+  #=> "आश्विन 27, 2079 Thursday(बिहिबार)"
+
+Miti.to_bs("2022/10/12").tarik
+  #=> #<Date: 2022-10-12 ((2459865j,0s,0n),+0s,2299161j)>
+
+Miti.to_bs("2022/10/12").to_h
+  #=> {:barsa=>2079, :mahina=>6, :gatey=>26, :bar=>3, :tarik=>#<Date: 2022-10-12 ((2459865j,0s,0n),+0s,2299161j)>}
+
+Miti.to_bs("2022/10/12").to_s
+  #=> "2079-06-26"
+
+Miti.to_bs("2022/10/12").to_s(separator: "/") # separator can be [" ", "/"]
+  #=> "2079/06/26" when (separator: "/")
+  #=> "2079 06 26" when (separator: " ")
+
+Miti.to_ad("2079/06/26")
+  #=> #<Date: 2022-10-12 ((2459865j,0s,0n),+0s,2299161j)>
+```

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,72 @@
+# 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 "to_bs ENGLISH_DATE", "converts ENGLISH_DATE to Nepali Miti"
+    long_desc <<-DESC
+    Converts english date to nepali miti.
+    The `to_bs` command takes a argument <ENGLISH_DATE>, argument must be in YYYY/MM/DD or YYYY-MM-DD format
+
+    Example: $ miti to_bs 2023-06-28
+
+    Output: [2080-03-13 BS] Ashadh 13, 2080 Wednesday
+    DESC
+
+    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_ad NEPALI_MITI", "converts NEPALI_MITI to English Date"
+    long_desc <<-DESC
+    Converts nepali miti.
+    The `to_ad` command takes a argument <NEPALI_MITI>, argument must be in YYYY/MM/DD or YYYY-MM-DD format
+
+    Example: $ miti to_ad 2080-03-13
+
+    Output: [2023-06-28 AD] June 28, 2023 Wednesday
+    DESC
+
+    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.1"
 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

@@ -12,24 +12,27 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/xkshitizx/miti"
   spec.required_ruby_version = ">= 2.6.0"
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata["homepage_uri"] = "https://github.com/xkshitizx/miti"
-  spec.metadata["source_code_uri"] = "https://github.com/xkshitizx/miti"
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-  spec.metadata = { "rubygems_mfa_required" => "true" }
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir["README.md", "LICENSE",
                    "CHANGELOG.md", "lib/**/*.rb",
-                   "lib/**/*.rake",
+                   "lib/**/*.rake", "docs/*.md",
                    "miti.gemspec", ".github/*.md",
                    "Gemfile", "Rakefile"]
+  spec.metadata = {
+    # "allowed_push_host" = "TODO: Set to your gem server 'https://example.com'",
+    "bug_tracker_uri" => "https://github.com/xkshitizx/miti/issues",
+    "changelog_uri" => "https://github.com/xkshitizx/miti/blob/main/CHANGELOG.md",
+    "homepage_uri" => "https://github.com/xkshitizx/miti",
+    "source_code_uri" => "https://github.com/xkshitizx/miti/tree/v#{Miti::VERSION}",
+    "rubygems_mfa_required" => "true"
+  }
   spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.executables = ["miti"]
   spec.require_paths = ["lib"]
   spec.license = "MIT"
 
+  spec.add_dependency "thor", "~> 1.2", ">= 1.2.2"
   # Uncomment to register a new dependency of your gem
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miti
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - xkshitizx
@@ -9,13 +9,34 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-01 00:00:00.000000000 Z
-dependencies: []
+date: 2023-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 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 +45,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/cli.md
+- docs/miti.md
+- exe/miti
+- lib/cli.rb
 - lib/miti.rb
 - lib/miti/ad_to_bs.rb
 - lib/miti/bs_to_ad.rb
@@ -35,6 +60,10 @@ homepage: https://github.com/xkshitizx/miti
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/xkshitizx/miti/issues
+  changelog_uri: https://github.com/xkshitizx/miti/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/xkshitizx/miti
+  source_code_uri: https://github.com/xkshitizx/miti/tree/v1.0.1
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -51,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Date converter BS to AD and vice-versa.