rpub 0.4.0 → 0.5.0

data/lib/rpub/commander.rb

@@ -1,23 +0,0 @@
-module Rpub
-  # The +Commander+ module is responsible for invoking `Command` objects. This is
-  # the internal part of the library that is used by the CLI.
-  #
-  # The +Commander+ takes a list of arguments, which would typically come from the CLI,
-  # and tries to look up a +Command+ class. If it cannot find anything, it will invoke
-  # the {Rpub::Commands::Main} command.
-  #
-  # @see Rpub::Commands::Base
-  # @see Rpub::Commands
-  module Commander
-    def invoke(args = [])
-      subcommand, *options = args
-      Commands::Base.matching(subcommand).new(options).invoke
-    rescue SubclassTracker::NoSuchSubclass
-      Commands::Main.new(args).invoke
-    rescue NoConfiguration
-      abort 'The current directory does not look like an rpub project.'
-    end
-
-    extend self
-  end
-end

data/lib/rpub/commands/base.rb

@@ -1,33 +0,0 @@
-module Rpub
-  module Commands
-    class Base
-      extend SubclassTracker
-
-      attr_reader :options
-
-      def initialize(options = [], stdout = $stdout)
-        @options, @stdout = options, stdout
-      end
-
-      def invoke
-        parser.parse!(options)
-      end
-
-      def help
-        puts parser
-      end
-
-    protected
-
-      def parser
-        OptionParser.new
-      end
-
-    private
-
-      def puts(*args)
-        @stdout.puts(*args)
-      end
-    end
-  end
-end

data/lib/rpub/commands/help.rb

@@ -1,37 +0,0 @@
-module Rpub
-  module Commands
-    class Help < Base
-      identifier 'help'
-
-      def invoke
-        if options.empty?
-          Main.new.invoke
-        else
-          Base.matching(options.shift).new.help
-        end
-      end
-
-    private
-
-      def parser
-        OptionParser.new do |opts|
-          opts.banner = <<-EOS
-Usage: rpub help subcommand
-
-Describe the usage and options for rpub subcommands.
-
-Options:
-EOS
-          opts.separator ''
-          opts.separator 'Generic options:'
-          opts.separator ''
-
-          opts.on_tail '-h', '--help', 'Display this message' do
-            puts opts
-            exit
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rpub/commands/main.rb

@@ -1,45 +0,0 @@
-module Rpub
-  module Commands
-    class Main < Base
-
-      def invoke
-        options << '-h' if options.empty?
-        super
-        raise InvalidSubcommand, options[0] unless options.empty?
-      end
-
-    protected
-
-      def parser
-        OptionParser.new do |opts|
-          opts.banner = <<-EOS
-Usage: rpub [subcommand] [options]
-
-Compile multiple Markdown-formatted input files into a machine-readable epub
-file for distribution as an ebook.
-
-Available subcommands:
-
-  compile
-  preview
-  clean
-  package
-  help
-EOS
-
-          opts.separator ''
-          opts.separator 'Generic options:'
-          opts.separator ''
-
-          opts.on_tail '-v', '--version', 'Display version information' do
-            puts "rpub #{Rpub::VERSION}"
-          end
-
-          opts.on_tail '-h', '--help', 'Display command reference' do
-            puts opts
-          end
-        end
-      end
-    end
-  end
-end

data/lib/rpub/compilation_helpers.rb

@@ -1,73 +0,0 @@
-module Rpub
-  # Provide a set of helper methods that are used across various commands to
-  # simplify the compilation process. These methods mostly deal with loading files
-  # from the current project directory.
-  module CompilationHelpers
-
-    def concatenated_document
-      Kramdown::Document.new(
-        markdown_files.join("\n"),
-        KRAMDOWN_OPTIONS.merge(:template => layout)
-      )
-    end
-
-    # Factory method for {Rpub::Book} objects, loading every markdown file as a
-    # chapter.
-    #
-    # @see #markdown_files
-    # @return [Rpub::Book]
-    def create_book
-      book = Book.new(layout, config, fonts)
-      markdown_files.each(&book.method(:<<))
-      book
-    end
-
-    # All chapter input files loaded into strings. This does not include any of
-    # the files listed in the +ignore+ configuration key.
-    #
-    # @return [Array<String>]
-    def markdown_files
-      @markdown_files ||= filter_exceptions(Dir['*.md']).sort.map(&File.method(:read))
-    end
-
-    # @return [String] path to the current layout file (defaulting to built-in)
-    def layout
-      @layout ||= own_or_support_file('layout.html')
-    end
-
-    # @return [String] path to the current stylesheet file (defaulting to built-in)
-    def styles
-      @styles ||= own_or_support_file('styles.css')
-    end
-
-    # Load the contents of +config.yml+ into a +Hash+ object.
-    #
-    # @raise [NoConfiguration] when the config file cannot be found.
-    # @return [Hash] parsed configuration
-    def config
-      @config_file ||= begin
-        raise NoConfiguration unless File.exist?('config.yml')
-        YAML.load_file('config.yml') || {}
-      end
-    end
-
-  private
-
-    def fonts
-      @fonts ||= File.read(styles).scan(/url\((?:'|")?([^'")]+\.otf)(?:'|")?\)/i).flatten
-    end
-
-    def filter_exceptions(filenames)
-      return filenames unless config.has_key?('ignore')
-      filenames.reject(&config['ignore'].method(:include?))
-    end
-
-    def own_or_support_file(filename)
-      if File.exists?(filename)
-        filename
-      else
-        Rpub.support_file(filename)
-      end
-    end
-  end
-end

