citation.feature 11.9 KB
Newer Older
1 2 3 4
Feature: Citations
  As a scholar who likes to blog
  I want to reference cool papers and books from my bibliography

Sylvester Keil's avatar
Sylvester Keil committed
5
  @tags @cite
Sylvester Keil's avatar
Sylvester Keil committed
6
  Scenario: A Simple Citation
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
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "Flanagan" in "_site/scholar.html"
31

Sylvester Keil's avatar
Sylvester Keil committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
  @tags @cite @suppress-author
  Scenario: Citations With Suppressed Author
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby --suppress_author %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "2008" in "_site/scholar.html"
    And I should not see "Flanagan" in "_site/scholar.html"

Sylvester Keil's avatar
Sylvester Keil committed
60
  @tags @cite
Sylvester Keil's avatar
Sylvester Keil committed
61
  Scenario: Missing references
62
    Given I have a scholar configuration with:
Sylvester Keil's avatar
Sylvester Keil committed
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite java %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "missing reference" in "_site/scholar.html"
Sylvester Keil's avatar
Sylvester Keil committed
86 87

  @tags @quote
Sylvester Keil's avatar
Sylvester Keil committed
88
  Scenario: A Simple Block-Quote
Sylvester Keil's avatar
Sylvester Keil committed
89
    Given I have a scholar configuration with:
Sylvester Keil's avatar
Sylvester Keil committed
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% quote ruby %}
      We <3 Ruby
      {% endquote %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "<blockquote><p>We <3 Ruby</p><cite><a .*#ruby.+\(Flanagan" in "_site/scholar.html"
115 116

  @tags @cite
Sylvester Keil's avatar
Sylvester Keil committed
117
  Scenario: A prefixed citation
118
    Given I have a scholar configuration with:
Sylvester Keil's avatar
Sylvester Keil committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby --prefix a %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "#a-ruby" in "_site/scholar.html"
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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

  @tags @cite
  Scenario: Multiple Citations
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }

      @book{microscope,
        title     = {Ruby Under a Microscope},
        author    = {Pat Shaughnessy},
        year      = {2013},
        publisher = {No Starch Press}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby microscope %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "Flanagan &amp; Matsumoto, 2008; Shaughnessy, 2013" in "_site/scholar.html"

  @tags @cite @locator
  Scenario: Multiple Citations with locators
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }

      @book{microscope,
        title     = {Ruby Under a Microscope},
        author    = {Pat Shaughnessy},
        year      = {2013},
        publisher = {No Starch Press}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby microscope -l 2-3 --locator 23 & 42 %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "Matsumoto, 2008, pp. 2-3; Shaughnessy, 2013, pp. 23 &amp; 42" in "_site/scholar.html"

Sylvester Keil's avatar
Sylvester Keil committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
  @tags @cite @citation_number
  Scenario: Multiple citations using citation numbers
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
      | style        | ieee              |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }

      @book{microscope,
        title     = {Ruby Under a Microscope},
        author    = {Pat Shaughnessy},
        year      = {2013},
        publisher = {No Starch Press}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby microscope %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "\[1\], \[2\]" in "_site/scholar.html"

Sylvester Keil's avatar
Sylvester Keil committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
  @tags @cite @citation_number
  Scenario: Multiple citations of the same item using citation numbers
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
      | style        | ieee              |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% cite ruby %}
      {% cite ruby %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "\[1\]" in "_site/scholar.html"
    And I should not see "\[2\]" in "_site/scholar.html"

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 302
  @tags @cite @variables
  Scenario: A Simple Citation using liquid variables
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% assign myVariable = 'ruby' %}
      {% cite myVariable %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "Flanagan" in "_site/scholar.html"
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337

  @tags @cite @variables @data
  Scenario: A Simple Citation using liquid variables
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }
      """
    And I have a "_data" directory
    And I have a file "_data/covers.yml":
      """
      - reference: "ruby"
        image: "/img/covers/cover_01.png"
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% for cover in site.data.covers %}
        {% cite cover.reference %}
      {% endfor %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "Flanagan" in "_site/scholar.html"
338

Sylvester Keil's avatar
Sylvester Keil committed
339
  @tags @cite @variables @data
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
  Scenario: Multiple Citations in a list using liquid variables
    Given I have a scholar configuration with:
      | key          | value             |
      | source       | ./_bibliography   |
      | bibliography | my_references     |
    And I have a "_bibliography" directory
    And I have a file "_bibliography/my_references.bib":
      """
      @book{ruby,
        title     = {The Ruby Programming Language},
        author    = {Flanagan, David and Matsumoto, Yukihiro},
        year      = {2008},
        publisher = {O'Reilly Media}
      }

      @book{gof,
         Author = {Erich Gamma and Richard Helm and Ralph Johnson and John Vlissides},
         Title = {Design Patterns: Elements of Reusable Object-Oriented Software},
         Publisher = {Addison-Wesley Professional},
         Year = {1994},                   
      }
      """
    And I have a "_data" directory
    And I have a file "_data/covers.yml":
      """
      - reference: "ruby"
        image: "/img/covers/cover_01.png"
      - reference: "gof"
        image: "/img/covers/cover_02.png"
      """
    And I have a page "scholar.html":
      """
      ---
      ---
      {% for cover in site.data.covers %}
        {% cite cover.reference %}
      {% endfor %}
      """
    When I run jekyll
    Then the _site directory should exist
    And the "_site/scholar.html" file should exist
    And I should see "Flanagan" in "_site/scholar.html"
    And I should see "Gamma" in "_site/scholar.html"