active_record_in_time_scope 0.1.7

data/sig/active_record_in_time_scope.rbs

@@ -0,0 +1,95 @@
+# Type definitions for ActiveRecordInTimeScope gem
+
+module ActiveRecordInTimeScope
+  VERSION: String
+
+  # Base error class for ActiveRecordInTimeScope errors
+  class Error < StandardError
+  end
+
+  # Raised when a specified column does not exist on the table
+  class ColumnNotFoundError < Error
+  end
+
+  # Raised when the scope configuration is invalid
+  class ConfigurationError < Error
+  end
+
+  def self.included: (Class model) -> void
+
+  # Configuration options for start_at column
+  type start_at_config = {
+    ?column: Symbol?,
+    ?null: bool
+  }
+
+  # Configuration options for end_at column
+  type end_at_config = {
+    ?column: Symbol?,
+    ?null: bool
+  }
+
+  # Class methods added to ActiveRecord models when ActiveRecordInTimeScope is included
+  module ClassMethods
+    # Defines time-window scopes for the model
+    #
+    # @param scope_name [Symbol] The name of the scope (default: :in_time)
+    # @param start_at [Hash] Configuration for the start column
+    # @param end_at [Hash] Configuration for the end column
+    # @return [void]
+    # @raise [ColumnNotFoundError] When a specified column doesn't exist
+    # @raise [ConfigurationError] When the configuration is invalid (at scope call time)
+    def in_time_scope: (
+      ?Symbol scope_name,
+      ?start_at: start_at_config,
+      ?end_at: end_at_config
+    ) -> void
+
+    private
+
+    # Private implementation methods
+    # These use ActiveRecord internals and are typed as untyped for flexibility
+    def fetch_null_option: (untyped config, untyped column, untyped table_column_hash) -> untyped
+    def start_only_pattern?: (Symbol? start_at_column, Symbol? end_at_column) -> bool
+    def end_only_pattern?: (Symbol? start_at_column, Symbol? end_at_column) -> bool
+    def define_scope_methods: (String suffix, start_at_column: untyped, start_at_null: untyped, end_at_column: untyped, end_at_null: untyped) -> void
+    def define_error_scope_and_method: (String suffix, String message) -> void
+    def define_start_only_scope: (String suffix, Symbol column) -> void
+    def define_latest_one_scope: (String suffix, Symbol column) -> void
+    def define_earliest_one_scope: (String suffix, Symbol column) -> void
+    def define_end_only_scope: (String suffix, Symbol column) -> void
+    def define_full_scope: (String suffix, Symbol start_column, untyped start_null, Symbol end_column, untyped end_null) -> void
+    def define_instance_method: (String suffix, Symbol? start_column, untyped start_null, Symbol? end_column, untyped end_null) -> void
+    def define_before_scope: (String suffix, Symbol? start_column, untyped start_null) -> void
+    def define_after_scope: (String suffix, Symbol? end_column, untyped end_null) -> void
+    def define_out_of_time_scope: (String suffix) -> void
+  end
+end
+
+# Generated scope methods (dynamically defined)
+# When you call `in_time_scope` on a model, it creates these methods:
+#
+# Class methods (primary - records in time window):
+#   Model.in_time(time = Time.current) -> ActiveRecord::Relation
+#   Model.in_time_<name>(time = Time.current) -> ActiveRecord::Relation  (for named scopes)
+#   Model.latest_in_time(foreign_key, time = Time.current) -> ActiveRecord::Relation  (start-only/end-only)
+#   Model.earliest_in_time(foreign_key, time = Time.current) -> ActiveRecord::Relation (start-only/end-only)
+#
+# Class methods (inverse - records outside time window):
+#   Model.before_in_time(time = Time.current) -> ActiveRecord::Relation  (not yet started)
+#   Model.after_in_time(time = Time.current) -> ActiveRecord::Relation   (already ended)
+#   Model.out_of_time(time = Time.current) -> ActiveRecord::Relation     (before OR after)
+#
+# Instance methods (primary):
+#   model.in_time?(time = Time.current) -> bool
+#   model.in_time_<name>?(time = Time.current) -> bool  (for named scopes)
+#
+# Instance methods (inverse):
+#   model.before_in_time?(time = Time.current) -> bool
+#   model.after_in_time?(time = Time.current) -> bool
+#   model.out_of_time?(time = Time.current) -> bool
+
+# Extend ActiveRecord::Base to include ActiveRecordInTimeScope
+class ActiveRecord::Base
+  extend ActiveRecordInTimeScope::ClassMethods
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: active_record_in_time_scope
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- kyohah
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: irb
+  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: 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: rbs
+  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: rspec
+  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
+  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: sqlite3
+  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: steep
+  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: timecop
+  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: yard
+  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: ActiveRecordInTimeScope provides time-window scopes for ActiveRecord
+  models.
+email:
+- 3257272+kyohah@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rulesync/commands/translate-readme.md"
+- ".rulesync/rules/project.md"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- docs/book.toml
+- docs/de/SUMMARY.md
+- docs/de/index.md
+- docs/de/point-system.md
+- docs/de/user-name-history.md
+- docs/fr/SUMMARY.md
+- docs/fr/index.md
+- docs/fr/point-system.md
+- docs/fr/user-name-history.md
+- docs/ja/SUMMARY.md
+- docs/ja/index.md
+- docs/ja/point-system.md
+- docs/ja/user-name-history.md
+- docs/src/SUMMARY.md
+- docs/src/index.md
+- docs/src/point-system.md
+- docs/src/user-name-history.md
+- docs/zh/SUMMARY.md
+- docs/zh/index.md
+- docs/zh/point-system.md
+- docs/zh/user-name-history.md
+- lib/active_record_in_time_scope.rb
+- lib/active_record_in_time_scope/class_methods.rb
+- lib/active_record_in_time_scope/version.rb
+- mise.toml
+- rbs_collection.yaml
+- rulesync.jsonc
+- sig/active_record_in_time_scope.rbs
+homepage: https://github.com/kyohah/active_record_in_time_scope
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/kyohah/active_record_in_time_scope
+  source_code_uri: https://github.com/kyohah/active_record_in_time_scope
+  changelog_uri: https://github.com/kyohah/active_record_in_time_scope/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 4.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.7
+specification_version: 4
+summary: Add time-window scopes to ActiveRecord models
+test_files: []