form_input 0.9.0.pre1

data/lib/form_input/localize.rb

@@ -0,0 +1,49 @@
+# Simple helper for creating default translation file for existing project.
+
+require 'yaml'
+require 'form_input/r18n'
+
+# Primitive helper for converting hash keys to strings.
+class Hash
+  # Convert all hash keys to strings recursively.
+  def stringify_keys
+    map{ |k, v| [ k.to_s, v.respond_to?( :stringify_keys ) ? v.stringify_keys : v ] }.to_h
+  end
+end
+
+class FormInput
+  class Parameter
+      # Array definining explicit default order of names of parameter options in translation files.
+      TRANSLATION_ORDER = %w[title form_title error_title gender plural inflect required_msg msg match_msg reject_msg]
+
+      # Get translation order for given option name.
+      def translation_order( name )
+        TRANSLATION_ORDER.index( name.to_s ) || TRANSLATION_ORDER.count
+      end
+
+      # Get hash of all parameter values which may need to be localized.
+      def translation_hash
+        opts.select{ |k, v| v.is_a? String }.sort_by{ |k, v| [ translation_order( k ), k ] }.to_h
+      end
+  end
+
+  # Get hash of all form values which may need to be localized.
+  def self.translation_hash
+    hash = form_params.map{ |k, v| [ k, v.translation_hash ] }.reject{ |k, v| v.empty? }.to_h
+    hash[ :steps ] = form_steps.reject{ |k, v| v.nil? } if form_steps
+    hash
+  end
+
+  # Get list of all classes inherited from FormInput.
+  def self.forms
+    ObjectSpace.each_object( Class ).select{ |x| x < FormInput }
+  end
+
+  # Get string containing YAML representation of the default R18n translation for current project.
+  def self.default_translation
+    hash = forms.sort_by{ |x| x.name }.map{ |x| [ x.translation_name, x.translation_hash ] }.reject{ |k, v| v.empty? }.to_h
+    YAML::dump( { forms: hash }.stringify_keys )
+  end
+end
+
+# EOF #

data/lib/form_input/r18n/cs.yml

@@ -0,0 +1,97 @@
+# Form input Czech messages.
+#
+# Supports singular and plural numbers and masculine, feminine, and neuter genders,
+# including animate and inanimate masculine gender. Nominative case is assumed.
+#
+# Inflection classes supported are (standard declension paradigms included for reference):
+#
+#   sma: pán muž předseda soudce
+#   smi or sm: hrad stroj
+#   sf: žena růže píseň kost
+#   sn: město moře kuře stavení
+#   pma: páni muži předsedové soudci
+#   pmi or pm: hrady stroje
+#   pf: ženy růže písně kosti
+#   pn: města moře kuřata stavení
+#
+# Note that when exact match is not found, longest prefix match applies (e.g., pma->pm->p is tried in turn).
+
+form_input:
+  default_gender: mi # For 'Parametr x'
+  errors:
+    required_scalar: !!inflect
+      sm: '%p je povinný'
+      sf: '%p je povinná'
+      sn: '%p je povinné'
+      p: '%p jsou povinné'
+      pma: '%p jsou povinní'
+      pn: '%p jsou povinná'
+    required_array: !!inflect
+      sm: '%p je povinný'
+      sf: '%p je povinná'
+      sn: '%p je povinné'
+      p: '%p jsou povinné'
+      pma: '%p jsou povinní'
+      pn: '%p jsou povinná'
+    not_array: !!inflect
+      s: '%p není pole'
+      p: '%p nejsou pole'
+    not_hash: !!inflect
+      s: '%p není hash'
+      p: '%p nejsou hash'
+    not_string: !!inflect
+      s: '%p není řetězec'
+      p: '%p nejsou řetězec'
+    match_key: !!inflect
+      s: '%p obsahuje neplatný klíč'
+      p: '%p obsahují neplatný klíč'
+    invalid_key: !!inflect
+      s: '%p obsahuje neplatný klíč'
+      p: '%p obsahují neplatný klíč'
+    min_key: !!inflect
+      s: '%p obsahuje příliš malý klíč'
+      p: '%p obsahují příliš malý klíč'
+    max_key: !!inflect
+      s: '%p obsahuje příliš velký klíč'
+      p: '%p obsahují příliš velký klíč'
+    min_count: '%p musí mít nejméně %1'
+    max_count: '%p smí mít nejvíce %1'
+    value_type: '%p musí mít správný formát'
+    element_type: !!inflect
+      s: '%p obsahuje neplatnou hodnotu'
+      p: '%p obsahují neplatnou hodnotu'
+    min_limit: '%p musí být nejméně %1'
+    max_limit: '%p smí být nejvíce %1'
+    inf_limit: '%p musí být větší než %1'
+    sup_limit: '%p musí být menší než %1'
+    invalid_encoding: '%p musí mít platný encoding'
+    invalid_characters: '%p nesmí obsahovat zakázané znaky'
+    min_size: '%p musí mít nejméně %1'
+    max_size: '%p smí mít nejvíce %1'
+    min_bytesize: '%p musí mít nejméně %1'
+    max_bytesize: '%p smí mít nejvíce %1'
+    reject_msg: !!inflect
+      sm: '%p v tomto tvaru není povolen'
+      sf: '%p v tomto tvaru není povolena'
+      sn: '%p v tomto tvaru není povoleno'
+      p: '%p v tomto tvaru nejsou povoleny'
+      pma: '%p v tomto tvaru nejsou povoleni'
+      pn: '%p v tomto tvaru nejsou povolena'
+    match_msg: !!inflect
+      s: '%p není ve správném tvaru'
+      p: '%p nejsou ve správném tvaru'
+  units:
+    byte: !!pl
+      1: '%1 byte'
+      2: '%1 byty'
+      n: '%1 bytů'
+    character: !!pl
+      1: '%1 znak'
+      2: '%1 znaky'
+      n: '%1 znaků'
+    element: !!pl
+      1: '%1 prvek'
+      2: '%1 prvky'
+      n: '%1 prvků'
+
+# EOF #

