rails-diff-time 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be36e9c0f9c1bc6a0566f4a346b4106196028880c654497dab69d32730c17091
+  data.tar.gz: 65097dbff040d4f111dacbc1c823324af51f3bcfefaeb9f01fd16a2c34b2e2f2
+SHA512:
+  metadata.gz: 88326fa6a91bd65e87e8998e88cd7d2d581f96d75c237221089f0c8153f8e12a7a6b1839400ce4a66780a83abd815d351e3765574fb14d89fffa170e3f3e265f
+  data.tar.gz: f98c3a29233b51ec321c1d473f128d0fd918a0570c7acb34c7681c583154f65ca9ac67207bc22d244ed8493de4ddd4aeda26da7502439c9d593ef948935ecdb5

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  TargetRubyVersion: 3.4.5
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# メトリクス系のルールをオプトアウト
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-10-19
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 dhq_boiler
+
+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,68 @@
+# Rails::Diff::Time
+
+A Rails helper gem to display time differences in a human-readable format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-diff-time'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-diff-time
+
+## Usage
+
+In your Rails views, you can use the `diff_time` helper to display time differences:
+
+```erb
+<%= diff_time(Time.now + 3.days) %>
+# Output: <span>3 days later</span>
+
+<%= diff_time(Time.now - 2.hours) %>
+# Output: <span>2 hours ago</span>
+
+<%= diff_time(Time.now + 1.year + 2.months, "div", class: "time-diff") %>
+# Output: <div class="time-diff">1 year 2 months later</div>
+```
+
+### Parameters
+
+- `certain_time` (required): The time to compare with the current time
+- `element_name` (optional, default: "span"): The HTML element to wrap the output
+- `attributes` (optional, default: {}): HTML attributes to add to the element
+
+## Examples
+
+```erb
+# Simple usage
+<%= diff_time(user.created_at) %>
+
+# Custom element
+<%= diff_time(event.starts_at, "p") %>
+
+# With CSS classes
+<%= diff_time(post.published_at, "span", class: "text-muted", id: "post-time") %>
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dhq_boiler/rails-diff-time.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

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/app/views/rails-diff-time/_diff_time.html.erb

@@ -0,0 +1,5 @@
+<%
+  element_name ||= "span"
+  attributes ||= {}
+%>
+<%= content_tag(element_name.to_sym, diff_time, attributes) %>

data/lib/rails/diff/time/helpers.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module RailsDiffTime
+  # Helper methods for displaying time differences in a human-readable format.
+  #
+  # This module provides methods to format time differences as relative strings
+  # (e.g., "2 hours ago", "3 days later") and integrates with Rails views.
+  # The helpers can be used directly in templates or through the provided
+  # render helper method.
+  #
+  # @example Usage in a Rails view
+  #   <%= diff_time(user.created_at) %>
+  #   <%= diff_time(event.start_time, "div", class: "timestamp") %>
+  module Helpers
+    def diff_time(certain_time, element_name = "span", attributes = {})
+      render "rails-diff-time/diff_time", locals: {
+        diff_time: diff_time_str(certain_time),
+        element_name: element_name,
+        attributes: attributes
+      }
+    end
+
+    private
+
+    def diff_time_str(certain_time)
+      now = ::Time.now
+      diff = certain_time - now
+      difference_in_seconds = diff.abs
+
+      # Display "now" if within 5 seconds
+      return "now" if difference_in_seconds <= 5
+
+      case difference_in_seconds
+      when year_threshold..Float::INFINITY
+        format_years difference_in_seconds, diff
+      when month_threshold...year_threshold
+        format_months difference_in_seconds, diff
+      when week_threshold...month_threshold
+        format_weeks difference_in_seconds, diff
+      when day_threshold...week_threshold
+        format_days difference_in_seconds, diff
+      when hour_threshold...day_threshold
+        format_hours difference_in_seconds, diff
+      when minute_threshold...hour_threshold
+        format_minutes difference_in_seconds, diff
+      else
+        format_seconds difference_in_seconds, diff
+      end
+    end
+
+    def format_years(difference_in_seconds, diff)
+      years = (difference_in_seconds / year_in_seconds).floor
+      remaining_seconds = difference_in_seconds - (years * year_in_seconds)
+
+      if remaining_seconds >= month_in_seconds
+        months = (remaining_seconds / month_in_seconds).floor
+        remaining_seconds -= months * month_in_seconds
+
+        if remaining_seconds >= day_in_seconds
+          days = (remaining_seconds / day_in_seconds).floor
+          "#{time_str(years, "year")} #{time_str(months, "month")} #{time_str(days, "day")} #{ago_or_later(diff)}"
+        else
+          "#{time_str(years, "year")} #{time_str(months, "month")} #{ago_or_later(diff)}"
+        end
+      else
+        "#{time_str(years, "year")} #{ago_or_later(diff)}"
+      end
+    end
+
+    def format_months(difference_in_seconds, diff)
+      months = (difference_in_seconds / month_in_seconds).floor
+      remaining_seconds = difference_in_seconds - (months * month_in_seconds)
+
+      if remaining_seconds >= day_in_seconds
+        days = (remaining_seconds / day_in_seconds).floor
+        "#{time_str(months, "month")} #{time_str(days, "day")} #{ago_or_later(diff)}"
+      else
+        "#{time_str(months, "month")} #{ago_or_later(diff)}"
+      end
+    end
+
+    def format_weeks(difference_in_seconds, diff)
+      weeks = (difference_in_seconds / week_in_seconds).floor
+      "#{time_str(weeks, "week")} #{ago_or_later(diff)}"
+    end
+
+    def format_days(difference_in_seconds, diff)
+      days = (difference_in_seconds / day_in_seconds).floor
+      "#{time_str(days, "day")} #{ago_or_later(diff)}"
+    end
+
+    def format_hours(difference_in_seconds, diff)
+      hours = (difference_in_seconds / hour_in_seconds).floor
+      remaining_seconds = difference_in_seconds - (hours * hour_in_seconds)
+
+      if remaining_seconds >= minute_in_seconds
+        minutes = (remaining_seconds / minute_in_seconds).floor
+        "#{time_str(hours, "hour")} #{time_str(minutes, "minute")} #{ago_or_later(diff)}"
+      else
+        "#{time_str(hours, "hour")} #{ago_or_later(diff)}"
+      end
+    end
+
+    def format_minutes(difference_in_seconds, diff)
+      minutes = (difference_in_seconds / minute_in_seconds).floor
+      remaining_seconds = difference_in_seconds - (minutes * minute_in_seconds)
+
+      if remaining_seconds.positive?
+        seconds = remaining_seconds.floor
+        "#{time_str(minutes, "minute")} #{time_str(seconds, "second")} #{ago_or_later(diff)}"
+      else
+        "#{time_str(minutes, "minute")} #{ago_or_later(diff)}"
+      end
+    end
+
+    def format_seconds(difference_in_seconds, diff)
+      seconds = difference_in_seconds.floor
+      "#{time_str(seconds, "second")} #{ago_or_later(diff)}"
+    end
+
+    # Time unit constant methods
+    def year_in_seconds
+      365.25 * 24 * 3600 # Considering leap years
+    end
+
+    def month_in_seconds
+      30 * 24 * 3600 # Average 30 days
+    end
+
+    def week_in_seconds
+      7 * 24 * 3600
+    end
+
+    def day_in_seconds
+      24 * 3600
+    end
+
+    def hour_in_seconds
+      3600
+    end
+
+    def minute_in_seconds
+      60
+    end
+
+    # Threshold methods
+    def year_threshold
+      year_in_seconds
+    end
+
+    def month_threshold
+      month_in_seconds
+    end
+
+    def week_threshold
+      week_in_seconds
+    end
+
+    def day_threshold
+      day_in_seconds
+    end
+
+    def hour_threshold
+      hour_in_seconds
+    end
+
+    def minute_threshold
+      minute_in_seconds
+    end
+
+    def ago_or_later(diff_seconds)
+      diff_seconds.negative? ? "ago" : "later"
+    end
+
+    def time_str(count, singular)
+      "#{count} #{count == 1 ? singular : singular.pluralize}"
+    end
+  end
+end

data/lib/rails/diff/time/version.rb

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

data/lib/rails/diff/time.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "time/version"
+require_relative "time/helpers"
+
+module RailsDiffTime
+  class Error < StandardError; end
+
+  # Define Engine class only when Rails::Engine is available
+  if defined?(::Rails::Engine)
+    # Rails engine for integrating RailsDiffTime into Rails applications.
+    #
+    # This engine automatically includes the time difference helpers into
+    # ActionView, making them available in all views and templates.
+    class Engine < ::Rails::Engine
+      isolate_namespace RailsDiffTime
+
+      initializer "rails_diff_time.helpers" do
+        ActiveSupport.on_load(:action_view) do
+          include RailsDiffTime::Helpers
+        end
+      end
+    end
+  end
+end

data/sig/rails/diff/time.rbs

@@ -0,0 +1,38 @@
+module RailsDiffTime
+  VERSION: String
+
+  module Helpers
+    def diff_time: (Time certain_time, ?String element_name, ?Hash[Symbol, untyped] attributes) -> String
+
+    private
+
+    def diff_time_str: (Time certain_time) -> String
+    def format_years: (Float difference_in_seconds, Float diff) -> String
+    def format_months: (Float difference_in_seconds, Float diff) -> String
+    def format_weeks: (Float difference_in_seconds, Float diff) -> String
+    def format_days: (Float difference_in_seconds, Float diff) -> String
+    def format_hours: (Float difference_in_seconds, Float diff) -> String
+    def format_minutes: (Float difference_in_seconds, Float diff) -> String
+    def format_seconds: (Float difference_in_seconds, Float diff) -> String
+    def year_in_seconds: () -> Float
+    def month_in_seconds: () -> Float
+    def week_in_seconds: () -> Float
+    def day_in_seconds: () -> Float
+    def hour_in_seconds: () -> Float
+    def minute_in_seconds: () -> Float
+    def year_threshold: () -> Float
+    def month_threshold: () -> Float
+    def week_threshold: () -> Float
+    def day_threshold: () -> Float
+    def hour_threshold: () -> Float
+    def minute_threshold: () -> Float
+    def ago_or_later: (Float diff_seconds) -> String
+    def time_str: (Integer count, String singular) -> String
+  end
+
+  class Error < StandardError
+  end
+
+  class Engine < Rails::Engine
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: rails-diff-time
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dhq_boiler
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: A Rails gem that provides helper methods to display time differences
+  in a human-readable format (e.g., '2 hours ago', '3 days later'). Integrates seamlessly
+  with Rails views and supports various time units from seconds to years.
+email:
+- dhq_boiler@live.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/rails-diff-time/_diff_time.html.erb
+- lib/rails/diff/time.rb
+- lib/rails/diff/time/helpers.rb
+- lib/rails/diff/time/version.rb
+- sig/rails/diff/time.rbs
+homepage: https://github.com/dhq-boiler/rails-diff-time
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dhq-boiler/rails-diff-time
+  source_code_uri: https://github.com/dhq-boiler/rails-diff-time
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rails helper for displaying human-readable time differences
+test_files: []