fyodor 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4153e3ca5ba770ca3a10fcf7d1896aa51566521f5f4f560c2353d3fecdeee3
-  data.tar.gz: dae113570a5189571ad80efc677a28cc7a9ddc02205f0b5690f44add8838a957
+  metadata.gz: 61b605527557fc96f8fbf0d526ee26a157d6dabf4544fbb8d3519197ad0ec45f
+  data.tar.gz: be89647509157f9cab923b498f90b129c3cdb00836e3d8a3c2af5e692252f155
 SHA512:
-  metadata.gz: 8fca692ec9b1f113476c1568b7beb45895e5cb3f1b7bfdbefa3076f70b44bc1b40a7bc51b46d84bd8c87eb7d384858048e5c2c9b64a11c23ebcfce8476f9de02
-  data.tar.gz: c453cd1c2cdaa59f18305ead427843313ba400450daead5db39f16090ec092e4e7395413f3a364028b69bf9d43fc164551a306146105a631610a077ddf075fc7
+  metadata.gz: 8dfc0e521bf352f1c98ac7d7f1203f8cccbd6491a9c216754dbc2ae3072a30361e688f8fe96014719043c3abac866022d7322ae3d5cb155657f434818ac624a1
+  data.tar.gz: 23c025a3c1bbdc206fa1d4cd4bfc6bccdd2e3de2a3735da74482d14c6cd5f74ed14cc834ac0851c5609c8be3aed1637e4312de405fb696594776a0c774731784

data/README.md

