bop 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Spanner Ltd
+
+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,82 @@
+# Bop
+
+*Blocks on Pages*. Very simple, very lovely html5 CMS that you can plug into any Rails app. Bop is designed
+from the ground up as an engine: for standalone CMS you need `bopulate`, which is an equally minimal
+multi-domain hosting package designed for the lazy. Also, doesn't exist yet.
+
+Bop includes modern html5 editing tools, asset-management, content reuse, and drag and drop editing of
+page trees.
+
+## Status
+
+Brand new, very alpha, avoid!
+
+## Requirements
+
+A rails 3.2 app with devise and cancan.
+
+## Conventions
+
+Bop works in a very simple way:
+
+* Anything can have a page tree;
+* Pages have a template;
+* Templates define spaces;
+* Spaces have one or more blocks in them;
+* Blocks have types, which determine the presentation of their content.
+
+Out of the box, you get three types of block: html, asset or list. It's very easy to add more.
+
+## Templates
+
+At the moment all our page templates are in Liquid. Other templating engines will be supported soon, including
+radius. Blocks can be edited in markdown, textile, html or haml. Also, soon, radius.
+
+## Installation
+
+In your gemfile:
+
+    gem "bop"
+
+To migrate:
+
+    rake bop:install:migrations
+    rake db:migrate
+
+## Usage
+
+Add this line to one or more of your model classes:
+
+    has_pages
+
+## Customisation (not yet)
+
+To bring Bop javascript, stylesheets and block_type views into your app for customisation:
+
+    rake bop:customise
+
+## Extension (not yet)
+
+Bop will be extensible from your initializers in these constrained ways:
+
+* block types can be added with a simple declaration and the necessary view/edit templates
+* markup types can be added for templates or blocks or both
+
+Before long there will also be a simple API for defining new data types or asset types and custom blocks to go 
+with them. The interior of Bop is very simple so it's also easy to monkey over if you like that sort of thing.
+
+## Migration from radiant (not yet)
+
+Once radius support is worked in, we will support the automated import of radiant sites. This will bring in
+pages, layouts, snippets and assets, but non-core radiant extensions will not be supported. Persuade their 
+authors to turn them into bop extensions instead.
+
+## Copyright
+
+Copyright William Ross for Spanner Ltd, 2012
+Released under the MIT license: See LICENSE.
+
+
+
+
+

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    = 'Bop'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/bop/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/stylesheets/bop/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/bop/application_controller.rb

@@ -0,0 +1,4 @@
+module Bop
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/bop/application_helper.rb

@@ -0,0 +1,4 @@
+module Bop
+  module ApplicationHelper
+  end
+end

data/app/models/bop/asset.rb

@@ -0,0 +1,6 @@
+class Bop::Asset < ActiveRecord::Base
+  # attr_accessible :title, :body
+  
+  has_attached_file :file
+  
+end

data/app/models/bop/block.rb

@@ -0,0 +1,20 @@
+class Bop::Block < ActiveRecord::Base
+  attr_accessible :title, :content, :type
+
+  belongs_to :user
+  has_many :block_properties
+  has_many :placed_blocks
+  has_many :pages, :through => :placed_blocks
+
+  def block_type
+    Bop::BlockType[type]
+  end
+
+  def render(context, view="show")
+    template(view).render(context)
+  end
+
+  def template(view)
+    block_type.template(view)
+  end
+end

data/app/models/bop/block_property.rb

@@ -0,0 +1,5 @@
+class Bop::BlockProperty < ActiveRecord::Base
+  # attr_accessible :title, :body
+
+  belongs_to :block
+end

data/app/models/bop/block_type.rb

@@ -0,0 +1,39 @@
+# At the moment block types are just parameterised template-finders.
+#
+
+class Bop::BlockType
+  @@types = []
+  @@type_lookup = {}
+  @template = {}
+  attr_reader :name
+
+  def initialize(name, options = {})
+    options = options.symbolize_keys
+    @name = name
+    @@types.push self
+    @@type_lookup[@name] = self
+  end
+  
+  def template(name)
+    unless @templates[name]
+      # Here we will need to support various file types and should probably just hook into ActionView. That's going to be fun.
+      tpl = null
+      [Bop::Engine.root, Rails.root].each do |root|
+        if !tpl && File.exist(root + "app/views/bop/block_types/#{name}.liquid")
+          tpl = File.read(root + "app/views/bop/block_types/#{name}.liquid")
+        end
+      end
+      raise Bop::MissingTemplateError unless tpl
+      @templates[name] = Liquid::Template.parse(tpl)
+    end
+    @templates[name]
+  end
+end
+
+def self.find(type)
+  @@type_lookup[type] if type
+end
+
+def self.[](type)
+  find(type)
+end

