RubyGems - Q - Versions diffs - 0.0.1 - Mend

Q 0.0.1

Files changed (11) hide show

data/.gitignore ADDED

	@@ -0,0 +1,2 @@
1	+ pkg/*
2	+ *.gem

data/Gemfile ADDED

@@ -0,0 +1,4 @@
+source :gemcutter
+# Specify your gem's dependencies in q.gemspec
+gemspec

data/Gemfile.lock ADDED

@@ -0,0 +1,18 @@
+PATH
+  remote: .
+  specs:
+    Q (0.0.1)
+      escape_utils (>= 0.1.5)
+GEM
+  remote: http://rubygems.org/
+  specs:
+    escape_utils (0.1.5)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  Q!
+  bundler (>= 1.0.0.rc.3)
+  escape_utils (>= 0.1.5)

data/README.rdoc ADDED

@@ -0,0 +1,37 @@
+= Q
+== Programmatic generation of HTML
+Often, within helpers, I want to output some HTML without resorting to a templating language. Here is my attempt to do so:
+  => Q {_div { __'this my divs contents' }}
+  <= <div>This is my divs contents</div>
+Or, with attributes
+  => Q {_div(:id => 'test') { __'this my divs contents' }}
+  <= <div id="test">This is my divs contents</div>
+Of course, this is all escaped
+  => Q {_div { __'<tag! tag!>' }}
+  <= <div>&lt;tag! tag!&gt;</div>
+Or, you can turn that off
+  => Q {_div { __no_escape'<tag! tag!>' }}
+  <= <div><tag! tag!></div>
+Or, you can indent too
+  => Q(:indent => 2) {_div { __'some awesome contents' }}
+  <= <div>
+       Some awesome contents
+     </div>
+And, you can one-line those values
+=> Q {_div 'some awesome contents' }}
+<= <div>Some awesome contents</div>
+Nest as much as you want, and use the QX method for XHTML based output.

data/Rakefile ADDED

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/q.rb ADDED

@@ -0,0 +1,99 @@
+require 'escape_utils'
+def Q(opts = nil, &blk)
+  Q.new(opts, &blk).to_s
+end
+def QX(opts, &blk)
+  Q(opts ? opts.merge(:xml_compat => true) : nil, &blk).to_s
+end
+class Q
+  VALID_TAGS = %w(a abbr acronym address area b base bdo big blockquote body br button caption cite code col colgroup dd del dfn div dl dt em fieldset form h1 h2 h3 h4 h5 h6 head html hr i img input ins kbd label legend li link map meta noscript object ol optgroup option p param pre q samp script select small span strong style sub sup table tbody td textarea tfoot th thead title tr tt ul var article aside audio canvas command datalist details embed figcaption figure footer header hgroup keygen mark meter nav output progress rp rt ruby section source summary time video)
+  def initialize(opts = nil, &block)
+    @__xml_compat = opts && opts.key?(:xml) ? opts[:xml] : false
+    @__indent = opts && opts.key?(:indent) ? opts[:indent] : false
+    @__default_doctype = opts && opts.key?(:doctype) ? opts[:doctype] : (@__xml_compat ? :xhtml_11 : :html5)
+    @__out = ''
+    @__level = 0
+    instance_eval(&block)
+  end
+  VALID_TAGS.each do |tag|
+    module_eval "
+    def _#{tag}(value = nil, opts = nil, &blk)
+      _(#{tag.inspect}, value, opts, &blk)
+    end
+    "
+  end
+  def div(class_or_id, value = nil, opts = nil, &blk)
+    attr_name, attr_val = case class_or_id[0]
+    when ?.
+      ['class', class_or_id[1, class_or_id.size - 1]]
+    when ?#
+      ['class', class_or_id[1, class_or_id.size - 1]]
+    end
+    _('div', value, opts ? {attr_name => attr_val}.merge(opts) : {attr_name => attr_val}, &blk)
+  end
+  def _doctype(type = @__default_doctype)
+    @__out << case type
+    when :html_401_strict       then '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">'
+    when :html_401_transitional then '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">'
+    when :html_401_frameset     then '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">'
+    when :xhtml_10_strict       then '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
+    when :xhtml_10_transitional then '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">'
+    when :xhtml_10_frameset     then '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">'
+    when :xhtml_11              then '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'
+    when :xhtml_11_basic        then '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.1//EN" "http://www.w3.org/TR/xhtml-basic/xhtml-basic11.dtd">'
+    when :html5                 then '<!DOCTYPE HTML>'
+    end
+  end
+  def _(tagname, value = nil, opts = nil, &blk)
+    if @__indent and !@__level.zero?
+      @__out << "\n"
+      @__level.times {__(@__indent)}
+    end
+    if value.is_a?(Hash)
+      opts = value
+      value = nil
+    end
+    @__out << "<#{tagname}"
+    if opts and !opts.empty?
+      opts.each do |k,v|
+        @__out << " #{EscapeUtils.escape_html(k.to_s)}=\"#{EscapeUtils.escape_html(v.to_s)}\""
+      end
+    end
+    if blk or value
+      @__out << '>'
+      __(value) if value
+      @__level += 1
+      instance_eval(&blk) if blk
+      @__level -= 1
+      if @__indent && blk
+        @__out << "\n"
+        @__level.times {__(@__indent)}
+      end
+      @__out << "</#{tagname}>"
+    else
+      @__out << (@__xml_compat ? '/>' : '>')
+    end
+    self
+  end
+  def __no_escape(text)
+    @__out << text
+    self
+  end
+  def __(text)
+    __no_escape EscapeUtils.escape_html(text)
+    self
+  end
+  def to_s
+    @__out
+  end
+end

data/lib/q/version.rb ADDED

@@ -0,0 +1,3 @@
+class Q
+  VERSION = "0.0.1"
+end

data/q.gemspec ADDED

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'q/version'
+Gem::Specification.new do |s|
+  s.name        = "Q"
+  s.version     = Q::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = []
+  s.email       = []
+  s.homepage    = "http://rubygems.org/gems/q"
+  s.summary     = "Fast, fun, east HTML generation from Ruby"
+  s.description = "Fast, fun, east HTML generation from Ruby"
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "Q"
+  s.add_dependency 'escape_utils', ">= 0.1.5"
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.3"
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.require_path = 'lib'
+end

data/test/q_test.rb ADDED

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__),'teststrap')
+context "Q" do
+  context "generating div" do
+    setup { Q{_div{}} }
+    asserts_topic.equals("<div></div>")
+  end
+  context "generating div with contents" do
+    setup { Q{_div{ __"<this is contents>"}} }
+    asserts_topic.equals("<div>&lt;this is contents&gt;</div>")
+  end
+  context "generating div with non-escaped contents" do
+    setup { Q{_div{ __no_escape"<this is contents>"}} }
+    asserts_topic.equals("<div><this is contents></div>")
+  end
+  context "generating nested HTML" do
+    setup { Q{_div{ _span{__'this is awesome'}}} }
+    asserts_topic.equals("<div><span>this is awesome</span></div>")
+  end
+  context "generating with indent" do
+    setup { Q(:indent => ' '){_div{ _span{__'this is awesome'}}} }
+    asserts_topic.equals("<div>\n <span>this is awesome\n </span>\n</div>")
+  end
+  context "generating divs with attrs" do
+    setup { Q{_div(:id => '"this is my attribute"'){ __"<this is contents>"}} }
+    asserts_topic.equals("<div id=\"&quot;this is my attribute&quot;\">&lt;this is contents&gt;</div>")
+  end
+end

data/test/teststrap.rb ADDED

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'tempfile'
+require 'fileutils'
+require 'riot'
+require 'mocha'
+$LOAD_PATH << File.basename(__FILE__)
+$LOAD_PATH << File.join(File.basename(__FILE__), '..', 'lib')
+require 'q'
+Riot.reporter = Riot::DotMatrixReporter

metadata ADDED

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: Q
+version: !ruby/object:Gem::Version
+  hash: 29
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: []
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-08-08 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: escape_utils
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 17
+        segments:
+        - 0
+        - 1
+        - 5
+        version: 0.1.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 15424051
+        segments:
+        - 1
+        - 0
+        - 0
+        - rc
+        - 3
+        version: 1.0.0.rc.3
+  type: :development
+  version_requirements: *id002
+description: Fast, fun, east HTML generation from Ruby
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/q.rb
+- lib/q/version.rb
+- q.gemspec
+- test/q_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/q
+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: 23
+      segments:
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+rubyforge_project: Q
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Fast, fun, east HTML generation from Ruby
+test_files: []