haveapi 0.29.0 → 0.29.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5fea26ee9dde153cf44881ba46fe548ebe63077029d787e9b8e82ac19295d27
-  data.tar.gz: 9314173d105633354963d996f0d8f4ceb70d5ec30c22684ced53052d694d9463
+  metadata.gz: 3de67ba481b9c0e88a56b07403e1979e24558ee8f52f3c1eb9d720faa442a62b
+  data.tar.gz: 1d3d0d435612eceeba75ec9973082f7eeca6fd8f7c5010197cb324edd606c843
 SHA512:
-  metadata.gz: 6b1fb3f7ea1140e86091161f740399c258540036c5dccd04e2c9c6c632d0ef8f5e9cd4ab3cf9ecfec7f2952f109b50716fd255bb22fd385efea4c2ea47df6999
-  data.tar.gz: e68a162dc87376dccfc8b5db1cc190aae4e1a47ff18029f21325b7dc2dc063aa522af594cedf0bec2a2f7d0c00d1df4f75151405a83e32821f7289ad4a14775b
+  metadata.gz: 40fcf28b778528046eab97d60034de89210b41c3e7977f12d622c0b8248bc89c231663eb355b5284693db781a3f25887c719ec6ca76effbfb604a10a914762e2
+  data.tar.gz: 7cd757b4ff23dfdd3dbe5efd732ceb23c6adb1bc763ed117de84687ee5c23652a7e71332e7f8762b94eca198b5b5cdbd76a2cf2f5698b876b9032343b98e1fab

data/README.md

@@ -328,6 +328,27 @@ cs:
         label: "Hostname"
 ```
 
+Choice labels declared through the `choices`/`include` validator use the same
+parameter metadata path with `choices.<value>.label` appended. If choices were
+declared as a value-to-label map, the declared label is used as the English
+fallback. If choices were declared as an array, untranslated self-description
+keeps the array form; a locale that supplies labels is returned as the existing
+HaveAPI `{value: label}` map form.
+
+```yaml
+cs:
+  my_api:
+    resources:
+      vps:
+        attributes:
+          state:
+            choices:
+              running:
+                label: "bezi"
+              stopped:
+                label: "vypnuto"
+```
+
 Metadata parameters fall back through resource and global metadata keys:
 
 ```yaml

data/haveapi.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= #{File.read('../../.ruby-version').strip}"
 
   s.add_dependency 'activesupport', '>= 7.1'
-  s.add_dependency 'haveapi-client', '~> 0.29.0'
+  s.add_dependency 'haveapi-client', '~> 0.29.2'
   s.add_dependency 'i18n', '>= 1.6', '< 2'
   s.add_dependency 'json'
   s.add_dependency 'mail'

data/lib/haveapi/parameters/metadata_i18n.rb

@@ -14,7 +14,7 @@ module HaveAPI::Parameters
           keys:,
           value:
         }
-      end
+      end + choice_i18n_catalog_items(context, i18n_path)
     end
 
     private
@@ -27,6 +27,17 @@ module HaveAPI::Parameters
       localized_metadata(context, i18n_path, :description, @desc)
     end
 
+    def localized_validators(context, i18n_path, validators)
+      include_validator = validators[:include]
+      return validators unless include_validator && include_validator.has_key?(:values)
+
+      values = include_validator.fetch(:values)
+      localized_values = localized_choice_values(context, i18n_path, values)
+      return validators if localized_values.equal?(values)
+
+      validators.merge(include: include_validator.merge(values: localized_values))
+    end
+
     def localized_metadata(context, i18n_path, kind, fallback)
       keys = metadata_i18n_keys(context, i18n_path, kind, fallback)
       default = HaveAPI.localize(fallback)
@@ -61,6 +72,74 @@ module HaveAPI::Parameters
       [exact_key, *metadata_i18n_default_keys(context, i18n_path, kind, scope)].uniq
     end
 
+    def localized_choice_values(context, i18n_path, values)
+      case values
+      when ::Hash
+        values.to_h do |value, label|
+          [
+            value,
+            localized_metadata(context, i18n_path, choice_i18n_kind(value), label)
+          ]
+        end
+      when ::Array
+        localized = values.to_h do |value|
+          label = localized_metadata(
+            context,
+            i18n_path,
+            choice_i18n_kind(value),
+            value.to_s
+          )
+          [value, label]
+        end
+
+        localized.any? { |value, label| label.to_s != value.to_s } ? localized : values
+      else
+        values
+      end
+    end
+
+    def choice_i18n_catalog_items(context, i18n_path)
+      values = choice_i18n_values
+      return [] unless values
+
+      choice_i18n_fallbacks(values).filter_map do |value, fallback|
+        keys = metadata_i18n_keys(context, i18n_path, choice_i18n_kind(value), fallback)
+        label = HaveAPI.localize(fallback).to_s.strip
+
+        next if keys.empty? || label.empty?
+
+        {
+          param: HaveAPI::Params.i18n_segment(@name),
+          kind: metadata_i18n_key_suffix(choice_i18n_kind(value)),
+          keys:,
+          value: label
+        }
+      end
+    end
+
+    def choice_i18n_values
+      metadata_i18n_choice_values
+    end
+
+    def metadata_i18n_choice_values
+      nil
+    end
+
+    def choice_i18n_fallbacks(values)
+      case values
+      when ::Hash
+        values
+      when ::Array
+        values.to_h { |value| [value, value.to_s] }
+      else
+        {}
+      end
+    end
+
+    def choice_i18n_kind(value)
+      "choices.#{HaveAPI::Params.i18n_segment(value)}.label"
+    end
+
     def metadata_i18n_fallback(kind)
       case kind
       when :label
