Invoke text editors from ruby scripts
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
.gitignore
.hound.yml
.rubocop.yml
.travis.yml
Gemfile
LICENSE.txt
README.md
Rakefile
editors.gemspec

README.md

Editors

A little utility gem that is designed to collect user input through the user's text editor.

This is mostly an extraction from the excellent pry, but with more generalized functionality

Installation

Add this line to your application's Gemfile:

gem 'editors'

And then execute:

$ bundle

Or install it yourself as:

$ gem install editors

Usage

docs

There are 2 main ways of using Editors. To open files, and to collect input.

Files

Editors.file

Editor.file('/path/to/your/file.rb')

Collecting input

This is what Editor was initially written for

Editors.temp

Editor.temp('String to put into the tempfile before the user edits it')

Contributing

  1. Fork it ( https://github.com/[my-github-username]/editors/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

License

Copyright (c) 2014 Jeff Sandberg

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.