clipcellar 0.0.1

data/NEWS.md

@@ -0,0 +1,5 @@
+# NEWS
+
+## 0.0.1: 2014-07-29
+
+Initial release!

data/README.md

@@ -0,0 +1,70 @@
+# Clipcellar
+
+Clipcellar is a full-text searchable data store for clipboard.
+
+Powered by [GTK+][] (via [Ruby/GTK2][]) and [Groonga][] (via [Rroonga][]).
+
+[GTK+]:http://www.gtk.org/
+[Ruby/GTK2]:http://ruby-gnome2.sourceforge.jp/
+[Groonga]:http://groonga.org/
+[Rroonga]:http://ranguba.org/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clipcellar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clipcellar
+
+## Usage
+
+### Show help
+
+    $ clipcellar
+
+### Add a text (or clipboard) to data store
+
+    $ clipcellar set [TEXT]
+
+### Add a text from files (or stdin)
+
+    $ clipcellar input [FILE]...
+
+### Show added texts in data store
+
+    $ clipcellar show [--gui]
+
+### Full-text search (and set a text to clipboard)
+
+    $ clipcellar search WORD... [--gui]
+
+### Watch clipboard (Ctrl+C to stop)
+
+    $ clipcellar watch
+
+### Delete data store and all added texts
+
+    $ clipcellar destroy
+
+## License
+
+Copyright (c) 2014 Masafumi Yokoyama `<myokoym@gmail.com>`
+
+LGPLv2.1 or later.
+
+See LICENSE.txt or http://www.gnu.org/licenses/lgpl-2.1 for details.
+
+## 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,25 @@
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "bundler/gem_tasks"
+
+desc "Run test"
+task :test do
+  Bundler::GemHelper.install_tasks
+  ruby("test/run-test.rb")
+end
+
+task :default => :test

data/bin/clipcellar

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "clipcellar/command"
+
+Clipcellar::Command.start

data/clipcellar.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clipcellar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "clipcellar"
+  spec.version       = Clipcellar::VERSION
+  spec.authors       = ["Masafumi Yokoyama"]
+  spec.email         = ["myokoym@gmail.com"]
+  spec.summary       = %q{Full-Text Searchable Data Store for Clipboard}
+  spec.description   = %q{Clipcellar is a full-text searchable data store for clipboard by GTK+ (via Ruby/GTK2) and Groonga (via Rroonga).}
+  spec.homepage      = "https://github.com/myokoym/clipcellar"
+  spec.license       = "LGPLv2.1 or later"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("gtk2")
+  spec.add_runtime_dependency("rroonga")
+  spec.add_runtime_dependency("thor")
+
+  spec.add_development_dependency("test-unit")
+  spec.add_development_dependency("test-unit-notify")
+  spec.add_development_dependency("test-unit-rr")
+  spec.add_development_dependency("bundler", "~> 1.6")
+  spec.add_development_dependency("rake")
+end

data/lib/clipcellar.rb

@@ -0,0 +1,23 @@
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "clipcellar/version"
+require "clipcellar/groonga_database"
+require "clipcellar/groonga_searcher"
+require "clipcellar/clipboard"
+
+module Clipcellar
+end

data/lib/clipcellar/clipboard.rb

@@ -0,0 +1,82 @@
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+begin
+  require "gtk2"
+rescue Gtk::InitError
+  # a window system is unnecessary.
+end
+
+module Clipcellar
+  class Clipboard
+    class << self
+      def watch
+        current_text = get
+        GLib::Timeout.add(500) do
+          text = get
+          if current_text != text
+            yield(text)
+            current_text = text
+          end
+          true
+        end
+
+        begin
+          Gtk.main
+        rescue Interrupt => e
+          $stderr.puts(e.message)
+        end
+      end
+
+      def get
+        if /darwin/ =~ RUBY_PLATFORM
+          `pbpaste`
+        else
+          clipboard.wait_for_text
+        end
+      end
+
+      def set(text)
+        copy_to_clipboard(text)
+
+        # workaround for CLI
+        GLib::Timeout.add(1) do
+          Gtk.main_quit
+        end
+        Gtk.main
+      end
+
+      def copy_to_clipboard(text)
+        if /darwin/ =~ RUBY_PLATFORM
+          require "tempfile"
+          Tempfile.open(["clipcellar", "w"]) do |file|
+            text.each_line do |line|
+              file.puts(line)
+            end
+            file.flush
+            system("pbcopy < #{file.path}")
+          end
+        else
+          clipboard.text = text
+        end
+      end
+
+      def clipboard
+        Gtk::Clipboard.get(Gdk::Selection::CLIPBOARD)
+      end
+    end
+  end
+end

data/lib/clipcellar/command.rb

