epub-search 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0e5eaac93572491de5dfb8b483d996daf3f2798
-  data.tar.gz: 12fd51e95e4ca7291b92ca3d10f8b5f43c76331c
+  metadata.gz: 536544d7de71e3a8248d0dfde581b2cf23a32cc1
+  data.tar.gz: dea71df17f48c5d10fa7b767904259db9021a057
 SHA512:
-  metadata.gz: 7bab11cd12dc7f248b8dcc3f990e45c3d7c77a798750fa0eb2b88e4c915b7926675b4c6e3d73b79bc9ad21106350cdab9c34e88f6c3e2726c0dcb38ed5cf622f
-  data.tar.gz: 64882ff476229d0841e126b9fb65c986a100e551fd39ccc0651845c0ad443eef0c554047ffac43a3f143d93e96d6fff8b230d9b77d55abba7abadb3754b45ac8
+  metadata.gz: 5d77aeba6dfcaff267d8e15577ad0fc5438039cabbb1badee432456906b4b3be780fcca4ea8be15235286205e34efa929bfa85526a1b0c49a927a49292aad345
+  data.tar.gz: 42f255473c9386d092b1d1d6b15cbfd081b729abf4a694321302c845e3778e14c807a65e108343c2f0a4cdb63d1718aeece69c0b3be3a6787a1d85d16565d7f3

data/CHANGELOG.markdown

@@ -0,0 +1,13 @@
+Change Log
+==========
+
+0.0.2
+-----
+* Ruby vertion limited to 2.0
+* Database directory changed
+  * Exec `epub-search init` again
+* Pid file is used to avoid multiple processes are running at once for epub-search watch
+
+0.0.1
+-----
+* First release

data/README.markdown

@@ -15,7 +15,7 @@ Usage
     Commands:
       epub-search add FILE                           # Add FILE to database
       epub-search help [COMMAND]                     # Describe available commands or one specific command
-      epub-search init [DB_DIR]                      # Setup database
+      epub-search init [DIR]                         # Setup database
       epub-search list                               # Show list of book titles in database
       epub-search remove FILE                        # Remove FILE from database
       epub-search search WORD [BOOK]                 # Search WORD in book whose title is like BOOK from database
@@ -40,9 +40,18 @@ EPUB Search(`epub-search` command) detectes configuration file following by this
 
 Configuration file should be written as YAML and you can set properties below:
 
-* :db_dir: String. Groonga database directory, defaults to $HOME/.epub-search/db
+* :dir: String. Directory for Groonga database and other files, defaults to $HOME/.epub-search/db
 * :directories: Array of String. Directories `watch` subcommand watches.
 
+ChangeLog
+---------
+
+### 0.0.2
+* Ruby vertion limited to 2.0
+* Database directory changed
+  * Exec `epub-search init` again
+* Pid file is used to avoid multiple processes are running at once for epub-search watch
+
 Contributing
 ------------
 

data/Rakefile

@@ -5,5 +5,7 @@ require 'bundler/gem_tasks'
 
 task :default => :test
 
-Rake::TestTask.new
+Rake::TestTask.new do |t|
+  t.options = '--verbose'
+end
 YARD::Rake::YardocTask.new

data/app/add.rb

@@ -1,8 +1,8 @@
 class Add
-  def initialize(db_dir, file_path)
+  def initialize(dir, file_path)
     @file_path = Pathname.new(file_path)
     raise "File not readable: #{@file_path}" unless @file_path.readable?
-    @db = EPUB::Search::Database.new(db_dir)
+    @db = EPUB::Search::Database.new(File.join(dir, EPUB::Search::Database::DIR_NAME))
   end
 
   def run(update=true)

data/app/init.rb

@@ -1,6 +1,6 @@
 class Init
-  def initialize(db_dir)
-    @db = EPUB::Search::Database.new(db_dir)
+  def initialize(dir)
+    @db = EPUB::Search::Database.new(File.join(dir, EPUB::Search::Database::DIR_NAME))
   end
 
   def run(force=false)

