reditor 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74b4410a288a3ffc7893f9cecf76135d1404781c
-  data.tar.gz: 41f82f2bc183430d20626e7f079461419d16e263
+  metadata.gz: 65d269738917fa656392dbfdc72911162d4bceb1
+  data.tar.gz: 9c2a310abe62329700de7faf0a991327796c64c5
 SHA512:
-  metadata.gz: cb4912b5b9b056d1a31029bfaa3382a4f4b68d717afea6e2223ed06c500df5d1a2fd3703474b8297ca7d013a124677f6952ff0237b8ef3525e236176faad4dd2
-  data.tar.gz: b9905d129c117c108c8e3c573e9c45b962cdd6cfd987052fc09e2ed64de664bb4df03bef9f5f1e9a96b7cface009e4ad87c9729e511e00c6ea770242fedac4a0
+  metadata.gz: 8c7832bc2ac674fbbc2da482810af2bf5733acde8d9ad9073df2e50d3aeacf1080ada3acb3ee288f6b4277f3e5f91e0d389c7e3bc0e5a0d61e653d3b6d191613
+  data.tar.gz: 6812fbaf4a82210d4eb0f40e6e0a80d71040316a071be069e9790af510e781961e1e318663aa81ce328d70b9463dbbeffea292d858bc90f2ba88c7473a518e80

data/.travis.yml

@@ -1,3 +1,5 @@
 rvm:
   - '1.9.3'
   - '2.0.0'
+  - '2.1.0'
+  - '2.1.1'

data/README.md

@@ -2,33 +2,19 @@
 
 Reditor provides `reditor` command.
 
-This command detect and open a library from $LOAD_PATH or rubygems.
+This command detect and open a library from `$LOAD_PATH` or rubygems.
 
-reditor requires the EDITOR variable.
+reditor requires the `$EDITOR` variable.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-  gem 'reditor'
-```
-
-And then execute:
-
-```
-  $ bundle
-```
-
-Or install it yourself as:
-
 ```
   $ gem install reditor
 ```
 
 ## Usage
 
-### Open Standard Library (pure ruby only)
+### Open a Standard Library (pure ruby only)
 
 ```
   $ reditor set
@@ -37,13 +23,32 @@ Or install it yourself as:
 ### Open a gem
 
 ```
-  $ reditor mechanize
+  $ reditor railties
 ```
 
-### Open a shell and move to the library.
+### Open a library by $SHELL
 
 ```
-  $ reditor sh mechanize
+  $ reditor sh railties
+```
+
+### Open a gem on bundler project
+
+Reditor opens a gem that specified in Gemfile by default.
+If you want to avoid it, pass the `--global` option.
+
+```
+$ gem list rack
+
+*** LOCAL GEMS ***
+
+rack (1.5.2, 1.4.5)
+
+$ bundle list rack
+/(snip)/rack-1.4.5
+
+$ reditor rack          # open rack-1.4.5
+$ reditor rack --global # open rack-1.5.2
 ```
 
 ## Contributing

data/bin/reditor

@@ -1,10 +1,7 @@
 #!/usr/bin/env ruby
-# coding: utf-8
 
 $LOAD_PATH.unshift File.join(File.expand_path('../../', __FILE__), 'lib')
 
 require 'reditor'
 
-$PROGRAM_NAME = File.basename(__FILE__)
-
 Reditor::Command.start

data/lib/reditor.rb

@@ -1,10 +1,5 @@
 require 'rubygems'
 
-# load all dependencies (https://github.com/hibariya/reditor/issues/4)
-require 'hotwater'
-require 'thor'
-require 'rake'
-
 module Reditor
   class LibraryNotFound < LoadError; end
 

data/lib/reditor/command.rb

@@ -4,14 +4,29 @@ require 'thor'
 
 module Reditor
   class Command < Thor
+    class << self
+      attr_accessor :restarted
+
+      def restart(args)
+        self.restarted = true
+
+        start args
+      end
+    end
+
     map '-v' => :version,
         '-h' => :help,
         '--version' => :version,
         '--help'    => :help
 
-    desc :open, 'Open the library'
-    def open(name)
-      detect_exec name do |dir, file|
+    default_command :open
+
+    desc 'open [NAME]', 'Detect and open a library'
+    method_options global: false
+    def open(name = nil)
+      return invoke :help unless name
+
+      detect_exec name, global: options[:global] do |dir, file|
         say "Moving to #{dir}", :green
         Dir.chdir dir do
           say "Opening #{file}", :green
@@ -21,9 +36,10 @@ module Reditor
       end
     end
 
