cheepub 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a8208f7e95b12fbe291fa305052ab6845b86727ad9d6c32eeaebe4290946a64
-  data.tar.gz: 2c38721ff77731851add0e51e952c69286995316cf86e726909b69b922e774cf
+  metadata.gz: cb88e2dae0bf74523ce1e187024db8e8e3ec3a332480461e020ca76af1ccef5e
+  data.tar.gz: d56c9785adfca375b8892f960e4be9c2f9b3f3fc222d6953e70e7471a55279a3
 SHA512:
-  metadata.gz: 1495dad487da24e6a782966908b3d8228b249b71e23fdc66d818fe64c37cba241da061b5e4320debbabf0946a5b4e58352ff24da7304c95f24a0e80b2efe1252
-  data.tar.gz: eb7146ec19ff947c938f291161f5d1459f51badf7e6c1140b759cadbd2738c0e4841e455f2d8e04325ca97408b5c824333b66cb1b5ead7504a9eaead3ab03bc8
+  metadata.gz: 05a9ec137505b9b7fe6ee3777500a96b0e9b9305e244b143406dba78ae24cb857f369e6f709b6b460dc216c5eccf2d125fb2fc4d95d468616d8bd0f29177bd13
+  data.tar.gz: e01f312ba85bc5c318689d74efcc3dec662bbe5c7979f331167d999e6417f5b8b1ad64384a12e3bfadae74ae6226514d23511dd23a7c0d115fccdc75694e0626

data/.travis.yml

@@ -1,11 +1,19 @@
 sudo: false
 language: ruby
+env:
+  global:
+    - CC_TEST_REPORTER_ID=787a2f89b15c637323c7340d65ec17e898ac44480706b4b4122ea040c2a88f1d
 rvm:
   - 2.4.1
   - 2.5.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
 before_install:
   - gem install bundler -v 1.16.1
-
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 branches:
   only:
     - master

data/README.md

@@ -1,8 +1,8 @@
 # Cheepub
 
