bookery 0.0.2 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f97ae9ea2ae24920a2039c25ff8c992f85ed3c8
+  data.tar.gz: c840b5b74a04f51cf2e618129fec5efb542043a8
+SHA512:
+  metadata.gz: 0bd2ce35591d8e0afe82cf39792c1649cda9c3d61932a6e0851c89cac4ec7e58ef326791a81d50f54a8f67f9ad7dc81b8db4ca154e3ce94ac921e0c1f62ac9ac
+  data.tar.gz: 1497fedfe9038028789fb1118e58865a8665eb728d1a13e60f999fc1e02af8322694d8195b2d34cdbf236bc4e841b4f7b67261c30d602b5974ad4d315d7df5f0

data/.gitignore

@@ -1,8 +1,20 @@
-.DS_Store
-.bundle/
-bin/*
-!bin/bookery
-sandbox/
-vendor/
-coverage/
-pkg/
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin
+vendor
+Guardfile

data/.travis.yml

@@ -0,0 +1,5 @@
+---
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,12 +1,11 @@
 # Bookery
 
-My own custom tool for writing books. This is very much a work in progress right now.
+[![Build Status](https://travis-ci.org/pseudomuto/bookery.png)](https://travis-ci.org/pseudomuto/bookery)
+
+My own (very opinionated) custom tool for writing books. This is very much a work in progress right now.
 
 ## TODO's for a reasonable v1
 
-* [ ] Support for variables (via config.yml)
-* [ ] Support for embedded assets
-* [ ] Build HTML
 * [ ] Build PDF
 * [ ] Build Mobi
 * [ ] Build ePub
@@ -15,14 +14,30 @@ My own custom tool for writing books. This is very much a work in progress right
 
     $ gem install bookery
 
-## Usage
+_If you're using rbenv, run `rbenv rehash` after the installation to ensure the shim is created_
+
+## Creating a New Book
+
+    $ bookery new <project_dir>
+
+This will create a new [project] in the specified directory.
+
+## Publishing
 
-* `bookery new [PATH]` - create a new book
+From within the project directory:
+
+    $ bookery publish
+
+This will generate an HTML version of your book for each language in the [project].
+
+## Editing
+
+For a guideline on editing, checkout the [editing] docs.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Wanna contribute? Awesome! Check out the [contributing guidelines] to get started.
+
+[project]: docs/project.md
+[editing]: docs/editing.md
+[contributing guidelines]: docs/contributing.md

data/Rakefile

@@ -1,8 +1,9 @@
 require "bundler/gem_tasks"
-
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
 end
+
+task :default => :test

data/bookery.gemspec

@@ -4,26 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bookery/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'bookery'
+  spec.name          = "bookery"
   spec.version       = Bookery::VERSION
-  spec.authors       = ['David Muto']
-  spec.email         = ['david.muto@gmail.com']
-  spec.description   = %q{A gem (that, will) gives you the tools you need to write your own book}
+  spec.authors       = ["David Muto"]
+  spec.email         = ["david.muto@gmail.com"]
+  spec.description   = %q{
+    A gem that gives you the tools you need to write your own book
+  }
   spec.summary       = %q{A simple way to author your book}
   spec.homepage      = 'https://github.com/pseudomuto/bookery'
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.bindir        = 'libexec'
+  spec.executables   = spec.files.grep(%r{^libexec/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'i18n'
+  spec.add_dependency('thor', '~> 0.18.1')
+  spec.add_dependency('kramdown', '~> 1.3.0')
+  spec.add_dependency('coderay', '~> 1.1.0')
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'guard-minitest'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency('bundler', '~> 1.3.5')
+  spec.add_development_dependency('rake', '~> 10.1.1')
+  spec.add_development_dependency('minitest', '~> 5.2.0')
+  spec.add_development_dependency('mocha', '~> 0.14.0')
+  spec.add_development_dependency('simplecov', '~> 0.8.2')
 end

data/docs/config.md

@@ -0,0 +1,61 @@
+# Project Configuration
+
+The _config.yml_ file contains configuration information for your book. A typical file might look like this:
+
+```yaml
+---
+book:
+  title: My Book
+  authors:
+    - Your Name
+    - Your Co-Author's Name
+  editors:
+    - Your Editor's Name
+    - Other Editor's Names
+  template: assets/templates/template.html.erb
+```
+
+You can override any of the values above for a particular language, by providing a subkey for that language. For example, if you want to change the title for the Spanish version, your file would look like this:
+
+```yaml
+---
+book:
+  title: My Book
+  authors:
+    - Your Name
+    - Your Co-Author's Name
+  editors:
+    - Your Editor's Name
+    - Other Editor's Names
+  template: assets/templates/template.html.erb
+
+  # overrides for Spanish
+  es:
+    title: Mi Libro
+```
+
+If there is no value specified for the current language (when publishing) the default will be used. So in the case of the file above, the template would be the same for both _en_ and _es_ books.
+
+## Optional Configuration
+
+If you want more control over how kramdown handles your markdown files you can provide some additional configuration options via the `generator` key. Here's an example:
+
+```yaml
+---
+book:
+  ...
+  ...
+
+generator:
+  input: Kramdown
+  enable_coderay: false
+```
+
+For a list of available options, see [kramdown's options](http://kramdown.gettalong.org/options.html). By default the following options are supplied:
+
+```yaml
+input: 'GFM'
+enable_coderay: true
+coderay_css: 'class'
+coderay_line_numbers: 'inline'
+```

data/docs/contributing.md

@@ -0,0 +1,47 @@
+# How to Contribute
+
+I love Pull Requests! Your contributions help make bookery great.
+
+## Getting Started
+
+So you want to contribute to bookery. Great! Contributions take many forms from
+submitting issues, writing docs, to making code changes. I welcome it all.
+
+But first things first...
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub or run the following command in a git shell.
+```
+git clone git@github.com:pseudomuto/bookery.git
+```
+* Make sure the project builds and all tests pass on your machine by running
+`rake test`
+
+## Making Changes
+
+* Create a topic branch off master (don't work directly on master).
+* Make commits of logical units.
+* Provide descriptive commit messages in the proper format
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request. Note what issue/issues your patch fixes.
+
+Some things that will increase the chance that your pull request is accepted.
+
+* Follow existing code conventions. The usual ruby stuff like soft tabs, etc.
+* Include tests that would otherwise fail without your code, but pass with
+  it.
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/docs/editing.md

@@ -0,0 +1,82 @@
+# Editing
+
+All book content is written in markdown. For a run down on markdown, check out Daring Fireball's [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax).
+
+When using the default options, [Github Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) is fully supported.
+
+## Useful Information
+
+* Markdown inside HTML blocks will not be processed
+* CodeRay is used for syntax highlighting. For a list of supported languages check out the [home page].
+
+[home page]: http://coderay.rubychan.de/
+
+## Using Images
+
+Images should be stored in the assets folder. You're free to choose any structure you like, but I would suggest an aptly named folder like _images_ or _img_.
+
+When referencing an image in your markdown files, use the relative path from the project directory. For example, in _book/en/001-first-chapter.md_ you can reference _assets/images/cover.png_ like so:
+
+<pre>
+&#33;[My Image Alt Text](assets/images/cover.png)
+</pre>
+
+## For technical writers, these might be of particular interest
+
+### Fenced Code Blocks
+
+You can include codce samples using fenced code blocks using back ticks and optionally the language name. For example, you could include a ruby class like this:
+
+<pre>
+  &#96;&#96;&#96;ruby
+  module Demo
+    class Foo
+      attr_reader :baz
+
+      def initialize(baz = 'demo')
+        @baz = baz
+      end
+
+      def bar(suffix)
+        "#{baz}#{suffix}"
+      end
+    end
+  end
+  &#96;&#96;&#96;
+</pre>
+
+This would result in output like this:
+
+```ruby
+module Demo
+  class Foo
+    attr_reader :baz
+
+    def initialize(baz = 'demo')
+      @baz = baz
+    end
+
+    def bar(suffix)
+      "#{baz}#{suffix}"
+    end
+  end
+end
+```
+
+### Including Code Files
+
+Sometimes large code blocks can make your chapter files too large and harder to manage. To help with this, you can include external code files by using the following syntax:
+
+<pre>
+  &#96;&#96;&#96;&lt;language&gt;
+  includes::&lt;path_to_include_file&gt;
+  &#96;&#96;&#96;
+</pre>
+
+The `path_to_include_file` above should be replaced with a path to a file relative to the _assets/includes_ directory. For example, to include _assets/includes/ruby/chapter2_fig1.rb_ you would use the following:
+
+<pre>
+  &#96;&#96;&#96;ruby
+  includes::ruby/chapter2_fig1.rb
+  &#96;&#96;&#96;
+</pre>

data/docs/project.md

@@ -0,0 +1,77 @@
+# Project Layout/Structure
+
+Each _book_ is represented a project containing:
+
+* assets
+* one or more books (one per language)
+* configuration
+
+## Directory Structure
+
+Using the default template will result in a project with the following directory structure:
+
+```
+[project]
+  assets
+    css
+      [CSS files]
+    includes
+    templates
+      template.html.erb
+    style.css
+  book
+    en
+      001-first-chapter
+        01-chapter-file.md
+  config.yml
+  Gemfile
+```
+
+### Assets
+
+The assets folder contains static files that are used by your book. These files can include templates, stylesheets, images, code files or anything else you like.
+
+### Book
+
+In the book directory, you will find a directory for each language you wish to support. By default, you will have an _en_ directory. If you wish to have another language, simply create a new folder under this directory with the abbreviated language code.
+
+For example, to create a Spanish version of your book, create a directory called _es_.
+
+Under each language directory, markdown files (_*.md_) contain the content of your book. For better organization (I told you this project was opinionated), each language directory is expected to follow something like this:
+
+```
+[lang]
+  [chapter]
+    [one or more md files]
+```
+
+During publishing, chapters (sub directories) will be combined in alphabetical order. Each of them combining their files in alphabetical order.
+
+_I suggest following a naming convention to make this easy. I use `001-<chapter_name>` and `01-<filename>.md` for each file within a chapter._
+
+For information on editing, check out the [editing docs](editing.md).
+
+### Configuration
+
+The _config.yml_ file contains configuration information for your book. A typical file might look like this:
+
+```yaml
+---
+book:
+  title: My Book
+  authors:
+    - Your Name
+    - Your Co-Author's Name
+  editors:
+    - Your Editor's Name
+    - Other Editor's Names
+  template: assets/templates/template.html.erb
+```
+
+You can override values on a per language basis. You can also specify special configuration options for the publishing process.
+
+For more details, see the [documentation for configuration](config.md).
+
+### The Gemfile
+
+This is a file used by ruby/bundler. For the most part you can ignore this file.

data/lib/bookery.rb

@@ -1,9 +1,32 @@
-require 'active_support/core_ext/string'
+require 'thor'
+require 'yaml'
+require 'kramdown'
+require 'erb'
+
 require 'bookery/version'
-require 'bookery/chapter'
+require 'bookery/config'
+require 'bookery/factories/chapter_factory'
 require 'bookery/book'
+require 'bookery/factories/publisher_factory'
+require 'bookery/project'
 require 'bookery/cli'
 
-module Bookery
-  # Your code goes here...
+require 'bookery/processors/include_processor'
+
+class Hash
+  # Adapted from http://devblog.avdi.org/2009/07/14/recursively-symbolize-keys/
+  def symbolize_keys
+    self.inject({}) do |result, (key, value)|
+      new_key = case key
+                when String then key.to_sym
+                else key
+                end
+      new_value = case value
+                  when Hash then value.symbolize_keys
+                  else value
+                  end
+      result[new_key] = new_value
+      result
+    end
+  end
 end