txprails 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jose Miguel Perez
+
+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.rdoc

@@ -0,0 +1,50 @@
+= TXPRrails
+
+*DISCLAIMER:*
+
+TXPRails born kind of a experiment. Please be aware that this is a work in
+progress.
+
+= TXPRails = TextPattern Rails
+
+This gem is a experiment for using TextPattern like templates in a Rails
+environment. Rails have many template engines available, from ERB thru Haml,
+etc. However, for many of us from a more traditional PHP/like environment,
+XML-style templates seems more natural. Moreover, Txp style templates differ
+from Haml or ERB in one thing: the templates are not "compiled" in the sense
+of making 1 pre-compile pass (Haml) or more-or-less-directly ruby-executed
+(ERB). Txp templates are executed while parsing, using different techniques
+explained below.
+
+I think Haml is kind of awesome, and I'm slowly getting used to it. However,
+I'm still fascinated of the elegance and simplicity of TXP XML'ish templates.
+
+So, in essence, I started this project solely for this pourposes:
+
+* Try to make my first publicy available Ruby Gem.
+* Test and experience the C/C++ binding of Ruby. (TXPRails is more or less
+  80% written in C++).
+* Learn and practice myself some advanced Rails techniques.
+* Just for fun... :-)
+
+*This project and some of the code (namely the Rails plugin bootstrap) is
+heavily inspired by Haml itself.*
+
+Please, PLEASE, if you find this gem useful, comment and make suggestions to make it better. I think you may also benefit and learn from TXPRails.
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyleft (c) 2010 Jose Miguel Perez. Do not see LICENSE for no details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "txprails"
+    gem.summary = %Q{TextPattern-like template engine for Rails}
+    gem.description = %Q{TXPRails is a template engine based on TextPattern for Rails.}
+    gem.email = "josemiguel@perezruiz.com"
+    gem.homepage = "http://github.com/twoixter/txprails"
+    gem.authors = ["Jose Miguel Pérez Ruiz"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "txprails #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/VERSION_NAME

@@ -0,0 +1 @@
+Domestikal Example

data/bin/txprails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# Command line utility for TXPRails
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'txprails'
+require 'txprails/commands'
+
+opts = TXPRails::Commands.new(ARGV)
+opts.parse!

data/ext/txparse/Makefile

@@ -0,0 +1,157 @@
+
+SHELL = /bin/sh
+
+#### Start of system configuration section. ####
+
+srcdir = .
+topdir = /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/universal-darwin10.0
+hdrdir = $(topdir)
+VPATH = $(srcdir):$(topdir):$(hdrdir)
+exec_prefix = $(prefix)
+prefix = $(DESTDIR)/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr
+sharedstatedir = $(prefix)/com
+mandir = $(DESTDIR)/usr/share/man
+psdir = $(docdir)
+oldincludedir = $(DESTDIR)/usr/include
+localedir = $(datarootdir)/locale
+bindir = $(exec_prefix)/bin
+libexecdir = $(exec_prefix)/libexec
+sitedir = $(DESTDIR)/Library/Ruby/Site
+htmldir = $(docdir)
+vendorarchdir = $(vendorlibdir)/$(sitearch)
+includedir = $(prefix)/include
+infodir = $(DESTDIR)/usr/share/info
+vendorlibdir = $(vendordir)/$(ruby_version)
+sysconfdir = $(prefix)/etc
+libdir = $(exec_prefix)/lib
+sbindir = $(exec_prefix)/sbin
+rubylibdir = $(libdir)/ruby/$(ruby_version)
+docdir = $(datarootdir)/doc/$(PACKAGE)
+dvidir = $(docdir)
+vendordir = $(libdir)/ruby/vendor_ruby
+datarootdir = $(prefix)/share
+pdfdir = $(docdir)
+archdir = $(rubylibdir)/$(arch)
+sitearchdir = $(sitelibdir)/$(sitearch)
+datadir = $(datarootdir)
+localstatedir = $(prefix)/var
+sitelibdir = $(sitedir)/$(ruby_version)
+
+CC = gcc
+LIBRUBY = $(LIBRUBY_SO)
+LIBRUBY_A = lib$(RUBY_SO_NAME)-static.a
+LIBRUBYARG_SHARED = -l$(RUBY_SO_NAME)
+LIBRUBYARG_STATIC = -l$(RUBY_SO_NAME)
+
+RUBY_EXTCONF_H = 
+CFLAGS   =  -fno-common -arch i386 -arch x86_64 -g -Os -pipe -fno-common -DENABLE_DTRACE  -fno-common  -pipe -fno-common $(cflags) 
+INCFLAGS = -I. -I$(topdir) -I$(hdrdir) -I$(srcdir)
+DEFS     = 
+CPPFLAGS =   -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE $(DEFS) $(cppflags)
+CXXFLAGS = $(CFLAGS) 
+ldflags  = -L. -arch i386 -arch x86_64 
+dldflags = 
+archflag = 
+DLDFLAGS = $(ldflags) $(dldflags) $(archflag)
+LDSHARED = $(CXX) -arch i386 -arch x86_64 -pipe -bundle -undefined dynamic_lookup
+AR = ar
+EXEEXT = 
+
+RUBY_INSTALL_NAME = ruby
+RUBY_SO_NAME = ruby
+arch = universal-darwin10.0
+sitearch = universal-darwin10.0
+ruby_version = 1.8
+ruby = /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
+RUBY = $(ruby)
+RM = rm -f
+MAKEDIRS = mkdir -p
+INSTALL = /usr/bin/install -c
+INSTALL_PROG = $(INSTALL) -m 0755
+INSTALL_DATA = $(INSTALL) -m 644
+COPY = cp
+
+#### End of system configuration section. ####
+
+preload = 
+
+libpath = . $(libdir)
+LIBPATH =  -L. -L$(libdir)
+DEFFILE = 
+
+CLEANFILES = mkmf.log
+DISTCLEANFILES = 
+
+extout = 
+extout_prefix = 
+target_prefix = /txprails
+LOCAL_LIBS = 
+LIBS = $(LIBRUBYARG_SHARED)  -lpthread -ldl  
+SRCS = txparse.cpp txparse_lib.cpp txparse_tag.cpp
+OBJS = txparse.o txparse_lib.o txparse_tag.o
+TARGET = txparse
+DLLIB = $(TARGET).bundle
+EXTSTATIC = 
+STATIC_LIB = 
+
+BINDIR        = $(bindir)
+RUBYCOMMONDIR = $(sitedir)$(target_prefix)
+RUBYLIBDIR    = $(sitelibdir)$(target_prefix)
+RUBYARCHDIR   = $(sitearchdir)$(target_prefix)
+
+TARGET_SO     = $(DLLIB)
+CLEANLIBS     = $(TARGET).bundle $(TARGET).il? $(TARGET).tds $(TARGET).map
+CLEANOBJS     = *.o *.a *.s[ol] *.pdb *.exp *.bak
+
+all:		$(DLLIB)
+static:		$(STATIC_LIB)
+
+clean:
+		@-$(RM) $(CLEANLIBS) $(CLEANOBJS) $(CLEANFILES)
+
+distclean:	clean
+		@-$(RM) Makefile $(RUBY_EXTCONF_H) conftest.* mkmf.log
+		@-$(RM) core ruby$(EXEEXT) *~ $(DISTCLEANFILES)
+
+realclean:	distclean
+install: install-so install-rb
+
+install-so: $(RUBYARCHDIR)
+install-so: $(RUBYARCHDIR)/$(DLLIB)
+$(RUBYARCHDIR)/$(DLLIB): $(DLLIB)
+	$(INSTALL_PROG) $(DLLIB) $(RUBYARCHDIR)
+install-rb: pre-install-rb install-rb-default
+install-rb-default: pre-install-rb-default
+pre-install-rb: Makefile
+pre-install-rb-default: Makefile
+$(RUBYARCHDIR):
+	$(MAKEDIRS) $@
+
+site-install: site-install-so site-install-rb
+site-install-so: install-so
+site-install-rb: install-rb
+
+.SUFFIXES: .c .m .cc .cxx .cpp .C .o
+
+.cc.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.cxx.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.cpp.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.C.o:
+	$(CXX) $(INCFLAGS) $(CPPFLAGS) $(CXXFLAGS) -c $<
+
+.c.o:
+	$(CC) $(INCFLAGS) $(CPPFLAGS) $(CFLAGS) -c $<
+
+$(DLLIB): $(OBJS)
+	@-$(RM) $@
+	$(LDSHARED) -o $@ $(OBJS) $(LIBPATH) $(DLDFLAGS) $(LOCAL_LIBS) $(LIBS)
+
+
+
+$(OBJS): ruby.h defines.h

data/ext/txparse/extconf.rb

@@ -0,0 +1,8 @@
+require 'mkmf'
+
+case RUBY_PLATFORM
+when /darwin/, /linux/
+  CONFIG['LDSHARED'] = "$(CXX) " + CONFIG['LDSHARED'].split[1..-1].join(' ')
+end
+
+create_makefile('txprails/txparse')

data/ext/txparse/test_txp.rb

@@ -0,0 +1,65 @@
+require "TXParse"
+
+class MyParse
+  include TXParse
+
+  def strong(tag)
+    unless tag.thing.nil?
+      "THE THING(" + tag.thing + ")"
+    else
+      "STRONG" unless tag.close?
+    end
+  end
+
+  def doctype(tag)
+    "<DOCTYPE HTML>"
+  end
+
+  def body(tag)
+    "<BODY>" + self.parse(tag.thing) + "</BODY>"
+  end
+
+  def uppercase(tag)
+    self.parse(tag.thing).upcase
+  end
+
+  def count(tag)
+    return self.parse(tag.thing) if tag.attr["limit"].nil?
+    limit = tag.attr["limit"].to_i
+    range = if tag.attr["zerobased"].nil? or tag.attr["zerobased"] == "no"
+            (1..limit)
+          else
+            (0...limit)
+          end
+    out = []
+    range.each do |n|
+      @num = n
+      out << self.parse(tag.thing)
+    end
+    out.join("\n")
+  end
+
+  def num(tag)
+    @num.to_s
+  end
+
+end
+
+txp = MyParse.new
+
+orig = %{
+<dmstk:doctype />
+<dmstk:body>
+  <dmstk:uppercase>
+    <dmstk:count limit="5" zerobased="yes">
+      Línea <var:num />
+      Esto es una <dmstk:strong>primera <em>impresión</em> de</dmstk:strong>
+      prueba de var:parseo de cosas...
+    </dmstk:count>
+  </dmstk:uppercase>
+</dmstk:body>
+}
+
+txt = txp.parse(orig)
+
+puts txt

data/ext/txparse/txparse.cpp

@@ -0,0 +1,139 @@
+#include "ruby.h"
+#include "txparse.h"
+
+extern "C" VALUE txp_initialize(VALUE self)
+{
+	return self;
+}
+
+extern "C" VALUE txp_domain(VALUE self)
+{
+//  Dejo esto como ejemplo de llamada a "rb_funcall", quitar después...
+//	VALUE txt = rb_iv_get(self, "@texto");
+//	return rb_funcall(txt, rb_intern("size"), 0);
+	return rb_str_new2(txp_domain_str.c_str());
+}
+
+extern "C" VALUE txp_domain_set(VALUE self, VALUE new_domain)
+{
+	txp_domain_str = StringValueCStr(new_domain);
+	return rb_str_new2(txp_domain_str.c_str());
+}
+
+extern "C" VALUE txp_parse(VALUE self, VALUE orig)
+{
+	// Lanza una excepción si no hay bloque...
+	// (rb_yield lanza una excepcion "LocalJump... noseque" de todas formas,
+	// pero parece buena idea comprobar al principio y no hacer nada si
+	// no tenemos bloque)...
+//	rb_need_block();
+
+	// rb_check_type tampoco retorna... (rb_raise no retorna, y esta funcion
+	// llama a rb_raise(rb_eTypeError, ...) si los tipos no coinciden)
+	rb_check_type(orig, T_STRING);
+
+	// Mmmmhhh... Lo anterior no es muy "rubyish", quizá debería ser
+	// suficiente con llamar al "to_s" del @texto en caso de que éste no sea
+	// de tipo String, de esta forma podríamos usar más tipos, pero...
+	// a costa de la velocidad.
+
+	// OK, "semos" un string...
+	// NOTA: Acceder mediante el macro RSTRING es un poco peligroso, pero
+	// es rápido ya que accedemos directamente a la estructura que almacena
+	// un string en ruby. Lo podemos hacer aquí más o menos seguro porque
+	// nos hemos asegurado que @texto es un String. Para conversiones, mirar
+	// la referencia de las funciones "rb_string_value" y "rb_string_value_cstr"
+	string::const_iterator iter(RSTRING(orig)->ptr);
+	
+	return txp_parse_private(self, iter, iter + RSTRING(orig)->len);
+}
+
+VALUE txp_parse_private(
+		VALUE self,
+		string::const_iterator begin,
+		string::const_iterator end
+		)
+{
+	VALUE ret = rb_str_new2("");
+	string::const_iterator old = begin;
+
+	while (begin != end) {
+		begin = txp_find_tag(begin, end);
+
+		if (begin != old) {
+			// Texto normal antes de un tag...
+			// rb_yield(rb_str_new(&(*old), begin - old));
+			rb_str_cat(ret, &(*old), begin - old);
+			old = begin;
+		}
+
+		if (begin != end) {
+			// Estamos en un tag...
+			begin = txp_find_close(begin, end);
+			if (begin != end) {
+				// FIXME: Este es el primer elemento a optimizar. Al crear
+				// un tag, ahora mismo tenemos que hacer dos copias de texto,
+				// una para crear un VALUE para instanciar un TXParse::Tag y
+				// luego otra, para crear un std::string desde este VALUE...
+				VALUE tag_txt = rb_str_new2(string(old, begin).c_str());
+				VALUE tag = rb_class_new_instance(1, &tag_txt, rb_const_get(mTXParse, rb_intern("Tag")));
+
+				// OK, tenemos el tag... Debemos buscar el "par" de cierre
+				// en caso de que este tag no sea de "autocierre"
+				VALUE closed = rb_iv_get(tag, "@is_close");
+				if (closed == Qfalse) {
+					// Buscamos el tag de cierre...
+					old = begin;
+					begin = txp_find_par(begin, end, tag);
+					if (begin != end) {
+						rb_iv_set(tag, "@thing", rb_str_new2(string(old, begin).c_str()));
+						// Vale, aquí habría que adelantar "begin" para saltar
+						// el tag de cierre...
+						begin = txp_find_close(begin+1, end);
+					} else {
+						// TODO:
+						// Retomamos donde estábamos... ¿Debería ser ERROR?
+						// SI: Tag mal balanceado si el tag original NO era
+						// de autocierre...
+						
+						// begin = old;
+						rb_raise(rb_eSyntaxError, "Unbalanced tag '%s'", RSTRING(rb_iv_get(tag, "@name"))->ptr);
+					}
+				}
+
+				VALUE domain   = rb_iv_get(tag, "@domain");
+				VALUE tag_name = rb_iv_get(tag, "@name");
+				rb_str_append(domain, rb_str_new2("_"));
+				rb_str_append(domain, tag_name);
+				VALUE tmp = rb_funcall2(self, rb_intern(StringValueCStr(domain)), 1, &tag);
+				// VALUE tmp = rb_yield(tag);
+
+				if (!NIL_P(tmp)) rb_str_append(ret, tmp);
+			} else {
+				rb_str_cat(ret, &(*old), begin - old);
+			}
+			old = begin;
+		}
+	}
+	return ret;
+}
+
+
+
+VALUE mTXParse = Qnil;
+extern "C" void Init_TXParse()
+{
+	mTXParse = rb_define_module("TXParse");
+	
+	rb_define_method(mTXParse, "initialize", RUBY_METHOD_FUNC(txp_initialize), 0);
+	rb_define_method(mTXParse, "domain", RUBY_METHOD_FUNC(txp_domain), 0);
+	rb_define_method(mTXParse, "domain=", RUBY_METHOD_FUNC(txp_domain_set), 1);
+	rb_define_method(mTXParse, "parse", RUBY_METHOD_FUNC(txp_parse), 1);
+	
+	Init_TXParseTag();
+}
+
+extern "C" void Init_txparse()
+{
+	Init_TXParse();
+}

data/ext/txparse/txparse.h

@@ -0,0 +1,15 @@
+#ifndef TXPARSE_H
+#define	TXPARSE_H
+
+#include "txparse_lib.h"
+#include "txparse_tag.h"
+
+VALUE txp_parse_private(
+		VALUE self,
+		string::const_iterator begin,
+		string::const_iterator end
+		);
+
+extern VALUE mTXParse;
+
+#endif