fyodor 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fa1b1e78cc0ab15159e69a7f63c51ff94d549a618059395d29401ddc16ff45c
-  data.tar.gz: 325bfb536a54858e628a81094b707f7cd3f0be83d2cf613cf6b8b8de79b33015
+  metadata.gz: 88047546f202ccab2251c4c6b1258cede3e051dc189543b184840c931d039b05
+  data.tar.gz: 33aa4298ddc3a369ca1e89cee791d2625447272e8bd6e28bf31ed342ec66bbf5
 SHA512:
-  metadata.gz: 4e5f8277ece0aa866131788f2702a1dc137cea14d86795e2c71c74947d9c532482b2bc0a89e34d7500af69a15642a774ce3a815882f835b4ce34cd155ec96af2
-  data.tar.gz: d8a7b83be1154a5385f8870e94f8973de8f8b744ffb09122d55dae9282b074ede788fba4ca1eccb9d1263786ad478c16d6d02a6bd1466e42aab603ed4fe22d53
+  metadata.gz: 186dd430f5299c25b33bcf1baff234525cd186592f6702980d24753f0ff3a48943c21bf0b5c5601bf8dc86d3e826d261328f50d4225fade827eef259e86fb305
+  data.tar.gz: b03ee75159f0db45a1e55912b74de25f716534d009b19495e711648d16f3336eda1afbcfa566e689c9ff4c951cc371650a39ac217e34fc9619622aaab4bbcbf2

data/README.md

