Module: TypedEnums

Defined in:
lib/typed_enums.rb,
lib/typed_enums/error.rb,
lib/typed_enums/railtie.rb,
lib/typed_enums/version.rb,
lib/typed_enums/watcher.rb,
lib/typed_enums/registry.rb,
lib/typed_enums/configuration.rb,
lib/typed_enums/model_scanner.rb,
lib/typed_enums/output/writer.rb,
lib/typed_enums/enum_definition.rb,
lib/typed_enums/naming/name_builder.rb,
lib/typed_enums/output/writer/result.rb,
lib/typed_enums/output/javascript_file.rb,
lib/generators/typed_enums/install_generator.rb,
lib/typed_enums/output/type_declaration_file.rb

Defined Under Namespace

Modules: Naming, Output Classes: Configuration, ConfigurationError, EnumDefinition, Error, InstallGenerator, ModelScanner, Railtie, Registry, Watcher

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.check(logger: nil) ⇒ Object 



35
36
37
 
# File 'lib/typed_enums.rb', line 35

def check(logger: nil)
  write(check: true, logger:)
end

.configuration ⇒ Object 



19
20
21
 
# File 'lib/typed_enums.rb', line 19

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



23
24
25
 
# File 'lib/typed_enums.rb', line 23

def configure
  yield configuration
end

.generate(logger: nil) ⇒ Object 



31
32
33
 
# File 'lib/typed_enums.rb', line 31

def generate(logger: nil)
  write(check: false, logger:)
end

.reset_configuration! ⇒ Object 



27
28
29
 
# File 'lib/typed_enums.rb', line 27

def reset_configuration!
  @configuration = Configuration.new
end

.stop_watcher ⇒ Object 



43
44
45
 
# File 'lib/typed_enums.rb', line 43

def stop_watcher
  Watcher.stop
end

.watch(logger: nil) ⇒ Object 



39
40
41
 
# File 'lib/typed_enums.rb', line 39

def watch(logger: nil)
  Watcher.start(logger: logger || default_logger)
end