miti 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f4c775b9f8c30928cebcae3433d1b058dfbcbc45b643b7b3a33bfb54eae823
-  data.tar.gz: '04585850914da921d0280dc52b30375081d90887985c3153bd852034beeb5817'
+  metadata.gz: f1f30a2d951f109ab5cdc4a290dec5dde6dcbeabd97a68217056c93751cca658
+  data.tar.gz: 21a30dcc1e05e5d9c3c38dbf24a9a2507c6ec096504a93ec5de83af9ba210140
 SHA512:
-  metadata.gz: 4c90647e451ca928370a6c186dca95131535d024491e3febbdc54522fbadf1167f77b7c2507e7beed2a1a3fe3deda6daa19b438b45f6d069f7b68e10ac0e9871
-  data.tar.gz: 207832fd309cab8bb680f2c81e60c0d5f0521983eb043c62676eee8f2bd14464bc0a9d01837c148649417c617432b59ead08b816812bc3b0d82244a30fb3bc71
+  metadata.gz: 577e91a616bc035f388939c883373666f7b514b030a16b1918747b1f3e48ecd11b149ee8246fa77235fd1343135a3ef9e4226602b1c57c65a86c11a3e734b8d7
+  data.tar.gz: 3efe7397bfa2198b7d8489a1776344190e826694f4487f2be1cf225c49ff9c06560afeb3152d04662db8636af0d7b7a676cc0697eb9d39f382d74ee5a189039a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 xkshitizx sanzay_mdr
+
+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 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.md

