content_block 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c9587e4af87be958a4620210ddcf12c1f74e449
+  data.tar.gz: 038285f8ddd76ca6634e857b7ab87519cf2b0397
+SHA512:
+  metadata.gz: 974897e75867ea21571297de5c33ff40004fedbabe7f2ceb65d9ec061a1db55a2d5a5cbb7e509af33dc8d302061039fb83b75142b0129220630abfad8e7995aa
+  data.tar.gz: 1ba6940d0376f369216f882c8cc425aa936184925658cbe0edff2e8764ffb6b078c3b2890bc8f4cc4eaf913964c87dcd838880155ce975e0c72a398626667233

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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,64 @@
+# ContentBlock
+
+[![Build Status](https://travis-ci.org/commonmedia/content_block.png)](https://travis-ci.org/commonmedia/content_block)
+[![Coverage Status](https://coveralls.io/repos/commonmedia/content_block/badge.png)](https://coveralls.io/r/commonmedia/content_block)
+[![Code Climate](https://codeclimate.com/github/commonmedia/content_block.png)](https://codeclimate.com/github/commonmedia/content_block)
+[![GitHub version](https://badge.fury.io/gh/commonmedia%2Fcontent_block.png)](http://badge.fury.io/gh/commonmedia%2Fcontent_block)
+
+A block, as used within this gem, is a section of content (either an image, simple text, or rich text that includes markup).
+This gem allows you to create these different types of blocks, and place them throughout the site.
+You can then give the administrative users of the site access to edit these blocks.
+
+
+## Requirements / Caveats
+
+* Your app must already have functional [devise](https://github.com/plataformatec/devise) installation
+* Your app must already have functional [cancancan](https://github.com/CanCanCommunity/cancancan) installation
+* Your app must already have functional [ckeditor](https://github.com/galetahub/ckeditor) installation
+* Your `User` must have a `role` field
+* Administrators must be identified by having a `role` value of 'admin'
+* Your app needs to handle the display of `notice` messages, should they exist
+* Only rich blocks are available - image & simple text blocks have not been added, yet
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'content_block'
+
+Have bundler install the gem:
+
+    bundle
+
+Run the installer:
+
+    rails generate content_block:install
+
+Optionally, you can copy over the view files in order to have direct control on the admin appearance:
+
+    rails generate content_block:views
+
+
+## Usage
+
+You can manage the blocks by visiting the `/content-block/admin` URL as an admin. That page links out to each block-type's simple CRUD interface.
+
+To use a block in your view without displaying its title
+(`IDENTIFIER` is either the `name` or the `id` of the block to be displayed):
+
+    <%= rich_block('IDENTIFIER') %>
+
+To use a block in your view and display its title
+(`IDENTIFIER` is either the `name` or the `id` of the block to be displayed & `TAG` is the HTML tag you'd like the title to be wrapped in):
+
+    <%= rich_block_with_title('IDENTIFIER', 'TAG') %>
+
+
+## Contributing
+
+1. Fork it ( http://github.com/commonmedia/content_block/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/javascripts/content_block/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
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require ckeditor/override
+//= require ckeditor/init
+//= require_tree .

data/app/assets/stylesheets/content_block/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/content_block/admin_controller.rb

@@ -0,0 +1,10 @@
+require_dependency 'content_block/application_controller'
+
+module ContentBlock
+  class AdminController < ContentBlock::ApplicationController
+    authorize_resource class: ContentBlock::RichBlock
+
+    def index
+    end
+  end
+end

data/app/controllers/content_block/application_controller.rb

@@ -0,0 +1,12 @@
+module ContentBlock
+  class ApplicationController < ::ApplicationController
+    rescue_from CanCan::AccessDenied do |exception|
+      redirect_to main_app.new_user_session_url, alert: exception.message
+    end
+
+    def current_ability
+      # ContentBlock::Ability.new(content_block_user)
+      @current_ability ||= ContentBlock::Ability.new(content_block_user)
+    end
+  end
+end

data/app/controllers/content_block/rich_blocks_controller.rb

@@ -0,0 +1,63 @@
+require_dependency 'content_block/application_controller'
+
+module ContentBlock
+  class RichBlocksController < ContentBlock::ApplicationController
+    before_action :set_rich_block, only: [:show, :edit, :update, :destroy]
+    authorize_resource class: ContentBlock::RichBlock
+
+    # GET /content-block/rich-blocks
+    def index
+      @rich_blocks = RichBlock.all
+    end
+
+    # GET /content-block/rich-blocks/1
+    def show
+    end
+
+    # GET /content-block/rich-blocks/new
+    def new
+      @rich_block = RichBlock.new
+    end
+
+    # GET /content-block/rich-blocks/1/edit
+    def edit
+    end
+
+    # POST /content-block/rich-blocks
+    def create
+      @rich_block = RichBlock.new(rich_block_params)
+
+      if @rich_block.save
+        redirect_to @rich_block, notice: 'RichBlock was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /content-block/rich-blocks/1
+    def update
+      if @rich_block.update(rich_block_params)
+        redirect_to @rich_block, notice: 'RichBlock was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /content-block/rich-blocks/1
+    def destroy
+      @rich_block.destroy
+      redirect_to rich_blocks_url, notice: 'RichBlock was successfully destroyed.'
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def set_rich_block
+        @rich_block = RichBlock.find(params[:id])
+      end
+
+      # Only allow a trusted parameter 'white list' through.
+      def rich_block_params
+        params.require(:rich_block).permit(:name, :title, :content)
+      end
+  end
+end

data/app/helpers/content_block/application_helper.rb

@@ -0,0 +1,11 @@
+module ContentBlock
+  module ApplicationHelper
+    def method_missing(method, *args, &block)
+      if (method.to_s.end_with?('_path') || method.to_s.end_with?('_url')) && main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/app/helpers/content_block/block_helper.rb

@@ -0,0 +1,14 @@
+module ContentBlock
+  module BlockHelper
+    def rich_block(find_by)
+      block = ContentBlock::RichBlock.where('id = ? OR name = ?', find_by, find_by).first
+      block.content.html_safe
+    end
+
+    def rich_block_with_title(find_by, wrapper)
+      block         = ContentBlock::RichBlock.where('id = ? OR name = ?', find_by, find_by).first
+      wrapped_title = "<#{wrapper}>#{block.title}</#{wrapper}>"
+      "#{wrapped_title}#{block.content}".html_safe
+    end
+  end
+end

data/app/models/ckeditor/asset.rb

@@ -0,0 +1,4 @@
+class Ckeditor::Asset < ActiveRecord::Base
+  include Ckeditor::Orm::ActiveRecord::AssetBase
+  include Ckeditor::Backend::Paperclip
+end

data/app/models/ckeditor/attachment_file.rb

@@ -0,0 +1,13 @@
+class Ckeditor::AttachmentFile < Ckeditor::Asset
+  has_attached_file :data,
+                    :url => "/ckeditor_assets/attachments/:id/:filename",
+                    :path => ":rails_root/public/ckeditor_assets/attachments/:id/:filename"
+
+  validates_attachment_presence :data
+  validates_attachment_size :data, :less_than => 100.megabytes
+  do_not_validate_attachment_file_type :data
+
+  def url_thumb
+    @url_thumb ||= Ckeditor::Utils.filethumb(filename)
+  end
+end

data/app/models/ckeditor/picture.rb

@@ -0,0 +1,14 @@
+class Ckeditor::Picture < Ckeditor::Asset
+  has_attached_file :data,
+                    :url  => "/ckeditor_assets/pictures/:id/:style_:basename.:extension",
+                    :path => ":rails_root/public/ckeditor_assets/pictures/:id/:style_:basename.:extension",
+                    :styles => { :content => '800>', :thumb => '118x100#' }
+
+  validates_attachment_presence :data
+  validates_attachment_size :data, :less_than => 2.megabytes
+  validates_attachment_content_type :data, :content_type => /\Aimage/
+
+  def url_content
+    url(:content)
+  end
+end

data/app/models/content_block/ability.rb

@@ -0,0 +1,11 @@
+module ContentBlock
+  class Ability
+    include CanCan::Ability
+
+    def initialize(user)
+      user ||= User.new
+
+      can :manage, ContentBlock::RichBlock if user.role == 'admin'
+    end
+  end
+end

data/app/models/content_block/rich_block.rb

@@ -0,0 +1,4 @@
+module ContentBlock
+  class RichBlock < ActiveRecord::Base
+  end
+end

data/app/views/content_block/admin/index.html.erb

@@ -0,0 +1,3 @@
+<h1>ContentBlock Admin</h1>
+
+<%= link_to 'Manage RichBlocks', content_block.rich_blocks_path %>

data/app/views/content_block/rich_blocks/_form.html.erb

@@ -0,0 +1,19 @@
+<%= simple_form_for(@rich_block, url: [content_block, @rich_block]) do |f| %>
+  <% if @rich_block.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@rich_block.errors.count, "error") %> prohibited this rich_block from being saved:</h2>
+
+      <ul>
+      <% @rich_block.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+    <%= f.input :name %>
+    <%= f.input :title %>
+    <%= f.input :content, as: :ckeditor %>
+
+    <%= f.submit %>
+<% end %>

data/app/views/content_block/rich_blocks/edit.html.erb

@@ -0,0 +1,5 @@
+<h1>Editing RichBlock</h1>
+
+<%= render 'content_block/rich_blocks/form' %>
+
+<%= link_to 'Cancel', content_block.rich_blocks_path %>

data/app/views/content_block/rich_blocks/index.html.erb

@@ -0,0 +1,32 @@
+<h1>Listing RichBlocks</h1>
+
+<p>
+  <%= link_to 'ContentBlock Admin', content_block.content_block_admin_path %> |
+  <%= link_to 'New RichBlock', content_block.new_rich_block_path %>
+</p>
+
+<table>
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Name</th>
+      <th>Title</th>
+      <th>Content</th>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <% @rich_blocks.each do |rich_block| %>
+      <tr>
+        <td><%= rich_block.id %></td>
+        <td><%= rich_block.name %></td>
+        <td><%= rich_block.title %></td>
+        <td><%= ActionView::Base.full_sanitizer.sanitize(rich_block.content)[0..50] %>...</td>
+        <td><%= link_to 'Show', content_block.rich_block_path(rich_block) %></td>
+        <td><%= link_to 'Edit', content_block.edit_rich_block_path(rich_block) %></td>
+        <td><%= link_to 'Destroy', content_block.rich_block_path(rich_block), method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/content_block/rich_blocks/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New RichBlock</h1>
+
+<%= render 'content_block/rich_blocks/form' %>
+
+<%= link_to 'Back', content_block.rich_blocks_path %>

data/app/views/content_block/rich_blocks/show.html.erb

@@ -0,0 +1,24 @@
+<p>
+  <%= link_to 'Edit', content_block.edit_rich_block_path(@rich_block) %> |
+  <%= link_to 'RichBlocks Admin', content_block.rich_blocks_path %>
+</p>
+
+<p>
+  <strong>ID:</strong>
+  <%= @rich_block.id %>
+</p>
+
+<p>
+  <strong>Name:</strong>
+  <%= @rich_block.name %>
+</p>
+
+<p>
+  <strong>Title:</strong>
+  <%= @rich_block.title %>
+</p>
+
+<p>
+  <strong>Content:</strong><br />
+  <%= @rich_block.content.html_safe %>
+</p>

data/config/initializers/ckeditor.rb

@@ -0,0 +1,34 @@
+# Use this hook to configure ckeditor
+Ckeditor.setup do |config|
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default), :mongo_mapper and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'ckeditor/orm/active_record'
+
+  # Allowed image file types for upload.
+  # Set to nil or [] (empty array) for all file types
+  # By default: %w(jpg jpeg png gif tiff)
+  # config.image_file_types = ["jpg", "jpeg", "png", "gif", "tiff"]
+
+  # Allowed attachment file types for upload.
+  # Set to nil or [] (empty array) for all file types
+  # By default: %w(doc docx xls odt ods pdf rar zip tar tar.gz swf)
+  # config.attachment_file_types = ["doc", "docx", "xls", "odt", "ods", "pdf", "rar", "zip", "tar", "swf"]
+
+  # Setup authorization to be run as a before filter
+  # By default: there is no authorization.
+  config.authorize_with :cancan
+
+  # Asset model classes
+  # config.picture_model { Ckeditor::Picture }
+  # config.attachment_file_model { Ckeditor::AttachmentFile }
+
+  # Paginate assets
+  # By default: 24
+  # config.default_per_page = 24
+
+  # Customize ckeditor assets path
+  # By default: nil
+  # config.asset_path = "http://www.example.com/assets/ckeditor/"
+end

data/config/locales/simple_form.en.yml

@@ -0,0 +1,26 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Please review the problems below:"
+    # Labels and hints examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+

data/config/routes.rb

@@ -0,0 +1,4 @@
+ContentBlock::Engine.routes.draw do
+  resources 'rich-blocks', controller: :rich_blocks, as: :rich_blocks
+  get '/admin' => 'admin#index', as: :content_block_admin
+end

data/db/migrate/20140418182642_create_content_block_rich_blocks.rb

@@ -0,0 +1,11 @@
+class CreateContentBlockRichBlocks < ActiveRecord::Migration
+  def change
+    create_table :content_block_rich_blocks do |t|
+      t.string :name
+      t.string :title
+      t.text :content
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140423122643_create_ckeditor_assets.rb

@@ -0,0 +1,26 @@
+class CreateCkeditorAssets < ActiveRecord::Migration
+  def self.up
+    create_table :ckeditor_assets do |t|
+      t.string  :data_file_name, null: false
+      t.string  :data_content_type
+      t.integer :data_file_size
+
+      t.integer :assetable_id
+      t.string  :assetable_type, limit: 30
+      t.string  :type, limit: 30
+
+      # Uncomment	it to save images dimensions, if your need it
+      t.integer :width
+      t.integer :height
+
+      t.timestamps
+    end
+
+    add_index 'ckeditor_assets', ['assetable_type', 'type', 'assetable_id'], name: 'idx_ckeditor_assetable_type'
+    add_index 'ckeditor_assets', ['assetable_type', 'assetable_id'], name: 'idx_ckeditor_assetable'
+  end
+
+  def self.down
+    drop_table :ckeditor_assets
+  end
+end

data/lib/content_block/engine.rb

@@ -0,0 +1,19 @@
+module ContentBlock
+  class Engine < ::Rails::Engine
+    isolate_namespace ContentBlock
+
+    config.generators do |g|
+      g.test_framework      :rspec,        fixture: false
+      g.integration_tool    :rspec
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    # initializer 'content_block.action_controller' do |app|
+    #   ActiveSupport.on_load :action_controller do
+    #     helper ContentBlock::ApplicationHelper
+    #   end
+    # end
+  end
+end