exedit 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7a1a6fcb2bd37d081b4e72d5dba3d2c0ef8939e
+  data.tar.gz: d2f7701805093598fa7c68fb35e03a4cf26c61eb
+SHA512:
+  metadata.gz: fb110f468d58966ff349e6d6bcf5fd4a8d76223d2e588c284dc49203d195667d54317ba0c2d014fac92893c06a370953dd4fe7ede8e9054b404c1bd7599824c2
+  data.tar.gz: ba9879d1737d6a30024cb6eb5b08997b6d20eaf8a6a4e2d5104e2186a18f10453e045a3f87af23d6c68062982040634e1ffd320c8c008bed180c068671431db9

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store*

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exedit.gemspec
+gemspec
+
+gem 'dot_configure', git: 'https://github.com/jlorich/dot_configure'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joey Lorich
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,65 @@
+# Exedit
+
+Easily jump to external editors from a ruby script for input. (Like git does with commit messages)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exedit'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+To open a file in the default external editor, simply call
+
+    result = Exedit.open ./path/to/file
+
+The script will pause until the editor closes and the saved result will be read and returned.
+
+If no file is specified, a tempfile will be generated and then destroyed immedately after the result is returned
+
+    result = Exedit.open
+
+#####String editing
+
+You can also edit strings in external functions by using 
+
+    result = Exedit.edit "my string!"
+
+#####Editors
+
+Commands to launch vim, nano, pico, sublime, and textmate are included by default. To open in a specific editor simply specify it when optining
+
+    result = Exedit.open editor: :sublime
+
+You can also manually pass in a command to launch an editor
+
+     result = Exedit.open command: 'subl -n -w'
+
+#####Options
+
+Configurable options are availabe, including what editors can be launched and the default editor.
+
+    Exedit.configure do |config|
+      config.editors[:cooleditor] = 'cooleditor -w'
+      config.default_editor = :cooleditor
+    end
+
+The following would set a hypothetical `cooleditor` as the default editor, launched with a command of `cooleditor -w ./path/to/file`
+
+
+##### Editor Availability
+
+`Exedit.available_editors` will return all editors availble on the current system.  The default configuration options also only include editors installed on the current system. If no `default_editor` is specified in the options, it will default to the first available editor on the system (typically vi)
+
+## Contributing
+
+1. Fork it ( https://github.com/jlorich/exedit/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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/exedit.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'exedit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "exedit"
+  spec.version       = Exedit::VERSION
+  spec.authors       = ["Joey Lorich"]
+  spec.email         = ["jospeh@lorich.me"]
+  spec.summary       = %q{Easily jump to external editors for file input!}
+  spec.description   = %q{Easily jump to external editors for file input!}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake', '~> 10.3.2'
+  spec.add_development_dependency 'pry-byebug', '~> 1.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'clint_eastwood', '~> 0.0.1'
+end

data/lib/exedit.rb

@@ -0,0 +1 @@
+require 'exedit/exedit'

data/lib/exedit/command.rb

@@ -0,0 +1,18 @@
+module Exedit
+  # A system command checking class
+  class Command
+    # Gets the path to a system command, returns nil if none found
+    def self.which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+
+      nil
+    end
+  end
+end

data/lib/exedit/editor.rb

@@ -0,0 +1,41 @@
+require 'tempfile'
+
+module Exedit
+  # An exedit external editor instance
+  class Editor
+    attr_accessor :edit_command
+
+    def initialize(edit_command, file_path = nil, content: nil)
+      @file_path = file_path
+      @edit_command = edit_command
+      @content = content
+    end
+
+    def open
+      (file.write(@content) && file.flush) if @content && !@file_path
+
+      system("#{edit_command} #{file.path}")
+
+      result = reload(file).read
+
+      # Remove the tempfile if it exists
+      tempfile.unlink if @tempfile
+
+      result
+    end
+
+    private
+
+    def file
+      @file ||= @file_path ? File.new(@file_path) : tempfile
+    end
+
+    def tempfile
+      @tempfile ||= Tempfile.new('ex-edit')
+    end
+
+    def reload(file)
+      file.reopen(file.path)
+    end
+  end
+end

data/lib/exedit/exedit.rb

@@ -0,0 +1,58 @@
+require 'exedit/editor'
+require 'exedit/command'
+require 'dot_configure'
+
+# A ruby external editor interface
+module Exedit
+  extend DotConfigure
+
+  class << self
+    attr_accessor :editor
+
+    # Opens a file (defaults to a tempfile which will be deleted) for editing in the external editor
+    def open(file = nil, editor: nil, command: nil)
+      Editor.new(edit_command(editor, command), file).open
+    end
+
+    # Edits the given content in a tempfile
+    def edit(content, editor: nil, command: nil)
+      Editor.new(edit_command(editor, command), content: content).open
+    end
+
+    # All editors available on the current system
+    def available_editors
+      if !defined? @options
+        base_editors.select { |_editor, command| Command.which(command.split(' ')[0]) }
+      else
+        options.editors.select { |_editor, command| Command.which(command.split(' ')[0]) }
+      end
+    end
+
+    private
+
+    def edit_command(editor, command)
+      command || options.editors[editor || default_editor]
+    end
+
+    def default_editor
+      options.default_editor || available_editors.keys.first
+    end
+
+    def base_editors
+      {
+        vi: 'vi',
+        vim: 'vim',
+        nano: 'nano',
+        pico: 'pico',
+        sublime: 'subl -w -n',
+        textmate: 'mate -w'
+      }
+    end
+
+    def default_options
+      {
+        editors: base_editors.select { |key, _value| available_editors.include? key }
+      }
+    end
+  end
+end

data/lib/exedit/version.rb

@@ -0,0 +1,4 @@
+# Exedit main module
+module Exedit
+  VERSION = '0.0.2'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'pry-byebug'
+require 'exedit'
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  config.color = true
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: exedit
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Joey Lorich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: clint_eastwood
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: Easily jump to external editors for file input!
+email:
+- jospeh@lorich.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exedit.gemspec
+- lib/exedit.rb
+- lib/exedit/command.rb
+- lib/exedit/editor.rb
+- lib/exedit/exedit.rb
+- lib/exedit/version.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Easily jump to external editors for file input!
+test_files:
+- spec/spec_helper.rb