simple_pages 0.1.0

data/README.md

@@ -0,0 +1,70 @@
+# Simple Pages
+
+A dummy plugin made for easy static page maintenance.
+
+
+## Example
+
+Include the SimplePages into a PagesController:
+
+    class PagesController
+      include SimplePages
+    end
+
+Then add into your routes the PagesController route:
+
+    ActionController::Routing::Routes.draw do |map|
+      ...
+      map.resources :pages
+      ...
+    end
+
+Now create the folder pages into your views folder and put there the templates you wish to render out. Remember to add a show.html.erb as the default template:
+
+    + app
+    |- views
+       |- pages
+          |- show.html.erb
+          |- about_us.html.erb
+
+So you can access the views getting:
+
+    http://localhost:3000/pages/about-us
+
+## Improving
+
+Let's say you want to put the PagesController as a default route and get this behavior:
+
+    http://localhost:3000/about-us
+
+You can get it changing the routes to:
+
+    ActionController::Routing::Routes.draw do |map|
+      ...
+      map.connect ':id', :controller => 'show', :action => 'show'
+    end
+    
+## Acknowledgment
+
+fnando's has_permalink plugin where I got the [permalink method](http://github.com/fnando/has_permalink/blob/master/lib/permalink/string_ext.rb).
+
+Copyright (c) 2009 [Bruno Azisaka Maciel], released under the MIT license
+
+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/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimplePages'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/simple_pages/version.rb

@@ -0,0 +1,3 @@
+module SimplePages
+  VERSION = "0.1.0"
+end

data/lib/simple_pages.rb

@@ -0,0 +1,42 @@
+module SimplePages
+  def self.included(base)
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+    def show
+      respond_to?(page_action) ? executes_page_action : render_page_template
+    end
+
+    protected
+    def page_action
+      @page_action ||= page_permalink params[:id]
+    end
+
+    def executes_page_action
+      send page_action
+      render page_template_path
+    rescue ActionView::MissingTemplate
+      render 'show'
+    end
+
+    def render_page_template
+      render page_template_path
+    rescue ActionView::MissingTemplate
+      render 'not_found', :status => 404
+    end
+
+    def page_template_path
+      [controller_name, page_locale, page_action].compact * "/"
+    end
+
+    def page_locale
+      return I18n.locale = params[:locale] if params[:locale]
+      return I18n.locale if I18n.locale != I18n.default_locale
+    end
+
+    def page_permalink(string)
+      URI.unescape(string).parameterize.underscore
+    end
+  end
+end

data/spec/controllers/i18n_simple_pages_controller_spec.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe I18nSimplePagesController do
+  render_views
+
+  describe "template rendering" do
+    describe "contact page" do
+      before { get :show, :id => "contact" }
+
+      it { should render_template "contact" }
+    end
+
+    describe "página de contato" do
+      context "when the locale param is defined" do
+        before { get :show, :id => "contato", :locale => "pt" }
+
+        it { should render_template "i18n_simple_pages/pt/contato" }
+
+        it "should define the locale" do
+          I18n.locale.should == :pt
+        end
+
+        after { I18n.locale = I18n.default_locale }
+      end
+
+      context "when the locale param is not defined" do
+        before { get :show, :id => "contato" }
+
+        it { should render_template "not_found" }
+      end
+
+      context "when the locale is defined" do
+        before do
+          I18n.locale = "pt"
+          get :show, :id => "contato"
+        end
+
+        it { should render_template "i18n_simple_pages/pt/contato" }
+
+        after { I18n.locale = I18n.default_locale }
+      end
+
+      context "when the locale param is not defined" do
+        before { get :show, :id => "contato" }
+
+        it { should render_template "not_found" }
+      end
+    end
+  end
+end

data/spec/controllers/simple_pages_controller_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe SimplePagesController do
+  render_views
+
+  context "when the template doesn't exist" do
+    before { get :show, :id => 'nothing' }
+
+    it { should render_template 'not_found' }
+    it { response.should be_not_found }
+  end
+
+  context "when the template exists" do
+    before { get :show, :id => 'testing' }
+
+    it { should render_template 'testing' }
+    it { response.should be_success }
+  end
+
+  context "when the template and action exist" do
+    before { get :show, :id => 'plus' }
+
+    it { should render_template 'plus' }
+    it { response.should be_success }
+    it { response.body.should =~ /1/ }
+  end
+
+  context "when the action exists but not the template" do
+    before { get :show, :id => 'minus' }
+
+    it { should render_template 'show' }
+    it { response.should be_success }
+    it { response.body.should =~ /\-1/ }
+  end
+end

data/spec/controllers/simple_pages_controller_with_special_characters_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe SimplePagesController, "using special characters like" do
+  context "\"testing-testing\"" do
+    before { get :show, :id => 'testing-testing' }
+
+    it { should render_template 'testing_testing' }
+  end
+
+  context "\"são-paulo-ribeirão\"" do
+    before { get :show, :id => 'são-paulo-ribeirão' }
+
+    it { should render_template 'sao_paulo_ribeirao' }
+  end
+
+  context "\"testing-testing\"" do
+    before { get :show, :id => 'testing-testing' }
+
+    it { should render_template 'testing_testing' }
+  end
+
+  context "\"são-paulo_ribeirão\"" do
+    before { get :show, :id => 'são-paulo_ribeirão' }
+
+    it { should render_template 'sao_paulo_ribeirao' }
+  end
+
+  context "\"são-paulo ribeirão\"" do
+    before { get :show, :id => 'são-paulo%20ribeirão' }
+
+    it { should render_template 'sao_paulo_ribeirao' }
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/controllers/i18n_simple_pages_controller.rb

@@ -0,0 +1,3 @@
+class I18nSimplePagesController < ApplicationController
+  include SimplePages
+end

data/spec/dummy/app/controllers/simple_pages_controller.rb

@@ -0,0 +1,11 @@
+class SimplePagesController < ApplicationController
+  include SimplePages
+
+  def plus
+    @total = 0 + 1
+  end
+
+  def minus
+    @total = 0 - 1
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/simple_pages/plus.html.erb

@@ -0,0 +1 @@
+<%= @total %>

data/spec/dummy/app/views/simple_pages/show.html.erb

@@ -0,0 +1 @@
+<%= @total %>

data/spec/dummy/config/application.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "simple_pages"
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+    config.assets.enabled = true
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../application', __FILE__)
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,17 @@
+Dummy::Application.configure do
+  config.cache_classes = true
+
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  config.whiny_nils = true
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_dispatch.show_exceptions = false
+
+  config.action_controller.allow_forgery_protection    = false
+
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1 @@
+Dummy::Application.config.secret_token = '9b6732ba44fd8625c7eadcac4c16c3e09ddf8e9b8df9e8dfb5e3da5bad77ce424324e8cf132c5cb723302dba28697fd88111895610ca82d3f13d9131a5570eb0'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1 @@
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,7 @@
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,4 @@
+Dummy::Application.routes.draw do
+  resources :i18n_simple_pages
+  resources :simple_pages
+end

data/spec/dummy/config.ru

@@ -0,0 +1,2 @@
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application