-    desc :sh, 'Open a shell and move to the library'
+    desc 'sh [NAME]', 'Detect and open a library by $SHELL'
+    method_options global: false
     def sh(name)
-      detect_exec name do |dir, _|
+      detect_exec name, global: options[:global] do |dir, _|
         say "Moving to #{dir}", :green
         Dir.chdir dir do
           exec shell_command
@@ -36,40 +52,47 @@ module Reditor
       say "Reditor version #{VERSION}"
     end
 
-    def method_missing(name, *args, &block)
-      open name
-    end
-
     private
 
-    def detect_exec(name, &block)
-      path = LibraryLocator.detect(name)
-
-      return choose_exec name, &block unless path
+    def detect_exec(name, options = {}, &block)
+      path = LibraryLocator.detect!(name, options)
 
-      dir, file =
-        if path.file?
-          [path.dirname.to_path, path.basename.to_path]
-        else
-          [path.to_path, '.']
-        end
+      do_exec path, &block
+    rescue LibraryNotFound => e
+      say e.message
 
-      block.call dir, file
+      choose_exec name, options, &block
     end
 
-    def choose_exec(name, &block)
-      names = LibrarySearchQuery.search(name)
+    def choose_exec(name, options = {}, &block)
+      names = LibrarySearchQuery.search(name, options)
 
       names.each.with_index do |name, i|
         say "[#{i}] #{name}"
       end
-      print 'Choose number of library [0]> '
 
-      abort_reditor unless num = $stdin.gets
+      exit_silently unless num = ask('Choose number of library [0]>')
 
-      detect_exec names[num.to_i], &block
+      if name = names[num.to_i]
+        do_exec LibraryLocator.detect!(name, options), &block
+      else
+        abort "#{num} isn't included in the list."
+      end
+    rescue LibraryNotFound => e
+      abort e.message
     rescue Interrupt
-      abort_reditor
+      exit_silently
+    end
+
+    def do_exec(path, &block)
+      dir, file =
+        if path.file?
+          [path.dirname.to_path, path.basename.to_path]
+        else
+          [path.to_path, '.']
+        end
+
+      block.call dir, file
     end
 
     def editor_command
@@ -80,10 +103,16 @@ module Reditor
       ENV['SHELL'] or raise '$SHELL is not provided.'
     end
 
-    def abort_reditor
+    def exit_silently
       puts
 
       exit
     end
+
+    def method_missing(name, *args, &block)
+      return super if Command.restarted
+
+      Command.restart ['open', name.to_s, *args]
+    end
   end
 end

data/lib/reditor/library_locator.rb

@@ -3,16 +3,23 @@ require 'pathname'
 # TODO: care version specification
 module Reditor
   class LibraryLocator
-    include BundlerSupport
-
-    def self.detect(name)
-      new(name.to_s).detect
+    class << self
+      def detect(name, options = {})
+        new(name.to_s, options).detect
+      end
+
+      def detect!(name, options = {})
+        detect(name, options) or raise LibraryNotFound, "Can't detect library `#{name}'."
+      end
     end
 
-    attr_reader :name
+    include BundlerSupport
+
+    attr_reader :name, :options
 
-    def initialize(name)
-      @name  = name
+    def initialize(name, options)
+      @name    = name
+      @options = {global: false}.merge(options)
     end
 
     def detect
@@ -20,6 +27,7 @@ module Reditor
     end
 
     def detect_from_bundler
+      return nil if options[:global]
       return nil unless spec = bundler_specs.find {|spec| spec.name == name }
 
       Pathname(spec.full_gem_path)

data/lib/reditor/library_search_query.rb

@@ -5,60 +5,66 @@ module Reditor
   class LibrarySearchQuery
     include BundlerSupport
 
-    def self.search(query, limit = 20)
-      new(query).search(limit)
+    def self.search(query, options = {})
+      new(query, options).search
     end
 
-    def initialize(query)
-      @query = query.to_s
+    attr_reader :query, :options
+    attr_reader :half_pattern, :partial_pattern
 
-      quoted = Regexp.quote(@query)
-      @substr_pattern  = /^#{quoted}|#{quoted}$/i
+    def initialize(query, options = {})
+      @query   = query.to_s
+      @options = {limit: 20, global: false}.merge(options)
+
+      quoted = Regexp.quote(query)
+      @half_pattern    = /^#{quoted}|#{quoted}$/i
       @partial_pattern = /#{quoted}/i
     end
 
