Module: Lizarb

Defined in:
lib/lizarb.rb,
lib/lizarb/version.rb

Defined Under Namespace

Classes: Error, ModeNotFound, SystemNotFound

Constant Summary collapse

VERSION = 
"1.0.8"

Class Method Summary collapse

Class Method Details

._require_system(key) ⇒ Object 



742
743
744
745
746
747
748
749
750
 
# File 'lib/lizarb.rb', line 742

def _require_system key
  key = "#{key}_system"
  log "        require '#{key}'" if defined? $log_boot_highest
  require key
  Object.const_get key.camelize
rescue LoadError => e
  def e.backtrace; []; end
  raise SystemNotFound, "FILE #{key}.rb not found on $LOAD_PATH", []
end

.eager_load! ⇒ Object 



853
854
855
856
857
858
859
 
# File 'lib/lizarb.rb', line 853

def eager_load!
  return if eager_loaded?
  log "Lizarb.#{__method__} begin" if defined? $log_boot_high
  @eager_loaded = true
  loaders[1].eager_load
  log "Lizarb.#{__method__} end" if defined? $log_boot_high
end

.eager_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


861
862
863
 
# File 'lib/lizarb.rb', line 861

def eager_loaded?
  !!@eager_loaded
end

.exit_messages ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/lizarb.rb', line 346

def exit_messages
  info = {
    ruby: RUBY_VERSION,
    bundler: Bundler::VERSION,
    zeitwerk: Zeitwerk::VERSION,
    lizarb: VERSION,
    app: $APP,
    mode: App.mode,
    log_boot: App.log_boot,
    log_level: App.log_level,
  }
  github = "https://github.com/lizarb/lizarb"
  puts info.to_s
  puts "Report bugs at #{github}/issues"
  puts "Fork us on Github at #{github}/fork"
end

.init_project!(executable) ⇒ Object

Initialize LizaRB as a project

  • You must provide FILE as argument to this method.


167
168
169
170
171
172
 
# File 'lib/lizarb.rb', line 167

def init_project! executable
  pwd = Dir.pwd
  $LOAD_PATH.unshift "#{pwd}/lib" if File.directory? "#{pwd}/lib"
  setup_project pwd, project: executable
  load
end

.init_script_dependent!(*systems, app:) ⇒ Object

Initialize LizaRB as a dependent script.

  • You must provide the app key.
  • You may provide an array of system keys.

Raises:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/lizarb.rb', line 178

def init_script_dependent!(
  *systems,
  app:
)
  pwd = Dir.pwd
  $LOAD_PATH.unshift "#{pwd}/lib" if File.directory? "#{pwd}/lib"
  cl = caller_locations(1, 1)[0]
  
  raise Lizarb::Error, "Lizarb.#{__method__} does not support app_global, use Lizarb.sfa" if app == "app_global"
  raise Lizarb::Error, "#{app.inspect} does not start with 'app_'" unless app == "app" or app.to_s.start_with? "app_"

  segments = cl.absolute_path.split("/")
  root, script = segments[0..-3].join("/"), segments[-2..-1].join("/")

  setup_script_dependent root, script: script, script_app: app

  App.class_exec do
    self.systems.clear if systems.any?
    systems.each do |key|
      system key
    end
  end
  load
end

.init_script_independent!(*systems, mode: :code, folder: nil, gemfile: nil, log_handler: :output, log_boot: nil, log_level: nil, log: nil, pwd:) ⇒ Object

Initialize LizaRB as an independent script.

  • You may provide all app configurations.
  • You may provide some dev_box configurations.
  • You may provide an array of system keys.


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/lizarb.rb', line 208

