Class: RbsRails::CLI::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Singleton
Defined in:
lib/rbs_rails/cli/configuration.rb,
sig/rbs_rails/cli/configuration.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

: void



25
26
27
28
29
# File 'lib/rbs_rails/cli/configuration.rb', line 25

def initialize #: void
  @signature_root_dir = nil
  @ignore_model_if = nil
  @check_db_migrations = true
end

Instance Attribute Details

#check_db_migrationsBoolean

@rbs! @signature_root_dir: Pathname? @ignore_model_if: (^(singleton(ActiveRecord::Base)) -> bool)?

Returns:

  • (Boolean)


23
24
25
# File 'lib/rbs_rails/cli/configuration.rb', line 23

def check_db_migrations
  @check_db_migrations
end

Class Method Details

.configure {|arg0| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

Yield Returns:

  • (void)


10
# File 'sig/rbs_rails/cli/configuration.rbs', line 10

def self.configure: () { (Configuration) -> void } -> void

.instanceConfiguration

Returns:



8
# File 'sig/rbs_rails/cli/configuration.rbs', line 8

def self.instance: () -> Configuration

Instance Method Details

#configure {|arg0| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

Yield Returns:

  • (void)


32
33
34
# File 'lib/rbs_rails/cli/configuration.rb', line 32

def configure(&block) #: void
  block.call(self)
end

#ignore_model_if {|arg0| ... } ⇒ void

This method returns an undefined value.

Yields:

Yield Parameters:

  • arg0 (singleton(ActiveRecord::Base))

Yield Returns:

  • (Boolean)


53
54
55
# File 'lib/rbs_rails/cli/configuration.rb', line 53

def ignore_model_if(&block) #: void
  @ignore_model_if = block
end

#ignored_model?(klass) ⇒ Boolean

Parameters:

  • klass (singleton(ActiveRecord::Base))

Returns:

  • (Boolean)


58
59
60
61
62
63
# File 'lib/rbs_rails/cli/configuration.rb', line 58

def ignored_model?(klass) #: bool
  ignore_model_if = @ignore_model_if
  return false unless ignore_model_if

  ignore_model_if.call(klass)
end

#signature_root_dirPathname

: Pathname

Returns:

  • (Pathname)


36
37
38
# File 'lib/rbs_rails/cli/configuration.rb', line 36

def signature_root_dir #: Pathname
  @signature_root_dir || Rails.root.join("sig/rbs_rails")
end

#signature_root_dir=(dir) ⇒ Pathname

Parameters:

  • dir (String, Pathname)

Returns:

  • (Pathname)


41
42
43
44
45
46
47
48
49
50
# File 'lib/rbs_rails/cli/configuration.rb', line 41

def signature_root_dir=(dir) #: Pathname
  @signature_root_dir = case dir
                      when String
                        Pathname.new(dir)
                      when Pathname
                        dir
                      else
                        raise ArgumentError, "signature_root_dir must be String or Pathname"
                      end
end