data/lib/form_input/r18n/en.yml

@@ -0,0 +1,70 @@
+# Form input English messages.
+#
+# Supports singular and plural inflection for all messages.
+# All parameter names are assumed to use the nominative case.
+
+form_input:
+  errors:
+    required_scalar: !!inflect
+      s: '%p is required'
+      p: '%p are required'
+    required_array: !!inflect
+      s: '%p is required'
+      p: '%p are required'
+    not_array: !!inflect
+      s: '%p is not an array'
+      p: '%p are not an array'
+    not_hash: !!inflect
+      s: '%p is not a hash'
+      p: '%p are not a hash'
+    not_string: !!inflect
+      s: '%p is not a string'
+      p: '%p are not a string'
+    match_key: !!inflect
+      s: '%p contains invalid key'
+      p: '%p contain invalid key'
+    invalid_key: !!inflect
+      s: '%p contains invalid key'
+      p: '%p contain invalid key'
+    min_key: !!inflect
+      s: '%p contains too small key'
+      p: '%p contain too small key'
+    max_key: !!inflect
+      s: '%p contains too large key'
+      p: '%p contain too large key'
+    min_count: '%p must have at least %1'
+    max_count: '%p may have at most %1'
+    value_type: !!inflect
+      s: '%p like this is not valid'
+      p: '%p like these are not valid'
+    element_type: !!inflect
+      s: '%p contains invalid value'
+      p: '%p contain invalid value'
+    min_limit: '%p must be at least %1'
+    max_limit: '%p may be at most %1'
+    inf_limit: '%p must be greater than %1'
+    sup_limit: '%p must be less than %1'
+    invalid_encoding: '%p must use valid encoding'
+    invalid_characters: '%p may not contain invalid characters'
+    min_size: '%p must have at least %1'
+    max_size: '%p may have at most %1'
+    min_bytesize: '%p must have at least %1'
+    max_bytesize: '%p may have at most %1'
+    reject_msg: !!inflect
+      s: '%p like this is not allowed'
+      p: '%p like these are not allowed'
+    match_msg: !!inflect
+      s: '%p like this is not valid'
+      p: '%p like these are not valid'
+  units:
+    byte: !!pl
+      1: '%1 byte'
+      n: '%1 bytes'
+    character: !!pl
+      1: '%1 character'
+      n: '%1 characters'
+    element: !!pl
+      1: '%1 element'
+      n: '%1 elements'
+
+# EOF #

