fyodor 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5de951472982ff3ff9ffaedc5f7c408bbef81440e17d93c9dae8dde987acc31
-  data.tar.gz: 677311ac291eddb41c81f909f9eedc6e6468c9949337e92d115e9bc88497456c
+  metadata.gz: 1d4153e3ca5ba770ca3a10fcf7d1896aa51566521f5f4f560c2353d3fecdeee3
+  data.tar.gz: dae113570a5189571ad80efc677a28cc7a9ddc02205f0b5690f44add8838a957
 SHA512:
-  metadata.gz: 97ff856f056f7b4cfbb00fca5f4444cb34077b0e6b136e8745e7d2b83cb36193656b6d5d0602c2b33618387b2eedf7122b658e66a56b6093914d0b20d54e6361
-  data.tar.gz: 04e4a70680ebadd82842fafaa7394af6f7f7bcf52d3ede4dd7549a167ddd7cbed2f93a96e20fb18f2fe2933c1ff5d7fa2f5744af897c333cb3687f52aef0f5c4
+  metadata.gz: 8fca692ec9b1f113476c1568b7beb45895e5cb3f1b7bfdbefa3076f70b44bc1b40a7bc51b46d84bd8c87eb7d384858048e5c2c9b64a11c23ebcfce8476f9de02
+  data.tar.gz: c453cd1c2cdaa59f18305ead427843313ba400450daead5db39f16090ec092e4e7395413f3a364028b69bf9d43fc164551a306146105a631610a077ddf075fc7

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/page on each book (the clippings file is ordered by time).
+- Orders your entries by location 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.
@@ -30,6 +30,14 @@ Install Ruby and run:
 $ gem install fyodor
 ```
 
+## Updating
+
+Run:
+
+```
+$ gem update fyodor
+```
+
 ## Configuration
 
 Fyodor has an optional configuration file, which is used for the following features.

data/lib/fyodor/md_generator.rb

@@ -52,25 +52,24 @@ module Fyodor
       output = "---\n\n"
       output += "## #{title}\n\n" unless title.nil?
       entries.each do |entry|
-        output += "#{entry_text(entry)}\n\n"
-        output += "<p style=\"text-align: right;\"><sup>#{entry_desc(entry)}</sup></p>\n\n"
+        output += "#{item_text(entry)}\n\n"
+        output += "<p style=\"text-align: right;\"><sup>#{item_desc(entry)}</sup></p>\n\n"
       end
       output
     end
 
-    def entry_text(entry)
+    def item_text(entry)
       case entry.type
       when Entry::TYPE[:bookmark]
         "* #{page(entry)}"
       when Entry::TYPE[:note]
-        # Markdown doesn't like multiline italics.
-        "* <i>#{text(entry)}</i>"
+        "* _Note:_\n#{entry.text.strip}"
       else
-        "* #{text(entry)}"
+        "* #{entry.text.strip}"
       end
     end
 
-    def entry_desc(entry)
+    def item_desc(entry)
       return entry.desc unless entry.desc_parsed?
 
       case entry.type
@@ -93,10 +92,5 @@ module Fyodor
     def type(entry)
       SINGULAR[entry.type]
     end
-
-    def text(entry)
-      # Markdown needs no white space between text and formatters
-      entry.text.strip
-    end
   end
 end

data/lib/fyodor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fyodor
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Rafael Cavalcanti