data/app/list.rb

@@ -1,6 +1,6 @@
 class List
-  def initialize(db_dir)
-    @db= EPUB::Search::Database.new(db_dir)
+  def initialize(dir)
+    @db= EPUB::Search::Database.new(File.join(dir, EPUB::Search::Database::DIR_NAME))
   end
 
   def run(path=false)

data/app/remove.rb

@@ -1,7 +1,7 @@
 class Remove
-  def initialize(db_dir, file_path)
+  def initialize(dir, file_path)
     @file_path = Pathname(file_path)
-    @db = EPUB::Search::Database.new(db_dir)
+    @db = EPUB::Search::Database.new(File.join(dir, EPUB::Search::Database::DIR_NAME))
   end
 
   def run

data/app/search.rb

@@ -1,7 +1,7 @@
 class Search
-  def initialize(db_dir, search_word, book=nil)
+  def initialize(dir, search_word, book=nil)
     @word, @book = search_word, book
-    @db = EPUB::Search::Database.new(db_dir)
+    @db = EPUB::Search::Database.new(File.join(dir, EPUB::Search::Database::DIR_NAME))
   end
 
   def run(color=$stdout.tty?)

data/app/server.rb

@@ -1,6 +1,6 @@
 class Server
-  def initialize(db_dir)
-    @db = EPUB::Search::Database.new(db_dir)
+  def initialize(dir)
+    @db = EPUB::Search::Database.new(File.join(dir, EPUB::Search::Database::DIR_NAME))
   end
 
   def run

data/app/watch.rb

@@ -2,19 +2,30 @@ require 'notify'
 
 class Watch
   EPUB_RE = /\.epub\Z/io
+  PID_FILE_NAME = 'epub-search.pid'
 
-  def initialize(db_file, directories)
+  def initialize(work_dir, directories)
     raise ArgumentError, 'specify at least one directory' if directories.empty?
-    @directories = directories
-    @db = EPUB::Search::Database.new(db_file)
+    @work_dir = Pathname === work_dir ? work_dir : Pathname.new(work_dir)
+    @directories = directories.map {|dir| File.expand_path(dir)}
+    @db = EPUB::Search::Database.new(File.join(@work_dir.to_path, EPUB::Search::Database::DIR_NAME))
   end
 
-  def run
+  def run(notify_on_change: true, daemonize: false, debug: false)
+    @notify, @daemonize, @debug = notify_on_change, daemonize, debug
+    if @debug
+      $stderr.puts "notify_on_change: #{@notify}"
+      $stderr.puts "daemonize: #{@daemonize}"
+      $stderr.puts "debug: #{@debug}"
+    end
+
     $PROGRAM_NAME = File.basename($PROGRAM_NAME)
     $stderr.puts 'start to watch:'
     @directories.each do |dir|
       $stderr.puts "  * #{dir}"
     end
+    Process.daemon if @daemonize
+    write_pid_file
     catch_up
     begin
       Listen.to *@directories, :filter => EPUB_RE do |modified, added, removed|
@@ -22,12 +33,16 @@ class Watch
           next unless file_path =~ EPUB_RE
           file_path.force_encoding 'UTF-8'
           begin
+            $stderr.puts "remove #{file_path}"
             @db.remove file_path
+            $stderr.puts "add #{file_path}"
             @db.add file_path
             title = EPUB::Parser.parse(file_path).title
             notify %Q|UPDATED: #{title}\n#{file_path}|
+            FileUtils.touch exit_time_file
           rescue => error
             $stderr.puts error
+            $stderr.puts error.backtrace if @debug
           end
         end
         added.each do |file_path|
@@ -37,8 +52,10 @@ class Watch
             @db.add file_path
             title = EPUB::Parser.parse(file_path).title
             notify %Q|ADDED: #{title}\n#{file_path}|
+            FileUtils.touch exit_time_file
           rescue => error
             $stderr.puts error
+            $stderr.puts error.backtrace if @debug
           end
         end
         removed.each do |file_path|