def init_script_independent!(
  *systems,
  mode: :code,
  folder: nil,
  gemfile: nil,
  log_handler: :output,
  log_boot: nil,
  log_level: nil,
  log: nil,
  pwd: 
)
  log_boot  ||= log if log
  log_level ||= log if log
  log_boot  ||= :normal
  log_level ||= :normal
  
  cl = caller_locations(1, 1)[0]
  
  script = cl.absolute_path

  setup_script_independent pwd, script: script

  App.class_exec do
    self.gemfile gemfile if gemfile
    self.folder folder if folder
    self.log_boot log_boot
    self.log_level log_level
    self.mode mode
    system :dev
    systems.each do |key|
      system key
    end
  end
  
  load

  DevSystem::DevBox.configure :log do
    handler log_handler
  end
end

.load ⇒ Object

The load phase is determined by containing the least amount of code needed after requiring configuration class App.

The load method orchestrates the following steps:

  1. Properly requires gem "bundler" for managing gem your dependencies.
  2. Requires essential Ruby libraries, not required by default.
  3. Enables or disables coding mode for debugging purposes.
  4. Loads environment variables from the following .env files.
  5. Requires award-winning gem Zeitwerk to manage autoloading of Ruby classes.
  6. Requires the Liza module, and its constants are required on demand by zeitwerk.
  7. Requires all system-gems, then requires each system class.
  8. Initializes Lizarb.loaders with the systems directories and the application directory.


330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/lizarb.rb', line 330

def load
  log "  Lizarb.#{__method__}" if defined? $log_boot_high

  load_and_require_bundler
  load_and_require_default_gems
  load_and_define_mode
  load_and_require_env_vars
  load_and_zeitwerk
  load_and_zeitwerk_loader_0_liza
  load_and_require_system_classes
  load_and_zeitwerk_loader_1_app
  App.after if defined? App.after

  log "  Lizarb.#{__method__} done" if defined? $log_boot_high
end

.load_and_define_mode ⇒ Object

This method is called internally by load and is not intended for direct use.

Enables or disables coding mode for debugging purposes:

  • Sets the global $mode variable to the application mode.
  • Sets the global $coding variable to true if the application mode is :code.


608
609
610
611
612
613
614
615
 
# File 'lib/lizarb.rb', line 608

def load_and_define_mode
  log "  Lizarb.#{__method__}" if defined? $log_boot_high

  $mode = App.mode
  log "    $mode = #{$mode.inspect}" if defined? $log_boot_higher
  $coding = App.coding?
  log "    $coding enabled because $mode == :code | A bit slower for debugging purposes" if $coding && defined? $log_boot_higher
end

.load_and_require_bundler ⇒ Object

This method is called internally by load and is not intended for direct use.

Properly requires gem "bundler" for managing gem your dependencies:

Up until now, require referred to the Ruby standard library. From this point on, require will refer to what is in the Gemfile.

  • If App.gemfile is a String, sets the BUNDLE_GEMFILE environment variable to the specified gemfile.
  • If App.gemfile is a Proc, requires Bundler inline and evaluates the gemfile block.
  • Raises an error if App.gemfile is neither a String nor a Proc.


531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/lizarb.rb', line 531

def load_and_require_bundler
  log "  Lizarb.#{__method__}" if defined? $log_boot_high

  gf = App.gemfile
  case gf
  when String
    string = "#{ @config_folder }/#{ gf }"
    log "    requiring 'bundler/setup'" if defined? $log_boot_higher
    log "      ENV['BUNDLE_GEMFILE'] = #{ string.inspect }" if defined? $log_boot_highest
    ENV["BUNDLE_GEMFILE"] = string
    log "      require 'bundler/setup'" if defined? $log_boot_highest
    require 'bundler/setup'
  when Proc
    string = gf.source_location
    log "    requiring 'bundler/inline' with #{ string }" if defined? $log_boot_higher
    require 'bundler/inline'
    log "      required 'bundler/inline'" if defined? $log_boot_highest
    gemfile(false, &gf)
  else
    raise "App.gemfile is not a String or a Proc"
  end
