ninetails 0.0.1

data/app/models/ninetails/page_revision_section.rb

@@ -0,0 +1,6 @@
+module Ninetails
+  class PageRevisionSection < ActiveRecord::Base
+    belongs_to :page_revision
+    belongs_to :section
+  end
+end

data/app/models/ninetails/section.rb

@@ -0,0 +1,30 @@
+module Ninetails
+  class Section < ActiveRecord::Base
+    self.inheritance_column = nil
+    has_many :page_revision_sections
+    has_many :page_revisions, through: :page_revision_sections
+
+    def to_builder
+      Jbuilder.new do |json|
+        json.call(self, :id, :name, :type, :tags, :elements)
+      end
+    end
+
+    def template
+      @template ||= "SectionTemplate::#{type}".safe_constantize.new
+    end
+
+    def deserialize
+      template.elements_instances = []
+
+      elements.each do |name, element_json|
+        element = template.class.find_element name
+        element.deserialize element_json
+        template.elements_instances << element
+      end
+
+      template
+    end
+
+  end
+end

data/config/initializers/error_classes.rb

@@ -0,0 +1,4 @@
+module Ninetails
+  class SectionConfigurationError < StandardError
+  end
+end

data/config/initializers/json_stuff.rb

@@ -0,0 +1,9 @@
+Jbuilder.key_format camelize: :lower
+
+module StringToApi
+  def to_api
+    camelize :lower
+  end
+end
+
+String.send :prepend, StringToApi

data/config/routes.rb

@@ -0,0 +1,9 @@
+Ninetails::Engine.routes.draw do
+  root 'pages#index'
+
+  resources :pages, only: :show do
+    resources :page_revisions, only: [:create, :show, :index], path: "revisions"
+  end
+
+  resources :section_templates, only: [:show, :index]
+end

data/db/migrate/20151006093040_create_pages.rb

@@ -0,0 +1,10 @@
+class CreatePages < ActiveRecord::Migration
+  def change
+    create_table :ninetails_pages do |t|
+      t.references :current_revision, index: true
+      t.string :name
+      t.string :url
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151006093559_create_page_revisions.rb

@@ -0,0 +1,8 @@
+class CreatePageRevisions < ActiveRecord::Migration
+  def change
+    create_table :ninetails_page_revisions do |t|
+      t.belongs_to :page
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151006093754_create_sections.rb

@@ -0,0 +1,11 @@
+class CreateSections < ActiveRecord::Migration
+  def change
+    create_table :ninetails_sections do |t|
+      t.string :name
+      t.string :type
+      t.json :elements
+      t.json :tags
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20151006094337_create_page_revision_sections.rb

@@ -0,0 +1,8 @@
+class CreatePageRevisionSections < ActiveRecord::Migration
+  def change
+    create_table :ninetails_page_revision_sections do |t|
+      t.belongs_to :page_revision, index: true
+      t.belongs_to :section, index: true
+    end
+  end
+end

data/db/migrate/20151111085201_add_message_to_page_revisions.rb

@@ -0,0 +1,5 @@
+class AddMessageToPageRevisions < ActiveRecord::Migration
+  def change
+    add_column :ninetails_page_revisions, :message, :string
+  end
+end

data/db/schema.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20151111085201) do
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  create_table "ninetails_page_revision_sections", force: :cascade do |t|
+    t.integer "page_revision_id"
+    t.integer "section_id"
+  end
+
+  add_index "ninetails_page_revision_sections", ["page_revision_id"], name: "index_ninetails_page_revision_sections_on_page_revision_id", using: :btree
+  add_index "ninetails_page_revision_sections", ["section_id"], name: "index_ninetails_page_revision_sections_on_section_id", using: :btree
+
+  create_table "ninetails_page_revisions", force: :cascade do |t|
+    t.integer  "page_id"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.string   "message"
+  end
+
+  create_table "ninetails_pages", force: :cascade do |t|
+    t.integer  "current_revision_id"
+    t.string   "name"
+    t.string   "url"
+    t.datetime "created_at",          null: false
+    t.datetime "updated_at",          null: false
+  end
+
+  add_index "ninetails_pages", ["current_revision_id"], name: "index_ninetails_pages_on_current_revision_id", using: :btree
+
+  create_table "ninetails_sections", force: :cascade do |t|
+    t.string   "name"
+    t.string   "type"
+    t.json     "elements"
+    t.json     "tags"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end

