Skip to content

Commit

Permalink
bump version to 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Geoffrey Litt committed Jan 28, 2018
1 parent 9911e0b commit 0df0a2c
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 12 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.gem
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,25 @@ Chrome Devtools as a user interface.
It aims to provide a rich backend debugging experience in a UI that many
web developers are already familiar with for debugging frontend Javascript.

**This project is currently in a very early experimental phase.** Expect many limitations and bugs, and use at your own risk. If you try it out, please file
**This project is currently in an early experimental phase.** Expect many limitations and bugs. If you try it out, please file
Github issues or [email me](mailto:gklitt@gmail.com) to help make this a
more useful tool.

![screenshot](screenshots/demo.png)

## Get started

1) Install the gem:
1) Install the gem, or add it to your Gemfile:

`gem install --pre ladybug`
`gem install ladybug`

2) ladybug is implemented as a Rack middleware, so you'll need to add
`Ladybug::Middleware` to the Rack middleware stack.
For example, in Rails 5, add
the following line to `config/application.rb`:

```
config.middleware.insert_before(Rack::Sendfile, Ladybug::Middleware)
config.middleware.use(Ladybug::Middleware)
```

3) Make sure you're using the puma web server, which is currently the
Expand All @@ -41,19 +41,22 @@ You should see your server program output something like:
In the Sources tab, you can view your Ruby source code.
If you set a breakpoint and then make another request to your server,
it should pause on the breakpoint and you'll be able to inspect
some variables in Devtools.
local and instance variables in Devtools.

6) You can then use the "step over" button to step through your code,
or "continue" to continue code execution. "Step into" and "Step out"
also work in some contexts.

**Security warning:** This debugger should only be run in local development.
Running it on a server open to the internet could allow anyone to
execute code on your server without authenticating.

## Development status

* basic pause/continue breakpoint control is supported, but "step over" and "step into" aren't fully supported yet.
* inspecting primtive objects like strings and numbers works okay; support for more complex objects is in development.
* So far, ladybug has only been tested with simple Rails applications running on
Rails 5 with the puma web server. Eventually it aims to support more Rack
applications and web servers (and perhaps even non-Rack applications).
* inspecting primtive objects like strings and numbers works okay; support for more complex objects is in development.

## Author

Expand Down
10 changes: 5 additions & 5 deletions ladybug.gemspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Gem::Specification.new do |s|
s.name = 'ladybug'
s.version = '0.0.1.alpha'
s.date = '2018-01-21'
s.version = '0.1.1'
s.date = '2018-01-28'
s.summary = "Ladybug"
s.description = "Debug Ruby code using Chrome Devtools"
s.authors = ["Geoffrey Litt"]
Expand All @@ -10,7 +10,7 @@ Gem::Specification.new do |s|
s.homepage = 'http://rubygems.org/gems/ladybug'
s.license = 'MIT'

s.add_runtime_dependency "faye-websocket"
s.add_runtime_dependency "parser"
s.add_runtime_dependency "memoist"
s.add_runtime_dependency "faye-websocket", "~> 0.10.7"
s.add_runtime_dependency "parser", "~> 2.4.0.2"
s.add_runtime_dependency "memoist", "~> 0.14.0"
end

0 comments on commit 0df0a2c

Please sign in to comment.