fyodor 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25a6bf161f516497c5d250665582dc1f51b1ffbe324c86b84ecf37fb9f60d52
-  data.tar.gz: 87a71fe8296a92cd30f69bf472a0d9953dc6ae17b2a66f06021b7397d8110f63
+  metadata.gz: 7fa1b1e78cc0ab15159e69a7f63c51ff94d549a618059395d29401ddc16ff45c
+  data.tar.gz: 325bfb536a54858e628a81094b707f7cd3f0be83d2cf613cf6b8b8de79b33015
 SHA512:
-  metadata.gz: 0caea4ca106e2dd01470ae5bde25f7cd76f12b932d9693c1f6169b8655402073ad193ce2f5c334c7ee2183aa2e685ad9d9f9e3419deeea7cdf9a06a925266ce3
-  data.tar.gz: 6f9303828a448bb10a2d3fbec48ef7ebe03c71c1a2a3b3e5a461f32793261a23dbd5f232b77c675e9638c7c7cca6ab084c1887b24876a7a2a746f12cdebbefae
+  metadata.gz: 4e5f8277ece0aa866131788f2702a1dc137cea14d86795e2c71c74947d9c532482b2bc0a89e34d7500af69a15642a774ce3a815882f835b4ce34cd155ec96af2
+  data.tar.gz: d8a7b83be1154a5385f8870e94f8973de8f8b744ffb09122d55dae9282b074ede788fba4ca1eccb9d1263786ad478c16d6d02a6bd1466e42aab603ed4fe22d53

data/README.md

@@ -1,6 +1,6 @@
 # Fyodor
 
-Convert your Amazon Kindle highlights, notes and bookmarks into markdown files.
+Convert your Amazon Kindle highlights, notes and bookmarks into markdown (or any format).
 
 ## What is Fyodor
 
@@ -17,9 +17,9 @@ To read more about the motivation and what problem it tries to solve, [check thi
 - 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.
 - By default, output in a format that is clean and easy to edit/fiddle around: markdown.
-- Entirely customizable output, through templates, in the format you prefer.
+- Bookmarks are placed together and notes are formatted differently, for better visualization.
+- Entirely customizable output, in the format you prefer, through templates.
 
 This program is based on the clippings file generated by Kindle 2019, but should work with other models.
 
@@ -34,7 +34,7 @@ We are limited by the data Kindle makes available through `My Clippings.txt`. Th
 
 Install Ruby and run:
 
-```
+```shell-session
 $ gem install fyodor
 ```
 
@@ -42,29 +42,29 @@ $ gem install fyodor
 
 Run:
 
-```
+```shell-session
 $ gem update fyodor
 ```
 
 ## Configuration
 
-Fyodor has an optional configuration file, which is used for the following.
-
-### Languages
-
-If your Kindle is not in English, you should tell Fyodor how some things are called by your `My Clippings.txt` (e.g. highlights, pages, etc). _Fyodor should still work without configuration, but you won't take advantage of many features, resulting in a dirtier output._
+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).
 
-1. Download the sample config to `~/.config/fyodor/fyodor.toml` or `$XDG_CONFIG_HOME/fyodor/fyodor.toml`:
+To download the [sample configuration](docs/fyodor.toml.sample):
 
-```sh
+```shell-session
 $ curl https://raw.githubusercontent.com/rc2dev/fyodor/master/docs/fyodor.toml.sample --create-dirs -o ~/.config/fyodor/fyodor.toml
 ```
 
-2. Open both the configuration and your `My Clippings.txt` in your preferred editor. Change the values in the `[parser]` section to mirror what you get in `My Clippings.txt`.
+### Languages
+
+If your Kindle device is not set to English (US), you should tell Fyodor how some things are named on your `My Clippings.txt` (highlights, pages, etc). I went through some length to make Fyodor work regardless of this step. However, if you don't set this correctly, you won't take advantage of many features, resulting in a dirtier output.
+
+Open both `fyodor.toml` and your `My Clippings.txt` in your preferred editor. Change the values in the `[parser]` section to mirror what you get in `My Clippings.txt`.
 
 For example, this is the configuration for Brazilian Portuguese:
 
-```
+```toml
 [parser]
 highlight = "Seu destaque"
 note = "Sua nota"
@@ -77,35 +77,41 @@ time = "Adicionado:"
 
 ### Showing the time
 
-In the configuration file you can also set whether to print the time of each entry. On `[output]`, set `time` to `true` or `false`.
-
-### Templating
-
-You may change the structure of the files output by Fyodor by providing your own template.
+You can also set whether to print the time of each entry. Under `[output]`, set `time` to `true` or `false`:
 
-Simply 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).
+```toml
+[output]
+time = true
+```
 
 ### Extension
 
-If you want to change the extension of the output files - typically after changing the template -, set `extension` on `fyodor.toml`. For example, to change it to HTML:
+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"
 ```
 
+## Templating
+
+You may change the structure of the files output by Fyodor by providing your own template in any format you wish.
+
+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).
+
+
 ## Usage
 
