Module: EffectiveResources

Includes:
EffectiveGem
Defined in:
lib/effective_resources.rb,
lib/effective_resources/engine.rb,
lib/effective_resources/version.rb,
lib/generators/effective_resources/install_generator.rb

Defined Under Namespace

Modules: Generators Classes: Engine

Constant Summary collapse

MAILER_SUBJECT_PROC = 
Proc.new { |action, subject, resource, opts = {}| subject }
VERSION = 
'2.18.3'.freeze

Constants included from EffectiveGem

EffectiveGem::EXCLUDED_GETTERS

Class Method Summary collapse

Class Method Details

.advance_date(date, business_days: 1, holidays: [:us, :observed]) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/effective_resources.rb', line 128

def self.advance_date(date, business_days: 1, holidays: [:us, :observed])
  raise('business_days must be an integer <= 365') unless business_days.kind_of?(Integer) && business_days <= 365

  business_days.times do
    loop do
      date = date + 1.day
      break if business_day?(date, holidays: holidays)
    end
  end

  date
end

.authorize!(controller, action, resource) ⇒ Object

Raises:



37
38
39
 
# File 'lib/effective_resources.rb', line 37

def self.authorize!(controller, action, resource)
  raise Effective::AccessDenied.new('Access Denied', action, resource) unless authorized?(controller, action, resource)
end

.authorized?(controller, action, resource) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/effective_resources.rb', line 24

def self.authorized?(controller, action, resource)
  @exceptions ||= [Effective::AccessDenied, (CanCan::AccessDenied if defined?(CanCan)), (Pundit::NotAuthorizedError if defined?(Pundit))].compact

  return !!authorization_method unless authorization_method.respond_to?(:call)
  controller = controller.controller if controller.respond_to?(:controller)

  begin
    !!(controller || self).instance_exec((controller || self), action, resource, &authorization_method)
  rescue *@exceptions
    false
  end
end

.best(name) ⇒ Object

This looks up the best class give the name If the Tenant is present, use those classes first.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/effective_resources.rb', line 89

def self.best(name)
  klass = if defined?(Tenant)
    ('::' + Tenant.module_name + '::' + name).safe_constantize ||
    ('::' + Tenant.module_name + '::Effective::' + name).safe_constantize
  end

  klass ||= begin
    ('::' + name).safe_constantize ||
    ('::Effective::' + name).safe_constantize
  end

  raise("unable to find best #{name}") if klass.blank?

  klass
end

.business_day?(date, holidays: [:us, :observed]) ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
144
 
# File 'lib/effective_resources.rb', line 141

def self.business_day?(date, holidays: [:us, :observed])
  require 'holidays' unless defined?(Holidays)
  date.wday != 0 && date.wday != 6 && Holidays.on(date, *holidays).blank?
end

.clone_blob(blob, options = {}) ⇒ Object

stackoverflow.com/questions/66103388/attach-activestorage-blob-with-a-different-filename



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
 
# File 'lib/effective_resources.rb', line 147

def self.clone_blob(blob, options = {})
  raise('expected an ActiveStorage::Blob') unless blob.kind_of?(ActiveStorage::Blob)

  atts = {
    filename: blob.filename,
    byte_size: blob.byte_size,
    checksum: blob.checksum,
    content_type: blob.content_type,
    metadata: blob.metadata,
  }.merge(options)

  service = blob.service
  duplicate = ActiveStorage::Blob.create_before_direct_upload!(**atts)

  case service.class.name
  when 'ActiveStorage::Service::S3Service', 'ActiveStorage::Service::S3NoDeleteService'
    bucket = service.bucket
    object = bucket.object(blob.key)
    object.copy_to(bucket.object(duplicate.key))
  when 'ActiveStorage::Service::DiskService'
    path = service.path_for(blob.key)
    duplicate_path = service.path_for(duplicate.key)
    FileUtils.mkdir_p(File.dirname(duplicate_path))
    FileUtils.ln(path, duplicate_path) if File.exist?(path)
  else
    raise "unknown storage service #{service.class.name}"
  end

  duplicate
end

.config_keys ⇒ Object 



10
11
12
13
14
15
 
# File 'lib/effective_resources.rb', line 10

def self.config_keys
  [
    :authorization_method, :default_submits,
    :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_froms, :mailer_admin, :mailer_subject
  ]
end

.default_submits ⇒ Object 



41
42
43
 
# File 'lib/effective_resources.rb', line 41

def self.default_submits
  (['Save', 'Continue', 'Add New'] & Array(config.default_submits)).inject({}) { |h, v| h[v] = true; h }
end

.deliver_method ⇒ Object

Mailer Settings These serve as the default mailer settings for all effective_* gems They can be overriden on a per-gem basis.



48
49
50
51
52
53
 
# File 'lib/effective_resources.rb', line 48

def self.deliver_method
  return config[:deliver_method] if config[:deliver_method].present?

  rails = Rails.application.config
  (rails.respond_to?(:active_job) && rails.active_job.queue_adapter) ? :deliver_later : :deliver_now
