enum_label 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d800732afc90ddb02ef79efe26fcd49abf77845c3b2f4765f624096a46e399d
+  data.tar.gz: 47a0d6b03f26ba883b91074727f0afcb9e8d1dc3d110bfc474b9c481a18f7ecf
+SHA512:
+  metadata.gz: 7f753ebfa6239f5f121499ba1bfc8ac0e239c31a6b020e22a9258e1f2433efbd4535fd80aaaf14c85e007ca5ba022b6f71bd0bcb50f40faacf509e7d5dfbde96
+  data.tar.gz: 417b89a7d11ace9a3edcc3b1964253df2d30d6b425d31679c57d1616c4a78fb744f74b94d0b267c0ede72ae1c9368f8ff14a9637439781f1bb64c4acdd973ecd

data/README.md

@@ -0,0 +1,73 @@
+# EnumLabel
+
+Rails の enum に人間が読めるラベルを簡単に付けられる gem です。
+
+日本語はもちろん、どの言語のラベルでも使えます。
+
+## Installation
+
+```ruby
+# Gemfile
+gem "enum_label"
+```
+
+```bash
+bundle install
+```
+
+## Usage
+
+```ruby
+class Article < ApplicationRecord
+  enum :status, { draft: 0, published: 1, archived: 2 }
+  enum_label :status, draft: "下書き", published: "公開済み", archived: "アーカイブ"
+end
+```
+
+### Instance method
+
+```ruby
+article = Article.new(status: :draft)
+article.status_label  #=> "下書き"
+
+article.status = :published
+article.status_label  #=> "公開済み"
+```
+
+### Class method
+
+```ruby
+Article.status_labels
+#=> { "draft" => "下書き", "published" => "公開済み", "archived" => "アーカイブ" }
+```
+
+セレクトボックスにそのまま使えます:
+
+```erb
+<%= f.select :status, Article.status_labels.invert %>
+```
+
+### Multiple enums
+
+```ruby
+class Article < ApplicationRecord
+  enum :status, { draft: 0, published: 1, archived: 2 }
+  enum_label :status, draft: "下書き", published: "公開済み", archived: "アーカイブ"
+
+  enum :visibility, { visible: 0, hidden: 1 }
+  enum_label :visibility, visible: "公開", hidden: "非公開"
+end
+
+article = Article.new(status: :draft, visibility: :hidden)
+article.status_label      #=> "下書き"
+article.visibility_label  #=> "非公開"
+```
+
+## Requirements
+
+- Ruby >= 3.2
+- Rails >= 7.0
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/enum_label/version.rb

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

data/lib/enum_label.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "enum_label/version"
+require "active_support/concern"
+
+module EnumLabel
+  extend ActiveSupport::Concern
+
+  class Error < StandardError; end
+
+  class_methods do
+    # Define human-readable labels for an enum attribute.
+    #
+    #   class Article < ApplicationRecord
+    #     enum :status, { draft: 0, published: 1, archived: 2 }
+    #     enum_label :status, draft: "下書き", published: "公開済み", archived: "アーカイブ"
+    #   end
+    #
+    #   article = Article.new(status: :draft)
+    #   article.status_label  #=> "下書き"
+    #   Article.status_labels #=> { "draft" => "下書き", "published" => "公開済み", "archived" => "アーカイブ" }
+    #
+    def enum_label(attribute, labels = {})
+      labels_map = labels.transform_keys(&:to_s).freeze
+      attribute = attribute.to_sym
+
+      # Store labels on the class for introspection
+      singleton_class.module_eval do
+        define_method(:"#{attribute}_labels") do
+          labels_map
+        end
+      end
+
+      # Instance method: article.status_label
+      define_method(:"#{attribute}_label") do
+        value = send(attribute)
+        labels_map[value.to_s] if value
+      end
+    end
+  end
+end
+
+# Auto-include into ActiveRecord if available
+ActiveSupport.on_load(:active_record) do
+  include EnumLabel
+end

data/sig/enum_label.rbs

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

data/spec/enum_label_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe EnumLabel do
+  it "has a version number" do
+    expect(EnumLabel::VERSION).not_to be_nil
+  end
+
+  describe "#status_label" do
+    it "returns the correct label" do
+      article = Article.new(status: :draft)
+      expect(article.status_label).to eq "下書き"
+    end
+
+    it "returns the updated label after change" do
+      article = Article.new(status: :draft)
+      article.status = :published
+      expect(article.status_label).to eq "公開済み"
+    end
+
+    it "returns the label for each enum value" do
+      expect(Article.new(status: :draft).status_label).to eq "下書き"
+      expect(Article.new(status: :published).status_label).to eq "公開済み"
+      expect(Article.new(status: :archived).status_label).to eq "アーカイブ"
+    end
+
+    it "returns nil when attribute is nil" do
+      article = Article.new
+      article[:status] = nil
+      expect(article.status_label).to be_nil
+    end
+  end
+
+  describe ".status_labels" do
+    it "returns all labels as a hash" do
+      expected = { "draft" => "下書き", "published" => "公開済み", "archived" => "アーカイブ" }
+      expect(Article.status_labels).to eq expected
+    end
+
+    it "returns a frozen hash" do
+      expect(Article.status_labels).to be_frozen
+    end
+  end
+
+  describe "multiple enums" do
+    it "supports multiple enum_label on the same model" do
+      article = Article.new(status: :draft, visibility: :hidden)
+      expect(article.status_label).to eq "下書き"
+      expect(article.visibility_label).to eq "非公開"
+    end
+
+    it "returns class-level labels for each enum" do
+      expect(Article.visibility_labels).to eq({ "visible" => "公開", "hidden" => "非公開" })
+    end
+  end
+
+  describe "persisted record" do
+    it "returns the label after reload" do
+      article = Article.create!(status: :published, visibility: :visible)
+      reloaded = Article.find(article.id)
+      expect(reloaded.status_label).to eq "公開済み"
+      expect(reloaded.visibility_label).to eq "公開"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "enum_label"
+
+# In-memory SQLite database for testing
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+ActiveRecord::Schema.define do
+  create_table :articles, force: true do |t|
+    t.integer :status, default: 0, null: false
+    t.integer :visibility, default: 0, null: false
+  end
+end
+
+class Article < ActiveRecord::Base
+  enum :status, { draft: 0, published: 1, archived: 2 }
+  enum_label :status, draft: "下書き", published: "公開済み", archived: "アーカイブ"
+
+  enum :visibility, { visible: 0, hidden: 1 }
+  enum_label :visibility, visible: "公開", hidden: "非公開"
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: enum_label
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- aluto144
+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: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Easily add human-readable labels (Japanese, English, etc.) to your Rails
+  enum attributes with a simple DSL.
+email:
+- attwelve@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/enum_label.rb
+- lib/enum_label/version.rb
+- sig/enum_label.rbs
+- spec/enum_label_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aluto12/enum_label
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/aluto12/enum_label
+  source_code_uri: https://github.com/aluto12/enum_label
+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.9
+specification_version: 4
+summary: Human-readable labels for Rails enums
+test_files: []