Module: Shojiku

Defined in:
lib/shojiku.rb,
lib/shojiku/env.rb,
lib/shojiku/log.rb,
lib/shojiku/client.rb,
lib/shojiku/config.rb,
lib/shojiku/engine.rb,
lib/shojiku/errors.rb,
lib/shojiku/result.rb,
lib/shojiku/failure.rb,
lib/shojiku/library.rb,
lib/shojiku/outcome.rb,
lib/shojiku/request.rb,
lib/shojiku/sources.rb,
lib/shojiku/version.rb,
lib/shojiku/artifact.rb,
lib/shojiku/lockdown.rb,
lib/shojiku/settings.rb,
lib/shojiku/local_pem.rb,
lib/shojiku/diagnostic.rb,
lib/shojiku/template_root.rb,
lib/shojiku/verification_report.rb

Overview

Process-wide configuration: the Config object and the module-level entry points that reach it.

Defined Under Namespace

Modules: Echo, Material, Outcome Classes: AbiMismatch, Client, Config, Diagnostic, DocumentArtifact, Engine, Env, Error, Failure, Library, LibraryNotFound, LocalPem, Lockdown, Log, MaterialUnreadable, Request, Result, Settings, Snapshot, Sources, TemplateRoot, UnwrapError, UsageError, VerificationReport

Constant Summary collapse

VERSION =

Tracks the engine workspace version. All seven SDKs move together while everything is pre-1.0 and publish together at the first public release.

"0.1.0"

Class Method Summary collapse

Class Method Details

.config ⇒ Object

The process-wide defaults. Mutated through configure, read by every Client at construction.



67
68
69
 
# File 'lib/shojiku/config.rb', line 67

def config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ Object 

Shojiku.configure do |config|
  config.templates = "app/templates"
  config.lang = "ja-JP"
end

Yields:



77
78
79
80
 
# File 'lib/shojiku/config.rb', line 77

def configure
  yield(config)
  config
end

.reset_configuration! ⇒ Object

Drops every configured default.

Public because a global that cannot be reset makes every test suite invent its own teardown — and get it wrong in a randomly-ordered run. Applications call it at most once, if at all.



87
88
89
 
# File 'lib/shojiku/config.rb', line 87

def reset_configuration!
  @config = Config.new
end