data/lib/rpub/subclass_tracker.rb

@@ -1,53 +0,0 @@
-module Rpub
-  # Add tracking of subclasses to an existing class by extending it with
-  # SubclassTracker.
-  #
-  # This allows you to set an identifier in a subclass using the +identifier+
-  # macro, and find subclasses based on that value.
-  #
-  # Example:
-  #
-  #     class ParentClass
-  #       extend SubclassTracker
-  #     end
-  #
-  #     class ChildClass < ParentClass
-  #       identifier 'foo'
-  #     end
-  #
-  #     ParentClass.matching('foo') # => ChildClass
-  #     ParentClass.matching('bar') # => raises SubclassTracker::NoSuchSubclass
-  #
-  # Note that you don't HAVE to set an identifier. If you don't, your child
-  # class will never be found by +#matching+.
-  module SubclassTracker
-    class NoSuchSubclass < StandardError
-      def initialize(subcommand)
-        super "Unrecognized identifier: #{subcommand}"
-      end
-    end
-
-    # Set or return the identifier for this class.
-    def identifier(id = nil)
-      return @identifier if id.nil?
-      @identifier = id
-    end
-
-    def inherited(child)
-      @subclasses ||= []
-      @subclasses << child
-      super
-    end
-
-    def each
-      @subclasses ||= []
-      @subclasses.each { |subclass| yield subclass }
-    end
-
-    def matching(identifier)
-      find { |subclass| subclass.identifier === identifier } or raise NoSuchSubclass, identifier
-    end
-
-    include Enumerable
-  end
-end

data/spec/rpub/commands/clean_spec.rb

@@ -1,46 +0,0 @@
-require 'spec_helper'
-
-describe Rpub::Commands::Clean do
-  before do
-    Dir.chdir File.join(FIXTURES_DIRECTORY, 'clean')
-  end
-
-  after do
-    FileUtils.touch 'preview.html'
-    FileUtils.touch 'example.epub'
-  end
-
-  it 'should remove example.epub file' do
-    expect {
-      described_class.new.invoke
-    }.to remove_file('example.epub')
-  end
-
-  it 'should remove preview.html file' do
-    expect {
-      described_class.new.invoke
-    }.to remove_file('preview.html')
-  end
-
-  context 'when in dry run mode' do
-    let(:buffer) { StringIO.new }
-    let(:subject) { described_class.new(['-d'], buffer) }
-
-    it 'should print preview.html' do
-      subject.invoke
-      buffer.string.should include('preview.html')
-    end
-
-    it 'should not print non-existant files' do
-      FileUtils.rm 'preview.html'
-      subject.invoke
-      buffer.string.should_not include('preview.html')
-    end
-
-    it 'should not remove existing files' do
-      expect {
-        subject.invoke
-      }.to_not remove_file('preview.html')
-    end
-  end
-end

data/spec/rpub/commands/generate_spec.rb

@@ -1,52 +0,0 @@
-require 'spec_helper'
-
-describe Rpub::Commands::Generate do
-  let(:buffer) { StringIO.new }
-  before do
-    Dir.chdir File.join(FIXTURES_DIRECTORY, 'generate')
-  end
-
-  after do
-    File.unlink 'styles.css' if File.exist?('styles.css')
-    File.unlink 'layout.html' if File.exist?('layout.html')
-    File.unlink 'config.yml' if File.exist?('config.yml')
-  end
-
-  context 'given a specific option' do
-    let(:subject) { described_class.new(['--config'], buffer) }
-
-    it 'should generate one file' do
-      expect(&subject.method(:invoke)).to create_file('config.yml')
-    end
-
-    it 'should not generate stylesheet' do
-      expect(&subject.method(:invoke)).to_not create_file('layout.html', 'styles.css')
-    end
-  end
-
-  context 'given a no option' do
-    let(:subject) { described_class.new(['--no-styles'], buffer) }
-
-    it 'should generate two files' do
-      expect(&subject.method(:invoke)).to create_file('layout.html', 'config.yml')
-    end
-
-    it 'should not generate stylesheet' do
-      expect(&subject.method(:invoke)).to_not create_file('styles.css')
-    end
-  end
-
-  context 'given no options' do
-    let(:subject) { described_class.new([], buffer) }
-
-    it 'should generate three files' do
-      expect(&subject.method(:invoke)).to create_file('styles.css', 'layout.html', 'config.yml')
-    end
-
-    it 'should not generate existing files' do
-      File.open('styles.css', 'w') { |f| f.write 'foo' }
-      expect(&subject.method(:invoke)).to_not change { File.read('styles.css') }
-      buffer.string.should include('Not overriding styles.css')
-    end
-  end
-end

data/spec/rpub/commands/main_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-describe Rpub::Commands::Main do
-  let(:buffer) { StringIO.new }
-
-  it 'should default to help text' do
-    described_class.new([], buffer).invoke
-    buffer.string.should =~ /Display command reference/
-  end
-
-  it 'should raise error when a subcommand remains' do
-    expect {
-      described_class.new(['foo'], buffer).invoke
-    }.should raise_error(Rpub::InvalidSubcommand)
-  end
-
-  it 'should print the version number' do
-    described_class.new(['-v'], buffer).invoke
-    buffer.string.should =~ /rpub \d+\.\d+\.\d+/
-  end
-
-  it 'should print help text' do
-    described_class.new(['-h'], buffer).invoke
-    buffer.string.should =~ /Display command reference/
-  end
-end

data/spec/rpub/commands/package_spec.rb

@@ -1,33 +0,0 @@
-require 'spec_helper'
-
-describe Rpub::Commands::Package do
-  before do
-    Dir.chdir File.join(FIXTURES_DIRECTORY, 'package')
-  end
-
-  after do
-    File.unlink('package.zip') if File.exist?('package.zip')
-    File.unlink('untitled-book-0.0.0.epub') if File.exist?('untitled-book-0.0.0.epub')
-  end
-
-  it 'should generate an archive' do
-    expect(&subject.method(:invoke)).to create_file('package.zip')
-  end
-
-  context 'archive file' do
-    before { described_class.new.invoke }
-
-    let(:subject) do
-      [].tap do |files|
-        Zip::ZipInputStream.open('package.zip') do |io|
-          while entry = io.get_next_entry
-            files << entry.name
-          end
-        end
-      end
-    end
-
-    it { should include('README.md') }
-    it { should include('untitled-book-0.0.0.epub') }
-  end
-end

data/spec/rpub/commands/preview_spec.rb

@@ -1,43 +0,0 @@
-require 'spec_helper'
-
-describe Rpub::Commands::Preview do
-  before do
-    Dir.chdir File.join(FIXTURES_DIRECTORY, 'preview')
-  end
-
-  after do
-    File.unlink 'preview.html' if File.exist?('preview.html')
-    File.unlink 'foo.bar' if File.exist?('foo.bar')
-  end
-
-  context 'generated content' do
-    before { Rpub::Commands::Preview.new.invoke }
-    let(:subject) { File.read('preview.html') }
-
-    it { should include('<p>foo</p>') }
-    it { should include('<p>bar</p>') }
-    it { should match(/foo.*bar/m) }
-    it { should match(/<head>/) }
-    it { should match(/<style>/) }
-  end
-
-  it 'should create new preview file' do
-    expect {
-      Rpub::Commands::Preview.new.invoke
-    }.to create_file('preview.html')
-  end
-
-  it 'should do nothing when there are no files to preview' do
-    Dir.chdir File.join(FIXTURES_DIRECTORY, 'no_files')
-    expect {
-      Rpub::Commands::Preview.new.invoke
-    }.to_not create_file('preview.html')
-  end
-
-  it 'should allow overriding the filename' do
-    expect {
-      Rpub::Commands::Preview.new(['-o', 'foo.bar']).invoke
-    }.to create_file('foo.bar')
-  end
-
-end