radiant-language_redirect-extension 1.0.0

data/README.textile

@@ -0,0 +1,52 @@
+h1. Language Redirect
+
+Redirects to the appropriate language section based on the content encoding preferred by the Web browser.
+
+h2. Version History
+
+* 2/2013 - Radiant 1.1.x compatible, fix deprecations, gemify
+* 5/2011 - Radiant 1.0 compatible
+* 4/2009 - Radiant 0.8 compatible
+* 2/2009 - Radiant 0.7 compatible
+* 1/2007 - Intital Import
+
+h2. Installation
+
+* add to your Gemfile:  <code>gem "radiant-language_redirect-extension"</code>
+* run bundle
+
+h2. Usage
+
+You can add a "config" part to the page which maps languages to URLs
+in the following format:
+
+<pre>
+  lang: url
+  lang: url
+  ...
+</pre>
+
+Where "lang" refers to a language code and "url" refers to the URL
+which should be redirected to based on the preferred content
+encoding of the Web browser.
+
+The following listing is a sample "config" page part:
+<pre>
+  en: /en/
+  ja: /ja/
+  *: /en/
+</pre>
+In this example, when the browser prefers English content it will be
+redirected to the "/en/" URL. When it prefers Japanese content it will
+be redirected to the "/ja/" URL. In the event that the browser prefers
+something other than English or Japanese content, they will be
+redirected to the "/en/" URL. This is what the "*" in the last entry
+does. URLs can be either relative (without "http://hostname.tld") or
+absolute (with "http://hostname.tld").
+
+If no "config" part is specified the behavior will force the page to
+redirect to the "/en/" folder.
+
+h2. Credits
+
+Created by "Giovanni Intini":http://tempe.st/about/, maintained by "contributors":https://github.com/intinig/radiant_language_redirect_extension/network 

data/Rakefile

@@ -0,0 +1,137 @@
+begin
+  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 = "radiant-language_redirect-extension"
+    gem.homepage = "https://github.com/avonderluft/radiant-language_redirect-extension"
+    gem.license = "MIT"
+    gem.summary = %Q{Language Redirect Extension for Radiant CMS}
+    gem.description = %Q{Redirects to the appropriate language section based on the content encoding preferred by the Web browser.}
+    gem.email = "avonderluft@avlux.net"
+    gem.authors = ["Giovanni Intini", "Andrew vonderLuft"]
+    gem.add_dependency 'radiant', ">=1.1.3"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package language_redirect as a gem."
+end
+
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rdoc/task'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the language_redirect extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LanguageRedirectExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the language_redirect extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

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

data/app/models/language_redirect_page.rb

