console_editor 0.0.5

data/README.md

@@ -0,0 +1,34 @@
+
+# Console editor
+
+Based almost entirely on interactive_editor, written by Jan Berkel. See [the original GitHub project](http://github.com/jberkel/interactive_editor) for details.
+
+The only difference between this project and interactive\_editor is its behaviour: the original project is intended for use in irb, and eval()'s the contents of your editor upon exit. The purpose of console\_editor is to let console application users edit text files that are not intended for evaluation by the script.
+
+## Usage
+
+    $ gem install console_editor
+
+Put the following in your console script:
+
+    require 'rubygems'
+    require 'console_editor'
+
+Then, in your console application:
+
+    > nano                       # (use nano w/ temp file)
+    > nano 'filename.rb'         # (open filename.rb in nano)
+    > ed                         # (use EDITOR env variable)
+    > [emacs|vim|mvim|nano|mate] # (other editors)
+
+When you exit the editor, your script can continue its execution.
+
+To try it out without installing the gem:
+
+    $ git clone git://github.com/aaronvegh/console_editor.git
+
+Include the lib/console\_editor.rb file in your script.
+
+## Disclaimer
+
+This is a quick and dirty rip from the interactive\_editor gem, so any legacy code from that project is due only to my haste and ignorance. Cheers!

data/Rakefile

@@ -0,0 +1,117 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master --tags"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Builds the gem"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/console_editor.gemspec

@@ -0,0 +1,49 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '0.0.1'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'console_editor'
+  s.version           = '0.0.5'
+  s.date              = '2010-09-26'
+  s.rubyforge_project = 'console_editor'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Interactive editing in the console."
+  s.description = "Use vim (or any other text editor) from a console app."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Aaron Vegh"]
+  s.email    = 'aaron@innoveghtive.com'
+  s.homepage = 'http://github.com/aaronvegh/console_editor'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency('spoon', [">= 0.0.1"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.md
+    Rakefile
+    console_editor.gemspec
+    lib/console_editor.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/console_editor.rb

@@ -0,0 +1,89 @@
+# vim: set syntax=ruby :
+# Giles Bowkett, Greg Brown, and several audience members from Giles' Ruby East presentation.
+# http://gilesbowkett.blogspot.com/2007/10/use-vi-or-any-text-editor-from-within.html
+
+require 'irb'
+require 'fileutils'
+require 'tempfile'
+
+class InteractiveEditor
+  VERSION = '0.0.5'
+
+  attr_accessor :editor
+
+  def initialize(editor)
+    @editor = editor.to_s
+  end
+
+  def edit(file=nil)
+    @file = if file
+       FileUtils.touch(file) unless File.exist?(file)
+       File.new(file)
+      else
+       (@file && File.exist?(@file.path)) ? @file : Tempfile.new(["irb_tempfile", ".rb"])
+    end
+    mtime = File.stat(@file.path).mtime
+
+    if (args = @editor.split(/\s+/)).size > 1
+      Exec.system(args[0], *(args[1..-1] << @file.path))
+    else
+      Exec.system(@editor, @file.path)
+    end
+
+    #execute if mtime < File.stat(@file.path).mtime
+  end
+
+  def execute
+    eval(IO.read(@file.path), TOPLEVEL_BINDING)
+  end
+
+  def self.edit(editor, file=nil)
+    #maybe serialise last file to disk, for recovery
+    (IRB.conf[:interactive_editors] ||=
+      Hash.new { |h,k| h[k] = InteractiveEditor.new(k) })[editor].edit(file)
+  end
+
+  module Exec
+    module Java
+      def system(file, *args)
+        require 'spoon'
+        Process.waitpid(Spoon.spawnp(file, *args))
+      rescue Errno::ECHILD => e
+        raise "error exec'ing #{file}: #{e}"
+      end
+    end
+
+    module MRI
+      def system(file, *args)
+        Kernel::system(file, *args) #or raise "error exec'ing #{file}: #{$?}"
+      end
+    end
+
+    extend RUBY_PLATFORM =~ /java/ ? Java : MRI
+  end
+
+  module Editors
+    {
+      :vi    => nil,
+      :vim   => nil,
+      :emacs => nil,
+      :nano  => nil,
+      :mate  => 'mate -w',
+      :mvim  => 'mvim -g -f'
+    }.each do |k,v|
+      define_method(k) do |*args|
+       InteractiveEditor.edit(v || k, *args)
+      end
+    end
+
+    def ed(*args)
+      if ENV['EDITOR'].to_s.size > 0
+        InteractiveEditor.edit(ENV['EDITOR'], *args)
+      else
+        raise "You need to set the EDITOR environment variable first"
+      end
+    end
+  end
+end
+
+include InteractiveEditor::Editors

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: console_editor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Aaron Vegh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-26 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spoon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id001
+description: Use vim (or any other text editor) from a console app.
+email: aaron@innoveghtive.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- console_editor.gemspec
+- lib/console_editor.rb
+has_rdoc: true
+homepage: http://github.com/aaronvegh/console_editor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: console_editor
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Interactive editing in the console.
+test_files: []
+