@@ -0,0 +1,158 @@
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "thor"
+require "fileutils"
+require "clipcellar/version"
+require "clipcellar/groonga_database"
+require "clipcellar/groonga_searcher"
+require "clipcellar/clipboard"
+require "clipcellar/window"
+
+module Clipcellar
+  class Command < Thor
+    map "-v" => :version
+    map "-a" => :set
+    map "-A" => :input
+    map "-s" => :show
+    map "-S" => :search
+    map "-W" => :watch
+
+    attr_reader :database_dir
+
+    def initialize(*args)
+      super
+      @base_dir = File.join(File.expand_path("~"), ".clipcellar")
+      @database_dir = File.join(@base_dir, "db")
+    end
+
+    desc "version", "Show version number."
+    def version
+      puts Clipcellar::VERSION
+    end
+
+    desc "set [TEXT]", "Add a text (or clipboard) to data store"
+    def set(text=nil)
+      text = Clipboard.get unless text
+      return unless text
+      Clipboard.set(text)
+      add(text)
+    end
+
+    desc "input [FILE]...", "Add a text from files (or stdin)"
+    def input(*files)
+      ARGV.shift
+      text = ""
+      while line = ARGF.gets
+        text << line
+      end
+      Clipboard.set(text)
+      add(text)
+    end
+
+    desc "watch", "Watch clipboard to add clipboard to data store"
+    def watch
+      $stderr.puts("Watching... (Ctrl+C to Stop)")
+      Clipboard.watch do |text|
+        add(text)
+      end
+    end
+
+    desc "show [--gui]", "Show added texts in data store"
+    option :gui, :type => :boolean, :desc => "GUI mode"
+    def show
+      records = []
+      GroongaDatabase.new.open(@database_dir) do |database|
+        database.clipboards.each do |clipboard|
+          record = {}
+          record[:key] = clipboard._key
+          record[:text] = clipboard.text
+          record[:time] = clipboard.created_at
+          records << record
+        end
+      end
+
+      records.sort_by! do |record|
+        record[:time]
+      end
+
+      if options[:gui]
+        records.reverse!
+        window = Window.new(records)
+        window.run
+      else
+        records.each do |record|
+          text = record[:text]
+          time = record[:time].strftime("%Y-%m-%d %H:%M:%S")
+          formatted_text = text.gsub(/\n/, " ") if text
+          puts "#{time} #{formatted_text}"
+        end
+      end
+    end
+
+    desc "search WORD... [--gui]", "Search texts from data store"
+    option :gui, :type => :boolean, :desc => "GUI mode"
+    def search(required_word, *optional_words)
+      words = [required_word]
+      words += optional_words
+
+      records = []
+      GroongaDatabase.new.open(@database_dir) do |database|
+        reverse = options[:gui] ? true : false
+        sorted_clipboards = GroongaSearcher.search(database,
+                                                   words,
+                                                   :reverse => reverse)
+
+        sorted_clipboards.each do |clipboard|
+          record = {}
+          record[:key] = clipboard._key
+          record[:text] = clipboard.text
+          record[:time] = clipboard.created_at
+          records << record
+        end
+      end
+
+      if options[:gui]
+        window = Window.new(records)
+        window.run
+      else
+        text = nil
+        records.each do |record|
+          text = record[:text]
+          time = record[:time].strftime("%Y-%m-%d %H:%M:%S")
+          formatted_text = text.gsub(/\n/, " ") if text
+          puts "#{time} #{formatted_text}"
+        end
+        Clipboard.set(text) if text
+      end
+    end
+
+    desc "destroy", "Delete data store and all added texts"
+    def destroy
+      FileUtils.rm(Dir.glob(File.join(@database_dir, "clipcellar.db*")))
+      FileUtils.rmdir(@database_dir)
+    end
+
+    private
+    def add(text)
+      time = Time.now
+      id = time.strftime("%Y%m%d%H%M%S%L")
+      GroongaDatabase.new.open(@database_dir) do |database|
+        database.add(id, text, time)
+      end
+    end
+  end
+end

data/lib/clipcellar/groonga_database.rb

@@ -0,0 +1,100 @@
+# Copyright (C) 2014  Masafumi Yokoyama <myokoym@gmail.com>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "groonga"
+
+module Clipcellar
+  class GroongaDatabase
+    def initialize
+      @database = nil
+    end
+
+    def open(base_path, encoding=:utf8)
+      reset_context(encoding)
+      path = File.join(base_path, "clipcellar.db")
+      if File.exist?(path)
+        @database = Groonga::Database.open(path)
+        populate_schema
+      else
+        FileUtils.mkdir_p(base_path)
+        populate(path)
+      end
+      if block_given?
+        begin
+          yield(self)
+        ensure
+          close unless closed?
+        end
+      end
+    end
+
+    def add(id, text, time)
+      clipboards.add(id,
+                     {
+                       :text       => text,
+                       :created_at => time,
+                     })
+    end
+
+    def delete(id)
+      clipboards.delete(id)
+    end
+
+    def close
+      @database.close
+      @database = nil
+    end
+
+    def closed?
+      @database.nil? or @database.closed?
+    end
+
+    def clipboards
+      @clipboards ||= Groonga["Clipboards"]
+    end
+
+    def dump
+      Groonga::DatabaseDumper.dump
+    end
+
+    private
+    def reset_context(encoding)
+      Groonga::Context.default_options = {:encoding => encoding}
+      Groonga::Context.default = nil
+    end
+
+    def populate(path)
+      @database = Groonga::Database.create(:path => path)
+      populate_schema
+    end
+
+    def populate_schema
+      Groonga::Schema.define do |schema|
+        schema.create_table("Clipboards", :type => :hash) do |table|
+          table.text("text")
+          table.time("created_at")
+        end
+
+        schema.create_table("Terms",
+                            :type => :patricia_trie,
+                            :key_normalize => true,
+                            :default_tokenizer => "TokenBigram") do |table|
+          table.index("Clipboards.text")
+        end
+      end
+    end
+  end
+end