effective_pages 0.8.0

data/app/views/admin/pages/edit.html.haml

@@ -0,0 +1,2 @@
+%h2= @page_title
+= render :partial => 'form', :as => :page, :object => @page

data/app/views/admin/pages/index.html.haml

@@ -0,0 +1,9 @@
+%h2= @page_title
+
+- unless @datatable.collection.length > 0
+  %p
+    There are no pages
+- else
+  = render_datatable @datatable
+
+%p= link_to 'New Page', effective_pages.new_admin_page_path, :class => 'btn btn-primary'

data/app/views/admin/pages/new.html.haml

@@ -0,0 +1,2 @@
+%h2= @page_title
+= render :partial => 'form', :as => :page, :object => @page

data/config/routes.rb

@@ -0,0 +1,28 @@
+class EffectivePagesRoutingConstraint
+  def self.matches?(request)
+    id = request.path_parameters[:id] || '/'
+    Effective::Page.find(id).present? rescue false
+  end
+end
+
+EffectivePages::Engine.routes.draw do
+  if defined?(EffectiveDatatables)
+    namespace :admin do
+      resources :pages, :except => [:show]
+      resources :menus, :except => [:show]
+    end
+  end
+
+  scope :module => 'effective' do
+    get '*id' => "pages#show", :constraints => EffectivePagesRoutingConstraint, :as => :page
+  end
+end
+
+# Automatically mount the engine as an append
+Rails.application.routes.append do
+  unless Rails.application.routes.routes.find { |r| r.name == 'effective_pages' }
+    mount EffectivePages::Engine => '/', :as => 'effective_pages'
+  end
+end
+
+#root :to => 'Effective::Pages#show', :id => 'home'

data/db/migrate/01_create_effective_pages.rb.erb

@@ -0,0 +1,52 @@
+class CreateEffectivePages < ActiveRecord::Migration
+  def self.up
+    create_table <%= @pages_table_name %> do |t|
+      t.string :title
+      t.string :meta_description
+
+      t.boolean :draft, :default => false
+
+      t.string :layout, :default => 'application'
+      t.string :template
+
+      t.string :slug
+      t.integer :roles_mask, :default => 0
+
+      t.datetime :updated_at
+      t.datetime :created_at
+    end
+    add_index <%= @pages_table_name %>, :slug, :unique => true
+
+    create_table <%= @menus_table_name %> do |t|
+      t.string      :title
+      t.timestamps
+    end
+
+    create_table <%= @menu_items_table_name %> do |t|
+      t.integer       :menu_id
+
+      t.integer       :menuable_id
+      t.string        :menuable_type
+
+      t.string        :title
+
+      t.string        :url
+      t.string        :special
+
+      t.string        :classes
+      t.boolean       :new_window, :default => false
+      t.integer       :roles_mask, :default => nil
+
+      t.integer       :lft
+      t.integer       :rgt
+    end
+    add_index <%= @menu_items_table_name %>, :lft
+  end
+
+  def self.down
+    drop_table <%= @pages_table_name %>
+    drop_table <%= @menus_table_name %>
+    drop_table <%= @menu_items_table_name %>
+  end
+
+end

data/lib/effective_pages/engine.rb

@@ -0,0 +1,19 @@
+module EffectivePages
+  class Engine < ::Rails::Engine
+    engine_name 'effective_pages'
+
+    # Include Helpers to base application
+    initializer 'effective_pages.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper EffectivePagesHelper
+        helper EffectiveMenusHelper
+      end
+    end
+
+    # Set up our default configuration options.
+    initializer "effective_pages.defaults", :before => :load_config_initializers do |app|
+      # Set up our defaults, as per our initializer template
+      eval File.read("#{config.root}/lib/generators/templates/effective_pages.rb")
+    end
+  end
+end

data/lib/effective_pages/version.rb

@@ -0,0 +1,3 @@
+module EffectivePages
+  VERSION = "0.8.0"
+end

data/lib/effective_pages.rb

