landable 1.7.0 → 1.7.1.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bab73bf093b17b370337984023eac8234b4d072
-  data.tar.gz: e4587f1dcf343bff05b4bc6280913d5d04e9dfa0
+  metadata.gz: 68d0d159a866cc88742e6b5603bcd0d5edb09b65
+  data.tar.gz: 2f1aa05942baaedab945f6163cebd4e65c5e4599
 SHA512:
-  metadata.gz: 8569f8fd1867cffe6883e116200aa4060723abd163ff3e29711738c089ba88267e97d5f5ba0ce5305299fc922b5cc0a72db3a9b06ffa46b0c972f352db8ca921
-  data.tar.gz: 4aad2b150a7b185ef673b2ea0f37daa115e57ab944b97cc307fbe92b650fc9c796f40722ba545146e2063c0eb150b563d3058af0d2448903954ad8ab0fb50633
+  metadata.gz: d9faf6bc62457e8a574dc47ca2eb6a2b95593bb2bcc72db13bc1d3f54ba327bb241fff269d658a27ac8d72e8412b4e36804b01fc1485d5ed1b3afce450d8e09b
+  data.tar.gz: ba14a46c7b46ae299eeb77d6b65568747ec989c3553816a0e947d70d9de1f7eb4f9d381eb60edad56edeca5cc45ce579a7b9cfb3f18ec8b4d1cc35815b705606

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3-p448
+  - 2.0.0-p247
+  - 2.1.2
+before_script:
+  - psql -c "CREATE USER dummy WITH superuser" -U postgres
+  - psql -c "CREATE DATABASE dummy_test;" -U postgres
+script:
+  - script/redb
+  - bundle exec rspec spec
+  - bundle exec cucumber features

data/CHANGELOG.md

@@ -2,4 +2,7 @@
 
 See README.md before updating this file.
 