data/lib/form_input/r18n/pl.yml

@@ -0,0 +1,122 @@
+# Form input Polish messages.
+#
+# Supports singular and plural numbers and masculine, feminine, and neuter genders,
+# including personal, animate, and inanimate masculine gender. Nominative case is assumed.
+#
+# Inflection classes supported are (some declension templates included for reference):
+#
+#   smp: Chłopak Rolnik Krzyś Facet Inżynier
+#   sma: Kot Pies
+#   smi or sm: Komputer Stół
+#   sf: Dziewczyna Kobieta Mrówka Kawa Krowa Kasia Komedia Miłość Wysokość
+#   sn: Piwo Krzesło Ciastko Dziecko Oko Ucho Spotkanie
+#   pmp: Chłopaki Rolnicy Krzysie Faceci Inżynierzy
+#   pma: Koty Psy
+#   pmi or pm: Komputery Stoły
+#   pf: Dziewczyny Kobiety Mrówki Kawy Krowy Kasie Komedie Miłości Wysokości
+#   pn: Piwa Krzesła Ciastka Dzieci Oczy Uszy Spotkania
+#
+# Note that when exact match is not found, longest prefix match applies (e.g., pma->pm->p is tried in turn).
+
+form_input:
+  default_gender: mi # For 'Parametr x'
+  errors:
+    required_scalar: !!inflect
+      sm: '%p jest wymagany'
+      sf: '%p jest wymagana'
+      sn: '%p jest wymagane'
+      pmp: '%p są wymagani'
+      p: '%p są wymagane'
+    required_array: !!inflect
+      sm: '%p jest wymagany'
+      sf: '%p jest wymagana'
+      sn: '%p jest wymagane'
+      pmp: '%p są wymagani'
+      p: '%p są wymagane'
+    not_array: !!inflect
+      s: '%p nie jest tablicą'
+      p: '%p nie są tablicami'
+    not_hash: !!inflect
+      s: '%p nie jest hashem'
+      p: '%p nie są hashami'
+    not_string: !!inflect
+      s: '%p nie jest ciągiem znaków'
+      p: '%p nie są ciągiem znaków'
+    match_key: !!inflect
+      s: '%p zawiera nieprawidłowy klucz'
+      p: '%p zawierają nieprawidłowy klucz'
+    invalid_key: !!inflect
+      s: '%p zawiera nieprawidłowy klucz'
+      p: '%p zawierają nieprawidłowy klucz'
+    min_key: !!inflect
+      s: '%p zawiera za mały klucz'
+      p: '%p zawierają za mały klucz'
+    max_key: !!inflect
+      s: '%p zawiera za duży klucz'
+      p: '%p zawierają za duży klucz'
+    min_count: !!inflect
+      s: '%p musi mieć conajmniej %1'
+      p: '%p muszą mieć conajmniej %1'
+    max_count: !!inflect
+      s: '%p musi mieć maksymalnie %1'
+      p: '%p muszą mieć maksymalnie %1'
+    value_type: !!inflect
+      s: '%p musi mieć poprawny format'
+      p: '%p muszą mieć poprawny format'
+    element_type: !!inflect
+      s: '%p zawiera nieprawidłową wartość'
+      p: '%p zawierają nieprawidłową wartość'
+    min_limit: !!inflect
+      s: '%p musi wynosić conajmniej %1'
+      p: '%p muszą wynosić conajmniej %1'
+    max_limit: !!inflect
+      s: '%p musi wynosić maksymalnie %1'
+      p: '%p muszą wynosić maksymalnie %1'
+    inf_limit: !!inflect
+      s: '%p musi wynosić więcej niż %1'
+      p: '%p muszą wynosić więcej niż %1'
+    sup_limit: !!inflect
+      s: '%p musi wynosić mniej niż %1'
+      p: '%p muszą wynosić mniej niż %1'
+    invalid_encoding: !!inflect
+      s: '%p musi używać poprawnego kodowania'
+      p: '%p muszą używać poprawnego kodowania'
+    invalid_characters: !!inflect
+      s: '%p nie może zawierać zabronionych znaków'
+      p: '%p nie mogą zawierać zabronionych znaków'
+    min_size: !!inflect
+      s: '%p musi mieć przynajmniej %1'
+      p: '%p muszą mieć przynajmniej %1'
+    max_size: !!inflect
+      s: '%p musi mieć maksymalnie %1'
+      p: '%p muszą mieć maksymalnie %1'
+    min_bytesize: !!inflect
+      s: '%p musi mieć przynajmniej %1'
+      p: '%p muszą mieć przynajmniej %1'
+    max_bytesize: !!inflect
+      s: '%p musi mieć maksymalnie %1'
+      p: '%p muszą mieć maksymalnie %1'
+    reject_msg: !!inflect
+      sm: '%p w tej postaci nie jest poprawny'
+      sf: '%p w tej postaci nie jest poprawna'
+      sn: '%p w tej postaci nie jest poprawne'
+      pmp: '%p w tej postaci nie są poprawni'
+      p: '%p w tej postaci nie są poprawne'
+    match_msg: !!inflect
+      s: '%p nie jest w poprawnej formie'
+      p: '%p nie są w poprawnej formie'
+  units:
+    byte: !!pl
+      1: '%1 bajt'
+      2: '%1 bajty'
+      n: '%1 bajtów'
+    character: !!pl
+      1: '%1 znak'
+      2: '%1 znaki'
+      n: '%1 znaków'
+    element: !!pl
+      1: '%1 element'
+      2: '%1 elementy'
+      n: '%1 elementów'
+
+# EOF #

data/lib/form_input/r18n/sk.yml

@@ -0,0 +1,120 @@
+# Form input Slovak messages.
+#
+# Supports singular and plural numbers and masculine, feminine, and neuter genders,
+# including animate and inanimate masculine gender. Nominative case is assumed.
+#
+# Inflection classes supported are (standard declension paradigms included for reference):
+#
+#   sma: chlap hrdina
+#   smi or sm: dub stroj
+#   sf: žena ulica dlaň kosť
+#   sn: mesto srdce vysvedčenie dievča
+#   pma: chlapi hrdinovia
+#   pmi or pm: duby stroje
+#   pf: ženy ulice dlane kosti
+#   pn: mestá srdcia vysvedčenia dievčatá
+#
+# Note that when exact match is not found, longest prefix match applies (e.g., pma->pm->p is tried in turn).
+
+form_input:
+  default_gender: mi # For 'Parameter x'
+  errors:
+    required_scalar: !!inflect
+      sm: '%p je povinný'
+      sf: '%p je povinná'
+      sn: '%p je povinné'
+      p: '%p sú povinné'
+      pma: '%p sú povinní'
+    required_array: !!inflect
+      sm: '%p je povinný'
+      sf: '%p je povinná'
+      sn: '%p je povinné'
+      p: '%p sú povinné'
+      pma: '%p sú povinní'
+    not_array: !!inflect
+      s: '%p nie je polia'
+      p: '%p nie sú polia'
+    not_hash: !!inflect
+      s: '%p nie je hash'
+      p: '%p nie sú hash'
+    not_string: !!inflect
+      s: '%p nie je reťazec'
+      p: '%p nie sú reťazce'
+    match_key: !!inflect
+      s: '%p obsahuje neplatný kľúč'
+      p: '%p obsahujú neplatný kľúč'
+    invalid_key: !!inflect
+      s: '%p obsahuje neplatný kľúč'
+      p: '%p obsahujú neplatný kľúč'
+    min_key: !!inflect
+      s: '%p obsahuje príliš malý kľúč'
+      p: '%p obsahujú príliš malý kľúč'
+    max_key: !!inflect
+      s: '%p obsahuje príliš veľký kľúč'
+      p: '%p obsahujú príliš veľký kľúč'
+    min_count: !!inflect
+      s: '%p musí mať najmenej %1'
+      p: '%p musia mať najmenej %1'
+    max_count: !!inflect
+      s: '%p smie mať najviac %1'
+      p: '%p smú mať najviac %1'
+    value_type: !!inflect
+      s: '%p musí mať správný formát'
+      p: '%p musia mať správný formát'
+    element_type: !!inflect
+      s: '%p obsahuje neplatnú hodnotu'
+      p: '%p obsahujú neplatnú hodnotu'
+    min_limit: !!inflect
+      s: '%p musí byť najmenej %1'
+      p: '%p musia byť najmenej %1'
+    max_limit: !!inflect
+      s: '%p smie byť najviac %1'
+      p: '%p smú byť najviac %1'
+    inf_limit: !!inflect
+      s: '%p musí byť väčší ako %1'
+      p: '%p musia byť väčší ako %1'
+    sup_limit: !!inflect
+      s: '%p musí byť menší ako %1'
+      p: '%p musia byť menší ako %1'
+    invalid_encoding: !!inflect
+      s: '%p musí mať platný encoding'
+      p: '%p musia mať platný encoding'
+    invalid_characters: !!inflect
+      s: '%p nesmie obsahovať zakázané znaky'
+      p: '%p nesmú obsahovať zakázané znaky'
+    min_size: !!inflect
+      s: '%p musí mať najmenej %1'
+      p: '%p musia mať najmenej %1'
+    max_size: !!inflect
+      s: '%p smie mať najviac %1'
+      p: '%p smú mať najviac %1'
+    min_bytesize: !!inflect
+      s: '%p musí mať najmenej %1'
+      p: '%p musia mať najmenej %1'
+    max_bytesize: !!inflect
+      s: '%p smie mať najviac %1'
+      p: '%p smú mať najviac %1'
+    reject_msg: !!inflect
+      sm: '%p v tomto tvare nie je povolený'
+      sf: '%p v tomto tvare nie je povolená'
+      sn: '%p v tomto tvare nie je povolené'
+      p: '%p v tomto tvare nie sú povolené'
+      pma: '%p v tomto tvare nie sú povolení'
+    match_msg: !!inflect
+      s: '%p nie je v správnom tvare'
+      p: '%p nie sú v správnom tvare'
+  units:
+    byte: !!pl
+      1: '%1 byte'
+      2: '%1 byty'
+      n: '%1 bytov'
+    character: !!pl
+      1: '%1 znak'
+      2: '%1 znaky'
+      n: '%1 znakov'
+    element: !!pl
+      1: '%1 prvok'
+      2: '%1 prvky'
+      n: '%1 prvkov'
+
+# EOF #

