nocms-pages 0.0.1

data/README.md

@@ -0,0 +1,4 @@
+nocms-pages
+===========
+
+Gem with content page functionality independent from any CMS embeddable in any Rails 4 app

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pages'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/stylesheets/pages/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/app/controllers/no_cms/pages/application_controller.rb

@@ -0,0 +1,6 @@
+module NoCms
+  module Pages
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/controllers/no_cms/pages/pages_controller.rb

@@ -0,0 +1,12 @@
+require_dependency "no_cms/pages/application_controller"
+
+module NoCms::Pages
+  class PagesController < ApplicationController
+    def show
+      @page = Page.no_drafts.where(path: "/#{params[:path]}").first
+      raise ActionController::RoutingError.new('Not Found') if @page.nil?
+
+      render @page.template unless @page.template.blank?
+    end
+  end
+end

data/app/helpers/no_cms/pages/application_helper.rb

@@ -0,0 +1,6 @@
+module NoCms
+  module Pages
+    module ApplicationHelper
+    end
+  end
+end

data/app/models/no_cms/pages/block.rb

@@ -0,0 +1,146 @@
+module NoCms::Pages
+  class Block < ActiveRecord::Base
+
+    include Concerns::TranslationScopes
+
+    scope :drafts, ->() { where_with_locale(draft: true) }
+    scope :no_drafts, ->() { where_with_locale(draft: false) }
+
+    belongs_to :page
+
+    attr_reader :cached_objects
+
+    translates :layout, :fields_info, :draft
+
+    class Translation
+      serialize :fields_info, Hash
+    end
+
+    after_initialize :set_blank_fields
+    after_create :set_default_position
+    before_save :save_related_objects
+
+    validates :fields_info, presence: { allow_blank: true }
+    validates :page, :layout, presence: true
+
+    def layout_config
+      NoCms::Pages.block_layouts.stringify_keys[layout]
+    end
+
+    def template
+      layout_config[:template] if layout_config
+    end
+
+    def has_field? field
+      # We have the field if...
+      !layout_config.nil? && # We have a layout configuration AND
+        (
+          !layout_config[:fields].symbolize_keys[field.to_sym].nil? || # We have this field OR
+          !layout_config[:fields].symbolize_keys[field.to_s.gsub(/\_id$/, '').to_sym].nil? # we remove the final _id and then we have the field
+        )
+    end
+
+    def field_type field
+      return nil unless has_field?(field)
+      layout_config[:fields].symbolize_keys[field.to_sym]
+    end
+
+    def read_field field
+      return nil unless has_field?(field)
+
+      value = fields_info[field.to_sym] || # first, we get the value
+                @cached_objects[field.to_sym] # or we get it from the cached objects
+
+      # If value is still nil, but the field exists we must get the object from the database
+      if value.nil?
+        field_id = fields_info["#{field}_id".to_sym]
+        value = @cached_objects[field.to_sym] = field_type(field).find(field_id) unless field_id.nil?
+      end
+
+      value
+    end
+
+    def write_field field, value
+      return nil unless has_field?(field)
+      field_type = field_type field
+      # If field type is a model then we update the cached object
+      if field_type.is_a?(Class) && field_type < ActiveRecord::Base
+        # First, we initialize the object if we don't read the object (it loads it into the cached objects)
+        @cached_objects[field.to_sym] = field_type.new if read_field(field).nil?
+        # Then, assign attributes
+        @cached_objects[field.to_sym].assign_attributes value
+      else # If it's a model then  a new object or update the previous one
+        self.fields_info = fields_info.merge field.to_sym => value # when updating through an object (i.e. the page updates through nested attributes) fields_info[field.to_sym] = value doesn't work. Kudos to Rubo for this fix
+      end
+    end
+
+    # In this missing method we check wether we're asking for one field
+    # in which case we will read or write ir
+    def method_missing(m, *args, &block)
+      # We get the name of the field stripping out the '=' for writers
+      field = m.to_s
+      write_accessor = field.ends_with? '='
+      field.gsub!(/\=$/, '')
+
+      # If this field actually exists, then we write it or read it.
+      if has_field?(field)
+        write_accessor ?
+          write_field(field, args.first) :
+          read_field(field.to_sym)
+      else
+        super
+      end
+    end
+
+    # When we are assigning attributes (this method is called in new, create...)
+    # we must split those fields from our current layout and those who are not
+    # (they must be attributes).
+    # Attributes are processed the usual way and fields are written later
+    def assign_attributes new_attributes
+      fields = []
+
+      set_blank_fields
+
+      # We get the layout
+      new_layout = new_attributes[:layout] || new_attributes['layout']
+      self.layout = new_layout unless new_layout.nil?
+
+      # And now separate fields and attributes
+      fields = new_attributes.select{|k, _| has_field? k }.symbolize_keys
+      new_attributes.reject!{|k, _| has_field? k }
+
+      super(new_attributes)
+
+      Rails.logger.info "Writing #{fields.inspect} to #{self.layout} block"
+
+      fields.each do |field_name, value|
+        self.write_field field_name, value
+      end
+    end
+
+    def reload
+      @cached_objects = {}
+      super
+    end
+
+    private
+
+    def set_blank_fields
+      self.fields_info ||= {}
+      @cached_objects ||= {}
+    end
+
+    def set_default_position
+      self.update_attribute :position, ((page.blocks.pluck(:position).compact.max || 0) + 1) if self.position.blank?
+    end
+
+    def save_related_objects
+      cached_objects.each do |field, object|
+        if object.is_a?(ActiveRecord::Base) && object.changed?
+          object.save!
+          fields_info["#{field}_id".to_sym] = object.id
+        end
+      end
+    end
+  end
+end

data/app/models/no_cms/pages/concerns/translation_scopes.rb

@@ -0,0 +1,16 @@
+module NoCms
+  module Pages
+    module Concerns
+      module TranslationScopes
+        extend ActiveSupport::Concern
+
+        included do
+          scope :where_with_locale, ->(where_params, locale = ::I18n.locale) {
+            with_translations(locale).where(self::Translation.table_name => where_params)
+          }
+        end
+
+      end
+    end
+  end
+end

data/app/models/no_cms/pages/page.rb

@@ -0,0 +1,37 @@
+module NoCms::Pages
+  class Page < ActiveRecord::Base
+
+    include Concerns::TranslationScopes
+
+    scope :drafts, ->() { where_with_locale(draft: true) }
+    scope :no_drafts, ->() { where_with_locale(draft: false) }
+
+    acts_as_nested_set
+
+    has_many :blocks, inverse_of: :page, class_name: 'NoCms::Pages::Block'
+    accepts_nested_attributes_for :blocks, allow_destroy: true
+
+    translates :title, :body, :slug, :path, :draft
+
+    validates :title, :body, presence: true
+    validates :slug, presence: { allow_blank: true }
+
+    before_validation :set_slug_and_path
+    after_move :rebuild_path
+
+    def set_slug_and_path
+      self.slug = title.parameterize if slug.nil? && !title.nil?
+      self.rebuild_path if path.nil?
+    end
+
+    def rebuild_path
+      self.update_attribute :path, "#{ancestors.map(&:path).join}/#{slug}"
+    end
+
+    def self.templates
+      Dir[Rails.root.join('app', 'views', 'no_cms', 'pages', 'pages', '*.html.erb').to_s]. # We get all page templates
+        map { |f| File.basename(f, '.html.erb') }.uniq.sort # And get their names
+    end
+
+  end
+end

data/app/views/layouts/nocms/pages/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Pages</title>
+  <%= stylesheet_link_tag    "pages/application", media: "all" %>
+  <%= javascript_include_tag "pages/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/no_cms/pages/blocks/_default.html.erb

@@ -0,0 +1,8 @@
+<div class='block'>
+  <% block.fields_info.each do |field_name, field_content| %>
+    <div class="<%=field_name %>">
+      <h2><%=field_name %></h2>
+      <p><%= field_content %></p>
+    </div>
+  <% end %>
+</div>

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

@@ -0,0 +1,6 @@
+<h1><%= @page.title %></h1>
+<p><%= @page.body %></p>
+
+<% @page.blocks.no_drafts.each do |block| %>
+  <%= render "no_cms/pages/blocks/#{block.template}", block: block %>
+<% end %>

data/config/locales/en.yml

@@ -0,0 +1,18 @@
+en:
+  activerecord:
+    models:
+      no_cms/pages/page: Page
+      no_cms/pages/block: Content Block
+    attributes:
+      no_cms/pages/page:
+        title: Title
+        body: Body
+      no_cms/pages/block:
+        layout: Layout
+        title: Title
+        body: Body
+  no_cms:
+    pages:
+      blocks:
+        layouts:
+          default: Default layout

data/config/routes.rb

@@ -0,0 +1,6 @@
+NoCms::Pages::Engine.routes.draw do
+
+  get '*path', to: 'pages#show', constraints: NoCms::Pages::Routes::PageFoundConstraint
+  root to: 'pages#show', path:''
+
+end

data/db/migrate/20140226123742_create_no_cms_pages.rb

@@ -0,0 +1,14 @@
+class CreateNoCmsPages < ActiveRecord::Migration
+  def change
+    create_table :no_cms_pages_pages do |t|
+      t.timestamps
+    end
+
+    create_table :no_cms_pages_page_translations do |t|
+      t.belongs_to :no_cms_pages_page, index: true
+      t.string :locale
+      t.string :title
+      t.string :body
+    end
+  end
+end

data/db/migrate/20140227100626_create_no_cms_blocks.rb

@@ -0,0 +1,16 @@
+class CreateNoCmsBlocks < ActiveRecord::Migration
+  def change
+    create_table :no_cms_pages_blocks do |t|
+      t.belongs_to :page, index: true
+
+      t.timestamps
+    end
+
+    create_table :no_cms_pages_block_translations do |t|
+      t.belongs_to :no_cms_pages_block, index: true
+      t.string :locale
+      t.string :layout
+    end
+
+  end
+end

