RubyGems - timl - Versions diffs - 0.1 - Mend

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (22) hide show

data/.gitignore ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ .session.vim
2	+ .rvmrc

data/.travis.yml ADDED Viewed

@@ -0,0 +1,3 @@
+rvm:
+  - 1.9.3
+  - 1.9.2

data/Gemfile ADDED Viewed

@@ -0,0 +1,6 @@
+source :rubygems
+group :development do
+  gem 'rspec'
+  gem 'rake'
+end

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  rake
+  rspec

data/README.md ADDED Viewed

@@ -0,0 +1,142 @@
+# Timl
+Timl is an amalgamation of Tiny XML. I created it because I find the builder DSL
+to be a little bit cluttered and hard to digest at first glance.
+Timl aims to be very small and very intuitive to use. The main code that does
+all of the heavy lifting is less than 100 lines of code, including comments.
+### Build statuses
+Develop: [![Build Status](https://secure.travis-ci.org/samwho/timl.png?branch=develop)](http://travis-ci.org/samwho/timl)
+Master: [![Build Status](https://secure.travis-ci.org/samwho/timl.png?branch=master)](http://travis-ci.org/samwho/timl)
+# Installation
+The installation is a standard RubyGem installation:
+    gem install timl
+# Usage
+The Timl DSL is very intuitive. It relies on some Ruby metaprogramming under the
+hood that will catch methods that have not been defined and define them. What
+this means to you, the user, is that you can use any XML tag you want as part of
+the DSL. Let's see an example:
+``` ruby
+require 'timl'
+Timl.start do
+  body do
+    p { "This is a paragraph tag." }
+  end
+end
+```
+The return value of that code is the following XML:
+``` xml
+<body>
+  <p>
+    This is a paragraph tag.
+  </p>
+</body>
+```
+Which is what you would expect, right?
+## Attributes in XML
+The above example is a bit simple. What is you want attributes in your XML? Timl
+can do that too:
+``` ruby
+require 'timl'
+Timl.start do
+  div id: "content" do
+    p style: "font-weight: bold" do
+      "This is a bold paragraph."
+    end
+  end
+end
+```
+Which, unsurprisingly, produces the following XML (I realise these are HTML
+examples, but the library really isn't constrained to HTML):
+``` xml
+<div id='content'>
+  <p style='font-weight: bold'>
+    This is a bold paragraph.
+  </p>
+</div>
+```
+## XML and HTML headers
+If you want to include XML and HTML header/doctype information, that's possible
+as well:
+``` ruby
+require 'timl'
+Timl.start do
+  xml_header
+end
+```
+Translates to:
+``` xml
+<?xml version='1.0' encoding='UTF-8'?>
+```
+If you want to use a different encoding, that's possible too:
+``` ruby
+require 'timl'
+Timl.start do
+  xml_header encoding: "UTF-16"
+end
+```
+Translates to:
+``` xml
+<?xml version='1.0' encoding='UTF-16'?>
+```
+### HTML doctype
+The HTML doctype is inserted in a very similar way:
+``` ruby
+require 'timl'
+Timl.start do
+  html5_doctype
+end
+```
+Translates to:
+``` xml
+<!DOCTYPE html>
+```
+Unfortunately doctypes before HTML5 are not currently supported. If there's
+overwhelming need for it in future, I might consider adding it.
+# Contributing
+If you want to contribute, please feel free. File an issue, fork the repo,
+submit a pull request, whatever you want to do. Please not, however, that I use
+git-flow as a branching strategy. If you aren't familiar with git-flow, look it
+up, learn it, love it :)
+Please don't submit pull requests to master. Pull requests must go to develop
+and come from a feature branch. Thanks!

data/Rakefile ADDED Viewed

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+task :default => 'test'
+desc "Run tests"
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.rspec_opts = '-cfs'
+end

data/lib/timl.rb ADDED Viewed

@@ -0,0 +1,11 @@
+libdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
+module Timl
+  VERSION   = '0.1'
+  ROOTDIR   = File.expand_path(File.dirname(__FILE__) + '/..')
+  SPECDIR   = ROOTDIR + '/spec'
+end
+require 'rexml/document'
+require 'timl/timl'

data/lib/timl/timl.rb ADDED Viewed

@@ -0,0 +1,87 @@
+module Timl
+  # Dynamically defines a tag method so we don't have to hit method_missing all
+  # the time.
+  def self.define_tags *args
+    args.each do |tag|
+      self.class.instance_eval do
+        define_method tag do |*args, &block|
+          @@out <<  "<#{tag.to_s}#{parameterize args.first}>"
+          result = module_eval(&block)
+          @@out <<  result unless result.nil? || result.start_with?('<')
+          @@out <<  "</#{tag.to_s}>"
+          @@out
+        end
+      end
+    end
+  end
+  # Define tags to override existing methods that can mess with the DSL.
+  define_tags :p
+  # Start a Timl XML string. This is the main method for creating XML with Timl.
+  # It accepts a format as its first parameter, which can either be :flat or
+  # :pretty (defaults to :pretty). The :flat parameter gives you back XML that
+  # has no indentation. The :pretty option runs the generated XML through the
+  # REXML document formatter, which is a little slower but gives great
+  # readability.
+  #
+  # Timl.start then takes a block, which kicks off the DSL. Here's a simple
+  # example:
+  #
+  #   Timl.start :flat do
+  #     p { "This is a paragraph." }
+  #   end
+  #
+  #   #=> <p>This is a paragraph.</p>
+  #
+  # For more example please refer to the README.
+  def self.start format = :pretty, &block
+    @@out = ""
+    module_eval &block
+    case format
+    when :pretty
+      doc = REXML::Document.new(@@out)
+      doc.write(xml = '', 2)
+    when :flat
+      xml = @@out
+    else
+    end
+    @@out = ""
+    xml
+  end
+  def self.method_missing name, *args, &block
+    define_tags name
+    method(name).call args, &block
+  end
+  private
+  def self.parameterize hash
+    return "" unless hash.is_a? Hash
+    hash.inject("") do |memo, entry|
+      memo += " #{entry.first.to_s}=\"#{entry.last.to_s}\""
+    end
+  end
+  # Appends:
+  #
+  #   <?xml version="1.0" encoding="UTF-8" ?>
+  #
+  # To the resulting XML file.
+  def self.xml_header options = {}
+    options[:version] = "1.0" unless options[:version]
+    options[:encoding] = "UTF-8" unless options[:encoding]
+    @@out << "<?xml #{parameterize(options)} ?>"
+  end
+  # Appends:
+  #
+  #   <!DOCTYPE html>
+  #
+  # To the resulting XML file.
+  def self.html5_doctype
+    @@out << '<!DOCTYPE html>'
+  end
+end

data/spec/case/1.rb ADDED Viewed

@@ -0,0 +1,3 @@
+Timl.start :flat do
+  h1 { "Simple test!" }
+end

data/spec/case/2.rb ADDED Viewed

@@ -0,0 +1,6 @@
+Timl.start :flat do
+  div do
+    h1 { "Slightly more complex." }
+    h2 { "Example." }
+  end
+end

data/spec/case/3.rb ADDED Viewed

@@ -0,0 +1,5 @@
+Timl.start :pretty do
+  div do
+    p { "This should be pretty." }
+  end
+end

data/spec/case/4.rb ADDED Viewed

@@ -0,0 +1,11 @@
+Timl.start :pretty do
+  div id: "content" do
+    p class: "bold" do
+      "Attributes, anyone?"
+    end
+    p do
+      "And another paragraph for fun."
+    end
+  end
+end

data/spec/case/5.rb ADDED Viewed

@@ -0,0 +1,23 @@
+Timl.start :pretty do
+  html do
+    head do
+      script do
+        "alert('Wassup!');"
+      end
+    end
+    body do
+      table do
+        tr do
+          th { "Key" }
+          th { "Value" }
+        end
+        tr do
+          td { "Foo" }
+          td { "Bar" }
+        end
+      end
+    end
+  end
+end

data/spec/result/1.xml ADDED Viewed

	@@ -0,0 +1 @@
1	+ <h1>Simple test!</h1>

data/spec/result/2.xml ADDED Viewed

	@@ -0,0 +1 @@
1	+ <div><h1>Slightly more complex.</h1><h2>Example.</h2></div>

data/spec/result/3.xml ADDED Viewed

@@ -0,0 +1,5 @@
+<div>
+  <p>
+    This should be pretty.
+  </p>
+</div>

data/spec/result/4.xml ADDED Viewed

@@ -0,0 +1,8 @@
+<div id='content'>
+  <p class='bold'>
+    Attributes, anyone?
+  </p>
+  <p>
+    And another paragraph for fun.
+  </p>
+</div>

data/spec/result/5.xml ADDED Viewed

@@ -0,0 +1,27 @@
+<html>
+  <head>
+    <script>
+      alert('Wassup!');
+    </script>
+  </head>
+  <body>
+    <table>
+      <tr>
+        <th>
+          Key
+        </th>
+        <th>
+          Value
+        </th>
+      </tr>
+      <tr>
+        <td>
+          Foo
+        </td>
+        <td>
+          Bar
+        </td>
+      </tr>
+    </table>
+  </body>
+</html>

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../lib/timl'
+module Timl
+  CASEDIR   = SPECDIR + '/case'
+  RESULTDIR = SPECDIR + '/result'
+  CASES     = Dir["#{CASEDIR}/*"].sort
+  RESULTS   = Dir["#{RESULTDIR}/*"].sort
+  # Zip cases and results together in an array of arrays.
+  TESTPAIRS = CASES.zip(RESULTS)
+end

data/spec/timl_spec.rb ADDED Viewed

@@ -0,0 +1,17 @@
+require 'spec_helper'
+describe "Timl" do
+  it "should pass all examples cases in spec/case" do
+    Timl::TESTPAIRS.each do |pair|
+      test_case, result = pair
+      # Check that the eval'd test case is the same as the result content for
+      # each test pair. A test pair is a pair of numbered files from the
+      # spec/case and spec/result directories.
+      #
+      # The last File.read(result) has a .chomp because the File.read adds a
+      # newline to the end of a file for some reason.
+      eval(File.read(test_case)).should == File.read(result).chomp
+    end
+  end
+end

data/timl.gemspec ADDED Viewed

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/lib/timl'
+Gem::Specification.new do |s|
+  s.name = %q{timl}
+  s.version = Timl::VERSION
+  s.authors = ["Sam Rose"]
+  s.email = %q{samwho@lbak.co.uk}
+  s.summary = %q{A Tiny XML building library, akin to builder.}
+  s.homepage = %q{http://github.com/samwho/timl}
+  s.description = %q{Similar to builder, Timl provides a DSL for creating XML.}
+  s.required_ruby_version = '>= 1.9.2'
+  s.license = 'MIT'
+  # Add all files in git to the files parameter.
+  s.files = `git ls-files`.split /\n/
+end

metadata ADDED Viewed

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: timl
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease:
+platform: ruby
+authors:
+- Sam Rose
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-07-03 00:00:00.000000000 Z
+dependencies: []
+description: Similar to builder, Timl provides a DSL for creating XML.
+email: samwho@lbak.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/timl.rb
+- lib/timl/timl.rb
+- spec/case/1.rb
+- spec/case/2.rb
+- spec/case/3.rb
+- spec/case/4.rb
+- spec/case/5.rb
+- spec/result/1.xml
+- spec/result/2.xml
+- spec/result/3.xml
+- spec/result/4.xml
+- spec/result/5.xml
+- spec/spec_helper.rb
+- spec/timl_spec.rb
+- timl.gemspec
+homepage: http://github.com/samwho/timl
+licenses:
+- MIT
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A Tiny XML building library, akin to builder.
+test_files: []

timl 0.1