deas-kramdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: 71dc6d17d7f6732475e5c6768803b1c442a1341a2183594a5587ce7e657d83d42849dc5ab59d4955d6297e1330f8a85db10291c88ee0a106530513e034dd90ad
+  metadata.gz: bb2f9493a9c89c22d71f7e52ddbfb1dcb22afc2c788a9fe16f919a5c8c493c70640307a90542ec0f84a48d834fe567a7233ac19b24a2c3a4b432ef5f4ab3b221
+SHA1: 
+  data.tar.gz: c6d1ae7dc5246d8a013a5527f3c835c61fb76504
+  metadata.gz: 5610ded1adef28042a476689355ccbacf67c9435

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.log
+*.rbc
+.rbx/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'pry', "~> 0.9.0"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016-Present Kelly Redding and Collin Redding
+
+MIT License
+
+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.md

@@ -0,0 +1,44 @@
+# Deas::Nm
+
+[Deas](https://github.com/redding/deas) template engine for rendering [Kramdown](http://kramdown.gettalong.org/) templates
+
+## Usage
+
+Register the engine:
+
+```ruby
+require 'deas'
+require 'deas-kramdown'
+
+Deas.configure do |c|
+
+  c.template_source "/path/to/templates" do |s|
+    s.engine 'md', Deas::Kramdown::TemplateEngine
+  end
+
+end
+```
+
+Add `.md` to any template files in your template source path.  Deas will render their content using Kramdown when they are rendered.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'deas-kramdown'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install deas-kramdown
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/deas-kramdown.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "deas-kramdown/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "deas-kramdown"
+  gem.version     = Deas::Kramdown::VERSION
+  gem.authors     = ["Kelly Redding", "Collin Redding"]
+  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
+  gem.summary     = %q{Deas template engine for Kramdown templates}
+  gem.description = %q{Deas template engine for Kramdown templates}
+  gem.homepage    = "http://github.com/redding/deas-kramdown"
+  gem.license     = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency("assert", ["~> 2.15.1"])
+
+  gem.add_dependency("deas",     ["~> 0.39.2"])
+  gem.add_dependency("kramdown", ["~> 1.10"])
+
+end

data/lib/deas-kramdown.rb

@@ -0,0 +1,38 @@
+require 'deas/template_engine'
+require 'kramdown'
+
+require "deas-kramdown/version"
+require 'deas-kramdown/source'
+
+module Deas::Kramdown
+
+  class TemplateEngine < Deas::TemplateEngine
+
+    def kramdown_source
+      @kramdown_source ||= Source.new(self.source_path, {
+        :doc_opts => self.opts['doc_opts'],
+        :cache    => self.opts['cache']
+      })
+    end
+
+    # Render straight markdown templates.  As no ruby will be evaluated the view
+    # handler, locals and content block will be ignored.
+    def render(template_name, view_handler, locals, &content)
+      self.kramdown_source.render(template_name)
+    end
+
+    # Render straight markdown partial templates.  As no ruby will be evaluated
+    # the locals and content block will be ignored.
+    def partial(template_name, locals, &content)
+      self.kramdown_source.render(template_name)
+    end
+
+    # this is used when chaining engines where another engine initially loads the
+    # template file
+    def compile(template_name, compiled_content)
+      self.kramdown_source.compile(template_name, compiled_content)
+    end
+
+  end
+
+end

data/lib/deas-kramdown/source.rb

@@ -0,0 +1,57 @@
+require 'pathname'
+require 'kramdown'
+
+module Deas; end
+module Deas::Kramdown
+
+  class Source
+
+    attr_reader :root, :cache, :doc_opts
+
+    def initialize(root, opts)
+      @root     = Pathname.new(root.to_s)
+      @doc_opts = opts[:doc_opts] || {}
+      @cache    = opts[:cache] ? Hash.new : NullCache.new
+    end
+
+    def render(template_name)
+      load(template_name).to_html
+    end
+
+    def compile(template_name, content)
+      doc(content).to_html
+    end
+
+    def doc(content)
+      Kramdown::Document.new(content, @doc_opts)
+    end
+
+    def inspect
+      "#<#{self.class}:#{'0x0%x' % (object_id << 1)}"\
+      " @root=#{@root.inspect}"\
+      " @doc_opts=#{@doc_opts.inspect}>"
+    end
+
+    private
+
+    def load(template_name)
+      @cache[template_name] ||= begin
+        file_path = source_file_path(template_name).to_s
+        content = File.send(File.respond_to?(:binread) ? :binread : :read, file_path)
+        doc(content)
+      end
+    end
+
+    def source_file_path(template_name)
+      Dir.glob(self.root.join("#{template_name}*")).first
+    end
+
+    class NullCache
+      def [](template_name);         end
+      def []=(template_name, value); end
+      def keys; [];                  end
+    end
+
+  end
+
+end

data/lib/deas-kramdown/version.rb

@@ -0,0 +1,4 @@
+module Deas; end
+module Deas::Kramdown
+  VERSION = "0.1.0"
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+# this file is automatically required when you run `assert`
+# put any test helpers here
+
+require 'pathname'
+
+# add the root dir to the load path
+ROOT = Pathname.new(File.expand_path("../..", __FILE__))
+$LOAD_PATH.unshift(ROOT.to_s)
+
+TEST_SUPPORT_PATH = ROOT.join('test/support')
+TEMPLATE_ROOT = TEST_SUPPORT_PATH.join('templates')
+TEMPLATE_CACHE_ROOT = ROOT.join('tmp/templates')
+
+# require pry for debugging (`binding.pry`)
+require 'pry'
+
+require 'test/support/factory'
+
+# TODO: put test helpers here...

data/test/support/factory.rb

@@ -0,0 +1,18 @@
+require 'assert/factory'
+
+module Factory
+  extend Assert::Factory
+
+  def self.template_root
+    TEMPLATE_ROOT.to_s
+  end
+
+  def self.template_file(name)
+    TEMPLATE_ROOT.join(name).to_s
+  end
+
+  def self.basic_markdown_rendered
+    "<h1 id=\"some-heading\">Some Heading</h1>\n"
+  end
+
+end

data/test/support/templates/_basic.md

@@ -0,0 +1 @@
+# Some Heading

data/test/support/templates/basic.html.md

@@ -0,0 +1 @@
+# Some Heading

data/test/support/templates/basic_alt.markdown

@@ -0,0 +1 @@
+# Some Heading

data/test/system/template_engine_tests.rb

@@ -0,0 +1,45 @@
+require 'assert'
+require 'deas-kramdown'
+
+require 'deas/template_source'
+
+class Deas::Kramdown::TemplateEngine
+
+  class SystemTests < Assert::Context
+    desc "Deas::Kramdown::TemplateEngine"
+    setup do
+      @view = OpenStruct.new({
+        :identifier => Factory.integer,
+        :name       => Factory.string
+      })
+      @locals  = { 'local1' => Factory.string }
+      @content = Proc.new{ Factory.string }
+
+      @engine = Deas::Kramdown::TemplateEngine.new('source_path' => TEMPLATE_ROOT)
+    end
+    subject{ @engine }
+
+    should "render templates (ignoring the view/locals/content)" do
+      exp = Factory.basic_markdown_rendered
+      assert_equal exp, subject.render('basic', @view, @locals)
+      assert_equal exp, subject.render('basic', @view, @locals, &@content)
+    end
+
+    should "render partial templates (ignoring the locals/content)" do
+      exp = Factory.basic_markdown_rendered
+      assert_equal exp, subject.partial('_basic', @locals)
+      assert_equal exp, subject.partial('_basic', @locals, &@content)
+    end
+
+    should "compile raw template markup" do
+      template_name = 'basic_alt'
+      file_path     = TEMPLATE_ROOT.join("#{template_name}.markdown").to_s
+      file_content  = File.read(file_path)
+
+      exp = Factory.basic_markdown_rendered
+      assert_equal exp, subject.compile(template_name, file_content)
+    end
+
+  end
+
+end

data/test/unit/source_tests.rb

@@ -0,0 +1,145 @@
+require 'assert'
+require 'deas-kramdown/source'
+
+require 'kramdown'
+
+class Deas::Kramdown::Source
+
+  class UnitTests < Assert::Context
+    desc "Deas::Kramdown::Source"
+    setup do
+      @source_class = Deas::Kramdown::Source
+    end
+    subject{ @source_class }
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @doc_opts = { Factory.string => Factory.string }
+      @root = Factory.template_root
+      @source = @source_class.new(@root, :doc_opts => @doc_opts)
+    end
+    subject{ @source }
+
+    should have_readers :root, :cache, :doc_opts
+    should have_imeths :render, :compile, :doc
+
+    should "know its root" do
+      assert_equal @root, subject.root.to_s
+    end
+
+    should "not cache templates by default" do
+      assert_kind_of NullCache, subject.cache
+    end
+
+    should "cache templates if the :cache opt is `true`" do
+      source = @source_class.new(@root, :cache => true)
+      assert_kind_of Hash, source.cache
+    end
+
+    should "know its doc options" do
+      assert_equal @doc_opts, subject.doc_opts
+      assert_equal Hash.new,  @source_class.new(@root, {}).doc_opts
+    end
+
+    should "build kramdown doc objects from template content" do
+      content  = '# Some Heading'
+      kdoc = Kramdown::Document.new(content, @doc_opts)
+      kdoc_called_with = []
+      Assert.stub(Kramdown::Document, :new) do |*args|
+        kdoc_called_with = args
+        kdoc
+      end
+
+      doc = subject.doc(content)
+      assert_instance_of Kramdown::Document, doc
+
+      exp = [content, @doc_opts]
+      assert_equal exp, kdoc_called_with
+    end
+
+  end
+
+  class RenderTests < InitTests
+    desc "`render` method"
+    setup do
+      @template_name = ['basic', 'basic_alt'].choice
+    end
+
+    should "render a template for the given template name and return its data" do
+      exp = Factory.basic_markdown_rendered
+      assert_equal exp, subject.render(@template_name)
+    end
+
+  end
+
+  class RenderCacheTests < RenderTests
+    desc "when caching is enabled"
+    setup do
+      @source = @source_class.new(@root, :cache => true)
+    end
+
+    should "cache templates by their template name" do
+      exp = Factory.basic_markdown_rendered
+      assert_equal exp, @source.render(@template_name)
+
+      assert_equal [@template_name], @source.cache.keys
+      assert_kind_of Kramdown::Document, @source.cache[@template_name]
+    end
+
+  end
+
+  class RenderNoCacheTests < RenderTests
+    desc "when caching is disabled"
+    setup do
+      @source = @source_class.new(@root, :cache => false)
+    end
+
+    should "not cache templates" do
+      exp = Factory.basic_markdown_rendered
+      assert_equal exp, @source.render(@template_name)
+
+      assert_equal [], @source.cache.keys
+    end
+
+  end
+
+  class CompileTests < InitTests
+    desc "`compile` method"
+
+    should "evaluate raw template output and return it" do
+      raw = "## Another Heading"
+      exp = "<h2 id=\"another-heading\">Another Heading</h2>\n"
+      assert_equal exp, subject.compile('compile', raw)
+    end
+
+  end
+
+  class NullCacheTests < UnitTests
+    desc "NullCache"
+    setup do
+      @cache = NullCache.new
+    end
+    subject{ @cache }
+
+    should have_imeths :[], :[]=, :keys
+
+    should "take a template name and return nothing on index" do
+      assert_nil subject[Factory.path]
+    end
+
+    should "take a template name and value and do nothing on index write" do
+      assert_nothing_raised do
+        subject[Factory.path] = Factory.string
+      end
+    end
+
+    should "always have empty keys" do
+      assert_equal [], subject.keys
+    end
+
+  end
+
+end

data/test/unit/template_engine_tests.rb

@@ -0,0 +1,46 @@
+require 'assert'
+require 'deas-kramdown'
+
+require 'deas/template_engine'
+require 'deas-kramdown/source'
+
+class Deas::Kramdown::TemplateEngine
+
+  class UnitTests < Assert::Context
+    desc "Deas::Kramdown::TemplateEngine"
+    setup do
+      @engine = Deas::Kramdown::TemplateEngine.new({
+        'source_path' => TEST_SUPPORT_PATH
+      })
+    end
+    subject{ @engine }
+
+    should have_imeths :kramdown_source
+    should have_imeths :render, :partial, :compile
+
+    should "be a Deas template engine" do
+      assert_kind_of Deas::TemplateEngine, subject
+    end
+
+    should "memoize its kramdown source" do
+      assert_kind_of Deas::Kramdown::Source, subject.kramdown_source
+      assert_equal subject.source_path, subject.kramdown_source.root
+      assert_same subject.kramdown_source, subject.kramdown_source
+    end
+
+    should "allow custom doc opts on its source" do
+      doc_opts = { Factory.string => Factory.string }
+      engine = Deas::Kramdown::TemplateEngine.new('doc_opts' => doc_opts)
+      assert_equal doc_opts, engine.kramdown_source.doc_opts
+    end
+
+    should "pass any given cache option to its source" do
+      engine = Deas::Kramdown::TemplateEngine.new('cache' => true)
+      assert_kind_of Hash, engine.kramdown_source.cache
+    end
+
+  end
+
+  # render, partial and compile tests are covered in the system tests
+
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: deas-kramdown
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kelly Redding
+- Collin Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2016-04-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: assert
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.15.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: deas
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.39.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: kramdown
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.10"
+  type: :runtime
+  version_requirements: *id003
+description: Deas template engine for Kramdown templates
+email: 
+- kelly@kellyredding.com
+- collin.redding@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- deas-kramdown.gemspec
+- lib/deas-kramdown.rb
+- lib/deas-kramdown/source.rb
+- lib/deas-kramdown/version.rb
+- log/.gitkeep
+- test/helper.rb
+- test/support/factory.rb
+- test/support/templates/_basic.md
+- test/support/templates/basic.html.md
+- test/support/templates/basic_alt.markdown
+- test/system/template_engine_tests.rb
+- test/unit/source_tests.rb
+- test/unit/template_engine_tests.rb
+- tmp/.gitkeep
+homepage: http://github.com/redding/deas-kramdown
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id004 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Deas template engine for Kramdown templates
+test_files: 
+- test/helper.rb
+- test/support/factory.rb
+- test/support/templates/_basic.md
+- test/support/templates/basic.html.md
+- test/support/templates/basic_alt.markdown
+- test/system/template_engine_tests.rb
+- test/unit/source_tests.rb
+- test/unit/template_engine_tests.rb