-## Unreleased [#]
+## Unreleased [#](https://github.com/enova/landable/compare/v1.7.1.rc1...master)
+
+## 1.7.1.rc1 [#](https://github.com/enova/landable/compare/v1.7.0...v1.7.1.rc1)
+* Allow for revisions for Templates [#3]

data/Gemfile

@@ -1,6 +1,9 @@
-source "http://gems.enova.com"
 source "https://rubygems.org"
 
+group :test do
+  gem "cucumber-rails", require: false
+end
+
 # Declare your gem's dependencies in landable.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
 # development dependencies will be added by default to the :development group.

data/README.md

@@ -1,5 +1,8 @@
 # Landable
 
+[![Gem Version](https://badge.fury.io/rb/landable.svg)](http://rubygems.org/gems/landable)
+[![Build Status](https://travis-ci.org/enova/landable.svg?branch=master)](https://travis-ci.org/enova/landable)
+
 Landable is an API for building your CMS. It's implemented as a [Rails Engine](http://guides.rubyonrails.org/engines.html). We like to use Landable with [Publicist](https://github.com/enova/publicist), a great UI for managing content.
 
 
@@ -40,7 +43,7 @@ end
 
 ## Development
 
-Run `./bin/redb` to refresh the dummy app's database.
+Run `./script/redb` to refresh the dummy app's database.
 
 Run the test suite with `rake landable`.
 

data/app/controllers/landable/api/template_revisions_controller.rb

@@ -0,0 +1,27 @@
+require_dependency "landable/api_controller"
+
+module Landable
+  module Api
+    class TemplateRevisionsController < ApiController
+
+      def index
+        template = Template.find(params[:template_id])
+        respond_with template.revisions.order(:ordinal).reverse
+      end
+
+      def show
+        revision = TemplateRevision.find(params[:id])
+
+        respond_to do |format|
+          format.json { respond_with revision }
+        end
+      end
+
+      def revert_to
+        revision = TemplateRevision.find(params[:id])
+        revision.template.revert_to! revision
+        respond_with revision
+      end
+    end
+  end
+end

data/app/controllers/landable/api/templates_controller.rb

@@ -23,10 +23,16 @@ module Landable
         respond_with template
       end
 
+      def publish
+        template = Template.find params[:id]
+        template.publish! author_id: current_author.id, notes: params[:notes], is_minor: !!params[:is_minor]
+        respond_with template
+      end
+
       private
 
       def template_params
-        params.require(:template).permit(:id, :name, :body, :description, :thumbnail_url, :slug, :is_layout)
+        params.require(:template).permit(:id, :name, :body, :description, :thumbnail_url, :slug, :is_layout, :is_publishable)
       end
     end
   end

data/app/models/landable/template.rb

@@ -6,6 +6,14 @@ module Landable
     validates_uniqueness_of :name, case_sensitive: false
     validates_uniqueness_of :slug, case_sensitive: false
 
+
+    belongs_to :published_revision,   class_name: 'Landable::TemplateRevision'
+    has_many   :revisions,            class_name: 'Landable::TemplateRevision'
+
+    before_save -> template {
+      template.is_publishable = true unless template.published_revision_id_changed?
+    }
+
     def name= val
       self[:name] = val
       self[:slug] ||= (val && val.underscore.gsub(/[^\w_]/, '_').gsub(/_{2,}/, '_'))
@@ -15,6 +23,23 @@ module Landable
       file.present?
     end
 
+    def publish!(options)
+      transaction do
+        published_revision.unpublish! if published_revision
+        revision = revisions.create! options
+        update_attributes!(published_revision: revision, is_publishable: false)
+      end
+    end
+
+    def revert_to!(revision)
+      self.name          = revision.name
+      self.body          = revision.body
+      self.description   = revision.description
+      self.slug          = revision.slug
+
+      save!
+    end
+
     class << self
       def create_from_partials!
         Partial.all.map(&:to_template)

data/app/models/landable/template_revision.rb

@@ -0,0 +1,40 @@
+module Landable
+  class TemplateRevision < ActiveRecord::Base
+    include Landable::TableName
+
+    @@ignored_template_attributes = [
+      'editable',
+      'created_at',
+      'updated_at',
+      'published_revision_id',
+      'file',
+      'thumbnail_url',
+      'is_layout',
+      'is_publishable',
+    ]
+
+    cattr_accessor :ignored_template_attributes
+
+    belongs_to :template, inverse_of: :revisions
+    belongs_to :author
+
+    def template_id=(id)
+      # set the value
+      self[:template_id] = id
+
+      # copy attributes from the template
+      self.name          = template.name
+      self.body          = template.body
+      self.description   = template.description
+      self.slug          = template.slug
+    end
+
+    def publish!
+      update_attribute :is_published, true
+    end
+
+    def unpublish!
+      update_attribute :is_published, false
+    end
+  end
+end

data/app/serializers/landable/template_revision_serializer.rb

@@ -0,0 +1,12 @@
+require_dependency 'landable/author_serializer'
+
+module Landable
+  class TemplateRevisionSerializer < ActiveModel::Serializer
+    attributes :id, :ordinal, :notes, :is_minor, :is_published
+    attributes :created_at, :updated_at
+
+    embed :ids
+    has_one :template
+    has_one :author, include: true, serializer: AuthorSerializer
+  end
+end

data/app/serializers/landable/template_serializer.rb

@@ -1,5 +1,10 @@
 module Landable
   class TemplateSerializer < ActiveModel::Serializer
-    attributes :id, :name, :body, :description, :thumbnail_url, :slug, :is_layout, :editable, :file
+    attributes :id, :name, :body, :description
+    attributes :thumbnail_url, :slug, :is_layout, :editable
+    attributes :file, :is_publishable
+
+    embed    :ids
+    has_one  :published_revision
   end
 end

data/config/routes.rb

@@ -22,7 +22,13 @@ Landable::Engine.routes.draw do
       post 'preview', on: :collection
     end
 
-    resources :templates, only: [:index, :show, :create, :update]
+    resources :templates, only: [:index, :show, :create, :update] do
+      post 'publish', on: :member
+    end
+
+    resources :template_revisions, only: [:index, :show] do
+      post 'revert_to', on: :member
+    end
 
     resources :pages, concerns: [:has_assets, :has_screenshots] do
       post 'preview', on: :collection

data/db/migrate/20140509190128_create_template_revisions.rb

@@ -0,0 +1,77 @@
+class CreateTemplateRevisions < ActiveRecord::Migration
+  def change
+    create_table "#{Landable.configuration.database_schema_prefix}landable.template_revisions", id: :uuid, primary_key: :template_revision_id do |t|
+      t.integer   :ordinal
+      t.text      :notes
+      t.boolean   :is_minor,      default: false
+      t.boolean   :is_published,  default: true
+
+      t.uuid      :template_id,   null: false
+      t.uuid      :author_id,     null: false
+
+      t.text      :name
+      t.text      :slug
+      t.text      :body
+      t.text      :description
+
+      t.timestamps
+    end
+
+    add_column "#{Landable.configuration.database_schema_prefix}landable.templates", :published_revision_id, :uuid
+    add_column "#{Landable.configuration.database_schema_prefix}landable.templates", :is_publishable, :boolean, null: :false, default: true
+
+    # Create foreign keys
+    execute <<-SQL
+      ALTER TABLE #{Landable::Template.table_name}
+        ADD CONSTRAINT template_revision_id_fk
+        FOREIGN KEY (published_revision_id)
+        REFERENCES #{Landable::TemplateRevision.table_name} (template_revision_id);
+
+      ALTER TABLE #{Landable::TemplateRevision.table_name}
+        ADD CONSTRAINT template_id_fk
+        FOREIGN KEY (template_id)
+        REFERENCES #{Landable::Template.table_name} (template_id);
+
+      ALTER TABLE #{Landable::TemplateRevision.table_name}
+        ADD CONSTRAINT author_id_fk
+        FOREIGN KEY (author_id)
+        REFERENCES #{Landable::Author.table_name} (author_id);
+    SQL
+
+    # Revision-tracking trigger to automatically update ordinal
+    execute "CREATE FUNCTION #{Landable.configuration.database_schema_prefix}landable.template_revision_ordinal()
+      RETURNS TRIGGER
+      AS
+      $TRIGGER$
+        BEGIN
+
+        IF NEW.ordinal IS NOT NULL THEN
+          RAISE EXCEPTION $$Must not supply ordinal value manually.$$;
+        END IF;
+
+        NEW.ordinal = (SELECT COALESCE(MAX(ordinal)+1,1)
+                        FROM #{Landable.configuration.database_schema_prefix}landable.template_revisions
+                        WHERE template_id = NEW.template_id);
+
+        RETURN NEW;
+
+        END
+       $TRIGGER$
+       LANGUAGE plpgsql;"
+
+      execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_template_revisions__bfr_insert
+              BEFORE INSERT ON #{Landable.configuration.database_schema_prefix}landable.template_revisions
+              FOR EACH ROW EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.template_revision_ordinal();"
+
+    # Trigger disallowing deletes on template_revisions
+    execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_template_revisions__no_delete
+            BEFORE DELETE ON #{Landable.configuration.database_schema_prefix}landable.template_revisions
+            FOR EACH STATEMENT EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.tg_disallow();"
+
+    execute "CREATE TRIGGER #{Landable.configuration.database_schema_prefix}landable_template_revisions__no_update
+            BEFORE UPDATE OF notes, is_minor, template_id, author_id, created_at, ordinal ON #{Landable.configuration.database_schema_prefix}landable.template_revisions
+            FOR EACH STATEMENT EXECUTE PROCEDURE #{Landable.configuration.database_schema_prefix}landable.tg_disallow();"
+
+
+  end
+end

data/doc/schema/template.json

@@ -0,0 +1,62 @@
+{
+  "title": "Template",
+  "description": "A template served by landable",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["name", "slug", "description", "is_layout", "body"],
+
+  "properties": {
+    "id": {
+      "$ref": "uuid.json"
+    },
+
+    "name": {
+      "type": ["string"]
+    },
+
+    "slug": {
+      "type": ["string"]
+    },
+
+    "file": {
+      "type": ["string", "null"]
+    },
+
+    "title": {
+      "type": ["string"]
+    },
+
+    "body": {
+      "type": ["string"]
+    },
+
+    "description": {
+      "type": ["string"]
+    },
+
+    "is_layout": {
+      "type": "boolean"
+    },
+
+    "editable": {
+      "type": "boolean"
+    },
+
+    "thumbnail_url": {
+      "type": ["string", "null"]
+    },
+
+    "is_publishable": {
+      "type": "boolean"
+    },
+
+    "published_revision_id": {
+      "type": ["null", {"$ref": "uuid.json"}]
+    },
+
+    "updated_by_author_id": {
+      "type": ["null", {"$ref": "uuid.json"}]
+    }
+
+  }
+}

data/doc/schema/template_revision.json

@@ -0,0 +1,48 @@
+{
+  "title": "Template Revision",
+  "description": "A particular snapshot of a template which has, at some point, been published.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "template_id", "author_id", "notes", "is_published", "is_minor", "ordinal", "created_at", "updated_at"],
+
+  "properties": {
+    "id": {
+      "$ref": "uuid.json"
+    },
+
+    "template_id": {
+      "$ref": "uuid.json"
+    },
+
+    "author_id": {
+      "type": "string"
+    },
+
+    "notes": {
+      "type": ["string", "null"]
+    },
+
+    "is_published": {
+      "type": "boolean"
+    },
+
+    "is_minor": {
+      "type": "boolean"
+    },
+
+    "ordinal": {
+      "type": "integer",
+      "minimum": 1
+    },
+
+    "created_at": {
+      "type": "string",
+      "format": "date-time"
+    },
+
+    "updated_at": {
+      "type": "string",
+      "format": "date-time"
+    }
+  }
+}

data/features/api/access_tokens.feature

@@ -20,7 +20,7 @@ Feature: Access Tokens API
     And  the response body should be empty
 
   Scenario: Creating an author if none yet exists
-    Given there are no authors in the database
+    Given an author "someone" does not exist
     When I POST to "/api/access_tokens" with:
       """
       { "access_token": { "username": "someone", "password": "anything" } }
@@ -34,7 +34,7 @@ Feature: Access Tokens API
       """
       { "access_token": { "username": "someone", "password": "anything" } }
       """
-    Then there should be 1 author in the database
+    Then there should be 2 author in the database
     And  the author "someone" should have 1 access token
 
   Scenario: Retrieving my own fresh token