temp_editor 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 riverpuro
+
+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,51 @@
+# TempEditor
+
+Edit temporary file with ENV['EDITOR'].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'temp_editor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install temp_editor
+
+## Usage
+
+1. Initialize TempEditor with Tempfile constructor arguments.
+2. Register callback: before editing, after editing or both.
+3. Make enduser edit tempfile.
+
+```ruby
+# Initialize TempEditor
+editor = TempEditor.new(['prefix', '.extension'])
+
+# Resister before editing callback:
+editor.before do |tempfile|
+  tempfile.write("EDIT ME")
+end
+
+# Resister after editing callback:
+editor.after do |tempfile|
+  puts tempfile.read
+end
+
+# launch editor
+editor.edit
+```
+
+See also: examples
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/examples/remote_editor.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'temp_editor'
+
+class RemoteResource
+  def initialize(resource_id)
+    @path = "http://example.com/diary/#{resource_id}"
+  end
+
+  def get
+    "# contents for #{@path}\n"
+  end
+
+  def put(content)
+    puts "update #{@path}"
+    puts "=" * 80
+    puts content
+  end
+end
+
+class RemoteEditor
+  def initialize(remote_resource_id)
+    @remote_resource = RemoteResource.new(remote_resource_id)
+
+    @editor = TempEditor.new(['remote', '.markdown'])
+
+    @editor.before do |file|
+      content = @remote_resource.get
+      file.write(content)
+    end
+
+    @editor.after do |file|
+      @remote_resource.put(file.read)
+    end
+  end
+
+  def edit
+    @editor.edit
+  end
+end
+
+if __FILE__ == $0
+  remote_editor = RemoteEditor.new(1)
+  remote_editor.edit
+end

data/lib/temp_editor.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+require 'tempfile'
+
+class TempEditor
+  VERSION = '0.0.1'
+
+  class EditorConfigureError < StandardError; end
+
+  attr_reader :tempfile
+
+  def initialize(basename, *rest)
+    @tempfile = Tempfile.new(basename, *rest)
+  end
+
+  def before(&block)
+    @before_callback = build_callback(&block)
+  end
+
+  def after(&block)
+    @after_callback = build_callback(&block)
+  end
+
+  def edit
+    @before_callback.call if @before_callback
+    system "#{editor} #{@tempfile.path}"
+    @after_callback.call if @after_callback
+  end
+
+  def editor
+    @editor ||= ENV['EDITOR']
+    @editor or raise EditorConfigureError, "set your ENV['EDITOR']"
+  end
+
+  def editor=(editor_cmd)
+    @editor = editor_cmd
+  end
+
+  private
+  def build_callback(&block)
+    Proc.new do
+      begin
+        @tempfile.open
+        block.call(@tempfile)
+      ensure
+        @tempfile.close
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'temp_editor'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

data/spec/temp_editor_spec.rb

@@ -0,0 +1,141 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe TempEditor do
+  shared_context "setup common @temp_editor instance" do
+    before do
+      @temp_editor = TempEditor.new('tempfile_prefix')
+
+      @editor_inputs = 'my editor inputs'
+
+      mock_editor_command = "echo '#{@editor_inputs}' >"
+      @temp_editor.editor = mock_editor_command
+    end
+  end
+
+
+  describe "#edit" do
+    include_context "setup common @temp_editor instance"
+
+    it "should exec editor" do
+      begin
+        @temp_editor.edit
+
+        @temp_editor.tempfile.open
+        tempfile_contents = @temp_editor.tempfile.read.chomp
+        tempfile_contents.should == @editor_inputs
+      ensure
+        @temp_editor.tempfile.close
+      end
+    end
+  end
+
+
+  describe "#before" do
+    include_context "setup common @temp_editor instance"
+
+    it "should be called with opened tempfile" do
+      @temp_editor.before do |file|
+        file.should_not be_closed
+      end
+
+      @temp_editor.edit
+    end
+
+    it "should be called before edit" do
+      @temp_editor.before do |file|
+        file_contents = file.read
+        file_contents.should be_empty
+      end
+
+      @temp_editor.edit
+    end
+  end
+
+
+  describe "#after" do
+    include_context "setup common @temp_editor instance"
+
+    it "should be called with opened tempfile" do
+      @temp_editor.after do |file|
+        file.should_not be_closed
+      end
+
+      @temp_editor.edit
+    end
+
+    it "should be called after edit" do
+      @temp_editor.after do |file|
+        file_contents = file.read.chomp
+        file_contents.should == @editor_inputs
+      end
+
+      @temp_editor.edit
+    end
+  end
+
+
+  describe "#editor", "#editor=" do
+    context "specify editor command" do
+      before do
+        @temp_editor = TempEditor.new('tempfile_prefix')
+
+        @specified_editor_command_inputs = "specified editor inputs"
+
+        @temp_editor.editor = "echo '#{@specified_editor_command_inputs}' >"
+      end
+
+      it "should use specified editor command" do
+        begin
+          @temp_editor.edit
+
+          @temp_editor.tempfile.open
+          tempfile_contents = @temp_editor.tempfile.read.chomp
+          tempfile_contents.should == @specified_editor_command_inputs
+        ensure
+          @temp_editor.tempfile.close
+        end
+      end
+    end
+
+    context "not specify editor command" do
+      before do
+        @temp_editor = TempEditor.new('tempfile_prefix')
+      end
+
+      it "should use ENV['EDITOR'] as default" do
+        begin
+          orignal_env_editor = ENV['EDITOR']
+          editor_inputs = "original editor inputs"
+          ENV['EDITOR'] = "echo '#{editor_inputs}' > "
+
+          @temp_editor.edit
+
+          @temp_editor.tempfile.open
+          tempfile_contents = @temp_editor.tempfile.read.chomp
+          tempfile_contents.should == editor_inputs
+        ensure
+          ENV['EDITOR'] = orignal_env_editor
+          @temp_editor.tempfile.close
+        end
+      end
+    end
+
+    context "when blank ENV['EDITOR']" do
+      before do
+        @temp_editor = TempEditor.new('tempfile_prefix')
+      end
+
+      it "should use ENV['EDITOR'] as default" do
+        begin
+          orignal_env_editor = ENV.delete('EDITOR')
+          expect {
+            @temp_editor.edit
+          }.to raise_error(TempEditor::EditorConfigureError)
+        ensure
+          ENV['EDITOR'] = orignal_env_editor
+        end
+      end
+    end
+  end
+end

data/temp_editor.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'temp_editor'
+
+Gem::Specification.new do |gem|
+  gem.name          = "temp_editor"
+  gem.version       = TempEditor::VERSION
+  gem.authors       = ["riverpuro"]
+  gem.email         = ["riverpuro@gmail.com"]
+  gem.description   = %q{Edit temporary file with ENV['EDITOR']}
+  gem.summary       = %q{Edit temporary file with ENV['EDITOR']}
+  gem.homepage      = "https://github.com/riverpuro/temp_editor"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency('rspec')
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: temp_editor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- riverpuro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Edit temporary file with ENV['EDITOR']
+email:
+- riverpuro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/remote_editor.rb
+- lib/temp_editor.rb
+- spec/spec_helper.rb
+- spec/temp_editor_spec.rb
+- temp_editor.gemspec
+homepage: https://github.com/riverpuro/temp_editor
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Edit temporary file with ENV['EDITOR']
+test_files:
+- spec/spec_helper.rb
+- spec/temp_editor_spec.rb