rescue SystemExit => e
  raise unless e.cause&.class == Bundler::GemNotFound
  puts
  puts "LizaRB v#{version} dependencies not found."
  puts "LizaRB is installing the dependencies found in the above gemfile."
  puts
  Kernel.system "bundle install --gemfile #{ENV["BUNDLE_GEMFILE"]}"
  puts
  puts "Please, run the latest command again."
  puts
  raise
end

.load_and_require_default_gems ⇒ Object

This method is called internally by load and is not intended for direct use.

Requires essential Ruby libraries, not required by default:

Requires the following default gems:

  • pathname for handling file paths.
  • time for Time parsing.

Converts the following instance variables to Pathname objects:

  • Lizarb: @root, @gem_dir, @config_path
  • App: @relative_path, @path


577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/lizarb.rb', line 577

def load_and_require_default_gems
  log "  Lizarb.#{__method__}" if defined? $log_boot_high
  
  log "    require 'pathname'" if defined? $log_boot_higher
  require "pathname"
  
  # this adds method Time.parse
  log "    require 'time'" if defined? $log_boot_higher
  require "time"

  log "      fixing instance variables" if defined? $log_boot_highest
  @root = Pathname(@root)
  @gem_dir = Pathname(@gem_dir)
  @config_path = Pathname(@config_path)

  App.instance_eval do
    @directory = root / directory
    @systems_directory = root / systems_directory_name

    @relative_path = Pathname(@relative_path)
    @path = Pathname(@path)
  end
end

.load_and_require_env_vars ⇒ Object

This method is called internally by load and is not intended for direct use.

Loads environment variables from the given .env files.

If the file is not found, it raises an error if the file is mandatory. Values will be overwritten if the same key is found in a subsequent file.

If the gem "dotenv" is found, it delegates to it instead.



626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/lizarb.rb', line 626

def load_and_require_env_vars
  log "  Lizarb.#{__method__}" if defined? $log_boot_high

  files = App.env_vars || []
  log "    ENV variables from #{files.count} sources" if defined? $log_boot_higher

  return if files.empty?

  if Gem::Specification.find_all_by_name("dotenv").any?
    require "dotenv"
    log "    gem 'dotenv' found" if defined? $log_boot_higher

    Dotenv.load(*files)
    log "      Dotenv.load(*#{files.inspect})" if defined? $log_boot_highest

    return
  end

  files.each do |file|
    File.readlines(file).each do |line|
      line.strip!
      next if line.empty? or line.start_with? "#"

      key, value = line.split('=', 2).map(&:strip)
      ENV[key] = value
    end
    log "    ENV variables #{file}" if defined? $log_boot_higher
  rescue Errno::ENOENT
    log "    ENV variables not found #{file}" if defined? $log_boot_higher
    raise if App.env_vars_mandatory?
  end
end

.load_and_require_system_classes ⇒ Object

This method is called internally by load and is not intended for direct use.

Requires all system-gems, then requires each system class:

  • Requires all system-gems. These gems must be added to the gemfile under group :systems.
  • Requires each system class.
  • Freezes the App.systems hash.


723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/lizarb.rb', line 723

def load_and_require_system_classes
  log "  Lizarb.#{__method__} (#{App.systems.count})" if defined? $log_boot_high

  # bundle each System gem

  log "    Bundler.require :systems" if defined? $log_boot_higher

.load_and_zeitwerk ⇒ Object

This method is called internally by load and is not intended for direct use.

Requires award-winning gem Zeitwerk to manage autoloading of Ruby classes.



663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/lizarb.rb', line 663

def load_and_zeitwerk
  log "  Lizarb.#{__method__}" if defined? $log_boot_high
  require "zeitwerk"
  log "    required Zeitwerk" if defined? $log_boot_higher

  if App.systems_directory_name != "lib"
    path = App.systems_directory.to_s
    $LOAD_PATH << path
    log "    $LOAD_PATH << #{path}" if defined? $log_boot_higher
  end
end