-```
+```shell-session
 $ fyodor CLIPPINGS_FILE [OUTPUT_DIR]
 ```
 
 Where:
 
 - `CLIPPINGS_FILE` is the path for `My Clippings.txt`.
-- `OUTPUT_DIR` is the directory to write the markdown files. If none is supplied, this will be `fyodor_output` under the current directory.
+- `OUTPUT_DIR` is the directory to write the output files. If none is supplied, this will be `fyodor_output` under the current directory.
 
 ## PSA: HTML to markdown
 

data/lib/fyodor/book.rb

@@ -15,7 +15,7 @@ module Fyodor
 
       @title = title
       @author = author
-      @entries = SortedSet.new
+      @entries = Set.new
       @rej_dup = 0
     end
 

data/lib/fyodor/config_getter.rb

@@ -4,11 +4,9 @@ require "toml"
 
 module Fyodor
   class ConfigGetter
-    CONFIG_NAME = "fyodor.toml"
-    TEMPLATE_NAME = "template.erb"
     DEFAULT_TEMPLATE_PATH = File.dirname(__FILE__) + "/../../share/template.erb"
 
-    DEFAULTS = {
+    DEFAULT_CONFIG = {
       "parser" => {
         "highlight" => "Your Highlight",
         "note" => "Your Note",
@@ -25,60 +23,48 @@ module Fyodor
     }
 
     def config
-      @config ||= get_config
-    end
-
-
-    private
+      return @config if defined?(@config)
 
-    def get_config
       Hash.include CoreExtensions::Hash::Merging
-
-      @config_path = get_path(CONFIG_NAME)
-      print_config_path
-      user_config = @config_path.nil? ? {} : TOML.load_file(@config_path)
-
-      config = DEFAULTS.deep_merge(user_config)
+      config = DEFAULT_CONFIG.deep_merge(user_config)
       config["output"]["template"] = template
 
-      config
+      @config = config
     end
 
-    def get_path(name)
-      possible_dirs.each do |d|
-        path = d + name
-        return path if path.exist?
-      end
 
-      return nil
+    private
+
+    def config_dir
+      @config_dir ||= Pathname.new(ENV["XDG_CONFIG_HOME"] || "~/.config").expand_path + "fyodor"
     end
 
-    def possible_dirs
-      return @possible_dirs unless @possible_dirs.nil?
+    def user_config_path
+      config_dir + "fyodor.toml"
+    end
 
-      @possible_dirs = []
-      @possible_dirs << Pathname.new(ENV["XDG_CONFIG_HOME"]) + "fyodor" unless ENV["XDG_CONFIG_HOME"].nil?
-      @possible_dirs << Pathname.new("~/.config/fyodor").expand_path
+    def user_template_path
+      config_dir + "template.erb"
     end
 
-    def print_config_path
-      if @config_path.nil?
-        puts "No config found: using defaults.\n"
-      else
-        puts "Using config at #{@config_path}.\n"
+    def user_config
+      if user_config_path.exist?
+        puts "Using config at #{user_config_path}.\n"
+        return TOML.load_file(user_config_path)
       end
+
+      puts "No config found: using defaults.\n"
+      {}
     end
 
     def template
-      template_path = get_path(TEMPLATE_NAME) || DEFAULT_TEMPLATE_PATH
-
-      if template_path == DEFAULT_TEMPLATE_PATH
-        puts "No template found: using default.\n\n"
-      else
-        puts "Using template at #{template_path}.\n\n"
+      if user_template_path.exist?
+        puts "Using custom template at #{user_template_path}.\n\n"
+        return File.read(user_template_path)
       end
 
-      File.read(template_path)
+      puts "No custom template found: using default.\n\n"
+      File.read(DEFAULT_TEMPLATE_PATH)
     end
   end
 end

data/lib/fyodor/entry.rb

@@ -48,20 +48,18 @@ module Fyodor
 
     # Override this method to use a SortedSet.
     def <=>(other)
-      return @page_start <=> other.page_start if @loc_start == 0
+      return (@page_start <=> other.page_start) if @loc_start == 0
 
       @loc_start <=> other.loc_start
     end
 
     # Override the following methods for deduplication.
     def ==(other)
-      return false if @type != other.type || @text != other.text
+      return false if (@type != other.type || @text != other.text)
 
-      if desc_parsed? && other.desc_parsed?
-        @loc == other.loc && @page == other.page
-      else
-        @desc == other.desc
-      end
+      return (@loc == other.loc && @page == other.page) if desc_parsed? && other.desc_parsed?
+
+      @desc == other.desc
     end
 
     alias eql? ==

data/lib/fyodor/output_generator.rb

@@ -27,7 +27,7 @@ module Fyodor
 
     def render_entries(entries)
       output = ""
-      entries.each do |entry|
+      entries.sort.each do |entry|
         output += "- #{item_text(entry)}\n\n"
         output += "  #{item_desc(entry)}\n\n" unless item_desc(entry).empty?
       end

data/lib/fyodor/output_writer.rb

@@ -27,7 +27,7 @@ module Fyodor
 
       i = 2
       while(path.exist?)
-        path = @output_dir + "${basename - #{i}.#{extension}"
+        path = @output_dir + "#{basename} - #{i}.#{extension}"
         i += 1
       end
 

data/lib/fyodor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fyodor
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Rafael Cavalcanti
@@ -38,7 +38,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Parse Kindle clippings into markdown files
+description: Parse Kindle clippings into markdown (or any format)
 email: dev@rafaelc.org
 executables:
 - fyodor
@@ -78,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3'
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Kindle clippings parser