data/db/migrate/20140227143723_add_fields_info_to_no_cms_block.rb

@@ -0,0 +1,5 @@
+class AddFieldsInfoToNoCmsBlock < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_block_translations, :fields_info, :longtext, default: Hash.new.to_yaml
+  end
+end

data/db/migrate/20140228112643_add_slug_to_no_cms_page.rb

@@ -0,0 +1,5 @@
+class AddSlugToNoCmsPage < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_page_translations, :slug, :string
+  end
+end

data/db/migrate/20140303092727_add_awesome_nested_set_to_no_cms_pages.rb

@@ -0,0 +1,8 @@
+class AddAwesomeNestedSetToNoCmsPages < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_pages, :parent_id, :integer
+    add_column :no_cms_pages_pages, :lft, :integer
+    add_column :no_cms_pages_pages, :rgt, :integer
+    add_column :no_cms_pages_pages, :depth, :integer
+  end
+end

data/db/migrate/20140303100908_add_path_to_no_cms_page.rb

@@ -0,0 +1,5 @@
+class AddPathToNoCmsPage < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_page_translations, :path, :string
+  end
+end

data/db/migrate/20140303123845_add_poisition_to_no_cms_block.rb

@@ -0,0 +1,5 @@
+class AddPoisitionToNoCmsBlock < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_blocks, :position, :integer
+  end
+end

data/db/migrate/20140303145615_add_template_to_no_cms_page.rb

@@ -0,0 +1,5 @@
+class AddTemplateToNoCmsPage < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_pages, :template, :string
+  end
+end

data/db/migrate/20140313171000_add_draft_to_block.rb

@@ -0,0 +1,5 @@
+class AddDraftToBlock < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_block_translations, :draft, :boolean, default: false
+  end
+end

data/db/migrate/20140314110439_add_draft_to_pages.rb

@@ -0,0 +1,5 @@
+class AddDraftToPages < ActiveRecord::Migration
+  def change
+    add_column :no_cms_pages_page_translations, :draft, :boolean, default: false
+  end
+end

data/lib/generators/nocms/pages_generator.rb

@@ -0,0 +1,15 @@
+module NoCms
+  class PagesGenerator < Rails::Generators::Base
+
+    source_root File.expand_path("../templates/", __FILE__)
+
+    def generate_nocms_pages_initializer
+      template "config/initializers/nocms/pages.rb", File.join(destination_root, "config", "initializers", "nocms", "pages.rb")
+    end
+
+    def self.namespace
+      "nocms:pages"
+    end
+
+  end
+end

data/lib/generators/nocms/templates/config/initializers/nocms/pages.rb

@@ -0,0 +1,25 @@
+NoCms::Pages.configure do |config|
+
+  # In this section we configure block layouts. It's just an array of layouts, each consisting on a hash.
+  # Each layout has a template and a list of fields with a type.
+  # E.g: config.block_layouts = {
+  #   'title-long_text' => {
+  #     template: 'title-long_text',
+  #     fields: {
+  #       title: :string,
+  #       long_text: :text
+  #     }
+  #   },
+  #   'title-3_columns_text' => {
+  #     template: 'title-3_columns_text',
+  #     fields: {
+  #       title: :string,
+  #       column_1: :text,
+  #       column_2: :text,
+  #       column_3: :text
+  #     }
+  #   }
+  # }
+  # config.block_layouts = {}
+
+end

data/lib/nocms/pages/configuration.rb

@@ -0,0 +1,18 @@
+module NoCms
+  module Pages
+    include ActiveSupport::Configurable
+
+    config_accessor :block_layouts
+
+    self.block_layouts = {
+      'default' => {
+        template: 'default',
+        fields: {
+          title: :string,
+          body: :text
+        }
+      }
+    }
+
+  end
+end

data/lib/nocms/pages/engine.rb

@@ -0,0 +1,10 @@
+require 'globalize'
+require 'awesome_nested_set'
+
+module NoCms
+  module Pages
+    class Engine < ::Rails::Engine
+      isolate_namespace NoCms::Pages
+    end
+  end
+end

data/lib/nocms/pages/routes/page_found_constraint.rb

@@ -0,0 +1,9 @@
+module NoCms::Pages::Routes
+  class PageFoundConstraint
+
+    # A filter URL must NOT have a qualification as the first of its path filters
+    def self.matches?(request)
+      @page = NoCms::Pages::Page.no_drafts.where(path: "/#{request.params[:path]}").exists?
+    end
+  end
+end

data/lib/nocms/pages/routes.rb

@@ -0,0 +1 @@
+require 'nocms/pages/routes/page_found_constraint'

data/lib/nocms/pages/version.rb

@@ -0,0 +1,5 @@
+module NoCms
+  module Pages
+    VERSION = "0.0.1"
+  end
+end

data/lib/nocms_pages.rb

@@ -0,0 +1,8 @@
+require "nocms/pages/engine"
+require 'nocms/pages/configuration'
+require "nocms/pages/routes"
+
+module NoCms
+  module Pages
+  end
+end

data/lib/tasks/pages_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pages do
+#   # Task goes here
+# end