yummy-guide-generic-administrate 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a6c5ac8336b23dfbac722bbf45ff6b9e2da1f92df3a9735d141d6f87cdf4785
-  data.tar.gz: a9e60712757ed858f26e6a14ea3a012898f4b52a146bdc777f6fd1691a82d244
+  metadata.gz: 387008d1b76513f348890946b449fcc46cdbb4ed61f594378786288baf0e74b7
+  data.tar.gz: 672c758ae345bcee1b7726e41bca7f6e7d77b9b5d2f52896ffd5514095d96cf6
 SHA512:
-  metadata.gz: d859073ea2ca3675c5ca819b451c3c0236407bbb05071ed2291795d811332e53b7daaf15beb715d27e238c872c6001fd3fbcc502d17943ebdcd21da456a39901
-  data.tar.gz: 72af6d3873e0bbf648c5f038105ebfa1b1130876a7831750e7b7594d8d86ac1e39c82e3e62b5c75f3fbd60972d186d77b1d3fcad28ce33501aeb85b6bbf5699e
+  metadata.gz: dbcf02d875cf41c10c080df757669320a22b9af01377848652445fac1ece7d1473f4c32f465c3c09a871702a3a77b3b28fc7883456f4b3ee25fa393566ab796f
+  data.tar.gz: 32b6e0fa25d8c7f5619c021be719cc28e74aa22c7c6f5a2220c0e5397d0589c52ffa26bdb9bb8e4d85213e8f342eb57fe0460ca7d6cc951b54ae552f24c39e1f

data/README.md

@@ -43,6 +43,8 @@ bundle install
   - datetime フィルターや checkbox group の組み立てを補助する helper
 - `YummyGuide::Administrate::DatetimeInputHelper`
   - 管理画面フォーム用の date + time 入力 helper
+- `YummyGuide::Administrate::NumberInputHelper`
+  - 管理画面フォーム用の number input text 化 helper
 - 共通 partial / assets
   - collection partial
   - fixed table header partial
@@ -102,9 +104,14 @@ class Admin::ApplicationController < Administrate::ApplicationController
   helper YummyGuide::Administrate::CollectionHelper
   helper YummyGuide::Administrate::DatetimeInputHelper
   helper YummyGuide::Administrate::FilterFormHelper
+  helper YummyGuide::Administrate::NumberInputHelper
 end
 ```
 
+`NumberInputHelper` は `Administrate::ApplicationController` の view helper として
+自動適用されます。`Administrate::ApplicationController` を継承しない独自 admin
+controller で同じ挙動が必要な場合だけ、上記のように明示的に読み込んでください。
+
 ### Collection partial
 
 ホストアプリ側の `app/views/administrate/application/_collection.html.erb` から、
@@ -293,6 +300,19 @@ def search_term
 end
 ```
 
+### Number input helper
+
+Admin/Administrate 画面では、`number_field` / `number_field_tag` を
+`type="text"` かつ `inputmode="decimal"` の input として描画します。これにより、
+ブラウザ標準の number spinner や mouse wheel による意図しない数値変更を避けます。
+
+`class`, `id`, `name`, `value`, `data`, `required`, `disabled`, `readonly`,
+`placeholder` などの通常 option は維持されます。`min`, `max`, `step`, `in`,
+`within` は `type="number"` 前提のブラウザ制御なので出力しません。
+
+`range_field` / `range_field_tag` は対象外で、従来どおり `type="range"` として描画
+されます。raw HTML の `<input type="number">` は helper を通らないため対象外です。
+
 ### Asset の読み込み
 
 この engine の asset はホストアプリ側で明示的に読み込んでください。

