Module: Decidim::Faker::Localized

Defined in:
decidim-core/lib/decidim/faker/localized.rb

Overview

A Custom Faker wrapper so we can easily generate fake data for each locale in localized attributes.

Class Method Summary collapse

Class Method Details

.character ⇒ Object

Builds a Lorem Ipsum character.

Returns a Hash with a value for each locale.



58
59
60
61
62
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 58

def self.character
  localized do
    ::Faker::Lorem.character
  end
end

.characters ⇒ Object

Builds many Lorem Ipsum characters. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



67
68
69
70
71
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 67

def self.characters(...)
  localized do
    ::Faker::Lorem.characters(...)
  end
end

.company ⇒ Object

Fakes a company name.

Returns a Hash with a value for each locale.



22
23
24
25
26
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 22

def self.company
  localized do
    ::Faker::Company.name
  end
end

.literal(text) ⇒ Object

Sets the given text as the value for each locale.

text - The String text to set for each locale.

Returns a Hash with a value for each locale.



132
133
134
135
136
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 132

def self.literal(text)
  Decidim.available_locales.inject({}) do |result, locale|
    result.update(locale => text)
  end.with_indifferent_access
end

.localized ⇒ Object

Runs the given block for each of the available locales in Decidim, momentarily setting the locale to the current one.

Returns a Hash with a value for each locale.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 170

def self.localized
  locales = Decidim.available_locales.dup
  last_locale = locales.pop if locales.length > 1

  value = locales.inject({}) do |result, locale|
    text = ::Faker::Base.with_locale(locale) do
      yield
    end

    if text.is_a?(Hash)
      result.merge!(text)
    else
      result.update(locale => text)
    end
  end.with_indifferent_access
  return value unless last_locale

  value.update(
    "machine_translations" => {
      last_locale => ::Faker::Base.with_locale(last_locale) { yield }
    }.with_indifferent_access
  )
end

.name ⇒ Object

Fakes a person name.

Returns a Hash with a value for each locale.



31
32
33
34
35
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 31

def self.name
  localized do
    ::Faker::Name.name
  end
end

.paragraph ⇒ Object

Builds a paragraph with Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



94
95
96
97
98
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 94

def self.paragraph(...)
  localized do
    ::Faker::Lorem.paragraph(...)
  end
end

.paragraphs ⇒ Object

Builds many paragraphs with Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



103
104
105
106
107
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 103

def self.paragraphs(...)
  localized do
    ::Faker::Lorem.paragraphs(...)
  end
end

.prefixed(msg, locales = Decidim.available_locales.dup) ⇒ Object

Prefixes the msg for each available locale and returns as a Hash of the form ‘locale => prefixed_msg`.

Return a Hash with a value for each locale.



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 198

def self.prefixed(msg, locales = Decidim.available_locales.dup)
  other_locales = locales
  last_locale = locales.pop if locales.length > 1

  value = other_locales.inject({}) do |result, locale|
    result.update(locale => "#{locale.to_s.upcase}: #{msg}")
  end.with_indifferent_access
  return value unless last_locale

  value.update(
    "machine_translations" => {
      last_locale => "#{last_locale.to_s.upcase}: #{msg}"
    }.with_indifferent_access
  )
end

.question ⇒ Object

Builds a question with Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



112
113
114
115
116
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 112

def self.question(...)
  localized do
    ::Faker::Lorem.question(...)
  end
end

.questions ⇒ Object

Builds many questions with Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



121
122
123
124
125
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 121

def self.questions(...)
  localized do
    ::Faker::Lorem.questions(...)
  end
end

.sentence ⇒ Object

Builds a sentence with Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



76
77
78
79
80
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 76

def self.sentence(...)
  localized do
    ::Faker::Lorem.sentence(...)
  end
end

.sentences ⇒ Object

Builds many sentences with Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



85
86
87
88
89
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 85

def self.sentences(...)
  localized do
    ::Faker::Lorem.sentences(...)
  end
end

.word ⇒ Object

Builds a Lorem Ipsum word.

Returns a Hash with a value for each locale.



40
41
42
43
44
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 40

def self.word
  localized do
    ::Faker::Lorem.word
  end
end

.words ⇒ Object

Builds many Lorem Ipsum words. See Faker::Lorem for options.

Returns a Hash with a value for each locale.



49
50
51
52
53
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 49

def self.words(...)
  localized do
    ::Faker::Lorem.words(...)
  end
end

.wrapped(before, after) ⇒ Object

Wraps a text build by the block with some other text.

before - The String text to inject at the beginning of each value. after - The String text to inject at the end of each value. block - A Block that generates a Hash with a text for each locale.

Example:

Decidim::Faker::Localized.wrapped("<p>", "</p>") do
  Decidim::Faker::Localized.sentence(5)
end

Returns a Hash with a value for each locale.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'decidim-core/lib/decidim/faker/localized.rb', line 151

def self.wrapped(before, after)
  result = yield
  result.inject({}) do |wrapped, (locale, value)|
    if value.is_a?(Hash) && locale.to_s == "machine_translations"
      final_value = value.inject({}) do |new_wrapped, (new_locale, new_value)|
        new_wrapped.update(new_locale => [before, new_value, after].join)
      end

      wrapped.update(locale => final_value)
    else
      wrapped.update(locale => [before, value, after].join)
    end
  end
end