.load_and_zeitwerk_loader_0_liza ⇒ Object

This method is called internally by load and is not intended for direct use.

Requires the Liza module, and its constants are required on demand by zeitwerk:

  • Requires the Liza module.
  • Initializes Lizarb.loaders with the liza directory.

lib/liza.rb lib/liza/unit.rb lib/liza/**/*.rb



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
 
# File 'lib/lizarb.rb', line 686

def load_and_zeitwerk_loader_0_liza
  log "  Lizarb.#{__method__}" if defined? $log_boot_high
  require "liza"
  log "    required Liza" if defined? $log_boot_higher

  # loaders[0] first loads Liza, then each System class

  log "    Zeitwerk loaders [0] first loads Liza, then each System class" if defined? $log_boot_higher

  loaders << loader = Zeitwerk::Loader.new
  loader.tag = Liza.to_s

  # collapse Liza paths

  # ORDER MATTERS: IGNORE, COLLAPSE, PUSH
  loader.collapse "#{Liza.source_location_radical}/**/*"
  loader.push_dir "#{Liza.source_location_radical}", namespace: Liza

  # loader setup

  log "      Setting up" if defined? $log_boot_higher
  loader.enable_reloading
  log "        loader.enable_reloading" if defined? $log_boot_highest
  loader.setup
  log "        loader.setup" if defined? $log_boot_highest
  loader.eager_load
  log "        loader.eager_load" if defined? $log_boot_highest
end

.load_and_zeitwerk_loader_1_app ⇒ Object

This method is called internally by load and is not intended for direct use.

Initializes Lizarb.loaders with the systems directories and the application directory:

  • For each system found in the application file, Zeitwerk namespaces their Liza::Unit sub-classes under the Liza::System sub-class. lib/dev_system.rb lib/dev_system/**/*.rb

  • For each box found in the application directory, Zeitwerk namespaces their Liza::Controller sub-classes under Object. app/dev_box.rb app/dev/**/*.rb



764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/lizarb.rb', line 764

def load_and_zeitwerk_loader_1_app
  log "  Lizarb.#{__method__}  (#{App.systems.count})" if defined? $log_boot_high

  # loaders[1] first loads each System, then the App
  log "    Zeitwerk loaders [1] first loads each System, then the App" if defined? $log_boot_higher
  loaders << loader = Zeitwerk::Loader.new

  # collapse each System paths

  App.systems.each do |k, klass|
    # ORDER MATTERS: IGNORE, COLLAPSE, PUSH
    loader.collapse "#{klass.source_location_radical}/**/*"
    loader.push_dir "#{klass.source_location_radical}", namespace: klass
  end

  # cherrypick App paths

  app_dir = App.path
  if app_dir
    log "      Application Directory: #{app_dir}" if defined? $log_boot_highest
    list = Dir["#{app_dir}/*"].to_set
  end

  if app_dir.nil? || list.empty?
    log "      Application Directory is empty" if defined? $log_boot_highest
  else
    log "      Application Directory found #{list.count} items to collapse" if defined? $log_boot_highest

    to_collapse = []

    App.systems.each do |k, klass|
      next if klass.subs.empty?

      box_dir  = "#{app_dir}/#{k}"
      box_file = "#{box_dir}_box.rb"
      next if !list.include? box_file

      log "        Found box file    #{box_file}" if defined? $log_boot_highest
      to_collapse << box_file

      if list.include? box_dir
        log "        Found controllers #{box_dir}" if defined? $log_boot_highest
        to_collapse << box_dir
      end
    end

    # ORDER MATTERS: IGNORE, COLLAPSE, PUSH
    to_ignore = list - to_collapse
    to_ignore.each do |file|
      log "      Ignoring   #{file}" if defined? $log_boot_highest
      loader.ignore file
    end

    to_collapse.each do |path|
      log "      Collapsing #{path}" if defined? $log_boot_highest
      if path.end_with? ".rb"
        loader.collapse path
      else
        loader.collapse "#{path}/**/*"
      end
    end
    loader.collapse "#{app_dir}/*"

    loader.push_dir app_dir, namespace: Object
  end

  # loader setup

  log "      Setting up" if defined? $log_boot_higher
  loader.enable_reloading
  log "        loader.enable_reloading" if defined? $log_boot_highest
  loader.setup
  log "        loader.setup" if defined? $log_boot_highest
