i18n_date_range 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a3b493211ef6ff478bdf03e8136a81e3b563d65770f8d715e147402804d8392
-  data.tar.gz: 4c7b14086e61504b519adf18a0c94422808b457318fcf0fdf8b1fbb7e4542d2f
+  metadata.gz: 4b5b37d47192e7ed082d17c10cb9e633b3267699985ceb4a9d5f23914d477f16
+  data.tar.gz: ab2eacf2fe9807d9e305f52c626a40352d2a445e0872c03ffe403b80aa84a884
 SHA512:
-  metadata.gz: 5ea01dd9ac857ea97b26ca5112087c6f646bc22066e13149301106000e8b191239969bead2a23bdcb0a49845c94818111768568b0fc7554f0c651bcfb29136fc
-  data.tar.gz: 331557b276f356e772e3413547c80106aef37c890d30b28029bd5ecf0cbc2c497aedda4ae67fa5a2b1095b76545f9813e1362331f6cf2ad06d47362412853c09
+  metadata.gz: 3a2ac59f09a6ac60221430eb270505b886beb3fd13cb335f7da7b174b7d283a8cf899d232572428048e903757958889bd442ca2f2eb8246dbaaf9915e7ceee0d
+  data.tar.gz: cbb79ad4ca1cac1a7058c9909e394ea6bc11424d1487798350275c53a706e7bfd771ef3ccf2bb9e8ae413ad99f16886bc8d0e9e1de301e70d1dd3e89b8e04a4f

data/.rubocop.yml

@@ -2,6 +2,8 @@ require: rubocop-rails
 
 AllCops:
   TargetRubyVersion: 2.6
+  AllCops:
+    NewCops: enable
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,8 @@
 ## [0.1.0] - 2023-09-08
 
 - Initial release
+
+## [2.0.0] - 2023-11-02
+
+- Change structure to manage different languages and different formats
+- Add bunch of tests

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i18n_date_range (1.0.2)
+    i18n_date_range (1.0.3)
       rails
       rails-i18n
 
@@ -119,7 +119,7 @@ GEM
     mini_mime (1.1.5)
     minitest (5.20.0)
     mutex_m (0.1.2)
-    net-imap (0.4.3)
+    net-imap (0.3.7)
       date
       net-protocol
     net-pop (0.1.2)
@@ -255,4 +255,4 @@ DEPENDENCIES
   rubocop-rails
 
 BUNDLED WITH
-   2.4.6
+   2.4.21

data/README.md

@@ -19,13 +19,18 @@ And then execute:
 This gem comes with an integrated view helper: `date_range_i18n` which takes 3 parameters:
 - date_from
 - date_to (optional)
-- format (optional) 
+- a hash of additional formatting options(optional) 
 
-Format can be `:short` or `:long` (default is :short)
+The options hash currently support 2 arguments:
+- format: can be `:short` or `:long` (default is :short)
+- layout: can be `:one_line`or `:two_lines` (default is :one_line)
 
 "Short" format means without the explicit day name (September 8, 2024).  
 "Long" format means with it (Friday, September 8, 2024).  
 
+"One line" layout means the string will be displayed on one line only (From September 8, 2024 to September 8, 2025)
+"Two lines" layout means the result will be displayed on 2 lines,separated with `<br>` (September 8, 2024<br>September 8, 2025)
+
 ## Change texts or formats
 
 This gem is based on I18n. Feel free to overwrite any key you want.  

data/config/locales/en-GB.yml

@@ -1,19 +1,157 @@
 en-GB:
   date_range:
-    one_line:
-      with_to: "From %{from} to %{to}"
-      without_to: "%{from}"
-    two_lines:
-      with_to: "%{from}<br>%{to}"
-      without_to: "%{from}"
-
-  date:
-    formats:
-      range_short:
-        day: "%-d"
-        day_month: "%-d %B"
-        day_month_year: "%-d %B %Y"
-      range_long:
-        day: "%A %-d"
-        day_month: "%A, %-d %B"
-        day_month_year: "%A, %-d %B %Y"
+    no_end:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+    same_day:
+      one_line: 
+        short: 
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+    same_month:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %-d"
+            upcase_first: false
+          to: 
+            sentence: " to %-d %B %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %-d"
+            upcase_first: false
+          to: 
+            sentence: " to %A %-d %B %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B"
+            upcase_first: false
+          to: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B"
+            upcase_first: true
+          to: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+    same_year:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %-d %B"
+            upcase_first: false
+          to: 
+            sentence: " to %-d %B %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %-d %B"
+            upcase_first: false
+          to: 
+            sentence: " to %A %-d %B %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B"
+            upcase_first: false
+          to: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B"
+            upcase_first: true
+          to: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+    other:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: " to %-d %B %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: " to %A %-d %B %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true

