rails_join 1.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activesupport", ">= 3.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  # gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Marc-Andre Lafortune
+
+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,37 @@
+= rails_join
+
+Doing a `join` on an array containing html safe strings will produce an html unsafe string.
+
+Rails provides a helper called `safe_join` that will always produce an html safe string.
+
+This gem modifies `Array#join` so that it returns an html safe string when the first element is an html safe string. This is similar to `s1 + s2` returning an html safe string if and only if `s1` is html safe. If the first element is not an html safe string (or does not exist), then `Array#join` returns a normal string, as was previously the case. Again, this is similar to `s1 + s2` returning a normal string if `s1` is a normal string, even if `s2` is an html safe string.
+
+    links = [link_to("Home", "/"), link_to("Profile", "/profile")]
+    desired = links[0] + " > " + links[1]
+    joined  = links.join(" > ")
+    joined == desired # => false
+    joined.html_safe? # => false
+    require 'rails_join'
+    joined  = links.join(" > ")
+    joined == desired # => true
+    joined.html_safe? # => true
+
+== Installation
+
+Simply add to your Gemfile:
+
+  gem "rails_join"
+
+Run `bundle install` and you're done.
+
+Runs on all versions of Ruby and all versions of Rails >= 3.0
+
+== Why?
+
+See: https://github.com/rails/rails/pull/3716
+
+== Copyright
+
+Copyright (c) 2012 Marc-Andre Lafortune. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails_join"
+  gem.homepage = "http://github.com/marcandre/rails_join"
+  gem.license = "MIT"
+  gem.summary = %Q{Make Array#join be html_safe aware}
+  gem.description = %Q{Use [...].join without worrying}
+  gem.email = "github@marc-andre.ca"
+  gem.authors = ["Marc-Andre Lafortune"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_join #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rails_join.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/string/output_safety'
+require 'active_support/core_ext/module/aliasing.rb'
+
+unless ["<br/>".html_safe, ">"].join("<") == "<br/>&lt;&gt;"
+  class Array
+    def join_with_safe_buffer_awareness(sep = $,)
+      f = first
+      if f.is_a?(ActiveSupport::SafeBuffer) && f.html_safe?
+        map { |i| ERB::Util.html_escape(i) }.join_without_safe_buffer_awareness(ERB::Util.html_escape(sep)).html_safe
+      else
+        join_without_safe_buffer_awareness(sep)
+      end
+    end
+    alias_method_chain :join, :safe_buffer_awareness
+  end
+end

data/spec/perf.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/rails_join"
+require 'fruity'
+
+[5, 25, 100].each do |n|
+  compare :join_without_safe_buffer_awareness, :join_with_safe_buffer_awareness, :on => ["A typical short string"] * n
+end

data/spec/rails_join_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Array#join" do
+  it "is not affected if the array is empty" do
+    r = [].join
+    r.should == ""
+    r.should_not be_html_safe
+
+    r = [].join("x".html_safe)
+    r.should == ""
+    r.should_not be_html_safe
+  end
+
+  it "is not affected if the first element is not an html safe buffer" do
+    r = [1, 2, 3].join
+    r.should == "123"
+    r.should_not be_html_safe
+
+    r = ["", "<>".html_safe].join("x".html_safe)
+    r.should == "x<>"
+    r.should_not be_html_safe
+  end
+
+  it "returns an html_safe string if the first element is an html safe buffer" do
+    r = ["<br/>".html_safe, 2, "<p/>"].join(" & ")
+    r.should == "<br/> &amp; 2 &amp; &lt;p/&gt;"
+    r.should be_html_safe
+  end
+
+  it "returns a string if the first element is a non html safe buffer" do
+    first = "<br/>".html_safe.upcase!
+    first.should_not be_html_safe # sanity check
+    first.class.should_not == String # sanity check
+    r = [first, 2, "<p/>"].join(" & ")
+    r.should == "<BR/> & 2 & <p/>"
+    r.should_not be_html_safe
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'rails_join'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: rails_join
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Marc-Andre Lafortune
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2165002120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165002120
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165001600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165001600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165000800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2165000800
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2165000040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2165000040
+description: Use [...].join without worrying
+email: github@marc-andre.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rails_join.rb
+- spec/perf.rb
+- spec/rails_join_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/marcandre/rails_join
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2340820225422058680
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Make Array#join be html_safe aware
+test_files: []