data/lib/form_input/r18n.rb

@@ -0,0 +1,163 @@
+# R18n localization support.
+
+require 'form_input'
+require 'r18n-core'
+
+class FormInput
+
+  # Include R18n helpers in form context.
+  include R18n::Helpers
+
+  # Localize few parameter methods.
+  class Parameter
+
+    # Include R18n helpers in parameter context.
+    include R18n::Helpers
+
+    # R18n specific methods.
+    module R18nMethods
+
+      # Parameter options which are known to be not localized.
+      UNLOCALIZED_OPTIONS = [
+        :required, :disabled, :array, :hash, :type, :data, :tag, :tags, :filter, :transform, :format, :class, :check, :test, :reject, :match,
+        :min_key, :max_key, :match_key, :min_count, :max_count, :min, :max, :inf, :sup, :min_size, :max_size, :min_bytesize, :max_bytesize,
+      ]
+
+      # Automatically attempt to translate available parameter options.
+      def []( name )
+        if form and r18n
+          value = opts[ name ]
+          if value.is_a?( String ) or ( value.nil? and not UNLOCALIZED_OPTIONS.include?( name ) )
+            text = pt( name )
+            return text.to_s if text.translated?
+          end
+        end
+        super
+      end
+
+      # Localized version of error message formatting. See original implementation for details.
+      def format_error_message( msg, count = nil, singular = nil, *rest )
+        return super unless msg.is_a?( Symbol ) and r18n
+        if limit = count and singular
+          limit = t.form_input.units[ singular, count ].to_s
+        end
+        text = t.form_input.errors[ msg, *limit, self ].to_s
+        super( text )
+      end
+
+      # Like t helper, except that the translation is looked up in the forms.<form_name> scope.
+      # Supports both ft.name( args ) and ft( :name, args ) forms.
+      def ft( *args )
+        form.ft( *args )
+      end
+
+      # Like t helper, except that the translation is looked up in the forms.<form_name>.<param_name> scope.
+      # Supports both pt.name( args ) and pt( :name, args ) forms. The latter automatically adds self as last argument to support inflection.
+      def pt( *args )
+        translation = ft[ name ]
+        args.empty? ? translation : translation[ *args, self ]
+      end
+
+      # Get the inflection string used for correctly inflecting the parameter messages.
+      # Note that it ignores the noun case as the parameter names are supposed to use the nominative case anyway.
+      def inflection
+        ( self[ :inflect ] || "#{pluralize}#{gender}" ).to_s
+      end
+
+      # Get the string corresponding to the grammatical number of the parameter name used for inflecting the parameter messages.
+      def pluralize
+        p = self[ :plural ]
+        p = ! scalar? if p.nil?
+        p = 's' if p == false
+        p = 'p' if p == true
+        p.to_s
+      end
+
+      # Get the gender string used for inflecting the parameter messages.
+      def gender
+        ( self[ :gender ] || ( t.form_input.default_gender | 'n' ) ).to_s
+      end
+
+    end
+
+    include R18nMethods
+
+  end
+
+  # Localize few step methods.
+  module StepMethods
+
+    # Get name of current or given step, if any.
+    def step_name( step = self.step )
+      name = raw_step_name( step )
+      name = ( ft.steps[ step ] | name ).to_s if r18n and name
+      name
+    end
+
+    # Get hash of steps along with their names.
+    def step_names
+      hash = raw_step_names
+      hash = Hash[ hash.map{ |k,v| [ k, ( ft.steps[ k ] | v ).to_s ] } ] if r18n
+      hash
+    end
+
+  end
+
+  # Get path to R18n translations provided by this gem.
+  def self.translations_path
+    File.expand_path( "#{__FILE__}/../r18n" )
+  end
+
+  # Get name of the form used as translation scope for text translations.
+  def self.translation_name
+    @translation_name ||= name.split( '::' ).last
+      .gsub( /([A-Z]+)([A-Z][a-z])/, '\1_\2' )
+      .gsub( /([a-z\d])([A-Z])/, '\1_\2' )
+      .downcase
+  end
+
+  # Like t helper, except that the translation is looked up in the forms.<form_name> scope.
+  # Supports both ft.name( args ) and ft( :name, args ) forms.
+  def ft( *args )
+    fail "You need to set the locale with R18n.set('en') or similar. No locale, no helper. Sorry." unless r18n
+    translation = t.forms[ self.class.translation_name ]
+    args.empty? ? translation : translation[ *args ]
+  end
+
+  # Iterate over each possible inflection for given inflection string and return first non-nil result.
+  # You may override this if you need more complex inflection fallbacks for some locale.
+  def self.find_inflection( string )
+    until string.empty?
+      break if result = yield( string )
+      string = string[0..-2]
+    end
+    result
+  end
+
+  # Define our inflection filter.
+  R18n::Filters.add( 'inflect', :inflection ) do |translations, config, *params|
+    inflection = case param = params.last
+    when Parameter
+      param.inflection
+    when String
+      param
+    end
+    inflection ||= 'sn'
+    text = FormInput.find_inflection( inflection ) do |i|
+      translations[ i ] if translations.key?( i )
+    end
+    text || R18n::Translation.new(
+      config[ :locale ], config[ :path ],
+      locale: config[ :locale ], translations: translations
+    )[ inflection ]
+  end
+
+  # Add our translations as R18n extensions.
+  R18n.extension_places << R18n::Loader::YAML.new( translations_path )
+
+  # Localize the helper for boolean args.
+  BOOL_ARGS[ :data ] = ->{ [ [ true, r18n ? t.yes.to_s : 'Yes' ], [ false, r18n ? t.no.to_s : 'No' ] ] }
+
+end
+
+# EOF #