@@ -0,0 +1,73 @@
+require "effective_pages/engine"
+require 'migrant'     # Required for rspec to run properly
+
+module EffectivePages
+  mattr_accessor :pages_table_name
+  mattr_accessor :menus_table_name
+  mattr_accessor :menu_items_table_name
+
+  mattr_accessor :pages_path
+  mattr_accessor :excluded_pages
+  mattr_accessor :excluded_layouts
+
+  mattr_accessor :authorization_method
+  mattr_accessor :simple_form_options
+  mattr_accessor :layout
+  mattr_accessor :menu
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
+      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
+    end
+    true
+  end
+
+  def self.pages
+    Rails.env.development? ? read_pages : (@@pages ||= read_pages)
+  end
+
+  def self.layouts
+    Rails.env.development? ? read_layouts : (@@layouts ||= read_layouts)
+  end
+
+  # Remove leading and trailing '/' characters
+  #  Will return:  "effective/pages"
+  def self.pages_path=(filepath)
+    filepath = filepath.to_s
+    filepath = filepath[1..-1] if filepath.starts_with?('/')
+    @@pages_path = filepath.chomp('/')
+  end
+
+  private
+
+  def self.read_pages
+    files = ApplicationController.view_paths.map { |path| Dir["#{path}/#{pages_path}/**"] }.flatten.reverse
+
+    HashWithIndifferentAccess.new().tap do |pages|
+      files.each do |file|
+        name = File.basename(file).split('.').first
+        next if name.starts_with?('_') || Array(EffectivePages.excluded_pages).map(&:to_s).include?(name)
+
+        pages[name.to_sym] = {}
+      end
+    end
+  end
+
+  def self.read_layouts
+    files = ApplicationController.view_paths.map { |path| Dir["#{path}/layouts/**"] }.flatten.reverse
+
+    HashWithIndifferentAccess.new().tap do |layouts|
+      files.each do |file|
+        name = File.basename(file).split('.').first
+        next if name.starts_with?('_') || Array(EffectivePages.excluded_layouts).map(&:to_s).include?(name)
+
+        layouts[name.to_sym] = {}
+      end
+    end
+  end
+
+end

data/lib/generators/effective_pages/install_generator.rb

@@ -0,0 +1,43 @@
+module EffectivePages
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Creates an EffectivePages initializer in your application."
+
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def self.next_migration_number(dirname)
+        if not ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def copy_initializer
+        template "effective_pages.rb", "config/initializers/effective_pages.rb"
+      end
+
+      def create_migration_file
+        @pages_table_name = ':' + EffectivePages.pages_table_name.to_s
+        @menus_table_name = ':' + EffectivePages.menus_table_name.to_s
+        @menu_items_table_name = ':' + EffectivePages.menu_items_table_name.to_s
+
+        migration_template '../../../db/migrate/01_create_effective_pages.rb.erb', 'db/migrate/create_effective_pages.rb'
+      end
+
+      def copy_example_page
+        template 'example.html.haml', 'app/views/effective/pages/example.html.haml'
+      end
+
+      def setup_routes
+        inject_into_file "config/routes.rb", "\n  # if you want EffectivePages to render the home / root page\n  # uncomment the following line and create an Effective::Page with slug == 'home' \n  # root :to => 'Effective::Pages#show', :id => 'home'\n", :before => /root (:?)to.*/
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectivePages

data/lib/generators/templates/effective_pages.rb

