jekyll-scholar 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0faa17cc46745d1aafa8b2ca82cc1fc0be124d3be611dac7d4207c09c5ce73f
-  data.tar.gz: 4b0b994ca1afa03a67d1653191ba8cf3817192da4a63b7197539ea09753e4c26
+  metadata.gz: 851a94e35cec0f98f3242345376008c32ce4d842733291176b0c1aec9839b9a5
+  data.tar.gz: 790bdcb509be73f07ad33cf05af48e7d5a66aaeba25910f5d2fbbd09d9066bff
 SHA512:
-  metadata.gz: fda84705218915ae8e12095dc9f4f01459627ab4025100a59f46ff2e6057698472e87321ecfaf38b18a03873e54af9b95cabc0efa5df18eac9f0f69d80936380
-  data.tar.gz: 959a16838a7be73d8b78764f5894578e702ed405825abaa5179e1553a0d77d01380856c2de206c3318540238965a7712a8f731f9cfc58796fef02e01673c3ec5
+  metadata.gz: 7e186f78e25cab5dedf1e9dcba3a455b7bdb6701077517e0770f007972d6ab22d6850c44e205c6f761ce32cfa2e68463494c53b3b617592517afdde8234117f5
+  data.tar.gz: 20b8a68f6fa78640dd3bcf4cedc5a730f4c93deefa2432445895cd4c88495c248007c4806a66696d9bfe6d8295583783f28ade1b5ddd5cc558ec93a8ba3f1f1d

data/features/details.feature

