transmuter 0.0.0.1 → 0.0.1

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+*.html
+*.pdf

data/.travis.yml

@@ -0,0 +1,8 @@
+script: "rake spec"
+env: JRUBY_OPTS="--1.9"
+rvm:
+  - 1.9.2
+  - 1.9.3
+notifications:
+  recipients:
+    - wael.nasreddine@gmail.com

data/Gemfile

@@ -2,3 +2,20 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in transmuter.gemspec
 gemspec
+
+platforms :ruby do
+  # Require rbconfig to figure out the target OS
+  require 'rbconfig'
+
+  unless ENV['TRAVIS']
+    if RbConfig::CONFIG['target_os'] =~ /darwin/i
+      gem 'rb-fsevent', require: false
+      gem 'ruby-growl', require: false
+      gem 'growl', require: false
+    end
+    if RbConfig::CONFIG['target_os'] =~ /linux/i
+      gem 'rb-inotify', require: false
+      gem 'libnotify', require: false
+    end
+  end
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,4 +1,4 @@
-# Transmuter
+# Transmuter [![Build Status](http://travis-ci.org/TechnoGate/transmuter.png)](http://travis-ci.org/TechnoGate/transmuter)
 
 Transmuter is a command line tool to convert Markdown files into HTML or PDF
 files, it can also be used to convert HTML files to PDF, it uses in the