@@ -0,0 +1,66 @@
+class LanguageRedirectPage < Page
+
+  def headers
+    {
+      'Status' => "301 Redirect",
+      'Location' => location,
+      'Vary' => "Accept-Language"
+    }
+  end
+
+  def render
+    "<html><body>301 Redirect</body></html>"
+  end
+
+  def cache?
+    false
+  end
+
+  def response_code
+    301
+  end
+  
+  def find_by_url(url, live=true, clean=true)
+    found = super
+    if (found.nil? || found.is_a?(FileNotFoundPage)) && 
+      location_map.values.all? {|target| clean_url(url) !~ Regexp.new(target) }
+      self
+    else
+      found
+    end
+  end
+  alias find_by_path find_by_url
+
+  protected
+    def config
+      YAML.load(render_part('config'))
+    end
+
+    def languages
+      langs = (@request.env["HTTP_ACCEPT_LANGUAGE"] || "").split(/[,\s]+/)
+      langs_with_weights = langs.map do |ele|
+        both = ele.split(/;q=/)
+        lang = both[0].split('-').first
+        weight = both[1] ? Float(both[1]) : 1
+        [-weight, lang]
+      end.sort_by(&:first).map(&:last)
+    end
+
+    def location
+      path = location_map[languages.find { |lang| location_map[lang] }]
+      path ||= location_map["*"] || '/en/'
+      path += request.request_uri
+      path.gsub!(%r{([^:])//}, '\1/')
+      if path =~ %r{[:][/][/]}
+        path
+      else
+        path.sub!(%r{^([^/])}, '/\1')
+        @request.protocol + @request.host_with_port + path
+      end
+    end
+
+    def location_map
+      @location_map ||= config
+    end
+
+end

data/language_redirect_extension.rb

@@ -0,0 +1,11 @@
+class LanguageRedirectExtension < Radiant::Extension
+  version "#{File.read(File.expand_path(File.dirname(__FILE__)) + '/VERSION')}"
+  description "Enables redirects to the appropriate language section based on the content encoding preferred by the Web browser."
+  url "https://github.com/avonderluft/radiant_language_redirect_extension"
+
+  def activate
+    Page.send :include, LanguageRedirectTags
+    LanguageRedirectPage
+  end
+
+end

data/lib/language_redirect_tags.rb

@@ -0,0 +1,90 @@
+module LanguageRedirectTags
+  include Radiant::Taggable
+  
+  class TagError < StandardError; end
+
+  desc %{
+    Shows the content if the code matches the actual language
+
+    *Usage:*
+    <pre><code><r:if_language code="language" >...</r:if_language></code></pre>
+  }
+  tag 'if_language' do |tag|
+    tag.expand if tag.attr['code'] == current_language
+  end
+
+  desc %{
+    Shows the content unless the code matches the actual language
+
+    *Usage:*
+    <pre><code><r:unless_language code="language" >...</r:unless_language></code></pre>
+  }
+  tag 'unless_language' do |tag|
+    tag.expand unless tag.attr['code'] == current_language
+  end
+
+  desc %{
+    Shows a language chooser list separated by the characters supplied with the 'separator' attribute. By default, 'separator' is set to |.
+    If the 'upcase' attribute is set to false, the language description will be uppercase. By default, 'upcase' is set to true.
+    If the 'singleletter' attribute is set to false, the language description will show only the first letter. By default, 'singleletter' is set to true.
+
+    *Usage:*
+    <pre><code><r:choose_language [separator="|"] [upcase="true|false] [singleletter="true|false"] /></code></pre>
+  }
+  tag 'languageswitch' do |tag|
+    upcase = tag.attr.has_key?('upcase') && tag.attr['upcase']=='false' ? nil : true
+    singleletter = tag.attr.has_key?('singleletter') && tag.attr['singleletter']=='false' ? nil : true
+    separator = tag.attr['separator'] || "|"
+
+    html = '<ul>'
+    config = language_config(self)
+    config.delete('*')
+    position = 1
+    config.each do |key, value|
+      key = key.upcase if upcase
+      key = key.split(//)[0] if singleletter
+      if request.request_uri.starts_with? value
+        html += "<li class='active_language'>#{key}</li>"
+      else
+        html += "<li><a href='#{value}'>#{key}</a></li>"
+      end
+      html += "<li>#{separator}</li>" if position != config.length
+      position = position + 1
+    end
+    html += '</ul>'
+  end
+
+  tag 'breadcrumbs' do |tag|
+    page = tag.locals.page
+    breadcrumbs = [tag.render('breadcrumb')]
+    nolinks = (tag.attr['nolinks'] == 'true')
+    # Remove LanguageRedirect pages from the hierarchy (preferably the root)
+    page.ancestors.reject {|p| p.is_a?(LanguageRedirectPage) }.each do |ancestor|
+      tag.locals.page = ancestor
+      if nolinks
+        breadcrumbs.unshift tag.render('breadcrumb')
+      else
+        breadcrumbs.unshift %{<a href="#{tag.render('url')}">#{tag.render('breadcrumb')}</a>}
+      end
+    end
+    separator = tag.attr['separator'] || ' &gt; '
+    breadcrumbs.join(separator)
+  end
+  
+  protected
+
+    def current_language
+      config = language_config(self)
+      config.each do |key, value|
+         return key if request.request_uri.starts_with? value
+      end
+    end
+
+    def language_config(page)
+      if page.class == LanguageRedirectPage
+        YAML.load(page.render_part(:config))
+      elsif page.parent
+        language_config(page.parent)
+      end
+    end
+end

data/lib/tasks/language_redirect_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :language_redirect do
+      
+      desc "Runs the migration of the Language Redirect extension"
+      task :migrate do
+        require 'extension_migrator'
+        if ENV["VERSION"]
+          LanguageRedirectExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          LanguageRedirectExtension.migrator.migrate
+        end
+      end
+    
+    end
+  end
+end

data/spec/datasets/language_redirect_dataset.rb

@@ -0,0 +1,7 @@
+class LanguageRedirectDataset < Dataset::Base
+  uses :pages
+  
+  def load
+    Page.update_all({:class_name => "LanguageRedirectPage"}, "id = #{page_id(:home)}")
+  end
+end

data/spec/models/language_redirect_page_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe "LanguageRedirectPage" do
+
+  before :each do
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+    @page = LanguageRedirectPage.new
+    @page.stub!(:url).and_return('/')
+    @page.parts.build(:name => 'config', :content => {'de' => '/de/', 'es' => '/es/', '*' => '/en/'}.to_yaml)
+    @page.parts[0].draft_content = @page.parts[0].content if defined? ConcurrentDraft
+    @request.request_uri = '/'
+  end
+
+  it "should select the * entry when no language is given" do
+    @page.process(@request, @response)
+    @response.should be_redirect
+    @response.redirect_url.should == "http://test.host/en/"
+  end
+
+  it "should select the * entry when no language matches" do
+    @request.env['HTTP_ACCEPT_LANGUAGE'] = "jp, fr"
+    @page.process(@request, @response)
+    @response.should be_redirect
+    @response.redirect_url.should == "http://test.host/en/"
+  end
+
+  it "should select the first matching language in order given (when all weights are same)" do
+    @request.env['HTTP_ACCEPT_LANGUAGE'] = "es, de, en"
+    @page.process(@request, @response)
+    @response.should be_redirect
+    @response.redirect_url.should == "http://test.host/es/"
+  end
+
+  it "should select the first matching language with the highest weight" do
+    @request.env['HTTP_ACCEPT_LANGUAGE'] = "de;q=0.7, es;q=0.9, en;q=0.2"
+    @page.process(@request, @response)
+    @response.should be_redirect
+    @response.redirect_url.should == "http://test.host/es/"
+  end
+
+  it "should append the request URI to the redirect location, cleaning up extra slashes" do
+    @request.request_uri = '/freight/'
+    @page.process(@request, @response)
+    @response.redirect_url.should == "http://test.host/en/freight/"
+  end
+
+  describe "when a child page is not found" do
+    dataset :language_redirect
+
+    before :each do
+      @page = pages(:home)
+      @page.slug = "freight"
+      @page.save!
+      @page.parts.create!(:name => 'config', :content => {'de' => '/parent/', 'es' => '/es/', '*' => '/en/'}.to_yaml)
+    end
+
+    it "should return self if the URL doesn't match any of the redirect locations" do
+      Page.find_by_path('/freight/').should == @page
+    end
+
+    it "should return the found page or nil if the URL matches a redirect location" do
+      Page.find_by_path('/en/freight/').should_not == @page
+    end
+  end
+end

data/spec/models/tags_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe "Adjusted breadcrumbs tag" do
+  dataset :pages
+  
+  before :each do
+    pages(:home).update_attributes(:class_name => "LanguageRedirectPage")
+  end
+  
+  it "should not render the language-redirect page (homepage) in the breadcrumbs" do
+    pages(:child_2).should render('<r:breadcrumbs nolinks="true" />').as('Parent &gt; Child 2')
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+Dataset::Resolver.default << (SnippetsExtension.root + "/spec/datasets") if defined?(SnippetsExtension)
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-language_redirect-extension
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Giovanni Intini
+- Andrew vonderLuft
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-02-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
+        version: 1.1.3
+  version_requirements: *id001
+  name: radiant
+  prerelease: false
+  type: :runtime
+description: Redirects to the appropriate language section based on the content encoding preferred by the Web browser.
+email: avonderluft@avlux.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- README.textile
+- Rakefile
+- VERSION
+- app/models/language_redirect_page.rb
+- language_redirect_extension.rb
+- lib/language_redirect_tags.rb
+- lib/tasks/language_redirect_extension_tasks.rake
+- spec/datasets/language_redirect_dataset.rb
+- spec/models/language_redirect_page_spec.rb
+- spec/models/tags_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/avonderluft/radiant-language_redirect-extension
+licenses: 
+- MIT
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Language Redirect Extension for Radiant CMS
+test_files: []
+