temporalize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2a45701d98622972625f0e15be722dac7c443bbfda275c38fe2eb6207bd7ae3b
+  data.tar.gz: 3316eee94d60ef9c3ff4db29ec1b318c66a0355dcfce5cec3c94de3af2efde66
+SHA512:
+  metadata.gz: ba165539da06d5abddf7a200261e8609c4b860ef7954236c07a5374a45222a08254e6778ddbb0603bd2c56700f6f6902c209f93279740f07b32d94b3bdb996bb
+  data.tar.gz: a1ba1ed84dd502783a1f0925980e0318c6d7e1b330d7ef597998a7f7fca13bb55d65ebd9edd02990f39901f257b07d1709d241561dd9a27f2d2ae269a1ce1e57

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 pacMakaveli
+
+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,104 @@
+# Temporalize
+
+Temporalize provides a simple way to handle time durations in your Ruby applications. Whether you're dealing with video lengths, gameplay times, or any other duration data, Temporalize makes it easy to store, format, and display durations without the headache.
+
+# Why Temporalize?
+
+I created Temporalize while working on games.directory where we deal with tons of data from different game APIs. We kept running into the same problem - handling duration strings like "PT3H10M10S" from APIs, storing them efficiently in the database, and then formatting them nicely for display.
+Converting these strings, storing them as integers, and formatting them back was becoming a tedious copy-paste job across our models. Inspired by how money-rails elegantly handles currency with monetize :price, I wanted something similarly clean for durations - just temporalize :duration_played and you're done.
+
+# Features
+
+- Dead simple API - just one line to handle a duration attribute
+- Stores durations efficiently as integers (seconds or milliseconds)
+- Automatically handles conversion between different formats
+
+- Multiple output formats:
+
+  - Default timestamp ("01:30:45")
+  - Natural language ("1 hour 30 minutes 45 seconds")
+  - Custom formats
+
+- Plays nice with ActiveRecord
+- Handles both seconds and milliseconds
+- Zero dependencies (other than ActiveRecord)
+
+## Installation
+
+## Usage
+
+``` ruby
+class Game < ApplicationRecord
+  # Basic usage - assumes column name is duration_played_in_seconds
+  temporalize :duration_played
+
+  # Custom column name
+  temporalize :total_time, column: :play_time_seconds
+
+  # Handle millisecond precision
+  temporalize :watch_time, column: :watch_time_in_ms
+
+  # Custom format
+  temporalize :completion_time, format: :natural  # "2 hours 30 minutes"
+end
+
+game = Game.new(duration_played: 3665)  # or "PT1H1M5S" from an API
+game.duration_played.to_s  # => "01:01:05"
+```
+```ruby
+class Game < ApplicationRecord
+  temporalize :duration_played
+  temporalize :total_time, column: :play_time_seconds
+  temporalize :watch_time, column: :watch_time_in_ms, format: :natural
+end
+
+game = Game.new(duration_played: 3665)  # or "PT1H1M5S" from an API
+
+# Returns a Temporalize::Seconds object
+game.duration_played       # => #<Temporalize::Seconds:0x00007f9b8a8b0>
+
+# Get formatted strings
+game.duration_played.to_s  # => "01:01:05"
+
+# Different format options
+temporalize :duration_played, format: :natural
+game.duration_played.to_s  # => "1 hour 1 minute 5 seconds"
+
+temporalize :duration_played, format: :hh_mm_ss
+game.duration_played.to_s  # => "01:01:05"
+
+temporalize :duration_played, format: :compact
+game.duration_played.to_s  # => "1h 1m 5s"
+
+# Store in milliseconds
+temporalize :watch_time, column: :watch_time_in_ms
+game.watch_time = 1500              # 1.5 seconds
+game.watch_time.to_s                # => "00:00:01"
+game.watch_time_in_ms               # => 1500
+```
+The value is stored as an integer in your database but accessed through a Temporalize::Seconds object. This gives you the flexibility to:
+
+Store the raw value efficiently in your database
+Format it however you need in your views
+Do calculations with the raw seconds when needed
+Handle both second and millisecond precision
+
+This is especially useful when dealing with APIs that send duration data in various formats - you can normalize everything to integers in the database while maintaining a clean interface for displaying values to users.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/temporalize. 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]/temporalize/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Temporalize project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/temporalize/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/gemfiles/ruby_3.0.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gem "activerecord", "~> 7.0.0", "< 7.1"
+gem "activesupport", "~> 7.0.0", "< 7.1"
+gemspec path: ".."

data/gemfiles/ruby_3_plus.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gem "activerecord", ">= 7.0"
+gem "activesupport", ">= 7.0"
+gemspec path: ".."

data/lib/temporalize/configuration.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Temporalize
+  class Configuration
+    attr_accessor :default_format
+
+    def initialize
+      @default_format = Formats::DEFAULT
+    end
+  end
+end

data/lib/temporalize/formats.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Temporalize
+  module Formats
+    NATURAL = :natural  # Special format for human-readable output
+
+    DEFAULT = "%H:%M:%S".freeze
+    HH_MM_SS = "%H:%M:%S".freeze
+    HOURS_MINUTES = "%H:%M".freeze
+    MINUTES_SECONDS = "%M:%S".freeze
+    VERBOSE = "%H hours %M minutes %S seconds".freeze
+    COMPACT = "%Hh %Mm %Ss".freeze
+
+  end
+end

