sorting.feature 9.16 KB
Newer Older
Sylvester Keil's avatar
Sylvester Keil committed
1 2 3 4
Feature: Sorting BibTeX Bibliographies
  As a scholar who likes to blog
  I want to sort my bibliographies according to configurable parameters

Sylvester Keil's avatar
Sylvester Keil committed
5
  @tags @sorting
Sylvester Keil's avatar
Sylvester Keil committed
6
  Scenario: Sort By Year
Sylvester Keil's avatar
Sylvester Keil committed
7
    Given I have a scholar configuration with:
Sylvester Keil's avatar
Sylvester Keil committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
      | key     | value             |
      | sort_by | year              |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      @book{ruby2,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2007},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% bibliography -f references %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
Sylvester Keil's avatar
Sylvester Keil committed
35 36
    Then "2007" should come before "2008" in "_site/scholar.html"

37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
  @tags @sorting
  Scenario: Sort By Year With Nil Values
    Given I have a scholar configuration with:
      | key     | value             |
      | sort_by | year              |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      @book{ruby2,
        title     = {Nil}
      }
      @book{ruby3,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2007},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% bibliography -f references %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    Then "Nil" should come before "Ruby" in "_site/scholar.html"
    And "2007" should come before "2008" in "_site/scholar.html"

Sylvester Keil's avatar
Sylvester Keil committed
73
  @tags @sorting
Sylvester Keil's avatar
Sylvester Keil committed
74
  Scenario: Reverse Sort Order
Sylvester Keil's avatar
Sylvester Keil committed
75
    Given I have a scholar configuration with:
Sylvester Keil's avatar
Sylvester Keil committed
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
      | key     | value             |
      | sort_by | year              |
      | order   | descending        |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      @book{ruby2,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2007},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% bibliography -f references %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
Sylvester Keil's avatar
Sylvester Keil committed
104 105
    Then "2008" should come before "2007" in "_site/scholar.html"

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
  @tags @sorting @cited_only
  Scenario: Sort By Year Cited Only
    Given I have a scholar configuration with:
      | key     | value             |
      | sort_by | year              |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      @book{ruby2,
        title     = {Ruby Not Cited},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2007},
        publisher = {O'Reilly Media}
      }
      @book{smalltalk,
        title     = {Smalltalk Best Practice Patterns},
        author    = {Kent Beck},
        year      = {1996},
        publisher = {Prentice Hall}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby1 %}
      {% cite smalltalk %}
      {% bibliography --cited %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    Then "Smalltalk" should come before "Ruby Programming" in "_site/scholar.html"
    And I should not see "<i>Ruby Not Cited</i>" in "_site/scholar.html"

  @tags @sorting @cited_only
  Scenario: Reverse Sort Order Cited Only
    Given I have a scholar configuration with:
      | key     | value             |
      | sort_by | year              |
      | order   | descending        |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      @book{ruby2,
        title     = {Ruby Not Cited},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2007},
        publisher = {O'Reilly Media}
      }
      @book{smalltalk,
        title     = {Smalltalk Best Practice Patterns},
        author    = {Kent Beck},
        year      = {1996},
        publisher = {Prentice Hall}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby1 %}
      {% cite smalltalk %}
      {% bibliography --cited %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    Then "Ruby Programming" should come before "Smalltalk" in "_site/scholar.html"
    And I should not see "<i>Ruby Not Cited</i>" in "_site/scholar.html"

Sylvester Keil's avatar
Sylvester Keil committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
  @tags @sorting @cited_in_order
  Scenario: Sort By Year Cited in Order
    Given I have a scholar configuration with:
      | key     | value             |
      | sort_by | year              |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      @book{ruby2,
        title     = {Ruby Not Cited},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2007},
        publisher = {O'Reilly Media}
      }
      @book{smalltalk,
        title     = {Smalltalk Best Practice Patterns},
        author    = {Kent Beck},
        year      = {1996},
        publisher = {Prentice Hall}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby1 %}
      {% cite smalltalk %}
      {% bibliography --cited_in_order %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    Then "Ruby Programming" should come before "Smalltalk" in "_site/scholar.html"
    And I should not see "<i>Ruby Not Cited</i>" in "_site/scholar.html"
229

Sylvester Keil's avatar
Sylvester Keil committed
230
  @tags @sorting
231 232 233 234 235 236 237 238
  Scenario: Sort By Year And Month
    Given I have a scholar configuration with:
      | key     | value       |
      | sort_by | year, month |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
239
        title     = {December 08},
240 241 242 243
        year      = {2008},
        month     = dec
      }
      @book{ruby2,
244
        title     = {March 08},
245 246 247 248
        year      = {2008},
        month     = mar
      }
      @book{ruby3,
249
        title     = {August 07},
250 251 252 253 254 255 256 257 258 259 260 261 262
        year      = {2007},
        month     = aug
      }
      """
    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
263 264
    Then "August 07" should come before "March 08" in "_site/scholar.html"
    And "March 08" should come before "December 08" in "_site/scholar.html"
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301

  @tags @sorting
  Scenario: Multi-level Sort Order
    Given I have a scholar configuration with:
      | key     | value                 |
      | sort_by | year, month           |
      | order   | descending, ascending |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/references.bib":
      """
      @book{ruby1,
        title     = {August 07},
        year      = {2007},
        month     = aug
      }
      @book{ruby2,
        title     = {March 08},
        year      = {2008},
        month     = mar
      }
      @book{ruby3,
        title     = {December 08},
        year      = {2008},
        month     = dec
      }
      """
    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
    Then "March 08" should come before "December 08" in "_site/scholar.html"
    And "December 08" should come before "August 07" in "_site/scholar.html"