@@ -47,18 +64,25 @@ class Watch
           begin
             @db.remove file_path
             notify %Q|REMOVED:\n#{file_path}|
+            FileUtils.touch exit_time_file
           rescue => error
             $stderr.puts error
+            $stderr.puts error.backtrace if @debug
           end
         end
       end
     ensure
+      pid_file.delete
       FileUtils.touch exit_time_file
     end
   end
 
   private
 
+  def notify?
+    @notify
+  end
+
   def exit_time
     @exittime ||= File.mtime(exit_time_file)
   end
@@ -67,6 +91,10 @@ class Watch
     @db.db_dir.join('../exittime').to_path
   end
 
+  def pid_file
+    @work_dir + PID_FILE_NAME
+  end
+
   def catch_up
     @directories.each do |dir|
       Dir["#{dir}/**/*.epub"].each do |file_path|
@@ -77,15 +105,34 @@ class Watch
           operation = removed.zero? ? 'ADDED' : 'UPDATED'
           title = EPUB::Parser.parse(file_path).title
           notify "#{operation}: #{title}\n#{file_path}"
+          FileUtils.touch exit_time_file
         rescue => error
           $stderr.puts error
+          $stderr.puts error.backtrace if @debug
         end
       end
     end
+  rescue
+    pid_file.unlink
+  end
+
+  def write_pid_file
+    if pid_file.exist?
+      pid = pid_file.read.to_i
+      begin
+        Process.kill 0, pid
+        raise "#{$PROGRAM_NAME}(pid: #{pid}) is running"
+      rescue Errno::ESRCH
+      end
+    end
+    $stderr.puts "pid: #{Process.pid}" if @debug
+    pid_file.open 'wb' do |file|
+      file.write Process.pid
+    end
   end
 
   def notify(message)
     $stderr.puts message
-    Notify.notify $PROGRAM_NAME, message
+    Notify.notify $PROGRAM_NAME, message if notify?
   end
 end

data/bin/epub-search

@@ -4,7 +4,7 @@ require 'thor'
 require 'epub/search'
 
 Class.new(Thor) {
-  APP_DIR = File.expand_path('../../app', __FILE__)
+  APP_DIR = File.expand_path('../app', __dir__)
   Dir["#{APP_DIR}/*.rb"].each do |path|
     require path
   end
@@ -18,44 +18,47 @@ Class.new(Thor) {
   class_option :config, :type => :string, :aliases => '-c', :default => nil, :desc => 'Path to config file'
 
   method_option :force, :type => :boolean, :aliases => '-f', :default => false, :desc => 'Remove existing database before init'
-  desc 'init [DB_DIR]', 'Setup database'
-  def init(db_dir=config[:db_dir])
-    Init.new(db_dir).run(options[:force])
+  desc 'init [DIR]', 'Setup database'
+  def init(dir=config[:dir])
+    Init.new(dir).run(options[:force])
   end
 
   method_option :update, :type => :boolean, :default => true, :desc => 'Remove existing indices of given book before adding'
   desc 'add FILE', 'Add FILE to database'
   def add(file)
-    Add.new(config[:db_dir], file).run(options[:update])
+    Add.new(config[:dir], file).run(options[:update])
   end
 
   method_option :color, :type => :string, :aliasis => :colour, :default => 'auto', :desc => 'Color search word in search result. auto, always and never is available. --no-color also is available as never', :banner => 'WHEN'
   desc 'search WORD [BOOK]', 'Search WORD in book whose title is like BOOK from database'
   def search(word, book=nil)
     raise 'Invalid argument for color option' unless [nil, 'auto', 'always', 'never'].include? options[:color]
-    Search.new(config[:db_dir], word, book).run(options[:color])
+    Search.new(config[:dir], word, book).run(options[:color])
   end
 
+  method_option :daemonize, :type => :boolean, :default => false, :desc => 'Watch in background'
+  method_option :notify, :type => :boolean, :default => true, :desc => 'Notify on adding/updating/removing files'
+  method_option :debug, :type => :boolean, :default => false, :desc => 'Set debugging flags'
   desc 'watch [DIRECTORY [DIRECTORY ...]]', 'Index all of EPUB files in DIRECTORY'
   def watch(*directories)
     directories = config[:directories] if directories.empty?
-    Watch.new(config[:db_dir], directories).run
+    Watch.new(config[:dir], directories).run(notify_on_change: options[:notify], daemonize: options[:daemonize], debug: options[:debug])
   end
 
   desc 'remove FILE', 'Remove FILE from database'
   def remove(file)
-    Remove.new(config[:db_dir], file).run
+    Remove.new(config[:dir], file).run
   end
 
   desc 'server', 'Run server'
   def server
-    Server.new(config[:db_dir]).run
+    Server.new(config[:dir]).run
   end
 
-  method_option :path, :typ => :boolean, :aliases => '-p', :default => false, :desc => 'Swho book paths'
+  method_option :path, :type => :boolean, :aliases => '-p', :default => false, :desc => 'Swho book paths'
   desc 'list', 'Show list of book titles in database'
   def list
-    List.new(config[:db_dir]).run(options[:path])
+    List.new(config[:dir]).run(options[:path])
   end
 
   private

data/epub-search.gemspec

@@ -10,8 +10,9 @@ Gem::Specification.new do |gem|
   gem.email         = ["KitaitiMakoto@gmail.com"]
   gem.description   = %q{Provides tool and library of full text search for EPUB books}
   gem.summary       = %q{Full text search for EPUB books}
-  # gem.homepage      = ""
+  gem.homepage      = "https://github.com/KitaitiMakoto/epub-search"
 
+  gem.required_ruby_version = '>= 2.0.0'
   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)/})
