gooday 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65408ee099ca8031d0d68dd135af070791f6355200ec25f66948c71533330a7b
-  data.tar.gz: 935a418f59438ac1bb30a89b9ac43a7fd28a24feb8828b567428f1531762fa07
+  metadata.gz: 03ea6be43169494d1482b5a50628e61d5ce9810ed3515e19a2fce5d9c3ae9366
+  data.tar.gz: 4962c2d8badfdf5cdfce4b092ffe2122f4167073954f5274cb0b8fc989c9fd75
 SHA512:
-  metadata.gz: b3f32797a736469b977b7bcc3790fe69921b2d86206c7acfc43df5e903bb9cdc78a5ed13b52bc6e7558f40f050ccb5532c6ec7550bba97708d52c8be9de51814
-  data.tar.gz: 24672d70ac24d37b511259263ac6a5121278105eea50ec0258651161489f563d95d1bf6ab570c477c3cee9662a4c133d9851413b581f4f588fed4ef168b922ce
+  metadata.gz: 4fc8efa4a033377e08f90fee4eee20e0ff6077dc60b41fcf44e30762db6ef7328a1fc7fd2bebaa2eff21bcb1e74f5040eb2ccf18b9656d0235b27cb738237061
+  data.tar.gz: 85f138587b86b19a04828a2c9ba86acc167e0ddd0fb7043e216f0a8601fb3ae9720b6707aea4c7ae79245702c072091df9cc5f170a9a4a79addfe2f466ed4a4f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gooday (0.1.1)
+    gooday (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -14,7 +14,48 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+To use Gooday. You have to initialize it. The default language is `English (en)`. The module includes `French (fr)` and `English (en)`
+
+```ruby
+require "gooday"
+
+gooday = Gooday.new(Time.now)
+```
+
+### Locale
+You can change the language by passing the language as an argument:
+
+```ruby
+gooday.locale("fr")
+```
+
+You can also set a locale directory, which will be used to load the language files.
+(This loads a YAML file)
+
+```ruby
+gooday.locale("fr", path: "PATH/TO/LOCALE", target: "yml")
+```
+
+### Add & Set
+You can add days, months, seconds with Gooday. You can also set the date with Gooday.
+
+```ruby
+gooday = Gooday.new(Time.now)
+gooday.set(:month => "April", :day => 2, :year => 2020)
+gooday.add(:days => 28)
+```
+This code sets the date to April, 2 2020 and adds 28 days to it.
+
+### Date parser
+With the regexes specified in locales file you can parse the dates.
+The parsed dates are returned as an array.
+```ruby
+gooday = Gooday.new(Time.now)
+gooday.locale("fr")
+parsed = date.parse_string("Nous sommes le 17/02/2021. Demain nous serons le 18 Février 2021")
+puts parsed[0]
+```
+
 
 ## Development
 
@@ -24,7 +65,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gooday. 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]/gooday/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/Senchuu/Gooday. 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/Senchuu/gooday/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -32,4 +73,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Gooday project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gooday/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Gooday project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Senchuu/gooday/blob/main/CODE_OF_CONDUCT.md).

data/lib/gooday/index.rb

@@ -29,15 +29,19 @@ module Gooday
       @zone = context.zone
     end
 
-    def locale(locale, path: false, target: "ruby")
+    def locale(locale, path: nil, target: "ruby")
       if target.downcase.match?(/^(yml|yaml)/)
-        raise Gooday::Error, "#{locale.inspect} doesn't exist as a YAML locale format" unless File.exist?(File.expand_path("#{locale}.yml", path))
+        raise Gooday::Error, "#{locale.inspect} doesn't exist as a YAML locale format" unless File.exist?(File.expand_path("#{locale}.yml", File.dirname(path)))
 
         require "gooday/yaml_parser"
         @translations = YAMLParser.new(File.expand_path("#{locale}.yml", path))
                                   .translations.transform_keys(&:to_sym)
       else
-        raise Gooday::Error, "#{locale.inspect} doesn't exist as a RUBY locale format" unless File.exist?(path ? File.expand_path("#{locale}.rb", path) : "./lib/gooday/locales/#{locale}.rb")
+        if path
+          raise Gooday::Error, "#{locale.inspect} doesn't exist as a RUBY locale format" unless File.file?(File.expand_path("#{locale}.rb", path))
+        else
+          raise Gooday::Error, "#{locale.inspect} doesn't exist as a RUBY locale format" unless File.file?(File.expand_path("./locales/#{locale}.rb", File.dirname(__FILE__)))
+        end
 
         file = if path
                  File.expand_path("#{locale}.rb", path)

data/lib/gooday/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gooday
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gooday
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Senchuu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-03 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies: []
 description: Gooday is a date manager written in ruby. It is a simple and easy to
   use.