data/lib/ninetails.rb

@@ -0,0 +1,4 @@
+require "ninetails/engine"
+
+module Ninetails
+end

data/lib/ninetails/engine.rb

@@ -0,0 +1,37 @@
+require "rails"
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+
+require "rails-api"
+require "pg"
+require "jbuilder"
+require "hash-pipe"
+require "virtus"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module Ninetails
+  class Engine < ::Rails::Engine
+    isolate_namespace Ninetails
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+  end
+end

data/lib/ninetails/version.rb

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

data/lib/tasks/ninetails_tasks.rake

@@ -0,0 +1,8 @@
+namespace :ninetails_generate do
+
+  desc "Generate a blank section as a hash"
+  task :section, [:type] => :environment do |task, args|
+    puts "SectionTemplate::#{args[:type]}".safe_constantize.new.serialize
+  end
+
+end

data/spec/components/element_definition_spec.rb

@@ -0,0 +1,104 @@
+require 'rails_helper'
+
+class CustomProperty < Ninetails::Property
+  property :text, String
+  validates :text, presence: true
+end
+
+class BasicElement < Ninetails::Element
+  property :foo, String
+  property :bar, String
+end
+
+describe Ninetails::ElementDefinition do
+
+  let(:text_element) { Ninetails::ElementDefinition.new(:foo, Element::Text, :single) }
+
+  it "should store the name of the element" do
+    expect(text_element.name).to eq :foo
+  end
+
+  it "should store the type of the element" do
+    expect(text_element.type).to eq Element::Text
+  end
+
+  it "should store the count of the element" do
+    expect(text_element.count).to eq :single
+  end
+
+  describe "adding type structure with singles" do
+    let(:hash) { Hash.new }
+
+    before do
+      text_element.add_to_hash hash
+    end
+
+    it "should add the type's structure to a hash" do
+      expect(hash[:foo]).to eq text_element.properties_structure
+    end
+  end
+
+  describe "adding type structure with multiples" do
+    let(:hash) { Hash.new }
+
+    before do
+      text_element.count = :multiple
+      text_element.add_to_hash hash
+    end
+
+    it "should add the type's structure to a hash as the single item of an array" do
+      expect(hash[:foo]).to eq [text_element.properties_structure]
+    end
+  end
+
+  describe "deserialization" do
+    describe "single elements" do
+
+      let(:definition) { Ninetails::ElementDefinition.new(:foo, Element::Text, :single) }
+      let(:hash) { {"type"=>"Text", "content"=>{"text"=>"Hello world!"}} }
+
+      it "should add one element to the elements array" do
+        expect {
+          definition.deserialize hash
+        }.to change { definition.elements.size }.from(0).to(1)
+      end
+
+      it "should pass the hash into the element to be deserialized" do
+        element_instance = Element::Text.new
+        allow(Element::Text).to receive(:new) { element_instance }
+        expect(element_instance).to receive(:deserialize).with(hash)
+
+        definition.deserialize hash
+      end
+    end
+
+    describe "multiple elements" do
+
+      let(:definition) { Ninetails::ElementDefinition.new(:foo, Element::ButtonIcon, :multiple) }
+      let(:hash) do
+        [
+          {"type"=>"ButtonIcon", "link"=>{"url"=>"/foo", "title"=>"Bar", "text"=>"hello"}, "icon"=>{"name"=>"person"}},
+          {"type"=>"ButtonIcon", "link"=>{"url"=>"/bar", "title"=>"Baz", "text"=>"box"}, "icon"=>{"name"=>"tree"}}
+        ]
+      end
+
+      it "should duplicate property types in properties_instances to be the correct number of passed in items" do
+        expect {
+          definition.deserialize hash
+        }.to change { definition.elements.size }.from(0).to(2)
+      end
+
+      it "should set the correct property on each instance" do
+        first_element_instance = Element::ButtonIcon.new
+        second_element_instance = Element::ButtonIcon.new
+        allow(Element::ButtonIcon).to receive(:new).and_return(first_element_instance, second_element_instance)
+        expect(first_element_instance).to receive(:deserialize).with(hash[0])
+        expect(second_element_instance).to receive(:deserialize).with(hash[1])
+
+        definition.deserialize hash
+      end
+
+    end
+  end
+
+end

