sunsetter 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37ced06e05303260aca17b9069cbf72def556def83b02c1cd5891b799b15a59e
+  data.tar.gz: e4fb09c5a8cb291a846d2de0933fc80ec6f37706fb826c66b4b30148fad41348
+SHA512:
+  metadata.gz: c81149f87e7d951873bc5de6e4fda8db50c18c4b5204e75358867d12af197f5f1d0144fc0a80ad81180846e7f49f5219db08a550f9bd4fa6520a0fba8d630780
+  data.tar.gz: 93699a34b63a885c8ea55241c50a74d8f7d5caa2dca48b6fef0babffc74fc688301f91bc7bbf70ddb3db7bd634669c3af7cfc95a4df64ff290b4679ddfdd7199

data/.standard.yml

@@ -0,0 +1,3 @@
+parallel: true
+format: progress
+fix: true 

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [v0.1.2]
+
+### Added
+- Initial release of Sunsetter gem
+- Support for marking Mongoid fields as deprecated
+- Customizable deprecation warning messages
+- Logger configuration support
+- Mongoid model validation 
+
+## [Unreleased]

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "mongoid"
+gem "minitest"
+gem "ostruct"
+
+group :development do
+  gem "standard", "~> 1.0"
+  gem "rake", "~> 13.0"
+end

data/Gemfile.lock

@@ -0,0 +1,100 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (8.0.2)
+      activesupport (= 8.0.2)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    bson (5.0.2)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    drb (2.2.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.10.2)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    mongo (2.21.1)
+      base64
+      bson (>= 4.14.1, < 6.0.0)
+    mongoid (9.0.6)
+      activemodel (>= 5.1, < 8.1, != 7.0.0)
+      concurrent-ruby (>= 1.0.5, < 2.0)
+      mongo (>= 2.18.0, < 3.0.0)
+    ostruct (0.6.1)
+    parallel (1.26.3)
+    parser (3.3.7.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.73.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.42.0)
+      parser (>= 3.3.7.2)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    standard (1.47.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.73.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.7)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.7.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.24.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  minitest
+  mongoid
+  ostruct
+  rake (~> 13.0)
+  standard (~> 1.0)
+
+BUNDLED WITH
+   2.6.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ryoh827
+
+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,106 @@
+# Sunsetter
+
+[![Gem Version](https://badge.fury.io/rb/sunsetter.svg)](https://badge.fury.io/rb/sunsetter)
+[![Build Status](https://github.com/ryoh827/sunsetter/actions/workflows/ci.yml/badge.svg)](https://github.com/ryoh827/sunsetter/actions/workflows/ci.yml)
+
+A Ruby gem that helps you mark Mongoid model fields as deprecated and display warning messages when they are used.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sunsetter'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sunsetter
+```
+
+## Usage
+
+To mark a field as deprecated in your Mongoid model:
+
+```ruby
+class User
+  include Mongoid::Document
+  include Sunsetter
+
+  field :old_name
+  field :new_name
+  deprecate_field :old_name
+end
+```
+
+When the deprecated field is accessed, you'll see warning messages like this:
+
+```
+[SUNSETTER] User#old_name is deprecated and will be removed in a future version.
+[SUNSETTER] Called from: app/models/user.rb:42:in `some_method'
+[SUNSETTER] Please update your code to use alternative methods.
+```
+
+### Customizing Log Output
+
+You can customize how deprecation warnings are logged:
+
+```ruby
+# In Rails, you might want to use Rails.logger
+Sunsetter.configure do |config|
+  config.logger = ->(message) { Rails.logger.warn(message) }
+end
+
+# Or use your own logger
+Sunsetter.configure do |config|
+  config.logger = ->(message) { MyLogger.warn(message) }
+end
+
+# Or suppress warnings entirely
+Sunsetter.configure do |config|
+  config.logger = ->(message) { } # no-op
+end
+```
+
+## Features
+
+- Displays warnings when deprecated fields are accessed
+- Shows caller information (file name and line number)
+- Prevents usage in non-Mongoid::Document models
+- Implementation is independent of include order
+- Customizable logging behavior
+
+## Development
+
+### Setup
+
+```bash
+$ git clone https://github.com/ryoh827/sunsetter.git
+$ cd sunsetter
+$ bundle install
+```
+
+### Running Tests
+
+```bash
+$ bundle exec ruby test/test_sunsetter.rb
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request 

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/sunsetter/version.rb

@@ -0,0 +1,3 @@
+module Sunsetter
+  VERSION = "0.1.2"
+end

data/lib/sunsetter.rb

@@ -0,0 +1,36 @@
+module Sunsetter
+  class << self
+    attr_accessor :logger
+
+    def configure
+      yield self
+    end
+  end
+
+  # デフォルトのロガー
+  self.logger = ->(message) { warn message }
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def deprecate_field(*field_names)
+      unless include?(Mongoid::Document)
+        raise "Sunsetter can only be used in Mongoid::Document models"
+      end
+
+      field_names.each do |field_name|
+        original_method = instance_method(field_name)
+
+        define_method(field_name) do |*args, &block|
+          caller_info = caller(1..1).first
+          Sunsetter.logger.call("[SUNSETTER] #{self.class.name}##{field_name} is deprecated and will be removed in a future version.")
+          Sunsetter.logger.call("[SUNSETTER] Called from: #{caller_info}")
+          Sunsetter.logger.call("[SUNSETTER] Please update your code to use alternative methods.")
+          original_method.bind_call(self, *args, &block)
+        end
+      end
+    end
+  end
+end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4"

data/sunsetter.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/sunsetter/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sunsetter"
+  spec.version = Sunsetter::VERSION
+  spec.authors = ["ryoh827"]
+  spec.email = ["ryoh827.dev@gmail.com"]
+
+
+  spec.summary       = "A gem to mark Mongoid fields as deprecated with warning messages"
+  spec.description   = "Sunsetter provides a simple way to mark Mongoid fields as deprecated and show warning messages when they are accessed."
+  spec.homepage      = "https://github.com/ryoh827/sunsetter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  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)}) || f.match(/\.gem$/)
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mongoid", ">= 7.0.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "ostruct", "~> 0.5.0"
+  spec.add_development_dependency "standard", "~> 1.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: sunsetter
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- ryoh827
+bindir: exe
+cert_chain: []
+date: 2025-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+description: Sunsetter provides a simple way to mark Mongoid fields as deprecated
+  and show warning messages when they are accessed.
+email:
+- ryoh827.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sunsetter.rb
+- lib/sunsetter/version.rb
+- mise.toml
+- sunsetter.gemspec
+homepage: https://github.com/ryoh827/sunsetter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ryoh827/sunsetter
+  source_code_uri: https://github.com/ryoh827/sunsetter
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A gem to mark Mongoid fields as deprecated with warning messages
+test_files: []