Class: MoneyRailsPlugin

Inherits:
SorbetRails::ModelPlugins::Base show all
Defined in:
lib/sorbet-rails/gem_plugins/money_rails_plugin.rb

Overview

typed: strict

Constant Summary

Constants inherited from SorbetRails::ModelPlugins::Base

SorbetRails::ModelPlugins::Base::Parameter

Instance Attribute Summary

Attributes inherited from SorbetRails::ModelPlugins::Base

#available_classes, #model_class

Instance Method Summary collapse

Methods inherited from SorbetRails::ModelPlugins::Base

#initialize, #serialization_coder_for_column

Methods included from SorbetRails::ModelUtils

#add_relation_query_method, #exists_class_method?, #exists_instance_method?, #habtm_class?, #model_assoc_proxy_class_name, #model_assoc_relation_class_name, #model_class_name, #model_module_name, #model_query_methods_returning_assoc_relation_module_name, #model_query_methods_returning_relation_module_name, #model_relation_class_name, #model_relation_type_alias, #model_relation_type_class_name

Methods included from SorbetRails::ModelColumnUtils

#active_record_type_to_sorbet_type, #attribute_has_unconditional_presence_validation?, #model_class, #nilable_column?, #time_zone_aware_column?, #type_for_column_def

Constructor Details

This class inherits a constructor from SorbetRails::ModelPlugins::Base

Instance Method Details

#allows_nil(attribute) ⇒ Object 



4
5
6
7
8
9
10
11
12
 
# File 'lib/sorbet-rails/gem_plugins/money_rails_plugin.rb', line 4

def allows_nil(attribute)
  validators = model_class.validators_on(attribute)
  return false if validators.empty?

  validators.any? do |validator|
    validator.respond_to?(:options) &&
      validator.options[:allow_nil]
  end
end

#generate(root) ⇒ Object 



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
 
# File 'lib/sorbet-rails/gem_plugins/money_rails_plugin.rb', line 15

def generate(root)
  return unless exists_class_method?(:monetize)

  # money-rails gives us a hash mapping the monetized attribute to its subunit
  # equivalent, eg: `{"price": "price_cents"}`
  monetized_attributes = T.let(
    T.unsafe(model_class).monetized_attributes,
    T::Hash[String,String]
  )

  return if monetized_attributes.empty?

  module_name = model_module_name("GeneratedMoneyRailsMethods")
  module_rbi = root.create_module(module_name)

  model_class_rbi = root.create_class(model_class_name)
  model_class_rbi.create_include(module_name)

  monetized_attributes.each do |name, subunit_name|
    validators = model_class.validators_on(name)

    money_attribute_type = allows_nil(name) ? "T.nilable(::Money)" : "::Money"
    subunit_attribute_type = allows_nil(name) ? "T.nilable(Integer)" : "Integer"

    module_rbi.create_method(
      name,
      return_type: money_attribute_type
    )

    module_rbi.create_method(
      subunit_name,
      return_type: subunit_attribute_type
    )

    module_rbi.create_method(
      "#{name}_money_before_type_cast",
      return_type: 'T.untyped'
    )

    module_rbi.create_method(
      "#{name}=",
      parameters:  [
         Parlour::RbiGenerator::Parameter.new("value", type: money_attribute_type)
      ],
      return_type: nil
    )

    module_rbi.create_method(
      "#{subunit_name}=",
      parameters:  [
         Parlour::RbiGenerator::Parameter.new("value", type: subunit_attribute_type)
      ],
      return_type: nil
    )

    module_rbi.create_method(
      "currency_for_#{name}",
      return_type: "T.nilable(::Money::Currency)"
    )
  end
end