i18n_date_range 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eddd20b29da075a3aa8e3f4c274c14a942887039bd1b85f28b25cf85945d815f
+  data.tar.gz: 032275f6d7c6ed1dd90525d6545730502b7358a4085409167e640b8c55a94cb2
+SHA512:
+  metadata.gz: f33b04aa867d4dd0152301e8d7beaaf04f2a6a7aca1610982a64e96e858fbac7d6296dea2defe17974132ab49268b6087be5e361c5162b78c88bd6ad418f862b
+  data.tar.gz: bcabbaf98c0f77319b99e3957758d60f269fb5dd6479b970c325b9da76aa5ea0e00aae8852a524c4eb6a9a31ead3c5149de4cc1d99c07d38836c0c798ed2fdc4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2023-09-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in i18n_date_range.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 pabois
+
+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

@@ -0,0 +1,112 @@
+# I18nDateRange
+
+The purpose of this gem is to add a helper needed to display proper Date range informations.  
+For example: "Du 3 au 5 octobre 2024" or "Du 3 octobre 2023 au 12 janvier 2024"
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_date_range'
+```
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+This gem comes with an integrated view helper: `date_range_i18n` which takes 3 parameters:
+- date_from
+- date_to (optional)
+- format (optional) 
+
+Format can be `:short` or `:long` (default is :short)
+
+"Short" format means without the explicit day name (September 8, 2024).  
+"Long" format means with it (Friday, September 8, 2024).  
+
+## Examples (in French)
+
+    // Example 1
+    <% date_from = Date.today %>
+    <%= date_range_i18n(date_from) %>
+
+=> 8 septembre 2023
+
+    // Example 1 bis
+    <% date_from = Date.today %>
+    <%= date_range_i18n(date_from, nil, :long) %>
+
+=> vendredi 8 septembre 2023
+
+    // Example 2
+    <% 
+    date_from = Date.today 
+    date_to = Date.today + 1.day
+    %>
+    <%= date_range_i18n(date_from, date_to) %>
+
+=> Du 8 au 9 septembre 2023
+
+    // Example 2 bis
+    <% 
+    date_from = Date.today 
+    date_to = Date.today + 1.day
+    %>
+    <%= date_range_i18n(date_from, date_to, :long) %>
+
+=> Du vendredi 8 au samedi 9 septembre 2023
+
+    // Example 3
+    <% 
+    date_from = Date.today 
+    date_to = Date.today + 1.month
+    %>
+    <%= date_range_i18n(date_from, date_to) %>
+
+=> Du 8 septembre au 8 octobre 2023
+
+    // Example 3 bis
+    <% 
+    date_from = Date.today 
+    date_to = Date.today + 1.month
+    %>
+    <%= date_range_i18n(date_from, date_to, :long) %>
+
+=> Du vendredi 8 septembre au dimanche 8 octobre 2023
+
+    // Example 4
+    <% 
+    date_from = Date.today 
+    date_to = Date.today + 1.year
+    %>
+    <%= date_range_i18n(date_from, date_to) %>
+
+=> Du 8 septembre 2023 au 8 septembre 2024
+
+    // Example 4 bis
+    <% 
+    date_from = Date.today 
+    date_to = Date.today + 1.year
+    %>
+    <%= date_range_i18n(date_from, date_to, :long) %>
+
+=> Du vendredi 8 septembre 2023 au dimanche 8 septembre 2024
+
+## Change texts or formats
+
+This gem is based on I18n. Feel free to overwrite any key you want.  
+Refer to [config/locales/fr.yml](config/locales/fr.yml) to see what can be edited.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/noesya/i18n_date_range.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Bibliography
+
+https://coderwall.com/p/fkg-ng/display-date-ranges-in-text-in-rails

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "i18n_date_range"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en-GB.yml

@@ -0,0 +1,15 @@
+en-GB:
+  date_range:
+    with_to: "From %{from} to %{to}"
+    without_to: "%{from}"
+
+  date:
+    formats:
+      short:
+        day: "%e"
+        day_month: "%e %B"
+        day_month_year: "%e %B %Y"
+      long:
+        day: "%A %e"
+        day_month: "%A, %e %B"
+        day_month_year: "%A, %e %B %Y"

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  date_range:
+    with_to: "From %{from} to %{to}"
+    without_to: "%{from}"
+
+  date:
+    formats:
+      short:
+        day: "%e"
+        day_month: "%B %e"
+        day_month_year: "%B %e, %Y"
+      long:
+        day: "%A %e"
+        day_month: "%A, %B %e"
+        day_month_year: "%A, %B %e, %Y"

data/config/locales/fr.yml

@@ -0,0 +1,15 @@
+fr:
+  date_range:
+    with_to: "Du %{from} au %{to}"
+    without_to: "%{from}"
+
+  date:
+    formats:
+      short:
+        day: "%e"
+        day_month: "%e %B"
+        day_month_year: "%e %B %Y"
+      long:
+        day: "%A %e"
+        day_month: "%A %e %B"
+        day_month_year: "%A %e %B %Y"

data/i18n_date_range.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/i18n_date_range/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_date_range"
+  spec.version       = I18nDateRange::VERSION
+  spec.authors       = ["pabois"]
+  spec.email         = ["pierreandre.boissinot@noesya.coop"]
+
+  spec.summary       = "Add helper to display a date range"
+  spec.description   = "Add a new helper to display properly a date range (ex: From 8 to 9 September 2023)"
+  spec.homepage      = "https://github.com/noesya/i18n_date_range"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/noesya/i18n_date_range/CHANGELOG.md"
+
+  # 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.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/i18n_date_range/i18n_date_range_generator.rb

@@ -0,0 +1,56 @@
+class I18nDateRangeGenerator
+  attr_reader :from_date, :to_date, :format
+  
+  def self.generate(from_date, to_date, format)
+    new(from_date, to_date, format).to_s
+  end
+
+  def initialize(from_date, to_date, format)
+    @from_date = from_date
+    @to_date = to_date
+    @format = format
+  end
+  
+  def to_s
+    to_date.blank? ? without_to : with_to
+  end
+
+  protected
+
+  def without_to
+    I18n.t(
+      'date_range.without_to', 
+      from: format_date(from_date, :day_month_year)
+    ) 
+  end
+
+  def with_to
+    I18n.t(
+      'date_range.with_to', 
+      from: format_date(from_date, from_format), 
+      to: format_date(to_date, :day_month_year)
+    )
+  end
+
+  def from_format
+    return :day_month_year if different_year?
+    return :day_month if different_month?
+    :day
+  end
+
+  def format_date(date, key)
+    I18n.l(
+      date, 
+      format: "#{format}.#{key}".to_sym
+    )
+  end
+
+  def different_year?
+    from_date.year != to_date.year
+  end
+
+  def different_month?
+    from_date.month != to_date.month
+  end
+
+end

data/lib/i18n_date_range/i18n_date_range_helper.rb

@@ -0,0 +1,7 @@
+module I18nDateRangeHelper
+
+  def date_range_i18n(from, to = nil, format = :short)
+    I18nDateRangeGenerator.generate(from, to, format)
+  end
+  
+end

data/lib/i18n_date_range/version.rb

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

data/lib/i18n_date_range.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "i18n_date_range/version"
+require_relative "i18n_date_range/i18n_date_range_generator"
+require_relative "i18n_date_range/i18n_date_range_helper"
+
+module I18nDateRange
+  class Error < StandardError; end
+
+  class Engine < ::Rails::Engine
+    isolate_namespace I18nDateRange
+
+    ActiveSupport.on_load( :action_view ){ include I18nDateRangeHelper }
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: i18n_date_range
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pabois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-08 00:00:00.000000000 Z
+dependencies: []
+description: 'Add a new helper to display properly a date range (ex: From 8 to 9 September
+  2023)'
+email:
+- pierreandre.boissinot@noesya.coop
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en-GB.yml
+- config/locales/en.yml
+- config/locales/fr.yml
+- i18n_date_range.gemspec
+- lib/i18n_date_range.rb
+- lib/i18n_date_range/i18n_date_range_generator.rb
+- lib/i18n_date_range/i18n_date_range_helper.rb
+- lib/i18n_date_range/version.rb
+homepage: https://github.com/noesya/i18n_date_range
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/noesya/i18n_date_range
+  source_code_uri: https://github.com/noesya/i18n_date_range
+  changelog_uri: https://github.com/noesya/i18n_date_range/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Add helper to display a date range
+test_files: []