-    def search(limit)
-      available_libraries.sort_by {|name|
-        indexes_with_match(name) + indexes_with_distance(name)
+    def search(limit = options[:limit])
+      candidates.sort_by {|name|
+        [*match_scores(name), *distance_scores(name), name]
       }.take(limit)
     end
 
-    def available_libraries
-      @available_libraries ||= (
-        availables_from_loadpath +
-        availables_from_gem      +
-        availables_from_bundler
+    def candidates
+      @candidates ||= (
+        candidates_from_loadpath +
+        candidates_from_gem      +
+        candidates_from_bundler
       ).uniq
     end
 
     private
 
-    def indexes_with_match(name)
+    def match_scores(name)
       words         = name.split(/-_/)
-      substr_count  = words.grep(@substr_pattern).count
-      partial_count = words.grep(@partial_pattern).count
+      half_count    = words.grep(half_pattern).count
+      partial_count = words.grep(partial_pattern).count
 
-      [-substr_count, -partial_count]
+      [-half_count, -partial_count]
     end
 
-    def indexes_with_distance(name)
-      [Hotwater.damerau_levenshtein_distance(@query, name)]
+    def distance_scores(name)
+      [Hotwater.damerau_levenshtein_distance(query, name)]
     end
 
-    def availables_from_bundler
+    def candidates_from_bundler
+      return [] if options[:global]
+
       bundler_specs.map(&:name)
     end
 
-    def availables_from_gem
+    def candidates_from_gem
       Gem::Specification.map(&:name)
     rescue Gem::LoadError
       []
     end
 
-    def availables_from_loadpath
-      $LOAD_PATH.each_with_object([]) {|path, availables|
+    def candidates_from_loadpath
+      $LOAD_PATH.each_with_object([]) {|path, memo|
         Pathname(File.expand_path(path)).entries.each do |entry|
-          availables << entry.basename('.rb').to_s if entry.extname == '.rb'
+          memo << entry.basename('.rb').to_s if entry.extname == '.rb'
         end
       }
     end

data/lib/reditor/version.rb

@@ -1,3 +1,3 @@
 module Reditor
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/reditor.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/reditor/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ['hibariya']
   gem.email         = ['celluloid.key@gmail.com']
-  gem.description   = %q{Open a ruby library with your editor. Reditor supports gem, bundler, and stdlib (pure ruby).}
-  gem.summary       = %q{Open a ruby library with your editor}
+  gem.description   = %q{Open a ruby library with $EDITOR. Reditor supports rubygems, bundler, and stdlib (pure ruby).}
+  gem.summary       = %q{Open a ruby library with $EDITOR.}
   gem.homepage      = 'https://github.com/hibariya/reditor'
   gem.licenses      = ['MIT']
 
@@ -18,10 +18,11 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'hotwater', '~> 0.1.2'
   gem.add_runtime_dependency 'thor',     '~> 0.18.1'
-  gem.add_runtime_dependency 'rake',     '~> 10.1.0' # workaround for `WARN: Unresolved specs during Gem::Specification.reset: rake (>= 0)' on ruby-2.0.0
+
+  # Add into runtime dependency to avoid `WARN: Unresolved specs during Gem::Specification.reset: rake (>= 0)'
+  gem.add_runtime_dependency 'rake', '~> 10.1.1'
 
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 2.14.1'
   gem.add_development_dependency 'tapp'
 end

data/spec/command_spec.rb

@@ -3,20 +3,26 @@ require 'open3'
 
 describe 'reditor command' do
   def capture_reditor(library_name, options = {})
-    options = {editor: 'echo', where: nil}.merge(options)
+    options = {editor: 'echo', on: nil, global: false}.merge(options)
     command = PROJECT_ROOT.join('bin/reditor').to_path
-    project = PROJECT_ROOT.join("spec/samples/#{options[:where]}").to_path
+    project = PROJECT_ROOT.join("spec/samples/#{options[:on]}").to_path
 
     Bundler.with_clean_env {
-      Open3.capture2e(
+      output, process = Open3.capture2e(
         {'EDITOR' => options[:editor]},
         command,
         library_name,
+        "--global=#{options[:global]}",
         chdir: project
-      ).first
+      )
+
+      raise "Command failed: #{output}" unless process.success?
+
+      output
     }
   end
 
+  let(:thor_in_global_gems)     { /thor-0\.18\.*/ }
   let(:thor_in_bundler_project) { /thor-0\.14\.6/ }
 
   before :all do
@@ -27,19 +33,19 @@ describe 'reditor command' do
 
   describe '#open' do
     context 'Standard library in non-bundler broject (happy case)' do
-      subject { capture_reditor('thread', where: 'blank_project') }
+      subject { capture_reditor('webrick', on: 'blank_project') }
 
-      it { should match /thread\.rb$/ }
+      it { should match /webrick\.rb$/ }
     end
 
     context 'Incorrect name library in non-bundler broject' do
-      subject { capture_reditor('cvs', where: 'blank_project') }
+      subject { capture_reditor('cvs', on: 'blank_project') }
 
       it { should match /\[0\] csv/ }
     end
 
-    context 'rubygems library in non-bundler project' do
-      subject { capture_reditor('thor', where: 'blank_project') }
+    context 'Rubygems library in non-bundler project' do
+      subject { capture_reditor('thor', on: 'blank_project') }
 
       it { should match /thor-/m }
 
@@ -48,25 +54,40 @@ describe 'reditor command' do
       end
     end
 
-    context 'rubygems library in bundler project (installed)' do
-      subject { capture_reditor('thor', where: 'bundler_project') }
+    context 'Rubygems library in bundler project (installed)' do
+      subject { capture_reditor('thor', on: 'bundler_project') }
 
       specify 'bundler gem should be used' do
         subject.should match thor_in_bundler_project
       end
     end
 
-    context 'rubygems library in bundler project (not yet installed)' do
-      subject { capture_reditor('thor', where: 'bundler_project_without_lockfile') }
+    context 'Rubygems library in bundler project (not yet installed)' do
+      subject { capture_reditor('thor', on: 'bundler_project_without_lockfile') }
 
       it { should match thor_in_bundler_project }
     end
 
+    context 'with --global option' do
+      subject { capture_reditor('thor', on: 'bundler_project', global: true) }
+
+      it { should match thor_in_global_gems }
+      it { should_not match thor_in_bundler_project }
+    end
+
     context 'with incorrect name' do
-      subject { capture_reditor('thief') }
+      subject { capture_reditor('rb') }
+
+      it { should match /\[\d+\]\sirb$/ }
+      it { should match /\[\d+\]\serb$/ }
+      it { should match /\[\d+\]\sdrb$/ }
+      it { should match /Choose number of library/ }
+    end
+
+    context 'with incorrect name and --global option' do
+      subject { capture_reditor('tho', on: 'bundler_project', global: true) }
 
-      it { should match /\[\d+\]\sthread/ }
-      it { should match /\[\d+\]\sthor/ }
+      it { should match /\[\d+\]\sthor$/ }
       it { should match /Choose number of library/ }
     end
   end

data/spec/library_search_query_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 describe Reditor::LibrarySearchQuery do
   describe '.search(query, limit)' do
     before do
-      Reditor::LibrarySearchQuery.any_instance.stub(:available_libraries) {
+      Reditor::LibrarySearchQuery.any_instance.stub(:candidates) {
         %w(
           rails_admin
           railtie
@@ -19,31 +19,31 @@ describe Reditor::LibrarySearchQuery do
     end
 
     describe 'rails' do
-      subject { Reditor::LibrarySearchQuery.search('rails', 3) }
+      subject { Reditor::LibrarySearchQuery.search('rails', limit: 3) }
 
       it { should == %w(rails_admin jquery-atwho-rails railtie) }
     end
 
     describe 'rails_' do
-      subject { Reditor::LibrarySearchQuery.search('rails_', 2) }
+      subject { Reditor::LibrarySearchQuery.search('rails_', limit: 2) }
 
       it { should == %w(rails_admin railtie) }
     end
 
     describe 'cvs' do
-      subject { Reditor::LibrarySearchQuery.search('cvs', 1) }
+      subject { Reditor::LibrarySearchQuery.search('cvs', limit: 1) }
 
       it { should == %w(csv) }
     end
 
     describe 'atwho' do
-      subject { Reditor::LibrarySearchQuery.search('atwho', 2) }
+      subject { Reditor::LibrarySearchQuery.search('atwho', limit: 2) }
 
       it { should == %w(jquery-atwho-rails itwho) }
     end
 
     describe 'active' do
-      subject { Reditor::LibrarySearchQuery.search('active', 3) }
+      subject { Reditor::LibrarySearchQuery.search('active', limit: 3) }
 
       it { should == %w(activemodel active_decorator action) }
     end

metadata

@@ -1,114 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: reditor
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - hibariya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-26 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hotwater
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: 10.1.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: tapp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Open a ruby library with your editor. Reditor supports gem, bundler,
+description: Open a ruby library with $EDITOR. Reditor supports rubygems, bundler,
   and stdlib (pure ruby).
 email:
 - celluloid.key@gmail.com
@@ -117,8 +103,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -147,20 +133,20 @@ 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.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Open a ruby library with your editor
+summary: Open a ruby library with $EDITOR.
 test_files:
 - spec/command_spec.rb
 - spec/library_search_query_spec.rb