-Cheepub is EPUB generator from Markdown.
+[![Gem Version](https://badge.fury.io/rb/cheepub.svg)](https://badge.fury.io/rb/cheepub)[![Build Status](https://travis-ci.org/takahashim/cheepub.svg?branch=master)](https://travis-ci.org/takahashim/cheepub)
 
-Cheepub uses [Kramdown](https://github.com/gettalong/kramdown) and [Gepub](https://github.com/skoji/gepub).
+Cheepub is EPUB generator from Markdown.  When you have markdown file, you can generate EPUB3 file with just one command: `cheepub sample.md`.
 
 ## Installation
 
@@ -16,10 +16,6 @@ If you use the gem in your project, add this line to your application's Gemfile:
 gem 'cheepub'
 ```
 
-And then execute:
-
-    $ bundle
-
 ## Usage
 
 You can add options `--title` and `--author`.
@@ -34,8 +30,46 @@ If you use front-matter section like Jekyll, you can execute without any options
 $ cheepub source.md
 ```
 
+### Options
+
+* `-v, --version`                 print version
+* `--author AUTOR`                set author of the book
+* `--title TITLE`                 set title of the book
+* `--config CONFIG`               set configuration file
+* `-o, --out EPUBFILE`            set output epub filename
+* `-h, --help`                    print help
+
+
+## Markdown extensions
+
+Cheepub uses [Kramdown](https://github.com/gettalong/kramdown) and [Gepub](https://github.com/skoji/gepub).
+So you can use Kramdown extensions and some other extensions from [DenDenMarkdown](https://github.com/denshoch/DenDenMarkdown).
+
+* newpage (separate files): ex. `===` or `------`.
+* tate-chu-yoko (horizontal in vertical): ex. `^30^` or `!?`.
+* footnote: ex. `[^1]` and `[^1]: some notes about it`.
+* ruby: ex. `{some base text|some ruby text}`
+
+
+## Configuration
+
+You can define configration with in front-matter or `--config` option.
+
+### Configuration items
+
+* id: identifier
+* title: title of the book
+* author: author of the book
+* date: publishing date
+* lastModified: last modified date-time
+* pageDirection: `ltr` or `rtl`
+
 ## History
 
+### 0.3.0
+
+- add option `--out`
+
 ### 0.2.0
 
 - add option `--title`, `--author`, `--config`

data/doc/README_ja.md

@@ -31,6 +31,17 @@ Cheepubはコマンドラインで使うことを想定しています。
 $ cheepub sample.md
 ```
 
+### コマンドラインオプション
+
+* `--title 【タイトル】` タイトルを指定します。
+* `--author 【著者名】` 著者名を指定します。
+* `--config 【設定ファイル】` 後述のfront-matterに相当するYAMLファイルを別ファイルで与えた場合に使います。Markdownファイル内に設定を書きたくない人用です。
+* `--out 【EPUBファイル名】 (または -o 【EPUBファイル名】)` 出力するEPUBファイル名を指定します。省略時はbook.epubになります。
+* `--help` ヘルプを表示します。
+* `--version` バージョンを表示します。
+
+front-matterがない場合は`--title`と`--author`は必須です。
+
 ## CheepubのMarkdownについて
 
 基本方針は3つです。

data/lib/cheepub/cli.rb

@@ -2,13 +2,14 @@ module Cheepub
   class CLI < Clamp::Command
     using Cheepub::ExtHash
 
-    option ["-v", "--version"], :flag, "Show version" do
+    option ["-v", "--version"], :flag, "print version" do
       puts Cheepub::VERSION
       exit(0)
     end
-    option ["--author"], "AUTOR", "author of the book"
-    option ["--title"],  "TITLE", "title of the book"
-    option ["--config"],  "CONFIG", "configuration file"
+    option ["--author"], "AUTOR", "set author of the book"
+    option ["--title"],  "TITLE", "set title of the book"
+    option ["--config"],  "CONFIG", "set configuration file"
+    option ["-o", "--out"], "EPUBFILE", "set output epub filename", attribute_name: :epubfile
 
     parameter "SRC", "source file"
 
@@ -19,6 +20,7 @@ module Cheepub
       end
       params[:author] = author if author
       params[:title] = title if title
+      params[:epubfile] = epubfile if epubfile
       gen = Cheepub::Generator.new(src, params)
       begin
         gen.execute

data/lib/cheepub/generator.rb

@@ -19,10 +19,33 @@ module Cheepub
 
     def execute
       params = @params.merge(@content.header)
+      check_params(params)
+      book = GEPUB::Book.new
+      apply_params(book, params)
+      epubfile = params[:epubfile] || "book.epub"
+      book.generate_epub(epubfile)
+    end
+
+    def parse_creator(book, creator)
+      if creator.kind_of? String
+        book.add_creator(creator)
+      else
+        creator.each do |role, name|
+          if !ROLES.include?(role)
+            raise Cheepub::Error, "invalid role: '#{role}' for creator '#{name}'."
+          end
+          book.add_creator(name, nil, role)
+        end
+      end
+    end
+
+    def check_params(params)
       if !params[:author] || !params[:title]
-        raise Cheepub::Error, "author and title should be defined."
+        raise Cheepub::Error, "you must use `--author` and `--title`, or add front-matter in Markdown file."
       end
-      book = GEPUB::Book.new
+    end
+
+    def apply_params(book, params)
       book.identifier = params[:id] || "urn:uuid:#{SecureRandom.uuid}"
       book.title = params[:title]
       if params[:creator]
@@ -48,21 +71,6 @@ module Cheepub
           item.add_content(StringIO.new(page))
         end
       end
-      epubname = params[:epubname] || "book.epub"
-      book.generate_epub(epubname)
-    end
-
-    def parse_creator(book, creator)
-      if creator.kind_of? String
-        book.add_creator(creator)
-      else
-        creator.each do |role, name|
-          if !ROLES.include?(role)
-            raise Cheepub::Error, "invalid role: '#{role}' for creator '#{name}'."
-          end
-          book.add_creator(name, nil, role)
-        end
-      end
     end
   end
 end

data/lib/cheepub/version.rb

@@ -1,3 +1,3 @@
 module Cheepub
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cheepub
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - takahashim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-05 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gepub