Class: Opal::CLI

Inherits:
Object
  • Object
show all
Defined in:
opal/lib/opal/cli.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = nil) ⇒ CLI

Returns a new instance of CLI.

Raises:

  • (ArgumentError)

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'opal/lib/opal/cli.rb', line 17

def initialize(options = nil)
  options ||= {}

  # Runner
  @runner_type    = options.delete(:runner)         || :nodejs
  @runner_options = options.delete(:runner_options) || {}

  @options     = options
  @sexp        = options.delete(:sexp)
  @file        = options.delete(:file)
  @no_exit     = options.delete(:no_exit)
  @lib_only    = options.delete(:lib_only)
  @argv        = options.delete(:argv)       { [] }
  @evals       = options.delete(:evals)      { [] }
  @load_paths  = options.delete(:load_paths) { [] }
  @gems        = options.delete(:gems)       { [] }
  @stubs       = options.delete(:stubs)      { [] }
  @preload     = options.delete(:preload)    { [] }
  @output      = options.delete(:output)     { self.class.stdout || $stdout }
  @verbose     = options.delete(:verbose)    { false }
  @debug       = options.delete(:debug)      { false }
  @filename    = options.delete(:filename)   { @file && @file.path }
  @requires    = options.delete(:requires)   { [] }
  @rbrequires  = options.delete(:rbrequires) { [] }

  @missing_require_severity = options.delete(:missing_require_severity) { Opal::Config.missing_require_severity }

  @requires.unshift('opal') unless options.delete(:skip_opal_require)

  @compiler_options = Hash[
    *compiler_option_names.map do |option|
      key = option.to_sym
      next unless options.key? key
      value = options.delete(key)
      [key, value]
    end.compact.flatten
  ]

  raise ArgumentError, 'no libraries to compile' if @lib_only && @requires.empty?
  raise ArgumentError, 'no runnable code provided (evals or file)' if @evals.empty? && @file.nil? && !@lib_only
  raise ArgumentError, "can't accept evals or file in `library only` mode" if (@evals.any? || @file) && @lib_only
  raise ArgumentError, "unknown options: #{options.inspect}" unless @options.empty?
end

Class Attribute Details

.stdoutObject

Returns the value of attribute stdout.


14
15
16
# File 'opal/lib/opal/cli.rb', line 14

def stdout
  @stdout
end

Instance Attribute Details

#argvObject (readonly)

Returns the value of attribute argv.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def argv
  @argv
end

#compiler_optionsObject (readonly)

Returns the value of attribute compiler_options.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def compiler_options
  @compiler_options
end

#debugObject (readonly)

Returns the value of attribute debug.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def debug
  @debug
end

#evalsObject (readonly)

Returns the value of attribute evals.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def evals
  @evals
end

#exit_statusObject (readonly)

Returns the value of attribute exit_status.


76
77
78
# File 'opal/lib/opal/cli.rb', line 76

def exit_status
  @exit_status
end

#fileObject (readonly)

Returns the value of attribute file.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def file
  @file
end

#filenameObject (readonly)

Returns the value of attribute filename.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def filename
  @filename
end

#gemsObject (readonly)

Returns the value of attribute gems.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def gems
  @gems
end

#lib_onlyObject (readonly)

Returns the value of attribute lib_only.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def lib_only
  @lib_only
end

#load_pathsObject (readonly)

Returns the value of attribute load_paths.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def load_paths
  @load_paths
end

#missing_require_severityObject (readonly)

Returns the value of attribute missing_require_severity.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def missing_require_severity
  @missing_require_severity
end

#no_exitObject (readonly)

Returns the value of attribute no_exit.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def no_exit
  @no_exit
end

#optionsObject (readonly)

Returns the value of attribute options.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def options
  @options
end

#outputObject (readonly)

Returns the value of attribute output.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def output
  @output
end

#preloadObject (readonly)

Returns the value of attribute preload.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def preload
  @preload
end

#rbrequiresObject (readonly)

Returns the value of attribute rbrequires.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def rbrequires
  @rbrequires
end

#requiresObject (readonly)

Returns the value of attribute requires.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def requires
  @requires
end

#runner_optionsObject (readonly)

Returns the value of attribute runner_options.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def runner_options
  @runner_options
end

#stubsObject (readonly)

Returns the value of attribute stubs.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def stubs
  @stubs
end

#verboseObject (readonly)

Returns the value of attribute verbose.


9
10
11
# File 'opal/lib/opal/cli.rb', line 9

def verbose
  @verbose
end

Instance Method Details

#builderObject


78
79
80
# File 'opal/lib/opal/cli.rb', line 78

def builder
  @builder ||= create_builder
end

#compiler_option_namesObject


127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'opal/lib/opal/cli.rb', line 127

def compiler_option_names
  %w[
    method_missing
    arity_check
    dynamic_require_severity
    source_map_enabled
    irb_enabled
    inline_operators
    enable_source_location
    use_strict
    parse_comments
  ]
end

#create_builderObject


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'opal/lib/opal/cli.rb', line 82

def create_builder
  rbrequires.each(&Kernel.method(:require))

  builder = Opal::Builder.new(
    stubs: stubs,
    compiler_options: compiler_options,
    missing_require_severity: missing_require_severity,
  )

  # --include
  builder.append_paths(*load_paths)

  # --gem
  gems.each { |gem_name| builder.use_gem gem_name }

  # --require
  requires.each { |required| builder.build(required) }

  # --preload
  preload.each { |path| builder.build_require(path) }

  # --verbose
  builder.build_str '$VERBOSE = true', '(flags)' if verbose

  # --debug
  builder.build_str '$DEBUG = true', '(flags)' if debug

  # --eval / stdin / file
  evals_or_file { |source, filename| builder.build_str(source, filename) }

  # --no-exit
  builder.build_str 'Kernel.exit', '(exit)' unless no_exit

  builder
end

#evals_or_fileObject

Internal: Yields a string of source code and the proper filename for either evals, stdin or a filepath.


143
144
145
146
147
148
149
150
151
152
# File 'opal/lib/opal/cli.rb', line 143

def evals_or_file
  # --library
  return if lib_only

  if evals.any?
    yield evals.join("\n"), '-e'
  elsif file && (filename != '-' || evals.empty?)
    yield file.read, filename
  end
end

#runObject


61
62
63
64
65
66
67
68
69
# File 'opal/lib/opal/cli.rb', line 61

def run
  return show_sexp if @sexp
  @exit_status = runner.call(
    options: runner_options,
    output: output,
    argv: argv,
    builder: builder,
  )
end

#runnerObject


71
72
73
74
# File 'opal/lib/opal/cli.rb', line 71

def runner
  CliRunners[@runner_type] ||
    raise(ArgumentError, "unknown runner: #{@runner_type.inspect}")
end

#show_sexpObject


118
119
120
121
122
123
124
125
# File 'opal/lib/opal/cli.rb', line 118

def show_sexp
  evals_or_file do |contents, filename|
    buffer = ::Opal::Parser::SourceBuffer.new(filename)
    buffer.source = contents
    sexp = Opal::Parser.default_parser.parse(buffer)
    output.puts sexp.inspect
  end
end