makimono 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab2d90e60b3c40579bb3a00023e0d1b4d9d2dbdeeb2f6646ba966bc2cf83dda
-  data.tar.gz: 28854075a1ea080b97038464b90ff37e6ec42a6ffc9b9646fa27ab3989650670
+  metadata.gz: 92d6d41d6c631de78c30e6ad85736cb83b8424f08d66bb71ff0be880dbd36390
+  data.tar.gz: 5fce9f2686b48071bdec692c7e5de2e43ac3b2b2f9ab29aa7e4037bfbb46037a
 SHA512:
-  metadata.gz: 77ff25682614bea8d5c3c2444b53ad07e8b702f9c6063e84f639b790b773001b230961cac9796a94018d5cc0440a6072f56a551e787d89bec3af097ae08605a2
-  data.tar.gz: 11cf570ef3a45c9127f0a81741a84d68bd97ce62a7f6709c11de6a27fac24439764414f7249522e273eec68e2a3eda9bbf4d9d4d48a0f57d9a611abd4e0475f8
+  metadata.gz: '08163bc86fa01c7db77ad93bae0124e692e6722e15d2fbb0bdf5670d24f62785df1517b682d6511e83c041e72c22a9fa61c0928b5bef7ae5922da6c438ba402e'
+  data.tar.gz: c971e8899e7dc09fd8fb17acf3cb4ff8243625d29aa8e09875e2ac47741de498ca2834116844a788efaf2e2d3e698025758a1de4118783898116cb455b5c6cc3

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: fuji-nakahara

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
 
 AllCops:
   NewCops: enable
+  TargetRubyVersion: 2.6
 
 # rubocop
 
@@ -10,9 +11,6 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Style/ClassAndModuleChildren:
-  Enabled: false
-
 Style/Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2020-10-24
+
+### Added
+
+- Add "Getting Started" section to README.
+- Add Japanese README. 
+
+### Changed
+
+- Update `makimono.yml` generated by `makimono new` command.
+- Stop generating `out` directory by `makimono new` command.
+- Enable to give non-array options for CommonMarker config. 
+
 ## [0.1.1] - 2020-10-12
 
 ### Fixed
@@ -16,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - First release!
 
-[Unreleased]: https://github.com/fuji-nakahara/makimono/compare/v0.1.1...HEAD
+[Unreleased]: https://github.com/fuji-nakahara/makimono/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/fuji-nakahara/makimono/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/fuji-nakahara/makimono/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/fuji-nakahara/makimono/releases/tag/v0.1.0

data/README-ja.md