data/app/helpers/yummy_guide/administrate/number_input_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module YummyGuide
+  module Administrate
+    module NumberInputHelper
+      NUMBER_INPUT_CONTROL_OPTIONS = %i[type min max step in within].freeze
+
+      def number_field(object_name, method, options = {})
+        text_field(object_name, method, yummy_guide_administrate_number_input_options(options))
+      end
+
+      def number_field_tag(name, value = nil, options = {})
+        return super if yummy_guide_administrate_range_input?(options)
+
+        text_field_tag(name, value, yummy_guide_administrate_number_input_options(options))
+      end
+
+      private
+
+      def yummy_guide_administrate_range_input?(options)
+        options[:type].to_s == "range" || options["type"].to_s == "range"
+      end
+
+      def yummy_guide_administrate_number_input_options(options)
+        options = options.to_h.deep_dup
+
+        NUMBER_INPUT_CONTROL_OPTIONS.each do |option|
+          options.delete(option)
+          options.delete(option.to_s)
+        end
+
+        options[:inputmode] ||= "decimal"
+        options
+      end
+    end
+  end
+end

data/lib/yummy_guide/administrate/engine.rb

@@ -16,6 +16,14 @@ module YummyGuide
           yummy_guide_administrate/sticky_table_headers.js
         ]
       end
+
+      initializer "yummy_guide.administrate.number_input_helper" do |app|
+        app.config.to_prepare do
+          next unless defined?(::Administrate::ApplicationController)
+
+          ::Administrate::ApplicationController.helper YummyGuide::Administrate::NumberInputHelper
+        end
+      end
     end
   end
 end

data/lib/yummy_guide/administrate/version.rb

@@ -2,6 +2,6 @@
 
 module YummyGuide
   module Administrate
-    VERSION = "0.5.3"
+    VERSION = "0.5.4"
   end
 end

data/lib/yummy_guide/administrate.rb

@@ -3,6 +3,7 @@
 require "rails"
 require "administrate"
 
+require_relative "../../app/helpers/yummy_guide/administrate/number_input_helper"
 require_relative "administrate/version"
 require_relative "administrate/engine"
 
@@ -10,4 +11,3 @@ module YummyGuide
   module Administrate
   end
 end
-