data/app/models/bop/page.rb

@@ -0,0 +1,68 @@
+require 'ancestry'
+
+class Bop::Page < ActiveRecord::Base
+  attr_accessible :title, :slug, :template_id, :race_id, :asset_id
+
+  belongs_to :race
+  belongs_to :template
+  belongs_to :user
+  belongs_to :asset
+  has_ancestry :orphan_strategy => :destroy
+  has_many :placed_blocks
+  has_many :blocks, :through => :placed_blocks
+
+  before_save :ensure_slug
+  before_save :receive_context
+  after_save :propagate_context
+
+  validate :title, :presence => true
+  # this needs scoping
+  validate :slug, :uniqueness => true, :presence => true
+
+  def inherited_template
+    template || parent.inherited_template
+  end
+
+  def inherited_asset
+    asset || parent.inherited_asset
+  end
+
+  # currently we only support liquid for page layouts
+  def render
+    inherited_template.compiled.render(context)
+  end
+  
+  # Fixed
+  def context
+    @context ||= {
+      :page => self,
+      :asset => inherited_asset,
+      :race => race,
+      :user => User.current,
+      :account => Account.current
+    }
+  end
+
+protected
+
+  def ensure_slug
+    self.slug ||= title.parameterize
+  end
+
+  def receive_context
+    if parent
+      self.race = parent.race
+      self.route = (ancestors + [self]).map(&:slug).join('/')
+    else
+      self.route = ""
+    end
+  end
+
+  def propagate_context
+    children.each do |child|
+      child.receive_context
+      child.save
+    end
+  end
+
+end

data/app/models/bop/placed_block.rb

@@ -0,0 +1,11 @@
+class Bop::PlacedBlock < ActiveRecord::Base
+  # attr_accessible :title, :body
+
+  belongs_to :page
+  belongs_to :block
+
+  scope :in_bucket, lambda { |bucket|
+  
+  }
+
+end

data/app/models/bop/template.rb

@@ -0,0 +1,11 @@
+class Bop::Template < ActiveRecord::Base
+  attr_accessible :title, :content
+
+  belongs_to :user
+  has_many :pages
+
+  def compiled
+    @template ||= Liquid::Template.parse(content)
+  end
+
+end

data/app/views/bop/block_types/text/show.liquid

@@ -0,0 +1,2 @@
+<h2>{{block.title}}</h2>
+{{block.content}}

data/config/initializers/bop.rb

@@ -0,0 +1,3 @@
+Bop::BlockType.new "text"
+Bop::BlockType.new "asset"
+Bop::BlockType.new "list"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Bop::Engine.routes.draw do
+end
+
+Rails.application.routes.draw do
+end

data/db/migrate/20120809125316_create_bop_tables.rb

@@ -0,0 +1,62 @@
+class CreateBopTables < ActiveRecord::Migration
+  def change
+    create_table :bop_pages do |t|
+      t.string :title
+      t.string :slug
+      t.string :route
+      t.string :ancestry
+      t.integer :race_id
+      t.integer :template_id
+      t.integer :asset_id
+      t.integer :user_id
+      t.timestamps
+    end
+
+    create_table :bop_templates do |t|
+      t.string :title
+      t.text :content
+      t.text :description
+      t.string :markup_type
+      t.integer :user_id
+      t.timestamps
+    end
+
+    create_table :bop_blocks do |t|
+      t.string :title
+      t.text :content
+      t.string :markup_type
+      t.string :type
+      t.integer :asset_id
+      t.integer :user_id
+      t.timestamps
+    end
+
+    create_table :bop_assets do |t|
+      t.string :title
+      t.has_attached_file :file
+      t.integer :user_id
+      t.timestamps
+    end
+
+    create_table :bop_placed_blocks do |t|
+      t.string :bucket
+      t.integer :block_id
+      t.integer :page_id
+      t.timestamps
+    end
+
+    create_table :bop_block_properties do |t|
+      t.string :name
+      t.string :content
+      t.timestamps
+    end
+
+    create_table :bop_publications do |t|
+      t.text :rendered_content
+      t.integer :page_id
+      t.integer :user_id
+      t.timestamps
+    end
+    
+  end
+end

