RubyGems - ie_conditional_tag - Versions diffs - 0.4.0 - Mend

ie_conditional_tag 0.4.0

Files changed (22) hide show

data/.document +5 -0
data/.gitignore +21 -0
data/LICENSE +20 -0
data/README.md +117 -0
data/Rakefile +52 -0
data/VERSION +1 -0
data/lib/generators/ie_conditional_tag/install_generator.rb +19 -0
data/lib/generators/templates/README +9 -0
data/lib/generators/templates/ie_conditional_tag.rb +24 -0
data/lib/ie_conditional_tag.rb +28 -0
data/lib/ie_conditional_tag/condition.rb +28 -0
data/lib/ie_conditional_tag/configuration.rb +20 -0
data/lib/ie_conditional_tag/dsl.rb +63 -0
data/lib/ie_conditional_tag/helper.rb +19 -0
data/lib/ie_conditional_tag/protected_condition.rb +12 -0
data/lib/ie_conditional_tag/railtie.rb +17 -0
data/lib/ie_conditional_tag/unprotected_condition.rb +12 -0
data/test/helper.rb +15 -0
data/test/test_condition.rb +41 -0
data/test/test_configuration.rb +17 -0
data/test/test_tag_helper.rb +41 -0
metadata +102 -0

data/.document ADDED Viewed

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

data/.gitignore ADDED Viewed

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+## TEXTMATE
+*.tmproj
+tmtags
+## EMACS
+*~
+\#*
+.\#*
+## VIM
+*.swp
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+## PROJECT::SPECIFIC

data/LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Anthony Burns, Bruce Williams
+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.md ADDED Viewed

@@ -0,0 +1,117 @@
+IE Conditional Tag
+==================
+This Rails plugin provides an easy way to insert a tag multiple times
+in an HTML document with IE conditional comments.  This is an
+alternate approach to conditional stylesheets and CSS hacks, and is
+explained in detail by [Paul Irish][1].
+You can learn more about conditional comments at [QuirksMode][2].
+Example
+-------
+Shown generating the `html` tag (as [recommended][1]), and adding a
+custom class:
+    <!DOCTYPE html>
+    <%= ie_conditional_tag :html, :class => 'some-custom-class' %>
+      <head>
+          <title>New HTML5 page</title>
+      </head>
+      <body>
+        <%= yield %>
+      </body>
+    </html>
+This would give you (with some prettied indentation):
+    <!DOCTYPE html>
+    <!--[if lt IE 7]><html class="ie6 some-custom-class"><![endif]-->
+    <!--[if IE 7]><html class="ie7 some-custom-class"><![endif]-->
+    <!--[if IE 8]><html class="ie8 some-custom-class"><![endif]-->
+    <!--[if IE 9]><html class="ie9 some-custom-class"><![endif]-->
+    <!--[if gt IE 9]><html class="some-custom-class"><![endif]-->
+    <!--[if !IE]><!--><html class="some-custom-class"><!--<![endif]-->
+      <head>
+          <title>New HTML5 page</title>
+      </head>
+      <body>
+        <!-- your content -->
+      </body>
+    </html>
+`ie_conditional_tag` will also accept a block, so this also works:
+    <!DOCTYPE html>
+    <%= ie_conditional_tag :html, :class => 'some-custom-class' do %>
+      <head>
+          <title>New HTML5 page</title>
+      </head>
+      <body>
+        <%= yield %>
+      </body>
+    <% end %>
+Wait, that's an ugly name!
+--------------------------
+We aimed for descriptive and agnostic; you may want to add a helper to
+call it, eg:
+    module ApplicationHelper
+      # ...
+      def html_tag(*args, &block)
+        ie_conditional_tag(*args, &block)
+      end
+    end
+Installation
+------------
+Use bundler.  In your `Gemfile`:
+    gem 'ie_conditional_tag'
+Install it:
+    $ bundler install
+Then, run the following:
+    $ rails generate ie_conditional_tag:install
+This will add the following initializer:
+    config/initializers/ie_conditional_tag.rb
+You may want to look/tweak the settings there.
+Note: By default, when IE 6, 7, 8, 9 are given the CSS classes 'ie6',
+'ie7', 'ie8', and 'ie9' respectively.  IE > 9 has no additional class
+added (which may be overly optimistic).  YMMV.
+Configuring
+-----------
+For details on how to configure the plugin, see `lib/ie_conditional_tag/dsl.rb`.
+Dependencies
+------------
+This plugin is only designed to work with Rails 3.0+.
+Note: We're happy to accept pull requests that add backwards
+compatibility with older versions of Rails.
+Copyright
+---------
+Copyright (c) 2010 Anthony Burns, Bruce Williams. See LICENSE for
+details.
+  [1]: http://paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/
+  [2]: http://www.quirksmode.org/css/condcom.html

