Module: RVGP

Defined in:
lib/rvgp.rb,
lib/rvgp/gem.rb,
lib/rvgp/pta.rb,
lib/rvgp/plot.rb,
lib/rvgp/commands.rb,
lib/rvgp/base/grid.rb,
lib/rvgp/dashboard.rb,
lib/rvgp/utilities.rb,
lib/rvgp/pta/ledger.rb,
lib/rvgp/application.rb,
lib/rvgp/base/reader.rb,
lib/rvgp/pta/hledger.rb,
lib/rvgp/base/command.rb,
lib/rvgp/plot/gnuplot.rb,
lib/rvgp/commands/grid.rb,
lib/rvgp/commands/plot.rb,
lib/rvgp/journal/pricer.rb,
lib/rvgp/utilities/yaml.rb,
lib/rvgp/base/reconciler.rb,
lib/rvgp/base/validation.rb,
lib/rvgp/journal/journal.rb,
lib/rvgp/journal/posting.rb,
lib/rvgp/fakers/fake_feed.rb,
lib/rvgp/journal/currency.rb,
lib/rvgp/commands/cashflow.rb,
lib/rvgp/journal/commodity.rb,
lib/rvgp/application/config.rb,
lib/rvgp/commands/reconcile.rb,
lib/rvgp/commands/ireconcile.rb,
lib/rvgp/fakers/fake_journal.rb,
lib/rvgp/commands/new_project.rb,
lib/rvgp/commands/rotate_year.rb,
lib/rvgp/fakers/faker_helpers.rb,
lib/rvgp/utilities/grid_query.rb,
lib/rvgp/fakers/fake_reconciler.rb,
lib/rvgp/plot/google-drive/sheet.rb,
lib/rvgp/commands/publish_gsheets.rb,
lib/rvgp/commands/validate_system.rb,
lib/rvgp/application/status_output.rb,
lib/rvgp/commands/validate_journal.rb,
lib/rvgp/journal/complex_commodity.rb,
lib/rvgp/reconcilers/csv_reconciler.rb,
lib/rvgp/plot/google-drive/output_csv.rb,
lib/rvgp/reconcilers/journal_reconciler.rb,
lib/rvgp/reconcilers/shorthand/mortgage.rb,
lib/rvgp/validations/balance_validation.rb,
lib/rvgp/application/descendant_registry.rb,
lib/rvgp/reconcilers/shorthand/investment.rb,
lib/rvgp/validations/uncategorized_validation.rb,
lib/rvgp/validations/duplicate_tags_validation.rb,
lib/rvgp/plot/google-drive/output_google_sheets.rb,
lib/rvgp/reconcilers/shorthand/international_atm.rb

Overview

The base module, under which all RVGP code is filed

Defined Under Namespace

Modules: Base, Commands, Fakers, Reconcilers, Utilities, Validations Classes: Application, Dashboard, Gem, Journal, Plot, Pta

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.commands ⇒ Array<RVGP::Base::Command> (readonly)

Contains an array of all available objects, with parent of type RVGP::Base::Command.

Returns:




# File 'lib/rvgp.rb', line 50

.grids ⇒ Array<RVGP::Base::Grid> (readonly)

Contains an array of all available objects, with parent of type RVGP::Base::Grid.
NOTE: RVGP.app.task_names => Array<String>, will return all grid-building tasks that have been defined in the project.

Returns:




# File 'lib/rvgp.rb', line 50

.journal_validations ⇒ Array<RVGP::Base::JournalValidation> (readonly)

Contains an array of all available objects, with parent of type RVGP::Base::JournalValidation.

Returns:




# File 'lib/rvgp.rb', line 50

.system_validations ⇒ Array<RVGP::Base::SystemValidation> (readonly)

Contains an array of all available objects, with parent of type RVGP::Base::SystemValidation.
NOTE: RVGP.system_validations.task_names => Array<String>, will return all system validation tasks that have been defined in the project.

Returns:




# File 'lib/rvgp.rb', line 50

Class Method Details

.app ⇒ RVGP::Application

Returns The currently-initialized RVGP:Application.

Returns:



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

def self.app
  @app
end

.initialize_app(from_path) ⇒ RVGP::Application

Returns The initialized application, that was stored in RVGP.app.

Parameters:

  • from_path (String) —

    The directory path, to an RVGP project.

Returns:

Raises:

  • (StandardError) 


34
35
36
37
38
 
# File 'lib/rvgp.rb', line 34

def self.initialize_app(from_path)
  raise StandardError, 'Application is already initialized' if @app

  @app = Application.new from_path
end

.pastel ⇒ Pastel

Returns The global pastel object, used to output to the console.

Returns:

  • (Pastel) —

    The global pastel object, used to output to the console.



46
47
48
 
# File 'lib/rvgp.rb', line 46

def self.pastel
  @pastel ||= Pastel.new enabled: $stdout.tty?
end