data/config/locales/en.yml

@@ -1,19 +1,157 @@
 en:
   date_range:
-    one_line:
-      with_to: "From %{from} to %{to}"
-      without_to: "%{from}"
-    two_lines:
-      with_to: "%{from}<br>%{to}"
-      without_to: "%{from}"
-
-  date:
-    formats:
-      range_short:
-        day: "%-d"
-        day_month: "%B %-d"
-        day_month_year: "%B %-d, %Y"
-      range_long:
-        day: "%A %-d"
-        day_month: "%A, %B %-d"
-        day_month_year: "%A, %B %-d, %Y"
+    no_end:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %B %-d, %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %B %-d, %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+    same_day:
+      one_line: 
+        short: 
+          from: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+    same_month:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %B %-d"
+            upcase_first: false
+          to: 
+            sentence: " to %-d, %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %B %-d"
+            upcase_first: false
+          to: 
+            sentence: " to %A %B %-d, %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%B %-d"
+            upcase_first: true
+          to: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+        long:
+          from: 
+            sentence: "%A %B %-d"
+            upcase_first: true
+          to: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true
+    same_year:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %B %-d"
+            upcase_first: false
+          to: 
+            sentence: " to %B %-d, %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %B %-d"
+            upcase_first: false
+          to: 
+            sentence: " to %A %B %-d, %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%B %-d"
+            upcase_first: true
+          to: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+        long:
+          from: 
+            sentence: "%A %B %-d"
+            upcase_first: true
+          to: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true
+    other:
+      one_line: 
+        short: 
+          from: 
+            sentence: "From %B %-d, %Y"
+            upcase_first: false
+          to: 
+            sentence: " to %B %-d, %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "From %A %B %-d, %Y"
+            upcase_first: false
+          to: 
+            sentence: " to %A %B %-d, %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: "%B %-d, %Y"
+            upcase_first: true
+        long:
+          from: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true
+          to: 
+            sentence: "%A %B %-d, %Y"
+            upcase_first: true

data/config/locales/fr.yml

@@ -1,19 +1,157 @@
 fr:
   date_range:
-    one_line:
-      with_to: "Du %{from} au %{to}"
-      without_to: "%{from}"
-    two_lines:
-      with_to: "%{from}<br>%{to}"
-      without_to: "%{from}"
-
-  date:
-    formats:
-      range_short:
-        day: "%-d"
-        day_month: "%-d %B"
-        day_month_year: "%-d %B %Y"
-      range_long:
-        day: "%A %-d"
-        day_month: "%A %-d %B"
-        day_month_year: "%A %-d %B %Y"
+    no_end:
+      one_line: 
+        short: 
+          from: 
+            sentence: "À partir du %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "À partir du %A %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+    same_day:
+      one_line: 
+        short: 
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: ""
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: ""
+            upcase_first: false
+    same_month:
+      one_line: 
+        short: 
+          from: 
+            sentence: "Du %-d"
+            upcase_first: false
+          to: 
+            sentence: " au %-d %B %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "Du %A %-d"
+            upcase_first: false
+          to: 
+            sentence: " au %A %-d %B %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B"
+            upcase_first: false
+          to: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B"
+            upcase_first: true
+          to: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+    same_year:
+      one_line: 
+        short: 
+          from: 
+            sentence: "Du %-d %B"
+            upcase_first: false
+          to: 
+            sentence: " au %-d %B %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "Du %A %-d %B"
+            upcase_first: false
+          to: 
+            sentence: " au %A %-d %B %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B"
+            upcase_first: false
+          to: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B"
+            upcase_first: true
+          to: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+    other:
+      one_line: 
+        short: 
+          from: 
+            sentence: "Du %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: " au %-d %B %Y"
+            upcase_first: false
+        long: 
+          from: 
+            sentence: "Du %A %-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: " au %A %-d %B %Y"
+            upcase_first: false
+      two_lines: 
+        short:
+          from: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+          to: 
+            sentence: "%-d %B %Y"
+            upcase_first: false
+        long:
+          from: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true
+          to: 
+            sentence: "%A %-d %B %Y"
+            upcase_first: true