@@ -6,6 +6,8 @@ backgound [Redcarper](https://github.com/tanoku/redcarpet),
 [Albino](https://github.com/github/albino) and
 [PDFkit](https://github.com/jdpace/PDFKit).
 
+<a href='http://www.pledgie.com/campaigns/16086'><img alt='Click here to lend your support to: Transmuter and make a donation at www.pledgie.com !' src='http://www.pledgie.com/campaigns/16086.png?skin_name=chrome' border='0' /></a>
+
 # Installation
 
 To install Transmuter use the command
@@ -35,3 +37,35 @@ $ sudo easy_install pygments
 2.  Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
         gem install wkhtmltopdf-binary
+
+# Usage
+
+You should check the help
+
+```bash
+$ transmute --help
+```
+
+To Generate a PDF from a markdown file with the default CSS:
+
+```bash
+$ transmute file.md
+```
+
+To Generate an HTML from a markdown file with the default CSS:
+
+```bash
+$ transmute file.md -t html
+```
+
+To Generate an HTML from a markdown file with custom CSS:
+
+```bash
+$ transmute file.md -t html -s custom.css
+```
+
+Custom CSS files can be be multiple path separated by a space, for example:
+
+```bash
+$ transmute file.md -t html -s custom1.css custom2.css
+```

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+# Require RSpec tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# The default task is tests
+task :default => :spec

data/bin/transmute

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'transmuter'
+Transmuter::CLI::Runner.start

data/lib/transmuter/cli/thor.rb

@@ -0,0 +1,99 @@
+require 'thor'
+require 'thor/group'
+
+module Transmuter
+  module CLI
+    module Thor
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.class_eval <<-END, __FILE__, __LINE__ + 1
+            desc "Transmute one file format into another."
+
+            class_option :input_format,
+              type: :string,
+              required: false,
+              aliases: "-f",
+              desc: "The input format."
+
+            class_option :output_format,
+              type: :string,
+              required: false,
+              aliases: "-t",
+              default: "pdf",
+              desc: "The output format."
+
+            class_option :stylesheets,
+              type: :array,
+              required: false,
+              aliases: "-s",
+              default: [DEFAULT_THEME],
+              desc: "The stylesheets."
+
+            argument :input,
+              type: :string,
+              required: true,
+              aliases: "-i",
+              desc: "The input file name."
+
+            argument :output,
+              type: :string,
+              required: false,
+              aliases: "-o",
+              desc: "The output file name."
+
+            def set_input_filename
+              @input_filename = input
+            end
+
+            def set_input_fileformat
+              @input_fileformat = options[:input_format] || input_format
+            end
+
+            def set_output_fileformat
+              @output_fileformat = options[:output_format]
+            end
+
+            def set_output_filename
+              if output.blank? && options[:output_format].blank?
+                raise ArgumentError, "Either output or output_format should be given,"
+              end
+
+              @output_filename = output || output_file
+            end
+
+            def set_stylesheets
+              @stylesheets = options[:stylesheets]
+            end
+
+            def transmute_input_to_output
+              transmute!
+            end
+
+            protected
+
+              def input_format
+                case @input.split('.').last
+                when /^(md|markdown)$/
+                  "markdown"
+                when /^(html|htm)/
+                  "html"
+                else
+                  raise ArgumentError, "No format was given and format could not be parsed from the file name"
+                end
+              end
+
+              def output_file
+                output = @input_filename.dup
+                output.gsub(/^(.+)\\.[^.]*$/, "\\\\1.\#{@output_fileformat}")
+              end
+          END
+        end
+      end
+    end
+  end
+end

data/lib/transmuter/cli/transmute.rb

@@ -0,0 +1,67 @@
+module Transmuter
+  module CLI
+    module Transmute
+      def self.included(base)
+        base.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def transmute!
+          set_klasses!
+          set_methods
+          verify_klasses!
+
+          source_klass_instance = @source_klass.new(read_input_file, parse_transmute_options)
+          output = source_klass_instance.send(@source_transform_method)
+
+          write_output_file(output)
+        end
+
+        def transmute
+          transmute!
+        rescue Exception => e
+          handle_error(e)
+        end
+
+        protected
+          def handle_error(exception)
+            # TODO: Handle error properly
+          end
+
+          def set_klasses!
+            @source_klass ||= "::Transmuter::Format::#{@input_fileformat.to_s.camelcase}".constantize
+            @destination_klass ||= "::Transmuter::Format::#{@output_fileformat.to_s.camelcase}".constantize
+          end
+
+          def set_methods
+            @source_transform_method ||= "to_#{@output_fileformat.to_s.downcase}".to_sym
+            @destination_process_method ||= :process
+          end
+
+          def verify_klasses!
+
+            raise NotImplementedError,
+              "#{@source_klass} does not respond to #{@source_transform_method}" unless
+              @source_klass.public_instance_methods.include?(@source_transform_method)
+
+            raise NotImplementedError,
+              "#{@destination_klass} does not respond to #{@destination_process_method}" unless
+              @destination_klass.public_instance_methods.include?(@destination_process_method)
+          end
+
+          def read_input_file
+            @input_file_contents ||= File.read(@input_filename)
+          end
+
+          def write_output_file(contents)
+            File.open(@output_filename, 'w') { |f| f.write(contents) }
+          end
+
+          def parse_transmute_options
+            { stylesheets: @stylesheets }
+          end
+
+      end
+    end
+  end
+end

data/lib/transmuter/cli.rb

@@ -0,0 +1,13 @@
+require 'transmuter/cli/thor'
+require 'transmuter/cli/transmute'
+
+module Transmuter
+  module CLI
+    class Runner < ::Thor::Group
+      DEFAULT_THEME = File.expand_path(File.join(ROOT_PATH, 'stylesheets', 'default.css'))
+
+      include Transmute
+      include Thor
+    end
+  end
+end

data/lib/transmuter/core_ext.rb

@@ -0,0 +1,4 @@
+require 'active_support/core_ext'
+require 'active_support/dependencies/autoload'
+
+Dir["#{File.dirname(__FILE__)}/core_ext/**/*.rb"].each { |f| require f }

data/lib/transmuter/format/html.rb

@@ -0,0 +1,81 @@
+require 'albino'
+require 'nokogiri'
+
+module Transmuter
+  module Format
+    class Html
+
+      def initialize(html, options = {})
+        parse_options(options)
+        @html = html
+      end
+
+      def to_pdf
+        html = process
+        pdf = Pdf.new(html, get_options)
+        pdf.process
+      end
+
+      def process
+        include_inline_stylesheets(syntax_highlighter)
+      end
+
+      protected
+        def get_options
+          options = @options.dup
+          options.delete(:redcarpet_options)
+          options
+        end
+
+        def parse_options(options)
+          @options = options.dup
+        end
+
+        def read_stylesheet_files
+          case @options[:stylesheets]
+          when Array
+            @options[:stylesheets].collect do |f|
+              File.read(f)
+            end.join("\n")
+          when String
+            File.read @options[:stylesheets]
+          when NilClass
+            # Apparently no stylesheets has been requested
+          end
+        end
+
+        def include_inline_stylesheets(html)
+          if @options[:stylesheets].present?
+            stylesheet_contents = read_stylesheet_files
+
+            doc = Nokogiri::HTML(html)
+            head = doc.xpath('/html/head').first
+
+            style = Nokogiri::XML::Node.new "style", doc
+            style['type'] = "text/css"
+            style.content = stylesheet_contents
+
+            unless head.present?
+              head = Nokogiri::XML::Node.new "head", doc
+              body = doc.xpath('/html/body').first
+              body.add_previous_sibling head
+            end
+
+            style.parent = head
+
+            html = doc.to_s
+          end
+
+          html
+        end
+
+        def syntax_highlighter
+          doc = Nokogiri::HTML(@html)
+          doc.search("//pre[@lang]").each do |pre|
+            pre.replace Albino.colorize(pre.text.rstrip, pre[:lang].downcase.to_sym)
+          end
+          doc.to_s
+        end
+    end
+  end
+end

data/lib/transmuter/format/markdown.rb

@@ -0,0 +1,45 @@
+require 'redcarpet'
+
+module Transmuter
+  module Format
+    class Markdown
+      REDCARPET_OPTIONS = [:autolink, :no_intraemphasis, :fenced_code, :gh_blockcode]
+
+      def initialize(markdown, options = {})
+        parse_options(options)
+        @markdown = markdown
+      end
+
+      def to_pdf
+        html = to_html
+        pdf = Pdf.new(html, get_options)
+        pdf.process
+      end
+
+      def to_html
+        html = Html.new(parse_markdown, get_options)
+        html.process
+      end
+
+      protected
+        def get_options
+          options = @options.dup
+          options.delete(:redcarpet_options)
+          options
+        end
+
+        def parse_options(options)
+          options = options.dup
+          @options = options.merge!(:redcarpet_options => REDCARPET_OPTIONS)
+        end
+
+        def create_markdown
+          Redcarpet.new(@markdown, *@options[:redcarpet_options])
+        end
+
+        def parse_markdown
+          create_markdown.to_html
+        end
+    end
+  end
+end

data/lib/transmuter/format/pdf.rb

@@ -0,0 +1,25 @@
+require 'pdfkit'
+
+module Transmuter
+  module Format
+    class Pdf
+
+      def initialize(html, options = {})
+        parse_options(options)
+        @html = html
+      end
+
+      def process
+        kit = PDFKit.new(@html, :page_size => @options[:page_size])
+
+        kit.to_pdf
+      end
+
+      protected
+        def parse_options(options)
+          options = options.dup
+          @options = options.merge!(:page_size => 'Letter')
+        end
+    end
+  end
+end

data/lib/transmuter/format.rb

@@ -0,0 +1,9 @@
+module Transmuter
+  module Format
+    extend ::ActiveSupport::Autoload
+
+    autoload :Markdown
+    autoload :Html
+    autoload :Pdf
+  end
+end

data/lib/transmuter/version.rb

@@ -1,8 +1,7 @@
 module Transmuter
   MAJOR = 0
   MINOR = 0
-  BUILD = 0
-  REVISION = 1
+  PATCH = 1
 
-  VERSION = [MAJOR, MINOR, BUILD, REVISION].join('.')
-end
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/lib/transmuter.rb

@@ -1,5 +1,6 @@
-require "transmuter/version"
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
-module Transmuter
-  # Your code goes here...
-end
+require "transmuter/version"
+require "transmuter/core_ext"
+require "transmuter/format"
+require "transmuter/cli"

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+ROOT_PATH = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+$:.push File.expand_path("#{ROOT_PATH}/lib")
+
+require 'rubygems'
+require 'rspec'
+
+# Require the library
+require 'transmuter'
+
+include Transmuter
+
+# Require support files
+Dir[ROOT_PATH + "/spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  # config.mock_with :rspec
+end