michael-transformer 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael Aufreiter
+
+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,7 @@
+= transformer
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Michael Aufreiter. See LICENSE for details.

data/README.textile

@@ -0,0 +1,93 @@
+h1. Transformer
+
+Transformer comes in handy if you need to turn your ruby objects into a html representation based on templates (currently haml).
+
+h2. Installation
+
+Use GitHub RubyGems.
+
+<pre>
+<code>
+  $ gem sources -a http://gems.github.com (you only have to do this once)
+  $ sudo gem install michael-transformer
+</code>
+</pre>
+
+Or even better, stay on The Edge.
+
+h2. Getting started
+
+Suppose your models look like so:
+
+<pre>
+<code>
+class Resource ; end
+
+class Album < Resource
+  attr_accessor :title, :artist
+end
+
+class Track < Resource
+  attr_accessor :length, :title, :artist
+end
+</code>
+</pre>
+
+You can now define Transformers which turn certain objects into adequate html representations.
+
+<pre>
+<code>
+class AlbumTransformer
+  include Transformer::Base
+
+  def self.matches?(subject)
+    subject.class == Album
+  end
+end
+
+class TrackTransformer
+  include Transformer::Base
+
+  def self.matches?(subject)
+    subject.class == Track
+  end
+end
+</code>
+</pre>
+
+You just need to include the Transformer::Base Module and specify when a certain Transformer should be matched (self.matches?). 
+
+The Transformer module keeps track of all registered Transformers.
+
+In addition, you need to create a HAML template for each transformer. 
+From within the template you can access the subject, which you are transforming by calling subject, while the context is always the concrete Transformer instance.
+If you need helper methods or calculations just put these into your Transformer class.
+
+At runtime you might have:
+
+<pre>
+<code>
+@thriller = Album.new
+@thriller.title = "Thriller"
+@thriller.artist = "Michael Jackson"
+
+@confusion = Track.new
+@confusion.title = "Confusion"
+@confusion.artist = "New Order"
+@confusion.duration = 5.18
+</code>
+</pre>
+
+Let's do some transformation...
+<pre>
+<code>
+transformer = Transformer.create_transformer(@thriller) # returns an AlbumTransformer instance
+transformer.transform # picks the corresponding template (e.g. templates/album_transformer.haml) and renders it
+</code>
+</pre>
+
+Transformer.create_transformer picks the right transformer for a certain object based on the respective self.matches? defintion, which must be specified in each concrete Transformer class.
+
+Please also have a look at the tests.
+
+Suggestions & contributions welcome, as always ;)

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "transformer"
+    gem.summary = %Q{turn your ruby objects into a html representation using transformers}
+    gem.email = "ma@zive.at"
+    gem.homepage = "http://github.com/michael/transformer"
+    gem.authors = ["michael"]
+    gem.add_dependency('haml')
+    gem.add_dependency('extlib')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo 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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "transformer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/transformer.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'pathname'
+require 'extlib'
+require 'haml'
+
+module Transformer
+  class TransformerNotFoundError < RuntimeError ; end
+  class AmbiguousTransformerError < RuntimeError ; end
+  class TemplateNotFoundError < RuntimeError ; end
+  
+  def self.registered_transformers
+    @registered_transformers ||= []
+  end
+  
+  def self.template_root
+    if Object.const_defined?('Merb')
+      Pathname(Merb.root) + 'app/templates'
+    elsif Object.const_defined?('Rails')
+      Pathname(Rails.root) + 'app/templates'
+    else
+      Pathname("templates").expand_path
+    end
+  end
+  
+  def self.transformer_root
+    if Object.const_defined?('Merb')
+      Pathname(Merb.root) + 'app/transformers'
+    elsif Object.const_defined?('Rails')
+      Pathname(Rails.root) + 'app/transformers'
+    else
+      Pathname("transformers").expand_path
+    end
+  end
+  
+  def self.create_transformer(subject)
+    transformers = Transformer.registered_transformers.select do |transformer|
+      transformer.matches?(subject)
+    end
+    raise Transformer::TransformerNotFoundError  if transformers.size == 0
+    raise Transformer::AmbiguousTransformerError if transformers.size > 1
+    transformers.first.new(subject)
+  end
+  
+  module Base
+    def self.included(base)
+      extend ClassMethods
+      Transformer.registered_transformers << base
+      attr_reader :subject
+    end
+    
+    def transform
+      Haml::Engine.new(template).render(self)
+    end
+    
+    def initialize(subject)
+      @subject = subject
+    end
+    
+    def template
+      begin
+        File.read(template_path+template_name)
+      rescue
+        raise Transformer::TemplateNotFoundError
+      end
+    end
+    
+    def template_path
+      Pathname(Transformer.template_root).expand_path
+    end
+    
+    def template_name
+      "#{Extlib::Inflection.underscore(Extlib::Inflection.demodulize(self.class.name))}.haml"
+    end
+    
+    module ClassMethods
+      # must be overridden
+      def matches?(subject)
+        raise NotImplementedError
+      end
+    end
+  end # module Base
+end # module Transformer
+
+
+Dir.glob(Transformer.transformer_root + '*.rb').each {|f| require f }

