michael-transformer 0.0.1

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.
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
@@ -0,0 +1,5 @@
1
+ *.sw?
2
+ .DS_Store
3
+ coverage
4
+ rdoc
5
+ pkg
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 Michael Aufreiter
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,7 @@
1
+ = transformer
2
+
3
+ Description goes here.
4
+
5
+ == Copyright
6
+
7
+ Copyright (c) 2009 Michael Aufreiter. See LICENSE for details.
@@ -0,0 +1,93 @@
1
+ h1. Transformer
2
+
3
+ Transformer comes in handy if you need to turn your ruby objects into a html representation based on templates (currently haml).
4
+
5
+ h2. Installation
6
+
7
+ Use GitHub RubyGems.
8
+
9
+ <pre>
10
+ <code>
11
+ $ gem sources -a http://gems.github.com (you only have to do this once)
12
+ $ sudo gem install michael-transformer
13
+ </code>
14
+ </pre>
15
+
16
+ Or even better, stay on The Edge.
17
+
18
+ h2. Getting started
19
+
20
+ Suppose your models look like so:
21
+
22
+ <pre>
23
+ <code>
24
+ class Resource ; end
25
+
26
+ class Album < Resource
27
+ attr_accessor :title, :artist
28
+ end
29
+
30
+ class Track < Resource
31
+ attr_accessor :length, :title, :artist
32
+ end
33
+ </code>
34
+ </pre>
35
+
36
+ You can now define Transformers which turn certain objects into adequate html representations.
37
+
38
+ <pre>
39
+ <code>
40
+ class AlbumTransformer
41
+ include Transformer::Base
42
+
43
+ def self.matches?(subject)
44
+ subject.class == Album
45
+ end
46
+ end
47
+
48
+ class TrackTransformer
49
+ include Transformer::Base
50
+
51
+ def self.matches?(subject)
52
+ subject.class == Track
53
+ end
54
+ end
55
+ </code>
56
+ </pre>
57
+
58
+ You just need to include the Transformer::Base Module and specify when a certain Transformer should be matched (self.matches?).
59
+
60
+ The Transformer module keeps track of all registered Transformers.
61
+
62
+ In addition, you need to create a HAML template for each transformer.
63
+ 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.
64
+ If you need helper methods or calculations just put these into your Transformer class.
65
+
66
+ At runtime you might have:
67
+
68
+ <pre>
69
+ <code>
70
+ @thriller = Album.new
71
+ @thriller.title = "Thriller"
72
+ @thriller.artist = "Michael Jackson"
73
+
74
+ @confusion = Track.new
75
+ @confusion.title = "Confusion"
76
+ @confusion.artist = "New Order"
77
+ @confusion.duration = 5.18
78
+ </code>
79
+ </pre>
80
+
81
+ Let's do some transformation...
82
+ <pre>
83
+ <code>
84
+ transformer = Transformer.create_transformer(@thriller) # returns an AlbumTransformer instance
85
+ transformer.transform # picks the corresponding template (e.g. templates/album_transformer.haml) and renders it
86
+ </code>
87
+ </pre>
88
+
89
+ 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.
90
+
91
+ Please also have a look at the tests.
92
+
93
+ Suggestions & contributions welcome, as always ;)
@@ -0,0 +1,58 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "transformer"
8
+ gem.summary = %Q{turn your ruby objects into a html representation using transformers}
9
+ gem.email = "ma@zive.at"
10
+ gem.homepage = "http://github.com/michael/transformer"
11
+ gem.authors = ["michael"]
12
+ gem.add_dependency('haml')
13
+ gem.add_dependency('extlib')
14
+ # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
15
+ end
16
+
17
+ rescue LoadError
18
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
19
+ end
20
+
21
+ require 'rake/testtask'
22
+ Rake::TestTask.new(:test) do |test|
23
+ test.libs << 'lib' << 'test'
24
+ test.pattern = 'test/**/*_test.rb'
25
+ test.verbose = true
26
+ end
27
+
28
+ begin
29
+ require 'rcov/rcovtask'
30
+ Rcov::RcovTask.new do |test|
31
+ test.libs << 'test'
32
+ test.pattern = 'test/**/*_test.rb'
33
+ test.verbose = true
34
+ end
35
+ rescue LoadError
36
+ task :rcov do
37
+ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
38
+ end
39
+ end
40
+
41
+
42
+ task :default => :test
43
+
44
+ require 'rake/rdoctask'
45
+ Rake::RDocTask.new do |rdoc|
46
+ if File.exist?('VERSION.yml')
47
+ config = YAML.load(File.read('VERSION.yml'))
48
+ version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
49
+ else
50
+ version = ""
51
+ end
52
+
53
+ rdoc.rdoc_dir = 'rdoc'
54
+ rdoc.title = "transformer #{version}"
55
+ rdoc.rdoc_files.include('README*')
56
+ rdoc.rdoc_files.include('lib/**/*.rb')
57
+ end
58
+
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.2
@@ -0,0 +1,85 @@
1
+ require 'rubygems'
2
+ require 'pathname'
3
+ require 'extlib'
4
+ require 'haml'
5
+
6
+ module Transformer
7
+ class TransformerNotFoundError < RuntimeError ; end
8
+ class AmbiguousTransformerError < RuntimeError ; end
9
+ class TemplateNotFoundError < RuntimeError ; end
10
+
11
+ def self.registered_transformers
12
+ @registered_transformers ||= []
13
+ end
14
+
15
+ def self.template_root
16
+ if Object.const_defined?('Merb')
17
+ Pathname(Merb.root) + 'app/templates'
18
+ elsif Object.const_defined?('Rails')
19
+ Pathname(Rails.root) + 'app/templates'
20
+ else
21
+ Pathname("templates").expand_path
22
+ end
23
+ end
24
+
25
+ def self.transformer_root
26
+ if Object.const_defined?('Merb')
27
+ Pathname(Merb.root) + 'app/transformers'
28
+ elsif Object.const_defined?('Rails')
29
+ Pathname(Rails.root) + 'app/transformers'
30
+ else
31
+ Pathname("transformers").expand_path
32
+ end
33
+ end
34
+
35
+ def self.create_transformer(subject)
36
+ transformers = Transformer.registered_transformers.select do |transformer|
37
+ transformer.matches?(subject)
38
+ end
39
+ raise Transformer::TransformerNotFoundError if transformers.size == 0
40
+ raise Transformer::AmbiguousTransformerError if transformers.size > 1
41
+ transformers.first.new(subject)
42
+ end
43
+
44
+ module Base
45
+ def self.included(base)
46
+ extend ClassMethods
47
+ Transformer.registered_transformers << base
48
+ attr_reader :subject
49
+ end
50
+
51
+ def transform
52
+ Haml::Engine.new(template).render(self)
53
+ end
54
+
55
+ def initialize(subject)
56
+ @subject = subject
57
+ end
58
+
59
+ def template
60
+ begin
61
+ File.read(template_path+template_name)
62
+ rescue
63
+ raise Transformer::TemplateNotFoundError
64
+ end
65
+ end
66
+
67
+ def template_path
68
+ Pathname(Transformer.template_root).expand_path
69
+ end
70
+
71
+ def template_name
72
+ "#{Extlib::Inflection.underscore(Extlib::Inflection.demodulize(self.class.name))}.haml"
73
+ end
74
+
75
+ module ClassMethods
76
+ # must be overridden
77
+ def matches?(subject)
78
+ raise NotImplementedError
79
+ end
80
+ end
81
+ end # module Base
82
+ end # module Transformer
83
+
84
+
85
+ Dir.glob(Transformer.transformer_root + '*.rb').each {|f| require f }
@@ -0,0 +1,4 @@
1
+ %h1
2
+ = subject.artist
3
+ = "- "
4
+ = subject.title
@@ -0,0 +1,40 @@
1
+ require 'rubygems'
2
+ require 'test/unit'
3
+ require 'shoulda'
4
+
5
+ gem 'jnunemaker-matchy', '0.4.0'
6
+ require 'matchy'
7
+
8
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
9
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
10
+ require 'transformer'
11
+
12
+ # load transformer classes
13
+ # Dir.glob(File.join(File.dirname(__FILE__), 'transformers/*.rb')).each {|f| require f }
14
+
15
+ class Test::Unit::TestCase
16
+ custom_matcher :be_nil do |receiver, matcher, args|
17
+ matcher.positive_failure_message = "Expected #{receiver} to be nil but it wasn't"
18
+ matcher.negative_failure_message = "Expected #{receiver} not to be nil but it was"
19
+ receiver.nil?
20
+ end
21
+
22
+ custom_matcher :have do |receiver, matcher, args|
23
+ count = args[0]
24
+ something = matcher.chained_messages[0].name
25
+ actual = receiver.send(something).size
26
+ actual == count
27
+ end
28
+
29
+ custom_matcher :be_true do |receiver, matcher, args|
30
+ matcher.positive_failure_message = "Expected #{receiver} to be true but it wasn't"
31
+ matcher.negative_failure_message = "Expected #{receiver} not to be true but it was"
32
+ receiver.eql?(true)
33
+ end
34
+
35
+ custom_matcher :be_false do |receiver, matcher, args|
36
+ matcher.positive_failure_message = "Expected #{receiver} to be false but it wasn't"
37
+ matcher.negative_failure_message = "Expected #{receiver} not to be false but it was"
38
+ receiver.eql?(false)
39
+ end
40
+ end
@@ -0,0 +1,61 @@
1
+ require 'test_helper'
2
+
3
+ # models
4
+ class Resource ; end
5
+
6
+ class Album < Resource
7
+ attr_accessor :title, :artist
8
+ end
9
+
10
+ class Track < Resource
11
+ attr_accessor :length, :title, :artist
12
+ end
13
+
14
+ class TransformerTest < Test::Unit::TestCase
15
+ context "The Transformer Class" do
16
+
17
+ setup do
18
+ @thriller = Album.new
19
+ @thriller.title = "Thriller"
20
+ @thriller.artist = "Michael Jackson"
21
+
22
+ @confusion = Track.new
23
+ @confusion.title = "Confusion"
24
+ @confusion.artist = "New Order"
25
+ @confusion.length = 5.18
26
+ end
27
+
28
+ should "increment Transformer.registered_transformers for each defined transformer" do
29
+ Transformer.should have(2).registered_transformers
30
+ end
31
+
32
+ should "pick the right transformer" do
33
+ Transformer.create_transformer(@thriller).class.should == AlbumTransformer
34
+ Transformer.create_transformer(@confusion).class.should == TrackTransformer
35
+ end
36
+
37
+ context "Tranformer instances" do
38
+ setup do
39
+ @album_transformer = Transformer.create_transformer(@thriller)
40
+ @track_transformer = Transformer.create_transformer(@confusion)
41
+ end
42
+
43
+ should "be the right transformer" do
44
+ @album_transformer.should be_kind_of(AlbumTransformer)
45
+ @track_transformer.should be_kind_of(TrackTransformer)
46
+ end
47
+
48
+ should "choose the right template" do
49
+ @album_transformer.template.should be_kind_of(String)
50
+ end
51
+
52
+ should "transform the template" do
53
+ @album_transformer.transform.should =~ /Michael Jackson/
54
+ end
55
+
56
+ should "raise a TemplateNotFoundError if template doesn't exist" do
57
+ lambda { @track_transformer.transform }.should raise_error(Transformer::TemplateNotFoundError)
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,7 @@
1
+ class AlbumTransformer
2
+ include Transformer::Base
3
+
4
+ def self.matches?(subject)
5
+ subject.class == Album
6
+ end
7
+ end
@@ -0,0 +1,7 @@
1
+ class TrackTransformer
2
+ include Transformer::Base
3
+
4
+ def self.matches?(subject)
5
+ subject.class == Track
6
+ end
7
+ end
@@ -0,0 +1,59 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{transformer}
5
+ s.version = "0.0.1"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["michael"]
9
+ s.date = %q{2009-07-03}
10
+ s.email = %q{ma@zive.at}
11
+ s.extra_rdoc_files = [
12
+ "LICENSE",
13
+ "README.rdoc",
14
+ "README.textile"
15
+ ]
16
+ s.files = [
17
+ ".document",
18
+ ".gitignore",
19
+ "LICENSE",
20
+ "README.rdoc",
21
+ "README.textile",
22
+ "Rakefile",
23
+ "VERSION",
24
+ "lib/transformer.rb",
25
+ "test/templates/album_transformer.haml",
26
+ "test/test_helper.rb",
27
+ "test/transformer_test.rb",
28
+ "test/transformers/album_transformer.rb",
29
+ "test/transformers/track_transformer.rb",
30
+ "transformer.gemspec"
31
+ ]
32
+ s.homepage = %q{http://github.com/michael/transformer}
33
+ s.rdoc_options = ["--charset=UTF-8"]
34
+ s.require_paths = ["lib"]
35
+ s.rubygems_version = %q{1.3.4}
36
+ s.summary = %q{turn your ruby objects into a html representation using transformers}
37
+ s.test_files = [
38
+ "test/test_helper.rb",
39
+ "test/transformer_test.rb",
40
+ "test/transformers/album_transformer.rb",
41
+ "test/transformers/track_transformer.rb"
42
+ ]
43
+
44
+ if s.respond_to? :specification_version then
45
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
46
+ s.specification_version = 3
47
+
48
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
49
+ s.add_runtime_dependency(%q<haml>, [">= 0"])
50
+ s.add_runtime_dependency(%q<extlib>, [">= 0"])
51
+ else
52
+ s.add_dependency(%q<haml>, [">= 0"])
53
+ s.add_dependency(%q<extlib>, [">= 0"])
54
+ end
55
+ else
56
+ s.add_dependency(%q<haml>, [">= 0"])
57
+ s.add_dependency(%q<extlib>, [">= 0"])
58
+ end
59
+ end
metadata ADDED
@@ -0,0 +1,90 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: michael-transformer
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - michael
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-07-03 00:00:00 -07:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: haml
17
+ type: :runtime
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: "0"
24
+ version:
25
+ - !ruby/object:Gem::Dependency
26
+ name: extlib
27
+ type: :runtime
28
+ version_requirement:
29
+ version_requirements: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: "0"
34
+ version:
35
+ description:
36
+ email: ma@zive.at
37
+ executables: []
38
+
39
+ extensions: []
40
+
41
+ extra_rdoc_files:
42
+ - LICENSE
43
+ - README.rdoc
44
+ - README.textile
45
+ files:
46
+ - .document
47
+ - .gitignore
48
+ - LICENSE
49
+ - README.rdoc
50
+ - README.textile
51
+ - Rakefile
52
+ - VERSION
53
+ - lib/transformer.rb
54
+ - test/templates/album_transformer.haml
55
+ - test/test_helper.rb
56
+ - test/transformer_test.rb
57
+ - test/transformers/album_transformer.rb
58
+ - test/transformers/track_transformer.rb
59
+ - transformer.gemspec
60
+ has_rdoc: false
61
+ homepage: http://github.com/michael/transformer
62
+ post_install_message:
63
+ rdoc_options:
64
+ - --charset=UTF-8
65
+ require_paths:
66
+ - lib
67
+ required_ruby_version: !ruby/object:Gem::Requirement
68
+ requirements:
69
+ - - ">="
70
+ - !ruby/object:Gem::Version
71
+ version: "0"
72
+ version:
73
+ required_rubygems_version: !ruby/object:Gem::Requirement
74
+ requirements:
75
+ - - ">="
76
+ - !ruby/object:Gem::Version
77
+ version: "0"
78
+ version:
79
+ requirements: []
80
+
81
+ rubyforge_project:
82
+ rubygems_version: 1.2.0
83
+ signing_key:
84
+ specification_version: 3
85
+ summary: turn your ruby objects into a html representation using transformers
86
+ test_files:
87
+ - test/test_helper.rb
88
+ - test/transformer_test.rb
89
+ - test/transformers/album_transformer.rb
90
+ - test/transformers/track_transformer.rb