editors 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c25ed541da528233569124bcc6d4eeeb89e397a
+  data.tar.gz: 48e7138e786182f55c17950a29e989991acf9938
+SHA512:
+  metadata.gz: 042a38b380168dbb676b80586200194da71465fef33bcb7ef2ca4dc32722e67a62d74a292c45e932ea9dcb01b2fbad4aca0d851a1927777173fdd7b8a0341d9a
+  data.tar.gz: 2c83e8e9d95a81e7c4f12d55d289522c416fee353b7bcfd709a04655afadc6fb4cebe0e8ecb0ba843678ef58301ff9d40d45a3bdc934308ce60ceee0356d4745

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor
+*.gem

data/.hound.yml

@@ -0,0 +1,5 @@
+LineLength:
+  Enabled: false
+Style/AlignHash:
+  EnforcedHashRocketStyle: separator
+  EnforcedColonStyle: separator

data/.rubocop.yml

@@ -0,0 +1,5 @@
+LineLength:
+  Enabled: false
+Style/AlignHash:
+  EnforcedHashRocketStyle: separator
+  EnforcedColonStyle: separator

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in editors.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeff Sandberg
+
+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,72 @@
+# 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](http://github.com/pry/pry), but with more generalized functionality
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'editors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install editors
+
+## Usage
+
+**[docs](http://rubydoc.info/github/paradox460/editors/master/)**
+
+There are 2 main ways of using `Editors`. To open files, and to collect input.
+
+### Files
+[`Editors.file`](http://rubydoc.info/github/paradox460/editors/master/Editor.file)
+```ruby
+Editor.file('/path/to/your/file.rb')
+```
+
+### Collecting input
+This is what Editor was initially written for
+
+[`Editors.temp`](http://rubydoc.info/github/paradox460/editors/master/Editor.temp)
+```ruby
+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.
+ ```

data/Rakefile

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

data/editors.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+# rubocop:disable all
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'editors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "editors"
+  spec.version       = Editors::VERSION
+  spec.authors       = ["Jeff Sandberg"]
+  spec.email         = ["paradox460@gmail.com"]
+  spec.summary       = %q{A library for invoking the users text editor.}
+  spec.description   = %q{Library for opening text editors and getting their content as a string. Useful for command line scripts. Somewhat of an extraction from the excellent pry gem.}
+  spec.homepage      = "https://github.com/paradox460/editor"
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/editor.rb

@@ -0,0 +1,167 @@
+require 'english'
+require 'editors/version'
+require 'editors/helpers/editor_syntax'
+require 'editors/helpers/platform_detection'
+
+# Editor class. Lets you edit both real and temporary files, and returns their values after editing.
+#
+# @author Jeff Sandberg
+#
+class Editors
+  include Editors::Helpers::PlatformDetection
+  include Editors::Helpers::EditorSyntax
+  attr_reader :content
+
+  # Initialize a new editor, with options. You should probably use Editor.edit or Editor.new instead of these
+  # You must pass a file OR temp string, but NOT both
+  #
+  # @param options [Hash]
+  # @option file [String] options (nil) A file path to edit
+  # @option temp [String] options (nil) The content of the tempfile, prior to editing
+  # @option line [String] options (1) The line of the file to place the cursor at
+  # @option blocking [Boolean] options (true) Pass the editor a blocking flag
+  # @return [Editor] Editor object, with #content set to the return value from the file
+  def initialize(options = {})
+    opts = { file: nil, temp: nil, line: 1, blocking: true }.merge(options)
+    if !opts_is_valid?opts
+      fail ArgumentError, 'define file OR temp'
+    elsif opts[:file]
+      edit_file(opts)
+    elsif opts[:temp]
+      edit_temp(opts)
+    end
+  end
+
+  class << self
+    # Edit a file from the filesystem, and return its value
+    # @param file [String] A file path to edit
+    # @param line [Fixnum] The line of the file to place the cursor at
+    # @param blocking [Boolean] Pass the editor a blocking flag
+    #
+    # @return [String] The value of the file AFTER it was edited
+    def file(file, line = 1, blocking = true)
+      new(file: file, line: line, blocking: blocking).content
+    end
+
+    # Edits a temporary file, and return its value
+    # @param initial_content [String] The content of the tempfile, prior to editing
+    # @param line [Fixnum] Tempfile line to place cursor at
+    #
+    # @return [String] The value of the tempfile AFTER it was edited
+    def temp(initial_content, line = 1)
+      new(temp: initial_content, line: line, blocking: true).content
+    end
+  end
+
+  private
+
+  # Checks if an options hash contains both file and temp values
+  # @param opts [Hash] Options hash
+  #
+  # @return [Boolean]
+  def opts_is_valid?(opts = {})
+    !(opts[:file].nil? && opts[:temp].nil?) || (opts[:file] && opts[:temp])
+  end
+
+  # Open the file in the users editor of choice
+  # @param opts [Hash] Options hash
+  # @option file [String] options (nil) A file path to edit
+  # @option line [String] options (1) The line of the file to place the cursor at
+  # @option blocking [Boolean] options (true) Pass the editor a blocking flag
+  #
+  # @return [String] The value of the tempfile AFTER it was edited
+  def edit_file(opts = {})
+    File.open(opts[:file]) do |f|
+      invoke_editor(f.path, opts[:line], opts[:blocking])
+      @content = File.read(f.path)
+    end
+  end
+
+  # Put a string in a temp file and present it to the user for editing
+  # @param opts [Hash] Options hash
+  # @option temp [String] options (nil) The content of the tempfile, prior to editing
+  # @option line [String] options (1) The line of the file to place the cursor at
+  #
+  # @return [String] The value of the tempfile AFTER it was edited
+  def edit_temp(opts = {})
+    temp_file do |f|
+      f.puts(opts[:temp])
+      f.flush
+      f.close(false)
+      invoke_editor(f.path, opts[:line], true)
+      @content = File.read(f.path)
+    end
+  end
+
+  # Open the users default editor with the params specified
+  # @param file [String] File path
+  # @param line [Fixnum] Line number to place cursor at
+  # @param blocking = true [Boolean] If the editor should be blocking
+  def invoke_editor(file, line = 1, blocking = true)
+    fail 'Please export $VISUAL or $EDITOR' unless default_editor
+
+    editor_invocation = build_editor_invocation_string(file, line, blocking)
+    return nil unless editor_invocation
+
+    if jruby?
+      open_editor_on_jruby(editor_invocation)
+    else
+      open_editor(editor_invocation)
+    end
+  end
+
+  # Create and yield a tempfile
+  # @param ext [String] File extension for the file to user
+  #
+  # @yieldparam [File] The tempfile object
+  def temp_file(ext = '.rb')
+    file = Tempfile.new(['editors', ext])
+    yield file
+  ensure
+    file.close(true) if file
+  end
+
+  # Builds the string that is used to call the editor
+  # @param file [String] File path
+  # @param line [Fixnum] Line number
+  # @param blocking [Boolean]
+  #
+  # @return [String] Editor invocation string
+  def build_editor_invocation_string(file, line, blocking)
+    sanitized_file = windows? ? file.gsub(/\//, '\\') : Shellwords.escape(file)
+    "#{default_editor} #{blocking_flag_for_editor(blocking)} #{start_line_syntax_for_editor(sanitized_file, line)}"
+  end
+
+  # Open the editor
+  # @param editor_invocation [String] Value from #build_editor_invocation_string
+  def open_editor(editor_invocation)
+    system(*Shellwords.split(editor_invocation)) || fail("`#{editor_invocation}` gave exit status: #{$CHILD_STATUS.exitstatus}")
+  end
+
+  # jRuby doesn't like open_editor, so we have to muck about with this
+  # @param editor_invocation [String] Value from #build_editor_invocation_string
+  def open_editor_on_jruby(editor_invocation)
+    require 'spoon'
+    pid = Spoon.spawnp(*Shellwords.split(editor_invocation))
+    Process.waitpid(pid)
+    rescue FFI::NotFoundError
+      system(editor_invocation)
+  end
+
+  # Get the user's configured visual or editor ENV
+  #
+  # @return [String] The editor command
+  def default_editor
+    # Visual = Advanced editor
+    return ENV['VISUAL'] if ENV['VISUAL'] && !ENV['VISUAL'].empty?
+    # Editor = basic editor
+    return ENV['EDITOR'] if ENV['EDITOR'] && !ENV['EDITOR'].empty?
+    if windows?
+      'notepad'
+    else
+      %w(editor nano vi).find do |editor|
+        system("which #{editor} > /dev/null 2>&1")
+      end
+    end
+  end
+end

data/lib/editors/helpers/editor_syntax.rb

@@ -0,0 +1,61 @@
+class Editors
+  module Helpers
+    # Helpers for generating editor invocation commands
+    #
+    # @author Jeff Sandberg
+    module EditorSyntax
+      def editor_name
+        File.basename(default_editor).split(' ').first
+      end
+      # The blocking flag for this particular editor.
+      #
+      # @param blocking [Boolean] If false, returns nothing
+      #
+      # @return [String, Nil]
+      def blocking_flag_for_editor(blocking)
+        case editor_name
+        when /^emacsclient/
+          '--no-wait'
+        when /^[gm]vim/
+          '--nofork'
+        when /^jedit/
+          '-wait'
+        when /^mate/, /^subl/, /^redcar/
+          '-w'
+        end if blocking
+      end
+
+      # The starting line syntax for the user's editor
+      # @param file_name [String] File name/path
+      # @param line_number [Fixnum]
+      #
+      # @return [String]
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def start_line_syntax_for_editor(file_name, line_number)
+        return file_name if line_number <= 1
+
+        case editor_name
+        when /^[gm]?vi/, /^emacs/, /^nano/, /^pico/, /^gedit/, /^kate/
+          "+#{line_number} #{file_name}"
+        when /^mate/, /^geany/
+          "-l #{line_number} #{file_name}"
+        when /^subl/
+          "#{file_name}:#{line_number}"
+        when /^uedit32/
+          "#{file_name}/#{line_number}"
+        when /^jedit/
+          "#{file_name} +line:#{line_number}"
+        when /^redcar/
+          "-l#{line_number} #{file_name}"
+        else
+          if windows?
+            "#{file_name}"
+          else
+            "+#{line_number} #{file_name}"
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity, Metrics/MethodLength
+    end
+  end
+end

data/lib/editors/helpers/platform_detection.rb

@@ -0,0 +1,52 @@
+class Editors
+  module Helpers
+    # Utilities for detecting which platform and which version of ruby the user is running
+    #
+    # @author Jeff Sandberg
+    module PlatformDetection
+      def windows?
+        RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
+      end
+
+      # Determines if we can use ANSI on windows
+      #
+      # @return [Boolean]
+      def windows_ansi?
+        defined?(Win32::Console) || ENV['ANSICON'] || (windows? && mri_2?)
+      end
+
+      def jruby?
+        RbConfig::CONFIG['ruby_install_name'] == 'jruby'
+      end
+
+      def jruby_19?
+        jruby? && RbConfig::CONFIG['ruby_version'] == '1.9'
+      end
+
+      def rbx?
+        RbConfig::CONFIG['ruby_install_name'] == 'rbx'
+      end
+
+      def mri?
+        RbConfig::CONFIG['ruby_install_name'] == 'ruby'
+      end
+      # rubocop:disable Style/DoubleNegation
+      def mri_19?
+        !!(mri? && RUBY_VERSION =~ /^1\.9/)
+      end
+
+      def mri_2?
+        !!(mri? && RUBY_VERSION =~ /^2/)
+      end
+
+      def mri_20?
+        !!(mri? && RUBY_VERSION =~ /^2\.0/)
+      end
+
+      def mri_21?
+        !!(mri? && RUBY_VERSION =~ /^2\.1/)
+      end
+      # rubocop:enable Style/DoubleNegation
+    end
+  end
+end

data/lib/editors/version.rb

@@ -0,0 +1,6 @@
+class Editors
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: editors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jeff Sandberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Library for opening text editors and getting their content as a string.
+  Useful for command line scripts. Somewhat of an extraction from the excellent pry
+  gem.
+email:
+- paradox460@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- editors.gemspec
+- lib/editor.rb
+- lib/editors/helpers/editor_syntax.rb
+- lib/editors/helpers/platform_detection.rb
+- lib/editors/version.rb
+homepage: https://github.com/paradox460/editor
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A library for invoking the users text editor.
+test_files: []
+has_rdoc: