honyomi 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 685d64724a342464a595155d65a219387bfb707e
-  data.tar.gz: baa05b5545b476237f482499d90f8f2fc7334d52
+  metadata.gz: 1c366948a12642cc9db95eaeb5c113ad48c5e13c
+  data.tar.gz: aa52ce3db3f3d67defa7c0a1ac2777e4043291bc
 SHA512:
-  metadata.gz: c469791cfe13da613deafd5eeadc10f4b7855d92c1b95823e58cdd626ba69cab932e27c81bf0a63d3ef819b4328021267cdd928f61e1d307f8029ee95cf7882d
-  data.tar.gz: 4a7440312e418348b4a36e335252369d63fd4d8fe70c6e39182086a6efd0a9156c8c7daded9aa9588461b9f2029a94f12060261934a90bf540d44358c3b36631
+  metadata.gz: 556d3960472a3c09adfea1e639a85bfbbb0bfc660560441d53461df47c282141a0675d7993a8d24946a88c3604cf78b6c19b443f5f7d55cf8c3ce722fe81f362
+  data.tar.gz: 61854babf0c1ca43a19f55551f413b6278cb7957a3f82c791f7c2172b40f89b4f3bd1eadc9f11cf5e809479de3994c4b23aab2e877c17a7159412e7c432c5675

data/HISTORY.md

@@ -1,5 +1,20 @@
 # HISTORY - Honyomi
 
+## 1.5 - 2015-11-21
+
+- Display as thumbnails
+  - Bookmark
+  - Search Result
+- Manage books from the web app
+  - Remove book
+  - Add/Delete image
+- Improve honyomi commands
+  - Fix page parse bug of 'honyomi add'
+  - Add "honyomi add --no-image" option
+  - Add 'honyomi image -d' options
+  - Delete image with 'honyomi remove'
+  - Exit with 1 on error
+
 ## 1.4 - 2015-08-05
 
 - Add basic authorization

data/README.md

@@ -1,18 +1,23 @@
 # Honyomi
 
-Honyomi is ebook (pdf) search engine written by Ruby. It have command line interface and web application. It will accelerate the ebook of your life.
+![honyomi-incon](images/honyomi-icon.png)
 
-Honyomi is "本読み". "Read a book" is meaning.
+Honyomi is pdf search engine written by Ruby. It have command line interface and web application. It will accelerate the ebook of your life.
 
