Class: Spring::Client::Binstub

Inherits:
Command
  • Object
show all
Defined in:
lib/spring/client/binstub.rb

Defined Under Namespace

Classes: Item

Constant Summary collapse

SHEBANG = 
/\#\!.*\n(\#.*\n)*/
LOADER =

If loading the bin/spring file works, it’ll run Spring which will eventually call Kernel.exit. This means that in the client process we will never execute the lines after this block. But if the Spring client is not invoked for whatever reason, then the Kernel.exit won’t happen, and so we’ll fall back to the lines after this block, which should cause the “unsprung” version of the command to run.

<<~CODE
  load File.expand_path("spring", __dir__)
CODE
SPRING =

The defined? check ensures these lines don’t execute when we load the binstub from the application process. Which means that in the application process we’ll execute the lines which come after the LOADER block, which is what we want.

<<~CODE
  #!/usr/bin/env ruby

  # This file loads Spring without loading other gems in the Gemfile in order to be fast.
  # It gets overwritten when you run the `spring binstub` command.

  if !defined?(Spring) && [nil, "development", "test"].include?(ENV["RAILS_ENV"])
    require "bundler"

    Bundler.locked_gems.specs.find { |spec| spec.name == "spring" }&.tap do |spring|
      Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
      gem "spring", spring.version
      require "spring/binstub"
    end
  end
CODE
OLD_BINSTUB = 
%{if !Process.respond_to?(:fork) || Gem::Specification.find_all_by_name("spring").empty?}
BINSTUB_VARIATIONS = 
Regexp.union [
  %{load File.expand_path("spring", __dir__)\n},
  %{begin\n  load File.expand_path('../spring', __FILE__)\nrescue LoadError => e\n  raise unless e.message.include?('spring')\nend\n},
  %{begin\n  load File.expand_path('../spring', __FILE__)\nrescue LoadError\nend\n},
  %{begin\n  spring_bin_path = File.expand_path('../spring', __FILE__)\n  load spring_bin_path\nrescue LoadError => e\n  raise unless e.message.end_with? spring_bin_path, 'spring/binstub'\nend\n},
  LOADER
].map { |binstub| /#{Regexp.escape(binstub).gsub("'", "['\"]")}/ }

Instance Attribute Summary collapse

Attributes inherited from Command

#args, #env

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Binstub

Returns a new instance of Binstub.



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/spring/client/binstub.rb', line 134

def initialize(args)
  super

  @bindir = env.root.join("bin")
  @all    = false
  @mode   = :add
  @items  = args.drop(1)
                .map { |name| find_commands name }
                .flatten.uniq
                .map { |command| Item.new(command) }
end

Instance Attribute Details

#bindir ⇒ Object (readonly)

Returns the value of attribute bindir.



119
120
121
 
# File 'lib/spring/client/binstub.rb', line 119

def bindir
  @bindir
end

#items ⇒ Object (readonly)

Returns the value of attribute items.



119
120
121
 
# File 'lib/spring/client/binstub.rb', line 119

def items
  @items
end

Class Method Details

.call(args) ⇒ Object 



129
130
131
132
 
# File 'lib/spring/client/binstub.rb', line 129

def self.call(args)
  require "spring/commands"
  super
end

.description ⇒ Object 



121
122
123
 
# File 'lib/spring/client/binstub.rb', line 121

def self.description
  "Generate Spring based binstubs. Use --all to generate a binstub for all known commands. Use --remove to revert."
end

.rails_command ⇒ Object 



125
126
127
 
# File 'lib/spring/client/binstub.rb', line 125

def self.rails_command
  @rails_command ||= CommandWrapper.new("rails")
end

Instance Method Details

#call ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/spring/client/binstub.rb', line 168

def call
  case @mode
  when :add
    bindir.mkdir unless bindir.exist?

    File.write(spring_binstub, SPRING)
    spring_binstub.chmod 0755

    items.each(&:add)
  when :remove
    spring_binstub.delete if @all
    items.each(&:remove)
  else
    raise ArgumentError
  end
end

#find_commands(name) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/spring/client/binstub.rb', line 146

def find_commands(name)
  case name
  when "--all"
    @all = true
    commands = Spring.commands.dup
    commands.delete_if { |command_name, _| command_name.start_with?("rails_") }
    commands.values + [self.class.rails_command]
  when "--remove"
    @mode = :remove
    []
  when "rails"
    [self.class.rails_command]
  else
    if command = Spring.commands[name]
      [command]
    else
      $stderr.puts "The '#{name}' command is not known to spring."
      exit 1
    end
  end
end

#spring_binstub ⇒ Object 



185
186
187
 
# File 'lib/spring/client/binstub.rb', line 185

def spring_binstub
  bindir.join("spring")
end