renderit 0.1.0

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 Andrey Romanov
+
+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,25 @@
+== RenderIt
+
+Main purpose of this gem was to make easier development of websites using html5/css3. 
+The problem that we have at the moment is that old browsers and ALL stable Internet Explorers don't support html5/css3, but we have to support all the main browsers. 
+To be able to use rounded corners, gradients, css-transformations, application cache and so on we can support two versions of website - one for old browsers and one for new.
+Browser name and browser version will be defined from user_agent that is sent by all the modern browsers.
+User expirience in new browser can be much better comparing to the versions of web applications written to work same under all browsers (including old once).
+
+To use this gem you can just install this gem, require it in your rails application and create configuration file conf/renderit.yml
+In this file you can define regular expressions to define browser name and version (if defaults are not enough). By default renderit supports InternetExplorer, Opera, Firefox, Chrome, Safari, SafariMobile.
+Also you can define templates that will be rendered for specific browsers. This templates will be used for rendering views as well as layouts.
+Here is an example of renderit.yml config file:
+
+templates:                                                                      
+  new: chrome>=4, firefox>=3.5, opera>=10.5
+
+If Chrome>=4 version, Firefox >= 3.5 version or Opera >= 10.5 version browser is used to get page of your rails application, rails will try to render page with '_new' postfix. For example, not 'sample_view' view,
+but 'sample_view_new' view (if it is present). If not - default 'sample_view' view will be rendered. Same thing with layouts. If you have 'application_new' layout - it will be rendered. If not 'application' layout
+will be used. 
+
+In order to use those tempates, default view or layout have to be present. You will not be able to render 'application_new' layout in case you have no 'application' layout.
+
+Have fun :)
+
+Copyright (c) 2010 Andrey Romanov. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "renderit"
+    gem.summary = %Q{Renders different templates depending on browser user_agent.}
+    gem.description = %Q{Renders different templates depending on browser user_agent.}
+    gem.email = "judo.ras@gmail.com"
+    gem.homepage = "http://github.com/romanoff/renderit"
+    gem.authors = ["Andrey Romanov"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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 '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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "renderit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/renderit.rb

@@ -0,0 +1,126 @@
+class ActionController::Base
+  private
+
+  # default_render method for ActionController::Base is redefined
+  # in order to render views for specific browsers (depending on user_agent)
+  def default_render
+    @renderit_template ||= RenderIt.get_template_name(request)
+    template_path = default_template_name + '_' + @renderit_template
+    if view_paths.find_template(template_path, default_template_format)
+      render template_path
+    end
+  rescue ActionView::MissingTemplate => e
+    render default_template_name
+  end
+
+  # default_layout method for ActionController::Base is redefined
+  # in order to render layouts for specific browsers (depending on user_agent)
+  def default_layout
+    @renderit_template = RenderIt.get_template_name(request)
+    layout = self.class.read_inheritable_attribute(:layout)
+    return layout unless self.class.read_inheritable_attribute(:auto_layout)
+    begin
+      rendered_layout = find_layout(layout+ '_' + @renderit_template, default_template_format)
+    rescue ActionView::MissingTemplate
+    end
+    return rendered_layout if rendered_layout
+    find_layout(layout, default_template_format)
+  rescue ActionView::MissingTemplate
+    nil
+  end
+
+end
+
+class RenderIt
+  # Default regular expressions to define browser and its version
+  DEFAULT_BROWSERS_CONFIG = {
+    'ie' => 'msie (\d+\.\d).*\)(?!\s*opera)', 
+    'firefox' => 'gecko.*?firefox\/(\d+\.\d)', 
+    'chrome' => 'applewebkit.*?chrome\/(\d+\.\d)', 
+    'safari' => 'applewebkit.*?version\/(\d+.\d)\.\d(?!\s*mobile).*?safari', 
+    'safarimobile' => 'applewebkit.*?version\/(\d+.\d)\.\d\smobile.*?safari', 
+    'opera' => 'opera.*?version\/(\d+\.\d)' 
+  }
+  VERSION_MATCH_REGEXP = Regexp.new("([a-z]+)(.*)", "i")
+  NON_EXPRESSION_REGEXP = Regexp.new("^[^><=]")
+
+  Browser = Struct.new(:name, :version)
+
+  # Returns template name depending on request. 
+  # Template name depends on configuration defined in conf/renderit.yml  
+  # For example, if renderit.yml will contain following:
+  #
+  # templates:
+  #      new: chrome>5, firefox>3.5, opera>10.5
+  #
+  # And request will be made from Chrome6.0 then if 'new' string should be returned.
+  def self.get_template_name(request)
+    user_agent = request.env["HTTP_USER_AGENT"]
+    browser = self.get_browser(user_agent)
+    return self.template_name(browser)
+  end
+
+
+  # Returns browser name and its version 
+  def self.get_browser(user_agent)
+    browsers_config = read_inheritable_attribute(:browsers_config)    
+    browsers_config.keys.each do |browser_name|
+      if version = browsers_config[browser_name].match(user_agent)
+        return Browser.new(browser_name, version[1])
+      end
+    end
+  end
+
+
+  # Returns template name based on browser and configuration
+  def self.template_name(browser)
+    templates_config = read_inheritable_attribute(:templates_config)
+    return '' unless templates_config
+    if (browser)
+      templates_config.keys.each do |name|
+        if comparator = templates_config[name][browser.name]
+          return name if eval(browser.version+comparator)
+        end
+      end
+    end
+    return ''
+  end
+
+  # Loads initial configuration from config/renderit.yml file
+  # This is made once on rails application start
+  def self.load_config
+    if File.exist?(File.join(Rails.root, 'config/renderit.yml'))
+      renderit_config = YAML::load_file(File.join(Rails.root, 'config/renderit.yml'))
+      
+      #Loading browsers config
+      browsers_config = renderit_config['browsers']||{}
+      browsers_config.merge!(DEFAULT_BROWSERS_CONFIG)
+      #Turning strings into RegExp
+      browsers_config.keys.each do |browser|
+        browsers_config[browser] = Regexp.new(browsers_config[browser], 'i')
+      end
+      write_inheritable_attribute(:browsers_config, browsers_config)
+
+      #Loading templates config
+      templates_config = renderit_config['templates']
+      templates_config.keys.each do |template_name|
+        matching_browser_versions = templates_config[template_name]
+        templates_config[template_name] = {}
+        matching_browser_versions.split(',').each do |value|
+          match = VERSION_MATCH_REGEXP.match(value)
+          if (browser = match[1]) && (expression = match[2])
+            expression = expression.strip
+            expression = '=='+expression if NON_EXPRESSION_REGEXP.match(expression)
+            templates_config[template_name][browser.strip.downcase] = expression
+          end
+        end
+      end
+
+      write_inheritable_attribute(:templates_config, templates_config)
+    end
+
+  end
+
+end
+
+RenderIt.load_config

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'renderit'
+
+class Test::Unit::TestCase
+end

data/test/test_renderit.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestRenderit < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: renderit
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrey Romanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-05 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Renders different templates depending on browser user_agent.
+email: judo.ras@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/renderit.rb
+- test/helper.rb
+- test/test_renderit.rb
+has_rdoc: true
+homepage: http://github.com/romanoff/renderit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Renders different templates depending on browser user_agent.
+test_files: 
+- test/helper.rb
+- test/test_renderit.rb