jekyll-org 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 586ba3111f8785149440159d08544faf4b17a2c4
+  data.tar.gz: 07a0a7235bd8f9b648be2fd9a2ddd58527b881ea
+SHA512:
+  metadata.gz: 7db2524a798f1b1ba4f3a574433a68761841630dda3335f5b15d8d3437faa7063ed1e41f9b6911f80e440a0cd08f74a7b946c95c60dbe7ddfa50141bd1c5d799
+  data.tar.gz: 2256f33c5b55fc5801139697cfa21c6db713e53d01a65e1adb4c3c2da5af0189191accdee4560c229337a82d06ea3da95d5e08f5526ada932f439c14242e9ce2

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'org-ruby' , '>= 0.9.12'
+gem 'jekyll', '>= 3.0.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rspec", ">=0"
+  gem "rdoc", ">=3.12"
+  gem "bundler", ">=1.0"
+  gem "jeweler", ">=2.1.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2016 eggcaker. http://yep8.org/jekyll-org/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.org

@@ -0,0 +1,115 @@
+* jekyll-org
+
+** Overview
+
+   This plugin adds [[http://orgmode.org/][Org mode]] support to [[http://jekyllrb.com][Jekyll]] and lets you write posts and pages in Org.
+
+** Requirements
+
+- Jekyll
+- org-ruby
+
+** Installation
+*** Short version
+For experienced Jekyll users, you need to do 2 things to get ~jekyll-org~ to work
+- Install the gem
+- Include the gem in your ~_config.yml~
+
+*** Long version
+To  use ~jekyll-org~ with Jekyll, you need to have Ruby RubyGems and Jekyll installed. See  how to do that [[http://jekyllrb.com/docs/installation/][here]].
+
+Create a new Jekyll project ~my-site~ run:
+#+begin_src sh
+jekyll new my-site
+#+end_src
+
+Create a Gemfile in the root of the project, and add at least the following lines:
+#+begin_src ruby
+source 'https://rubygems.org'
+
+gem 'jekyll' , '>= 3.0.0'
+gem 'jekyll-org', '>= '1.0.0'
+#+end_src
+
+Install the gems with bundler:
+#+begin_src sh
+bundle install
+#+end_src
+
+
+To use the new converter add the following line to your ~_config.yml~:
+#+begin_src ruby
+gems: [jekyll-org]
+#+end_src
+** Usage
+
+   Create a new file with =.org= extension in =_posts=, and write the post with Org. That is all! Generate your Jekyll site as you usually do.
+
+** Front matter
+
+   Instead of YAML the front matter is configured in the usual Org way, with no lines:
+
+   #+BEGIN_EXAMPLE
+   #+TITLE: Jekyll and Org together
+   #+LAYOUT: posts
+   #+TAGS: jekyll org-mode
+
+   This is a blog post about Jekyll and Org mode.
+   #+END_EXAMPLE
+
+** Liquid templating
+
+By default the all content is exported to raw HTML with org-ruby, but you can add =#+liquid: whatevervalue==
+in the header.  Then you can use [[http://docs.shopify.com/themes/liquid-documentation/basics][Liquid]] tags.
+
+For example, if your Org file contains
+
+#+BEGIN_EXAMPLE
+#+liquid: enabled
+#+foo: hello world
+
+{{ page.foo }}
+
+or
+
+{{ site.time | date_to_xmlschema }}
+
+#+END_EXAMPLE
+
+then you will get output like
+
+#+BEGIN_EXAMPLE
+<p>hello world</p>
+<p>or</p>
+<p>2014-07-02T08:20:28+08:00</p>
+#+END_EXAMPLE
+
+** Source code highlighting
+
+   Add a source code block as you would in Org, for example Ruby:
+
+  #+BEGIN_EXAMPLE
+  #+BEGIN_SRC
+   require 'rubygems'
+   require 'org-ruby'
+   data = IO.read(filename)
+   puts Orgmode::Parser.new(data).to_html
+  #+END_SRC
+  #+END_EXAMPLE
+
+  Then the output will have code highlighting:
+
+  #+BEGIN_SRC ruby
+   require 'rubygems'
+   require 'org-ruby'
+   data = IO.read(filename)
+   puts Orgmode::Parser.new(data).to_html
+  #+END_SRC
+
+** Author
+
+   eggcaker <eggcaker@gmail.com>
+
+** License
+
+   MIT

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require 'org-ruby'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "jekyll-org"
+  gem.homepage = "http://eggcaker.github.io/jekyll-org"
+  gem.license = "MIT"
+  gem.summary = %Q{Jekyll converter for org-mode files}
+  gem.description = %Q{So you want org-mode support for Jekyll. Write your _posts in org-mode, then add 'gems: [jekyll-org]' to your _config.yml. Thats it!}
+  gem.email = "eggcaker@gmail.com"
+  gem.authors = "eggcaker"
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jekyll-org #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/jekyll-org.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: jekyll-org 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "jekyll-org"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["eggcaker"]
+  s.date = "2016-10-11"
+  s.description = "So you want org-mode support for Jekyll. Write your _posts in org-mode, then add 'gems: [jekyll-org]' to your _config.yml. Thats it!"
+  s.email = "eggcaker@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.org"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE",
+    "README.org",
+    "Rakefile",
+    "VERSION",
+    "jekyll-org.gemspec",
+    "lib/jekyll-org.rb",
+    "script/bootstrap",
+    "script/cibuild",
+    "script/console",
+    "script/release",
+    "spec/helper.rb",
+    "spec/test_jekyll-org.rb"
+  ]
+  s.homepage = "http://eggcaker.github.io/jekyll-org"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.5.1"
+  s.summary = "Jekyll converter for org-mode files"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<org-ruby>, [">= 0.9.12"])
+      s.add_runtime_dependency(%q<jekyll>, [">= 3.0.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 2.1.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<org-ruby>, [">= 0.9.12"])
+      s.add_dependency(%q<jekyll>, [">= 3.0.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 2.1.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<org-ruby>, [">= 0.9.12"])
+    s.add_dependency(%q<jekyll>, [">= 3.0.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 2.1.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/jekyll-org.rb

@@ -0,0 +1,81 @@
+require 'org-ruby'
+
+if Jekyll::VERSION < "3.0"
+  raise Jekyll::FatalException, "This version of jekyll-org is only compatible with Jekyll v3 and above."
+end
+
+module Jekyll
+  class OrgConverter < Converter
+    safe true
+
+    priority :low
+
+    def matches(ext)
+      ext =~ /org/i
+    end
+
+    def output_ext(ext)
+      ".html"
+    end
+
+    def convert(content)
+      content
+    end
+  end
+
+  module Filters
+    def restify(input)
+      site = @context.registers[:site]
+      converter = site.find_converter_instance(Jekyll::OrgConverter)
+      converter.convert(input)
+    end
+  end
+
+  # This overrides having to use YAML in the posts.
+  # Instead use settings from Org mode.
+  class Document
+    alias :_orig_read :read
+    def read(opts = {})
+      unless relative_path.end_with?(".org")
+        return _orig_read(opts)
+      end
+
+      Jekyll.logger.debug "Reading:", relative_path
+
+      self.content = File.read(path, Utils.merged_file_read_opts(site, opts))
+      self.data ||= {}
+      liquid_enabled = false
+
+      org_text = Orgmode::Parser.new(content, { markup_file: "html.tags.yml" })
+      org_text.in_buffer_settings.each_pair do |key, value|
+        # Remove #+TITLE from the buffer settings to avoid double exporting
+        org_text.in_buffer_settings.delete(key) if key =~ /title/i
+        buffer_setting = key.downcase
+
+        if buffer_setting == 'liquid'
+          liquid_enabled = true
+        end
+
+        self.data[buffer_setting] = value
+      end
+
+      # Disable Liquid tags from the output by default or enabled with liquid_enabled tag
+
+      if liquid_enabled
+        self.content = org_text.to_html
+        self.content = self.content.gsub("&#8216;","'")
+        self.content = self.content.gsub("&#8217;", "'")
+      else
+        self.content = <<ORG
+{% raw %}
+#{org_text.to_html}
+{% endraw %}
+ORG
+      end
+
+      post_read
+    rescue => e
+      puts "Error converting file #{relative_path}: #{e.message} #{e.backtrace}"
+    end
+  end
+end

data/script/bootstrap

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+
+bundle install

data/script/cibuild

@@ -0,0 +1,8 @@
+#!/bin/sh
+set -e
+
+bundle exec rspec
+bundle exec rspec spec/test_jekyll-org.rb
+if [ "$JEKYLL_VERSION" = "3.0" ]; then
+   bundle exec rubocop -S -D
+fi

data/script/console

@@ -0,0 +1,34 @@
+#! /usr/bin/env ruby
+
+def relative_to_root(path)
+  File.expand_path(path, File.dirname(File.dirname(__FILE__)))
+end
+
+require 'jekyll'
+require relative_to_root('lib/jekyll-org.rb')
+require 'pry-debugger'
+
+SOURCE_DIR = relative_to_root('spec/fixtures')
+DEST_DIR   = relative_to_root('spec/dest')
+
+def source_dir(*files)
+  File.join(SOURCE_DIR, *files)
+end
+
+def dest_dir(*files)
+  File.join(DEST_DIR, *files)
+end
+
+def config(overrides = {})
+  Jekyll.configuration({
+    "source"      => source_dir,
+    "destination" => dest_dir,
+    "url"         => "http://example.org"
+  }).merge(overrides)
+end
+
+def site(configuration = config)
+  Jekyll::Site.new(configuration)
+end
+
+binding.pry

data/script/release

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+
+set -e
+
+script/cibuild
+bundle exec rake release

data/spec/helper.rb

@@ -0,0 +1,21 @@
+require 'jekyll'
+require File.expand_path('../lib/jekyll-org', File.dirname(__FILE__))
+
+Jekyll.logger.log_level = :error
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
+  DEST_DIR   = File.expand_path("../dest",     __FILE__)
+
+  def source_dir(*files)
+    File.join(SOURCE_DIR, *files)
+  end
+
+  def dest_dir(*files)
+    File.join(DEST_DIR, *files)
+  end
+end

data/spec/test_jekyll-org.rb

@@ -0,0 +1,6 @@
+require 'helper'
+
+describe("should working with unit test") do
+  it "added some test cases" do
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-org
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- eggcaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: org-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'So you want org-mode support for Jekyll. Write your _posts in org-mode,
+  then add ''gems: [jekyll-org]'' to your _config.yml. Thats it!'
+email: eggcaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.org
+files:
+- Gemfile
+- LICENSE
+- README.org
+- Rakefile
+- VERSION
+- jekyll-org.gemspec
+- lib/jekyll-org.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/release
+- spec/helper.rb
+- spec/test_jekyll-org.rb
+homepage: http://eggcaker.github.io/jekyll-org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Jekyll converter for org-mode files
+test_files: []