data/lib/bop.rb

@@ -0,0 +1,49 @@
+require "bop/engine"
+require "bop/tags"
+require "bop/glue"
+
+module Bop
+  class BopError < StandardError; end
+  class MissingRootPageError < BopError; end
+  class MissingPageError < BopError; end
+  class MissingTemplateError < BopError; end
+
+  module ClassMethods
+    def has_pages
+      include InstanceMethods
+
+      has_many :pages, :class_name => "Bop::Page"
+      after_save :ensure_root_page
+    end
+  end
+
+  module InstanceMethods
+    def root_page!
+      raise Bop::MissingRootPageError unless page = root_page
+      page
+    end
+
+    def root_page
+      find_page("")
+    end
+
+    def find_page!(route)
+      raise Bop::MissingPageError unless page = find_page(route)
+      page
+    end
+
+    def find_page(route)
+      pages.find_by_route(route)
+    end
+
+  protected
+    
+    def ensure_root_page
+      unless root_page
+        pages.create(:title => "Home", :slug => "")
+      end
+    end
+  
+  end
+end
+

data/lib/bop/engine.rb

@@ -0,0 +1,8 @@
+module Bop
+  class Engine < ::Rails::Engine
+    isolate_namespace Bop
+    initializer "bop.integration" do
+      ActiveRecord::Base.send(:include, Bop::Glue)
+    end
+  end
+end

data/lib/bop/exceptions.rb

@@ -0,0 +1,6 @@
+module Bop
+  class BopError < StandardError; ned
+  class MissingRootPageError < BopError; end
+  class MissingPageError < BopError; end
+  class MissingTemplateError < BopError; end
+end

data/lib/bop/glue.rb

@@ -0,0 +1,7 @@
+module Bop
+  module Glue
+    def self.included base #:nodoc:
+      base.extend ClassMethods
+    end
+  end
+end

data/lib/bop/tags.rb

@@ -0,0 +1,22 @@
+require "liquid"
+
+module Bop
+  module Tags
+    
+    class Yield < Liquid::Tag
+      def initialize(tag_name, bucket, tokens)
+         super
+         @bucket = bucket || "main"
+      end
+
+      def render(context)
+        if page = context[:page]
+          block_context = context.dup.merge(:block => self)
+          page.blocks_for(@bucket.downcase).map{ |block| block.render(block_context) }
+        end
+      end
+    end
+
+    Liquid::Template.register_tag('yield', Yield)
+  end
+end

data/lib/bop/version.rb

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

data/lib/tasks/bop_tasks.rake

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: bop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- William Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Blocks on Pages. Very simple, very lovely html5 CMS designed from the
+  ground up as a rails engine.
+email:
+- will@spanner.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/bop/application.js
+- app/assets/stylesheets/bop/application.css
+- app/controllers/bop/application_controller.rb
+- app/helpers/bop/application_helper.rb
+- app/models/bop/asset.rb
+- app/models/bop/block.rb
+- app/models/bop/block_property.rb
+- app/models/bop/block_type.rb
+- app/models/bop/page.rb
+- app/models/bop/placed_block.rb
+- app/models/bop/template.rb
+- app/views/bop/block_types/text/show.liquid
+- config/initializers/bop.rb
+- config/routes.rb
+- db/migrate/20120809125316_create_bop_tables.rb
+- lib/bop/engine.rb
+- lib/bop/exceptions.rb
+- lib/bop/glue.rb
+- lib/bop/tags.rb
+- lib/bop/version.rb
+- lib/bop.rb
+- lib/tasks/bop_tasks.rake
+- Rakefile
+- README.md
+- LICENSE
+homepage: http://bop.spanner.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: HTML5 CMS engine for Rails 3.2+
+test_files: []