-[Milkode](https://github.com/ongaeshi/milkode) are brothers.
+You can [search](http://library.honyomi.nagoya/?query=global-set-key) and [browse](http://library.honyomi.nagoya/v/2) the pdf document only in the browser.
 
-![honyomi-01.png](images/honyomi-01.png)
+Honyomi is "本読み". "Read a book" is meaning. [Milkode](https://github.com/ongaeshi/milkode) are brothers.
+
+- [English](#installation)
+- [日本語](http://honyomi.nagoya/ja/)
+
+![honyomi-03.gif](images/honyomi-03.gif)
 
 ## Installation
 
-You can use the Docker container.
+You can use the Docker container. With [Kitematic](https://kitematic.com/) it is very easy! For more information and a look at the video above.
 
-- [ongaeshi/honyomi Repository | Docker Hub Registry](https://registry.hub.docker.com/u/ongaeshi/honyomi/)
+- [ongaeshi/docker-honyomi](https://github.com/ongaeshi/docker-honyomi)
 
 or
 
@@ -108,7 +113,7 @@ aaa <<bbb>> ccc
 $ honyomi web
 ```
 
-![honyomi-03.gif](images/honyomi-03.gif)
+![honyomi-01.png](images/honyomi-01.png)
 
 ### Basic authorization
 
@@ -125,5 +130,14 @@ a6a27374ec8f49426e8ee6249125369e8c529f361ffa20ace73de0b92514bb0f
 $ HONYOMI_AUTH_USERNAME=ongaeshi HONYOMI_AUTH_PASSWORD=a6a27374ec8f49426e8ee6249125369e8c529f361ffa20ace73de0b92514bb0f honyomi web
 ```
 
+## Demo
+
+- [library of honyomi](http://library.honyomi.nagoya/)
+
+## Credit
+
+- Beyond Interaction http://www.bnn.co.jp/books/3746/  CC-BY-NC-SA
+
+
 
 

data/lib/honyomi/cli.rb

@@ -3,6 +3,10 @@ require 'thor'
 
 module Honyomi
   class CLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
     class_option :help, :type => :boolean, :aliases => '-h', :desc => 'Help message'
 
     desc "init", "Create database in ENV['HONYOMI_DATABASE_DIR'] or '~/.honyomi'"
@@ -19,6 +23,7 @@ module Honyomi
     desc "add file1 [file2 ...]", "Add pdf files"
     option :title, :aliases => '-t', :type => :string,  :desc => 'Specify title'
     option :strip, :type => :boolean, :desc => 'Remove spaces'
+    option :image, :type => :boolean, :desc => "Generate image (Default true)"
     def add(*args)
       core = Core.new
       core.load_database
@@ -131,12 +136,13 @@ module Honyomi
     end
 
     desc "image book_id1 [book_id2 ...]", "Generate page images (Need pdftoppm)"
+    option :delete, :type => :boolean, :aliases => '-d', :desc => 'Delete image'
     def image(*args)
       core = Core.new
       core.load_database
 
       args.each do |id|
-        core.image(id.to_i, { verbose: true })
+        core.image(id.to_i, { verbose: true, delete: options[:delete] })
       end
     end
 

data/lib/honyomi/core.rb

@@ -14,16 +14,16 @@ module Honyomi
     def init_database
       FileUtils.mkdir_p(db_dir)
       Groonga::Database.create(path: db_path)
-      @database = Database.new
+      @database = Database.new(home_dir)
     end
 
     def load_database
       Groonga::Database.open(db_path)
-      @database = Database.new
+      @database = Database.new(home_dir)
     end
 
     def add(filename, options = {})
-      book, status = @database.add_from_pdf(filename, home_dir, options)
+      book, status = @database.add_from_pdf(filename, options)
 
       return book, status
     end
@@ -123,8 +123,29 @@ EOF
     end
 
     def image(id, options = {})
-      output_dir = @database.add_image(id, home_dir)
-      puts "Generated images to '#{output_dir}'" if options[:verbose]
+      output_dir = @database.image_dir(id)
+
+      unless options[:delete]
+        if options[:verbose]
+          unless File.exist?(output_dir)
+            puts "Generate images to '#{output_dir}'"
+          else
+            puts "Regenerate images to '#{output_dir}'"
+          end
+        end
+
+        @database.add_image(id)
+      else
+        if options[:verbose]
+          if File.exist?(output_dir)
+            puts "Delete images from '#{output_dir}'"
+          else
+            puts "Already deleted '#{output_dir}'"
+          end
+        end
+        
+        @database.delete_image(id)
+      end
     end
 
     def move(old_path, new_path)

data/lib/honyomi/database.rb

@@ -6,11 +6,14 @@ module Honyomi
   class HonyomiError < Exception ; end
 
   class Database
+    attr_reader :home_dir
     attr_reader :books
     attr_reader :pages
     attr_reader :bookmarks
 
-    def initialize
+    def initialize(home_dir)
+      @home_dir = home_dir
+      
       @books = GrnMini::Array.new("Books")
       @pages = GrnMini::Hash.new("Pages")
       @bookmarks = GrnMini::Hash.new("Bookmarks")
@@ -33,7 +36,7 @@ module Honyomi
                                )
     end
 
-    def add_from_pdf(filename, home_dir, options = {})
+    def add_from_pdf(filename, options = {})
       if File.exist?(filename)
         filename = File.expand_path(filename)
         options = options.dup
@@ -42,7 +45,8 @@ module Honyomi
         options[:timestamp] = File.stat(filename).mtime
         book, status = add_book(filename, pages, options)
 
-        add_image(book.id, home_dir) if Util.exist_command?('pdftoppm')
+        options[:image] = true if options[:image].nil? # Default true
+        add_image(book.id) if Util.exist_command?('pdftoppm') && options[:image]
 
         return book, status
       else
@@ -50,13 +54,17 @@ module Honyomi
       end
     end
 
-    def add_image(id, home_dir)
-      output_dir = File.join(home_dir, "image", id.to_s)
+    def image_dir(id)
+      File.join(home_dir, "image", id.to_s)
+    end
 
+    def add_image(id)
       pdf = Pdf.new(books[id].path)
-      pdf.generate_images(output_dir)
+      pdf.generate_images(image_dir(id))
+    end
 
-      output_dir
+    def delete_image(id)
+      FileUtils.remove_entry_secure(image_dir(id), true)
     end
 
     def add_book(path, pages, options = {})
@@ -116,6 +124,9 @@ module Honyomi
     end
 
     def delete_book(book_id)
+      # path = @books[book_id].path
+
+      # Delete book
       book = @books[book_id]
       
       @pages.delete do |page|
@@ -123,6 +134,12 @@ module Honyomi
       end
 
       book.delete
+
+      # Delete iamges
+      delete_image(book_id)
+
+      # Delete file (if ~/.honyomi/book)
+      # FileUtils.rm(path) if path.index(home_dir) == 0
     end
 
     def search(query, options = {})
@@ -151,6 +168,10 @@ module Honyomi
       @pages.select("book._id:\"#{book_id}\"").sort(["page_no"])
     end
 
+    def book_page(book, page_no)
+      @pages["#{book.id}:#{page_no}"]
+    end
+
     def book_from_path(path)
       r = @books.select("path:\"#{path}\"").first
 

data/lib/honyomi/pdf.rb

@@ -2,6 +2,8 @@
 require 'honyomi'
 require 'tmpdir'
 require 'fileutils'
+require "open3"
+require "shellwords"
 
 module Honyomi
   class Pdf
@@ -10,16 +12,28 @@ module Honyomi
     end
 
     def pages
+      result = []
+      
       Dir.mktmpdir do |dir|
         outfile = File.join(dir, "pdf.txt")
-        system("pdftotext", @filename, outfile) # Need pdftotext (poppler, xpdf)
-        @text = File.read(outfile, encoding: Encoding::UTF_8)
-        if String.method_defined? :scrub
-          @text = @text.scrub('?')
+
+        loop do
+          page_no = (result.count + 1).to_s
+
+          o, e, s = Open3.capture3("pdftotext -f #{page_no} -l #{page_no} #{Shellwords.escape(@filename)} #{Shellwords.escape(outfile)}") # Need pdftotext (poppler, xpdf)
+          break if s.exitstatus != 0
+          
+          text = File.read(outfile, encoding: Encoding::UTF_8)
+
+          if String.method_defined? :scrub
+            text = text.scrub('?')
+          end
+
+          result << text
         end
       end
 
-      @text.split("\f")
+      result
     end
 
     def generate_images(output_dir)

data/lib/honyomi/version.rb

@@ -1,3 +1,3 @@
 module Honyomi
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/honyomi/web/app.rb

@@ -26,7 +26,7 @@ configure do
     end
   end
   
-  $database = Database.new
+  $database = Database.new(Util.home_dir)
 end
 
 get '/' do
@@ -64,7 +64,7 @@ post '/upload' do
         f.write file[:tempfile].read
       end
 
-      @database.add_from_pdf(save_path, Util.home_dir)
+      @database.add_from_pdf(save_path)
     end
 
     @message = "Upload Success"
@@ -148,6 +148,12 @@ post '/command' do
                             url: params[:url],
                           })
     ""
+  when 'add-image'
+    @database.add_image(params[:id].to_i)
+  when 'delete-image'
+    @database.delete_image(params[:id].to_i)
+  when 'remove-book'
+    @database.delete_book(params[:id].to_i)
   end
 end
 
@@ -304,7 +310,7 @@ EOF
       image_path = Util.image_path(page)
 
       if File.exist? image_path
-        main_contents += %|<div><img src="/v/#{page.book.id}?image=1&page=#{page.page_no}" width="100%"/></div>|
+        main_contents += %|<div><img src="/v/#{page.book.id}?image=1&page=#{page.page_no}" width="250px"/></div>|
       end
 
       <<EOF
@@ -375,7 +381,7 @@ EOF
       content = r.map { |e| "<p>#{escape_html(e)}</p>" }.join("\n")
 
       if has_image
-        content += %|<p><img src="/v/#{page.book.id}?image=1&page=#{page.page_no}" width="100%"/></p>|
+        content += %|<p><img src="/v/#{page.book.id}?image=1&page=#{page.page_no}" width="250px"/></p>|
       end
 
       <<EOF
@@ -414,10 +420,12 @@ EOF
 
   def header_title_book(book, query)
     query = query ? "?query=#{query}" : ""
+    first_page = @database.book_page(book, 1)
+    has_image = File.exist?(Util.image_path(first_page))
 
     <<EOF
 <div class="title">
-  <a href='/#{query}'>HOME</a> &gt; <a href='/v/#{book.id}#{query}' id="book-title" honyomi-book-id="#{book.id}">#{escape_html(book.title)}</a> <span class='edit-link'>- <a href="#">Edit</a></span>
+  <a href='/#{query}'>HOME</a> &gt; <a href='/v/#{book.id}#{query}' id="book-title" honyomi-book-id="#{book.id}" honyomi-book-image="#{has_image ? "1" : "0"}">#{escape_html(book.title)}</a> <span class='edit-link'>- <a href="#">Edit</a></span>
 </div>
 <div class="etc">
   <span id="book-author">#{escape_html(book.author)}</span>

data/lib/honyomi/web/public/css/honyomi.css

@@ -23,6 +23,14 @@
     margin: 10px 0px 0px 5px;
 }
 
+.header .operation-button {
+    margin: 0px 0px 40px 0px;
+}
+
+.remove-button {
+    margin: 0px 0px 0px 15px;
+}
+
 /* content */
 .content {
     margin: 10px 0px 0px 5px;

data/lib/honyomi/web/public/js/honyomi.js

@@ -165,6 +165,44 @@ $(document).ready(function() {
     hideTitleForm();
   });
 
+  $(".operation-button .image-button").click(function (e) {
+    var id = $("#book-title").attr('honyomi-book-id');
+    var title = $("#title-form-title").val();
+    var isExist = $("#book-title").attr('honyomi-book-image') == '1';
+    var msg = !isExist ? "Generate" : "Delete";
+    var kind = !isExist ? "add-image" : "delete-image";
+
+    if (confirm(msg + " '" + title + "'" + " of page images?")) {
+      $.post(
+        '/command',
+        {
+          kind:      kind,
+          id:        id
+        }
+      );
+
+      hideTitleForm();
+    }
+  });
+
+  $(".operation-button .remove-button").click(function (e) {
+    var id = $("#book-title").attr('honyomi-book-id');
+    var title = $("#title-form-title").val();
+
+    if (confirm("Remove '" + title + "'" + "?") &&
+        confirm("Are you sure?")) {
+      $.post(
+        '/command',
+        {
+          kind:      "remove-book",
+          id:        id
+        }
+      );
+
+      document.location = "/";
+    }
+  });
+
   $(function() {
     document.addEventListener("dragover", function(e) {
       e.preventDefault();

data/lib/honyomi/web/views/index.haml

@@ -8,6 +8,14 @@
           = @header_title
 
         .title-form.hide
+          %div.operation-button
+            %span.image-button
+              %a(class="btn btn-warning" href="#" role="button")
+                Image
+            %span.remove-button
+              .pull-right
+                %a(class="btn btn-danger" href="#" role="button")
+                  Remove
           %form.form-horizontal(role="form")
             .form-group
               %label.col-sm-1.control-label(for="title-form-title")

data/test/test_core.rb

@@ -77,12 +77,12 @@ module Honyomi
         core.init_database
 
         core.add(datafile("test2.pdf"))
-        assert_equal "aaa bbb ccc", core.database.pages["1:1"].text.sub(/\n+\Z/, "")
-        assert_equal "dd ee", core.database.pages["1:2"].text.sub(/\n+\Z/, "")
+        assert_equal "aaa bbb ccc", core.database.pages["1:1"].text.sub(/\n*\f*\Z/, "")
+        assert_equal "dd ee", core.database.pages["1:2"].text.sub(/\n*\f*\Z/, "")
 
         core.add(datafile("test2.pdf"), strip: true)
-        assert_equal "aaabbbccc", core.database.pages["1:1"].text.sub(/\n+\Z/, "")
-        assert_equal "ddee", core.database.pages["1:2"].text.sub(/\n+\Z/, "")
+        assert_equal "aaabbbccc", core.database.pages["1:1"].text.sub(/\n*\f*\Z/, "")
+        assert_equal "ddee", core.database.pages["1:2"].text.sub(/\n*\f*\Z/, "")
       end
     end
 
@@ -110,7 +110,7 @@ module Honyomi
         assert_equal "ttt", core.database.books[1].title 
 
         core.edit(1, strip: true)
-        assert_equal "aaabbbccc", core.database.pages["1:1"].text.sub(/\n+\Z/, "")
+        assert_equal "aaabbbccc", core.database.pages["1:1"].text.sub(/\n*\f*\Z/, "")
 
         assert_equal datafile("test2.pdf"), core.database.books[1].path
         core.edit(1, path: datafile("test.pdf"))
@@ -170,6 +170,30 @@ module Honyomi
       end
     end
 
+    def test_image
+      Dir.mktmpdir do |dir|
+        core = Core.new({home_dir: dir})
+        core.init_database
+
+        book, _ = core.add(datafile("test.pdf"), title: "TEST PDF")
+        
+        image_dir = File.join(dir, "image", book.id.to_s)
+        assert File.exist?(File.join(image_dir, "book-1.jpg"))
+        assert File.exist?(File.join(image_dir, "book-2.jpg"))
+        assert File.exist?(File.join(image_dir, "book-3.jpg"))
+
+        core.image(book.id, {delete: true})
+        assert !File.exist?(File.join(image_dir, "book-1.jpg"))
+        assert !File.exist?(File.join(image_dir, "book-2.jpg"))
+        assert !File.exist?(File.join(image_dir, "book-3.jpg"))
+
+        core.image(book.id)
+        assert File.exist?(File.join(image_dir, "book-1.jpg"))
+        assert File.exist?(File.join(image_dir, "book-2.jpg"))
+        assert File.exist?(File.join(image_dir, "book-3.jpg"))
+      end
+    end
+
     private
 
     def datafile(path)

data/test/test_database.rb

@@ -3,13 +3,13 @@ require 'minitest_helper'
 class TestDatabase < MiniTest::Test
   def test_open
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
     end
   end
 
   def test_add_book
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
 
       db.add_book("/path/to/book1.pdf", ["1aa"], title: "Book1")
       db.add_book("/path/to/book2.pdf", ["2aa", "2bb"], title: "Book2")
@@ -45,7 +45,7 @@ class TestDatabase < MiniTest::Test
 
   def test_add_book_title_default
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
 
       db.add_book("/path/to/book1.pdf", ["1aa"])
       assert_equal "book1", db.books[1].title
@@ -54,7 +54,7 @@ class TestDatabase < MiniTest::Test
 
   def test_add_book_same_path
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
 
       db.add_book("/path/to/book1.pdf", ["1aa"], title: "Book1")
       db.add_book("/path/to/book2.pdf", ["2aa", "2bb"], title: "Book2")
@@ -70,7 +70,7 @@ class TestDatabase < MiniTest::Test
 
   def test_change_book
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
 
       db.add_book("/path/to/book1.pdf", ["1aa"], title: "Book1")
       db.add_book("/path/to/book2.pdf", ["2aa", "2bb"], title: "Book2")
@@ -92,8 +92,11 @@ class TestDatabase < MiniTest::Test
   end
 
   def test_delete_book
-    GrnMini::tmpdb do
-      db = Honyomi::Database.new
+    Dir.mktmpdir do |dir|
+      core = Honyomi::Core.new({home_dir: dir})
+      core.init_database
+
+      db = core.database
 
       db.add_book("/path/to/book1.pdf", ["1aa"], title: "Book1")
       db.add_book("/path/to/book2.pdf", ["2aa", "2bb"], title: "Book2")
@@ -108,7 +111,7 @@ class TestDatabase < MiniTest::Test
 
   def test_search
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
       db.add_book("/path/to/book1.pdf", ["1aa"])
       db.add_book("/path/to/book2.pdf", ["2aa", "2bb"])
       db.add_book("/path/to/book3.pdf", ["3aa", "3bb", "3cc"])
@@ -126,7 +129,7 @@ class TestDatabase < MiniTest::Test
 
   def test_book_pages
     GrnMini::tmpdb do
-      db = Honyomi::Database.new
+      db = Honyomi::Database.new(nil)
       db.add_book("/path/to/book1.pdf", ["1aa"])
       db.add_book("/path/to/book2.pdf", ["2aa", "2bb"])
       db.add_book("/path/to/book3.pdf", ["3aa", "3bb", "3cc"])
@@ -137,4 +140,20 @@ class TestDatabase < MiniTest::Test
       assert_equal 0, db.book_pages(4).size # Not found
     end
   end
+
+
+  def test_book_page
+    GrnMini::tmpdb do
+      db = Honyomi::Database.new(nil)
+      db.add_book("/path/to/book1.pdf", ["1aa"])
+      db.add_book("/path/to/book2.pdf", ["2aa", "2bb"])
+      db.add_book("/path/to/book3.pdf", ["3aa", "3bb", "3cc"])
+
+      book = db.books[2]
+      assert_equal 1, db.book_page(book, 1).page_no
+      assert_equal "2aa", db.book_page(book, 1).text
+      assert_equal 2, db.book_page(book, 2).page_no
+      assert_equal nil, db.book_page(book, 3)
+    end
+  end
 end

data/test/test_pdf.rb

@@ -9,9 +9,9 @@ class TestPdf < MiniTest::Test
     pdf = Honyomi::Pdf.new(test_pdf)
 
     assert_equal         3, pdf.pages.size
-    assert_equal "aaa\n\n", pdf.pages[0]
-    assert_equal "bbb\n\n", pdf.pages[1]
-    assert_equal "ccc\n\n", pdf.pages[2]
+    assert_equal "aaa\n\n\f", pdf.pages[0]
+    assert_equal "bbb\n\n\f", pdf.pages[1]
+    assert_equal "ccc\n\n\f", pdf.pages[2]
   end
 
   def test_file_name_includes_special_characters

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: honyomi
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - ongaeshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grn_mini