jekyll-transform 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2af0c2ea81575418b63f6117c075911979dcb017
+  data.tar.gz: 237e4981848bdf715966e211e4a8a9ec0e7e4ae9
+SHA512:
+  metadata.gz: 3e3c7f1afc4d49326ab3191c9ea898fae613ec4de2af51719d2f0d8f8f0b4cdb13a1928c14ee36f456af837616c75e54196168e9de54cecb054d20598bf9dacb
+  data.tar.gz: 76f57ab6d9caa5d4fe2a5167c1098c1c7737d80cc07643ed4fe0a85e9c9572ad2a18f29851f658899067a7e96f99ead7e8d1074c7a94075b7dca4c6e35f5a0e1

data/.index

@@ -0,0 +1,47 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- name: jekyll
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/jekyll-transform
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/jekyll-transform
+  label: Source Code
+- type: docs
+  uri: http://rubydoc.info/gems/jekyll-transform/frames
+  label: Documentation
+- type: mail
+  uri: http://groups.google.com/groups/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/kekyll-transform.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2013'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+name: jekyll-transform
+title: Jekyll Transform
+summary: Transform any directory into a website!
+created: '2013-08-09'
+description: "Jykell Transform converts transforms external sources \ninto a Jykell
+  managable material."
+version: 0.1.0
+date: '2013-08-09'

data/HISTORY.md

@@ -0,0 +1,9 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2013-08-10
+
+This is the initial release of Jekyll Transform.
+
+Changes:
+
+* Happy Release Day!

data/LICENSE.txt

