altered_views 0.1.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in altered_views.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/Readme.rdoc

@@ -0,0 +1,57 @@
+= altered_views
+
+== Synopsis
+Everybody is accustomed now to the power and flexibility inheritance gives you in OOP. But when it comes to view life is getting really complex! Let me give you an example. 
+
+You have a nice rails engine that provides you with authentication functionality you use throughout your applications. But the login page should really look slightly different in this app and that registration page should carry different logo, name and copyright. The only option you have is to copy those views into the app and redo them. That is it, from this point you've lost it, cause any bugs you fixed in the views inside the engine still live in the copied views.
+
+This is where altered_views comes to help. It allows you to inherit the engine's view and alter only the bits you need referring to them using css selectors.
+
+You view in the *engine* could look like this:
+
+ app/views/user_session/new.html.erb [engine]
+	
+ <h1 id="login-title">Login:</h1>
+ <div class="form-container">
+ <!-- Code to display login box, which I omit -->
+ </div>
+ <span class="legal">Some legal nonsence</span>
+
+Now we will alter customizing only required parts. This view goes inside your *application*.
+
+ app/views/user_session/new.html.erb [application]
+	
+ <%= inherit_view "parent:admin/cataloguer/categories/edit" do %>
+   <%= content "#login-title" do %>
+     Login into my company's account:
+   <% end %>
+		
+   <%= append ".legal" do %>
+     <p>Exta clause</p>
+   <% end %>
+ <% end %>
+
+
+altered_views support the following DOM modifiers:
+
+* content — replace the element's content
+* before — place content before the node
+* after — place content after the node
+* append — content in appended in the end of the element
+* prepend — content in placed as the first child of the element before other content
+
+== Installing
+altered_views is available on gemcutter so all you have to do it
+  gem install altered_views
+
+Then include it in your Gemfile
+ gem altered_views
+
+== Requirements
+altered_views was written to extend Rails 3.0 functionality and uses nokogiri — a fast and powerful XML/HTML processing engine.
+
+== Known issues
+This is the very first version of the gem and might contain bugs. 
+
+* it assumes you are using layouts in your application. If your view contains the whole page — it will cause problems. 
+* head section modification is not supported

data/altered_views.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/altered_views/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "altered_views"
+  s.version     = AltereddViews::VERSION
+  s.platform    = Gem::Platform::RUBY
+	s.date 				= %q{2010-12-24}
+  s.authors     = ["Sergey Kuleshov"]
+  s.email       = ["svyatogor@gmail.com"]
+  # s.homepage    = "http://rubygems.org/gems/altered_views"
+  s.summary     = "Inherit and extend rails views in OOP manner"
+  s.description = "Altered views allows one to inherit views from pluged in engines and extend them by operating on the DOM model."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "altered_views"
+
+  s.add_runtime_dependency "rails", "~> 3.0.0"
+  s.add_runtime_dependency "nokogiri", "~> 1.4"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+
+  s.extra_rdoc_files = [
+    "Readme.rdoc"
+  ]
+end

data/lib/altered_views/path_set_extension.rb

@@ -0,0 +1,23 @@
+module ActionView
+	class PathSet		
+		def find_all(*args)
+			@cache ||= {}
+			call_parent = false
+			
+			if args[1].is_a? String and args[1] =~ /^parent:/
+				call_parent = true
+				args[1] = args[1].gsub(/^parent:/, '')
+			end
+
+			if @cache.has_key? args.hash and call_parent
+				list = @cache[args.hash] 
+			else
+	      list = map do |resolver|
+	        templates = resolver.find_all(*args)        
+	      end.reject {|templates| templates.empty? }
+				@cache[args.hash] = list
+			end
+			list.empty? ? [] : list.shift
+    end
+	end
+end

data/lib/altered_views/version.rb

@@ -0,0 +1,3 @@
+module AltereddViews
+  VERSION = "0.1.1"
+end

data/lib/altered_views.rb

@@ -0,0 +1,50 @@
+require "altered_views/path_set_extension"
+
+module AltereddViews
+	def inherit_view(name, &block)
+		content = capture {render(:template => name) }
+		@doc = Nokogiri::HTML content
+		yield
+		raw @doc.css("body > *").to_s
+	end	
+
+private	
+	def content(selector, &block)
+		find_node(selector).each {|node| node.inner_html = capture(&block)}
+		""
+	end
+
+	def before(selector, &block)
+		find_node(selector).each {|node| node.before capture(&block)}
+		""
+	end
+
+	def after(selector, &block)
+		find_node(selector).each {|node| node.after capture(&block)}
+		""
+	end	
+
+	def append(selector, &block)
+		find_node(selector).each {|node| node.add_child capture(&block)}
+		""
+	end		
+
+	def prepend(selector, &block)
+		find_node(selector).each do |node| 
+			c = node.children; 
+			node.inner_html = capture(&block); node.add_child c
+		end
+		""
+	end	
+
+	def find_node(selector)
+		els = @doc.css selector
+		if els.empty?
+			raise "Selector \"#{selector}\" not found in the view."
+		else
+			return els
+		end
+	end
+end
+
+ActionController::Base.send :add_template_helper, AltereddViews

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: altered_views
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Sergey Kuleshov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-24 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id003
+description: Altered views allows one to inherit views from pluged in engines and extend them by operating on the DOM model.
+email: 
+- svyatogor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Readme.rdoc
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.rdoc
+- altered_views.gemspec
+- lib/altered_views.rb
+- lib/altered_views/path_set_extension.rb
+- lib/altered_views/version.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: altered_views
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Inherit and extend rails views in OOP manner
+test_files: []
+