RubyGems - bookery - Versions diffs - 0.0.2 → 0.1.0 - Mend

bookery 0.0.2 → 0.1.0

Files changed (64) hide show

checksums.yaml +7 -0
data/.gitignore +20 -8
data/.travis.yml +5 -0
data/{LICENSE.txt → LICENSE} +0 -0
data/README.md +26 -11
data/Rakefile +2 -1
data/bookery.gemspec +18 -14
data/docs/config.md +61 -0
data/docs/contributing.md +47 -0
data/docs/editing.md +82 -0
data/docs/project.md +77 -0
data/lib/bookery.rb +27 -4
data/lib/bookery/book.rb +13 -15
data/lib/bookery/cli.rb +29 -12
data/lib/bookery/config.rb +42 -0
data/lib/bookery/factories/chapter_factory.rb +35 -0
data/lib/bookery/factories/publisher_factory.rb +13 -0
data/lib/bookery/processors/include_processor.rb +17 -0
data/lib/bookery/project.rb +75 -0
data/lib/bookery/publishers/html_publisher.rb +68 -0
data/lib/bookery/version.rb +1 -1
data/{bin → libexec}/bookery +1 -4
data/templates/basic/Gemfile.tt +2 -0
data/templates/basic/assets/css/base.css +7 -0
data/templates/basic/assets/css/layout.css +23 -0
data/templates/basic/assets/css/modules/code-block.css +132 -0
data/templates/{book/assets → basic/assets/includes}/.empty_directory +0 -0
data/templates/basic/assets/style.css +3 -0
data/templates/basic/assets/templates/template.html.erb +30 -0
data/templates/basic/book/en/001-first-chapter/01-chapter-file.md +9 -0
data/templates/basic/config.yml +14 -0
data/test/bookery/book_test.rb +32 -9
data/test/bookery/cli_test.rb +25 -14
data/test/bookery/config_test.rb +26 -0
data/test/bookery/factories/chapter_factory_test.rb +24 -0
data/test/bookery/factories/publisher_factory_test.rb +16 -0
data/test/bookery/processor/include_processor_test.rb +38 -0
data/test/bookery/project_test.rb +37 -0
data/test/bookery/publishers/html_publisher_test.rb +78 -0
data/test/data/project/Gemfile.tt +2 -0
data/{templates/book/book/.empty_directory → test/data/project/assets/images/cover.png} +0 -0
data/test/data/project/assets/includes/ruby/chapter2.rb +3 -0
data/test/data/project/assets/style.css +1 -0
data/test/data/project/assets/templates/template.html.erb +15 -0
data/test/data/project/book/en/001-first-chapter/01-chapter-file.md +9 -0
data/test/data/project/book/en/002-second-chapter/01-chapter-file.md +7 -0
data/test/data/project/book/en/002-second-chapter/02-second-chapter-file.md +1 -0
data/{templates/book/book/en/.empty_directory → test/data/project/book/es/.git-keep} +0 -0
data/test/data/project/config.yml +19 -0
data/test/test_helper.rb +3 -46
metadata +107 -79
data/Gemfile.lock +0 -64
data/Guardfile +0 -9
data/lib/bookery/chapter.rb +0 -30
data/templates/book/Gemfile +0 -2
data/templates/book/README.md +0 -3
data/templates/book/config.yml +0 -5
data/templates/sample/Gemfile +0 -2
data/templates/sample/README.md +0 -3
data/templates/sample/book/en/01-introduction/01-intro-to-book.md +0 -0
data/templates/sample/book/en/02-second-chapter/01-first-things-first.md +0 -1
data/templates/sample/book/en/02-second-chapter/02-before_intro.md +0 -1
data/templates/sample/config.yml +0 -5
data/test/bookery/chapter_test.rb +0 -21

data/templates/{book/assets → basic/assets/includes}/.empty_directory RENAMED Viewed

File without changes

data/templates/basic/assets/style.css ADDED Viewed

@@ -0,0 +1,3 @@
+@import 'css/base.css';
+@import 'css/layout.css';
+@import 'css/modules/code-block.css';

data/templates/basic/assets/templates/template.html.erb ADDED Viewed

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="<%= language %>">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <title><%= title %> by <%= authors %></title>
+  <meta name="author" content="<%= authors %>">
+  <meta name="description" content="<%= title %>">
+  <meta name="generator" content="bookery">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="stylesheet" type="text/css" href="assets/style.css">
+</head>
+<body>
+  <header>
+    <div class="container">
+      <h1><%= title %></h1>
+    </div>
+  </header>
+  <section class="container">
+    <%= body %>
+  </section>
+  <footer>
+    <div class="container">
+      Copyright &copy; <%= Time.now.year %> <%= authors %>
+    </div>
+  </footer>
+</body>
+</html>

data/templates/basic/book/en/001-first-chapter/01-chapter-file.md ADDED Viewed

@@ -0,0 +1,9 @@
+# The First Chapter
+Checkout some ruby code...
+```ruby
+def some_method_name(with, *args)
+  does_something(with, args)
+end
+```

data/templates/basic/config.yml ADDED Viewed

@@ -0,0 +1,14 @@
+---
+book:
+  title: My Book
+  authors:
+    - Your name here
+  editors:
+    - Any editors
+  template: assets/templates/template.html.erb
+generator:
+  input: GFM
+  enable_coderay: true
+  coderay_css: class
+  coderay_line_numbers: inline

data/test/bookery/book_test.rb CHANGED Viewed

@@ -1,19 +1,42 @@
 require 'test_helper'
-class BookTest < AppTest
+class BookTest < Minitest::Test
   def setup
-    super
-    @book = Bookery::Book.new('en', cwd: 'sandbox')
+    config = Bookery::Config.new('en', {
+      title: 'My Title',
+      authors: ['David Muto', 'Jesus Christ'],
+      editors: ['Kevin Centeno', 'Kevin Ackland'],
+      language: 'en'
+    })
+    book_dir = 'test/data/project/book/en'
+    chapters = Bookery::Factories::ChapterFactory.create_chapters(book_dir)
+    @book = Bookery::Book.new(chapters, config)
+  end
+  def test_title_pulled_from_options
+    refute_empty @book.title
   end
-  def test_loads_chapters
-    expected_names = ['Introduction', 'Second Chapter']
-    actual_names = @book.chapters.map { |c| c.name }
+  def test_authors_pulled_from_options
+    assert_equal 2, @book.authors.size
+  end
+  def test_editors_pulled_from_options
+    assert_equal 2, @book.editors.size
+  end
-    assert_equal expected_names, actual_names
+  def test_language_pulled_from_options
+    refute_empty @book.language
   end
-  def template_name
-    'sample'
+  def test_content_combines_all_chapters
+    expected = [
+      '# The First Chapter',
+      '# The Second Chapter'
+    ]
+    expected.each { |heading| assert_includes @book.content, heading }
   end
 end

data/test/bookery/cli_test.rb CHANGED Viewed

@@ -1,28 +1,39 @@
 require 'test_helper'
-class CLITest < AppTest
-  def test_new_creates_readme_file
-    assert_file 'README.md'
+class CLITest < Minitest::Test
+  def setup
+    @cli = Bookery::CLI.new
   end
-  def test_new_creates_gemfile
-    assert_file 'Gemfile'
+  def test_source_root_points_to_templates
+    templates_dir = File.expand_path('../../../templates', __FILE__)
+    assert_equal templates_dir, Bookery::CLI.source_root
   end
-  def test_new_creates_book_folder
-    assert_dir 'book'
+  def test_version_returns_gem_version
+    expected = Bookery::VERSION
+    output, _ = capture_io { @cli.version }
+    assert_equal expected, output.chomp
   end
-  def test_new_creates_en_folder_in_book
-    assert_dir 'book/en'
+  def test_new_creates_project
+    @cli.stubs(:directory).with('basic', 'project').once
+    @cli.new('project')
   end
-  def test_new_creates_assets_folder
-    assert_dir 'assets'
+  def test_new_creates_project_from_template
+    @cli.stubs(:directory).with('example', 'project').once
+    @cli.stubs(:options).returns({ template: 'example' })
+    @cli.new('project')
   end
-  def test_new_creates_config_yml
-    assert_file 'config.yml'
+  def test_publish_publishes_book
+    FileUtils.stubs(:mkdir_p)
+    FileUtils.stubs(:cp)
+    File.stubs(:write)
+    @cli.stubs(:options).returns({ project_dir: 'test/data/project' })
+    @cli.publish
   end
 end

data/test/bookery/config_test.rb ADDED Viewed

@@ -0,0 +1,26 @@
+require 'test_helper'
+class ConfigTest < Minitest::Test
+  def setup
+    options = YAML.load_file('test/data/project/config.yml')
+    @config = Bookery::Config.new('es', options['book'])
+  end
+  def test_language_specific_keys_override_globals
+    assert_equal 'El libro Testing', @config.title
+  end
+  def test_global_values_returns_when_languages_specifics_not_found
+    assert_equal 2, @config.authors.size
+  end
+  def test_can_retrieve_values_like_hashes
+    assert_equal @config.title, @config[:title]
+  end
+  def test_method_missing_bubbles_to_super
+    assert_raises(NoMethodError) do
+      @config.invalid_meta_method
+    end
+  end
+end

data/test/bookery/factories/chapter_factory_test.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'test_helper'
+class ChapterFactoryTest < Minitest::Test
+  def setup
+    book_dir = 'test/data/project/book/en'
+    @chapters = Bookery::Factories::ChapterFactory.create_chapters(book_dir)
+  end
+  def test_create_chapters_loads_each_chapter
+    assert_equal 2, @chapters.size
+  end
+  def test_each_chapter_loads_chapter_files
+    expected = [
+      '# The Second Chapter',
+      '# Another File in Chapter 2'
+    ]
+    expected.each do |string|
+      assert_includes @chapters.last.content, string
+    end
+  end
+end

data/test/bookery/factories/publisher_factory_test.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require 'test_helper'
+class PublisherFactoryTest < Minitest::Test
+  def setup
+    @options = {
+      enable_coderay: false,
+      project_dir: './',
+      template: 'test/data/project/assets/template/template.html.erb'
+    }
+  end
+  def test_create_publishers
+    refute_equal 0, Bookery::Factories::PublisherFactory.create_publishers(@options)
+  end
+end

data/test/bookery/processor/include_processor_test.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'test_helper'
+class IncludeProcessorTest < Minitest::Test
+  def setup
+    @processor = Bookery::Processors::IncludeProcessor.new('./')
+    File.stubs('read').with('./js/file.js').returns('function someThing() {}')
+    File.stubs('read').with('./ruby/chapter2.rb').returns('def some_method; end')
+  end
+  def test_replaces_includes_with_file_content
+    input = <<-EOF
+    ```javascript
+    includes::js/file.js
+    ```
+    EOF
+    output = @processor.process(input)
+    assert_includes output, 'function someThing() {}'
+  end
+  def test_supports_multiple_includes
+    input = <<-EOF
+    ```javascript
+    includes::js/file.js
+    ```
+    ```ruby
+    includes::ruby/chapter2.rb
+    ```
+    EOF
+    output = @processor.process(input)
+    assert_includes output, 'function someThing() {}'
+    assert_includes output, 'def some_method'
+  end
+end

data/test/bookery/project_test.rb ADDED Viewed

@@ -0,0 +1,37 @@
+require 'test_helper'
+class ProjectTest < Minitest::Test
+  def setup
+    config = YAML.load_file('test/data/project/config.yml').symbolize_keys
+    @project = Bookery::Project.new('test/data/project', config)
+  end
+  def test_book_config
+    refute_empty @project.book_config[:title]
+  end
+  def test_generator_config
+    refute_empty @project.generator_config[:input]
+    assert_equal @project.dir, @project.generator_config[:project_dir]
+  end
+  def test_books_returns_a_book_for_each_language
+    assert_equal 2, @project.books.size
+  end
+  def test_publish_sends_each_book_to_each_publisher
+    books = @project.books
+    publishers = [mock(), mock()]
+    publishers.each { |pub| pub.expects(:publish).twice }
+    @project.stubs(:prepare_output_dir)
+    @project.publish(publishers)
+  end
+  def test_assets_return_without_includes_and_templates
+    assert_equal 2, @project.assets.size
+    assert_equal 'test/data/project/assets/images/cover.png', @project.assets.first
+    assert_equal 'test/data/project/assets/style.css', @project.assets.last
+  end
+end

data/test/bookery/publishers/html_publisher_test.rb ADDED Viewed

@@ -0,0 +1,78 @@
+require 'test_helper'
+class HTMLPublisherTest < Minitest::Test
+  def setup
+    @publisher = Bookery::Publishers::HTMLPublisher.new({
+      project_dir: 'test/data/project'
+    })
+    FileUtils.stubs(:mkdir_p)
+    File.stubs(:write)
+  end
+  def with_stubbed_book(content)
+    book = OpenStruct.new({
+      content: content,
+      title: 'Some Title',
+      authors: [],
+      editors: [],
+      language: 'en',
+      template: 'test/data/project/assets/templates/template.html.erb'
+    })
+    yield(book)
+  end
+  def test_publish_renders_html_from_markdown
+    with_stubbed_book('# Introduction') do |book|
+      expected = '<h1 id="introduction">Introduction</h1>'
+      assert_includes @publisher.publish(book), expected
+    end
+  end
+  def test_publish_ignores_intra_emphasis
+    with_stubbed_book('_some_method_def_') do |book|
+      expected = '<p><em>some_method_def</em></p>'
+      assert_includes @publisher.publish(book), expected
+    end
+  end
+  def test_publish_uses_pre_tags_for_standard_code_blocks
+    content = <<-EOF
+    def some_method(with, *params)
+      # Do Something
+    end
+    EOF
+    with_stubbed_book(content) do |book|
+      assert_includes @publisher.publish(book), '<pre><code>'
+    end
+  end
+  def test_publish_uses_coderay_for_fenced_code_blocks
+    content = <<-EOF
+```ruby
+def some_method(with, *params)
+  # Do Something
+end
+```
+    EOF
+    with_stubbed_book(content) do |book|
+      assert_includes @publisher.publish(book), '<div class="CodeRay">'
+    end
+  end
+  def test_publish_supports_includes
+    content = <<-EOF
+```ruby
+includes::ruby/chapter2.rb
+```
+    EOF
+    with_stubbed_book(content) do |book|
+      assert_includes @publisher.publish(book), 'some_included_method'
+    end
+  end
+end

data/test/data/project/Gemfile.tt ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ source 'https://rubygems.org'
2	+ gem 'bookery'

data/{templates/book/book/.empty_directory → test/data/project/assets/images/cover.png} RENAMED Viewed

File without changes

data/test/data/project/assets/includes/ruby/chapter2.rb ADDED Viewed

@@ -0,0 +1,3 @@
+def some_included_method(with, *args)
+  # Will eventually do something here
+end

data/test/data/project/assets/style.css ADDED Viewed

	@@ -0,0 +1 @@
1	+ /stylesheet for book/

data/test/data/project/assets/templates/template.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="<%= language %>">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <title><%= title %></title>
+  <meta name="author" content="<%= authors %>">
+  <meta name="description" content="<%= title %>">
+  <meta name="generator" content="bookery">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+</head>
+<body>
+  <%= body %>
+</body>
+</html>

data/test/data/project/book/en/001-first-chapter/01-chapter-file.md ADDED Viewed

@@ -0,0 +1,9 @@
+# The First Chapter
+Checkout some ruby code...
+```ruby
+def some_method_name(with, *args)
+  does_something(with, args)
+end
+```