data/test/templates/album_transformer.haml

@@ -0,0 +1,4 @@
+%h1
+  = subject.artist
+  = "- "
+  = subject.title

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+gem 'jnunemaker-matchy', '0.4.0'
+require 'matchy'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'transformer'
+
+# load transformer classes
+# Dir.glob(File.join(File.dirname(__FILE__), 'transformers/*.rb')).each {|f| require f }
+
+class Test::Unit::TestCase
+  custom_matcher :be_nil do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be nil but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be nil but it was"
+    receiver.nil?
+  end
+  
+  custom_matcher :have do |receiver, matcher, args|
+    count = args[0]
+    something = matcher.chained_messages[0].name
+    actual = receiver.send(something).size
+    actual == count
+  end
+  
+  custom_matcher :be_true do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be true but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be true but it was"
+    receiver.eql?(true)
+  end
+  
+  custom_matcher :be_false do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be false but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be false but it was"
+    receiver.eql?(false)
+  end
+end

data/test/transformer_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+# models
+class Resource ; end
+
+class Album < Resource
+  attr_accessor :title, :artist
+end
+
+class Track < Resource
+  attr_accessor :length, :title, :artist
+end
+
+class TransformerTest < Test::Unit::TestCase
+  context "The Transformer Class" do
+    
+    setup do
+      @thriller = Album.new
+      @thriller.title = "Thriller"
+      @thriller.artist = "Michael Jackson"
+      
+      @confusion = Track.new
+      @confusion.title = "Confusion"
+      @confusion.artist = "New Order"
+      @confusion.length = 5.18
+    end
+    
+    should "increment Transformer.registered_transformers for each defined transformer" do
+      Transformer.should have(2).registered_transformers
+    end
+    
+    should "pick the right transformer" do
+      Transformer.create_transformer(@thriller).class.should == AlbumTransformer
+      Transformer.create_transformer(@confusion).class.should == TrackTransformer
+    end
+    
+    context "Tranformer instances" do
+      setup do
+        @album_transformer = Transformer.create_transformer(@thriller)
+        @track_transformer = Transformer.create_transformer(@confusion)
+      end
+      
+      should "be the right transformer" do
+        @album_transformer.should be_kind_of(AlbumTransformer)
+        @track_transformer.should be_kind_of(TrackTransformer)
+      end
+      
+      should "choose the right template" do
+        @album_transformer.template.should be_kind_of(String)
+      end
+      
+      should "transform the template" do
+        @album_transformer.transform.should =~ /Michael Jackson/
+      end
+      
+      should "raise a TemplateNotFoundError if template doesn't exist" do
+        lambda { @track_transformer.transform }.should raise_error(Transformer::TemplateNotFoundError)
+      end
+    end
+  end
+end

data/test/transformers/album_transformer.rb

@@ -0,0 +1,7 @@
+class AlbumTransformer
+  include Transformer::Base
+
+  def self.matches?(subject)
+    subject.class == Album
+  end
+end

data/test/transformers/track_transformer.rb

@@ -0,0 +1,7 @@
+class TrackTransformer
+  include Transformer::Base
+
+  def self.matches?(subject)
+    subject.class == Track
+  end
+end

data/transformer.gemspec

@@ -0,0 +1,59 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{transformer}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["michael"]
+  s.date = %q{2009-07-03}
+  s.email = %q{ma@zive.at}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "lib/transformer.rb",
+     "test/templates/album_transformer.haml",
+     "test/test_helper.rb",
+     "test/transformer_test.rb",
+     "test/transformers/album_transformer.rb",
+     "test/transformers/track_transformer.rb",
+     "transformer.gemspec"
+  ]
+  s.homepage = %q{http://github.com/michael/transformer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{turn your ruby objects into a html representation using transformers}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/transformer_test.rb",
+     "test/transformers/album_transformer.rb",
+     "test/transformers/track_transformer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<haml>, [">= 0"])
+      s.add_runtime_dependency(%q<extlib>, [">= 0"])
+    else
+      s.add_dependency(%q<haml>, [">= 0"])
+      s.add_dependency(%q<extlib>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<haml>, [">= 0"])
+    s.add_dependency(%q<extlib>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: michael-transformer
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- michael
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: ma@zive.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- README.textile
+- Rakefile
+- VERSION
+- lib/transformer.rb
+- test/templates/album_transformer.haml
+- test/test_helper.rb
+- test/transformer_test.rb
+- test/transformers/album_transformer.rb
+- test/transformers/track_transformer.rb
+- transformer.gemspec
+has_rdoc: false
+homepage: http://github.com/michael/transformer
+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.2.0
+signing_key: 
+specification_version: 3
+summary: turn your ruby objects into a html representation using transformers
+test_files: 
+- test/test_helper.rb
+- test/transformer_test.rb
+- test/transformers/album_transformer.rb
+- test/transformers/track_transformer.rb