Module: Everywhere::Config::App

Included in:
Everywhere::Config
Defined in:
lib/everywhere/config/app.rb

Constant Summary collapse

BUNDLE_ID =

A bundle id isn't only an identifier: it's a path segment (Paths.*_work_dir, which the builders rm_rf, and the update-signing key on disk). The derived default is safe by construction; an explicit one is whatever the app repo says, so it's held to reverse-DNS characters and nothing else.

/\A[A-Za-z0-9][A-Za-z0-9.-]*\z/

Instance Method Summary collapse

Instance Method Details

#background_color ⇒ Object 



121
122
123
 
# File 'lib/everywhere/config/app.rb', line 121

def background_color
  normalize_color(appearance["background_color"])
end

#build ⇒ Object

The build: section — durable build knobs that were once every build flags (ruby, targets, capabilities). CLI flags still override per-run. See platform/docs/build-engine.md §2.



73
 
# File 'lib/everywhere/config/app.rb', line 73

def build = @data.fetch("build", nil) || {}

#build_capabilities ⇒ Object

Desktop OS-integration capabilities the app declares (build.capabilities), as a plain list. Deliberately not called permissions: the top-level permissions: below is the mobile prompt declaration — a different shape for a different consumer — and while both were spelled "permissions" this accessor was silently redefined by that one and could never be read.



83
 
# File 'lib/everywhere/config/app.rb', line 83

def build_capabilities = Array(build["capabilities"])

#build_ruby ⇒ Object

Ruby version to package. nil here means "let the CLI decide its default".



76
 
# File 'lib/everywhere/config/app.rb', line 76

def build_ruby = build["ruby"]

#build_target_specs ⇒ Object

The raw build.targets entries, suffixes intact ("ios-arm64:testflight").



93
 
# File 'lib/everywhere/config/app.rb', line 93

def build_target_specs = Array(build["targets"])

#bundle_id(target: nil) ⇒ Object

Reverse-DNS identifier: macOS bundle id, and the name of the per-user app-data directory on every platform. Set it explicitly and never change it — renaming moves users' data. A platform may override it (e.g. the App Store often wants com.example.app.ios).



14
15
16
17
 
# File 'lib/everywhere/config/app.rb', line 14

def bundle_id(target: nil)
  resolved(target)["bundle_id"] ||
    "com.rubyeverywhere.#{name(target: target).downcase.gsub(/[^a-z0-9]+/, "-").gsub(/\A-|-\z/, "")}"
end

#entry_path ⇒ Object 



57
58
59
60
 
# File 'lib/everywhere/config/app.rb', line 57

def entry_path
  path = app["entry_path"] || "/"
  path.start_with?("/") ? path : "/#{path}"
end

#icon ⇒ Object

App icon source: a PNG (ideally square, 1024px+). Explicit app.icon path relative to the app root, or icon.png at the root by convention.



40
41
42
43
44
45
46
47
 
# File 'lib/everywhere/config/app.rb', line 40

def icon
  if (explicit = app["icon"])
    File.expand_path(explicit, root)
  else
    default = File.join(root, "icon.png")
    File.exist?(default) ? default : nil
  end
end

#identity_errors ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/everywhere/config/app.rb', line 25

def identity_errors
  sections = [["app", app]] + platforms.map { |os, override| ["platforms.#{os}", override] }
  sections.filter_map do |at, section|
    next unless section.is_a?(Hash)

    value = section["bundle_id"].to_s
    next if value.empty? || (value.match?(BUNDLE_ID) && !value.include?(".."))

    "#{at}.bundle_id #{value.inspect} is not a bundle id — reverse-DNS, " \
      "letters/digits/./- only (like com.example.app)"
  end
end

#mode ⇒ Object

"local" — the app is tebako-pressed and runs on-device (default) "remote" — thin shell around an already-deployed app: no press, no sidecar



97
98
99
 
# File 'lib/everywhere/config/app.rb', line 97

def mode
  app["mode"] || (remote_url ? "remote" : "local")
end

#name(target: nil) ⇒ Object 



6
7
8
 
# File 'lib/everywhere/config/app.rb', line 6

def name(target: nil)
  resolved(target)["name"] || File.basename(File.expand_path(root)).split(/[-_]/).map(&:capitalize).join(" ")
end

#remote? ⇒ Boolean

Returns:

  • (Boolean) 


101
 
# File 'lib/everywhere/config/app.rb', line 101

def remote? = mode == "remote"

#remote_instances? ⇒ Boolean

Multi-instance apps (remote.instances: true): the mobile shell boots into remote.url — a hosted instance-picker page — and lets that page re-root the app onto a chosen instance via Everywhere.instance.set, persisted across launches until Everywhere.instance.clear. Opt-in because it lets page JS repoint the whole app: apps that aren't multi-instance shouldn't carry that surface.

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/everywhere/config/app.rb', line 113

def remote_instances?
  @data.dig("remote", "instances") == true
end

#remote_url ⇒ Object 



103
104
105
 
# File 'lib/everywhere/config/app.rb', line 103

def remote_url
  @data.dig("remote", "url")&.chomp("/")
end

#splash ⇒ Object

Optional custom splash page (HTML file, path relative to the app root). Shown while the packaged server boots; the shell injects window.EVERYWHERE_CONFIG so it can use the app's name and colors.



52
53
54
55
 
# File 'lib/everywhere/config/app.rb', line 52

def splash
  path = app["splash"]
  File.expand_path(path, root) if path
end

#targets ⇒ Object

Build targets as BARE os-arch strings — any ":" suffix is stripped. Callers treat these as filesystem/URL-safe identifiers (every publish derives S3 update-manifest key paths from the first one), so a suffix leaking through here would poison those paths. Use #build_target_specs when the channel matters.



90
 
# File 'lib/everywhere/config/app.rb', line 90

def targets = build_target_specs.map { |t| t.to_s.split(":", 2).first }

#tint_color ⇒ Object 



117
118
119
 
# File 'lib/everywhere/config/app.rb', line 117

def tint_color
  normalize_color(appearance["tint_color"])
end

#version(target: nil) ⇒ Object

Marketing/display version of the app (CFBundleShortVersionString, and the version recorded in the build receipt). One shared app.version is the default for every target; a platform may override it when a store forces a different number. Defaults conservatively.



66
67
68
 
# File 'lib/everywhere/config/app.rb', line 66

def version(target: nil)
  resolved(target)["version"] || "0.1.0"
end