exfuz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b0a899fb5743a6cd65c434e4be0853019ddcf1856bdd27515518fe5a04e9716
+  data.tar.gz: a8d191ed60ffcba306c483027351176b90a800b494017ca049c4a9382d68ea01
+SHA512:
+  metadata.gz: 879270cc6ab2a5e08d979d9d88995362f09ea5be623f9a9b95d54aca8e4fe35ea997625da92bfb56740d31c8a44edbe781255ba7d514bd793e086b6ffad31006
+  data.tar.gz: 3eebc206ab2ad1780a4c9254642fe33e8635ed4f8b09cb083c775c8fe10eb9e15d25ab875067acac4c9f3f9a10944450b77e29275a5f89e9e29cc76776f719fe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exfuz.gemspec
+gemspec
+
+gem 'curses'
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'thor'
+gem 'unicode-display_width'
+gem 'xsv'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    exfuz (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    curses (1.4.4)
+    diff-lcs (1.5.0)
+    rake (13.0.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubyzip (2.3.2)
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+    xsv (1.1.1)
+      rubyzip (>= 1.3, < 3)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  curses
+  exfuz!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  thor
+  unicode-display_width
+  xsv
+
+BUNDLED WITH
+   2.2.24

data/README.md

@@ -0,0 +1,88 @@
+# exfuz
+
+exfuz is able to fuzzy search for excel by using fuzzy finder tools such as fzf, peco
+
+## Features
+
+- fuzzy search is possible for excel workbook, sheet, cells
+    - note: In the current version, exfuz cannot be used if the Ruby environment is Windows.
+- can jump to positions selected lines by fuzzy finder tools
+    - note: In the current version, the jump function is only available in wsl.
+
+## Demo
+![demo](https://user-images.githubusercontent.com/85052152/213947172-8917d9a8-1f88-42a2-9fc1-53c8de25e309.gif)
+
+## Installation
+
+```sh
+gem install exfuz
+```
+
+Install the fuzzy finder tool.[^1]
+[^1]:One of the following fuzzy finder tools must be installed in advance.</br>
+・[fzf](https://github.com/junegunn/fzf)</br>
+・[peco](https://github.com/peco/peco)</br>
+・[percol](https://github.com/mooz/percol)</br>
+・[skim](https://github.com/lotabout/skim)
+
+## Usage
+
+```sh
+exfuz start
+```
+
+Sources to be searched are xlsx files under the current directory hierarchy.
+
+### Query
+It is possible to enter a query on the initial screen. Only cells matching the query will be subject to fuzzy search.</br>
+For example, in the figure below, enter the regular expression `test.*data` in the query area.
+![image](https://user-images.githubusercontent.com/85052152/215886143-6c2750a9-72d9-4b3d-ad86-334569f88642.png)
+
+### Item Format
+The format of the items read by fuzzy finder tool is as follows.</br>
+
+```sh
+LineNumber:FileName:SheetName:CellAddress:CellValue
+```
+
+`LineNumber` is the order of the data passed to the standard input. Also, the delimiter character for each content is`:`.
+
+
+## Key binding
+
+| Key         | Description                             |
+|-------------|-----------------------------------------|
+| CTRL-R      | Launch Fuzzy Finder tool                |
+| CTRL-E      | Stop exfuz                              |
+| CTRL-H      | Back to previous page of selection list |
+| CTRL-L      | Go to next page of selection list       |
+| Right Arrow | Move Query cursor to right              |
+| Left Arrow  | Move Query cursor to left               |
+| BACKSPACE   | Delete one character in Query           |
+
+## Options
+
+Setting file is `.exfuz.json` . 
+
+The priority for reading the configuration is as follows.
+
+1. `./.exfuz.json`
+2. `~/.config/exfuz/.exfuz.json`
+3. Default settings
+
+| Option                    | Values / Default Value                                                            | Description                                                                  |
+|---------------------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------|
+| book_name_path_type       | [”relative”, “absolute”] </br> Default Value: "relative"                          | Format to display book name. </br> relative path or absolute path.           |
+| cell_position_format      | [”index”, “address”] </br> Default Value: "address"                               | Format to display cell position </br> ex) index: $3$4, address: $C$4         |
+| line_sep                  | Arbitary character </br> Default Value: ":"                                       | Delimiter char </br> ex) book1.xlsx:sheet1:$A$1:value if delimiter char is : |
+| split_new_line            | [true, false] </br> Default Value: false                                          | Whether to escape line breaks in cells                                       |
+| fuzzy_finder_command_type | ["fzf", "peco", "percol", "sk"][^2]  </br> Default Value: "fzf" | Which fuzzy finder tool to use                                               |
+[^2]: Value to fuzzy finder tool is as followeds.   </br>
+・"fzf": fzf</br>
+・"peco": peco</br>
+・"percol": percol</br>
+・"sk": skim
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "exfuz"
+
+# 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(__FILE__)

data/bin/setup

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

data/exe/exfuz

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "exfuz"
+Exfuz::Command.start

data/exfuz.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('./lib', __FILE__))
+require_relative "lib/exfuz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "exfuz"
+  spec.version       = Exfuz::VERSION
+  spec.authors       = ["wata00913"]
+  spec.email         = ["175d8639@gmail.com"]
+
+  spec.summary       = "excel fuzzy finder"
+  spec.description   = "Fuzzy finder excel. This uses a fuzzy finder such as peco or fzf."
+  spec.homepage      = "https://github.com/wata00913/exfuz"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ["exfuz"]
+  spec.require_paths = ["lib"]
+
+end

data/lib/exfuz/body.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Exfuz
+  class Body
+    attr_reader :top, :bottom
+
+    def initialize(texts: [], top: 0, bottom: 10)
+      @top = top
+      @bottom = bottom
+
+      @prev_row_to_text = {}
+
+      @size = bottom - top + 1
+      @texts = init_texts(texts)
+      init_page(@texts, @size)
+    end
+
+    def move_next
+      return if @current_page == @max_page
+
+      @current_page += 1
+
+      offset = (@current_page - 1) * @size
+      next_texts = @texts.slice(offset, @size).each_with_index.each_with_object({}) do |(text, idx), result|
+        result[idx] = text
+      end
+      change_some(next_texts)
+    end
+
+    def move_prev
+      return if @current_page == 1
+
+      @current_page -= 1
+
+      offset = (@current_page - 1) * @size
+      prev_texts = @texts.slice(offset, @size).each_with_index.each_with_object({}) do |(text, idx), result|
+        result[idx] = text
+      end
+      change_some(prev_texts)
+    end
+
+    def change(texts)
+      change_some(texts)
+    end
+
+    def change_some(texts)
+      texts.each do |line_num, text|
+        @prev_row_to_text[row(line_num)] = @row_to_text[row(line_num)] if @row_to_text.key?(row(line_num))
+        @row_to_text[row(line_num)] = text
+      end
+    end
+
+    def change_all(texts)
+      @texts = init_texts(texts)
+      @prev_row_to_text = @row_to_text
+      init_page(texts, @size)
+    end
+
+    def lines(overwrite: false)
+      return @row_to_text unless overwrite
+
+      overwrite_lines = @prev_row_to_text.each_with_object({}) do |(row, prev_text), result|
+        current_text = @row_to_text[row] || ''
+        result[row] = overwrite(current: current_text, prev: prev_text)
+      end
+
+      @row_to_text.merge(overwrite_lines)
+    end
+
+    def clear_prev
+      @prev_row_to_text = {}
+    end
+
+    def bottom=(bottom)
+      @bottom = bottom
+      @size = @bottom - top + 1
+    end
+
+    private
+
+    def row(idx)
+      idx + @top
+    end
+
+    def init_texts(texts)
+      @texts = texts + [''] * (@size - (texts.size % @size))
+    end
+
+    def init_page(texts, size)
+      @max_page = texts.size.zero? ? 1 : (texts.size.to_f / size).ceil
+      @current_page = 1
+      @row_to_text = texts.slice(0, size).each_with_index.each_with_object({}) do |(text, idx), result|
+        result[row(idx)] = text
+      end
+    end
+
+    def overwrite(current:, prev:)
+      if current.size < prev.size
+        current.ljust(prev.size)
+      else
+        current
+      end
+    end
+  end
+end

data/lib/exfuz/book_name.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Exfuz
+  class BookName
+    def self.name
+      :book_name
+    end
+
+    attr_reader :absolute_path
+
+    include Exfuz::Util
+
+    def initialize(file_name)
+      @absolute_path = @text = File.absolute_path(file_name)
+    end
+
+    def ==(other)
+      absolute_path == other.absolute_path
+    end
+
+    def hash
+      absolute_path.hash
+    end
+
+    def relative_path
+      Pathname.new(@absolute_path).relative_path_from(Dir.pwd).to_s
+    end
+
+    def jump_info
+      path = wsl? ? wsl_to_windows(@absolute_path) : @absolute_path
+      { Exfuz::BookName.name => path }
+    end
+  end
+end

data/lib/exfuz/candidate.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Exfuz
+  class Candidate
+    def initialize(book_name:, sheet_name:, textable:)
+      @book_name = book_name
+      @sheet_name = sheet_name
+      @textable = textable
+    end
+
+    def value
+      @textable.value
+    end
+
+    def to_line
+      @conf ||= Exfuz::Configuration.instance
+      [
+        book_name_line,
+        @sheet_name,
+        textable_position_line,
+        value_line
+      ].join(@conf.line_sep)
+    end
+
+    private
+
+    def book_name_line
+      pname = Pathname.new(@book_name)
+      case @conf.book_name_path_type
+      when :relative
+        pname.relative_path_from(@conf.dirname.to_s)
+      when :absolute
+        @book_name
+      end
+    end
+
+    def textable_position_line
+      @textable.position_s(format: @conf.cell_position_format)
+    end
+
+    def value_line
+      text = @textable.value.to_s
+      @conf.split_new_line ? text : text.gsub(/\R+/) { '\n' }
+    end
+  end
+end

data/lib/exfuz/candidates.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Exfuz
+  class Candidates
+    @@queue = Queue.new
+    @@raw = []
+
+    def initialize(items = [])
+      @processed = items
+    end
+
+    def push(item)
+      @@queue << item
+    end
+
+    def suspend_push
+      @@queue << nil
+    end
+
+    def close_push?
+      @@queue.closed?
+    end
+
+    def close_push
+      @@queue << nil
+      @@queue.close
+    end
+
+    def positions
+      @processed.empty? ? @@raw : @processed
+    end
+
+    def filter(conditions)
+      pipeline
+      filtered = positions.filter do |position|
+        position.match?(conditions)
+      end
+      Exfuz::Candidates.new(filtered)
+    end
+
+    def group_by(keys)
+      pipeline
+      Exfuz::Group.new(positions, keys)
+    end
+
+    private
+    def pipeline
+      while data = @@queue.pop
+        @processed << data
+      end
+    end
+  end
+end

data/lib/exfuz/cell.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Exfuz
+  class Cell
+    def self.name
+      :textable
+    end
+
+    attr_reader :row, :col, :value
+
+    include Exfuz::Util
+
+    def initialize(value:, row: nil, col: nil, address: nil)
+      if row && col
+        @row = row
+        @col = col
+      elsif address
+        @row, @col = to_idx(address)
+      else
+        raise "argument error. row: #{row}, col: #{col}, address: #{address}"
+      end
+
+      @value = value
+      # valueはString型以外も含むのでマッチ用の@textは文字列に変換させる
+      @text = @value.to_s
+    end
+
+    def position_s(format: :address)
+      case format
+      when :address
+        to_address(@col, row)
+      when :index
+        "$#{col}$#{row}"
+      end
+    end
+
+    def ==(other)
+      return false if other.nil? || !other.instance_of?(Exfuz::Cell)
+
+      [@row, @col, @value] == [other.row, other.col, other.value]
+    end
+
+    def hash
+      [@row, @col, @value].hash
+    end
+
+    def jump_info
+      { Exfuz::Cell.name => { row: @row, col: @col } }
+    end
+
+    private
+
+    def to_idx(address)
+      _, c_alph, r_str = address.split('$')
+
+      c = 0
+      large_a_z = ('A'..'Z')
+      c_alph.chars.reverse.each_with_index do |char, i|
+        c += (26**i * (large_a_z.find_index(char) + 1))
+      end
+
+      [r_str.to_i, c]
+    end
+
+    def to_address(col, row)
+      "$#{to_alphabet(col)}$#{row}"
+    end
+
+    def to_alphabet(idx)
+      large_a_z = ('A'..'Z').to_a
+      alphabet = ''
+      q = idx
+
+      until q.zero?
+        q, r = (q - 1).divmod(26)
+        alphabet += large_a_z[r]
+      end
+
+      alphabet
+    end
+  end
+end

data/lib/exfuz/command.rb

@@ -0,0 +1,11 @@
+require 'thor'
+require_relative 'main'
+
+module Exfuz
+  class Command < Thor
+    desc "start", "start exfuz"
+    def start
+      main
+    end
+  end
+end

data/lib/exfuz/configuration.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'pathname'
+require 'json'
+
+module Exfuz
+  class Configuration
+    include Singleton
+
+    GLOBAL_DIRS = [File.join(Dir.home, '.config/exfuz')].freeze
+    FILE_NAME = '.exfuz.json'
+
+    attr_reader :dirname
+
+    private_constant :FILE_NAME, :GLOBAL_DIRS
+
+    def initialize
+      @dirname = Pathname.new(Dir.pwd)
+      set_data
+    end
+
+    def book_name_path_type
+      @data[:book_name_path_type]
+    end
+
+    def cell_position_format
+      @data[:cell_position_format]
+    end
+
+    def line_sep
+      @data[:line_sep]
+    end
+
+    def split_new_line
+      @data[:split_new_line]
+    end
+
+    def jump_positions?
+      @data[:jump_positions]
+    end
+
+    def fuzzy_finder_command_type
+      @data[:fuzzy_finder_command_type].to_sym
+    end
+
+    private
+
+    def set_data
+      @data = default.clone
+      @data.merge!(read_from_global || {})
+           .merge!(read_from_local(@dirname) || {})
+    end
+
+    def read_from_local(dirname)
+      fpath = File.join(dirname.to_s, FILE_NAME)
+      return nil unless File.exist?(fpath)
+
+      read(fpath)
+    end
+
+    def read_from_global
+      fpath = GLOBAL_DIRS.map { |d| File.join(d, FILE_NAME) }
+                         .find { |f| File.exist?(f) }
+      return nil unless fpath
+
+      read(fpath)
+    end
+
+    def read(path)
+      data = JSON.parse(File.read(path), symbolize_names: true)
+      data.transform_values { |v| v.instance_of?(String) ? v.to_sym : v }
+    end
+
+    def default
+      {
+        book_name_path_type: :relative,
+        cell_position_format: :index,
+        line_sep: ':',
+        split_new_line: false,
+        jump_positions: false,
+        fuzzy_finder_command_type: 'fzf'
+      }
+    end
+  end
+end

data/lib/exfuz/event.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'observer'
+
+module Exfuz
+  class Event
+    include Observable
+    def add_event_handler(obj, func)
+      add_observer(obj, func)
+    end
+
+    def fired(*args)
+      changed
+      args.empty? ? notify_observers : notify_observers(*args)
+    end
+  end
+end