excesselt 1.0.0

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+coverage/*
+

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    excesselt (1.0.0)
+      builder (= 2.1.2)
+      nokogiri (= 1.4.3.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.1)
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    linecache (0.43)
+    nokogiri (1.4.3.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  builder (= 2.1.2)
+  excesselt!
+  jeweler
+  nokogiri (= 1.4.3.1)
+  rake
+  rcov
+  rspec (> 2.0.0)
+  ruby-debug

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-10-29
+
+* 1 major enhancement:
+  * Initial release

data/PostInstall.txt

@@ -0,0 +1 @@
+You're ready to get rid of that awful XSLT stuck in your codebase!

data/README.md

@@ -0,0 +1,67 @@
+# Excesselt
+
+http://github.com/DanielHeath/excesselt
+
+## DESCRIPTION:
+
+Excesselt is a ruby library that I built because I hate XSLT.
+
+I've extracted it from an app I built for my work at Lonely Planet.
+
+Excesselt solves the same problem as XSLT does (that is, how can I transform this xml document into some other format).
+
+## FEATURES/PROBLEMS:
+
+Nice syntax.
+Testable, reusable xml transformation
+Tested on REE 1.8.7 - TODO test on more platforms and update this section
+
+## SYNOPSIS:
+    
+    class MyStylesheet < Excesselt::Stylesheet
+      def rules
+        render('parent > child')     { builder.p(:style => "child_content" ) { child_content }  }
+        render('parent')             { builder.p(:style => "parent_content") { child_content }  }
+        render('text()')             { add element.to_xml.upcase                                }
+      end
+    end
+    
+    MyStylesheet.transform <<-XML
+    <parent>
+      <child>Use Excesselt</child>
+    </parent>
+    XML
+    -> <p style="parent_content"><p style="child_content">USE EXCESSELT</p></p>
+
+## REQUIREMENTS:
+
+* Nokogiri, Builder
+
+## INSTALL:
+
+* gem install excesselt
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Daniel Heath
+
+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

@@ -0,0 +1,54 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+  Bundler::GemHelper.install_tasks
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'jeweler'
+require 'excesselt'
+Jeweler::Tasks.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'excesselt'
+  s.version     = Excesselt::VERSION
+  s.summary     = 'Helps you to transform XML without using XSLT.'
+  s.description = 'I had a lot of XML transformation to do and the requirements kept changing, so I sat down and wrote something that was easy to modify.'
+
+  s.required_ruby_version     = '>= 1.8.7'
+  s.required_rubygems_version = ">= 1.3.6"
+
+  s.author            = 'Daniel Heath'
+  s.email             = 'daniel.r.heath@gmail.com'
+  s.homepage          = 'http://www.github.com/danielheath/excesselt'
+
+# Would be good to take a stylesheet and an xml file as arguments for a binary.
+#  s.bindir             = 'bin'
+#  s.executables        = ['excesselt'] 
+#  s.default_executable = 'excesselt'
+
+  s.rdoc_options    = ["--charset=UTF-8", "-mREADME.md"]
+
+  s.add_dependency('nokogiri', '1.4.3.1')
+  s.add_dependency('builder', '2.1.2')
+  s.add_development_dependency('activesupport')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '>2.0.0')
+  s.add_development_dependency('rcov')
+  s.add_development_dependency('ruby-debug')
+  s.add_development_dependency('jeweler')
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = Excesselt::VERSION
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "<%= project_name %> #{version}"
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir.glob('tasks/*').each {|rakefile| load rakefile }

data/TODO

@@ -0,0 +1,3 @@
+Test on multiple rubies
+Add binary
+Add more examples

data/excesselt.gemspec

@@ -0,0 +1,102 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{excesselt}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Heath"]
+  s.date = %q{2010-11-08}
+  s.description = %q{I had a lot of XML transformation to do and the requirements kept changing, so I sat down and wrote something that was easy to modify.}
+  s.email = %q{daniel.r.heath@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md",
+     "TODO"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "History.txt",
+     "PostInstall.txt",
+     "README.md",
+     "Rakefile",
+     "TODO",
+     "excesselt.gemspec",
+     "lib/excesselt.rb",
+     "lib/excesselt/element_wrapper.rb",
+     "lib/excesselt/rule.rb",
+     "lib/excesselt/stylesheet.rb",
+     "rdoc/classes/Excesselt.html",
+     "rdoc/classes/Excesselt/ElementWrapper.html",
+     "rdoc/classes/Excesselt/Rule.html",
+     "rdoc/classes/Excesselt/Stylesheet.html",
+     "rdoc/created.rid",
+     "rdoc/files/README_md.html",
+     "rdoc/files/lib/excesselt/element_wrapper_rb.html",
+     "rdoc/files/lib/excesselt/rule_rb.html",
+     "rdoc/files/lib/excesselt/stylesheet_rb.html",
+     "rdoc/files/lib/excesselt_rb.html",
+     "rdoc/fr_class_index.html",
+     "rdoc/fr_file_index.html",
+     "rdoc/fr_method_index.html",
+     "rdoc/index.html",
+     "rdoc/rdoc-style.css",
+     "script/console",
+     "script/destroy",
+     "script/generate",
+     "spec/excesselt_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/matchers/dom_matcher.rb",
+     "tasks/rspec.rake"
+  ]
+  s.homepage = %q{http://www.github.com/danielheath/excesselt}
+  s.rdoc_options = ["--charset=UTF-8", "-mREADME.md"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Helps you to transform XML without using XSLT.}
+  s.test_files = [
+    "spec/excesselt_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/support/matchers/dom_matcher.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+      s.add_runtime_dependency(%q<builder>, ["= 2.1.2"])
+      s.add_development_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["> 2.0.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+      s.add_dependency(%q<builder>, ["= 2.1.2"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["> 2.0.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+    s.add_dependency(%q<builder>, ["= 2.1.2"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["> 2.0.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/excesselt/element_wrapper.rb

@@ -0,0 +1,37 @@
+module Excesselt
+  class ElementWrapper
+  
+    attr_reader :element, :builder, :stylesheet
+  
+    def initialize(stylesheet, element, builder)
+      @stylesheet = stylesheet
+      @element = element
+      @builder = builder
+    end
+  
+    def child_content(selector=nil)
+      elements = selector ? @element.css(selector) : @element.children
+      elements.each do |child|
+        stylesheet.generate_element(child)
+      end
+    end
+  
+    def method_missing(sym, *args)
+      begin
+        @element.send(sym, *args)
+      rescue Exception => e
+        raise e.exception("Error delegating method '#{sym}' to #{@element.class.name}: #{e.message}\n\n#{e.backtrace.join("\n")}")
+      end
+    end
+  
+    def add(*content)
+      @builder << content.join('')
+    end
+    
+    def error(string)
+      stylesheet.errors << string
+    end
+        
+  end
+
+end

data/lib/excesselt/rule.rb

@@ -0,0 +1,45 @@
+module Excesselt
+  class Rule
+    
+    attr_reader :stylesheet, :element, :block, :selector
+
+    def initialize(stylesheet, selector, extensions, &block)
+      @stylesheet = stylesheet
+      @selector = selector
+      @extensions = extensions
+      @block = block
+    end
+    
+    def matching_elements(document)
+      @selector_cache ||= {}
+      @selector_cache[document] ||= document.css(@selector)
+    end
+    
+    def applies_to_element?
+      matching_elements(element.document).include? element
+    end
+    
+    def matches?(element)
+      @element = element
+      if applies_to_element?
+        self # if it matches, nil otherwise
+      else
+        nil
+      end
+    end
+    
+    def generate(builder)
+      # Call the block in the elements context
+      wrapper = ElementWrapper.new(stylesheet, element, builder)
+      @extensions.each {|e| wrapper.extend e }
+      wrapper.instance_eval(&@block)
+    rescue Exception => e
+      if e.message =~ /With Included Modules/
+        raise e
+      else
+        raise e.class, "With Included Modules: #{@extensions.inspect}\n#{e.message}\n#{e.backtrace.join("\n")}"
+      end
+    end
+    
+  end
+end

data/lib/excesselt/stylesheet.rb

@@ -0,0 +1,64 @@
+require 'builder'
+module Excesselt
+  class Stylesheet
+  
+    attr_reader :builder, :errors
+  
+    def self.transform(xml)
+      self.new.transform(xml)
+    end
+  
+    def initialize
+      @builder = Builder::XmlMarkup.new
+      @helper_modules = []
+      @errors = []
+    end
+  
+    def transform(xml)
+      generate_element(Nokogiri::XML(xml, nil, nil, Nokogiri::XML::ParseOptions.new).root)
+    end
+
+    def generate_element(element)
+      rule = rule_for(element)
+      raise "Attempted to generate #{self.name} with parents #{self.parents.inspect} but no rule was found." unless rule
+      rule.generate(builder)
+    end
+
+    private
+
+    def rule_for(element)
+      # Look up the rule that is used to render this.
+      # Should fold into stylesheet.rules (collection) .find(:matches?, element)
+      # TODO: Patch enumerable#find etc to take a plain symbol and some arguments?
+      rule = get_rules.find {|rule| rule.matches? element }
+      rule or raise "There is no style defined to handle element #{element.node.name} in this context (element.node.parents.inspect)"
+    end
+  
+    def helper(*mods, &block)
+      @helper_modules.push(mods).flatten!
+      block.call
+      @helper_modules -= [mods].flatten
+    end
+    
+    def render(selector, opts={}, &block)
+      raise "Neither a block nor a :with option were provided for '#{selector}'" unless (opts[:with] or block)
+            
+      mappings << Rule.new(self, selector, @helper_modules) do
+        opts[:with] ? self.send(opts[:with]) : (instance_eval &block)
+      end
+    end
+    
+    def mappings
+      @mappings ||= []
+    end
+    
+    def get_rules
+      unless @rules_generated
+        rules # Generates the mappings
+        @rules_generated = true
+      end
+      mappings
+    end
+  
+  end
+end

data/lib/excesselt.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Excesselt
+  VERSION = '1.0.0'
+end
+
+require 'excesselt/stylesheet'
+require 'excesselt/rule'
+require 'excesselt/element_wrapper'