@@ -1,8 +1,7 @@
-# Miti
+# Miti 
+[![Gem Version](https://badge.fury.io/rb/miti.svg)](https://badge.fury.io/rb/miti)
 
-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/miti`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem can help to convert English date to Nepali date and vice-versa.
 
 ## Installation
 
@@ -13,21 +12,47 @@ Install the gem and add to the application's Gemfile by executing:
 If bundler is not being used to manage dependencies, install the gem by executing:
 
     $ gem install miti
-
 ## Usage
 
-TODO: Write usage instructions here
+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.
 
-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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/miti. 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]/miti/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/xkshitizx/miti. 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/xkshitizx/miti/blob/main/CODE_OF_CONDUCT.md).
 
 ## Code of Conduct
 
-Everyone interacting in the Miti project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/miti/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Miti project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/xkshitizx/miti/blob/main/CODE_OF_CONDUCT.md).

data/lib/miti/ad_to_bs.rb

@@ -3,17 +3,40 @@
 module Miti
   # class to handle the algorithm for converting AD to BS
   class AdToBs
+    ##
+    # Initializes a AdToBs object
+    # @param @english_date [Date]
+    #
     def initialize(english_date)
       @english_date = english_date
       @nepali_year = english_date.year + 56
     end
 
+    ##
+    # Converts the @english_date to nepali date
+    # @param to_h [boolean], default set to false
+    #
+    # @return <NepaliDate>, refers to converted nepali date object
+    # @return [Hash], hash consisting (:barsa, :mahina, :gatey) if @params to_h is true
     def convert(to_h: false)
       return NepaliDate.new(barsa: final_nepali_year_month_value[:year], mahina: mahina, gatey: gatey) unless to_h
 
       { barsa: final_nepali_year_month_value[:year], mahina: mahina, gatey: gatey }
     end
 
+    ##
+    # Calculates the nepalese year and month respectively
+    # determines the difference of nepali_nth_day and total_days_in_nepali_year
+    #
+    # if the difference is positive
+    # - month -> @english_date's month - 4 = nepali_month
+    # - year -> @english_date's year + 1 = nepali year
+    #
+    # if negative
+    # - month -> @english_date's month + 8 = nepali_month
+    # - year -> @english_date's year = nepali year
+    #
+    # @return [Hash],which includes (:year,:month) *[converted to nepali]*
     def final_nepali_year_month_value
       @final_nepali_year_month_value = if (nepali_nth_day - total_days_in_nepali_year).positive?
                                          { year: nepali_year + 1, month: english_date.month - 4 }
@@ -57,6 +80,13 @@ module Miti
       end
     end
 
+    ##
+    # Calculates the remaining days in a specific year
+    # by retrieving the modulo of nepali_nth_day to total_days_in_nepali_year
+    # - nepali_nth_day -> number of days from 1st Jan
+    # - total_days_in_nepali_year -> number of days in specific nepali year
+    #
+    # @return [Integer], refers to number of days remaining in nepali year
     def remaining_days_in_nepali_year
       remaining_days = nepali_nth_day % total_days_in_nepali_year
       if remaining_days.zero?
@@ -66,25 +96,46 @@ module Miti
       end
     end
 
+    ##
+    # Calculates the total number of days in a specific year
+    #
+    # @return [Integer], refers to the total number of days
     def total_days_in_nepali_year
       @total_days_in_nepali_year ||= year_data[nepali_year].sum
     end
 
+    ##
+    # Calculates the number of days in nepali year as on from Jan 1st
+    #
+    # @return [Integer], refers to number of days
     def nepali_nth_day
       @nepali_nth_day = english_date.yday + nepali_nth_day_for_english_new_year - 1
     end
 
+    ##
+    # Determines the number of days from Jan 1st to Baisakh 1st, for leap years
+    # - 263 days for normal year
+    # - 264 days for year following the leap years
+    # @return [Integer], refers to the number of days
     def nepali_nth_day_for_english_new_year
       return 264 if year_after_leap_year?
 
       263
     end
 
+    ##
+    # Checks the previous year of @english_date from params is leap year or not?
+    #
+    # @return [Boolean], refers previous year is whether leap year or not
     def year_after_leap_year?
       year_before = english_date.year - 1
       (year_before % 400).zero? || (year_before % 100 != 0 && (year_before % 4).zero?)
     end
 
+    ##
+    # Calls DateData class to retrieve the nepali date data consisting total no of days, month
+    #
+    # @return [Hash], refers to hash object consisting the nepali date data
     def year_data
       @year_data = Miti::Data::DateData.year_month_days_hash
     end

data/lib/miti/bs_to_ad.rb

@@ -8,7 +8,7 @@ module Miti
     ##
     # Creating an object of BsToAd requires a Miti::NepaliDate object
     #
-    # params Miti::NepaliDate
+    # @param [Miti::NepaliDate]
     def initialize(nepali_date)
       @barsa = nepali_date.barsa
       @mahina = nepali_date.mahina
@@ -28,7 +28,7 @@ module Miti
     # Incase the date is not found, error is raised.
     # For fixing the issue, the value for range in date_range method should be increased.
     #
-    # returns Date
+    # @return [Date]
     def english_date
       date_range.each do |date|
         return date if Miti::AdToBs.new(date).convert(to_h: true) ==
@@ -43,7 +43,7 @@ module Miti
     # This method creates new english date with year/month/day value equal to Nepali date and subtracts by 20,711
     # and returns the range of date around it.
     #
-    # return []<Date>
+    # @return [DateRange]
     def date_range(range = 8)
       probable_english_date = Date.new(barsa, mahina, gatey) - 20_711
       probable_english_date.prev_day(range)..probable_english_date.next_day(range)

data/lib/miti/nepali_date.rb

@@ -18,7 +18,7 @@ module Miti
     ##
     # Get equivalent tarik(AD) for NepaliDate
     #
-    # return Date
+    # @return [Date]
     def tarik
       @tarik ||= BsToAd.new(self).convert
     end
@@ -26,7 +26,7 @@ module Miti
     ##
     # Get weekday for a nepali date.
     #
-    # returns Integer(0-6) that represents weekdays starting from 0.
+    # @return [Integer](0-6) that represents weekdays starting from 0.
     def bar
       @bar ||= tarik&.wday
     end
@@ -34,7 +34,7 @@ module Miti
     ##
     # returns details of nepali date in a ruby Hash
     #
-    # returns Hash
+    # @return [Hash]
     def to_h
       { barsa: barsa, mahina: mahina, gatey: gatey, bar: bar, tarik: tarik }
     end
@@ -42,9 +42,9 @@ module Miti
     ##
     # Returns Nepali Date in string format(yyyy/mm/dd).
     #
-    # params separator(- by default)
+    # @param separator(- by default)
     #
-    # returns String
+    # @return [String]
     def to_s(seperator = "-")
       return unless [" ", "/", "-"].include?(seperator)
 
@@ -57,7 +57,7 @@ module Miti
     # Descriptive output for current date
     # When nepali flag is true, month is returned in nepali font and week day in Nepali
     #
-    # returns String
+    # @return [String]
     def descriptive(nepali: false)
       month_index = mahina - 1
       if nepali
@@ -96,7 +96,7 @@ module Miti
       ##
       # This method parses date in yyyy/mm/dd to NepaliDate object
       #
-      # returns Miti::NepaliDate
+      # @return [Miti::NepaliDate]
       def parse(date_string)
         regex = %r{\A\d{4}[-/\s]\d{1,2}[-/\s]\d{1,2}\z}
         raise "Invalid Date Format" unless regex.match(date_string)

data/lib/miti/version.rb

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

data/lib/miti.rb

@@ -10,6 +10,10 @@ module Miti
   class Error < StandardError; end
 
   class << self
+    ##
+    # This method converts the provided english date to nepali date
+    # @param english_date [String], refers to date in string format
+    # @return [<Miti::NepaliDate>], refers to the converted nepali date
     def to_bs(english_date)
       date = parse_english_date(english_date)
       Miti::AdToBs.new(date).convert
@@ -17,6 +21,10 @@ module Miti
       "Invalid Date"
     end
 
+    ##
+    # This method converts the provided nepali date to english date
+    # @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)
       date = parse_nepali_date(nepali_date)
       Miti::BsToAd.new(date).convert
@@ -24,6 +32,12 @@ module Miti
 
     private
 
+    ##
+    # This method parses the provided parameter english date to Date object
+    # It checks the class of the parameter and returns the Date object accordingly
+    # @param english_date [String], refers to date in string format OR
+    # @param english_date [Date], refers to date object
+    # @return [<Date>], refers to Date object
     def parse_english_date(english_date)
       klass = english_date.class.to_s
 
@@ -36,6 +50,12 @@ module Miti
       end
     end
 
+    ##
+    # This method parses the provided parameter nepali_date to Miti::NepaliDate object
+    # It checks the class of the parameter and returns the Miti::NepaliDate object accordingly
+    # @param nepali_date [String], refers to date in string format OR
+    # @param nepali_date [Miti::NepaliDate ], refers to date object
+    # @return [<Date>], refers to Date object
     def parse_nepali_date(nepali_date)
       klass = nepali_date.class.to_s
 

data/miti.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |spec|
   spec.email = %w[kshitizlama03@gmail.com sanzaymanandhar99@gmail.com]
 
   spec.summary = "Date converter BS to AD and vice-versa."
-  spec.description = "You can get current date by simply typing miti. It also converts date in AD to Nepali Date(BS)."
+  spec.description = "This gem can help to convert English date(AD) to Nepali date(BS) and vice-versa."
   # spec.homepage = "TODO: Put your gem's website or public repo URL here."
   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"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miti
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - xkshitizx
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies: []
-description: You can get current date by simply typing miti. It also converts date
-  in AD to Nepali Date(BS).
+description: This gem can help to convert English date(AD) to Nepali date(BS) and
+  vice-versa.
 email:
 - kshitizlama03@gmail.com
 - sanzaymanandhar99@gmail.com
@@ -22,6 +22,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/miti.rb