data/lib/i18n_date_range/i18n_date_range_generator.rb

@@ -4,6 +4,13 @@
 class I18nDateRangeGenerator
   attr_reader :from_date, :to_date, :format, :layout
 
+  KIND_NO_END = :no_end
+  KIND_SAME_DAY = :same_day
+  KIND_SAME_MONTH = :same_month
+  KIND_SAME_YEAR = :same_year
+  KIND_OTHER = :other
+
+  # "format" can be :short or :long. "layout" can be :one_line or :two_lines
   def initialize(from_date, to_date = nil, format: :short, layout: :one_line)
     @from_date = from_date
     @to_date = to_date
@@ -12,50 +19,75 @@ class I18nDateRangeGenerator
   end
 
   def to_s
-    to_date.blank? || same_date? ? without_to : with_to
+    layout == :two_lines && to_formatted.present? ? from_formatted + '<br>' + to_formatted : from_formatted + to_formatted
   end
 
   protected
 
-  def same_date?
+  # Analyzing
+
+  def kind
+    unless @kind
+      @kind = KIND_OTHER
+      @kind = KIND_SAME_YEAR if same_year?
+      @kind = KIND_SAME_MONTH if same_month?
+      @kind = KIND_SAME_DAY if same_day?
+      @kind = KIND_NO_END if no_end?
+    end
+    @kind
+  end
+
+  def same_year?
+    from_date.year == to_date&.year
+  end
+
+  def same_month?
+    from_date.year == to_date&.year && from_date.month == to_date&.month
+  end
+
+  def same_day?
     to_date == from_date
   end
 
-  def without_to
-    I18n.t(
-      "date_range.#{layout}.without_to",
-      from: format_date(from_date, :day_month_year)
-    ).capitalize
+  def no_end?
+    to_date.blank?
   end
 
-  def with_to
-    I18n.t(
-      "date_range.#{layout}.with_to",
-      from: format_date(from_date, from_format),
-      to: format_date(to_date, :day_month_year)
-    ).capitalize
+  def from_sentence
+    I18n.t("#{composite_key}.from.sentence")
   end
 
-  def from_format
-    return :day_month_year if different_year?
+  def from_upcase_first
+    I18n.t("#{composite_key}.from.upcase_first")
+  end
 
-    return :day_month if different_month?
+  def to_sentence
+    I18n.t("#{composite_key}.to.sentence")
+  end
 
-    :day
+  def to_upcase_first
+    I18n.t("#{composite_key}.to.upcase_first")
   end
 
-  def format_date(date, key)
-    I18n.l(
-      date,
-      format: "range_#{format}.#{key}".to_sym
-    )
+  def from_formatted
+    @from_formatted ||= begin
+      from = I18n.l(from_date, format: from_sentence)
+      from = from.upcase_first if from_upcase_first
+      from
+    end
   end
 
-  def different_year?
-    from_date.year != to_date.year
+  def to_formatted
+    return '' if no_end?
+    @to_formatted ||= begin
+      to = I18n.l(to_date, format: to_sentence)
+      to = to.upcase_first if to_upcase_first
+      to
+    end
   end
 
-  def different_month?
-    from_date.month != to_date.month
+  def composite_key
+    "date_range.#{kind}.#{layout}.#{format}"
   end
-end
+
+end

data/lib/i18n_date_range/i18n_date_range_helper.rb

@@ -6,8 +6,9 @@
 # Layout can be :one_line (default) or :two_lines, other might be necessary in the future
 module I18nDateRangeHelper
 
-  def date_range_i18n(from, to = nil, format: nil, layout: nil)
-    I18nDateRangeGenerator.new(*args).to_s
+  def date_range_i18n(from_date, to_date = nil, **options)
+    generator = I18nDateRangeGenerator.new(from_date, to_date, **options.slice(:format, :layout))
+    generator.to_s.html_safe
   end
 
 end

data/lib/i18n_date_range/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nDateRange
-  VERSION = "1.0.2"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n_date_range
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - pabois
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Add helper to display a date range