active_date_range 0.1.0

data/lib/active_date_range/humanizer.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "active_date_range/i18n"
+
+module ActiveDateRange
+  # Translates a <tt>DateRange</tt> to a human readable format. Localization and translations are
+  # handled by I18n.
+  #
+  # Valid <tt>format</tt> parameters:
+  # - <tt>short</tt> (default): Jan 1, 2021 - Jan 15, 2021
+  # - <tt>long</tt>: January 12, 2021 - January 15, 2021
+  # - <tt>relative</tt>: when available, returns a relative translation like "this month" or "next year".
+  # - <tt>explicit</tt>: never shortens a <tt>short</tt> or <tt>long</tt> format (see below)
+  #
+  # Unless you use the <tt>:explicit</tt> format, the translation is as short as possible:
+  #
+  #   DateRange.parse("20210101..20210101").humanize # => "Jan 1, 2021"
+  #   DateRange.parse("20210101..20210115").humanize # => "Jan 1 - Jan 15, 2021"
+  #   DateRange.parse("20210101..20220115").humanize # => "Jan 1 2021 - Jan 15, 2022"
+  #   DateRange.parse("202101..202101").humanize # => "Jan 2021"
+  #   DateRange.parse("202101..202102").humanize # => "Jan - Feb 2021"
+  #   DateRange.parse("202101..202202").humanize # => "Jan 2021 - Feb 2022"
+  #   DateRange.parse("202101..202103").humanize # => "Q1 2021"
+  #   DateRange.parse("202101..202106").humanize # => "Q1 - Q2 2021"
+  #   DateRange.parse("202101..202206").humanize # => "Q1 2021 - Q2 2022"
+  #   DateRange.parse("202101..202112").humanize # => "2021"
+  #   DateRange.parse("202101..202212").humanize # => "2021 - 2021"
+  #
+  # Translations and formats are completely customizable through <tt>I18n</tt>, see
+  # <tt>locales/en.yml</tt> for an overview of translatable keys.
+  class Humanizer
+    attr_reader :date_range, :format
+
+    FORMATS = %i[short long relative explicit]
+
+    def initialize(date_range, format: :short)
+      @date_range = date_range
+      raise ArgumentError, "Unknown format #{format} for humanize, valid formats: #{FORMATS.join(", ")}" unless FORMATS.include?(format)
+
+      @format = format
+    end
+
+    def humanize
+      return day_range if format == :explicit
+
+      if format == :relative
+        return relative if date_range.relative_param
+
+        @format = :short
+      end
+
+      one_day || year || quarter || month || day_range
+    end
+
+    private
+      def relative
+        I18n.translate(date_range.relative_param, scope: %i[date relative_range])
+      end
+
+      def one_day
+        return unless date_range.days == 1
+
+        I18n.localize(date_range.begin, format: :"#{format}_day")
+      end
+
+      def year
+        return unless date_range.full_year? || format == :explicit
+
+        if date_range.one_year?
+          date_range.begin.year.to_s
+        else
+          range(date_range.begin.year, date_range.end.year)
+        end
+      end
+
+      def quarter
+        return unless date_range.full_quarter? || format == :explicit
+
+        if date_range.one_quarter?
+          I18n.translate(
+            "#{format}_quarter",
+            scope: :date, quarter: "#{date_range.begin.quarter} #{date_range.begin.year}"
+          )
+        else
+          begin_quarter = if date_range.same_year?
+            date_range.begin.quarter
+          else
+            "#{date_range.begin.quarter} #{date_range.begin.year}"
+          end
+
+          range(
+            I18n.translate("#{format}_quarter", scope: :date, quarter: begin_quarter),
+            I18n.translate(
+              "#{format}_quarter",
+              scope: :date, quarter: "#{date_range.end.quarter} #{date_range.end.year}"
+            )
+          )
+        end
+      end
+
+      def month
+        return unless date_range.one_month?
+
+        I18n.localize(date_range.begin, format: :"#{format}_month")
+      end
+
+      def day_range
+        month_format = date_range.full_month? ? "month" : "day_month"
+        abbr = "abbr_" if date_range.same_year?
+
+        range(
+          I18n.localize(date_range.begin, format: :"#{abbr}#{format}_#{month_format}"),
+          I18n.localize(date_range.end, format: :"#{format}_#{month_format}")
+        )
+      end
+
+      def range(range_begin, range_end)
+        I18n.translate(:range, scope: :date, begin: range_begin, end: range_end)
+      end
+  end
+end

data/lib/active_date_range/i18n.rb

@@ -0,0 +1,9 @@
+begin
+  require "i18n"
+  require "i18n/backend/fallbacks"
+rescue LoadError => e
+  $stderr.puts "The i18n gem is not available. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+I18n.load_path << File.expand_path("locale/en.yml", __dir__)

data/lib/active_date_range/locale/en.yml

@@ -0,0 +1,38 @@
+en:
+  date:
+    formats:
+      abbr_explicit_day_month: "%b %d"
+      abbr_explicit_month: "%B"
+      abbr_long_day_month: "%B %d"
+      abbr_long_month: "%B"
+      abbr_short_day_month: "%b %d"
+      abbr_short_month: "%b"
+      default: "%Y-%m-%d"
+      explicit_day: "%b %d, %Y"
+      explicit_day_month: "%b %d, %Y"
+      explicit_month: "%B %Y"
+      explicit_year: "%B %Y"
+      long: "%B %d, %Y"
+      long_day: "%B %d, %Y"
+      long_day_month: "%B %d, %Y"
+      long_month: "%B %Y"
+      month: "%B"
+      short: "%b %d"
+      short_day: "%b %d, %Y"
+      short_day_month: "%b %d, %Y"
+      short_month: "%b %Y"
+      short_year: "%y"
+    relative_range:
+      next_month: "next month"
+      next_quarter: "next quarter"
+      next_year: "next year"
+      prev_month: "the previous month"
+      prev_quarter: "the previous quarter"
+      prev_year: "the previous year"
+      this_month: "this month"
+      this_quarter: "this quarter"
+      this_year: "this year"
+      today: "today"
+    long_quarter: "quarter %{quarter}"
+    short_quarter: "Q%{quarter}"
+    range: "%{begin} - %{end}"

data/lib/active_date_range/version.rb

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: active_date_range
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edwin Vlieg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveDateRange provides a range of dates with a powerful API to manipulate
+  and use date ranges in your software.
+email:
+- edwin@moneybird.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- active_date_range.gemspec
+- bin/console
+- bin/setup
+- lib/active_date_range.rb
+- lib/active_date_range/core_ext/date.rb
+- lib/active_date_range/core_ext/integer.rb
+- lib/active_date_range/date_range.rb
+- lib/active_date_range/humanizer.rb
+- lib/active_date_range/i18n.rb
+- lib/active_date_range/locale/en.yml
+- lib/active_date_range/version.rb
+homepage: https://github.com/moneybird/active-date-range
+licenses: []
+metadata:
+  homepage_uri: https://github.com/moneybird/active-date-range
+  source_code_uri: https://github.com/moneybird/active-date-range
+  changelog_uri: https://github.com/moneybird/active-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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: DateRange for ActiveSupport
+test_files: []