data/lib/temporalize/seconds.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Temporalize
+  class Seconds
+    attr_reader :seconds, :format_string, :milliseconds
+
+    def initialize(seconds, format_string = Formats::DEFAULT, milliseconds = nil)
+      @seconds = seconds.to_i.abs  # Handle negative values by taking absolute value
+      @format_string = resolve_format(format_string)
+      @milliseconds = milliseconds
+    end
+
+    def to_s(override_format = nil)
+      format_to_use = override_format ? resolve_format(override_format) : @format_string
+
+      case format_to_use
+      when :natural
+        to_natural
+      when :minutes_seconds
+        format_minutes_seconds
+      else
+        format_duration(format_to_use)
+      end
+    end
+
+    private
+
+    def format_duration(format_str)
+      time = Time.at(@seconds).utc
+      time.strftime(format_str)
+    end
+
+    def format_minutes_seconds
+      total_minutes = (@seconds / 60.0).floor
+      remaining_seconds = @seconds % 60
+      format("%02d:%02d", total_minutes, remaining_seconds)
+    end
+
+    def to_natural
+      parts = []
+
+      hours_val = hours
+      minutes_val = minutes
+      seconds_val = seconds_remainder
+
+      parts << "#{hours_val} #{hours_val == 1 ? 'hour' : 'hours'}" if hours_val > 0
+      parts << "#{minutes_val} #{minutes_val == 1 ? 'minute' : 'minutes'}" if minutes_val > 0
+      parts << "#{seconds_val} #{seconds_val == 1 ? 'second' : 'seconds'}" if seconds_val > 0 || parts.empty?
+
+      if @milliseconds && @milliseconds > 0
+        ms = @milliseconds % 1000
+        parts << "#{ms} milliseconds" if ms > 0
+      end
+
+      parts.join(' ')
+    end
+
+    def resolve_format(format)
+      case format
+      when Symbol
+        if format == :natural
+          :natural
+        elsif format == :minutes_seconds
+          :minutes_seconds
+        else
+          Formats.const_get(format.to_s.upcase)
+        end
+      else
+        format
+      end
+    end
+
+    def hours
+      @seconds / 3600
+    end
+
+    def minutes
+      (@seconds % 3600) / 60
+    end
+
+    def seconds_remainder
+      @seconds % 60
+    end
+  end
+end

data/lib/temporalize/version.rb

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

data/lib/temporalize.rb

@@ -0,0 +1,70 @@
+# lib/temporalize.rb
+# frozen_string_literal: true
+
+require_relative "temporalize/version"
+require_relative "temporalize/formats"
+require_relative "temporalize/configuration"
+require_relative "temporalize/seconds"
+
+module Temporalize
+  class Error < StandardError; end
+
+  def self.temporalize(klass, attribute, **options)
+    column = options[:column] || "#{attribute}_in_seconds".to_sym
+    default_format = options[:format] || configuration.default_format
+
+    # Enhanced column name detection
+    uses_milliseconds = if options.key?(:milliseconds)
+                          options[:milliseconds]
+                        else
+                          column_name = column.to_s
+                          column_name.end_with?('_in_milliseconds', '_in_ms', '_milliseconds', '_ms')
+                        end
+
+    klass.class_eval do
+      define_method(attribute) do |**opts|
+        value = read_attribute(column)
+        return nil if value.nil?
+
+        if uses_milliseconds
+          seconds = value / 1000
+          milliseconds = value % 1000
+          Temporalize::Seconds.new(seconds, opts[:format] || default_format, milliseconds)
+        else
+          Temporalize::Seconds.new(value, opts[:format] || default_format)
+        end
+      end
+
+      define_method("#{attribute}=") do |value|
+        numeric_value = case value
+                        when Temporalize::Seconds then value.seconds
+                        when Numeric
+                          if uses_milliseconds
+                            (value.to_f * 1000).to_i
+                          else
+                            value.to_i
+                          end
+                        when nil then return write_attribute(column, nil)
+                        else
+                          raise ArgumentError, "Invalid duration value: #{value.inspect}"
+                        end
+
+        value_to_store = if uses_milliseconds && value.is_a?(Temporalize::Seconds)
+                           numeric_value * 1000
+                         else
+                           numeric_value
+                         end
+
+        write_attribute(column, value_to_store)
+      end
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/sig/temporalize.rbs

@@ -0,0 +1,4 @@
+module Temporalize
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: temporalize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pacMakaveli
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: minitest-snapshots
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.35.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.21.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Provides a convenient way to work with attributes that store durations
+  in seconds, allowing for custom formatting and column names.
+email:
+- oss@studio51.solutions
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/ruby_3.0.gemfile
+- gemfiles/ruby_3_plus.gemfile
+- lib/temporalize.rb
+- lib/temporalize/configuration.rb
+- lib/temporalize/formats.rb
+- lib/temporalize/seconds.rb
+- lib/temporalize/version.rb
+- sig/temporalize.rbs
+homepage: https://github.com/yourusername/temporalize
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/yourusername/temporalize
+  source_code_uri: https://github.com/games-directory/temporalize
+  changelog_uri: https://github.com/games-directory/temporalize/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Handles attributes representing durations in seconds.
+test_files: []