@@ -14,7 +14,7 @@ To read more about the motivation and what problem it tries to solve, [check thi
 
 - Supports all the type of entries in your clippings file: highlights, notes, clips and bookmarks.
 - Automatic removal of empty or duplicate entries (the clippings file can get a lot of those).
-- Orders your entries by location on each book (the clippings file is ordered by time).
+- Orders your entries by location/page on each book (the clippings file is ordered by time).
 - Easily configurable for your language, allowing you to get all features and beautiful output.
 - This software goes some length to be locale agnostic: basic parsing should work without configuration for any language. It should also work even if your clippings file has multiple locales.
 - Bookmarks are printed together and notes are formatted differently, for better visualization.

data/lib/fyodor/entry.rb

@@ -1,23 +1,35 @@
 module Fyodor
   class Entry
-    TYPE = { note: "note",
-            highlight: "highlight",
-            bookmark: "bookmark",
-            clip: "clip" }
-
-    attr_reader :book_title, :book_author, :text, :desc, :type, :loc, :loc_start, :page, :time
-
-    def initialize(attrs)
-      @book_title = attrs[:book_title]
-      @book_author = attrs[:book_author]
-      @text = attrs[:text]
-      @desc = attrs[:desc]
-      @type = attrs[:type]
-      @loc = attrs[:loc]
-      # This is our comparable, we need it as a number.
-      @loc_start = attrs[:loc_start].to_i
-      @page = attrs[:page]
-      @time = attrs[:time]
+    TYPE = {
+      note: "note",
+      highlight: "highlight",
+      bookmark: "bookmark",
+      clip: "clip"
+    }
+
+    ATTRS = [
+      :book_title,
+      :book_author,
+      :text,
+      :desc,
+      :type,
+      :loc,
+      :loc_start,
+      :page,
+      :page_start,
+      :time
+    ]
+
+    attr_reader *ATTRS
+
+    def initialize(args)
+      ATTRS.each do |attr|
+        instance_variable_set("@#{attr}", args[attr])
+      end
+
+      # These are our comparables. Let's make sure they are numbers.
+      @loc_start = @loc_start.to_i
+      @page_start = @page_start.to_i
 
       raise ArgumentError, "Invalid Entry type" unless TYPE.value?(@type) || @type.nil?
     end
@@ -31,11 +43,13 @@ module Fyodor
     end
 
     def desc_parsed?
-      ! @type.nil? && (! @loc_start.nil? || ! @page.nil?)
+      ! @type.nil? && (@loc_start != 0 || @page_start != 0)
     end
 
     # Override this method to use a SortedSet.
     def <=>(other)
+      return @page_start <=> other.page_start if @loc_start == 0
+
       @loc_start <=> other.loc_start
     end
 

data/lib/fyodor/entry_parser.rb

@@ -9,22 +9,27 @@ module Fyodor
     end
 
     def entry
-      Entry.new({book_title: book[:title],
-                book_author: book[:author],
-                text: text,
-                desc: desc,
-                type: type,
-                loc: loc,
-                loc_start: loc_start,
-                page: page,
-                time: time})
+      Entry.new({
+        book_title: book[:title],
+        book_author: book[:author],
+        text: text,
+        desc: desc,
+        type: type,
+        loc: loc,
+        loc_start: loc_start,
+        page: page,
+        page_start: page_start,
+        time: time
+      })
     end
 
 
     private
 
     def book
-      title, author = @lines[0].scan(regex_cap(:title_author)).first
+      regex = /^(.*) \((.*)\)\r?\n$/
+
+      title, author = @lines[0].scan(regex).first
       # If book has no author, regex fails.
       title = @lines[0] if title.nil?
 
@@ -36,51 +41,51 @@ module Fyodor
     end
 
     def type
-      Entry::TYPE.values.find { |type| @lines[1] =~ regex_type(type) }
+      Entry::TYPE.values.find do |type|
+        keyword = Regexp.quote(@config[type])
+        regex = /^- #{keyword}/i
+
+        @lines[1] =~ regex
+      end
     end
 
     def loc
-      @lines[1][regex_cap(:loc), 1]
+      keyword = Regexp.quote(@config["loc"])
+      regex = /#{keyword} (\S+)/i
+
+      @lines[1][regex, 1]
     end
 
     def loc_start
-      @lines[1][regex_cap(:loc_start), 1].to_i
+      keyword = Regexp.quote(@config["loc"])
+      regex = /#{keyword} (\d+)(-\d+)?/i
+
+      @lines[1][regex, 1].to_i
     end
 
     def page
-      @lines[1][regex_cap(:page), 1]
-    end
+      keyword = Regexp.quote(@config["page"])
+      regex = /#{keyword} (\S+)/i
 
-    def time
-      @lines[1][regex_cap(:time), 1]
+      @lines[1][regex, 1]
     end
 
-    def text
-      @lines[3..-2].join.strip
+    def page_start
+      keyword = Regexp.quote(@config["page"])
+      regex = /#{keyword} (\d+)(-\d+)?/i
+
+      @lines[1][regex, 1].to_i
     end
 
-    def regex_type(type)
-      s = Regexp.quote(@config[type])
-      /^- #{s}/i
+    def time
+      keyword = Regexp.quote(@config["time"])
+      regex = /#{keyword} (.*)\r?\n$/i
+
+      @lines[1][regex, 1]
     end
 
-    def regex_cap(item)
-      case item
-      when :title_author
-        /^(.*) \((.*)\)\r?\n$/
-      when :loc
-        s = Regexp.quote(@config["loc"])
-        /#{s} (\S+)/i
-      when :loc_start
-        s = Regexp.quote(@config["loc"])
-        /#{s} (\d+)(-\d+)?/i
-      when :page
-        s = Regexp.quote(@config["page"])
-        /#{s} (\S+)/i
-      when :time
-        s = Regexp.quote(@config["time"])
-        /#{s} (.*)\r?\n$/i
-      end
+    def text
+      @lines[3..-2].join.strip
     end
 
     def format_check

data/lib/fyodor/version.rb

@@ -1,3 +1,3 @@
 module Fyodor
-  VERSION = "0.2.4".freeze
+  VERSION = "0.2.5".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fyodor
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Rafael Cavalcanti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml