kitabu 1.0.6 → 2.0.0

data/examples/RailsGuides/text/10_Building_a_multi_model_form.mkdn

@@ -1,130 +0,0 @@
-## Building a Multi-Model Form
-
-Another feature of your average blog is the ability to tag posts. To implement this feature your application needs to interact with more than one model on a single form. Rails offers support for nested forms.
-
-To demonstrate this, we will add support for giving each post multiple tags, right in the form where you create the post. First, create a new model to hold the tags:
-
-	$ rails generate model tag name:string post:references
-
-Again, run the migration to create the database table:
-
-	$ rake db:migrate
-
-Next, edit the `post.rb` file to create the other side of the association, and to tell Rails (via the `accepts_nested_attributes_for` macro) that you intend to edit tags via posts:
-
-@@@ ruby
-class Post < ActiveRecord::Base
-  validates :name,  :presence => true
-  validates :title, :presence => true,
-                    :length => { :minimum => 5 }
-
-  has_many :comments, :dependent => :destroy
-  has_many :tags
-
-  accepts_nested_attributes_for :tags, :allow_destroy => :true,
-    :reject_if => proc { |attrs| attrs.all? { |k, v| v.blank? } }
-end
-@@@
-
-The `:allow_destroy` option on the nested attribute declaration tells Rails to display a “remove” checkbox on the view that you’ll build shortly. The `:reject_if` option prevents saving new tags that do not have any attributes filled in.
-
-We will modify `views/posts/_form.html.erb` to render a partial to make a tag:
-
-@@@ html
-<% @post.tags.build %>
-<%= form_for(@post) do |post_form| %>
-  <% if @post.errors.any? %>
-  <div id="errorExplanation">
-    <h2><%= pluralize(@post.errors.count, "error") %> prohibited this post from being saved:</h2>
-    <ul>
-    <% @post.errors.full_messages.each do |msg| %>
-      <li><%= msg %></li>
-    <% end %>
-    </ul>
-  </div>
-  <% end %>
-
-  <div class="field">
-    <%= post_form.label :name %><br />
-    <%= post_form.text_field :name %>
-  </div>
-  <div class="field">
-    <%= post_form.label :title %><br />
-    <%= post_form.text_field :title %>
-  </div>
-  <div class="field">
-    <%= post_form.label :content %><br />
-    <%= post_form.text_area :content %>
-  </div>
-  <h2>Tags</h2>
-  <%= render :partial => 'tags/form',
-             :locals => {:form => post_form} %>
-  <div class="actions">
-    <%= post_form.submit %>
-  </div>
-<% end %>
-@@@
-
-Note that we have changed the `f in form_for(@post) do |f|` to `post_form` to make it easier to understand what is going on.
-
-This example shows another option of the render helper, being able to pass in local variables, in this case, we want the local variable `form` in the partial to refer to the `post_form` object.
-
-We also add a `@post.tags.build` at the top of this form, this is to make sure there is a new tag ready to have it’s name filled in by the user. If you do not build the new tag, then the form will not appear as there is no new Tag object ready to create.
-
-Now create the folder `app/views/tags` and make a file in there called `_form.html.erb` which contains the form for the tag:
-
-@@@ html
-<%= form.fields_for :tags do |tag_form| %>
-  <div class="field">
-    <%= tag_form.label :name, 'Tag:' %>
-    <%= tag_form.text_field :name %>
-  </div>
-  <% unless tag_form.object.nil? || tag_form.object.new_record? %>
-    <div class="field">
-      <%= tag_form.label :_destroy, 'Remove:' %>
-      <%= tag_form.check_box :_destroy %>
-    </div>
-  <% end %>
-<% end %>
-@@@
-
-Finally, we will edit the `app/views/posts/show.html.erb` template to show our tags.
-
-@@@ html
-<p class="notice"><%= notice %></p>
-
-<p>
-  <b>Name:</b>
-  <%= @post.name %>
-</p>
-
-<p>
-  <b>Title:</b>
-  <%= @post.title %>
-</p>
-
-<p>
-  <b>Content:</b>
-  <%= @post.content %>
-</p>
-
-<p>
-  <b>Tags:</b>
-  <%= @post.tags.map { |t| t.name }.join(", ") %>
-</p>
-
-<h2>Comments</h2>
-<%= render :partial => "comments/comment",
-           :collection => @post.comments %>
-
-<h2>Add a comment:</h2>
-<%= render "comments/form" %>
-
-
-<%= link_to 'Edit Post', edit_post_path(@post) %> |
-<%= link_to 'Back to Posts', posts_path %> |
-@@@
-
-With these changes in place, you’ll find that you can edit a post and its tags directly on the same view.
-
-However, that method call `@post.tags.map { |t| t.name }.join(", ")` is awkward, we could handle this by making a helper method.

data/examples/RailsGuides/text/11_View_helpers.mkdn

@@ -1,50 +0,0 @@
-## View Helpers
-
-View Helpers live in `app/helpers` and provide small snippets of reusable code for views. In our case, we want a method that strings a bunch of objects together using their name attribute and joining them with a comma. As this is for the Post show template, we put it in the `PostsHelper`.
-
-Open up `app/helpers/posts_helper.rb` and add the following:
-
-@@@ ruby
-module PostsHelper
-  def join_tags(post)
-    post.tags.map { |t| t.name }.join(", ")
-  end
-end
-@@@
-
-Now you can edit the view in `app/views/posts/show.html.erb` to look like this:
-
-@@@ html
-<p class="notice"><%= notice %></p>
-
-<p>
-  <b>Name:</b>
-  <%= @post.name %>
-</p>
-
-<p>
-  <b>Title:</b>
-  <%= @post.title %>
-</p>
-
-<p>
-  <b>Content:</b>
-  <%= @post.content %>
-</p>
-
-<p>
-  <b>Tags:</b>
-  <%= join_tags(@post) %>
-</p>
-
-<h2>Comments</h2>
-<%= render :partial => "comments/comment",
-           :collection => @post.comments %>
-
-<h2>Add a comment:</h2>
-<%= render "comments/form" %>
-
-
-<%= link_to 'Edit Post', edit_post_path(@post) %> |
-<%= link_to 'Back to Posts', posts_path %> |
-@@@

data/examples/RailsGuides/text/12_Whats_next.mkdn

@@ -1,14 +0,0 @@
-## What’s Next?
-
-Now that you’ve seen your first Rails application, you should feel free to update it and experiment on your own. But you don’t have to do everything without help. As you need assistance getting up and running with Rails, feel free to consult these support resources:
-
-* The [Ruby on Rails guides](http://guides.rubyonrails.org/index.html)
-* The [Ruby on Rails Tutorial](http://railstutorial.org/book)
-* The [Ruby on Rails mailing list](http://groups.google.com/group/rubyonrails-talk)
-* The [#rubyonrails](irc://irc.freenode.net/#rubyonrails) channel on irc.freenode.net
-* The [Rails Wiki](http://wiki.rubyonrails.org/)
-
-Rails also comes with built-in help that you can generate using the rake command-line utility:
-
-* Running `rake doc:guides` will put a full copy of the Rails Guides in the `doc/guides` folder of your application. Open `doc/guides/index.html` in your web browser to explore the Guides.
-* Running `rake doc:rails` will put a full copy of the API documentation for Rails in the `doc/api` folder of your application. Open `doc/api/index.html` in your web browser to explore the API documentation.

data/examples/RailsGuides/text/13_Configuration_gotchas.mkdn

@@ -1,10 +0,0 @@
-## Configuration Gotchas
-
-The easiest way to work with Rails is to store all external data as UTF-8. If you don’t, Ruby libraries and Rails will often be able to convert your native data into UTF-8, but this doesn’t always work reliably, so you’re better off ensuring that all external data is UTF-8.
-
-If you have made a mistake in this area, the most common symptom is a black diamond with a question mark inside appearing in the browser. Another common symptom is characters like “ü” appearing instead of “ü”. Rails takes a number of internal steps to mitigate common causes of these problems that can be automatically detected and corrected. However, if you have external data that is not stored as UTF-8, it can occasionally result in these kinds of issues that cannot be automatically detected by Rails and corrected.
-
-Two very common sources of data that are not UTF-8:
-
-* Your text editor: Most text editors (such as Textmate), default to saving files as UTF-8. If your text editor does not, this can result in special characters that you enter in your templates (such as é) to appear as a diamond with a question mark inside in the browser. This also applies to your I18N translation files. Most editors that do not already default to UTF-8 (such as some versions of Dreamweaver) offer a way to change the default to UTF-8. Do so.
-* Your database. Rails defaults to converting data from your database into UTF-8 at the boundary. However, if your database is not using UTF-8 internally, it may not be able to store all characters that your users enter. For instance, if your database is using Latin-1 internally, and your user enters a Russian, Hebrew, or Japanese character, the data will be lost forever once it enters the database. If possible, use UTF-8 as the internal storage of your database.

data/lib/kitabu/adapters/markdown.rb

@@ -1,34 +0,0 @@
-module Kitabu
-  class Markdown
-    # Supported Markdown libraries
-    #
-    MARKDOWN_LIBRARIES = %w[Maruku BlueCloth PEGMarkdown Redcarpet RDiscount]
-
-    # Retrieve preferred Markdown processor.
-    # You'll need one of the following libraries:
-    #
-    # # RDiscount: https://rubygems.org/gems/rdiscount
-    # # Maruku: https://rubygems.org/gems/maruku
-    # # PEGMarkdown: https://rubygems.org/gems/rpeg-markdown
-    # # BlueCloth: https://rubygems.org/gems/bluecloth
-    # # Redcarpet: https://rubygems.org/gems/redcarpet
-    #
-    # Note: RDiscount will always be installed as Kitabu's dependency but only used when no
-    # alternative library is available.
-    #
-    def self.engine
-      @engine ||= Object.const_get(MARKDOWN_LIBRARIES.find {|lib| Object.const_defined?(lib)})
-    end
-
-    # Convert Markdown to HTML.
-    def self.to_html(content)
-      case engine.name
-      when "Redcarpet"
-        render = Redcarpet::Render::HTML.new(:hard_wrap => true, :xhtml => true)
-        Redcarpet::Markdown.new(render).render(content)
-      else
-        engine.new(content).to_html
-      end
-    end
-  end
-end

data/lib/kitabu/extensions/redcloth.rb

@@ -1,69 +0,0 @@
-module RedCloth
-  INLINE_FORMATTERS = [:textile, :footnote, :link]
-
-  def self.convert(text)
-    new(text).to_html(*INLINE_FORMATTERS)
-  end
-
-  module Inline
-    FN_RE = /
-      (\s+)?     # getting spaces
-      (\\)?%\{   # opening
-      (.*?)      # footnote
-      \}#        # closing
-    /xm
-
-    def footnote(text)
-      text.gsub!(FN_RE) do |m|
-        if $2
-          %[#{$1}%{#{$3}}]
-        else
-          %(<span class="footnote">#{$3}</span>)
-        end
-      end
-    end
-
-    LINK_RE = /
-      <
-      ((?:https?|ftp):\/\/.*?)
-      >
-    /xm
-
-    def link(text)
-      text.gsub!(LINK_RE) do |m|
-        %(<a href="#{$1}">#{$1}</a>)
-      end
-    end
-  end
-
-  module Formatters
-    module HTML
-      def figure(options = {})
-        %[<p class="figure"><img src="../images/#{options[:text]}" alt="#{options[:class]}" /><br/><span class="caption">#{options[:class]}</span></p>]
-      end
-
-      def note(options = {})
-        %[<p class="note">#{options[:text]}</p>]
-      end
-
-      def attention(options = {})
-        %[<p class="attention">#{options[:text]}</p>]
-      end
-
-      def file(options = {})
-        base_url = Kitabu.config[:base_url]
-
-        if base_url
-          url = File.join(base_url, options[:text])
-        else
-          url = content
-          $stderr << "\nYou're using `file. #{content}` but didn't set base_url in your configuration file.\n"
-        end
-
-        %[<p class="file"><span><strong>Download</strong> <a href="#{url}">#{options[:text]}</a></span></p>]
-      end
-    end
-  end
-end
-
-RedCloth.send(:include, RedCloth::Inline)

data/lib/kitabu/syntax.rb

@@ -1,130 +0,0 @@
-module Kitabu
-  class Syntax
-    autoload :Highlight, "kitabu/syntax/highlight"
-
-    attr_reader :io
-    attr_reader :lines
-    attr_reader :root_dir
-    attr_reader :format
-
-    # Render syntax blocks from specified source code.
-    #
-    #   dir = Pathname.new(File.dirname(__FILE__))
-    #   text = File.read(dir.join("text/some_file.textile"))
-    #   Kitabu::Syntax.render(dir, :textile, text)
-    #
-    def self.render(root_dir, format, source_code, raw = false)
-      source_code.gsub(/@@@(.*?)@@@/m) do |match|
-        new(root_dir, format, $1, raw).process
-      end
-    end
-
-    # Process each syntax block individually.
-    #
-    def initialize(root_dir, format, code, raw = false)
-      @format = format
-      @root_dir = root_dir
-      @io = StringIO.new(code)
-      @lines = io.readlines.collect(&:chomp)
-      @language = 'text' if raw
-    end
-
-    # Return unprocessed line codes.
-    #
-    def raw
-      lines[1..-1].join("\n")
-    end
-
-    # Return meta data from syntax annotation.
-    #
-    def meta
-      @meta ||= begin
-        line = lines.first.squish
-        _, language, file, modifier, reference = *line.match(/^([^ ]+)(?: ([^:#]+)(?:(:|#)(.*?))?)?$/)
-
-        if modifier == "#"
-          type = :block
-        elsif modifier == ":"
-          type = :range
-        elsif file
-          type = :file
-        else
-          type = :inline
-        end
-
-        {
-          :language  => language,
-          :file      => file,
-          :type      => type,
-          :reference => reference
-        }
-      end
-    end
-
-    # Process syntax block, returning a +pre+ HTML tag.
-    #
-    def process
-      code = raw.to_s.strip_heredoc
-      code = process_file.gsub(/\n^.*?@(begin|end):.*?$/, "") if meta[:file]
-
-      code = Highlight.apply(code, language)
-
-      # escape for textile
-      code = %[<notextile>#{code}</notextile>] if format == :textile
-      code
-    end
-
-    private
-    # Process line range as in <tt>@@@ ruby some_file.rb:15,20 @@@</tt>.
-    #
-    def process_range(code)
-      starts, ends = meta[:reference].split(",").collect(&:to_i)
-      code = StringIO.new(code).readlines[starts-1..ends-1].join("\n").strip_heredoc.chomp
-    end
-
-    # Process block name as in <tt>@@@ ruby some_file.rb#some_block @@@</tt>.
-    #
-    def process_block(code)
-      code.gsub!(/\r\n/, "\n")
-      re = %r[@begin: *\b(#{meta[:reference]})\b *[^\n]*\n(.*?)\n[^\n]*@end: \1]im
-
-      if code.match(re)
-        $2.strip_heredoc
-      else
-        "[missing '#{meta[:reference]}' block name]"
-      end
-    end
-
-    # Process file and its relatives.
-    #
-    def process_file
-      file_path = root_dir.join("code/#{meta[:file]}")
-
-      if File.exist?(file_path)
-        code = File.read(file_path)
-
-        if meta[:type] == :range
-          process_range(code)
-        elsif meta[:type] == :block
-          process_block(code)
-        else
-          code
-        end
-      else
-        "[missing 'code/#{meta[:file]}' file]"
-      end
-    end
-
-    # Return e-book's configuration.
-    #
-    def config
-      Kitabu.config(root_dir)
-    end
-
-    # Return the language used for this syntax block. Overrideable
-    # for epub generation.
-    def language
-      @language || meta[:language]
-    end
-  end
-end

data/spec/kitabu/extensions/redcloth_spec.rb

@@ -1,57 +0,0 @@
-require "spec_helper"
-
-describe RedCloth do
-  describe "#figure" do
-    it "renders html" do
-      html = RedCloth.convert("figure(The Rails logo). rails.png")
-      expect(html).to have_tag("p.figure") do |p|
-        expect(p).to have_tag("img[@src='../images/rails.png'][@alt='The Rails logo']")
-        expect(p).to have_tag("span.caption", "The Rails logo")
-      end
-    end
-  end
-
-  describe "#note" do
-    it "renders html" do
-      html = RedCloth.convert("note. Some important note!")
-      expect(html).to have_tag("p.note", "Some important note!")
-    end
-  end
-
-  describe "#attention" do
-    it "renders html" do
-      html = RedCloth.convert("attention. Some warning note!")
-      expect(html).to have_tag("p.attention", "Some warning note!")
-    end
-  end
-
-  describe "#file" do
-    it "renders html" do
-      allow(Kitabu).to receive_message_chain(:config).and_return(base_url: "http://example.com")
-      html = RedCloth.convert("file. app/models/users.rb")
-
-      expect(html).to have_tag("p.file") do |p|
-        expect(p).to have_tag("a[@href='http://example.com/app/models/users.rb']", "app/models/users.rb")
-      end
-    end
-  end
-
-  context "custom footnote helper" do
-    it "renders html" do
-      html = RedCloth.convert("Writing some text with a footnote %{this is a footnote}")
-      expect(html).to eq(%[<p>Writing some text with a footnote<span class="footnote">this is a footnote</span></p>])
-    end
-
-    it "ignores escaped notations" do
-      html = RedCloth.convert("It must skip \\%{this}")
-      expect(html).to eq(%[<p>It must skip %{this}</p>])
-    end
-  end
-
-  context "custom url helper" do
-    it "renders html" do
-      html = RedCloth.convert("<http://example.com>")
-      expect(html).to eq(%[<p><a href="http://example.com">http://example.com</a></p>])
-    end
-  end
-end