rpub 0.4.0 → 0.5.0

data/doc/stylesheets/styles.css

@@ -0,0 +1,255 @@
+@import url(https://fonts.googleapis.com/css?family=Lato:300italic,700italic,300,700);
+
+body {
+  padding:50px;
+  font:14px/1.5 Lato, "Helvetica Neue", Helvetica, Arial, sans-serif;
+  color:#777;
+  font-weight:300;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  color:#222;
+  margin:0 0 20px;
+}
+
+p, ul, ol, table, pre, dl {
+  margin:0 0 20px;
+}
+
+h1, h2, h3 {
+  line-height:1.1;
+}
+
+h1 {
+  font-size:28px;
+}
+
+h2 {
+  color:#393939;
+}
+
+h3, h4, h5, h6 {
+  color:#494949;
+}
+
+a {
+  color:#39c;
+  font-weight:400;
+  text-decoration:none;
+}
+
+a small {
+  font-size:11px;
+  color:#777;
+  margin-top:-0.6em;
+  display:block;
+}
+
+.wrapper {
+  width:860px;
+  margin:0 auto;
+}
+
+blockquote {
+  border-left:1px solid #e5e5e5;
+  margin:0;
+  padding:0 0 0 20px;
+  font-style:italic;
+}
+
+code, pre {
+  font-family:Monaco, Bitstream Vera Sans Mono, Lucida Console, Terminal;
+  color:#333;
+  font-size:12px;
+}
+
+pre {
+  padding:8px 15px;
+  background: #f8f8f8;  
+  border-radius:5px;
+  border:1px solid #e5e5e5;
+  overflow-x: auto;
+}
+
+table {
+  width:100%;
+  border-collapse:collapse;
+}
+
+th, td {
+  text-align:left;
+  padding:5px 10px;
+  border-bottom:1px solid #e5e5e5;
+}
+
+dt {
+  color:#444;
+  font-weight:700;
+}
+
+th {
+  color:#444;
+}
+
+img {
+  max-width:100%;
+}
+
+header {
+  width:270px;
+  float:left;
+  position:fixed;
+}
+
+header ul {
+  list-style:none;
+  height:40px;
+  
+  padding:0;
+  
+  background: #eee;
+  background: -moz-linear-gradient(top, #f8f8f8 0%, #dddddd 100%);
+  background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f8f8f8), color-stop(100%,#dddddd));
+  background: -webkit-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+  background: -o-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+  background: -ms-linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+  background: linear-gradient(top, #f8f8f8 0%,#dddddd 100%);
+  
+  border-radius:5px;
+  border:1px solid #d2d2d2;
+  box-shadow:inset #fff 0 1px 0, inset rgba(0,0,0,0.03) 0 -1px 0;
+  width:270px;
+}
+
+header li {
+  width:89px;
+  float:left;
+  border-right:1px solid #d2d2d2;
+  height:40px;
+}
+
+header ul a {
+  line-height:1;
+  font-size:11px;
+  color:#999;
+  display:block;
+  text-align:center;
+  padding-top:6px;
+  height:40px;
+}
+
+strong {
+  color:#222;
+  font-weight:700;
+}
+
+header ul li + li {
+  width:88px;
+  border-left:1px solid #fff;
+}
+
+header ul li + li + li {
+  border-right:none;
+  width:89px;
+}
+
+header ul a strong {
+  font-size:14px;
+  display:block;
+  color:#222;
+}
+
+section {
+  width:500px;
+  float:right;
+  padding-bottom:50px;
+}
+
+small {
+  font-size:11px;
+}
+
+hr {
+  border:0;
+  background:#e5e5e5;
+  height:1px;
+  margin:0 0 20px;
+}
+
+footer {
+  width:270px;
+  float:left;
+  position:fixed;
+  bottom:50px;
+}
+
+@media print, screen and (max-width: 960px) {
+  
+  div.wrapper {
+    width:auto;
+    margin:0;
+  }
+  
+  header, section, footer {
+    float:none;
+    position:static;
+    width:auto;
+  }
+  
+  header {
+    padding-right:320px;
+  }
+  
+  section {
+    border:1px solid #e5e5e5;
+    border-width:1px 0;
+    padding:20px 0;
+    margin:0 0 20px;
+  }
+  
+  header a small {
+    display:inline;
+  }
+  
+  header ul {
+    position:absolute;
+    right:50px;
+    top:52px;
+  }
+}
+
+@media print, screen and (max-width: 720px) {
+  body {
+    word-wrap:break-word;
+  }
+  
+  header {
+    padding:0;
+  }
+  
+  header ul, header p.view {
+    position:static;
+  }
+  
+  pre, code {
+    word-wrap:normal;
+  }
+}
+
+@media print, screen and (max-width: 480px) {
+  body {
+    padding:15px;
+  }
+  
+  header ul {
+    display:none;
+  }
+}
+
+@media print {
+  body {
+    padding:0.4in;
+    font-size:12pt;
+    color:#444;
+  }
+}

data/features/clean.feature

@@ -0,0 +1,31 @@
+Feature: clean the working tree
+    As an author
+    I want to remove generated files
+    In order to return my working tree to a pristine state
+
+    Background:
+        Given a basic project
+
+    Scenario: preview file
+        Given an empty file named "preview.html"
+        When I successfully run `rpub clean`
+        Then the file "preview.html" should not exist
+
+    Scenario: book
+        Given an empty file named "untitled-book-0.0.0.epub"
+        When I successfully run `rpub clean`
+        Then the file "untitled-book-0.0.0.epub" should not exist
+
+    Scenario: dry run mode
+        Given an empty file named "preview.html"
+        And an empty file named "untitled-book-0.0.0.epub"
+        When I successfully run `rpub clean -d`
+        Then the output should contain "preview.html"
+        And the output should contain "untitled-book-0.0.0.epub"
+        And a file named "preview.html" should exist
+        And a file named "untitled-book-0.0.0.epub" should exist
+
+    Scenario: help
+        When I successfully run `rpub clean -h`
+        Then the output should contain "Clean up all generated files"
+

data/features/compile.feature

@@ -0,0 +1,49 @@
+Feature: Compilation
+    As an author
+    I want to compile my contents into an epub file
+    So my audience can read it on his e-reader device
+
+    Background:
+        Given a file named "chapter1.md" with:
+        """
+        # Hello, world
+
+        lorem ipsum
+        """
+        And a file named "chapter2.markdown" with:
+        """
+        # Goodbye, world
+
+        lorem ipsum
+        """
+
+    Scenario: generate epub file
+        Given the default "config.yml" file
+        When I successfully run `rpub compile`
+        Then a file named "untitled-book-0.0.0.epub" should exist
+        And the archive "untitled-book-0.0.0.epub" should contain file "OEBPS/chapter-0-hello-world.html"
+        And the archive "untitled-book-0.0.0.epub" should contain file "OEBPS/chapter-1-goodbye-world.html"
+
+    Scenario: file versioning
+        Given the default "config.yml" file with:
+            | version | 1.2.3   |
+            | title   | My book |
+        When I successfully run `rpub compile`
+        Then a file named "my-book-1.2.3.epub" should exist
+
+    @epubcheck
+    Scenario: valid epub file
+        Given the default "config.yml" file
+        When I successfully run `rpub compile`
+        And I run `epubcheck untitled-book-0.0.0.epub`
+        Then the output should contain "No errors or warnings detected"
+
+    Scenario: help
+        When I successfully run `rpub compile -h`
+        Then the stdout should contain "Compile your Markdown-formatted input files"
+
+    Scenario: overriding configuration
+        Given the default "config.yml" file
+        When I successfully run `mv config.yml settings.yml`
+        And I successfully run `rpub compile -c settings.yml`
+        Then a file named "untitled-book-0.0.0.epub" should exist

data/features/embedded_assets.feature

@@ -0,0 +1,51 @@
+Feature: embedding assets
+    As an author
+    I want to include custom fonts and images
+    In order to spice up the look of my book
+
+    Background:
+        Given a file named "chapter2.md" with:
+        """
+        # Chapter 2
+
+        Here comes an image:
+
+        ![alt text](image.jpg)
+
+        ## Subheading
+
+        Lorem ipsum
+        """
+        And an empty file named "image.jpg"
+
+    Scenario: ignoring files
+        When I successfully run `rpub compile`
+        Then the archive "untitled-book-0.0.0.epub" should not contain file "OEBPS/README.md"
+
+    Scenario: embedding fonts
+        Given a file named "styles.css" with:
+        """
+        @font-face {
+            font-family: Foo;
+            src: url('Foo.otf');
+        }
+        p {
+            font-family: Foo;
+        }
+        @font-face {
+            font-family: Bar;
+            src: url('Bar.ttf');
+        }
+        p {
+            font-family: Bar;
+        }
+        """
+        And an empty file named "Foo.otf"
+        And an empty file named "Bar.ttf"
+        When I successfully run `rpub compile`
+        Then the archive "untitled-book-0.0.0.epub" should contain file "OEBPS/Foo.otf"
+        And the archive "untitled-book-0.0.0.epub" should contain file "OEBPS/Bar.ttf"
+
+    Scenario: embedding images
+        When I successfully run `rpub compile`
+        Then the archive "untitled-book-0.0.0.epub" should contain file "OEBPS/image.jpg"

data/features/generate.feature

@@ -0,0 +1,63 @@
+Feature: Generate boilerplate files
+    As an author
+    I want to generate boilerplate files
+    So I can get writing quickly
+
+    Scenario: Help
+        When I successfully run `rpub generate -h`
+        Then the stdout should contain "Generate one or more standard files"
+
+    Scenario: Generate all
+        When I successfully run `rpub generate`
+        Then the default file "config.yml" should exist
+        And the default file "layout.html" should exist
+        And the default file "styles.css" should exist
+
+    Scenario: All but styles
+        When I successfully run `rpub generate --no-styles`
+        Then the default file "config.yml" should exist
+        And the default file "layout.html" should exist
+        And a file named "styles.css" should not exist
+
+    Scenario: All but layout
+        When I successfully run `rpub generate --no-layout`
+        Then the default file "config.yml" should exist
+        And a file named "layout.html" should not exist
+        And the default file "styles.css" should exist
+
+    Scenario: All but configuration
+        When I successfully run `rpub generate --no-config`
+        Then a file named "config.yml" should not exist
+        And the default file "layout.html" should exist
+        And the default file "styles.css" should exist
+
+    Scenario: Only styles
+        When I successfully run `rpub generate --styles`
+        Then a file named "config.yml" should not exist
+        And a file named "layout.html" should not exist
+        And the default file "styles.css" should exist
+
+    Scenario: Only layout
+        When I successfully run `rpub generate --layout`
+        Then a file named "config.yml" should not exist
+        And the default file "layout.html" should exist
+        And a file named "styles.css" should not exist
+
+    Scenario: Only configuration
+        When I successfully run `rpub generate --config`
+        Then the default file "config.yml" should exist
+        And a file named "layout.html" should not exist
+        And a file named "styles.css" should not exist
+
+    Scenario: Not overriding existing files
+        Given a file named "layout.html" with:
+            """
+            Foo
+            """
+        When I successfully run `rpub generate --layout`
+        Then the stderr should contain "Not overriding layout.html"
+        And the file "layout.html" should contain exactly:
+            """
+            Foo
+            """
+