jekyll-scholar 5.0.0.pre.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c900b4242f9e31499231040ddf97470e84d1c081
-  data.tar.gz: 1c8a78d9f26ab1f0dd3193c049d5ee2e27fcc848
+  metadata.gz: c1a9174d59f0edc15f40cf4b9add6ff620fdfb96
+  data.tar.gz: 67ae1aacef4d60a65bf1ed094fdb355da2a9081e
 SHA512:
-  metadata.gz: 2c68e80076e577f5c34af42297f0fa86487805c5abbd9f556a1ca0b81cdbb7f87844910458ea40404f93fc3177710448e2bcc95c305c13aa5004fb71f591e08a
-  data.tar.gz: a02ef361fc2ed975c7973d15158b60e824839235c0dd1e05567eab2138bf69c5fe31a5d2282e6d514d8c51054ee917af01a8af98d4f1825d381856a9deaf71f6
+  metadata.gz: 4c4fa55fe3ace0b47f34d079292f025967d9c8fea72fd925176286a8f7a215f8adfbf73ef46803ec8c2bfac698bde610acf977d2623c165a4c64ef3d724ff591
+  data.tar.gz: f68ca2a4f8bce0bfb77e5826a651577e2a35640662a47c0930b675621f69201fb4ba4b6e45dd62786ecf4c1e5c4874eec27d34ad42610a3111db6a7755c8e5fb

data/.travis.yml

@@ -7,7 +7,6 @@ rvm:
   - 2.2.0
   - 2.1.0
   - 2.0.0
-  - 1.9.3
   - rbx-2
 notifications:
   email:

data/README.md