@@ -24,7 +25,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rb-inotify'
   gem.add_runtime_dependency 'listen'
   gem.add_runtime_dependency 'highline'
-  gem.add_runtime_dependency 'notify'
+  gem.add_runtime_dependency 'notify', '0.5.0'
   gem.add_runtime_dependency 'rack'
   gem.add_runtime_dependency 'tilt'
 

data/lib/epub/search.rb

@@ -4,12 +4,15 @@ require 'epub/parser'
 require 'groonga'
 require 'listen'
 require 'highline'
+require 'epub/search/database'
+require 'epub/search/formatter'
+require 'epub/search/server'
 
 module EPUB
   module Search
     DEFAULT_CONFIG = {
       :config_path => File.join(Dir.home, '.epub-search/config.yaml'),
-      :db_dir      => File.join(Dir.home, '.epub-search/db')
+      :dir         => File.join(Dir.home, '.epub-search')
     }
 
     class << self
@@ -23,7 +26,3 @@ module EPUB
     end
   end
 end
-
-require 'epub/search/database'
-require 'epub/search/formatter'
-require 'epub/search/server'

data/lib/epub/search/database.rb

@@ -1,6 +1,7 @@
 module EPUB
   module Search
     class Database
+      DIR_NAME  = 'db'
       FILE_NAME = 'epub-search.db'
 
       attr_reader :db_dir
@@ -19,7 +20,7 @@ module EPUB
       end
 
       def init(force=false)
-        @db_dir.rmtree if force
+        @db_dir.rmtree if force && @db_dir.exist?
         @db_dir.mkpath
         Groonga::Database.create :path => db_file.to_path
         Groonga::Schema.create_table 'Pages', :type => :array
@@ -32,9 +33,9 @@ module EPUB
           table.text 'content'
         end
         Groonga::Schema.create_table 'Terms',
-        :type => :patricia_trie,
-        :normalizer => :NormalizerAuto,
-        :default_tokenizer => 'TokenBigram'
+                                     :type => :patricia_trie,
+                                     :normalizer => :NormalizerAuto,
+                                     :default_tokenizer => 'TokenBigram'
         Groonga::Schema.change_table 'Terms' do |table|
           table.index 'Pages.book_title'
           table.index 'Pages.metadata'