data/spec/components/element_spec.rb

@@ -0,0 +1,92 @@
+require 'rails_helper'
+
+class CustomProperty < Ninetails::Property
+  property :text, String
+  validates :text, presence: true
+end
+
+class ExampleElement < Ninetails::Element
+  property :foo, String
+  property :bar, String
+end
+
+class ExampleElement2 < Ninetails::Element
+  property :foo, CustomProperty
+  property :bar, CustomProperty
+end
+
+class ElementForValidating < Ninetails::Element
+  property :something, CustomProperty
+end
+
+RSpec.describe Ninetails::Element do
+
+  describe "properties" do
+    it "should store properties as an array of Property instances" do
+      expect(ExampleElement.properties).to be_a(Array)
+      expect(ExampleElement.properties.first).to be_a(Ninetails::PropertyType)
+    end
+
+    it "should store the property names" do
+      expect(ExampleElement.properties[0].name).to eq(:foo)
+      expect(ExampleElement.properties[1].name).to eq(:bar)
+    end
+  end
+
+  describe "generating a reference" do
+    it "should use a SecureRandom uuid" do
+      allow(SecureRandom).to receive(:uuid) { "ABC" }
+      expect(ExampleElement.new.reference).to eq "ABC"
+    end
+
+    it "should be unique for each instance of the Element" do
+      expect(ExampleElement.new.reference).not_to eq ExampleElement.new.reference
+    end
+  end
+
+  describe "serialization" do
+    let(:element) { ExampleElement.new }
+    let(:structure) { element.properties_structure }
+
+    it "should be a hash" do
+      expect(structure).to be_a(Hash)
+    end
+
+    it "should contain a unique element id" do
+      expect(structure[:reference]).to eq element.reference
+    end
+
+    it "should have a :type key which is the class name" do
+      expect(structure[:type]).to eq "ExampleElement"
+    end
+
+    it "should have a key for each property with a blank string as the value" do
+      expect(structure[:foo]).to eq ""
+      expect(structure[:bar]).to eq ""
+    end
+  end
+
+  describe "deserialization" do
+    let(:element) { ExampleElement2.new }
+    let(:hash) do
+      {"type"=>"ExampleElement2", "reference"=>"6ebf107b-c8e5-48f3-bd65-c6d3f8beba90", "foo"=>{"text"=>"hello"}, "bar"=>{"text"=>"world"}}
+    end
+
+    it "should set the serialized_values on each property" do
+      expect(element.send(:properties_instances).first).to receive(:serialized_values=).with("text"=>"hello")
+      expect(element.send(:properties_instances).last).to receive(:serialized_values=).with("text"=>"world")
+      element.deserialize hash
+    end
+  end
+
+  describe "validating properties" do
+    let(:invalid_element) { ElementForValidating.new }
+    let(:valid_element) { ExampleElement.new }
+
+    it "should check if each property is valid" do
+      expect(invalid_element.valid?).to eq false
+      expect(valid_element.valid?).to eq true
+    end
+  end
+
+end

data/spec/components/property_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+class SecondProperty < Ninetails::Property
+  property :finally, String
+end
+
+class FirstProperty < Ninetails::Property
+  property :first, String
+  property :second, SecondProperty
+end
+
+RSpec.describe Ninetails::Property do
+
+  describe "storing properties" do
+    it "should store properties" do
+      expect(FirstProperty.properties.collect(&:name)).to include(:first)
+      expect(FirstProperty.properties.collect(&:name)).to include(:second)
+    end
+
+    it "should store properties with types" do
+      prop = FirstProperty.properties.find{|p| p.name == :first}
+      expect(prop.type).to eq String
+    end
+
+    it "should represent single-level structure correctly" do
+      expect(SecondProperty.serialize).to eq({ finally: "" })
+    end
+
+    it "should represent nested properties with nested structure" do
+      expect(FirstProperty.serialize).to eq({ first: "", second: { finally: "" }})
+    end
+  end
+
+end