end

.et(resource, attribute = nil) ⇒ Object

effective_translate



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

def self.et(resource, attribute = nil)
  if resource.respond_to?(:datatable_name)
    resource.datatable_name
  elsif resource.respond_to?(:model_name) == false # Just a string. Fees will do this
    value = I18n.t(resource)
    raise StandardError.new("Missing translation: #{resource}") if value.include?(resource)
    value
  elsif attribute.blank?
    resource.model_name.human
  elsif resource.respond_to?(:human_attribute_name)
    resource.human_attribute_name(attribute)
  else
    resource.class.human_attribute_name(attribute)
  end
end

.etd(resource, attribute = nil) ⇒ Object 



214
215
216
 
# File 'lib/effective_resources.rb', line 214

def self.etd(resource, attribute = nil)
  et(resource, attribute).downcase
end

.ets(resource, attribute = nil) ⇒ Object 



218
219
220
 
# File 'lib/effective_resources.rb', line 218

def self.ets(resource, attribute = nil)
  et(resource, attribute).pluralize
end

.etsd(resource, attribute = nil) ⇒ Object 



222
223
224
 
# File 'lib/effective_resources.rb', line 222

def self.etsd(resource, attribute = nil)
  et(resource, attribute).pluralize.downcase
end

.mailer_admin ⇒ Object 



68
69
70
 
# File 'lib/effective_resources.rb', line 68

def self.mailer_admin
  config[:mailer_admin] || raise('effective resources mailer_admin missing. Add it to config/initializers/effective_resources.rb')
end

.mailer_froms ⇒ Object 



76
77
78
 
# File 'lib/effective_resources.rb', line 76

def self.mailer_froms
  config[:mailer_froms].presence || [mailer_sender]
end

.mailer_layout ⇒ Object 



60
61
62
 
# File 'lib/effective_resources.rb', line 60

def self.mailer_layout
  config[:mailer_layout] || 'effective_mailer_layout'
end

.mailer_sender ⇒ Object 



72
73
74
 
# File 'lib/effective_resources.rb', line 72

def self.mailer_sender
  config[:mailer_sender] || raise('effective resources mailer_sender missing. Add it to config/initializers/effective_resources.rb')
end

.mailer_subject ⇒ Object 



64
65
66
 
# File 'lib/effective_resources.rb', line 64

def self.mailer_subject
  config[:mailer_subject] || MAILER_SUBJECT_PROC
end

.mailer_subject_prefix_hint ⇒ Object

This is used by the effective_email_templates form



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

def self.mailer_subject_prefix_hint
  instance_exec(:mailer_subject_blank_prefix, nil, nil, nil, &mailer_subject) if mailer_subject.respond_to?(:call)
end

.parent_mailer_class ⇒ Object 



55
56
57
58
 
# File 'lib/effective_resources.rb', line 55

def self.parent_mailer_class
  return config[:parent_mailer].constantize if config[:parent_mailer].present?
  '::ApplicationMailer'.safe_constantize || 'ActionMailer::Base'.constantize
end

.replace_nested_attributes(attributes) ⇒ Object 



191
192
193
194
195
 
# File 'lib/effective_resources.rb', line 191

def self.replace_nested_attributes(attributes)
  attributes.reject { |k, values| truthy?(values[:_destroy]) }.inject({}) do |h, (key, values)|
    h[key] = values.reject { |k, v| k == 'id' || k == '_destroy' }; h
  end
end

.serialize_with_coder? ⇒ Boolean

We use the newer syntax for serialize calls in rails 7+

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/effective_resources.rb', line 20

def self.serialize_with_coder?
  Gem::Version.new(Gem.loaded_specs['rails'].version.to_s) >= Gem::Version.new('7')
end

.transaction(resource = nil, &block) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/effective_resources.rb', line 178

def self.transaction(resource = nil, &block)
  raise('expected a block') unless block_given?

  if resource.respond_to?(:transaction)
    resource.transaction { yield }
  elsif resource.class.respond_to?(:transaction)
    resource.class.transaction { yield }
  else
    ActiveRecord::Base.transaction { yield }
  end

end

.truthy?(value) ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
123
124
125
126
 
# File 'lib/effective_resources.rb', line 120

def self.truthy?(value)
  if defined?(::ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES)  # Rails <5
    ::ActiveRecord::ConnectionAdapters::Column::TRUE_VALUES.include?(value)
  else
    ::ActiveRecord::Type::Boolean.new.cast(value)
  end
end

.with_resource_enumerator(&block) ⇒ Object

Used by streaming CSV export in datatables



106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/effective_resources.rb', line 106

def self.with_resource_enumerator(&block)
  raise('expected a block') unless block_given?

  tenant = Tenant.current if defined?(Tenant)

  if tenant
    Enumerator.new do |enumerator|
      Tenant.as(tenant) { yield(enumerator) }
    end
  else
    Enumerator.new { |enumerator| yield(enumerator) }
  end
end