@@ -70,11 +71,11 @@ module EPUB
       # @return [Integer] the number of removed recoreds
       def remove(file_path)
         file_path = Pathname.new(file_path) unless file_path.kind_of? Pathname
-        location = file_path.expand_path.to_path
+        location = file_path.expand_path
         record_count = 0
         open do
           records = pages.select {|record|
-            record.location == location
+            record.location == location.to_path
           }
           records.each do |record|
             record.key.delete
@@ -102,8 +103,9 @@ module EPUB
       def books(path=false)
         open do
           pages.group_by(&:location).collect {|location, records|
-            result  =records.first.book_title
+            result = records.first.book_title
             result << " - #{location}" if path
+            result
           }
         end
       end

data/lib/epub/search/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   module Search
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/helper.rb

@@ -1,3 +1,8 @@
 require 'test/unit'
 require 'test/unit/notify'
 require 'epub/search'
+require 'tmpdir'
+
+class EPUB::Search::TestCase < Test::Unit::TestCase
+  include EPUB::Search
+end

data/test/test_database.rb

@@ -1,7 +1,83 @@
 require_relative 'helper'
 
-class TestDatabase < Test::Unit::TestCase
-  def test_example
-    assert false
+class TestDatabase < EPUB::Search::TestCase
+  def setup
+    @dir = Dir.mktmpdir 'epub-search'
+    @db = Database.new(@dir)
+  end
+
+  def teardown
+    FileUtils.remove_entry_secure @dir if File.directory? @dir
+  end
+
+  def test_paths
+    assert_equal Pathname.new(@dir), @db.db_dir
+    assert_equal Pathname.new(@dir).join('epub-search.db'), @db.db_file
+  end
+
+  def test_init_make_db_paths
+    dir = File.join(@dir, 'init')
+    db = Database.new(dir)
+    db.init
+    assert_path_exist db.db_dir
+    assert_path_exist db.db_file
+  end
+
+  class TestAfterInit < TestDatabase
+    def setup
+      super
+      @db.init
+    end
+
+    def test_init_make_Pages_table
+      open_db do
+        assert_not_nil Groonga['Pages']
+      end
+    end
+
+    def test_init_make_Terms_table
+      open_db do
+        assert_not_nil Groonga['Terms']
+      end
+    end
+
+    class TestAdd < TestAfterInit
+      class TestWhenNonEpubFilePassed < TestAdd
+        def setup
+          super
+          @epub_path = __FILE__
+        end
+
+        def test_add_raise_error
+          assert_raise Zip::Error do
+            @db.add @epub_path
+          end
+        end
+      end
+
+      class TestWhenEpubFilePassed < TestAdd
+        def setup
+          super
+          @epub_path = File.join(__dir__, 'rails_guides.epub')
+        end
+
+        def test_add_insert_records_same_to_xhtml_in_epub
+          @db.add @epub_path
+          epub = EPUB::Parser.parse(@epub_path)
+          xhtmls = epub.each_content.select {|content| content.media_type == 'application/xhtml+xml'}.length
+          open_db do
+            assert_equal xhtmls, Groonga['Pages'].size
+          end
+        end
+      end
+    end
+  end
+
+  private
+
+  def open_db
+    Groonga::Database.open @db.db_file.to_path do |database|
+      yield database
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-search
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: epub-parser
@@ -98,16 +98,16 @@ dependencies:
   name: notify
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -230,6 +230,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .yardopts
+- CHANGELOG.markdown
 - Gemfile
 - LICENSE.txt
 - README.markdown
@@ -252,8 +253,9 @@ files:
 - template/index.html.erb
 - template/result.html.erb
 - test/helper.rb
+- test/rails_guides.epub
 - test/test_database.rb
-homepage: 
+homepage: https://github.com/KitaitiMakoto/epub-search
 licenses: []
 metadata: {}
 post_install_message: 
@@ -264,7 +266,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -278,5 +280,6 @@ specification_version: 4
 summary: Full text search for EPUB books
 test_files:
 - test/helper.rb
+- test/rails_guides.epub
 - test/test_database.rb
 has_rdoc: yard