condensation 1.0.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in condensation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derrick Reimer
+
+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,29 @@
+# Condensation
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'condensation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install condensation
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/condensation.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'condensation/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "condensation"
+  gem.version       = Condensation::VERSION
+  gem.authors       = ["Derrick Reimer"]
+  gem.email         = ["derrickreimer@gmail.com"]
+  gem.description   = %q{A collection of handy extensions to the Liquid templating language}
+  gem.summary       = %q{Condensation is a collection of handy extensions to the Liquid templating language}
+  gem.homepage      = "https://github.com/djreimer/condensation"
+
+  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_dependency "liquid", "~> 2.0"
+  gem.add_development_dependency "shoulda-context", "~> 1.0"
+end

data/lib/condensation/filters/default.rb

@@ -0,0 +1,10 @@
+module Condensation
+  module Filters
+    module Default
+      def default(input, default_value = "")
+        is_blank = input.respond_to?(:empty?) ? input.empty? : !input
+        is_blank ? default_value : input
+      end
+    end
+  end
+end

data/lib/condensation/filters/hyperlink.rb

@@ -0,0 +1,12 @@
+module Condensation
+  module Filters
+    module Hyperlink
+      def hyperlink(input, text = nil)
+        return if input.nil?
+        input = Sanitizer.new(input.to_s).escape_html
+        text = text ? Sanitizer.new(text).escape_html : input
+        "<a href='#{input}'>#{text}</a>"
+      end
+    end
+  end
+end

data/lib/condensation/filters/replace_inner_html.rb

@@ -0,0 +1,12 @@
+module Condensation
+  module Filters
+    module ReplaceInnerHTML
+      def replace_inner_html(input, inner_html = "")
+        return if input.nil?
+        input.to_s.gsub(/\A(<\S.*>)(.*)(<\/\S*>)\z/) do 
+          "#{$1}#{inner_html}#{$3}"
+        end
+      end
+    end
+  end
+end

data/lib/condensation/filters.rb

@@ -0,0 +1,3 @@
+require "condensation/filters/default"
+require "condensation/filters/hyperlink"
+require "condensation/filters/replace_inner_html"

data/lib/condensation/sanitizer.rb

@@ -0,0 +1,13 @@
+module Condensation
+  class Sanitizer
+    attr_reader :input
+
+    def initialize(input)
+      @input = input
+    end
+
+    def escape_html
+      CGI.escapeHTML(input) rescue input
+    end
+  end
+end

data/lib/condensation/version.rb

@@ -0,0 +1,3 @@
+module Condensation
+  VERSION = "1.0.0"
+end

data/lib/condensation.rb

@@ -0,0 +1,17 @@
+require "liquid"
+require "condensation/sanitizer"
+require "condensation/filters"
+require "condensation/version"
+
+module Condensation
+  FILTERS = [
+    Filters::Default,
+    Filters::ReplaceInnerHTML
+  ]
+
+  def register_filters
+    FILTERS.each do |filter|
+      Liquid::Template.register_filter(filter)
+    end
+  end
+end

data/spec/condensation/filters/default_spec.rb

@@ -0,0 +1,45 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Condensation::Filters::Default do
+  def render_with_filter(template, context)
+    template.render(context, :filters => [Condensation::Filters::Default])
+  end
+
+  describe "#default" do
+    it "should return input if it is not blank" do
+      template = Liquid::Template.parse("{{ name | default: 'Bar' }}")
+      result = render_with_filter(template, { "name" => "Foo" })
+      result.must_equal "Foo"
+    end
+
+    it "should return default value if input is nil" do
+      template = Liquid::Template.parse("{{ name | default: 'Bar' }}")
+      result = render_with_filter(template, { "name" => nil })
+      result.must_equal "Bar"
+    end
+
+    it "should return default value if input is an empty string" do
+      template = Liquid::Template.parse("{{ name | default: 'Bar' }}")
+      result = render_with_filter(template, { "name" => "" })
+      result.must_equal "Bar"
+    end
+
+    it "should return default value if input is an empty hash" do
+      template = Liquid::Template.parse("{{ name | default: 'Bar' }}")
+      result = render_with_filter(template, { "name" => {} })
+      result.must_equal "Bar"
+    end
+
+    it "should return default value if input is an empty array" do
+      template = Liquid::Template.parse("{{ name | default: 'Bar' }}")
+      result = render_with_filter(template, { "name" => [] })
+      result.must_equal "Bar"
+    end
+
+    it "should return default value if input is false" do
+      template = Liquid::Template.parse("{{ name | default: 'Bar' }}")
+      result = render_with_filter(template, { "name" => false })
+      result.must_equal "Bar"
+    end
+  end
+end