end

.loaders ⇒ Object 



843
844
845
 
# File 'lib/lizarb.rb', line 843

def loaders
  @loaders
end

.log(s) ⇒ Object 



126
127
128
129
 
# File 'lib/lizarb.rb', line 126

def log s
  print "#{$boot_time.diff}s " if defined? $log_boot_high
  puts s
end

.reload(&block) ⇒ Object 



847
848
849
850
851
 
# File 'lib/lizarb.rb', line 847

def reload &block
  @eager_loaded = false
  loaders[1].reload
  true
end

.ruby_supports_raise_cause? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ruby_supports_raise_cause?
  RUBY_ENGINE != "jruby"
end

.ruby_version ⇒ Object

Returns RUBY_VERSION as a Gem::Version



137
138
139
 
# File 'lib/lizarb.rb', line 137

def ruby_version
  @ruby_version ||= Gem::Version.new RUBY_VERSION
end

.setup ⇒ Object

The setup phase is determined by containing the least amount of code needed before requiring configuration class App.

The setup method orchestrates the following steps:

  1. Determines the environment by setting various directory and configuration variables.
  2. Configures the application by loading the main application configuration file.
  3. Overwrites Application settings with environment variables.
  4. Defines log levels for the application based on the boot log level setting.


308
309
310
311
312
313
314
315
316
 
# File 'lib/lizarb.rb', line 308

def setup
  ENV["LOG_BOOT"] = ENV["LOG"] = "1" if ARGV[0] && ARGV[0][0] == "-"
  setup_and_determine_environment
  puts "Lizarb  #{__FILE__}" if $VERBOSE
  setup_and_configure_app
  puts "App     #{@config_path}\n\n" if $VERBOSE
  setup_and_overwrite_app_settings
  setup_and_define_log_levels
end

.setup_and_configure_app ⇒ Object

This method is called internally by setup and is not intended for direct use.

  • Requires the application definitions file lizarb/app.rb.
  • Searches for the application configuration file app.rb in both the application directory and the LizaRB directory.
  • Requires the configuration file if found.
  • Raises an error if the configuration file is not found.
  • Prints verbose output if $VERBOSE is enabled.

Raises:



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/lizarb.rb', line 420

def setup_and_configure_app
  # This is lib/app.rb
  require "app"

  finder = \
    proc do |path, file|
      lib_name = "#{path}/#{file}"
      app_config_path = "#{lib_name}.rb"
      puts "        #{app_config_path} exists?" if $VERBOSE
      if File.file? app_config_path
        # This is app.rb
        require lib_name
        @config_folder = path
        @config_path = app_config_path
        return
      end
    end

  finder.call @app_dir, $APP unless $APP == "app_global"
  finder.call @liz_dir, $APP

  raise Error, "Could not find #{$APP}.rb in #{@app_dir} or #{@liz_dir}"
end

.setup_and_define_log_levels ⇒ Object

This method is called internally by setup and is not intended for direct use.

Defines log levels for the application based on the boot log level setting:

  • Prints corresponding log messages if verbose output is enabled.
  • Sets $log_boot_* global variables as true if application boot level settings.

In other words:

$log_boot_highest = true if App.log_boot >= 7 # this number is for :highest $log_boot_higher = true if App.log_boot >= 6 # this number is for :higher $log_boot_high = true if App.log_boot >= 5 # this number is for :high $log_boot_normal = true if App.log_boot >= 4 # this number is for :normal $log_boot_low = true if App.log_boot >= 3 # this number is for :low $log_boot_lower = true if App.log_boot >= 2 # this number is for :lower $log_boot_lowest = true if App.log_boot >= 1 # this number is for :lowest



