dress 0.0.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 Howard Yeh
+
+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

@@ -0,0 +1,145 @@
+h1. XSLT(not!) with Elegant Dress
+
+You'd swear XSLT is a joke, but it's not. It's
+cruelty. XSLT is like this: it's good to rid the
+city of this horrible vermin infestation-- Let's
+nuke the city. It's an out-of-proportion
+insanity. It's Turing-complete, and it's XML.
+
+Hmm.
+
+But what it is, is just a set of transformations
+on fragments of your XML document. The beauty of
+XSLT (they say), is that XSLT itself is XML, so
+you can (in principle) use XSLT to transform
+itself.
+
+Hmm.
+
+Oh I know, how about let's use Ruby?
+
+Dress is an XML transformation library built on
+top of Nokogiri. Nokogiri is awesome. Dress is
+built on top of Nokogiri...
+
+By syllogism, Dress is awesome.
+
+
+h1. Transformation Elegant Dress
+
+Honestly, there's not much to it. A @Dress@ is
+just a sequence of transformations you perform on
+a DOM tree. Unlike XSLT though, the
+transformations are performed directly on the DOM
+tree. That is to say, they are destructive.
+
+This is a simple dress,
+
+require 'dress'
+doc = "<my><brain></brain></my>"
+dress = Dress {
+ match("brain") do
+   set("size","pea")
+ end
+}
+result = dress.on(doc)
+puts result.to_s
+# <my><brain "size"="pea"></brain></my>
+
+
+We can have more matchers,
+
+dress = Dress {
+ match("brain") do
+   set("size","pea")
+ end
+ match("my") do
+   each { |e| e.name = "homer"}
+ end
+}
+result = dress.on(doc)
+puts result.to_s
+# <homer><brain "size"="pea"></brain></homer>
+
+
+Note that match always yield a
+Nokogiri::Nodeset. But sometimes we'd like to
+operate on just one node (or the first one we
+find). For that there's the @at@ matcher.
+
+dress = Dress {
+  at("my") do
+    me.name = "homer"
+  end
+}
+
+@me@ is always the object yielded by the matcher
+string. For @match@ it would be a Nodeset, and for
+@at@, it would be an Element.
+
+We can define helper methods on a Dress. This is
+one that implements a counter,
+
+dress = Dress {
+  def count
+    @count ||= 0
+    @count += 1
+    @count
+  end
+
+  match("brain") do
+    each { |e| e["area"] = count.to_s }
+  end
+}
+puts dress.on(Nokogiri.make { my { brain; brain; brain; brain }}).to_s
+# <my><brain area="1"></brain><brain area="2"></brain><brain area="3"></brain><brain area="4"></brain></my>
+
+
+We can combine dresses into lines,
+
+d1 = Dress { ... }
+d2 = Dress { ... }
+(d1 | d2).on(doc)
+
+
+We can link lines together,
+
+d3 = Dress { ... }
+d4 = Dress { ... }
+((d1 | d2) | (d3 | d4)).on(doc)
+
+
+A dress is a class inheriting from Dress.
+
+class FancyDress < Dress
+  def helper1
+  end
+  def helper2
+  end
+  match(...) { ... }
+  ...
+end
+
+class PrettyDress < Dress
+  ...
+end
+
+
+Then we can combine these dresses,
+
+(FancyDress | PrettyDress).on(document)
+
+You can of course mix that with dynamic dresses,
+
+(FancyDress | PrettyDress | Dress do ... end).on(doc)
+
+
+h1. That Wasn't So Hard, Was It?
+
+So Ruby saved us all from XSLT. Minus all the
+XSLT-inspired buckets of tears, the world is a
+better place. FTW.
+
+h1. Copyright
+
+Copyright (c) 2009 Howard Yeh. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dress"
+    gem.summary = %Q{DOM transformation based on nokogiri}
+    gem.description = %Q{Inspired by the horror of XSLT}
+    gem.email = "hayeah@gmail.com"
+    gem.homepage = "http://github.com/hayeah/dress"
+    gem.authors = ["Howard Yeh"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dress #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/dress.rb

@@ -0,0 +1,92 @@
+require 'nokogiri'
+
+class Dress
+  class Line
+    attr_reader :dresses
+    def initialize(dresses)
+      @dresses = dresses
+    end
+
+    def |(obj)
+      case obj
+      when Line
+        Line.new(self.dresses + obj.dresses)
+      when Dress
+        Line.new(self.dresses + [obj])
+      else
+        raise "expects a Dress or a Line"
+      end
+    end
+
+    def length
+      dresses.length
+    end
+
+    def on(node)
+      @dresses.each do |dress|
+        dress.on(node)
+      end
+      node
+    end
+  end
+  
+  class << self
+    attr_reader :transforms
+    def match(matcher,&block)
+      @transforms ||= []
+      @transforms << [:search,matcher,block]
+    end
+
+    def at(matcher,&block)
+      @transforms ||= []
+      @transforms << [:at,matcher,block]
+    end
+
+    # destructive transform of node
+    def on(node)
+      node =
+        case node
+        when Nokogiri::XML::Node
+          node
+        when String,IO
+          Nokogiri::XML(node)
+        else
+          raise "bad xml document: #{node}"
+        end
+      dresser = self.new(node)
+      node
+    end
+
+    def style(&block)
+      c = Class.new(Dress)
+      c.class_eval(&block)
+      c
+    end
+
+    def |(dress2)
+      raise "expects a Dress" unless dress2.ancestors.include?(Dress)
+      Line.new([self,dress2])
+    end
+  end
+
+  attr_reader :me
+  def initialize(node)
+    self.class.transforms.each do |(method,matcher,block)|
+      # method == :at | :search
+      @me = node.send(method,matcher)
+      self.instance_eval(&block) # this is so we can define helper methods on the dress
+    end
+  end
+  
+  def method_missing(method,*args,&block)
+    if block
+      @me.send(method,*args,&block)
+    else
+      @me.send(method,*args)
+    end
+  end
+end
+
+def Dress(&block)
+  Dress.style(&block)
+end

data/spec/dress_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'pp'
+require 'tempfile'
+
+describe "Dress" do
+  
+  def test_data
+    Nokogiri.make { foo { bar { baz }}}.parent
+  end
+
+  it "transforms" do
+    d = Dress {
+      match("bar") do
+        wrap(nil) { qux }
+      end
+
+      match("bar") do
+        set("attr","oh yay!")
+      end
+    }
+    
+    node = d.on(test_data)
+    (node / "qux bar").should_not be_empty
+  end
+
+  it "transforms xml string or file" do
+    d = Dress {
+      match("bar") do
+        wrap(nil) { qux }
+      end
+    }
+    doc_str = "<bar></bar>"
+    r = d.on(doc_str)
+    (r / "qux bar").should_not be_empty
+
+    Tempfile.open("test-xml") do |f|
+      f.puts doc_str
+      f.flush
+      r = d.on(File.new(f.path))
+      (r / "qux bar").should_not be_empty  
+    end
+  end
+
+  it "transforms the first element found with at" do
+    d = Dress {
+      at("bar") do
+        me.name = "bar2"
+      end
+    }
+    r = d.on(test_data)
+    (r / "bar2").should_not be_empty
+  end
+  
+  it "chains transforms" do
+    d1 = Dress {
+      match("bar") do
+        wrap(nil) { qux }
+      end
+    }
+
+    d2 = Dress {
+      match("bar") do
+        set("attr","oh yay!")
+      end
+    }
+
+    line = (d1 | d2)
+    line.should be_a(Dress::Line)
+    node = line.on(test_data)
+    (node / "qux").should_not be_empty
+    (node / "qux bar").should_not be_empty
+    node.xpath("//@attr").map(&:value).should == ["oh yay!"]
+  end
+
+  it "chains chains" do
+    d1 = Dress {
+      match("foo") do
+        set("a","1")
+      end
+    }
+
+    d2 = Dress {
+      match("foo") do
+        set("b","2")
+      end
+    }
+
+    d3 = Dress {
+      match("bar") do
+        set("a","1")
+      end
+    }
+
+    d4 = Dress {
+      match("bar") do
+        set("b","2")
+      end
+    }
+
+    line1 = (d1 | d2)
+    line2 = (d3 | d4)
+    line = (line1 | line2)
+    line.length.should == 4
+    node = line.on(test_data)
+    node.xpath("foo/@a").map(&:value).should == ["1"]
+    node.xpath("foo/@b").map(&:value).should == ["2"]
+    node.xpath("//bar/@a").map(&:value).should == ["1"]
+    node.xpath("//bar/@b").map(&:value).should == ["2"]
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'dress'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: dress
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Howard Yeh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-28 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Inspired by the horror of XSLT
+email: hayeah@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/dress.rb
+- spec/dress_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/hayeah/dress
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: DOM transformation based on nokogiri
+test_files: 
+- spec/dress_spec.rb
+- spec/spec_helper.rb