@@ -216,7 +216,7 @@ Feature: Details
       @book{b,
         title     = {The Ruby Programming Language},
         author    = {Flanagan, David and Matsumoto, Yukihiro},
-        year      = {2008},
+        year      = {2018},
         publisher = {O'Reilly Media}
       }
       """
@@ -355,7 +355,7 @@ Feature: Details
       @book{ruby,
         title     = {The Ruby Programming Language},
         author    = {Flanagan, David and Matsumoto, Yukihiro},
-        year      = {2008},
+        year      = {2018},
         publisher = {O'Reilly Media}
       }
       """
@@ -381,9 +381,9 @@ Feature: Details
     Then the _site directory should exist
     And the "_site/scholar/index.html" file should exist
     And I should see "<a[^>]+href=\"/bibliography/2008/10.0000/1111/\">" in "_site/scholar/index.html"
-    And I should see "<a[^>]+href=\"/bibliography/2008/ruby/\">" in "_site/scholar/index.html"
+    And I should see "<a[^>]+href=\"/bibliography/2018/ruby/\">" in "_site/scholar/index.html"
     And the "_site/bibliography/2008/10.0000/1111/index.html" file should exist
-    And the "_site/bibliography/2008/ruby/index.html" file should exist
+    And the "_site/bibliography/2018/ruby/index.html" file should exist
 
   @generators @parse_months
   Scenario: Months are parsed by default

data/features/grouping.feature

@@ -285,7 +285,7 @@ Feature: Grouping BibTeX Bibliographies
       @book{ruby2,
         title     = {The Ruby Programming Language},
         author    = {Flanagan, David and Matsumoto, Yukihiro},
-        year      = {2008},
+        year      = {2018},
         month     = dec
       }
       """

data/features/removeduplicate.feature

@@ -0,0 +1,131 @@
+Feature: BibTeX
+  As a scholar who likes to blog
+  I want to publish my BibTeX bibliography on my blog
+  In order to share my awesome references with my peers
+
+  @tags @bibliography
+   Scenario: Duplicates should not be removed by default
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+      | bibliography_list_tag | ol |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+
+      @book{ruby,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+        }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography_count -f references %}
+
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "3" in "_site/scholar.html"
+
+  @tags @bibliography
+   Scenario: Duplicates should be removed
+    Given I have a scholar configuration with:
+      | key                   | value           |
+      | source                | ./_bibliography |
+      | remove_duplicates     | true            |
+      | bibliography_list_tag | ol              |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+
+      @book{ruby,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+        }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography_count -f references --remove_duplicates %}
+
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "2" in "_site/scholar.html"
+
+  @tags @bibliography
+   Scenario: Remove duplicates by year
+    Given I have a scholar configuration with:
+      | key                   | value           |
+      | source                | ./_bibliography |
+      | remove_duplicates     | true            |
+      | bibliography_list_tag | ol              |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {1996},
+        publisher = {O'Reilly Media}
+      }
+
+      @book{ruby,
+        title     = {The Ruby Programming Language},
+        author    = {Flanagan, David and Matsumoto, Yukihiro},
+        year      = {2008},
+        publisher = {O'Reilly Media}
+      }
+
+      @book{ruby,
+        title     = {Smalltalk Best Practice Patterns},
+        author    = {Kent Beck},
+        year      = {1996},
+        publisher = {Prentice Hall}
+        }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography_count -f references -r year %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "2" in "_site/scholar.html"

data/lib/jekyll/scholar/defaults.rb

@@ -42,6 +42,8 @@ module Jekyll
 
       'replace_strings'        => true,
       'join_strings'           => true,
+      # Remove duplicate entries from bibliography
+      'remove_duplicates'      => false,
 
       'details_dir'            => 'bibliography',
       'details_layout'         => 'bibtex.html',

data/lib/jekyll/scholar/utilities.rb

@@ -32,6 +32,7 @@ module Jekyll
         return if arguments.nil? || arguments.empty?
 
         parser = OptionParser.new do |opts|
+
          opts.on('-c', '--cited') do |cited|
             @cited = true
           end
@@ -40,6 +41,11 @@ module Jekyll
             @cited, @skip_sort = true, true
           end
 
+          opts.on('-r', '--remove_duplicates [MATCH_FIELDS]') do |match_field|
+            @remove_duplicates = true
+            @match_fields = match_field.split(/,\s+/) if not match_field.nil? 
+          end
+
           opts.on('-A', '--suppress_author') do |cited|
             @suppress_author = true
           end
@@ -102,7 +108,7 @@ module Jekyll
           end
         end
 
-        argv = arguments.split(/(\B-[cCfhqptTsgGOlLomA]|\B--(?:cited(_in_order)?|bibliography_list_tag|file|query|prefix|text|style|group_(?:by|order)|type_order|template|locator|label|offset|max|suppress_author|))/)
+        argv = arguments.split(/(\B-[cCfhqptTsgGOlLomAr]|\B--(?:cited(_in_order)?|bibliography_list_tag|file|query|prefix|text|style|group_(?:by|order)|type_order|template|locator|label|offset|max|suppress_author|remove_duplicates|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -120,6 +126,10 @@ module Jekyll
       end
 
 
+      def match_fields
+        @match_fields ||= []
+      end 
+
       def locators
         @locators ||= []
       end
@@ -173,6 +183,9 @@ module Jekyll
           @bibliography.join if join_strings? && replace_strings?
         end
 
+        # Remove duplicate entries
+        @bibliography.uniq!(*match_fields) if remove_duplicates?
+
         @bibliography
       end
 
@@ -352,6 +365,10 @@ module Jekyll
         @month_names = config['month_names'].nil? ? Date::MONTHNAMES : config['month_names'].unshift(nil)
       end
 
+      def remove_duplicates?
+        @remove_duplicates || config['remove_duplicates']
+      end 
+
       def suppress_author?
         !!@suppress_author
       end

data/lib/jekyll/scholar/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   class Scholar
-    VERSION = '6.1.0'.freeze
+    VERSION = '6.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2019-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -104,6 +104,7 @@ files:
 - features/layout.feature
 - features/multiple_files.feature
 - features/reference.feature
+- features/removeduplicate.feature
 - features/repository.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb
@@ -171,6 +172,7 @@ test_files:
 - features/layout.feature
 - features/multiple_files.feature
 - features/reference.feature
+- features/removeduplicate.feature
 - features/repository.feature
 - features/sorting.feature
 - features/step_definitions/jekyll_steps.rb