507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/lizarb.rb', line 507

def setup_and_define_log_levels
  level = App.log_boot
  is_highest = level == 7
  App::LOG_LEVELS.each do |k, v|
    puts "$log_boot_#{k} = #{v <= level}" if is_highest
    eval "$log_boot_#{k} = true" if v <= level
  end

  log "LizaRB v#{Lizarb.version}                                                                                                      https://lizarb.org" if defined? $log_boot_lower
  log "  log_boot is set to #{App.log_boot}" if defined? $log_boot_higher
  log "  log_level is set to #{App.log_level}" if defined? $log_boot_higher
end

.setup_and_determine_environment ⇒ Object

This method is called internally by setup and is not intended for direct use.

  • Checks for the presence of its signature files (app.rb, lib/lizarb.rb, and lizarb.gemspec) in the current directory.

  • Stores those boolean values in instance variables (@is_app_dir, @is_liz_dir, @is_gem_dir).

  • Determines key directories (@app_dir, @liz_dir, @gem_dir) and configuration specs (@spec).

  • Prints verbose output if $VERBOSE is enabled.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/lizarb.rb', line 370

def setup_and_determine_environment
  if $VERBOSE
    puts "determining environment"
    puts "        Lizarb.root       = #{root.inspect}"
    puts "        Lizarb.setup_type = #{setup_type.inspect}"
    # puts "        Lizarb._project            = #{_project.inspect}" if setup_type == :project
    # puts "        Lizarb._script_dependent   = #{_script_dependent.inspect}" if setup_type == :script_dependent
    # puts "        Lizarb._script_independent = #{_script_independent.inspect}" if setup_type == :script_independent
  end
  
  # NOTE: calling an unset instance variable returns nil
  # NOTE: these file calls are pretty fast
  @is_app_dir = File.file? "#{root}/app.rb" if setup_type != :sfa
  @is_liz_dir = File.file? "#{root}/lib/lizarb.rb"
  @is_gem_dir = File.file? "#{root}/lizarb.gemspec" if @is_liz_dir

  $APP = "app_global" unless @is_app_dir

  if $VERBOSE
    puts "               Lizarb.root does #{ @is_app_dir ? "   " : "not" } have a configuration app.rb file"
    puts "               Lizarb.root does #{ @is_liz_dir ? "   " : "not" } have a lib/lizarb.rb file"
    puts "               Lizarb.root does #{ @is_gem_dir ? "   " : "not" } have a lizarb.gemspec file"
  end

  begin
    @spec    = Gem::Specification.find_by_name("lizarb")
    @gem_dir = @spec.gem_dir
  rescue Gem::MissingSpecError
    @gem_dir = root
  end
  @app_dir = @is_app_dir ? root : @gem_dir
  @liz_dir = @is_liz_dir ? root : @gem_dir

  if $VERBOSE
    puts "                      Lizarb.spec    = #{spec}"
    puts "                      Lizarb.app_dir = #{@app_dir.inspect}"
    puts "                      Lizarb.liz_dir = #{@liz_dir.inspect}"
    puts "                      Lizarb.gem_dir = #{@gem_dir.inspect}"
    puts
  end
end

.setup_and_overwrite_app_settings ⇒ Object

This method is called internally by setup and is not intended for direct use.

Overwrites Application settings with the following environment variables:

  • App.directory with APP_DIR example: APP_DIR=app liza irb
  • App.systems_directory with SYSTEMS_DIR example: SYSTEMS_DIR=lib liza irb
  • App.log_boot with LOG_BOOT or LOG example: LOG=highest liza irb
  • App.log_level with LOG_LEVEL or LOG example: LOG=highest liza irb
  • App.mode with MODE example: MODE=production liza irb
  • App.gemfile with GEMFILE example: GEMFILE=Gemfile liza irb
  • App.system with ENV example: SYSTEMS=dev,happy,deep,lab liza irb


