rails-brochure 0.0.1 → 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dan Hixon
+
+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,100 @@
+Rails Brochure
+============
+
+Rails engine for brochure pages. Similar to High Voltage but with named routes.
+
+Brochure pages are the semi-static pages like "home", "about us", "FAQ", "pricing", "contact us", etc.
+
+Most of the designers I have worked with really appreciate the power and convenience this plugin provides. They are able to simply create erb files in folders like they are used to with static html or php and it just works.  No futzing with routes, controllers etc.
+
+Installation
+------------
+
+Rails 3 required.
+
+Include in your Gemfile:
+
+    gem "rails-brochure"
+
+Don't forget to install:
+
+    $ bundle install
+
+You can install from the command line as well:
+
+    $ sudo gem install rails-brochure
+
+Usage
+-----
+
+Write your static pages and put them in the RAILS_ROOT/app/views/home directory.
+
+    mkdir app/views/home
+    touch app/views/home/about.html.erb
+    
+After putting something interesting there, a named route is created and you can link to it from anywhere in your app with:
+
+        link_to "About", about_url
+        link_to "About", about_path
+        
+You can also create content in sub directories like this:
+    
+    mkdir app/views/home/about
+    touch app/views/home/about/company
+
+This will create a named route about_company:
+
+    link_to "Company", about_company_url
+    link_to "Company", about_company_path
+
+Once you have an index template you may want to add this route to your config/routes.rb:
+
+    root :to => "home#index"
+
+Name Routes?
+--------
+
+Named routes are good because if you change a page name (about.html.erb to about_us.html.erb) without updating the links you'll get failing tests:
+
+  ActionView::TemplateError: undefined local variable or method `about_path'
+
+
+Override
+--------
+
+Some reasons you may want to override:
+
+  * Need to grab some data from a database or something.
+  * Need authentication around some pages
+  * Need to render different layouts for different pages.
+  
+Create a HomeController of your own:
+
+    rails generate controller home
+
+Then just add in the actions you want to behave differently:
+
+    class HomeController < ApplicationController
+      before_filter :require_user, :only => :private_info
+      
+      def pricing
+        @prices = Price.all
+      end
+    
+      def index
+        # index page has it's own layout html
+        render :layout => false
+      end
+      
+      def private_info
+        @info = current_user.private_info
+      end
+      
+    end
+
+Enjoy!
+
+License
+-------
+
+Rails Brochure is Copyright © 2010-2011 Dan Hixon. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/app/controllers/home_controller.rb

@@ -0,0 +1,3 @@
+class HomeController < ApplicationController
+  
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  Rails::Brochure::HomeContent.templates.each do |pg|
+    match "/#{pg}" => "home##{pg}", :as => pg.gsub('/','_').to_sym
+  end
+end

data/lib/generators/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate brochure
+
+    This will create:
+        app/views/home
+        app/views/home/index.html.erb
+        app/views/home/about.html.erb

data/lib/generators/brochure_generator.rb

@@ -0,0 +1,3 @@
+class BrochureGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+end

data/lib/generators/templates/app/views/home/about.html.erb

@@ -0,0 +1,2 @@
+<h1>home#about</h1>
+find me in app/views/home/about.html.erb

data/lib/generators/templates/app/views/home/index.html.erb

@@ -0,0 +1,2 @@
+<h1>home#index</h1>
+find me in app/views/home/index.html.erb

data/lib/rails-brochure.rb

@@ -1,4 +1,3 @@
-require File.dirname(__FILE__) + '/rails-brochure/home_content'
-require File.dirname(__FILE__) + '/rails-brochure/route_reloader'
-require File.dirname(__FILE__) + '/rails-brochure/engine'
-
+require File.expand_path(File.dirname(__FILE__)) + '/rails-brochure/home_content'
+require File.expand_path(File.dirname(__FILE__)) + '/rails-brochure/route_reloader'
+require File.expand_path(File.dirname(__FILE__)) + '/rails-brochure/engine'

data/lib/rails-brochure/engine.rb

@@ -0,0 +1,11 @@
+# Engine injects some middleware to reload 
+# routes if new files habe been added
+module Rails
+  module Brochure
+    class Engine < Rails::Engine
+      initializer "brochure routes" do |app|
+        app.middleware.use "Rails::Brochure::RouteReloader"  
+      end
+    end
+  end
+end

data/lib/rails-brochure/home_content.rb

@@ -0,0 +1,18 @@
+module Rails
+  module Brochure
+    class HomeContent
+      HOME_FOLDER_PATH = "app/views/home/"
+      def self.newest
+        HomeContent.files.map { |f| File.new(f) }.sort { |a,b| a.ctime <=> b.ctime }.map { |f| f.ctime }.last
+      end
+      def self.files
+        Dir.glob("#{HOME_FOLDER_PATH}**/*.html.*")
+      end
+      def self.templates
+        HomeContent.files.map do |f| 
+          f.gsub(/(#{HOME_FOLDER_PATH}|.html.\w+)/,"")
+        end
+      end
+    end
+  end
+end

data/lib/rails-brochure/route_reloader.rb

@@ -0,0 +1,25 @@
+module Rails
+  module Brochure
+    class RouteReloader
+      def initialize(app)
+        @app = app
+      end
+      def call(env)
+        reload_routes if new_content?
+        @app.call(env)
+      end
+      def reload_routes
+        # we must touch the routes file in order for it to be reloaded    
+        FileUtils.touch("config/routes.rb")
+        Rails.application.reload_routes!
+        Rails.logger.info "ROUTES RELOADED by rails-brochure"
+      end
+      def new_content?
+        HomeContent.newest > last_route_change
+      end
+      def last_route_change
+        File.mtime("config/routes.rb")
+      end
+    end
+  end
+end

data/lib/rails-brochure/version.rb

@@ -1,5 +1,5 @@
 module Rails
   module Brochure
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/rails-brochure.gemspec

@@ -9,8 +9,10 @@ Gem::Specification.new do |s|
   s.authors     = ["Dan Hixon"]
   s.email       = ["danhixon@gmail.com"]
   s.homepage    = "http://github.com/danhixon/rails-brochure"
-  s.summary     = %q{Rails Plugin for hosting static content files a-la-php with named routes.}
-  s.description = %q{Rails Plugin for hosting static content files a-la-php with named routes.  It is a lot like high voltage but you get named routes and '/pages' is not part of your routes.}
+  s.summary     = %q{Rails engine for brochure pages. Similar to High Voltage but with named routes.}
+  s.description = %q{Rails engine for brochure pages. Similar to High Voltage but with named routes.
+  Brochure pages are the semi-static pages like "home", "about us", "FAQ", "pricing", "contact us", etc.
+  Most of the designers I have worked with really appreciate the power and convenience this plugin provides. They are able to simply create erb files in folders like they are used to with static html or php and it just works.  No futzing with routes, controllers etc.}
  
   s.add_dependency('rails', '>= 3.0.0')
  

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: rails-brochure
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors: 
 - Dan Hixon
@@ -15,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-29 00:00:00 -07:00
+date: 2011-04-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,15 +21,13 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        - 0
         version: 3.0.0
   type: :runtime
   version_requirements: *id001
-description: Rails Plugin for hosting static content files a-la-php with named routes.  It is a lot like high voltage but you get named routes and '/pages' is not part of your routes.
+description: |-
+  Rails engine for brochure pages. Similar to High Voltage but with named routes.
+    Brochure pages are the semi-static pages like "home", "about us", "FAQ", "pricing", "contact us", etc.
+    Most of the designers I have worked with really appreciate the power and convenience this plugin provides. They are able to simply create erb files in folders like they are used to with static html or php and it just works.  No futzing with routes, controllers etc.
 email: 
 - danhixon@gmail.com
 executables: []
@@ -46,8 +39,19 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- MIT-LICENSE
+- README.md
 - Rakefile
+- app/controllers/home_controller.rb
+- config/routes.rb
+- lib/generators/USAGE
+- lib/generators/brochure_generator.rb
+- lib/generators/templates/app/views/home/about.html.erb
+- lib/generators/templates/app/views/home/index.html.erb
 - lib/rails-brochure.rb
+- lib/rails-brochure/engine.rb
+- lib/rails-brochure/home_content.rb
+- lib/rails-brochure/route_reloader.rb
 - lib/rails-brochure/version.rb
 - rails-brochure.gemspec
 has_rdoc: true
@@ -64,25 +68,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   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: rails-brochure
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Rails Plugin for hosting static content files a-la-php with named routes.
+summary: Rails engine for brochure pages. Similar to High Voltage but with named routes.
 test_files: []