xhive 1.0.0.pre

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,223 @@
+XHIVE
+======
+
+xhive is a gem built for turning your Rails application into an AJAXified CMS.
+
+# How it works
+
+xhive converts your controller actions or [cells](https://github.com/apotonick/cells) into AJAX widgets.
+
+It leverages the power of [Liquid](http://liquidmarkup.org/) creating a custom Liquid::Tag for every
+widget, so it can be called from within any HTML template.
+
+xhive also gives you the foundation of a CMS providing the following models:
+
+* Site
+* Page
+* Stylesheet
+* Image
+
+Using this models along with the xhive widgets you will be able to build a fully functional CMS.
+
+# Installation
+
+Add xhive to your Gemfile
+
+`gem 'xhive'`
+
+Run bundle install
+
+`bundle install`
+
+Run xhive migrations
+
+```
+rake xhive:install:migrations
+rake db:migrate
+```
+
+Include the custom stylesheets in your head tag.
+
+`<%= include_custom_stylesheets %>`
+
+Include the widgets loader just before your \<\\body\> tag.
+
+`<%= initialize_widgets_loader %>`
+
+# Usage
+
+## Widgify
+
+### Turning your controller actions into widgets
+
+Let's say you have a Posts controller and you want to access the show action as a widget.
+
+```
+app/controller/posts_controller.rb
+
+class PostsController < ApplicationController
+  def show
+    @post = Post.find(params[:id])
+  end
+end
+
+app/views/posts/show.html.erb
+
+<h1><%= @post.title %></h1>
+
+<p><%= @post.body %></p>
+
+config/routes.rb
+
+resources :posts, :only => [:show]
+
+```
+Just tell xhive to *widgify* your action:
+
+```
+class PostsController < ApplicationController
+  widgify :show
+
+  def show
+    @post = Post.find(params[:id])
+  end
+end
+```
+And that's it. You will now be able to insert the content of any post from within an HTML template using:
+
+{% posts_show id:1234 %}
+
+This tag will make the browser insert the post content asynchronously into the HTML document.
+
+xhive will also enforce the tag to include the :id parameter.
+
+### Using [cells](https://github.com/apotonick/cells) as reusable widgets
+
+Let's use the same example to illustrate the use of cells with xhive.
+
+We have a Posts cell and we want to use the show method as an AJAX widget.
+
+```
+app/cells/posts_cell.rb
+
+class PostsCell < Cell::Rails
+  def show(params)
+    @post = params[:id]
+    render
+  end
+end
+
+app/cells/posts/show.html.erb
+
+<div class='post'>
+  <h1><%= @post.title %></h1>
+
+  <p><%= @post.body %></p>
+</div>
+
+```
+In this case, we need to tell xhive how we are mounting our widgets routes:
+
+```
+config/initializers/xhive.rb
+
+Xhive::Router::Cells.draw do |router|
+  router.mount 'posts/:id', :to => 'posts#show'
+end
+```
+
+And that's it. You will now be able to insert the content of any post from within an HTML template using:
+
+{% posts_show id:1234 %}
+
+This tag will make the browser insert the post content asynchronously into the HTML document.
+
+xhive will also enforce the tag to include the :id parameter.
+
+## CMS features
+
+Ok, I can include my cells and controller actions as widgets, but... how?
+
+xhive provides you with some basic CMS infrastructure.
+
+### Creating your first dynamic page
+
+To be able to use your widgets, you have to follow the following steps:
+
+Create a Site
+
+```
+site = Xhive::Site.create(:name => 'My awesome blog', :domain => 'localhost')
+```
+
+Create a Page
+
+```
+page = Xhive::Page.create(:name => 'home',
+                          :title => 'My blog page',
+                          :content => '<h1>Home</h1><p>{% posts_show id:1 %}</p>',
+                          :site => site)
+```
+
+Start the server
+
+Now you can access the page on http://localhost:3000/pages/home.
+
+This should display the post with id: 1 inside the home page.
+
+### Adding pages to your own custom data
+
+You can also use the xhive pages from within you own data.
+
+xhive provides the Xhive::Mapper to wire up your resources to xhive pages.
+
+Create a new page to display all the posts
+
+```
+posts_page = Xhive::Page.create(:name => 'posts',
+                                :title => 'Blog Posts',
+                                :content => '{% for post in posts %}{% posts_show id:post.id %}{% endfor %}',
+                                :site => site)
+```
+
+Create a new stylesheet to display your posts:
+
+```
+stylesheet = Xhive::Stylesheet.create(:name => 'Posts', 
+                                      :content => '.post {
+                                                     h1 { font-size: 20px; color: blue; }
+                                                     p { font-size: 12px; color: #000; }
+                                                   }',
+                                      :site => site)
+```
+
+Create a new mapper record for the posts resources
+
+```
+mapper = Xhive::Mapper.create(:resource => 'Post', :action => 'index', :page => posts_page)
+```
+
+From your posts controller, render the posts page
+
+```
+class PostsController < ApplicationController
+  def index
+    @posts = Post.all.limit(10)
+    render_page_for 'Post', 'index', :posts => @posts
+  end
+end
+```
+
+Using this feature you can let the designers implement the HTML/CSS to display the posts in your site without your intervention.
+
+TODO
+====
+
+* Implement the Image model
+* Remove as many dependencies as possible
+* Improve test coverage
+
+Disclaimer
+==========
+This is a work in progress and still a proof of concept. Use at your own risk :P.
+

data/Rakefile

@@ -0,0 +1,40 @@
+#!/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    = 'Xhive'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/xhive/application.js

@@ -0,0 +1,15 @@
+// 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 jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/xhive/loader.js.coffee

@@ -0,0 +1,22 @@
+class @WidgetLoader
+  @load: ->
+    $widgets = []
+
+    $("[data-widget='true']").each((index) ->
+      $widget = $(this)
+      baseUrl = $widget.data('url')
+      args = $widget.data('params')
+      url = "#{baseUrl}?#{args}"
+      $widgets.push $.ajax({
+        url: url,
+        success: (data) ->
+          $widget.html(data)
+          $widget.attr('data-widget', 'false')
+      })
+    )
+
+    if $widgets.length > 0
+      $.when.apply(null, $widgets).then( ->
+        WidgetLoader.load()
+      )
+

data/app/assets/javascripts/xhive/pages.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/xhive/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/assets/stylesheets/xhive/pages.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/xhive/application_controller.rb

@@ -0,0 +1,5 @@
+module Xhive
+  class ApplicationController < ActionController::Base
+    extend Xhive::Controller
+  end
+end

data/app/controllers/xhive/pages_controller.rb

@@ -0,0 +1,24 @@
+require_dependency "xhive/application_controller"
+
+module Xhive
+  class PagesController < ApplicationController
+    extend Xhive::Widgify
+
+    widgify :widget
+
+    before_filter :load_page
+
+    def show
+    end
+
+    def widget
+      render :show
+    end
+
+  private
+
+    def load_page
+      @page = current_site.pages.find(params[:id])
+    end
+  end
+end

data/app/controllers/xhive/stylesheets_controller.rb

@@ -0,0 +1,16 @@
+require_dependency "xhive/application_controller"
+
+module Xhive
+  class StylesheetsController < ApplicationController
+    respond_to :css
+
+    def index
+      render :text => StylesheetPresenter.all_compressed(Stylesheet.all)
+    end
+
+    def show
+      @style = Stylesheet.find(params[:id])
+      render :text => @style.presenter.compressed
+    end
+  end
+end

data/app/controllers/xhive/widgets_controller.rb

@@ -0,0 +1,16 @@
+require_dependency "xhive/application_controller"
+
+module Xhive
+  class WidgetsController < ApplicationController
+    def show
+      # Looks for a route matching the request path
+      route = Xhive::Router::Route.find(request.path)
+      # Gets the parameters from the request path and the query string
+      parameters = route.params_from(request.path).merge(params).with_indifferent_access
+      # Renders the corresponding cell#action
+      render :text => render_cell(route.klass.underscore.to_sym, route.action.to_sym, parameters), :status => 200
+    rescue => e
+      render :text => 'Not found', :status => 404
+    end
+  end
+end

data/app/helpers/xhive/application_helper.rb

@@ -0,0 +1,39 @@
+module Xhive
+  module ApplicationHelper
+    def initialize_widgets_loader
+      "<script type='text/javascript'>WidgetLoader.load()</script>".html_safe
+    end
+
+    def include_custom_stylesheets
+      "<link href='#{stylesheets_path}' media='all' rel='stylesheet' type='text/css'/>".html_safe
+    end
+
+    def render_page_for(resource, action, options={})
+      page = current_site.mappers.page_for(resource, action)
+      render :text => page.presenter.render_content(options)
+    end
+
+    def current_site
+      domain = request.host
+      @current_site ||= Site.where(:domain => domain).first || Site.first
+      fail "No Site defined. Please create a default Site." unless @current_site.present?
+      @current_site
+    end
+
+    # Private: Returns a safe user, e.i. a logged user or a guest user.
+    #
+    # This is just a placeholder and should be implemented in the host app.
+    #
+    # Example:
+    #
+    # def safe_user
+    #   current_user || AnonymousUser.new
+    # end
+    #
+    # Returns: an anonymous user.
+    #
+    def safe_user
+      AnonymousUser.new
+    end
+  end
+end

data/app/models/xhive/anonymous_user.rb

@@ -0,0 +1,6 @@
+module Xhive
+  class AnonymousUser < Xhive::Hashy
+    include Xhive::Presentable
+    self.presenter_class = 'Xhive::UserPresenter'
+  end
+end

data/app/models/xhive/mapper.rb

@@ -0,0 +1,19 @@
+module Xhive
+  class Mapper < ActiveRecord::Base
+    attr_accessible :action, :page, :site, :resource
+
+    belongs_to :site
+    belongs_to :page
+
+    validates :resource, :presence => true
+    validates :action, :presence => true
+    validates :site, :presence => true
+    validates :page, :presence => true
+
+    def self.page_for(resource, action)
+      page = where(:resource => resource).where(:action => action).first.try(:page)
+      fail ActiveRecord::RecordNotFound unless page.present?
+      page
+    end
+  end
+end

data/app/models/xhive/page.rb

@@ -0,0 +1,19 @@
+require 'friendly_id'
+
+module Xhive
+  class Page < ActiveRecord::Base
+    extend ::FriendlyId
+    friendly_id :name, use: :slugged
+
+    include Xhive::Presentable
+
+    attr_accessible :content, :meta_description, :meta_keywords, :name, :slug, :title, :site
+
+    belongs_to :site
+
+    validates :name, :presence => true, :uniqueness => { :scope => :site_id }
+    validates :title, :presence => true
+    validates :content, :presence => true
+    validates :site, :presence => true
+  end
+end

data/app/models/xhive/site.rb

@@ -0,0 +1,14 @@
+module Xhive
+  class Site < ActiveRecord::Base
+    attr_accessible :domain, :name, :home_page
+
+    has_many :pages
+    has_many :mappers
+    has_many :stylesheets
+
+    belongs_to :home_page, :class_name => 'Page'
+
+    validates :name, :presence => true
+    validates :domain, :presence => true
+  end
+end

data/app/models/xhive/stylesheet.rb

@@ -0,0 +1,29 @@
+require 'friendly_id'
+require 'sass'
+
+module Xhive
+  class Stylesheet < ActiveRecord::Base
+    extend ::FriendlyId
+    friendly_id :name, use: :slugged
+
+    include Xhive::Presentable
+
+    attr_accessible :content, :name, :slug, :site
+
+    belongs_to :site
+
+    validates :name, :presence => true, :uniqueness => { :scope => :site_id }
+    validates :content, :presence => true
+    validates :site, :presence => true
+    validate  :css_syntax, :if => Proc.new { self.content.present? }
+
+  private
+
+    def css_syntax
+      engine = Sass::Engine.new(content, :syntax => :scss)
+      engine.render
+    rescue Sass::SyntaxError => e
+      errors.add(:content, e.message)
+    end
+  end
+end

data/app/presenters/xhive/base_presenter.rb

@@ -0,0 +1,31 @@
+module Xhive
+  class BasePresenter
+    attr_reader :object
+
+    include ActionView::Helpers
+    include ActionView::Context
+    include Rails.application.routes.url_helpers
+
+    default_url_options[:host] = (Rails.application.config.action_mailer.default_url_options || {}).fetch(:host, 'localhost')
+
+    def initialize(object)
+      @object = object
+    end
+
+    def id
+      @object.id
+    end
+
+  private
+
+    def controller
+      ApplicationController.current_controller
+    end
+
+    def self.presents(name)
+      define_method(name) do
+        @object
+      end
+    end
+  end
+end

data/app/presenters/xhive/page_presenter.rb

@@ -0,0 +1,23 @@
+module Xhive
+  class PagePresenter < Xhive::BasePresenter
+    presents :page
+    delegate :name, :title, :content, :meta_keywords, :meta_description, :to => :page
+
+    liquid_methods :name, :title, :content, :meta_keywords, :meta_description
+
+    def render_content(options={})
+      layout = ::Liquid::Template.parse("{{content}}").render({"content" => page.content})
+      text = ::Liquid::Template.parse(layout).render(
+        {'page' => self, 'user' => controller.safe_user.presenter}.merge(options.stringify_keys),
+        :registers => {:controller => controller}
+      )
+      result = text.html_safe
+    rescue => e
+      logger.debug "#{e.class.name}: #{e.message}"
+      logger.debug e.backtrace.join("/n")
+      result = ''
+    ensure
+      return result
+    end
+  end
+end

data/app/presenters/xhive/stylesheet_presenter.rb

@@ -0,0 +1,31 @@
+module Xhive
+  class StylesheetPresenter < Xhive::BasePresenter
+    presents :stylesheet
+    delegate :name, :content, :to => :stylesheet
+
+    liquid_methods :name, :content, :compressed
+
+    def compressed
+      self.class.compress(stylesheet.content)
+    end
+
+    def self.all_compressed(stylesheets)
+      stylesheets.inject('') do |result, stylesheet|
+        result << compress(stylesheet.content)
+      end
+    end
+
+  private
+
+    # Private: compress stylesheet content
+    #
+    # content - The string containing the stylesheet content
+    #
+    # Returns: the compressed CSS
+    #
+    def self.compress(content)
+      engine = Sass::Engine.new(content, :syntax => :scss, :style => :compressed)
+      engine.render
+    end
+  end
+end

data/app/presenters/xhive/user_presenter.rb

@@ -0,0 +1,8 @@
+module Xhive
+  class UserPresenter < Xhive::BasePresenter
+    presents :user
+    delegate :email, :first_name, :last_name, :to => :user
+
+    liquid_methods :email, :first_name, :last_name
+  end
+end

data/app/views/layouts/xhive/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= @title || 'Xhive' %></title>
+    <%= stylesheet_link_tag    "xhive/application", :media => "all" %>
+    <%= javascript_include_tag "xhive/application" %>
+    <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.18/jquery-ui.min.js" %>
+    <%= include_custom_stylesheets %>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+    <%= initialize_widgets_loader %>
+  </body>
+</html>

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

@@ -0,0 +1,2 @@
+<%= @page.presenter.render_content %>
+

data/config/routes.rb

@@ -0,0 +1,13 @@
+Xhive::Engine.routes.draw do
+  resources :pages, :only => :show do
+    get 'widget', :on => :member
+  end
+
+  get 'stylesheets/custom.css', :to => 'stylesheets#index', :as => :stylesheets, :format => :css
+
+  resources :stylesheets, :only => :show, :format => :css
+
+  get 'widgets/*widget', :to => 'widgets#show'
+
+  root :to => 'pages#show'
+end