456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/lizarb.rb', line 456

def setup_and_overwrite_app_settings
  if env_app_directory = ENV["APP_DIR"]
    App.directory env_app_directory
  end

  if env_systems_directory = ENV["SYSTEMS_DIR"]
    App.systems_directory env_systems_directory
  end

  if s = ENV["LOG_BOOT"] || ENV["LOG"]
    App.log_boot (s.length == 1) ? s.to_i : s.to_sym
  end

  if s = ENV["LOG_LEVEL"] || ENV["LOG"]
    App.log_level (s.length == 1) ? s.to_i : s.to_sym
  end

  if env_mode = ENV["MODE"]
    App.mode env_mode
  end

  if env_gemfile = ENV["GEMFILE"]
    App.gemfile env_gemfile
  end

  if env_systems = ENV["SYSTEMS"]
    App.systems.clear
    App.system :dev
    env_systems.split(",").each do |system|
      App.system system.to_sym
    end
  end
end

.setup_project(pwd, project:) ⇒ Object

Setup Methods for Different Contexts

The LizaRB framework provides specific setup methods for different contexts: project, script_dependent, and script_independent. Each method sets the @root and @setup_type instance variables and calls the setup method.

Sets up the environment for a project.

A project is a directory that contains an application app.rb file.



258
259
260
261
262
263
264
 
# File 'lib/lizarb.rb', line 258

def setup_project pwd, project:
  @root = pwd.to_s
  @setup_type = :project
  # NOTE: arg project is not being stored anywhere
  $APP = ENV["APP"] || "app"
  setup
end

.setup_script_dependent(pwd, script:, script_app:) ⇒ Object

Setup Methods for Different Contexts

The LizaRB framework provides specific setup methods for different contexts: project, script_dependent, and script_independent. Each method sets the @root and @setup_type instance variables and calls the setup method.

Sets up the environment for a script.

A script_dependent must be placed in a directory which parent directory is a project directory.



275
276
277
278
279
280
281
 
# File 'lib/lizarb.rb', line 275

def setup_script_dependent pwd, script: , script_app:
  @root = pwd.to_s
  @setup_type = :script_dependent
  # NOTE: arg script is not being stored anywhere
  $APP = script_app
  setup
end

.setup_script_independent(pwd, script:) ⇒ Object

Setup Methods for Different Contexts

The LizaRB framework provides specific setup methods for different contexts: project, script_dependent, and script_independent. Each method sets the @root and @setup_type instance variables and calls the setup method.

Sets up the environment for a script.

A script_independent is a Ruby script that uses the global_app for its project and project directory.



292
293
294
295
296
297
298
 
# File 'lib/lizarb.rb', line 292

def setup_script_independent pwd, script:
  @root = pwd.to_s
  @setup_type = :script_independent
  # NOTE: arg script is not being stored anywhere
  $APP = "app_global"
  setup
end

.source_location ⇒ Object

["/path/to/lizarb.rb", 1]



160
161
162
 
# File 'lib/lizarb.rb', line 160

def source_location
  [__FILE__, 1]
end

.thread_id ⇒ Object 



874
875
876
877
878
879
 
# File 'lib/lizarb.rb', line 874

def thread_id
  @thread_ids[thread_object_id] ||=
    @thread_ids_mutex.synchronize do
      @thread_ids.count
    end
end

.thread_object_id ⇒ Object

naive thread management



867
868
869
 
# File 'lib/lizarb.rb', line 867

def thread_object_id
  Thread.current.object_id
end

.version ⇒ Object

Returns Lizarb::VERSION as a Gem::Version



132
133
134
 
# File 'lib/lizarb.rb', line 132

def version
  @version ||= Gem::Version.new VERSION
end