boing 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +43 -2
  3. data/lib/boing.rb +1 -1
  4. data/lib/boing/version.rb +1 -1
  5. metadata +11 -11
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 74b7d6f99b91897b5b77241acda31a5dec883bac
4
- data.tar.gz: d339a967a03c4b7dbf44f135c9333b3e4ad2909e
3
+ metadata.gz: 8be50b2db3d8cb58ca1efdc44db974d62bb298df
4
+ data.tar.gz: f4424460846c88550296d4d7dc9f62f4ce1ba80d
5
5
  SHA512:
6
- metadata.gz: 2fd6fc2dc7f6d8997e36f03e3e135736a1db9ddca0e86b41746f55687e447ad7e2186e351c3af1c65f9c86f2004fb21cbcc3f9c3ac845e213cafa2e33c3d9c8d
7
- data.tar.gz: c8ef4f6f0c0f840c16484611e2b9297daf3e8cba03bf4930900cc91837083117b893ea6c5e0197e3de822fad3e319101ff679ca49cc797c6b1ab0eedae2ae27f
6
+ metadata.gz: fd1967442b3939a8086ac3079b7ecbef90099a2676214456c81186e1fd1fe0ed9dee83dcc7be1d91e68b84a3bc5942db10f8714ae41a8be358e768751d3a9c88
7
+ data.tar.gz: 8ec92e4bca379658a8fb76fc23c4821b39e7b48359022a430f4908d9c01ce478700f7d72a9a810643fc3ce517e8110e8529af553bbb5cffed69c38380d2f7080
data/README.md CHANGED
@@ -1,6 +1,31 @@
1
1
  # Boing
2
2
 
3
- TODO: Write a gem description
3
+ Boing is a preloader-aware command runner for JRuby. It builds off the preload
4
+ capabilities of [Drip](https://github.com/flatland/drip) and adds per-command smarts for specific commands.
5
+
6
+ Boing is being created in response to the [Spring](https://github.com/jonleighton/spring) preloader being supported by
7
+ Rails 4.1. Spring preloads Ruby/Rails instances in the background in much the
8
+ same way as JRuby can do with Drip, but does it using forking. Because JRuby
9
+ already has Drip, Boing should only need to know how to safely preload and
10
+ reload the application.
11
+
12
+ Similar to Spring commands can be run with Boing using the format
13
+
14
+ ```boing <command>```
15
+
16
+ Most commands will just run directly, with the assumption that they are
17
+ already in a preloaded JVM. (Boing will warn if used outside of a preloaded
18
+ JVM). Some Rails commands, however, will be run directly.
19
+
20
+ However, boing is also aware of a few rails commands that can be run directly
21
+ using a specific dripmain.rb preload script. Boing can generate this script
22
+ using ```boing dripmain```.
23
+
24
+ Finally, all background instances can be cleaned up with ```boing killall```,
25
+ which is equivalent to the ```drip kill``` command from Drip.
26
+
27
+ Note that there's a more work to do here and much more that Boing could do to
28
+ improve startup and application development interactivity.
4
29
 
5
30
  ## Installation
6
31
 
@@ -18,7 +43,23 @@ Or install it yourself as:
18
43
 
19
44
  ## Usage
20
45
 
21
- TODO: Write usage instructions here
46
+ To run a command in a preloaded VM:
47
+
48
+ ```
49
+ boing <command>
50
+ ```
51
+
52
+ To generate a dripmain.rb suitable for Rails:
53
+
54
+ ```
55
+ boing dripmain
56
+ ```
57
+
58
+ To kill all background VM instances:
59
+
60
+ ```
61
+ boing killall
62
+ ```
22
63
 
23
64
  ## Contributing
24
65
 
@@ -20,7 +20,7 @@ module Boing
20
20
  end
21
21
 
22
22
  # check for known "special" commands
23
- if @args[0] == 'rails' && INPROC_RAILS_COMMANDS.include?(@args[1])
23
+ if @args[0] == 'rails' && INPROC_RAILS_CMDS.include?(@args[1])
24
24
  # running a `rails` command
25
25
 
26
26
  # best value comes from prebooting rails, so warn if not prebooted
@@ -1,3 +1,3 @@
1
1
  module Boing
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,38 +1,38 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: boing
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Charles Oliver Nutter
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-01-03 00:00:00.000000000 Z
11
+ date: 2014-11-24 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
+ name: bundler
14
15
  requirement: !ruby/object:Gem::Requirement
15
16
  requirements:
16
17
  - - ~>
17
18
  - !ruby/object:Gem::Version
18
19
  version: '1.3'
19
- name: bundler
20
- prerelease: false
21
20
  type: :development
21
+ prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - ~>
25
25
  - !ruby/object:Gem::Version
26
26
  version: '1.3'
27
27
  - !ruby/object:Gem::Dependency
28
+ name: rake
28
29
  requirement: !ruby/object:Gem::Requirement
29
30
  requirements:
30
31
  - - '>='
31
32
  - !ruby/object:Gem::Version
32
33
  version: '0'
33
- name: rake
34
- prerelease: false
35
34
  type: :development
35
+ prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - '>='
@@ -59,7 +59,7 @@ homepage: https://github.com/headius/boing
59
59
  licenses:
60
60
  - Apache-2
61
61
  metadata: {}
62
- post_install_message:
62
+ post_install_message:
63
63
  rdoc_options: []
64
64
  require_paths:
65
65
  - lib
@@ -74,9 +74,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
76
  requirements: []
77
- rubyforge_project:
78
- rubygems_version: 2.1.9
79
- signing_key:
77
+ rubyforge_project:
78
+ rubygems_version: 2.0.14
79
+ signing_key:
80
80
  specification_version: 4
81
81
  summary: A command running that's aware of the Drip prebooter for JRuby.
82
82
  test_files: []