pepin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 570d718040558cf7d64387744e53377dc2af975f
+  data.tar.gz: 2d523c01a2cfa6683d6eeb9897244481413e598a
+SHA512:
+  metadata.gz: 7506252df04c06ade066876f27ac80871fa54bd376551889c3d92c96abe40f9f45d7d23d5e32e070e279193fad5e5a51d85db55c5d5abc224a567b68cbef1f19
+  data.tar.gz: ca4fbede7b90605ba47b62e496f83a31d82d0781bed65535271a99ff32b2a6d53da18b024ca5c2f0dc4b36d71c85c90bc6493ef8495653da918159e24f0d68bd

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hika Hibariya
+
+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,49 @@
+# Pepin
+
+Pepin is a Percol and Peco like, interactive filtering tool for CLI written in Ruby.
+`Pepin.search` Launches interactive window for filtering, and returns the filtered item.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pepin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pepin
+
+## Usage
+
+The most simple example is below.
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'pepin'
+
+list = %w(Alpha Bravo Charlie Delta Echo)
+item = Pepin.search(list) # Launches interactive window and returns selected item
+
+puts %(You selected "#{item}" from #{list.inspect}.)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hibariya/pepin. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pepin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/pepin

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pepin'
+
+list = $stdin.read.split($/)
+
+# FIXME Pepin responds to SIGWINCH but this command can't handle window size
+$stdin.reopen '/dev/tty'
+
+puts Pepin.search(list)

data/lib/pepin.rb

@@ -0,0 +1,14 @@
+require 'pepin/version'
+
+module Pepin
+  autoload :InteractiveSearch, 'pepin/interactive_search'
+  autoload :GrepFilter,        'pepin/grep_filter'
+  autoload :Query,             'pepin/query'
+  autoload :CursesView,        'pepin/curses_view'
+
+  class << self
+    def search(list, view: nil, filter: nil)
+      InteractiveSearch.new(list, view: view, filter: filter).search
+    end
+  end
+end

data/lib/pepin/curses_view.rb

@@ -0,0 +1,141 @@
+require 'curses'
+require 'forwardable'
+
+module Pepin
+  class CursesView
+    class PromptView
+      extend Forwardable
+
+      attr_reader :cursor
+
+      def_delegators :@window, :resize
+
+      def initialize(height, width, y, x, query:, prompt:)
+        @query, @prompt_string = query, prompt
+        @window = Curses::Window.new(height, width, y, x)
+        @cursor = cursor_range.first
+
+        @query.add_observer -> { render }, :call
+      end
+
+      def input_char
+        @window.getch
+      end
+
+      def move_cursor(value)
+        self.cursor = cursor + value
+      end
+
+      def move_cursor_to_first
+        self.cursor = cursor_range.first
+      end
+
+      def move_cursor_to_last
+        self.cursor = cursor_range.last
+      end
+
+      def render
+        @window.setpos 0, 0
+        @window.addstr @prompt_string + @query.to_s
+        @window.clrtoeol
+      end
+
+      private
+
+      def cursor_range
+        0..@query.length
+      end
+
+      def cursor=(pos)
+        return false unless cursor_range.include?(pos)
+
+        @cursor = pos
+
+        @window.setpos 0, @prompt_string.length + pos
+      end
+    end
+
+    class ListView
+      extend Forwardable
+
+      def_delegators :@window, :resize
+
+      def initialize(height, width, y, x, query:)
+        @query  = query
+        @window = Curses::Window.new(height, width, y, x)
+
+        @query.add_observer -> { render }, :call
+      end
+
+      def render
+        @window.clear
+
+        @query.search.each.with_index 1 do |item, n|
+          selected       = n == 1
+          matched_offset = @query.pattern ? @query.pattern.match(item).offset(0) : [-1, -1]
+
+          @window.setpos n, 0
+          @window.attron Curses::A_UNDERLINE if selected
+          item.each_char.with_index do |ch, i|
+            @window.attron  Curses::A_BOLD if i == matched_offset[0]
+            @window.attroff Curses::A_BOLD if i == matched_offset[1]
+            @window.addch ch
+          end
+
+          @window.addstr ' ' * (@window.maxx - @window.curx)
+          @window.attroff Curses::A_UNDERLINE if selected
+          @window.attroff Curses::A_BOLD
+        end
+
+        @window.refresh
+      end
+    end
+
+    extend Forwardable
+
+    def_delegators :@prompt_view, :cursor, :input_char, :move_cursor, :move_cursor_to_first, :move_cursor_to_last
+
+    def initialize(query, prompt: '> ')
+      @query         = query
+      @prompt_string = prompt
+
+      launch
+    end
+
+    def launch
+      @window = Curses.init_screen
+
+      @window.keypad true
+      Curses.raw
+      Curses.noecho
+
+      @prompt_view = PromptView.new(1,                 Curses.cols, 0, 0, query: @query, prompt: @prompt_string)
+      @list_view   = ListView.new(  Curses.lines - 1,  Curses.cols, 0, 0, query: @query)
+
+      render
+    end
+
+    def render
+      @prompt_view.render
+      @list_view.render
+    end
+
+    def refresh_winsize
+      Curses.clear
+
+      lines = Curses.lines
+      cols  = Curses.cols
+
+      Curses.resize       lines,     cols
+      @window.resize      lines,     cols
+      @prompt_view.resize 1,         cols
+      @list_view.resize   lines - 1, cols
+
+      render
+    end
+
+    def shutdown
+      Curses.close_screen if @window
+    end
+  end
+end

data/lib/pepin/grep_filter.rb

@@ -0,0 +1,11 @@
+module Pepin
+  class GrepFilter
+    def pattern(query)
+      query.empty? ? nil : Regexp.new(Regexp.quote(query), 'i')
+    end
+
+    def select(list, query)
+      query.empty? ? list : list.grep(pattern(query))
+    end
+  end
+end

data/lib/pepin/interactive_search.rb

@@ -0,0 +1,108 @@
+module Pepin
+  class InteractiveSearch
+    attr_reader :query, :view
+
+    def initialize(list, view: nil, filter: nil)
+      @query      = Query.new(list, filter: filter || GrepFilter)
+      @view_klass = view || CursesView
+    end
+
+    def search
+      @view = @view_klass.new(query)
+
+      search_interactive
+    ensure
+      @view.shutdown if @view
+    end
+
+    private
+
+    def search_interactive
+      while ch = view.input_char
+        handler =
+          case ch
+          when String                                         then :handle_string
+          when Curses::KEY_ENTER, 10                          then :handle_enter
+          when Curses::KEY_CTRL_A                             then :handle_ctrl_a
+          when Curses::KEY_CTRL_W                             then :handle_ctrl_w
+          when Curses::KEY_CTRL_E                             then :handle_ctrl_e
+          when Curses::KEY_CTRL_K                             then :handle_ctrl_k
+          when Curses::KEY_BACKSPACE, Curses::KEY_CTRL_H, 127 then :handle_backspace
+          when Curses::KEY_CTRL_C                             then :handle_ctrl_c
+          when Curses::KEY_CTRL_D                             then :handle_ctrl_d
+          when Curses::KEY_CTRL_F, Curses::KEY_RIGHT          then :handle_cursor_right
+          when Curses::KEY_CTRL_B, Curses::KEY_LEFT           then :handle_cursor_left
+          when Curses::KEY_RESIZE                             then :handle_resize
+          else                                                     :handle_unknown
+          end
+
+        send handler, ch
+      end
+
+      result
+    rescue StopIteration
+      result
+    end
+
+    def result
+      query.search.first
+    end
+
+    def handle_string(ch)
+      query.add_char ch
+      view.move_cursor 1
+    end
+
+    def handle_enter(*)
+      raise StopIteration
+    end
+
+    def handle_ctrl_a(*)
+      view.move_cursor_to_first
+    end
+
+    def handle_ctrl_w(*)
+      len = query.delete_behind_word_from(view.cursor)
+
+      view.move_cursor -len
+    end
+
+    def handle_ctrl_e(*)
+      view.move_cursor_to_last
+    end
+
+    def handle_ctrl_k(*)
+      query.delete_ahead_from view.cursor
+    end
+
+    def handle_backspace(*)
+      query.delete_behind_char_from view.cursor
+
+      view.move_cursor -1
+    end
+
+    def handle_ctrl_c(*)
+      exit
+    end
+
+    def handle_ctrl_d(*)
+      exit if query.empty?
+    end
+
+    def handle_cursor_right(*)
+      view.move_cursor 1
+    end
+
+    def handle_cursor_left(*)
+      view.move_cursor -1
+    end
+
+    def handle_resize(*)
+      view.refresh_winsize
+    end
+
+    def handle_unknown(*)
+      # Intentionally NOP
+    end
+  end
+end

data/lib/pepin/query.rb

@@ -0,0 +1,70 @@
+require 'forwardable'
+require 'observer'
+
+module Pepin
+  class Query
+    extend Forwardable
+    include Observable
+
+    def_delegators :@string, :length, :empty?, :to_s
+
+    def initialize(list, filter: GrepFilter)
+      @list   = list
+      @string = ''
+      @filter = filter.new
+    end
+
+    def pattern
+      @filter.pattern(@string.strip)
+    end
+
+    def search
+      @filter.select(@list, @string.strip)
+    end
+
+    def clear
+      @string.clear
+
+      notify_change
+    end
+
+    def add_char(ch)
+      @string << ch
+
+      notify_change
+    end
+
+    def delete_behind_word_from(pos)
+      string_was = @string
+      @string    = @string[0..pos.pred].split(/\b/)[0...-1].join + @string[pos..-1]
+
+      notify_change
+
+      string_was.length - @string.length
+    end
+
+    def delete_behind_char_from(pos)
+      @string = @string[0...pos.pred] + @string[pos..-1]
+
+      notify_change
+
+      1
+    end
+
+    def delete_ahead_from(pos)
+      string_was = @string
+      @string    = @string.to_s[0...pos]
+
+      notify_change
+
+      string_was.length - @string.length
+    end
+
+    private
+
+    def notify_change
+      changed
+      notify_observers
+    end
+  end
+end

data/lib/pepin/version.rb

@@ -0,0 +1,3 @@
+module Pepin
+  VERSION = '0.1.0'
+end

data/pepin.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pepin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pepin'
+  spec.version       = Pepin::VERSION
+  spec.authors       = ['hibariya']
+  spec.email         = ['hibariya@gmail.com']
+
+  spec.summary       = %q{Interactive filtering tool for CLI written in Ruby.}
+  spec.homepage      = 'https://github.com/hibariya/pepin'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'curses',   '~> 1.0.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: pepin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hibariya
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 
+email:
+- hibariya@gmail.com
+executables:
+- pepin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pepin
+- lib/pepin.rb
+- lib/pepin/curses_view.rb
+- lib/pepin/grep_filter.rb
+- lib/pepin/interactive_search.rb
+- lib/pepin/query.rb
+- lib/pepin/version.rb
+- pepin.gemspec
+homepage: https://github.com/hibariya/pepin
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Interactive filtering tool for CLI written in Ruby.
+test_files: []