Top Level Namespace

Includes:
Argon2Encryptor

Defined Under Namespace

Modules: Admin, Argon2Encryptor, Authentication, Authorization, DatabaseCleanerSupport, DeviseHelpers, ErrorHandlers, Kowl Classes: ApplicationMailer, ApplicationPolicy, ApplicationSystemTestCase, DeferredGarbageCollection, DeviseMailer, GeoDB, GravatarField, LoginActivityPolicy, LoginActivityPolicyTest, LoginActivityTest, PageControllerTest, RichTextAreaField, RichTextAreaInput, UserPolicy, UserPolicyTest, UserTest, UsersController

Instance Method Summary collapse

Methods included from Argon2Encryptor

#compare, #digest

Instance Method Details

#add_to_assets(asset_str) ⇒ Object

Used to add additional assets to be considered when compiling your assets

Parameters:

  • str (String) —

    Asset string file to add to the file, ie: ‘application-mailer.scss`



81
82
83
 
# File 'lib/kowl/helpers.rb', line 81

def add_to_assets(asset_str)
  append_to_file('config/initializers/assets.rb', "Rails.application.config.assets.precompile += %w( #{asset_str} )\n") unless asset_str.blank?
end

#add_to_routes(route_str = '') ⇒ Object

Add a specific line to the config/routes.rb file

Parameters:

  • route_str (String) (defaults to: '') —

    The specific route you want to add to the applications route file



87
88
89
 
# File 'lib/kowl/helpers.rb', line 87

def add_to_routes(route_str = '')
  inject_into_file('config/routes.rb', optimize_indentation("#{route_str.strip}\n", 2), after: "\s# For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html\n")
end

#config ⇒ Object

src: pranavsingh.me/semantic-ui-simple-form-wrapper/ Use this setup block to configure all options available in SimpleForm.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/kowl/templates/config/initializers/simpleform/semantic.rb', line 5

SimpleForm.setup do |config|
  # Wrappers are used by the form builder to generate a
  # complete input. You can remove any component from the
  # wrapper, change the order or even add your own to the
  # stack. The options given below are used to wrap the
  # whole input.
  config.wrappers :default, class: :input, hint_class: :field_with_hint, error_class: :field_with_errors do |b|
    ## Extensions enabled by default
    # Any of these extensions can be disabled for a
    # given input by passing: `f.input EXTENSION_NAME => false`.
    # You can make any of these extensions optional by
    # renaming `b.use` to `b.optional`.

    # Determines whether to use HTML5 (:email, :url, ...)
    # and required attributes
    b.use :html5

    # Calculates placeholders automatically from I18n
    # You can also pass a string as f.input placeholder: "Placeholder"
    b.use :placeholder

    ## Optional extensions
    # They are disabled unless you pass `f.input EXTENSION_NAME => true`
    # to the input. If so, they will retrieve the values from the model
    # if any exists. If you want to enable any of those
    # extensions by default, you can change `b.optional` to `b.use`.

    # Calculates maxlength from length validations for string inputs
    # and/or database column lengths
    b.optional :maxlength

    # Calculate minlength from length validations for string inputs
    b.optional :minlength

    # Calculates pattern from format validations for string inputs
    b.optional :pattern

    # Calculates min and max from length validations for numeric inputs
    b.optional :min_max

    # Calculates readonly automatically from readonly attributes
    b.optional :readonly

    ## Inputs
    b.use :label_input
    b.use :hint,  wrap_with: { tag: :span, class: :hint }
    b.use :error, wrap_with: { tag: :span, class: :error }
  end

  # Custom Semantic Wrapper
  # Values are similar to the default wrapper above, with different classes
  config.wrappers :semantic, tag: 'div', class: 'field', error_class: 'error', hint_class: 'with_hint' do |b|
    b.use :html5
    b.use :placeholder
    b.optional :maxlength
    b.optional :pattern
    b.optional :min_max
    b.use :label_input
    b.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
    b.use :error, wrap_with: { tag: 'div', class: 'ui red pointing above label error' }
  end

  config.wrappers :ui_checkbox, tag: 'div', class: 'field', error_class: 'error', hint_class: 'with_hint' do |b|
    b.use :html5
    b.wrapper tag: 'div', class: 'ui checkbox' do |input|
      input.use :label_input
      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
    end
  end

  config.wrappers :ui_slider_checkbox, tag: 'div', class: 'field', error_class: 'error', hint_class: 'with_hint' do |b|
    b.use :html5
    b.wrapper tag: 'div', class: 'ui slider checkbox' do |input|
      input.use :label_input
      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
    end
  end

  config.wrappers :ui_toggle_checkbox, tag: 'div', class: 'field', error_class: 'error', hint_class: 'with_hint' do |b|
    b.use :html5
    b.wrapper tag: 'div', class: 'ui toggle checkbox' do |input|
      input.use :label_input
      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
    end
  end

  config.wrappers :ui_left_labled_input, tag: 'div', class: 'field', error_class: 'error', hint_class: 'with_hint' do |b|
    b.use :html5
    b.use :label

    b.wrapper tag: 'div', class: 'ui left labeled input' do |input|
      input.use :input
      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
    end
  end

  config.wrappers :ui_right_labled_input, tag: 'div', class: 'field', error_class: 'error', hint_class: 'with_hint' do |b|
    b.use :html5
    b.use :label

    b.wrapper tag: 'div', class: 'ui right labeled input' do |input|
      input.use :input
      input.use :hint,  wrap_with: { tag: 'div', class: 'hint' }
    end
  end

  # The default wrapper to be used by the FormBuilder.
  # config.default_wrapper = :default
  config.default_wrapper = :semantic

  # Define the way to render check boxes / radio buttons with labels.
  # Defaults to :nested for bootstrap config.
  #   inline: input + label
  #   nested: label > input
  config.boolean_style = :inline

  # Default class for buttons
  config.button_class = 'ui primary submit button'

  # Method used to tidy up errors. Specify any Rails Array method.
  # :first lists the first message for each field.
  # Use :to_sentence to list all errors for each field.
  config.error_method = :first

  # Default tag used for error notification helper.
  config.error_notification_tag = :div

  # CSS class to add for error notification helper.
  config.error_notification_class = 'alert alert-error'

  # ID to add for error notification helper.
  # config.error_notification_id = nil

  # Series of attempts to detect a default label method for collection.
  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]

  # Series of attempts to detect a default value method for collection.
  # config.collection_value_methods = [ :id, :to_s ]

  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
  # config.collection_wrapper_tag = :div

  # You can define the class to use on all collection wrappers. Defaulting to none.
  # config.collection_wrapper_class = 'field'

  # You can wrap each item in a collection of radio/check boxes with a tag,
  # defaulting to :span. Please note that when using :boolean_style = :nested,
  # SimpleForm will force this option to be a label.
  config.item_wrapper_tag = :div

  # You can define a class to use in all item wrappers. Defaulting to none.
  config.item_wrapper_class = 'ui checkbox'

  # How the label text should be generated altogether with the required text.
  # config.label_text = lambda { |label, required, explicit_label| "#{required} #{label}" }
  config.label_text = lambda { |label, required, explicit_label| "#{label}" }
  # Semantic UI has its own astrick

  # You can define the class to use on all labels. Default is nil.
  # config.label_class = nil

  # You can define the class to use on all forms. Default is simple_form.
  config.default_form_class = 'ui form'

  # You can define which elements should obtain additional classes
  # config.generate_additional_classes_for = [:wrapper, :label, :input]

  # Whether attributes are required by default (or not). Default is true.
  # config.required_by_default = true

  # Tell browsers whether to use the native HTML5 validations (novalidate form option).
  # These validations are enabled in SimpleForm's internal config but disabled by default
  # in this configuration, which is recommended due to some quirks from different browsers.
  # To stop SimpleForm from generating the novalidate option, enabling the HTML5 validations,
  # change this configuration to true.
  config.browser_validations = false

  # Collection of methods to detect if a file type was given.
  # config.file_methods = [ :mounted_as, :file?, :public_filename ]

  # Custom mappings for input types. This should be a hash containing a regexps
  # to match as key, and the input type that will be used when the field name
  # matches the regexp as value.
  # config.input_mappings = { /count/ => :integer }

  # Custom wrappers for input types. This should be a hash containing an input
  # type as key and the wrapper that will be used for all inputs with specified type.
  # config.wrapper_mappings = { string: :prepend }

  # Namespaces where SimpleForm should look for custom input classes that
  # override default inputs.
  # config.custom_inputs_namespaces << "CustomInputs"

  # Default priority for time_zone inputs.
  # config.time_zone_priority = nil

  # Default priority for country inputs.
  # config.country_priority = nil

  # When false, do not use translations for labels.
  # config.translate_labels = true

  # Automatically discover new inputs in Rails' autoload path.
  # config.inputs_discovery = true

  # Cache SimpleForm inputs discovery
  # config.cache_discovery = !Rails.env.development?

  # Default class for inputs
  # config.input_class = nil

  # Define the default class of the input wrapper of the boolean input.
  config.boolean_label_class = 'checkbox'

  # Defines if the default input wrapper class should be included in radio
  # collection wrappers.
  # config.include_default_input_wrapper_class = true

  # Defines which i18n scope will be used in Simple Form.
  # config.i18n_scope = 'simple_form'
end

#dh(str = '') ⇒ String

Highlight the default values for specified flag

Parameters:

  • str (String) (defaults to: '') —

    The default values for the specified parameter

Returns:

  • (String) —

    the specified text string surrounded by terminal string highlights



108
109
110
111
112
113
 
# File 'lib/kowl/helpers.rb', line 108

def dh(str = '')
  return '' if str.blank?

  str = str.split(': ')
  str.count > 1 ? "\e[36m#{str[0]}: \e[31m#{str[1]}\e[0m" : "\e[34m#{str[0]}\e[0m"
end

#dotfile_databases(database, env) ⇒ String

Used to create and return the .env file database configuration for the specific environment

Parameters:

  • database (String) —

    the database adapter in which the application will be connecting to

  • env (String) —

    the environment which the env file is bring created for

Returns:

  • (String) —

    a list of database parameters for the specific database connection



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/kowl/helpers.rb', line 119

def dotfile_databases(database, env)
  return '' if database == 'sqlite3'

  db = { username: "DB_USER=appUser123\n",
         password: "DB_PASSWORD=App($)Password\n",
         sid: '',
         host: '' }

  case database
  when 'oracle'
    db = { username: "DB_USER=system\n",
           password: "DB_PASSWORD=oracle\n",
           sid: "DB_SID=xe\n" }
  when 'sqlserver'
    db[:username] = "DB_USER=SA\n"
    db[:password] = "DB_PASSWORD=yourStrong(!)Password\n"
  end
  db[:host] = "DB_HOST=localhost\n" unless env == 'docker'

  "#{db[:username]}#{db[:password]}#{db[:host]}#{db[:sid]}"
end

#gem_options(gem) ⇒ String

If the requested gem requires additional options (ie: require: false) return this

Parameters:

  • gem (String) —

    The specified gem you want to use

Returns:

  • (String) —

    If the gem requires additional opotions in the gemfile, return these as a string



56
57
58
59
60
61
 
# File 'lib/kowl/helpers.rb', line 56

def gem_options(gem)
  return '' unless gem.options.any?

  options_str = gem.options.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')
  ", #{options_str}" unless options_str.blank?
end

#gem_to_gemfile(gem) ⇒ String

github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/app/templates/Gemfile.tt#L9 Add a gem to the Gemfile

Parameters:

  • gem (String) —

    Specfic gem name that you want to add to the gemfile

Returns:

  • (String) —

    Returns the gem entry for the gemfile



34
35
36
37
38
39
40
41
 
# File 'lib/kowl/helpers.rb', line 34

def gem_to_gemfile(gem)
  gem_str = <<~GEM
    #{gem.comment ? "# #{gem.comment}" : ''}
    #{(gem.commented_out ? '#' : '')}gem '#{gem.name}'#{gem_version_str(gem)}#{gem_options(gem)}
  GEM

  gem_str.strip
end

#gem_version_str(gem) ⇒ String

If the gem requires a specific version, determine it

Parameters:

  • gem (String) —

    • To determine if the specified gems requires a specific version to run with the application

Returns:

  • (String) —

    • If the gem require a specific version, it will return that version entry for the gemfile



46
47
48
49
50
51
 
# File 'lib/kowl/helpers.rb', line 46

def gem_version_str(gem)
  return '' unless gem.version

  # "#{gem.version ? ", '#{gem.version}'" : ''}"
  ", '#{gem.version}'"
end

#gemfile_requirement(name) ⇒ Object

Method required when processing the gemfile

- https://raw.githubusercontent.com/liukun-lk/rails_start_template/master/template.rb
- https://github.com/manuelvanrijn/rails-template/blob/master/template.rb

Parameters:

  • name (String) —

    Specific gem you are wanting to check the requirements for



12
13
14
15
16
 
# File 'lib/kowl/helpers.rb', line 12

def gemfile_requirement(name)
  @original_gemfile ||= IO.read('Gemfile')
  req = @original_gemfile[/gem\s+['"]#{name}['"]\s*(,[><~= \t\d\.\w'"]*)?.*$/, 1]
  req && req.tr("'", %(")).strip.sub(/^,\s*"/, ', "')
end

#highlight(str = '') ⇒ String

Highlight the specific string

Parameters:

  • str (String) (defaults to: '') —

    The string in which you wish to highlight

Returns:

  • (String) —

    The specified string concatenated between terminal encoded character sequences



98
99
100
101
102
103
 
# File 'lib/kowl/helpers.rb', line 98

def highlight(str = '')
  return '' if str.blank?

  str = str.split('=')
  str.count > 1 ? "\e[32m#{str[0]}=\e[33m#{str[1]}\e[0m" : "\e[32m#{str[0]}\e[0m"
end

#indent_all_lines(str, spaces = 2) ⇒ String

If you want all lines of the string to be indented a specific amount

Parameters:

  • str (String) —

    • The multiline string in which you want to indent

Returns:

  • (String) —

    • An indented version of thee string that was passed to the function



73
74
75
76
77
 
# File 'lib/kowl/helpers.rb', line 73

def indent_all_lines(str, spaces = 2)
  return '' if str.nil? || str.blank?

  str.strip.split(/\n/).map { |line| optimize_indentation(line, spaces.to_i) }.join('')
end

#mk_appdir(dir) ⇒ Object

Make a directory in the applications directory path

Parameters:

  • dir (String) —

    The name of the directory you want to create



65
66
67
68
 
# File 'lib/kowl/helpers.rb', line 65

def mk_appdir(dir)
  path = Rails.root.join(dir)
  FileUtils.mkdir(path) unless File.directory?(path)
end

#template_engine_gem_str(css_framework = '') ⇒ String

Determine which gem will be used for the projects CSS framework

Parameters:

  • css_framework (String) (defaults to: '') —

    Which CSSFramework the developer wants to use with the application

Returns:

  • (String) —

    The specific gem that will be used for the applications CSS framework



21
22
23
24
25
26
27
28
 
# File 'lib/kowl/helpers.rb', line 21

def template_engine_gem_str(css_framework = '')
  case css_framework.to_s
  when 'semantic'
    'semantic_ui'
  else
    'bootstrap'
  end
end

#with_versioning ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
 
# File 'lib/kowl/templates/tests/minitest/support/papertrail.rb', line 5

def with_versioning
  was_enabled = PaperTrail.enabled?
  was_enabled_for_request = PaperTrail.request.enabled?
  PaperTrail.enabled = true
  PaperTrail.request.enabled = true
  begin
    yield
  ensure
    PaperTrail.enabled = was_enabled
    PaperTrail.request.enabled = was_enabled_for_request
  end
end