data/Rakefile ADDED Viewed

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ie_conditional_tag"
+    gem.summary = %Q{IE conditional comments for Rails}
+    gem.description = %Q{Provides an easy-to-use helper for generating multiple tags inside IE-specific conditional comments}
+    gem.email = "bruce@codefluency.com"
+    gem.homepage = "http://github.com/bruce/ie_conditional_tag"
+    gem.authors = ["Anthony Burns", "Bruce Williams"]
+    gem.add_dependency 'rails', '~> 3.0'
+  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 = "ie_conditional_tag #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 0.4.0

data/lib/generators/ie_conditional_tag/install_generator.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module IeConditionalTag
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates a ie_conditional_tag initializer to configure your application."
+      def copy_initializer
+        template "ie_conditional_tag.rb", "config/initializers/ie_conditional_tag.rb"
+      end
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README ADDED Viewed

@@ -0,0 +1,9 @@
+=============================================================
+Added an initializer at:
+    config/initializers/ie_conditional_tag.rb
+You can modify this file to change browser-specific settings.
+=============================================================

data/lib/generators/templates/ie_conditional_tag.rb ADDED Viewed

@@ -0,0 +1,24 @@
+IEConditionalTag.configure do |config|
+  # The standard `config.on` line looks like:
+  #
+  #   on IE_CONDITIONAL_COMMENT_EXPRESSION, HTML_OPTIONS
+  #
+  # The `:class` option is special; unlike other attributes, its value
+  # will be prepended to any `:class` attribute given to `ie_conditional_tag`.
+  # Add CSS classes for IE 6 - 9
+  config.on 'lt IE 7', :class => 'ie6'
+  config.on 'IE 7', :class => 'ie7'
+  config.on 'IE 8', :class => 'ie8'
+  config.on 'IE 9', :class => 'ie9'
+  # For IE >= 9, no change
+  config.on 'gt IE 9'
+  # For all other browsers
+  # Note: Don't remove this line-- or other browsers won't get a
+  #       visible tag!
+  config.on '!IE'
+end

data/lib/ie_conditional_tag.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'ie_conditional_tag/configuration'
+require 'ie_conditional_tag/dsl'
+require 'ie_conditional_tag/helper'
+require 'ie_conditional_tag/condition'
+require 'ie_conditional_tag/protected_condition'
+require 'ie_conditional_tag/unprotected_condition'
+require 'ie_conditional_tag/railtie'
+module IEConditionalTag
+  def self.config
+    @config ||= Configuration.new
+  end
+  def self.process(options = {}, &block)
+    config.inject('') do |result, condition|
+      result << condition.wrap(options.dup, &block)
+    end
+  end
+  def self.configure(options = {}, &block)
+    @config = nil if options[:clear]
+    DSL.new(config, &block)
+  end
+end

data/lib/ie_conditional_tag/condition.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module IEConditionalTag
+  # Abstract
+  class Condition
+    def initialize(expression, options = {})
+      @expression = expression
+      @options = options
+    end
+    private
+    def merge_options(options = {})
+      css_class = options.delete(:class)
+      overridden = options.merge(@options)
+      if options[:class] || css_class
+        overridden.merge(:class => [@options[:class], css_class].compact.join(' '))
+      else
+        overridden
+      end
+    end
+  end
+end

data/lib/ie_conditional_tag/configuration.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module IEConditionalTag
+  class Configuration
+    include Enumerable
+    def clear
+      conditions.clear
+    end
+    def conditions
+      @conditions ||= []
+    end
+    def each(&block)
+      conditions.each(&block)
+    end
+  end
+end

data/lib/ie_conditional_tag/dsl.rb ADDED Viewed

@@ -0,0 +1,63 @@
+module IEConditionalTag
+  class DSL
+    def initialize(config, &block)
+      @config = config
+      instance_eval(&block) if block
+    end
+    # Add a condition
+    #
+    # Unless +expression+ is "!IE", this will add a "protected"
+    # condition, meaning that the contents of the condition
+    # will be hidden inside a comment and will not be added to the DOM
+    # by other browsers.
+    #
+    # You can also use the more specific +add_protected_condition+ and
+    # +add_unprotected_condition+ directly.
+    #
+    # call-seq:
+    #
+    #   on 'lt 7', :class => 'ie6'
+    #   on '!IE' # for other browsers
+    #
+    def on(expression, options = {})
+      if expression.upcase == '!IE'
+        add_unprotected_condition(expression, options)
+      else
+        add_protected_condition(expression, options)
+      end
+    end
+    # Add a protected condition.
+    #
+    # The contents of a protected condition will be hidden inside a
+    # comment and will not be added to the DOM  by other browsers.
+    def add_protected_condition(expression, options = {})
+      add_condition(ProtectedCondition, expression, options)
+    end
+    # Add an unprotected condition
+    #
+    # The contents of an unprotected condition will NOT be hidden from
+    # other browsers.  There should only be one of these configured.
+    #
+    # This is commonly used for the modern/up-to-date/non-IE version,
+    # eg when +expression+ is "!IE" or "gt IE 9".  Note you can add
+    # an unprotected condition using +on+ if you use the former
+    # expression (the latter may be too optimistic!)
+    def add_unprotected_condition(expression, options = {})
+      add_condition(UnprotectedCondition, expression, options)
+    end
+    private
+    def add_condition(klass, expression, options = {})
+      @config.conditions << klass.new(expression, options)
+    end
+  end
+end

data/lib/ie_conditional_tag/helper.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module IEConditionalTag
+  module Helper
+    def ie_conditional_tag(name, options = {}, &block)
+      result = IEConditionalTag.process(options) do |modified_options|
+        tag(name, modified_options, true)
+      end
+      result.chomp!
+      if block_given?
+        result << capture(&block)
+        result << raw("</#{name}>")
+      end
+      raw(result)
+    end
+  end
+end

data/lib/ie_conditional_tag/protected_condition.rb ADDED Viewed

@@ -0,0 +1,12 @@
+module IEConditionalTag
+  class ProtectedCondition < Condition
+    def wrap(options = {})
+      inside = yield(merge_options(options))
+      "<!--[if #{@expression}]>#{inside}<![endif]-->\n"
+    end
+  end
+end

data/lib/ie_conditional_tag/railtie.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module IEConditionalTag
+  if defined?(Rails::Railtie)
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'ie_conditional_tag.insert_into_active_record' do
+        IEConditionalTag::Railtie.insert
+      end
+    end
+  end
+  class Railtie
+    def self.insert
+      ActionController::Base.helper(IEConditionalTag::Helper)
+    end
+  end
+end

data/lib/ie_conditional_tag/unprotected_condition.rb ADDED Viewed

@@ -0,0 +1,12 @@
+module IEConditionalTag
+  class UnprotectedCondition < Condition
+    def wrap(options = {})
+      inside = yield(merge_options(options))
+      "<!--[if #{@expression}]><!-->#{inside}<!--<![endif]-->\n"
+    end
+  end
+end

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/core_ext'
+require 'action_view'
+require 'action_controller'
+require 'action_controller/test_case'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ie_conditional_tag'
+Dir[File.expand_path('../../lib/ie_conditional_tag/*.rb', __FILE__)].each do |path|
+  require path
+end

data/test/test_condition.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'helper'
+class TestCondition < ActionView::TestCase
+  test "wrapping a tag in a protected condition without additional options" do
+    condition = IEConditionalTag::ProtectedCondition.new('IE 6', :class => 'ie6')
+    assert_equal(%Q(<!--[if IE 6]><body class="ie6"><![endif]-->\n),
+                 condition.wrap { |opts| tag(:body, opts, true) })
+  end
+  test "wrapping a tag in an unprotected condition without additional options" do
+    condition = IEConditionalTag::UnprotectedCondition.new('!IE', :id => 'override', :class => 'non-ie')
+    result = condition.wrap(:id => 'custom', :class => 'basic') { |opts| tag(:body, opts, true) }
+    wrapper_pattern = Regexp.new(Regexp.quote('<!--[if !IE]><!--><body ') + '[^>]+' + Regexp.quote('><!--<![endif]-->'))
+    assert result =~ wrapper_pattern
+    assert result.include?('class="non-ie basic"')
+    assert result.include?('id="override"')
+  end
+  test "wrapping a tag in a protected condition with additional options" do
+    condition = IEConditionalTag::ProtectedCondition.new('IE 6', :id => 'override', :class => 'ie6')
+    result = condition.wrap(:id => 'custom', :class => 'basic') { |opts| tag(:body, opts, true) }
+    wrapper_pattern = Regexp.new(Regexp.quote('<!--[if IE 6]><body ') + '[^>]+' + Regexp.quote('><![endif]-->'))
+    assert result =~ wrapper_pattern
+    assert result.include?('class="ie6 basic"')
+    assert result.include?('id="override"')
+  end
+  test "wrapping a tag in an unprotected condition with additional options" do
+    condition = IEConditionalTag::UnprotectedCondition.new('!IE', :id => 'override', :class => 'no-ie')
+    result = condition.wrap(:id => 'custom', :class => 'basic') { |opts| tag(:body, opts, true) }
+    wrapper_pattern = Regexp.new(Regexp.quote('<!--[if !IE]><!--><body ') + '[^>]+' + Regexp.quote('><!--<![endif]-->'))
+    assert result =~ wrapper_pattern
+    assert result.include?('class="no-ie basic"')
+    assert result.include?('id="override"')
+  end
+end

data/test/test_configuration.rb ADDED Viewed

@@ -0,0 +1,17 @@
+require 'helper'
+class TestConfiguration < ActiveSupport::TestCase
+  setup do
+    IEConditionalTag.config.clear
+  end
+  test "adding a condition" do
+    assert_equal 0, IEConditionalTag.config.conditions.size
+    IEConditionalTag.configure do |config|
+      config.on '!IE', :class => 'not-ie'
+    end
+    assert_equal 1, IEConditionalTag.config.conditions.size
+  end
+end

data/test/test_tag_helper.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require 'helper'
+require 'action_view/template/handlers/erb'
+class TestIEConditionalTag < ActionView::TestCase
+  tests IEConditionalTag::Helper
+  setup do
+    @response = ActionController::TestResponse.new
+    IEConditionalTag.config.clear
+    IEConditionalTag.configure do |config|
+      config.on 'lt IE 7', :class => 'ie6'
+      config.on 'IE 7', :class => 'ie7'
+      config.on 'IE 8', :class => 'ie8'
+      config.on 'IE 9', :class => 'ie9'
+      config.on 'gt IE 9'
+      config.on '!IE'
+    end
+  end
+  test "browser body tag with no options and no block" do
+    rendered = String.new(ie_conditional_tag(:html))
+    assert rendered.include?('<!--[if lt IE 7]><html class="ie6"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if IE 7]><html class="ie7"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if IE 8]><html class="ie8"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if IE 9]><html class="ie9"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if gt IE 9]><html><![endif]-->'), rendered
+    assert rendered.include?('<!--[if !IE]><!--><html><!--<![endif]-->'), rendered
+  end
+  test "browser body tag with class option and no block" do
+    rendered = String.new(ie_conditional_tag(:html, :class => 'custom-class'))
+    assert rendered.include?('<!--[if lt IE 7]><html class="ie6 custom-class"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if IE 7]><html class="ie7 custom-class"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if IE 8]><html class="ie8 custom-class"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if IE 9]><html class="ie9 custom-class"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if gt IE 9]><html class="custom-class"><![endif]-->'), rendered
+    assert rendered.include?('<!--[if !IE]><!--><html class="custom-class"><!--<![endif]-->'), rendered
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: ie_conditional_tag
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors:
+- Anthony Burns
+- Bruce Williams
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-09-09 00:00:00 -07: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
+        segments:
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Provides an easy-to-use helper for generating multiple tags inside IE-specific conditional comments
+email: bruce@codefluency.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/generators/ie_conditional_tag/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/ie_conditional_tag.rb
+- lib/ie_conditional_tag.rb
+- lib/ie_conditional_tag/condition.rb
+- lib/ie_conditional_tag/configuration.rb
+- lib/ie_conditional_tag/dsl.rb
+- lib/ie_conditional_tag/helper.rb
+- lib/ie_conditional_tag/protected_condition.rb
+- lib/ie_conditional_tag/railtie.rb
+- lib/ie_conditional_tag/unprotected_condition.rb
+- test/helper.rb
+- test/test_condition.rb
+- test/test_configuration.rb
+- test/test_tag_helper.rb
+has_rdoc: true
+homepage: http://github.com/bruce/ie_conditional_tag
+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
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: IE conditional comments for Rails
+test_files:
+- test/helper.rb
+- test/test_condition.rb
+- test/test_configuration.rb
+- test/test_tag_helper.rb