@@ -0,0 +1,49 @@
+# EffectivePages Rails Engine
+
+EffectivePages.setup do |config|
+  config.pages_table_name = :pages
+  config.menus_table_name = :menus
+  config.menu_items_table_name = :menu_items
+
+  # Relative to app/views/
+  config.pages_path = '/effective/pages/'
+
+  # Excluded Pages
+  config.excluded_pages = []
+
+  # Excluded Layouts
+  config.excluded_layouts = [:admin]
+
+  # Use CanCan: can?(action, resource)
+  # Use effective_roles:  resource.roles_match_with?(current_user)
+  config.authorization_method = Proc.new { |controller, action, resource| true }
+
+  # Layout Settings
+  # Configure the Layout per controller, or all at once
+
+  # config.layout = 'application'   # The layout for the EffectivePages admin screen
+  config.layout = {
+    :admin => 'application'
+  }
+
+  # SimpleForm Options
+  # This Hash of options will be passed into any simple_form_for() calls
+  config.simple_form_options = {}
+
+  # config.simple_form_options = {
+  #   :html => {:class => 'form-horizontal'},
+  #   :wrapper => :horizontal_form,
+  #   :wrapper_mappings => {
+  #     :boolean => :horizontal_boolean,
+  #     :check_boxes => :horizontal_radio_and_checkboxes,
+  #     :radio_buttons => :horizontal_radio_and_checkboxes
+  #   }
+  # }
+
+  # All effective_page menu options
+  config.menu = {
+    :apply_active_class => true,
+    :maxdepth => 2
+  }
+
+end

data/lib/generators/templates/example.html.haml

@@ -0,0 +1,6 @@
+%h1
+  = simple_effective_region page, :title do
+    = page.title
+
+= effective_region page, :content do
+  %p this is default content for the page titled #{page.title}

data/lib/tasks/effective_pages_tasks.rake

@@ -0,0 +1,29 @@
+# bundle exec rake effective_pages:seed
+namespace :effective_pages do
+  task :seed => :environment do
+    include EffectiveMenusHelper
+
+    return true if Effective::Menu.find_by_title('main menu').present?
+
+    Effective::Menu.new(:title => 'main menu').build do
+      dropdown 'About' do
+        item '111'
+        item '222'
+        dropdown 'More...' do
+          item '333'
+          item '444'
+        end
+      end
+
+      dropdown 'Pages' do
+        item 'AAA'
+        divider
+        item 'BBB'
+        item 'CCC'
+        divider
+        item 'DDD'
+      end
+    end.save!
+
+  end
+end

data/spec/controllers/effective/pages_controller_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Effective::PagesController do
+  routes { EffectivePages::Engine.routes }
+
+  let(:page) { FactoryGirl.create(:page) }
+  let(:draft) { FactoryGirl.create(:page, :draft => true) }
+  let(:page_with_invalid_template) { FactoryGirl.create(:page, :template => 'notemplate') }
+  let(:page_with_invalid_layout) { FactoryGirl.create(:page, :layout => 'nolayout') }
+
+  before (:each) do
+  end
+
+  context "#show" do
+    context 'valid requests' do
+      it 'raises RecordNotFound when the page is a draft' do
+        expect {
+          get :show, :id => draft.id
+        }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+
+      it 'renders a draft page when edit=true is passed' do
+        get :show, :id => draft.id, :edit => true
+
+        response.should be_success
+      end
+
+      it 'renders the appropriate page template' do
+        get :show, :id => page.id
+
+        expect(response).to render_template('layouts/application')
+        expect(response).to render_template('effective/pages/example')
+      end
+    end
+
+    context 'invalid requests' do
+      it 'raises RecordNotFound when passed invalid ID' do
+        expect { get :show, :id => 999 }.to raise_error(ActiveRecord::RecordNotFound)
+      end
+
+      it 'raises MissingTemplate when the page has an unknown template' do
+        expect {
+          get :show, :id => page_with_invalid_template.id
+        }.to raise_error(ActionView::MissingTemplate)
+      end
+
+      it 'raises MissingTemplate when the page has an unknown layout' do
+        expect {
+          get :show, :id => page_with_invalid_layout.id
+        }.to raise_error(ActionView::MissingTemplate)
+      end
+    end
+
+    context 'authentication' do
+      it 'prevents the page from being viewed when not authorized' do
+        original_auth_method = EffectivePages.authorization_method
+        EffectivePages.authorization_method = Proc.new { |controller, action, resource| false }
+
+        expect { get :show, :id => page.id }.to raise_error(Effective::AccessDenied)
+
+        EffectivePages.authorization_method = original_auth_method
+      end
+    end
+  end # /show
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.