exstatic 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.log
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage/*
+/bin/

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.3-p374@exstatic --create

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in static_charge.gemspec
+gemspec
+
+group :development, :test do
+  gem "sqlite3"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Josh Schramm
+
+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/README.md

@@ -0,0 +1,36 @@
+# Exstatic
+
+Exstatic is an embedded content management system for Ruby on
+Rails. It integrates with a Rails 3.1+ web application to allow managed
+content creation for "static" pages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'exstatic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install exstatic
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Gem Todos
+
+TODO: Create a test runner rake task that resets test db in dummy app
+TODO: Figure out how to support Mongoid 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+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    = 'Exstatic'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/rails_app/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks

data/app/controllers/exstatic/pages_controller.rb

@@ -0,0 +1,37 @@
+class Exstatic::PagesController < ApplicationController
+  before_filter Exstatic.authorization_method, :only => Exstatic.authorization_actions
+
+  def index
+    @pages = Exstatic::Page.all
+  end
+
+  def show
+    @page = Exstatic::Page.find(params[:id])
+  end
+
+  def new
+    @page = Exstatic::Page.new
+  end
+
+  def display
+    @page = Exstatic::Page.where(:slug => stripped_path).first!
+  end
+
+  def create
+    @page = Exstatic::Page.new(params[:page])
+    if @page.save
+      redirect_to @page
+    else
+      render :new
+    end
+  end
+
+  private
+  def authorize_exstatic_pages
+    super if defined?(super)
+  end
+
+  def stripped_path
+    request.fullpath.gsub(/^\//, "")
+  end
+end

data/app/models/exstatic/page.rb

@@ -0,0 +1,9 @@
+include Exstatic::Validators
+
+module Exstatic
+  class Page < ActiveRecord::Base
+    validates :slug, :nonexistant_path => true, :uniqueness => true
+
+    attr_accessible :title, :content, :slug
+  end
+end

data/app/views/exstatic/pages/display.html.erb

@@ -0,0 +1 @@
+<p><%= @page.content %></p>

data/app/views/exstatic/pages/index.html.erb

@@ -0,0 +1,8 @@
+<h1> This will be a listing of pages</h1>
+<ul>
+  <% @pages.each do |p| %>
+    <li><%= link_to p.title, p %>
+  <% end %>
+</ul>
+
+<%= link_to "New Page", new_page_path %>

data/app/views/exstatic/pages/new.html.erb

@@ -0,0 +1,33 @@
+<div id="errors_container" class="<%= @page.errors.count > 0 ? "" : "hidden" %> <%= @page.class.name.downcase %>_errors">
+  <h2>
+    <% if defined? heading %>
+      <%= t(heading) %>
+    <% else %>
+      <%= t(:save_error) %>
+    <% end %>
+  </h2>
+  <ul id="errors">
+  <% @page.errors.full_messages.each do |msg| %>
+    <li><%= msg %></li>
+  <% end %>
+  </ul>
+</div>
+
+<h1>Create a Page</h1>
+<%= form_for @page do |f| %>
+  <div>
+    <%= f.label :title %>
+    <%= f.text_field :title %>
+  </div>
+  <div>
+    <%= f.label :slug %>
+    <%= f.text_field :slug %>
+  </div>
+  <div>
+    <%= f.label :content %>
+    <%= f.text_field :content %>
+  </div>
+  <div>
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/exstatic/pages/show.html.erb

@@ -0,0 +1,6 @@
+<h1><%= @page.title %></h1>
+<p><%= @page.content %></p>
+
+<strong>Slug: </strong><%= @page.slug %><br>
+
+<%= link_to "Back to list", pages_path %>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Exstatic::Engine.routes.draw do
+  resources :pages, :controller => "pages", :path => "/pages"
+  root :to => "exstatic/pages#index"
+end

data/exstatic.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'exstatic/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "exstatic"
+  gem.version       = Exstatic::VERSION
+  gem.authors       = ["Josh Schramm"]
+  gem.email         = ["josh.schramm@gmail.com"]
+  gem.description   = %q{Allows managed content pages in a Ruby on Rails 3.1+ application.}
+  gem.summary       = %q{Allows managed content pages in a Ruby on Rails 3.1+ application.}
+  gem.homepage      = "http://github.com/JoshReedSchramm/exstatic"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rails", "~> 3.2.11"
+
+  gem.add_development_dependency("rspec", "~> 2.12.0")
+  gem.add_development_dependency("rspec-rails", "~> 2.12.0")
+  gem.add_development_dependency "tzinfo"
+end

data/lib/exstatic/engine.rb

@@ -0,0 +1,23 @@
+module Exstatic
+  class Engine < ::Rails::Engine
+    isolate_namespace Exstatic 
+
+    config.exstatic = Exstatic
+
+    initializer 'exstatic.bind_dynamic_routes', :after => :disable_dependency_loading do |app|
+      begin
+        app.routes.disable_clear_and_finalize = true
+        app.routes.draw do
+          Exstatic::Page.all.each do |p|
+            get "/#{p.slug}", :to => "exstatic/pages#display"
+          end
+        end
+      rescue 
+        Rails.logger.error "Failed to bind custom page routes for Exstatic"
+      ensure
+        app.routes.disable_clear_and_finalize = false
+        app.routes.finalize!
+      end
+    end
+  end
+end

data/lib/exstatic/validators/nonexistant_path_validator.rb

@@ -0,0 +1,20 @@
+module Exstatic
+  module Validators
+    class NonexistantPathValidator < ActiveModel::EachValidator
+      def validate_each(object, attribute, value)
+        return true if value.blank?
+
+        path = '/' + value
+
+        begin
+          route = Rails.application.routes.recognize_path(path, :method => :get)
+
+          if route && !route[:controller].starts_with?("exstatic/")
+            object.errors[attribute] << (options[:message] || "matches an existing path")
+          end
+        rescue ActionController::RoutingError
+        end
+      end
+    end
+  end
+end

data/lib/exstatic/version.rb

@@ -0,0 +1,3 @@
+module Exstatic
+  VERSION = "0.0.1"
+end

data/lib/exstatic.rb

@@ -0,0 +1,11 @@
+require 'exstatic/engine'
+require 'exstatic/validators/nonexistant_path_validator'
+
+module Exstatic
+
+  mattr_accessor :authorization_method
+  @@authorization_method = :authorize_exstatic_pages
+
+  mattr_accessor :authorization_actions
+  @@authorization_actions = [:new, :create, :edit, :update, :destroy, :index, :show]
+end

data/lib/generators/exstatic/install_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/active_record'
+
+module Exstatic
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      desc "Copies migrations and initialization components into your application"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/exstatic_create_exstatic_pages"
+      end
+    end
+  end
+end

data/lib/generators/exstatic/templates/migration.rb

@@ -0,0 +1,11 @@
+class ExstaticCreateExstaticPages < ActiveRecord::Migration
+  def change
+    create_table(:exstatic_pages) do |t|
+      t.string :title
+      t.text :content
+      t.string :slug
+
+      t.timestamps
+    end
+  end
+end

data/spec/controllers/pages_controller_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+describe Exstatic::PagesController do
+  describe "GET index" do
+    it 'can render the listing page' do
+      pages = [mock]
+      Exstatic::Page.stub(:all).and_return(pages)
+      get :index, { :use_route => :exstatic }
+
+      response.should be_success
+      response.should render_template('index')
+      assigns(:pages).should == pages
+    end
+  end
+
+
+  it 'can serve a form to create a new page' do
+    # fake a login
+    get :new, { :use_route => :exstatic }
+
+    response.should render_template('new')
+  end
+
+  describe 'POST create' do
+    context 'and the page is valid' do
+      it 'redirects to the page details' do
+        page = mock_model(Exstatic::Page)
+
+        Exstatic::Page.stub(:new).and_return(page)
+        page.should_receive(:save).and_return(true)
+
+        post :create, {:page => { :title => "foo" }, :use_route => :exstatic }
+
+        response.should redirect_to page_path(page)
+      end
+    end
+
+    context 'and the page is invalid' do
+      it 'rerenders the form' do
+        page = mock(Exstatic::Page)
+
+        Exstatic::Page.stub(:new).and_return(page)
+        page.should_receive(:save).and_return(false)
+
+        post :create, {:page => { :title => "foo" }, :use_route => :exstatic }
+
+        response.should render_template(:new)
+      end
+    end
+  end
+
+  describe "GET show" do
+    it "renders the page" do
+      page = mock_model(Exstatic::Page)
+      Exstatic::Page.stub(:find).and_return(page)
+
+      get :show, {:id => 1, :use_route => :exstatic}
+
+      response.should render_template(:show)
+      assigns(:page).should == page
+    end
+  end
+
+  describe "GET display" do
+    it "renders the page based on the request path" do
+      page = mock_model(Exstatic::Page)
+
+      request.stub(:fullpath).and_return("/the/page/path")
+      Exstatic::Page.stub(:where).with(:slug => "the/page/path").and_return(page)
+      page.stub(:first!).and_return(page)
+
+      get :display, { :use_route => :exstatic }
+
+      response.should be_success
+      response.should render_template(:display)
+
+      assigns(:page).should == page
+    end
+  end
+
+  context "When authorizing the user to make changes to a page" do
+    describe "when the default method is defined in application controller" do
+      before(:each) do
+        class ApplicationController
+          private 
+          def authorize_exstatic_pages
+            render :status => 402 and return
+          end
+        end
+      end
+      it "returns a 402 auth failure" do
+        get :new, { :use_route => :exstatic }
+        response.status.should == 402
+      end
+    end
+
+    describe "when a custom method has been defined" do
+      before(:each) do
+        Exstatic.authorization_method = :custom_page_auth
+        class ApplicationController
+          private 
+          def custom_page_auth
+            render :status => 402 and return
+          end
+        end
+      end
+      it "returns a 402 auth failure" do
+        get :new, { :use_route => :exstatic }
+        response.status.should == 402
+      end
+    end
+
+    describe "when secure methods have been overridden" do
+      before(:each) do
+        class ApplicationController
+          private 
+          def authorize_exstatic_pages
+            render :status => 402 and return
+          end
+        end
+      end
+      it "allows access to the non-filtered method" do
+        get :index, { :use_route => :exstatic }
+        response.status.should == 200
+      end
+
+      it "returns a 402 auth failure for filtered methods" do
+        get :new, { :use_route => :exstatic }
+        response.status.should == 402
+      end
+    end
+  end
+end

data/spec/exstatic_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe "When testing exstatic" do
+  it "includes a dummy rails application" do
+    RailsApp.should be_a(Module)
+    Exstatic.should be_a(Module)
+  end
+end

data/spec/lib/exstatic/engine_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Exstatic::Engine do
+  it "dynamically adds routes from pages at initialization" do
+    Exstatic::Page.create(:slug => "rspec/test", :title => "Rspec Test", :content => "This is an rspec test")
+
+    initializer = Exstatic::Engine.initializers.select { |i| i.name == "exstatic.bind_dynamic_routes" }.first
+    initializer.run(Rails.application)
+
+    route = Rails.application.routes.recognize_path("/rspec/test", :method => :get)
+    route.should_not be_nil
+  end
+
+  it "does preserves existing routes" do
+    initializer = Exstatic::Engine.initializers.select { |i| i.name == "exstatic.bind_dynamic_routes" }.first
+    initializer.run(Rails.application)
+
+    route = Rails.application.routes.recognize_path("/custompage", :method => :get)
+    route.should_not be_nil
+    route[:controller].should == "home"
+  end
+
+  it "does not override pre-existing routes" do
+    p = Exstatic::Page.new(:slug => "custompage", :title => "Rspec Test", :content => "This is an rspec test")
+    p.save(:validate => false)
+
+    verify_saved = Exstatic::Page.where(:slug => "custompage").first!
+    verify_saved.should_not be_nil
+
+    initializer = Exstatic::Engine.initializers.select { |i| i.name == "exstatic.bind_dynamic_routes" }.first
+    initializer.run(Rails.application)
+
+    route = Rails.application.routes.recognize_path("/custompage", :method => :get)
+    route.should_not be_nil
+    route[:controller].should == "home"
+  end
+end

data/spec/lib/validators/nonexistant_path_validator_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Exstatic::Validators::NonexistantPathValidator do
+  context "when a path exists matching the one provided" do
+    it "fails" do
+      page = Exstatic::Page.new(:slug => "custompage")
+
+      validator = Exstatic::Validators::NonexistantPathValidator.new({:attributes => {}})
+      validator.validate_each(page, :slug, page.slug)
+
+      page.errors[:slug].first.should == "matches an existing path"
+    end
+  end
+
+  context "when no path exists matching the one provided" do
+    it "succeeds" do
+      page = Exstatic::Page.new(:slug => "brandnewpage")
+
+      validator = Exstatic::Validators::NonexistantPathValidator.new({:attributes => {}})
+      validator.validate_each(page, :slug, page.slug)
+
+      page.errors[:slug].empty?.should == true
+
+    end
+  end
+
+  context "when a matchinj path is from exstatic" do
+    it "succeeds" do
+      page = Exstatic::Page.new(:slug => "foo/bar")
+
+      validator = Exstatic::Validators::NonexistantPathValidator.new({:attributes => {}})
+      validator.validate_each(page, :slug, page.slug)
+
+      page.errors[:slug].empty?.should == true
+
+    end
+  end
+end

data/spec/models/page_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Exstatic::Page do
+  it "can be saved" do
+    page = Exstatic::Page.new(:title => "This is my page", :slug => "foo", :content => "This is some content")
+    page.save.should be_true
+
+    page2 = Exstatic::Page.where(:slug => "foo").first!
+    page2.should == page
+  end
+
+  it "validates that another routes with the same path does not exist" do
+    page = Exstatic::Page.new(:title => "foo", :content => "bar", :slug => "custompage")
+    page.save.should be_false
+    page.errors[:slug].should_not be_nil
+  end
+
+  it "validates that the slug is unique" do
+    page1 = Exstatic::Page.create(:title => "This is my page", :slug => "foo", :content => "This is some content")
+
+    page2 = Exstatic::Page.new(:title => "This is my second page", :slug => "foo", :content => "This is some content")
+    page2.valid?.should be_false
+    page2.errors[:slug].should_not be_nil
+  end
+end

data/spec/rails_app/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+RailsApp::Application.load_tasks

data/spec/rails_app/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/spec/rails_app/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

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

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

data/spec/rails_app/app/controllers/home_controller.rb

@@ -0,0 +1,5 @@
+class HomeController < ApplicationController
+  def custom_route
+    render
+  end
+end

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

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

data/spec/rails_app/app/views/home/custom_route.html.erb

@@ -0,0 +1 @@
+This is a custom page used for testing validation and saving of a new url slug