@@ -0,0 +1,23 @@
+(SPDX) BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL Thomas Sawyer OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,91 @@
+# Jekyll Transform
+
+**Transform your documents into a Jekyll site!**
+
+## About
+
+Jekyll Transform allows Jekyll to use any directory as a source for markup
+documents in the construction of a website. The documents within the
+directory **do not need YAML front matter**. A good example how this can be
+useful is taking a Gollum wiki and using its contents for the creation of
+a custom website.
+
+
+## Usage
+
+Jekyll Transform works as a Jekyll plugin.
+
+You first need to have a Jekyll setup in accordance with Jekyll's specification.
+With a Jekyll site in place you simply need to add a `transform.rb` file to
+your site's `_plugins` directory containing:
+
+    require `jekyll-transform'
+
+Then in your `_config.yml` file add:
+
+    transform:
+      folder: '_wiki'
+      page_yaml:
+        layout: page
+      post_yaml:
+        layout: post
+
+Change the confgiuration to meet your needs. The `folder` settings
+tells it where to find the files to be transformed. In our example
+we use `_wiki` because we want to it to contain a cloned Gollum wiki
+repository. If no entry is given the default is `_trans`. The `page_yaml`
+and `post_yaml` entries specify the YAML front matter to add to pages
+and posts respecively. If not given the defaults are as shown above,
+`page` and `post`.
+
+Jekyll transform distinguishes posts from pages simply soley by the name
+of the file starting with a date. It does not matter where they are located
+in the directory. And pages will keep their relative paths.
+
+Drafts are not yet supported, but that will be added in future release.
+In the mean time you can still set `future: false` and date your drafts
+far in the future.
+
+
+## Tips
+
+### Is it possible to customize files individually?
+
+If your documents can contain HTML style comments then you can add YAML
+matter to the bottom of the document. For instance, perhaps specfic
+documents require a `speical` layout. Adding the following to the bottom
+of the document will allow Jekyll to use it as the documents YAML front
+matter.
+
+```html
+    <!--- ---
+    layout: special
+    --->
+```
+
+In the future we might allow YAML front matter to be set via glob matches
+in the _config.yml, if there are requests for the feature.
+
+### How does Jekyll Transfrom compare to Smeagol?
+
+Smeagol is a little different in that it is specifcally designed for use
+with Gollum wikis. It is also, first and foremost, a Rack-based service
+for serving up a Gollum wiki as a customize website. New versions do include 
+a static site generator, but its generation features aren't as polished as
+Jekyll's. On the other hand, Smeagol does supports all markup languages
+that Gollum supports and more faithly renders them in the same manner as
+Gollum (because it in most cases it passes the chore off to Gollum).
+
+
+## Copyrights
+
+Copyright (c) 2013 Rubyworks
+
+Hyde is open-source software distributed under the BSD-2-Clause license.
+
+See LICENSE.txt for details.
+
+
+
+
+

data/lib/jekyll-transform.rb

@@ -0,0 +1,105 @@
+module Jekyll
+
+  class TransformPage < Page
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    #
+    # Returns nothing.
+    def read_yaml(base, name)
+      begin
+        self.content = File.read(File.join(base, name))
+
+        config_data = (site.config['transform'] || {})['page_yaml'] || {} #{'layout'=>'default'}
+        if self.content =~ /(<!---\s+---\s*\n.*?\n?)^(---\s*$\n?)/m
+          self.content = $POSTMATCH
+          self.data = config_data.merge(YAML.safe_load($1))
+        else
+          self.data = config_data
+        end
+      rescue SyntaxError => e
+        puts "YAML Exception reading #{File.join(base, name)}: #{e.message}"
+      rescue Exception => e
+        puts "Error reading file #{File.join(base, name)}: #{e.message}"
+      end
+
+      self.data ||= {'layout'=>'page'}
+    end
+  end
+
+  class TransformPost < Post
+    # Read the YAML frontmatter.
+    #
+    # base - The String path to the dir containing the file.
+    # name - The String filename of the file.
+    #
+    # Returns nothing.
+    def read_yaml(base, name)
+      begin
+        self.content = File.read(File.join(base, name))
+
+        config_data = (site.config['transform'] || {})['post_yaml'] || {} #{'layout'=>'default'}
+        if self.content =~ /(<!---\s+---\s*\n.*?\n?)^(---\s*$\n?)/m
+          self.content = $POSTMATCH
+          self.data = config_data.merge(YAML.safe_load($1))
+        else
+          self.data = config_data
+        end
+      rescue SyntaxError => e
+        puts "YAML Exception reading #{File.join(base, name)}: #{e.message}"
+      rescue Exception => e
+        puts "Error reading file #{File.join(base, name)}: #{e.message}"
+      end
+
+      self.data ||= {'layout'=>'post'}
+
+      self.extracted_excerpt = self.extract_excerpt
+    end
+
+    def path
+      self.data['path'] || File.join(@dir, @name).sub(/\A\//, '')
+    end
+
+    def containing_dir(source, dir)
+      return File.join(source, dir)
+    end
+  end
+
+
+  class TransformGenerator < Generator
+    safe true
+
+    #
+    # TODO: Handle drafts.
+    #
+    def generate(site)
+      return unless site.config.key?('transform')
+
+      folder = site.config['transform']['folder'] || '_trans'
+      source = File.join(site.source, folder)
+      files = transform_entries(source)
+      files.each do |file|
+        if is_post?(File.join(source, file))
+          post = TransformPost.new(site, source, File.dirname(file), File.basename(file))
+          site.posts << post
+        else
+          page = TransformPage.new(site, source, File.dirname(file), File.basename(file))
+          site.pages << page
+        end
+      end
+    end
+
+    def transform_entries(dir)
+      Dir.glob(File.join(dir, '**/*')).map do |d|
+        d.sub(dir+'/', '')
+      end
+    end
+
+    def is_post?(file)
+      /\d\d\d\d-\d\d-\d\d/ =~ File.basename(file)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-transform
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "Jykell Transform converts transforms external sources \ninto a Jykell
+  managable material."
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- HISTORY.md
+files:
+- .index
+- lib/jekyll-transform.rb
+- README.md
+- HISTORY.md
+- LICENSE.txt
+homepage: http://rubyworks.github.com/jekyll-transform
+licenses:
+- BSD-2-Clause
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Transform any directory into a website!
+test_files: []