@@ -13,6 +13,8 @@ For additional features you may also want to take a look at
 [![Coverage Status](https://coveralls.io/repos/inukshuk/jekyll-scholar/badge.png)](https://coveralls.io/r/inukshuk/jekyll-scholar)
 [![Dependency Status](https://gemnasium.com/inukshuk/jekyll-scholar.png)](https://gemnasium.com/inukshuk/jekyll-scholar)
 
+Already using Jekyll-Scholar and interested to help out? Please get in touch with us if you would like to become a maintainer!
+
 Installation
 ------------
 
@@ -106,7 +108,7 @@ It would be converted to `bibliography.html` with the following content:
 This makes it very easy for you to add your bibliography to your Jekyll-powered
 blog or website.
 
-If your using other converters to generate your site, don't worry, you can
+If you are using other converters to generate your site, don't worry, you can
 still generate bibliographies using the `bibliography` tag. In your site
 or blog post, simply call:
 

data/features/details.feature

@@ -182,7 +182,7 @@ Feature: Details
     Then the _site directory should exist
     And I should see "pretty" in "_config.yml"
     And the "_site/scholar/index.html" file should exist
-    And I should see "<a[^>]+href=\"/bibliography/ruby/index.html\">" in "_site/scholar/index.html"
+    And I should see "<a[^>]+href=\"/bibliography/ruby/\">" in "_site/scholar/index.html"
     And the "_site/bibliography/ruby/index.html" file should exist
 
   @generators @parse_months

data/features/filter.feature

@@ -106,6 +106,40 @@ Feature: BibTeX
     And I should not see "Programming Ruby" in "_site/scholar.html"
     And I should see "The Ruby Programming Language" in "_site/scholar.html"
 
+  @tags @offset
+  Scenario: Start listing entries with an offset
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    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{pickaxe,
+        title     = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+        author    = {Thomas, Dave and Fowler, Chad and Hunt, Andy},
+        year      = {2009},
+        edition   = 3,
+        publisher = {Pragmatic Bookshelf}
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography --offset 1 %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "Programming Ruby" in "_site/scholar.html"
+    And I should not see "The Ruby Programming Language" in "_site/scholar.html"
+
   @tags @urls
   Scenario: URLs as text
     Given I have a scholar configuration with:
@@ -140,8 +174,8 @@ Feature: BibTeX
       | key    | value             |
       | source | ./_bibliography   |
     And I have the following BibTeX filters:
-      | latex    |
       | markdown |
+      | latex    |
     And I have a "_bibliography" directory
     And I have a file "_bibliography/references.bib":
       """
@@ -164,3 +198,33 @@ Feature: BibTeX
     Then the _site directory should exist
     And the "_site/scholar.html" file should exist
     And I should see "from \[https://pragprog.com\]\(https://pragprog.com\)" in "_site/scholar.html"
+
+  @tags @urls
+  Scenario: LaTeX links as Markdown links
+    Given I have a scholar configuration with:
+      | key    | value             |
+      | source | ./_bibliography   |
+    And I have the following BibTeX filters:
+      | markdown |
+      | latex    |
+    And I have a "_bibliography" directory
+    And I have a file "_bibliography/references.bib":
+      """
+      @book{pickaxe,
+        title     = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+        author    = {Thomas, Dave and Fowler, Chad and Hunt, Andy},
+        year      = {2009},
+        edition   = 3,
+        publisher = {\href\{https://pragprog.com\}\{Pragmatic Bookshelf\}},
+      }
+      """
+    And I have a page "scholar.html":
+      """
+      ---
+      ---
+      {% bibliography %}
+      """
+    When I run jekyll
+    Then the _site directory should exist
+    And the "_site/scholar.html" file should exist
+    And I should see "\[Pragmatic Bookshelf\]\(https://pragprog.com\)" in "_site/scholar.html"

data/jekyll-scholar.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = '>= 1.3.6'
   s.rubyforge_project = s.name
 
-  s.add_runtime_dependency('jekyll', '>= 3.0.0.beta')
+  s.add_runtime_dependency('jekyll', '~> 3.0')
   s.add_runtime_dependency('citeproc-ruby', '~> 1.0')
   s.add_runtime_dependency('csl-styles', '~> 1.0')
   s.add_runtime_dependency('bibtex-ruby', '~> 4.0', '>= 4.0.13')

data/lib/jekyll/scholar/generators/details.rb

@@ -15,7 +15,7 @@ module Jekyll
         process(@name)
         read_yaml(File.join(base, '_layouts'), config['details_layout'])
 
-        data['entry'] = liquidify(entry)
+        data.merge!(reference_data(entry))
       end
 
     end

data/lib/jekyll/scholar/plugins/markdown_links.rb

@@ -1,13 +1,24 @@
-# Contriubted by @mfenner
+# Contributed by @mfenner
 # See https://github.com/inukshuk/jekyll-scholar/issues/30
 
 require 'uri'
 
+URL_PATTERN = Regexp.compile([
+  '\\\\href\\\\{([^\\\\}]+)\\\\}\\\\{([^\\\\}]+)\\\\}',
+  URI.regexp(['http', 'https', 'ftp'])
+].join('|'))
+
 module Jekyll
   class Scholar
     class Markdown < BibTeX::Filter
       def apply(value)
-        value.to_s.gsub(URI.regexp(['http','https','ftp'])) { |c| "[#{$&}](#{$&})" }
+        value.to_s.gsub(URL_PATTERN) {
+          if $1
+            "[#{$2}](#{$1})"
+          else
+            "[#{$&}](#{$&})"
+          end
+        }
       end
     end
   end

data/lib/jekyll/scholar/tags/bibliography.rb

@@ -15,6 +15,16 @@ module Jekyll
       def render(context)
         set_context_to context
 
+        # Add bibtex files to dependency tree
+        if context.registers[:page] and context.registers[:page].has_key? "path"
+          bibtex_paths.each do |bibtex_path|
+            site.regenerator.add_dependency(
+              site.in_source_dir(context.registers[:page]["path"]),
+              bibtex_path
+            )
+          end
+        end
+
         items = entries
 
         if cited_only?
@@ -32,7 +42,7 @@ module Jekyll
           cited_keys.clear
         end
 
-        items = items.take(max.to_i) if limit_entries?
+        items = items[offset..max] if limit_entries?
 
         bibliography = items.each_with_index.map { |entry, index|
           reference = bibliography_tag(entry, index + 1)

data/lib/jekyll/scholar/utilities.rb

@@ -5,7 +5,9 @@ module Jekyll
     # They should be thread safe as long as they are
     # treated as being read-only.
     STYLES = Hash.new do |h, k|
-      h[k.to_s] = CSL::Style.load k
+      style = CSL::Style.load k
+      style = style.independent_parent unless style.independent?
+      h[k.to_s] = style
     end
 
 
@@ -14,7 +16,7 @@ module Jekyll
     # #site readers
     module Utilities
 
-      attr_reader :config, :site, :context, :prefix, :text, :max
+      attr_reader :config, :site, :context, :prefix, :text, :offset, :max
 
       def split_arguments(arguments)
 
@@ -63,8 +65,12 @@ module Jekyll
             locators << locator
           end
 
+          opts.on('-o', '--offset OFFSET') do |offset|
+            @offset = offset.to_i
+          end
+
           opts.on('-m', '--max MAX') do |max|
-            @max = max
+            @max = max.to_i
           end
 
           opts.on('-s', '--style STYLE') do |style|
@@ -76,7 +82,7 @@ module Jekyll
           end
         end
 
-        argv = arguments.split(/(\B-[cCfqptTslmA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|max|suppress_author|))/)
+        argv = arguments.split(/(\B-[cCfqptTslomA]|\B--(?:cited(_in_order)?|file|query|prefix|text|style|template|locator|offset|max|suppress_author|))/)
 
         parser.parse argv.map(&:strip).reject(&:empty?)
       end
@@ -135,8 +141,16 @@ module Jekyll
         sort bibliography[query || config['query']]
       end
 
+      def offset
+        @offset ||= 0
+      end
+
+      def max
+        @max.nil? ? -1 : @max + offset - 1
+      end
+
       def limit_entries?
-        !max.nil?
+        !offset.nil? || !max.nil?
       end
 
       def sort(unsorted)
@@ -272,16 +286,22 @@ module Jekyll
       def bibliography_tag(entry, index)
         return missing_reference unless entry
 
-        liquid_template.render({
+        liquid_template.render(
+          reference_data(entry,index).merge({
+            'index' => index,
+            'details' => details_link_for(entry)
+        }))
+      end
+
+      def reference_data(entry, index = nil)
+        {
           'entry' => liquidify(entry),
           'reference' => reference_tag(entry, index),
           'key' => entry.key,
           'type' => entry.type.to_s,
           'link' => repository_link_for(entry),
-          'links' => repository_links_for(entry),
-          'index' => index,
-          'details' => details_link_for(entry)
-        })
+          'links' => repository_links_for(entry)
+        }
       end
 
       def liquidify(entry)
@@ -323,7 +343,7 @@ module Jekyll
         name.gsub!(/[:\s]+/, '_')
 
         if site.config['permalink'] == 'pretty'
-          name << '/index.html'
+          name << '/'
         else
           name << '.html'
         end

data/lib/jekyll/scholar/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-scholar
 version: !ruby/object:Gem::Version
-  version: 5.0.0.pre.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: citeproc-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: jekyll-scholar
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Jekyll extensions for the academic blogger.