@@ -78,8 +157,6 @@ module HaveAPI::Parameters
         @label_key
       when :description
         @desc_key
-      else
-        raise ArgumentError, "unsupported parameter metadata kind #{kind.inspect}"
       end
     end
 

data/lib/haveapi/parameters/typed.rb

@@ -62,7 +62,7 @@ module HaveAPI::Parameters
         label: localized_label(context, i18n_path),
         description: localized_description(context, i18n_path),
         type: @type ? @type.to_s : String.to_s,
-        validators: @validators ? @validators.describe : {},
+        validators: @validators ? localized_validators(context, i18n_path, @validators.describe) : {},
         default: @default,
         protected: @protected || false
       }
@@ -167,6 +167,10 @@ module HaveAPI::Parameters
       @type == Custom
     end
 
+    def metadata_i18n_choice_values
+      @validators&.describe&.dig(:include, :values)
+    end
+
     def normalize_custom_keys(value)
       case value
       when ::Hash

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'.freeze
-  VERSION = '0.29.0'.freeze
+  VERSION = '0.29.2'.freeze
 end

data/spec/i18n_spec.rb

@@ -48,6 +48,14 @@ describe HaveAPI::I18n do
             string :global_attr_label,
                    label: 'Global attribute fallback',
                    desc: 'Global attribute description fallback'
+            string :status, choices: %i[enabled disabled]
+            string :priority,
+                   choices: {
+                     values: {
+                       low: 'Low priority',
+                       high: 'High priority'
+                     }
+                   }
             string :code, length: {
               min: 3,
               message: HaveAPI.message('haveapi.validators.length.min', min: 3)
@@ -146,6 +154,14 @@ describe HaveAPI::I18n do
       expect(length[:message]).to eq('délka musí být v rozsahu <3, 5>')
     end
 
+    it 'keeps untranslated array choices unchanged in OPTIONS responses' do
+      header 'Accept', 'application/json'
+      options '/v1/things', method: 'POST'
+
+      choices = api_response[:input][:parameters][:status][:validators][:include]
+      expect(choices[:values]).to eq(%w[enabled disabled])
+    end
+
     it 'localizes API metadata in OPTIONS responses' do
       previous_available = ::I18n.available_locales
       ::I18n.available_locales = (previous_available + %i[en cs]).uniq
@@ -218,6 +234,18 @@ describe HaveAPI::I18n do
                     global_attr_label: {
                       label: 'Přesný globální popisek',
                       description: 'Přesný globální popis'
+                    },
+                    status: {
+                      choices: {
+                        enabled: { label: 'Zapnuto' },
+                        disabled: { label: 'Vypnuto' }
+                      }
+                    },
+                    priority: {
+                      choices: {
+                        low: { label: 'Nízká priorita' },
+                        high: { label: 'Vysoká priorita' }
+                      }
                     }
                   },
                   output: {
@@ -325,6 +353,14 @@ describe HaveAPI::I18n do
         label: 'Přesný globální popisek',
         description: 'Přesný globální popis'
       )
+      expect(input_params[:status][:validators][:include][:values]).to eq(
+        enabled: 'Zapnuto',
+        disabled: 'Vypnuto'
+      )
+      expect(input_params[:priority][:validators][:include][:values]).to eq(
+        low: 'Nízká priorita',
+        high: 'Vysoká priorita'
+      )
       expect(input_params[:count]).to include(
         label: 'Count',
         description: nil

data/spec/params_spec.rb

@@ -258,6 +258,8 @@ describe HaveAPI::Params do
     p = described_class.new(:input, ParamsSpec::MyResource::Index)
     p.add_block(proc do
       string :hostname, label: 'Hostname', desc: 'VPS hostname'
+      string :state, choices: %i[queued running]
+      string :priority, choices: { values: { low: 'Low priority' } }
       string :framework,
              label: HaveAPI.message('haveapi.parameters.metadata.no.label')
     end)
@@ -274,6 +276,22 @@ describe HaveAPI::Params do
                                  params_spec.attributes.hostname.label
                                ])
     expect(items.none? { |item| item[:param] == 'framework' }).to be true
+
+    choice = items.detect do |item|
+      item[:param] == 'state' && item[:kind] == 'choices.queued.label'
+    end
+    expect(choice[:value]).to eq('queued')
+    expect(choice[:keys]).to eq(%w[
+                                  params_spec.resources.my_resource.actions.index.input.state.choices.queued.label
+                                  params_spec.resources.my_resource.input.state.choices.queued.label
+                                  params_spec.resources.my_resource.attributes.state.choices.queued.label
+                                  params_spec.attributes.state.choices.queued.label
+                                ])
+
+    choice = items.detect do |item|
+      item[:param] == 'priority' && item[:kind] == 'choices.low.label'
+    end
+    expect(choice[:value]).to eq('Low priority')
   end
 
   it 'does not parse meta resource path segments as metadata paths' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.29.2
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.29.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.0
+        version: 0.29.2
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement