fyodor 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 928a21f90c52229824428fa62a99e0ccd1b3319c954aa9f89696833933920315
-  data.tar.gz: ceedbb0b474de8f63f72fb4388f1e4eaf2a540644a61e26ed5a7616c0def2dbc
+  metadata.gz: eeecee4acc8d86b2d4e21dc8071d5c1fa29ef5c7a7873f1c8c9cf0a693f2a9fb
+  data.tar.gz: ebd27239fbb6da6fb2fc601ed4138212ded181f135c42c99a4aff45046dcc802
 SHA512:
-  metadata.gz: 44a7b6488f71988cdbfdb0b35083ae3e156e66899eee560188fc11da7127ff190edc60e8d9f22b3fab97cc96462efdc7732dbf905ce22b6cf87af14f5b41e61e
-  data.tar.gz: 53e882dd8ea580dd5657d088b064a00b45f86b145b8fbf403c0c84bbd9de5d7549933345b8291a7a2bc73260d5a3a5e98f711fd7b235953a2f554f394022f89d
+  metadata.gz: 41bd104a94086a9d42d99b85b99b17105013b38f2fa15f8623af86e64f7b648503748770edbec5d22681700b48f56b577c73c555a2b845f59f0d4b5d0b4590db
+  data.tar.gz: 06575a116669bbd2f1758ef772a5fbb091bfb22381f7cc44315c2f9973a7384174434c8a82443f1dc0ddef934a5f5fc2f49f53cb2caf5f9033897c0449843695

data/README.md

@@ -18,7 +18,8 @@ To read more about the motivation and what problem it tries to solve, [check thi
 - 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.
-- Output in a format that is clean and easy to edit/fiddle around: markdown.
+- 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.
 
 This program is based on the clippings file generated by Kindle 2019, but should work with other models.
 
@@ -80,16 +81,15 @@ In the configuration file you can also set whether to print the time of each ent
 
 ### Templating
 
-If you want to change the structure of the files output by Fyodor, you can use custom templates.
+You may change the structure of the files output by Fyodor by providing your own template.
 
-It should be a ERB template and placed at `~/.config/fyodor/template.erb` or `$XDG_CONFIG_HOME/fyodor/template.erb`. Fyodor will find and use it automatically.
-
-You can find a sample close to the default [here](docs/template.erb.sample). You can use any method or attribute available [at this class](lib/fyodor/output_generator.rb).
+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).
 
 ### 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` on `fyodor.toml`. For example, to change it to HTML:
 
 ```toml
 [output]

data/lib/fyodor/config_getter.rb

@@ -6,6 +6,7 @@ module Fyodor
   class ConfigGetter
     CONFIG_NAME = "fyodor.toml"
     TEMPLATE_NAME = "template.erb"
+    DEFAULT_TEMPLATE_PATH = File.dirname(__FILE__) + "/../../share/template.erb"
 
     DEFAULTS = {
       "parser" => {
@@ -38,9 +39,7 @@ module Fyodor
       user_config = @config_path.nil? ? {} : TOML.load_file(@config_path)
 
       config = DEFAULTS.deep_merge(user_config)
-      @template_path = get_path(TEMPLATE_NAME)
-      config["output"]["template_path"] = @template_path
-      print_template_path
+      config["output"]["template"] = template
 
       config
     end
@@ -70,12 +69,16 @@ module Fyodor
       end
     end
 
-    def print_template_path
-      if @template_path.nil?
+    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"
+        puts "Using template at #{template_path}.\n\n"
       end
+
+      File.read(template_path)
     end
   end
 end

data/lib/fyodor/output_generator.rb

@@ -5,39 +5,18 @@ module Fyodor
   class OutputGenerator
     include Strings
 
-    # The use of <% - 1 %> is a workaround for trimming indentation before <%=.
-    DEFAULT_TEMPLATE = %q{<% -%>
-      <%- 1 %><%= "# #{@book.basename}" %>
-      <% if regular_entries.size > 0 %>
-        <%- 1 %><%= "## Highlights and notes" %>
-
-        <%- 1 %><%= render_entries(regular_entries) %>
-      <% end -%>
-      <% if bookmarks.size > 0 %>
-        <%- 1 %><%= "## Bookmarks" %>
-
-        <%- 1 %><%= render_entries(bookmarks) %>
-      <% end -%>
-    }
-
     def initialize(book, config)
       @book = book
       @config = config
     end
 
     def content
-      ERB.new(template, nil, '-').result(binding)
+      ERB.new(@config["template"], nil, '-').result(binding)
     end
 
 
     private
-
-    def template
-      return DEFAULT_TEMPLATE if @config["template_path"].to_s.empty?
-
-      File.read(@config["template_path"])
-    end
-
+    
     def regular_entries
       @book.reject { |entry| entry.type == Entry::TYPE[:bookmark] }
     end
@@ -50,9 +29,9 @@ module Fyodor
       output = ""
       entries.each do |entry|
         output += "- #{item_text(entry)}\n\n"
-        output += "  #{item_desc(entry)}\n\n"
+        output += "  #{item_desc(entry)}\n\n" unless item_desc(entry).empty?
       end
-      output
+      output.strip
     end
 
     def item_text(entry)

data/lib/fyodor/version.rb

@@ -1,3 +1,3 @@
 module Fyodor
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

metadata

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