data/spec/yummy_guide/administrate/number_input_helper_spec.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "nokogiri"
+
+RSpec.describe YummyGuide::Administrate::NumberInputHelper do
+  subject(:helper_host) do
+    Class.new do
+      include ActionView::Context
+      include ActionView::Helpers::FormHelper
+      include ActionView::Helpers::FormTagHelper
+      include ActionView::Helpers::OutputSafetyHelper
+      include ActionView::Helpers::TagHelper
+      include YummyGuide::Administrate::NumberInputHelper
+    end.new
+  end
+
+  before do
+    stub_const("SpecNumberInputResource", Class.new do
+      extend ActiveModel::Naming
+      include ActiveModel::Conversion
+
+      attr_accessor :base_salary
+
+      def persisted?
+        false
+      end
+    end)
+  end
+
+  let(:resource) do
+    SpecNumberInputResource.new.tap do |record|
+      record.base_salary = "123.45"
+    end
+  end
+
+  def fragment(html)
+    Nokogiri::HTML.fragment(html)
+  end
+
+  describe "#number_field" do
+    it "renders a decimal-friendly text input without number-only control attributes" do
+      html = helper_host.number_field(
+        :job_match,
+        :base_salary,
+        class: "payment-input",
+        data: { role: "base-salary" },
+        required: true,
+        disabled: true,
+        readonly: true,
+        placeholder: "0.0",
+        value: "100.5",
+        min: 0,
+        max: 999,
+        step: "any",
+        in: 1..10,
+        within: 1..10
+      )
+      input = fragment(html).at_css("input")
+
+      expect(input["type"]).to eq("text")
+      expect(input["inputmode"]).to eq("decimal")
+      expect(input["class"]).to eq("payment-input")
+      expect(input["id"]).to eq("job_match_base_salary")
+      expect(input["name"]).to eq("job_match[base_salary]")
+      expect(input["value"]).to eq("100.5")
+      expect(input["data-role"]).to eq("base-salary")
+      expect(input["required"]).to eq("required")
+      expect(input["disabled"]).to eq("disabled")
+      expect(input["readonly"]).to eq("readonly")
+      expect(input["placeholder"]).to eq("0.0")
+      expect(input["min"]).to be_nil
+      expect(input["max"]).to be_nil
+      expect(input["step"]).to be_nil
+    end
+
+    it "keeps range fields as range inputs" do
+      input = fragment(helper_host.range_field(:job_match, :base_salary, value: "50")).at_css("input")
+
+      expect(input["type"]).to eq("range")
+      expect(input["value"]).to eq("50")
+    end
+  end
+
+  describe "#number_field_tag" do
+    it "renders a decimal-friendly text input without number-only control attributes" do
+      html = helper_host.number_field_tag(
+        "job_match[base_salary]",
+        "200.5",
+        id: "base_salary",
+        class: "payment-input",
+        data: { role: "base-salary" },
+        required: true,
+        disabled: true,
+        readonly: true,
+        placeholder: "0.0",
+        min: 0,
+        max: 999,
+        step: "any",
+        in: 1..10,
+        within: 1..10
+      )
+      input = fragment(html).at_css("input")
+
+      expect(input["type"]).to eq("text")
+      expect(input["inputmode"]).to eq("decimal")
+      expect(input["id"]).to eq("base_salary")
+      expect(input["name"]).to eq("job_match[base_salary]")
+      expect(input["value"]).to eq("200.5")
+      expect(input["class"]).to eq("payment-input")
+      expect(input["data-role"]).to eq("base-salary")
+      expect(input["required"]).to eq("required")
+      expect(input["disabled"]).to eq("disabled")
+      expect(input["readonly"]).to eq("readonly")
+      expect(input["placeholder"]).to eq("0.0")
+      expect(input["min"]).to be_nil
+      expect(input["max"]).to be_nil
+      expect(input["step"]).to be_nil
+    end
+
+    it "keeps range field tags as range inputs" do
+      input = fragment(helper_host.range_field_tag("base_salary", "50")).at_css("input")
+
+      expect(input["type"]).to eq("range")
+      expect(input["value"]).to eq("50")
+    end
+
+    it "keeps explicit range type options as range inputs" do
+      input = fragment(helper_host.number_field_tag("base_salary", "50", "type" => "range")).at_css("input")
+
+      expect(input["type"]).to eq("range")
+      expect(input["value"]).to eq("50")
+    end
+  end
+
+  describe "form builder integration" do
+    it "routes f.number_field through the helper override" do
+      form_builder = ActionView::Helpers::FormBuilder.new(:job_match, resource, helper_host, {})
+      input = fragment(form_builder.number_field(:base_salary)).at_css("input")
+
+      expect(input["type"]).to eq("text")
+      expect(input["inputmode"]).to eq("decimal")
+      expect(input["value"]).to eq("123.45")
+    end
+
+    it "keeps f.range_field as a range input" do
+      form_builder = ActionView::Helpers::FormBuilder.new(:job_match, resource, helper_host, {})
+      input = fragment(form_builder.range_field(:base_salary, value: "50")).at_css("input")
+
+      expect(input["type"]).to eq("range")
+      expect(input["value"]).to eq("50")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yummy-guide-generic-administrate
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - akatsuki-kk
@@ -109,6 +109,7 @@ files:
 - app/helpers/yummy_guide/administrate/collection_helper.rb
 - app/helpers/yummy_guide/administrate/datetime_input_helper.rb
 - app/helpers/yummy_guide/administrate/filter_form_helper.rb
+- app/helpers/yummy_guide/administrate/number_input_helper.rb
 - app/views/fields/number/_form.html.erb
 - app/views/fields/yummy_guide_administrate/area/picture/_form.html.erb
 - app/views/fields/yummy_guide_administrate/area/picture/_index.html.erb
@@ -140,6 +141,7 @@ files:
 - spec/yummy_guide/administrate/fields/version_item_field_spec.rb
 - spec/yummy_guide/administrate/fields/version_whodunnit_field_spec.rb
 - spec/yummy_guide/administrate/filter_form_helper_spec.rb
+- spec/yummy_guide/administrate/number_input_helper_spec.rb
 - yummy-guide-generic-administrate.gemspec
 homepage: https://github.com/yummy-guide/generic-administrate
 licenses: