blue_sparks 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 Cody Krieger
+
+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

@@ -0,0 +1,130 @@
+BlueSparks
+============
+
+Epic static page rendering controller with support for nested pages.
+Heavily inspired by [thoughtbot's high_voltage](/thoughtbot/high_voltage).
+
+Static pages?
+-------------
+
+Yeah, like "About us", "Directions", marketing pages, etc.
+
+Installation
+------------
+
+    % gem install blue_sparks
+
+Include in your Gemfile:
+
+    gem "blue_sparks"
+
+Sorry, folks, Rails 3 only.
+
+Usage
+-----
+
+Write your static pages and put them in the RAILS_ROOT/app/views/pages directory.
+
+    % mkdir app/views/pages
+    % touch app/views/pages/about.html.erb
+
+<!--
+After putting something interesting there, you can link to it from anywhere in your app with:
+
+    link_to "About", page_path("about")
+
+This will also work, if you like the more explicit style:
+
+    link_to "About", page_path(:id => "about")
+-->
+
+Bam.
+
+Routes
+------
+
+By default, the static page routes will be like /pages/:id (where :id is the view filename).
+
+If you want to route to a static page in another location (for example, a homepage), do this:
+
+    match 'pages/home' => 'blue_sparks/pages#show', :id => 'home'
+
+In that case, you'd need an app/views/pages/home.html.erb file.
+
+Generally speaking, you need to route to the 'show' action with an :id param of the view filename.
+
+You can route the root url to a high voltage page like this:
+
+    root :to => 'blue_sparks/pages#show', :id => 'home'
+
+Which will render a homepage from app/views/pages/home.html.erb
+
+Override
+--------
+
+Most common reasons to override?
+
+  * You need authentication around the pages to make sure a user is signed in.
+  * You need to render different layouts for different pages.
+
+Create a PagesController of your own:
+
+    $ rails generate controller pages
+
+Override the default route:
+
+    # in config/routes.rb
+    resources :pages
+
+Then modify it to subclass from High Voltage, adding whatever you need:
+
+    class PagesController < BlueSparks::PagesController
+      before_filter :authenticate
+      layout :layout_for_page
+
+      protected
+        def layout_for_page
+          case params[:id]
+          when 'home'
+            'home'
+          else
+            'application'
+          end
+        end
+    end
+
+Testing
+-------
+
+Just a suggestion, but you can test your pages using Shoulda pretty easily:
+
+    class PagesControllerTest < ActionController::TestCase
+      tests PagesController
+
+      %w(earn_money screencast about contact).each do |page|
+        context "on GET to /#{page}" do
+          setup { get :show, :slug => page }
+
+          should_respond_with :success
+          should_render_template page
+        end
+      end
+    end
+
+If you're not using a custom PagesController be sure to test <code>BlueSparks::PagesController</code> instead.
+
+Enjoy!
+
+Credits
+-------
+
+![thoughtbot](http://thoughtbot.com/images/tm/logo.png)
+
+for their awesome high_voltage gem.
+
+The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+
+License
+-------
+
+BlueSparks is Copyright © 2011 Cody Krieger. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/app/controllers/blue_sparks/pages_controller.rb

@@ -0,0 +1,47 @@
+class BlueSparks::PagesController < ApplicationController
+
+  unloadable
+
+  rescue_from ActionView::MissingTemplate do |exception|
+    if exception.message =~ %r{Missing template pages/}
+      raise ActionController::RoutingError, "No such page: #{params[:slug]}"
+    else
+      raise exception
+    end
+  end
+
+  def show
+    begin
+      render :template => current_page
+    rescue
+      raise $! unless $!.kind_of? ActionView::MissingTemplate
+
+      render :template => "#{current_page}/index"
+    end
+  end
+
+  def subnav
+    # magic method to render a given folder's subnav partial
+    begin
+      subnav = render :partial => "#{current_page}/menu", :layout => "menu_template"
+      subnav.first unless subnav.nil?
+    rescue
+      begin
+        subnav = render :partial => "#{page_root}/menu", :layout => "menu_template"
+      rescue
+      end
+    end
+    subnav.first unless subnav.nil?
+  end
+
+protected
+
+  def current_page
+    "pages/#{params[:slug].to_s.downcase}"
+  end
+
+  def page_root
+    "pages/#{params[:slug].to_s.downcase.gsub /^([^\/]+)(\/.+)+$/, '\1'}"
+  end
+
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match '/*slug' => 'blue_sparks/pages#show', :constraints => { :fullpath => /^\/(?!assets).+/ }
+end

data/lib/blue_sparks.rb

@@ -0,0 +1,3 @@
+module BlueSparks
+  require 'blue_sparks/engine' if defined?(Rails)
+end

data/lib/blue_sparks/engine.rb

@@ -0,0 +1,6 @@
+module BlueSparks
+
+  class Engine < Rails::Engine
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: blue_sparks
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Cody Krieger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Fire in the disco.  Fire in the ... taco bell.
+email: cody@codykrieger.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README.md
+- app/controllers/blue_sparks/pages_controller.rb
+- config/routes.rb
+- lib/blue_sparks/engine.rb
+- lib/blue_sparks.rb
+has_rdoc: true
+homepage: https://github.com/codykrieger/blue_sparks
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Epic static page rendering controller with support for nested pages.
+test_files: []
+