@@ -6,7 +6,7 @@ Convert your Amazon Kindle highlights, notes and bookmarks into markdown (or any
 
 This application parses `My Clippings.txt` from your Kindle and generates a markdown file for each book/document, in the format `#{Author} - #{Title}.md`. This way, your annotations are conveniently stored and easily managed.
 
-[For samples of the output, click here.](docs/output_demo)
+[For samples of the output, click here.](share/docs/output_demo)
 
 To read more about the motivation and what problem it tries to solve, [check this blog post](https://rafaelc.org/posts/export-all-your-kindle-highlights-and-notes/).
 
@@ -20,6 +20,7 @@ To read more about the motivation and what problem it tries to solve, [check thi
 - By default, output in a format that is clean and easy to edit/fiddle around: markdown.
 - Bookmarks are placed together and notes are formatted differently, for better visualization.
 - Entirely customizable output, in the format you prefer, through templates.
+- Customizable file names.
 
 This program is based on the clippings file generated by Kindle 2019, but should work with other models.
 
@@ -50,10 +51,10 @@ $ gem update fyodor
 
 Fyodor reads an optional configuration file at `~/.config/fyodor/fyodor.toml` or `$XDG_CONFIG_HOME/fyodor/fyodor.toml`. This section describes the available parameters (none is required).
 
-To download the [sample configuration](docs/fyodor.toml.sample):
+To download the [default configuration](share/defaults/fyodor.toml):
 
 ```shell-session
-$ curl https://raw.githubusercontent.com/rc2dev/fyodor/master/docs/fyodor.toml.sample --create-dirs -o ~/.config/fyodor/fyodor.toml
+$ curl https://raw.githubusercontent.com/rc2dev/fyodor/master/share/defaults/fyodor.toml --create-dirs -o ~/.config/fyodor/fyodor.toml
 ```
 
 ### Languages
@@ -75,23 +76,20 @@ page = "página"
 time = "Adicionado:"
 ```
 
-### Showing the time
+### Change output file names
 
-You can also set whether to print the time of each entry. Under `[output]`, set `time` to `true` or `false`:
+By default, Fyodor writes the output files in the format `%{author_fill} - %{title}.md`. You can change that by setting `filename` under `[output]`. For example, for HTML extension and to only display the title of the book:
 
 ```toml
 [output]
-time = true
+filename = "%{title}.html"
 ```
 
-### Extension
+Available variables:
 
-If you want to change the extension of the output files (typically after changing the template), set `extension` under `[output]`. For example, to change it to HTML:
-
-```toml
-[output]
-extension = "html"
-```
+- `%{author}`: Author of the book.
+- `%{author_fill}`: Author of the book. If empty, shows "Author Not Available".
+- `%{title}`: Title of the book.
 
 ## Templating
 
@@ -99,8 +97,9 @@ You may change the structure of the files output by Fyodor by providing your own
 
 To do that, place a ERB template at `~/.config/fyodor/template.erb` or `$XDG_CONFIG_HOME/fyodor/template.erb` and Fyodor will use it automatically.
 
-The default template can be found [here](share/template.erb). You can use any method or attribute available [on this class](lib/fyodor/output_generator.rb).
+The default template can be found [here](share/defaults/template.erb). You can use any method or attribute available [on this class](lib/fyodor/output_generator.rb).
 
+If you use a format other than markdown, you'll want to change the files extension. To do this, refer to [the corresponding section](#change-output-file-names).
 
 ## Usage
 

data/bin/fyodor

@@ -35,10 +35,21 @@ module Fyodor
     end
 
     def run
-      library = Library.new
-      ClippingsParser.new(@clippings_path, @config["parser"]).parse(library)
-      StatsPrinter.new(library).print
-      OutputWriter.new(library, @output_dir, @config["output"]).write_all
+      @library = Library.new
+
+      ClippingsParser.new(@clippings_path, @config["parser"]).parse(@library)
+      StatsPrinter.new(@library).print
+      write_output
+    end
+
+    def write_output
+      return if @library.empty?
+
+      puts "\nWriting to #{@output_dir}..."
+      @output_dir.mkpath unless @output_dir.exist?
+      @library.each do |book|
+        OutputWriter.new(book, @output_dir, @config["output"]).write
+      end
     end
 
     def parse_args

data/lib/fyodor/book.rb

@@ -25,11 +25,6 @@ module Fyodor
       @rej_dup += 1 if @entries.add?(entry).nil?
     end
 
-    def basename
-      base = @author.to_s.empty? ? "Author N/A - #{@title}" : "#{@author} - #{@title}"
-      base.strip
-    end
-
     def count_types
       list = group_by(&:type).map { |k, v| [k, v.size] }
       Hash[list]

data/lib/fyodor/config_getter.rb

@@ -4,29 +4,15 @@ require "toml"
 
 module Fyodor
   class ConfigGetter
-    DEFAULT_TEMPLATE_PATH = File.dirname(__FILE__) + "/../../share/template.erb"
+    DEFAULT_CONFIG_PATH = File.dirname(__FILE__) + "/../../share/defaults/fyodor.toml"
+    DEFAULT_TEMPLATE_PATH = File.dirname(__FILE__) + "/../../share/defaults/template.erb"
 
-    DEFAULT_CONFIG = {
-      "parser" => {
-        "highlight" => "Your Highlight",
-        "note" => "Your Note",
-        "bookmark" => "Your Bookmark",
-        "clip" => "Clip This Article",
-        "loc" => "Location",
-        "page" => "page",
-        "time" => "Added on"
-      },
-      "output" => {
-        "time" => false,
-        "extension" => "md"
-      }
-    }
 
     def config
       return @config if defined?(@config)
 
       Hash.include CoreExtensions::Hash::Merging
-      config = DEFAULT_CONFIG.deep_merge(user_config)
+      config = default_config.deep_merge(user_config)
       config["output"]["template"] = template
 
       @config = config
@@ -57,6 +43,10 @@ module Fyodor
       {}
     end
 
+    def default_config
+      @default_config ||= TOML.load_file(DEFAULT_CONFIG_PATH)
+    end
+
     def template
       if user_template_path.exist?
         puts "Using custom template at #{user_template_path}.\n\n"

data/lib/fyodor/entry.rb

@@ -46,7 +46,7 @@ module Fyodor
       ! @type.nil? && (@loc_start != 0 || @page_start != 0)
     end
 
-    # Override this method to use a SortedSet.
+    # Override this method for sorting.
     def <=>(other)
       return (@page_start <=> other.page_start) if @loc_start == 0
 

data/lib/fyodor/output_generator.rb

@@ -5,68 +5,32 @@ module Fyodor
   class OutputGenerator
     include Strings
 
-    def initialize(book, config)
+    def initialize(book, config, params={})
       @book = book
       @config = config
+      @params = params
     end
 
-    def content
-      ERB.new(@config["template"], nil, '-').result(binding)
+    def output
+      ERB.new(@config["template"], trim_mode: '-').result(binding)
     end
 
 
     private
-    
+
     def regular_entries
-      @book.reject { |entry| entry.type == Entry::TYPE[:bookmark] }
+      @regular_entries ||= @book.reject { |entry| entry.type == Entry::TYPE[:bookmark] }.sort
     end
 
     def bookmarks
-      @book.select { |entry| entry.type == Entry::TYPE[:bookmark] }
-    end
-
-    def render_entries(entries)
-      output = ""
-      entries.sort.each do |entry|
-        output += "- #{item_text(entry)}\n\n"
-        output += "  #{item_desc(entry)}\n\n" unless item_desc(entry).empty?
-      end
-      output.strip
+      @bookmarks ||= @book.select { |entry| entry.type == Entry::TYPE[:bookmark] }.sort
     end
 
-    def item_text(entry)
-      case entry.type
-      when Entry::TYPE[:bookmark]
-        "#{page(entry)}"
-      when Entry::TYPE[:note]
-        "_Note:_ #{entry.text.strip}"
-      else
-        "#{entry.text.strip}"
-      end
-    end
-
-    def item_desc(entry)
-      return entry.desc unless entry.desc_parsed?
+    def place(entry)
+      raise "Description is not parsed." unless entry.desc_parsed?
 
-      case entry.type
-      when Entry::TYPE[:bookmark]
-        time(entry)
-      else
-        (type(entry) + " @ " + page(entry) + " " + time(entry)).strip
-      end
-    end
-
-    def page(entry)
       ((entry.page.nil? ? "" : "page #{entry.page}, ") +
         (entry.loc.nil? ? "" : "loc. #{entry.loc}")).delete_suffix(", ")
     end
-
-    def time(entry)
-      @config["time"] ? "[#{entry.time}]" : ""
-    end
-
-    def type(entry)
-      SINGULAR[entry.type]
-    end
   end
 end

data/lib/fyodor/output_writer.rb

@@ -1,37 +1,48 @@
 require "fyodor/output_generator"
+require "fyodor/strings"
+require "pathname"
 
 module Fyodor
   class OutputWriter
-    def initialize(library, output_dir, config)
-      @library = library
+    include Strings
+
+    def initialize(book, output_dir, config)
+      @book = book
       @output_dir = output_dir
-      @output_dir.mkdir unless @output_dir.exist?
       @config = config
     end
 
-    def write_all
-      puts "\nWriting to #{@output_dir}..." unless @library.empty?
-      @library.each do |book|
-        content = OutputGenerator.new(book, @config).content
-        File.open(path(book), "w") { |f| f.puts(content) }
-      end
+    def write
+      output = OutputGenerator.new(@book, @config).output
+      File.open(path, "w") { |f| f.puts(output) }
     end
 
 
     private
 
-    def path(book)
-      basename = book.basename.gsub(/[?*:|\/"<>]/,"_")
-      extension = @config["extension"]
-      path = @output_dir + "#{basename}.#{extension}"
+    def filename
+      return @filename if defined?(@filename)
+
+      filename = @config["filename"] % {
+        author: @book.author,
+        author_fill: @book.author.empty? ? SINGULAR[:AUTHOR_NA] : @book.author,
+        title: @book.title
+      }
+      filename = filename.gsub(/[?*:|\/"<>]/,"_")
+
+      Pathname.new(filename)
+    end
+
+    def path
+      result = @output_dir + filename
 
       i = 2
-      while(path.exist?)
-        path = @output_dir + "#{basename} - #{i}.#{extension}"
+      while(result.exist?)
+        result = @output_dir + "#{filename.basename} - #{i}#{filename.extname}"
         i += 1
       end
 
-      path
+      result
     end
   end
 end

data/lib/fyodor/strings.rb

@@ -2,16 +2,21 @@ require "fyodor/entry"
 
 module Fyodor
   module Strings
-    PLURAL = { Entry::TYPE[:highlight] => "highlights",
-               Entry::TYPE[:note] => "notes",
-               Entry::TYPE[:bookmark] => "bookmarks",
-               Entry::TYPE[:clip] => "clips",
-               nil => "unrecognized" }
+    PLURAL = {
+      Entry::TYPE[:highlight] => "highlights",
+      Entry::TYPE[:note] => "notes",
+      Entry::TYPE[:bookmark] => "bookmarks",
+      Entry::TYPE[:clip] => "clips",
+      nil => "unrecognized"
+    }
 
-    SINGULAR = { Entry::TYPE[:highlight] => "highlight",
-                 Entry::TYPE[:note] => "note",
-                 Entry::TYPE[:bookmark] => "bookmark",
-                 Entry::TYPE[:clip] => "clip",
-                 nil=> "unrecognized" }
+    SINGULAR = {
+      Entry::TYPE[:highlight] => "highlight",
+      Entry::TYPE[:note] => "note",
+      Entry::TYPE[:bookmark] => "bookmark",
+      Entry::TYPE[:clip] => "clip",
+      nil => "unrecognized",
+      :AUTHOR_NA => "Author Not Available"
+    }
   end
 end

data/lib/fyodor/version.rb

@@ -1,3 +1,3 @@
 module Fyodor
-  VERSION = "0.3.3".freeze
+  VERSION = "0.3.4".freeze
 end

data/share/defaults/fyodor.toml

@@ -0,0 +1,14 @@
+# Fyodor's default config.
+
+# Set the translations you get on your clippings file.
+[parser]
+highlight = "Your Highlight"
+note = "Your Note"
+bookmark = "Your Bookmark"
+clip = "Clip This Article"
+loc = "Location"
+page = "page"
+time = "Added on"
+
+[output]
+filename = "%{author_fill} - %{title}.md"

data/share/defaults/template.erb

@@ -0,0 +1,20 @@
+<%# Fyodor's default template. -%>
+# <%= @book.author.empty? ? SINGULAR[:AUTHOR_NA] : @book.author %> - <%= @book.title %>
+<% if regular_entries.size > 0 -%>
+
+## Highlights and notes
+<% for entry in regular_entries -%>
+
+- <%= "_Note:_ " if entry.type == Entry::TYPE[:note] %><%= entry.text %>
+
+  <%= entry.desc_parsed? ? (SINGULAR[entry.type] + " @ " + place(entry)) : entry.desc %>
+<% end -%>
+<% end -%>
+<% if bookmarks.size > 0 -%>
+
+## Bookmarks
+
+<% for bookmark in bookmarks -%>
+- <%= bookmark.desc_parsed? ? place(bookmark) : bookmark.desc %>
+<% end -%>
+<% end -%>

data/share/docs/expected_desc.md

@@ -0,0 +1,52 @@
+# Expected description syntax
+
+Fyodor tries to parse entry descriptions. This allows tasks related to a cleaner output, such as:
+
+- Ignore duplicate entries.
+- Order entries by location/page.
+- Render the description in a shorter and more elegant way.
+- Render each type of entry differently.
+
+The syntax depends on the user language and on characteristics of the book/document. In this document, I keep track of what I've found until the date and coded Fyodor to expect.
+
+## Default - English
+
+### Highlights
+
+```
+- Your Highlight on Location 2637-2637 | Added on Monday, Setember 16, 2019 9:50:16 AM
+- Your Highlight at location 311-317 | Added on Tuesday, 13 May 2020 03:05:21
+- Your Highlight on page 315 | Location 4444-4444 | Added on Monday, September 16, 2019 10:06:01 AM
+- Your Highlight on page 21-21 | Added on Monday, 12 May 2020 11:01:03
+```
+
+### Notes
+
+```
+- Your Note on Location 2435 | Added on Monday, September...
+- Your Note on page 315 | Location 4444 | Added on Monday, September 16, 2019 10:06:09 AM
+```
+
+### Bookmarks
+
+```
+- Your Bookmark on Location 2434 | Added on Monday...
+- Your Bookmark on page 315 | Location 4444 | Added on Monday...
+```
+
+### Clips
+
+```
+- Clip This Article on Location 401 | Added on Monday...
+```
+
+## Locale pt-br
+
+```
+- Seu destaque ou posição 2309-2311 | Adicionado: domingo, 15 de setembro de 2019 12:40:37
+- Seu destaque na página 70 | posição 952-953 | Adicionado: quinta-feira...
+- Sua nota ou posição 2383 | Adicionado: ...
+- Seu marcador ou posição 2637 | Adicionado: segunda-feira, 16 de setembro de 2019 11:47:02
+- Seu marcador na página 315 | posição 4445 | Adicionado: segunda-feira, 16 de setembro de 2019 11:45:54
+- Recortar este artigo na posição 401 | Adicionado: segunda-feira, 16 de setembro de 2019 11:44:35
+```

data/share/docs/input_demo/extract_pt-br.txt

@@ -0,0 +1,175 @@
+Your P2K Articles (2019-11-01) (P2K)
+- Seu destaque ou posição 77-80 | Adicionado: sábado, 2 de novembro de 2019 14:03:00
+
+So my main advice to anyone preparing to give a talk on stage is to cut out everything from your talk that’s not surprising. (Nobody has ever complained that a talk was too short.) Use this rule in all your public writing. If you already found something surprising in what you’re presenting, then remove everything else. If you haven’t found something surprising about it yet, keep looking until you do.
+==========
+On Writing Well, 30th Anniversary Edition: An Informal Guide to Writing Nonfiction (Zinsser, William)
+- Sua nota ou posição 115 | Adicionado: sábado, 2 de novembro de 2019 20:43:52
+
+This is a note.
+==========
+On Writing Well, 30th Anniversary Edition: An Informal Guide to Writing Nonfiction (Zinsser, William)
+- Seu destaque ou posição 295-297 | Adicionado: sábado, 2 de novembro de 2019 20:47:01
+
+The point is that you have to strip your writing down before you can build it back up. You must know what the essential tools are and what job they were designed to do. Extending the metaphor of carpentry, it’s first necessary to be able to saw wood neatly and to drive nails. Later you can bevel the edges or add elegant finials, if that’s your taste.
+==========
+Your P2K Articles (2019-11-02) (P2K)
+- Seu destaque ou posição 530-532 | Adicionado: sábado, 2 de novembro de 2019 21:20:24
+
+If you are going to invest time in a class, certification, or degree make sure you’ll leave with skills that employers actually want, and don’t pay tons of money for something you could get for less.
+==========
+Your P2K Articles (2019-11-02) (P2K)
+- Seu destaque ou posição 931-932 | Adicionado: sábado, 2 de novembro de 2019 21:22:48
+
+Traits like speed, ambition, independence, bravery, and humor — they’re all relative. Back home I’m considered quiet. Here I’m considered loud.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 734-734 | Adicionado: sábado, 2 de novembro de 2019 21:36:32
+
+At the coding level, we often need to have the same information represented in different forms.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 740-742 | Adicionado: sábado, 2 de novembro de 2019 21:37:38
+
+Class definitions can be generated automatically from the online database schema, or from the metadata used to build the schema in the first place. The code extracts in this book are inserted by a preprocessor each time we format the text. The trick is to make the process active: this cannot be a one-time conversion, or we're back in a position of duplicating data.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 744-746 | Adicionado: sábado, 2 de novembro de 2019 21:38:56
+
+The DRY principle tells us to keep the low-level knowledge in the code, where it belongs, and reserve the comments for other, high-level explanations. Otherwise, we're duplicating knowledge,
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 749-751 | Adicionado: sábado, 2 de novembro de 2019 21:40:40
+
+The documentation and code both contain representations of the same knowledge. And we all know that in the heat of the moment, with deadlines looming and important clients clamoring, we tend to defer the updating of documentation.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 755-756 | Adicionado: sábado, 2 de novembro de 2019 21:41:44
+
+Many languages impose considerable duplication in the source.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Sua nota ou posição 756 | Adicionado: sábado, 2 de novembro de 2019 21:42:31
+
+Diz que nao ha muito o que fazer. Cita as IDEs no caso de C.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Sua nota ou posição 754 | Adicionado: sábado, 2 de novembro de 2019 21:43:12
+
+Única solução que ele menciona.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 764-765 | Adicionado: sábado, 2 de novembro de 2019 21:43:53
+
+There is absolutely no point in duplicating a function or class header comment between the two files. Use the header files to document interface issues, and the implementation files to document the nitty-gritty details that users of your code don't need to know.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 767-767 | Adicionado: sábado, 2 de novembro de 2019 21:45:16
+
+Sometimes, duplication comes about as the result of mistakes in the design.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Sua nota ou posição 767 | Adicionado: sábado, 2 de novembro de 2019 21:45:49
+
+Dá como e exemplo a falta de normalização.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 779-781 | Adicionado: sábado, 2 de novembro de 2019 21:47:07
+
+Later on in the development process, you may choose to violate the DRY principle for performance reasons. Frequently this occurs when you need to cache data to avoid repeating expensive operations. The trick is to localize the impact. The violation is not exposed to the outside world: only the methods within the class have to worry about keeping things straight.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 783-784 | Adicionado: sábado, 2 de novembro de 2019 21:50:13
+
+Where possible, always use accessor functions to read and write the attributes of objects.[1] It will make it easier to add functionality, such as caching, in the future.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Sua nota ou posição 780 | Adicionado: sábado, 2 de novembro de 2019 21:51:09
+
+Falando sobre ter start, end e lngth numa classe. Length deveria ser um atributo calculado, mas no futuro vc pode violar o dry e torna-lol um atributo como start e end por questoes de perflrmance (evitar o calculo repetido).
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 785-787 | Adicionado: sábado, 2 de novembro de 2019 21:51:51
+
+The use of accessor functions ties in with Meyer's Uniform Access principle [Mey97b], which states that "All services offered by a module should be available through a uniform notation, which does not betray whether they are implemented through storage or through computation."
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 793-793 | Adicionado: sábado, 2 de novembro de 2019 21:52:53
+
+You may well save some seconds now, but at the potential loss of hours later.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Sua nota ou posição 793 | Adicionado: sábado, 2 de novembro de 2019 21:53:25
+
+Impatient duplication
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 803-805 | Adicionado: sábado, 2 de novembro de 2019 21:54:49
+
+Commonly needed functionality or data that doesn't fall into an obvious area of responsibility can get implemented many times over. We feel that the best way to deal with this is to encourage active and frequent communication between developers. Set up forums to discuss common problems.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 807-809 | Adicionado: sábado, 2 de novembro de 2019 21:55:57
+
+Appoint a team member as the project librarian, whose job is to facilitate the exchange of knowledge. Have a central place in the source tree where utility routines and scripts can be deposited. And make a point of reading other people's source code and documentation, either informally or during code reviews.
+==========
+The Pragmatic Programmer: From Journeyman to Master (Andrew Hunt;David Thomas)
+- Seu destaque ou posição 812-813 | Adicionado: sábado, 2 de novembro de 2019 21:56:23
+
+What you're trying to do is foster an environment where it's easier to find and reuse existing stuff than to write it yourself. If it isn't easy, people won't do it.
+==========
+Crime and Punishment (AmazonClassics Edition) (Dostoyevsky, Fyodor)
+- Seu destaque na página 467 | posição 6607-6609 | Adicionado: domingo, 3 de novembro de 2019 18:43:35
+
+Sonia, timid by nature, had felt before that day that she could be ill-treated more easily than anyone, and that she could be wronged with impunity. Yet till that moment she had fancied that she might escape misfortune by care, gentleness and submissiveness before everyone.
+==========
+O Processo (Franz Kafka)
+- Seu marcador ou posição 604 | Adicionado: segunda-feira, 11 de novembro de 2019 04:49:31
+
+
+==========
+Your P2K Articles (2019-11-10) (P2K)
+- Seu destaque ou posição 67-67 | Adicionado: segunda-feira, 11 de novembro de 2019 18:58:31
+
+Vamos a ser muy dueños de nuestro silencio y no esclavos de nuestras palabras.
+==========
+Your P2K Articles (2019-11-10) (P2K)
+- Seu destaque ou posição 685-686 | Adicionado: segunda-feira, 11 de novembro de 2019 19:02:47
+
+Though Protestant work ethic-driven Americans have tended to worry about the devil holding sway in idle time, it turns out idle time is crucial for creativity, innovation and breakthrough thinking.
+==========
+Your P2K Articles (2019-11-10) (P2K)
+- Seu destaque ou posição 689-691 | Adicionado: segunda-feira, 11 de novembro de 2019 19:03:31
+
+The default mode network is like a series of airport hubs in different and typically unconnected parts of the brain. And that's why it's so crucial. When the brain flips into idle mode, this network subconsciously puts together stray thoughts, makes seemingly random connections and enables us to see an old problem in an entirely new light.
+==========
+Your P2K Articles (2019-11-10) (P2K)
+- Seu destaque ou posição 697-698 | Adicionado: segunda-feira, 11 de novembro de 2019 19:04:17
+
+"To be most creative, you need this oscillation between deep study with focused attention and daydreaming, which is why you may have your great ideas when you're in the shower," Smart told me.
+==========
+Your P2K Articles (2019-11-10) (P2K)
+- Seu destaque ou posição 699-700 | Adicionado: segunda-feira, 11 de novembro de 2019 19:04:38
+
+Smart himself typically takes long, leisurely walks during the workday and carries a notebook with him to capture any interesting thoughts or ideas that his default mode network may burble to the surface.
+==========
+Your P2K Articles (2019-11-10) (P2K)
+- Seu destaque ou posição 517-520 | Adicionado: segunda-feira, 11 de novembro de 2019 19:59:50
+
+For those of you quick to point out that not making a decision is basically the same as not inviting the person (as they don’t get invited either way) that is true factually but not psychologically. Unmade decisions can be sources of distraction and stress and the more of them hover over us, they more we are burdening ourselves unnecessarily.
+==========
+Book without author
+- Seu destaque ou posição 527-529 | Adicionado: segunda-feira, 11 de novembro de 2019 20:01:05
+
+When dealing with non-urgent decisions, either impose an artificial deadline for making the decision or if you feel unready to do so, decide to defer the decision to a later (specific) date when you will revisit the issue (so it doesn’t hover over you as an outstanding task).
+==========
+Book without author
+- Seu marcador ou posição 604 | Adicionado: segunda-feira, 11 de novembro de 2019 04:49:31
+
+
+==========
+Book without author
+- Seu marcador ou posição 535 | Adicionado: segunda-feira, 11 de novembro de 2019 20:03:05
+
+
+==========

data/share/docs/input_demo/multiline_notes.txt

@@ -0,0 +1,14 @@
+Harry Potter e il Prigioniero di Azkaban (Rowling, J.K.)
+- Your Note at location 5170 | Added on Wednesday, 13 May 2020 20:55:46
+
+This
+is
+a
+test
+note
+==========
+Harry Potter e il Prigioniero di Azkaban (Rowling, J.K.)
+- Your Highlight at location 5170-5170 | Added on Wednesday, 13 May 2020 20:55:46
+
+all’espressione
+==========

data/share/docs/input_demo/page_only_and_lowercase.txt

@@ -0,0 +1,25 @@
+Kindle Paperwhite User’s Guide, 7th Edition (Amazon)
+- Your Highlight at location 525-528 | Added on Monday, 11 May 2020 01:09:56
+
+To highlight over to the next page, drag your finger to the bottom-right corner of the screen and the page will turn. You can highlight across multiple pages by continuing to drag your finger to the bottom-right corner of the screen. To highlight to the previous page, drag your finger to the top-left corner of the screen and the page will turn. You can highlight across multiple pages by continuing to drag your finger to the top-left corner of the screen.
+==========
+Rutherford 1996 - Of Birds and Gifts  
+- Your Highlight on page 13-13 | Added on Monday, 11 May 2020 15:08:37
+
+interiorized form of repression" that New Order's hold on its Javanese subjects. A logic borne of tions and complicities incites an obsessional devotion to the idea of Javanese culture-a decidedly modern obsession shared by ers, researchers, and foreign guests (
+==========
+Brubaker 2004 - Ethnicity without groups  
+- Your Highlight on page 75-75 | Added on Tuesday, 12 May 2020 01:12:02
+
+Even when census categories are initially remote from prevailing self-understandings, they may be taken up by cultural and political entrepreneurs and eventually reshape lines of identification (Starr 1987; Nagel 1995; Petersen 1987, 1997). Especially when they are linked through public policy to tangible benefits, official census categories can have the effect of "making up people" (Hacking 1986), or "nominating into existence" (Goldberg 1997: 29-30) new kinds of persons for individuals to be. Such categories, Goldberg argues from a Foucauldian perspective, are central to the state's exercise of "racial governmentality": censuses have comprised a "formative governmental technology in the service of the state to fashion racialized knowledgeto articulate categories, to gather data, and to put them to work" (Goldberg 1997: 30)
+==========
+Dangerous Visions (S.F. MASTERWORKS) (Ellison, Harlan)
+- Your Highlight on page 27 | location 1097-1099 | Added on Tuesday, 12 May 2020 20:35:14
+
+Or even if they weren’t animals, exactly. When he found out how many reservations were coming in over the teletype he realized that some people did in fact care. However, Mr. Mandala didn’t take much interest in things like that.
+==========
+The Early Works of F. Scott Fitzgerald (With Active Table of Contents) (Fitzgerald, F. Scott)
+- Your Highlight at location 77-80 | Added on Tuesday, 12 May 2020 20:43:37
+
+But Beatrice Blaine! There was a woman! Early pictures taken on her father’s estate at Lake Geneva, Wisconsin, or in Rome at the Sacred Heart Convent—an educational extravagance that in her youth was only for the daughters of the exceptionally wealthy—showed the exquisite delicacy of her features, the consummate art and simplicity of her clothes.
+==========

data/share/docs/output_demo/Alan Harris, Konstantin Haase - Sinatra Up and Running.md

@@ -0,0 +1,24 @@
+# Alan Harris, Konstantin Haase - Sinatra: Up and Running
+
+## Highlights and notes
+
+- At a high-level, a domain-specific language is one that is dedicated to solving a particular type of problem. For example, SQL (structured query language) is designed to facilitate interaction with relational database systems. By contrast, a general-purpose language such as Ruby can be used to write code in many different domains.
+
+  highlight @ page 8, loc. 111-113
+
+- Sinatra is not a framework; you’ll find no built-in ORM (object-relational mapper) tools, no pre-fab configuration files...you won’t even get a project folder unless you create one yourself.
+
+  highlight @ page 9, loc. 130-131
+
+- Sinatra does not force you to adhere to the model-view-controller pattern, or any other pattern for that matter. It is a lightweight wrapper around Rack middleware
+
+  highlight @ page 9, loc. 135-136
+
+- Who’s Using It? GitHub, Heroku, BBC, thoughtbot, Songbird, Engine Yard, and many others are active users of Sinatra in production environments.
+
+  highlight @ page 10, loc. 144-146
+
+## Bookmarks
+
+- page 84, loc. 1150
+- page 315, loc. 4445

data/share/docs/output_demo/Sandi Metz - Practical Object-Oriented Design in Ruby.md

@@ -0,0 +1,28 @@
+# Sandi Metz - Practical Object-Oriented Design in Ruby: An Agile Primer
+
+## Highlights and notes
+
+- One of the core truisms of software development is that as your code grows and requirements for the system that you are building change, additional logic will be added that is not yet present in the current system. In almost all cases, maintainability over the life of the code is more important than optimizing its present state.
+
+  highlight @ loc. 271-274
+
+- The promise of using object-oriented (OO) design is that your code will be easier to maintain and evolve than otherwise.
+
+  highlight @ loc. 274-275
+
+- This book uses Ruby to teach OOD but you do not need to know Ruby to understand the concepts herein.
+
+  highlight @ loc. 316-316
+
+- every concept in this book can be directly translated to a statically typed OO language.
+
+  highlight @ loc. 319-320
+
+- _Note:_ This is a note.
+
+  note @ loc. 1827
+
+## Bookmarks
+
+- loc. 1150
+- loc. 4445

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fyodor
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Rafael Cavalcanti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml
@@ -61,7 +61,14 @@ files:
 - lib/fyodor/stats_printer.rb
 - lib/fyodor/strings.rb
 - lib/fyodor/version.rb
-- share/template.erb
+- share/defaults/fyodor.toml
+- share/defaults/template.erb
+- share/docs/expected_desc.md
+- share/docs/input_demo/extract_pt-br.txt
+- share/docs/input_demo/multiline_notes.txt
+- share/docs/input_demo/page_only_and_lowercase.txt
+- share/docs/output_demo/Alan Harris, Konstantin Haase - Sinatra Up and Running.md
+- share/docs/output_demo/Sandi Metz - Practical Object-Oriented Design in Ruby.md
 homepage: https://rafaelc.org/fyodor
 licenses:
 - GPL-3.0-only
@@ -75,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
   - - "<"
     - !ruby/object:Gem::Version
       version: '4'

data/share/template.erb

@@ -1,16 +0,0 @@
-<%# Fyodor's default template. -%>
-# <%= @book.basename %>
-
-## Highlights and notes
-
-<% if regular_entries.size > 0 -%>
-<%= render_entries(regular_entries) %>
-<% else -%>
-None.
-<% end -%>
-
-<% if bookmarks.size > 0 -%>
-## Bookmarks
-
-<%= render_entries(bookmarks) %>
-<% end -%>