data/spec/condensation/filters/hyperlink_spec.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Condensation::Filters::Hyperlink do
+  def render_with_filter(template, context)
+    template.render(context, :filters => [Condensation::Filters::Hyperlink])
+  end
+
+  describe "#hyperlink" do
+    it "should use the URL as the anchor text if none provided" do
+      url = "http://www.example.com"
+      template = Liquid::Template.parse("{{ url | hyperlink }}")
+      result = render_with_filter(template, { "url" => url })
+      result.must_equal "<a href='#{url}'>#{url}</a>"
+    end
+
+    it "should use the provided anchor text" do
+      url = "http://www.example.com"
+      template = Liquid::Template.parse("{{ url | hyperlink: 'Click here!' }}")
+      result = render_with_filter(template, { "url" => url })
+      result.must_equal "<a href='#{url}'>Click here!</a>"
+    end
+
+    it "should escape HTML in the URL" do
+      url = "<script>attack.me()</script>"
+      escaped = "&lt;script&gt;attack.me()&lt;/script&gt;"
+      template = Liquid::Template.parse("{{ url | hyperlink }}")
+      result = render_with_filter(template, { "url" => url })
+      result.must_equal "<a href='#{escaped}'>#{escaped}</a>"
+    end
+
+    it "should escape HTML in the anchor text" do
+      url = "http://www.example.com"
+      text = "<script>attack.me()</script>"
+      escaped = "&lt;script&gt;attack.me()&lt;/script&gt;"
+      template = Liquid::Template.parse("{{ url | hyperlink: '#{text}' }}")
+      result = render_with_filter(template, { "url" => url })
+      result.must_equal "<a href='#{url}'>#{escaped}</a>"
+    end
+
+    it "should return empty string if input is nil" do
+      template = Liquid::Template.parse("{{ url | hyperlink }}")
+      result = render_with_filter(template, {})
+      result.must_equal ""
+    end
+
+    it "should handle numeric input" do
+      template = Liquid::Template.parse("{{ url | hyperlink: 'Bar' }}")
+      result = render_with_filter(template, { "url" => 1 })
+      result.must_equal "<a href='1'>Bar</a>"
+    end
+  end
+end

data/spec/condensation/filters/replace_inner_html_spec.rb

@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../../spec_helper.rb'
+
+describe Condensation::Filters::ReplaceInnerHTML do
+  def render_with_filter(template, context)
+    template.render(context, :filters => [Condensation::Filters::ReplaceInnerHTML])
+  end
+
+  describe "#replace_inner_html" do
+    it "should replace the inner content of a given HTML tag" do
+      tag = "<a href='http://www.example.com'>Foo</a>"
+      template = Liquid::Template.parse("{{ example_link | replace_inner_html: 'Bar' }}")
+      result = render_with_filter(template, { "example_link" => tag })
+      result.must_equal "<a href='http://www.example.com'>Bar</a>"
+    end
+
+    it "should not alter malformed input" do
+      tags = [
+        "< a href='http://www.example.com'>Foo</a>",
+        "<a href='http://www.example.com'>Foo< /a>",
+        "<a href='http://www.example.com'>Foo",
+        " <a href='http://www.example.com'>Foo</a> "
+      ]
+
+      tags.each do |tag|
+        template = Liquid::Template.parse("{{ example_link | replace_inner_html: 'Bar' }}")
+        result = render_with_filter(template, { "example_link" => tag })
+        result.must_equal tag
+      end
+    end
+
+    it "should return empty string if input is nil" do
+      template = Liquid::Template.parse("{{ example_link | replace_inner_html: 'Bar' }}")
+      result = render_with_filter(template, {})
+      result.must_equal ""
+    end
+
+    it "should handle numeric input" do
+      template = Liquid::Template.parse("{{ example_link | replace_inner_html: 'Bar' }}")
+      result = render_with_filter(template, { "example_link" => 1 })
+      result.must_equal "1"
+    end
+  end
+end

data/spec/condensation/sanitizer_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Condensation::Sanitizer do
+  describe "#escape_html" do
+    it "should escape HTML entities" do
+      html = "<div><a href='http://foo.bar/?x=r%20b&y=z'>Baz</a></div>"
+      escaped = "&lt;div&gt;&lt;a href='http://foo.bar/?x=r%20b&amp;y=z'&gt;Baz&lt;/a&gt;&lt;/div&gt;"
+      Condensation::Sanitizer.new(html).escape_html.must_equal(escaped)
+    end
+  end
+end

data/spec/condensation_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Condensation do
+  describe "#register_filters" do
+    # TODO
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'condensation'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: condensation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Derrick Reimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A collection of handy extensions to the Liquid templating language
+email:
+- derrickreimer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- condensation.gemspec
+- lib/condensation.rb
+- lib/condensation/filters.rb
+- lib/condensation/filters/default.rb
+- lib/condensation/filters/hyperlink.rb
+- lib/condensation/filters/replace_inner_html.rb
+- lib/condensation/sanitizer.rb
+- lib/condensation/version.rb
+- spec/condensation/filters/default_spec.rb
+- spec/condensation/filters/hyperlink_spec.rb
+- spec/condensation/filters/replace_inner_html_spec.rb
+- spec/condensation/sanitizer_spec.rb
+- spec/condensation_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/djreimer/condensation
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Condensation is a collection of handy extensions to the Liquid templating
+  language
+test_files:
+- spec/condensation/filters/default_spec.rb
+- spec/condensation/filters/hyperlink_spec.rb
+- spec/condensation/filters/replace_inner_html_spec.rb
+- spec/condensation/sanitizer_spec.rb
+- spec/condensation_spec.rb
+- spec/spec_helper.rb