@@ -0,0 +1,187 @@
+# Makimono
+
+[English](README.md)
+
+Makimono はマークダウンで書かれたファイル群から電子書籍を生成するコマンドラインツールを提供します。
+
+## はじめに
+
+まず、Makimono をインストールします。
+
+    $ gem install makimono
+
+次に、`mybook` ディレクトリに Makimono プロジェクトを作成し、移動します。
+
+    $ makimono new mybook
+    $ cd mybook
+
+`src` ディレクトリにあるマークダウンファイルに電子書籍にしたいテキストを書きます。
+
+    $ vi src/01-mybook.md
+
+編集が完了したら、電子書籍を作成します。
+
+    $ makimono build
+
+すると、`out/book.epub` に EPUB ファイルが作成されます。
+
+## ファイル名の規約
+
+Makimono では、ソースディレクトリ（デフォルトではカレントディレクトリの `src`）内のファイルで、正規表現 `^(\d+)-(.+)$` にマッチするファイル名のものを電子書籍に含めるべきコンテンツとみなします。
+たとえば `01-プロローグ.md` や `99-エピローグ.md` などです。
+また、`-` 以前の数値をコンテンツ順序の決定に利用し、`-` 以降拡張子までの文字列をタイトルとみなします。
+
+正規表現にマッチしない場合は電子書籍の順序だったコンテンツを構成する要素とはみなしませんが、相対パスで参照することができます。
+たとえば、`01-プロローグ.md` の中で画像 `sample.png` を表示したい場合、マークダウン記法を使って、
+
+```
+![サンプル](sample.png)
+```
+
+のように記述し、`src` ディレクトリに `sample.png` を配置すれば、電子書籍でも画像を表示することができます。
+
+## 設定
+
+Makimono はデフォルトでカレントディレクトリの `makimono.yml` を設定ファイルとみなします。
+`--config` オプションで別のファイルを指定することもできます。
+
+利用可能な設定項目とデフォルト値は以下のとおりです。
+
+```yaml
+# EPUB のメタデータ
+# 詳しくは https://imagedrive.github.io/Submission/epub32/epub-packages.html を参照
+identifier:                 # 指定しなかった場合は実行時に生成した UUID が設定される 
+modified:                   # 指定しなかった場合は現在時刻が設定される
+title: 'No title'
+language: 'ja'
+creator:                    # 配列でも指定可能
+contributor:                # 配列でも指定可能
+date:
+page_progression_direction:
+
+# Makimono 固有のビルド設定
+source: 'src'              # 電子書籍にするファイル群を置くディレクトリ
+output: 'out'              # 出力したファイルを置くディレクトリ
+library: 'lib'             # Makimono 拡張用のユーザーライブラリを置くディレクトリ
+converters: [ 'Markdown' ] # 使用するコンバーターの配列。この順で変換が行われる
+markdown: 'CommonMarker'   # Markdown コンバーターで使用するマークダウンの種類。デフォルトは CommonMarker で FujiMarkdown も利用可能
+CommonMarker:              # CommonMarker の設定
+  options: 'DEFAULT'       # 配列でも指定可
+  extensions: []
+template: 'default.xhtml'  # 使用する ERB テンプレートのパス。default.xhtml を指定した場合はプリセットが適用される
+style: null                # 使用する CSS のパス。fuji または fuji_tategaki を指定した場合はプリセットが適用される
+generator: 'EPUB'          # 使用するジェネレーター
+ebook_file_name: 'book'    # 電子書籍を出力するときのファイル名
+```
+
+#### markdown
+
+Makimono は [CommonMark](https://commonmark.org/) の Ruby 実装である [CommonMarker](https://github.com/gjtorikian/commonmarker) をデフォルトのマークダウンコンバーターとして使用します。
+また、日本語小説用の拡張マークダウンである [FujiMarkdown](https://github.com/fuji-nakahara/fuji_markdown) を仕様するよう変更することも可能です。
+以下は、縦書き日本語小説用の設定例です。
+
+```yaml
+page_progression_direction: rtl # ページ送りを右から左（right to left）にする
+markdown: FujiMarkdown          # マークダウンコンバーターとして FujiMarkdown を使用する
+style: fuji_tategaki            # プリセットの縦書きスタイルを用いる
+```
+
+後述のユーザーライブラリ機能を用いれば、kramdown など任意のマークダウンコンバーターを使用することもできます。 
+
+#### template
+
+設定 `template` にファイルパスを渡せば、マークダウン変換時に利用するテンプレートを変更可能です。
+テンプレートとして指定されたファイルは ERB として処理されます。
+変数として、設定のハッシュオブジェクト `config`、[`Resource`](lib/makimono/resource.rb) クラスのインスタンス `resource`、マークダウン変換後の文字列 `body` の3つが渡されます。
+詳しい書き方はデフォルトの XHTML テンプレート [`default.xhtml`](lib/templates/default.xhtml.erb) を参考にしてください。
+
+#### style
+
+設定 `style` に CSS ファイルのパスを渡せば、電子書籍で利用するスタイルを変更できます。
+また、プリセットとして横書き日本語小説に適した [`fuji`](lib/styles/fuji.css) と縦書き日本語小説に適した [`fuji_tategaki`](lib/styles/fuji_tategaki.css) が用意されています。
+
+## ユーザーライブラリ
+
+Makimono は Makimono 自体のコードを変更することなく Ruby で拡張できます。
+
+拡張用の Ruby ファイルはライブラリディレクトリ以下に配置すれば実行時に自動でロードされます。
+デフォルトのライブラリディレクトリは `lib` ですが、設定 `library` でディレクトリパスを変更可能です。
+
+また、gem として配布されている場合は、`Gemfile` で `makimono` group に含めれば実行時に自動でロードされます。
+
+```ruby
+gem 'my_makimono_library', group: :makimono
+```
+
+### マークダウン
+
+独自のマークダウンコンバーターを使用するには、`Makimono::Converter::Markdown` 以下に `#render` メソッドを持つ新しいクラスを定義し、設定 `markdown` でクラス名を指定します。
+実装は [`CommonMarker`](lib/makimono/converter/markdown/commonmarker.rb) や [`FujiMarkdown`](lib/makimono/converter/markdown/fuji_markdown.rb) を参考にしてください。
+
+たとえば、[kramdown](https://github.com/gettalong/kramdown) をマークダウンコンバーターとして利用するには、まず以下のようなクラス `Makimono::Converter::Markdown::Kramdown` を定義します。
+
+```ruby
+require 'kramdown'
+
+module Makimono
+  class Converter
+    class Markdown
+      class Kramdown
+        def initialize(config)
+          @config = config
+        end
+
+        def render(markdown)
+          ::Kramdown::Document.new(markdown).to_html
+        end
+      end
+    end
+  end
+end
+```
+
+次に設定 `markdown` でクラス名 `Kramdown` を指定します。
+
+```yaml
+markdown: Kramdown
+```
+
+### コンバーター
+
+独自のコンバーターを使用するには、`Makimono::Converter` 以下に `#convertible?` と `#convert` メソッドを持つ新しいクラスを定義し、設定 `converters` でクラス名を指定します。
+実装は [`Markdown`](lib/makimono/converter/markdown.rb) を参考にしてください。
+
+たとえば、タイトルのアンダースコア (`_`) を空白に変換するコンバーターを追加するには、まず以下のようなクラス `Makimono::Converter::UnderscoreToSpace` を定義します。
+
+```ruby
+module Makimono
+  class Converter
+    class UnderscoreToSpace
+      def initialize(config)
+        @config = config
+      end
+
+      def convertible?(resource)
+        resource.ordered?
+      end
+
+      def convert(resource)
+        converted = resource.dup
+        converted.title = resource.title.gsub('_', ' ')
+        converted
+      end
+    end
+  end
+end
+```
+
+次に設定 `converters` にクラス名 `UnderscoreToSpace` を追加します。
+
+```yaml
+converters: [ 'Markdown', 'UnderscoreToSpace' ]
+```
+
+### ジェネレーター
+
+独自のジェネレーターを使用するには、`Makimono::Generator` 以下に `#generate` メソッドを持つ新しいクラスを定義し、設定 `generator` でクラス名を指定します。
+実装は [`Epub`](lib/makimono/generator/epub.rb) や [`SimpleFile`](lib/makimono/generator/simple_file.rb) を参考にしてください。

data/README.md

@@ -1,26 +1,29 @@
 # Makimono
 
-Makimono is a simple ebook generator.
+[日本語](README-ja.md)
 
-## Installation
+Makimono provides a command line tool to generate an ebook from a set of markdown files.
 
-Add this line to your application's Gemfile:
+## Getting Started
 
-```ruby
-gem 'makimono'
-```
+First, install Makimono.
 
-And then execute:
+    $ gem install makimono
 
-    $ bundle install
+Next, create a Makimono project in the `mybook` directory.
 
-Or install it yourself as:
+    $ makimono new mybook
+    $ cd mybook
 
-    $ gem install makimono
+Write text on a markdown file in the `src` directory.
+
+    $ vi src/01-mybook.md
+
+When you are done writing, create an ebook.
 
-## Usage
+    $ makimono build
 
-TODO: Write usage instructions here
+This will create an EPUB file in `out/book.epub`.
 
 ## Development
 

data/lib/makimono/command/new.rb

@@ -22,7 +22,6 @@ module Makimono
         copy_file('Gemfile')
         template('makimono.yml', { name: name })
         copy_file('src/01-Title.md', "src/01-#{name.capitalize}.md")
-        create_file('out/.keep')
       end
 
       def run_bundle_install

data/lib/makimono/configuration.rb

@@ -11,23 +11,32 @@ module Makimono
 
     DEFAULTS = {
       # Makimono
-      source: File.expand_path('src'),
-      output: File.expand_path('out'),
-      style: nil,
-      template: 'default.xhtml',
-      markdown: 'CommonMarker',
+      source: 'src',
+      output: 'out',
+      library: 'lib',
       converters: %w[Markdown],
+      markdown: 'CommonMarker',
+      CommonMarker: {
+        options: 'DEFAULT',
+        extensions: []
+      },
+      template: 'default.xhtml',
+      style: nil,
       generator: 'EPUB',
       ebook_file_name: 'book',
-      library: File.expand_path('lib'),
 
       # EPUB
       identifier: "urn:uuid:#{SecureRandom.uuid}",
+      modified: Time.now,
       title: 'No title',
-      language: 'ja'
+      language: 'ja',
+      creator: nil,
+      contributor: nil,
+      date: nil,
+      page_progression_direction: nil
     }.freeze
 
-    def_delegators :@config, :[], :fetch, :dig, :slice
+    def_delegators :@config, :[], :fetch, :dig
 
     def initialize(config = {})
       @config = DEFAULTS.merge(config)

data/lib/makimono/converter/markdown/commonmarker.rb

@@ -17,7 +17,11 @@ module Makimono
         private
 
         def options
-          @config.dig(:CommonMarker, :options)&.map(&:upcase)&.map(&:to_sym) || :DEFAULT
+          if (options = @config.dig(:CommonMarker, :options))
+            Array(options).map(&:upcase).map(&:to_sym)
+          else
+            :DEFAULT
+          end
         end
 
         def extensions

data/lib/makimono/generator/epub.rb

@@ -19,6 +19,7 @@ module Makimono
         add_items([@config.style, *resources.reject(&:ordered?)].compact)
         add_ordered_items(resources.select(&:ordered?).sort_by(&:number))
 
+        FileUtils.mkdir_p(@config[:output]) unless Dir.exist?(@config[:output])
         @book.generate_epub("#{File.expand_path(@config[:ebook_file_name], @config[:output])}.epub")
       end
 
@@ -26,9 +27,9 @@ module Makimono
 
       def add_required_metadata
         @book.identifier = @config.fetch(:identifier)
+        @book.lastmodified = @config.fetch(:modified)
         @book.title = @config.fetch(:title)
         @book.language = @config.fetch(:language)
-        @book.lastmodified = parse_config_time(:modified) if @config[:modified]
       rescue KeyError => e
         raise InvalidConfigurationError, "Required metadata not found: #{e.key}"
       end
@@ -41,7 +42,7 @@ module Makimono
           @book.add_contributor(contributor)
         end
 
-        @book.add_date(parse_config_time(:date).iso8601) if @config[:date]
+        @book.add_date(@config[:date].to_time.iso8601) if @config[:date]
       end
 
       def add_items(resources)
@@ -60,12 +61,6 @@ module Makimono
           end
         end
       end
-
-      def parse_config_time(key)
-        Time.parse(@config[key].to_s)
-      rescue ArgumentError
-        raise InvalidConfigurationError, "Invalid time format: #{key}"
-      end
     end
   end
 end

data/lib/makimono/resource.rb

@@ -4,13 +4,18 @@ module Makimono
   class Resource
     ORDERED_BASENAME_REGEXP = /\A(?<number>\d+)-(?<title>.+)\z/.freeze
 
-    attr_accessor :path, :content
+    attr_reader :path
+    attr_accessor :content
 
     def initialize(path, content)
-      @path = path
+      self.path = path
       @content = content
     end
 
+    def path=(new_path)
+      @path = Pathname.new(new_path).cleanpath.to_s
+    end
+
     def dirname
       File.dirname(path)
     end

data/lib/makimono/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Makimono
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/project_template/makimono.yml

@@ -1,3 +1,7 @@
-identifier: 'urn:uuid:<%= SecureRandom.uuid %>'
-title: '<%= config[:name].capitalize %>'
-ebook_file_name: '<%= config[:name] %>'
+identifier: urn:uuid:<%= SecureRandom.uuid %>
+title: <%= config[:name].capitalize %>
+language: ja
+creator:
+
+style:
+ebook_file_name: book

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: makimono
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fuji Nakahara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2020-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commonmarker
@@ -74,6 +74,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/gem-push.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -83,6 +84,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- README-ja.md
 - README.md
 - Rakefile
 - bin/console