RubyGems - undies - Versions diffs - 0.0.1 - Mend

undies 0.0.1

Files changed (20) hide show

data/.gitignore ADDED Viewed

@@ -0,0 +1,4 @@
+pkg/*
+.bundle
+*.gem
+*.log

data/Gemfile ADDED Viewed

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+# Specify dependencies in undies.gemspec
+gemspec
+gem 'rake', '~>0.9.2'

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    undies (0.0.1)
+GEM
+  remote: http://rubygems.org/
+  specs:
+    leftright (0.9.1)
+    rake (0.9.2)
+    test-belt (1.1.2)
+      leftright (~> 0.9.0)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  bundler (~> 1.0)
+  rake (~> 0.9.2)
+  test-belt (~> 1.1.0)
+  undies!

data/README.rdoc ADDED Viewed

@@ -0,0 +1,58 @@
+= Undies
+A pure-Ruby DSL for writing HTML templates.  Named for its gratuitous use of the underscore.
+== Installation
+    $ gem install undies
+== Usage
+Empty tag:
+    _br # => "<br />"
+Tag with content:
+    _h1 {
+      _ "Some Header"
+    } # => "<h1>Some Header</h1>"
+Nested tags:
+    _body {
+      _div {
+        _ "Some Content"
+      }
+    } # => "<body><div>Some Content</div></body>"
+Buffer escaped output:
+    _ "this will be escaped & and added to the buffer"
+    # => "this will be escaped &amp; added to the buffer"
+Buffer un-escaped output:
+    __ "this will <em>not</em> be escaped"
+    # => "this will <em>not</em> be escaped"
+Tag with attributes
+    _h1(:class => 'title', :title => "A Header")
+    # => "<h1 class=\"title\" title=\"A Header\" />"
+Tag with id attribute
+    _h1.header!
+    # => "<h1 id=\"header\" />"
+Tag with class attributes
+    _h1.header.awesome
+    # => "<h1 class=\"header awesome\" />"
+== License
+Copyright (c) 2011 Kelly D. Redding
+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/Rakefile ADDED Viewed

@@ -0,0 +1,9 @@
+include Rake::DSL
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'test_belt/rake_tasks'
+TestBelt::RakeTasks.for :test
+task :default => :build

data/lib/undies.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require 'undies/template'
+module Undies
+  # TODO: maybe implement this pattern??
+  # class << self
+  #   def new(&block)
+  #     Template.new(&block)
+  #   end
+  # end
+end

data/lib/undies/buffer.rb ADDED Viewed

@@ -0,0 +1,81 @@
+module Undies
+  class Buffer < ::Array
+    def initialize(*args)
+      super()
+    end
+    # Add data and don't escape it
+    def __(data="")
+      append_item(data)
+    end
+    # Add data and escape it
+    def _(data="")
+      append_item(escape_html(data))
+    end
+    TAG_METH_REGEX = /^_(.+)$/
+    def method_missing(meth, *args, &block)
+      if meth.to_s =~ TAG_METH_REGEX
+        tag($1, *args, &block)
+      else
+        super
+      end
+    end
+    def respond_to?(*args)
+      if args.first.to_s =~ TAG_METH_REGEX
+        true
+      else
+        super
+      end
+    end
+    def tag(name, attrs={}, &block)
+      append_item(new_tag=Tag.new(name, attrs, &block))
+      new_tag
+    end
+    def to_s(pp_level=0, pp_indent=nil)
+      self.collect do |i|
+        begin
+          i.to_s(pp_level, pp_indent)
+        rescue ArgumentError => err
+          pretty_print(i.to_s, pp_level, pp_indent)
+        end
+      end.join
+    end
+    protected
+    def pretty_print(data, level, indent)
+      indent ? "#{' '*level*indent}#{data}\n" : data
+    end
+    private
+    def append_item(data)
+      self << data
+    end
+    # Ripped from Rack v1.3.0 ======================================
+    # => ripped b/c I don't want a dependency on Rack for just this
+    ESCAPE_HTML = {
+      "&" => "&amp;",
+      "<" => "&lt;",
+      ">" => "&gt;",
+      "'" => "&#x27;",
+      '"' => "&quot;",
+      "/" => "&#x2F;"
+    }
+    ESCAPE_HTML_PATTERN = Regexp.union(*ESCAPE_HTML.keys)
+    # Escape ampersands, brackets and quotes to their HTML/XML entities.
+    def escape_html(string)
+      string.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
+    end
+    # end Rip from Rack v1.3.0 =====================================
+  end
+end

data/lib/undies/source.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module Undies
+  class Source
+    attr_reader :file, :block, :data
+    def initialize(file=nil, block=nil)
+      raise ArgumentError, "file or block required" if (file || block).nil?
+      @file = file
+      @block = block
+      # load template data and prepare (uses binread to avoid encoding issues)
+      @data = @block || if File.respond_to?(:binread)
+        File.binread(@file)
+      else
+        File.read(@file)
+      end
+    end
+    def file?
+      !!self.file
+    end
+  end
+end

data/lib/undies/tag.rb ADDED Viewed

@@ -0,0 +1,87 @@
+require 'undies/buffer'
+module Undies
+  class Tag < Buffer
+    attr_reader :attrs
+    def initialize(name=nil, attrs={}, &block)
+      super
+      @name = name
+      @attrs = attrs
+      self.content = block
+    end
+    ID_METH_REGEX = /^([^_].+)!$/
+    CLASS_METH_REGEX = /^([^_].+)$/
+    def method_missing(meth, *args, &block)
+      if meth.to_s =~ ID_METH_REGEX
+        proxy_id_attr($1, *args, &block)
+      elsif meth.to_s =~ CLASS_METH_REGEX
+        proxy_class_attr($1, *args, &block)
+      else
+        super
+      end
+    end
+    def respond_to?(*args)
+      if args.first.to_s =~ ID_METH_REGEX || args.first.to_s =~ CLASS_METH_REGEX
+        true
+      else
+        super
+      end
+    end
+    def to_s(pp_level=0, pp_indent=nil)
+      out = ""
+      if @content
+        out << pretty_print("<#{@name}#{html_attrs(@attrs)}>", pp_level, pp_indent)
+        out << super(pp_level+1, pp_indent)
+        out << pretty_print("</#{@name}>", pp_level, pp_indent)
+      else
+        out << pretty_print("<#{@name}#{html_attrs(@attrs)} />", pp_level, pp_indent)
+      end
+      out
+    end
+    protected
+    def html_attrs(attrs={})
+      raise ArgumentError unless attrs.kind_of? ::Hash
+      if attrs.empty?
+        ''
+      else
+        ' '+attrs.
+        sort {|a,b|  a[0].to_s <=> b[0].to_s}.
+        collect {|k_v| "#{k_v[0]}=\"#{k_v[1]}\""}.
+        join(' ').
+        strip
+      end
+    end
+    private
+    def proxy_id_attr(value, attrs={}, &block)
+      @attrs.merge!(:id => value)
+      @attrs.merge!(attrs)
+      self.content = block
+      self
+    end
+    def proxy_class_attr(value, attrs={}, &block)
+      @attrs[:class] = [@attrs[:class], value].compact.join(' ')
+      @attrs.merge!(attrs)
+      self.content = block
+      self
+    end
+    def content=(block)
+      if block
+        @content = block
+        instance_eval(&@content)
+      end
+    end
+  end
+end

data/lib/undies/template.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'undies/source'
+require 'undies/buffer'
+require 'undies/tag'
+module Undies
+  class Template < Buffer
+    def initialize(file=nil, &block)
+      super
+      if (@source = Source.new(file, block)).file?
+        instance_eval(@source.data, @source.file, 1)
+      else
+        instance_eval(&@source.data)
+      end
+    end
+    def to_s(pp_indent=nil)
+      super(0, pp_indent)
+    end
+  end
+end

data/lib/undies/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Undies
+  VERSION = "0.0.1"
+end

data/test/buffer_test.rb ADDED Viewed

@@ -0,0 +1,79 @@
+require "test/helper"
+require "undies/buffer"
+require "undies/tag"
+class Undies::Buffer
+  class BasicTest < Test::Unit::TestCase
+    include TestBelt
+    context 'a buffer'
+    subject { Undies::Buffer.new }
+    should have_instance_methods :to_s, :_, :__, :tag
+    should "be a kind of ::Array" do
+      assert subject.kind_of?(::Array)
+    end
+  end
+  class DataTest < BasicTest
+    context "with data"
+    before do
+      @data = "stuff & <em>more stuff</em>"
+    end
+    should "add it un-escaped using the '__' method" do
+      subject.__ @data
+      assert_equal "stuff & <em>more stuff</em>", subject.to_s
+    end
+    should "add it escaped using the '_' method" do
+      subject._ @data
+      assert_equal "stuff &amp; &lt;em&gt;more stuff&lt;&#x2F;em&gt;", subject.to_s
+    end
+  end
+  class TagTest < BasicTest
+    context "when using the tag method"
+    should "return a new Tag object" do
+      assert_equal Undies::Tag.new(:br), subject.tag(:br)
+    end
+    should "add a new Tag object" do
+      subject.tag(:br)
+      assert_equal Undies::Tag.new(:br), subject.first
+    end
+    should "respond to any underscore prefix method" do
+      assert subject.respond_to?(:_div)
+    end
+    should "not respond to tag methods without an underscore prefix" do
+      assert !subject.respond_to?(:div)
+      assert_raises NoMethodError do
+        subject.div
+      end
+    end
+    should "interpret underscore prefix methods as a tag" do
+      assert_equal subject._div, subject.tag(:div)
+    end
+  end
+  # TODO: pretty printing
+end

data/test/env.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# Add test and lib paths to the $LOAD_PATH
+[ File.dirname(__FILE__),
+  File.join(File.dirname(__FILE__), '..', 'lib')
+].each do |path|
+  full_path = File.expand_path(path)
+  $LOAD_PATH.unshift(full_path) unless $LOAD_PATH.include?(full_path)
+end
+require 'undies'

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'test_belt'
+require 'test/env'

data/test/source_test.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require "test/helper"
+require "undies/source"
+class Undies::Source
+  class BasicTest < Test::Unit::TestCase
+    include TestBelt
+    context 'a source'
+    subject { Undies::Source.new(nil, Proc.new {}) }
+    should have_instance_method :file?
+    should have_readers :file, :block, :data
+    should "need a file or block to initialize" do
+      assert_raises ArgumentError do
+        Undies::Source.new
+      end
+    end
+  end
+  class BlockTest < BasicTest
+    context 'from a block'
+    subject { Undies::Source.new(nil, Proc.new {}) }
+    should "not be a file source" do
+      assert !subject.file?
+    end
+  end
+  class FileTest < BasicTest
+    context 'from a file'
+    subject do
+      file = 'test/test_template.html.rb'
+      Undies::Source.new(File.expand_path(file))
+    end
+    should "be a file source" do
+      assert subject.file?
+    end
+  end
+end

data/test/tag_test.rb ADDED Viewed

@@ -0,0 +1,152 @@
+require "test/helper"
+require "undies/tag"
+class Undies::Tag
+  class BasicTest < Test::Unit::TestCase
+    include TestBelt
+    context 'a tag'
+    subject { Undies::Tag.new(:div) }
+    should have_instance_methods :to_s, :attrs
+  end
+  class HtmlAttrsTest < BasicTest
+    context "html_attrs util"
+    should "convert an empty hash to html attrs" do
+      assert_equal('', subject.send(:html_attrs, {}))
+    end
+    should "convert a basic hash to html attrs" do
+      attrs = subject.send(:html_attrs, :class => "test", :id => "test_1")
+      assert_match /^\s{1}/, attrs
+      assert attrs.include?('class="test"')
+      assert attrs.include?('id="test_1"')
+    end
+    should "convert a nested hash to html attrs" do
+      attrs = subject.send(:html_attrs, {
+        :class => "testing", :id => "test_2",
+        :nested => {:something => 'is_awesome'}
+      })
+      assert_match /^\s{1}/, attrs
+      assert attrs.include?('class="testing"')
+      assert attrs.include?('id="test_2"')
+      assert attrs.include?('nested="somethingis_awesome"')
+    end
+  end
+  class SerializeTest < BasicTest
+    context "when serialized"
+    should "buffer an empty html tag with no attrs" do
+      tag = Undies::Tag.new(:br)
+      assert_equal "<br />", tag.to_s
+    end
+    should "buffer an html tag with attrs" do
+      tag = Undies::Tag.new(:br, {:class => 'big'})
+      assert_equal '<br class="big" />', tag.to_s
+    end
+    should "buffer an html tag with attrs and content" do
+      tag = Undies::Tag.new(:strong, {:class => 'big'}) { __ "Loud Noises!" }
+      assert_equal '<strong class="big">Loud Noises!</strong>', tag.to_s
+    end
+  end
+  class CSSProxyTest < BasicTest
+    should "respond to any method ending in '!' as an id proxy" do
+      assert subject.respond_to?(:asdgasdg!)
+    end
+    should "proxy id attr with methods ending in '!'" do
+      assert_equal({
+        :id => 'thing1'
+      }, subject.thing1!.attrs)
+    end
+    should "nest tags from proxy id call" do
+      assert_equal(
+        "<div id=\"thing1\">stuff</div>",
+        subject.thing1! { _ 'stuff' }.to_s
+      )
+    end
+    should "proxy id attr with last method call ending in '!'" do
+      assert_equal({
+        :id => 'thing2'
+      }, subject.thing1!.thing2!.attrs)
+    end
+    should "set id attr to explicit if called last " do
+      assert_equal({
+        :id => 'thing3'
+      }, subject.thing1!.thing2!(:id => 'thing3').attrs)
+    end
+    should "set id attr to proxy if called last" do
+      assert_equal({
+        :id => 'thing1'
+      }, subject.thing2!(:id => 'thing3').thing1!.attrs)
+    end
+    should "respond to any other method as a class proxy" do
+      assert subject.respond_to?(:asdgasdg)
+    end
+    should "proxy single html class attr" do
+      assert_equal({
+        :class => 'thing'
+      }, subject.thing.attrs)
+    end
+    should "nest tags from proxy class call" do
+      assert_equal(
+        "<div class=\"thing\">stuff</div>",
+        subject.thing { _ 'stuff' }.to_s
+      )
+    end
+    should "proxy multi html class attrs" do
+      assert_equal({
+        :class => 'list thing awesome'
+      }, subject.list.thing.awesome.attrs)
+    end
+    should "set class attr with explicit if called last " do
+      assert_equal({
+        :class => 'list'
+      }, subject.thing.awesome(:class => "list").attrs)
+    end
+    should "update class attr with proxy if called last" do
+      assert_equal({
+        :class => 'list is good'
+      }, subject.thing.awesome(:class => "list is").good.attrs)
+    end
+    should "proxy mixed class and id selector attrs" do
+      assert_equal({
+        :class => 'list is good',
+        :id => "thing3"
+      }, subject.thing1!.awesome({
+        :class => "list is",
+        :id => "thing2"
+      }).good.thing3!.attrs)
+    end
+  end
+end

data/test/template_test.rb ADDED Viewed

@@ -0,0 +1,57 @@
+require "test/helper"
+require "undies/template"
+class Undies::Template
+  class BasicTest < Test::Unit::TestCase
+    include TestBelt
+    context 'template'
+    subject { Undies::Template.new {} }
+    should have_instance_methods :to_s
+  end
+  class DefinitionTest < BasicTest
+    should "generate markup given a block" do
+      assert_equal(
+        "<html><head></head><body><div class=\"loud element\" id=\"header\">YEA!!</div></body></html>",
+        Undies::Template.new do
+          _html {
+            _head {}
+            _body {
+              _div.header!.loud.element {
+                __ "YEA!!"
+              }
+            }
+          }
+        end.to_s
+      )
+    end
+    should "generate markup given a file" do
+      file = 'test/test_template.html.rb'
+      assert_equal(
+        "<html><head></head><body><div class=\"file\">FILE!!</div></body></html>",
+        Undies::Template.new(File.expand_path(file)).to_s
+      )
+    end
+    should "generate pretty printed markup" do
+      file = 'test/test_template.html.rb'
+      assert_equal(
+        %{<html>
+  <head>
+  </head>
+  <body>
+    <div class="file">
+      FILE!!
+    </div>
+  </body>
+</html>
+},
+        Undies::Template.new(File.expand_path(file)).to_s(2)
+      )
+    end
+  end
+end

data/test/test_template.html.rb ADDED Viewed

@@ -0,0 +1,8 @@
+_html {
+  _head {}
+  _body {
+    _div.file {
+      __ "FILE!!"
+    }
+  }
+}

data/undies.gemspec ADDED Viewed

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "undies/version"
+Gem::Specification.new do |s|
+  s.name        = "undies"
+  s.version     = Undies::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kelly D. Redding"]
+  s.email       = ["kelly@kelredd.com"]
+  s.homepage    = "http://github.com/kelredd/undies"
+  s.summary     = %q{A pure-Ruby HTML templating DSL.}
+  s.description = %q{A pure-Ruby HTML templating DSL.}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency("bundler", ["~> 1.0"])
+  s.add_development_dependency("test-belt", ["~> 1.1.0"])
+end

metadata ADDED Viewed

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: undies
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease:
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors:
+- Kelly D. Redding
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-07-22 00:00:00 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 15
+        segments:
+        - 1
+        - 0
+        version: "1.0"
+  version_requirements: *id001
+  prerelease: false
+  name: bundler
+  type: :development
+- !ruby/object:Gem::Dependency
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        hash: 19
+        segments:
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  version_requirements: *id002
+  prerelease: false
+  name: test-belt
+  type: :development
+description: A pure-Ruby HTML templating DSL.
+email:
+- kelly@kelredd.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/undies.rb
+- lib/undies/buffer.rb
+- lib/undies/source.rb
+- lib/undies/tag.rb
+- lib/undies/template.rb
+- lib/undies/version.rb
+- test/buffer_test.rb
+- test/env.rb
+- test/helper.rb
+- test/source_test.rb
+- test/tag_test.rb
+- test/template_test.rb
+- test/test_template.html.rb
+- undies.gemspec
+homepage: http://github.com/kelredd/undies
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.7.2
+signing_key:
+specification_version: 3
+summary: A pure-Ruby HTML templating DSL.
+test_files:
+- test/buffer_test.rb
+- test/env.rb
+- test/helper.rb
+- test/source_test.rb
+- test/tag_test.rb
+- test/template_test.rb
+- test/test_template.html.rb