static_blocks 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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,88 @@
+# Static Blocks
+
+Static Blocks is an ultra light-weight CMS for Ruby on Rails. Create static blocks of content. Place them anywhere in your views.
+
+## Features
+* Simple admin interface
+* i18n internationalization support
+* Optional http basic authentication
+* Search
+* wysihtml5 editor
+
+## Installation
+
+Add the following to Gemfile:
+
+```ruby
+gem 'static_blocks'
+```
+
+Run bundle from shell:
+
+```shell
+bundle install
+```
+
+Run static blocks install generator from shell:
+
+```shell
+rails generate static_blocks:install
+```
+
+Run migrations:
+
+```shell
+rake db:migrate
+```
+
+Mount engine in routes.rb:
+
+```ruby
+mount StaticBlocks::Engine => "/static_blocks_admin"
+```
+
+## Usage
+
+Visit `/static_blocks_admin` and create some static blocks.
+
+Use the `static_block_for` method or it's alias `s` to output a block onto any view template. Pass in the title of the static block as argument. Use `raw` if you do not want to escape the html.
+
+```
+<%=raw static_block_for('foo') %>
+<%=raw s('foo') %>
+```
+
+## Configuration
+
+When you ran the install generator, a configuration file should have been created in config/initializers/static_blocks.rb:
+
+```ruby
+StaticBlocks.config do |config|
+  config.locales = ['en']
+  config.http_auth = false
+  config.username = ENV['STATIC_BLOCKS_USERNAME']
+  config.password = ENV['STATIC_BLOCKS_PASSWORD']
+end
+```
+
+### i18n Internationalization
+
+Static Blocks supports i18n internationalization. Pass in an array of locales to it's config option:
+
+```ruby
+config.locales = ['en', 'wk', 'zh', 'pirate']
+```
+
+### Optional http basic authentication
+
+Static Blocks has an optional http basic authentication which is turned off by default. To activate, set the config option to true and create environment variables for the username and password.
+
+```ruby
+config.http_auth = true
+```
+
+## Credits
+Written by Travis Luong
+
+## License
+[MIT](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,33 @@
+#!/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    = 'StaticBlocks'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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

@@ -0,0 +1,17 @@
+// 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 .
+//= require bootstrap
+//= require bootstrap-wysihtml5

data/app/assets/javascripts/static_blocks/static_blocks.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/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/assets/stylesheets/static_blocks/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/static_blocks/static_blocks.css.scss

@@ -0,0 +1,14 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*= require bootstrap-wysihtml5
+*/
+@import "bootstrap";
+
+.wysihtml5 {
+  width: 100%;
+}
+
+.navbar .container {
+  width: 940px;
+}

data/app/controllers/static_blocks/application_controller.rb

@@ -0,0 +1,24 @@
+module StaticBlocks
+  class ApplicationController < ActionController::Base
+
+    if StaticBlocks.config.http_auth
+      http_basic_authenticate_with :name => StaticBlocks.config.username, :password => StaticBlocks.config.password
+    end
+
+    before_filter :set_locale
+
+    private
+
+    def set_locale
+      I18n.locale = params[:locale] if params[:locale].present?
+      # current_user.locale
+      # request.subdomain
+      # request.env["HTTP_ACCEPT_LANGUAGE"]
+      # request.remote_ip
+    end
+
+    def default_url_options(options = {})
+      {locale: I18n.locale}
+    end
+  end
+end

data/app/controllers/static_blocks/static_blocks_controller.rb

@@ -0,0 +1,88 @@
+require_dependency "static_blocks/application_controller"
+
+module StaticBlocks
+  class StaticBlocksController < ApplicationController
+    # GET /static_blocks
+    # GET /static_blocks.json
+    def index
+      @search = StaticBlock.search(params[:q])
+      @static_blocks = @search.result.page(params[:page]).per(10)
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render json: @static_blocks }
+      end
+    end
+
+    # GET /static_blocks/1
+    # GET /static_blocks/1.json
+    def show
+      @static_block = StaticBlock.find(params[:id])
+
+      respond_to do |format|
+        format.html # show.html.erb
+        format.json { render json: @static_block }
+      end
+    end
+
+    # GET /static_blocks/new
+    # GET /static_blocks/new.json
+    def new
+      @static_block = StaticBlock.new
+
+      respond_to do |format|
+        format.html # new.html.erb
+        format.json { render json: @static_block }
+      end
+    end
+
+    # GET /static_blocks/1/edit
+    def edit
+      @static_block = StaticBlock.find(params[:id])
+    end
+
+    # POST /static_blocks
+    # POST /static_blocks.json
+    def create
+      @static_block = StaticBlock.new(params[:static_block])
+
+      respond_to do |format|
+        if @static_block.save
+          format.html { redirect_to @static_block, notice: 'Static block was successfully created.' }
+          format.json { render json: @static_block, status: :created, location: @static_block }
+        else
+          format.html { render action: "new" }
+          format.json { render json: @static_block.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # PUT /static_blocks/1
+    # PUT /static_blocks/1.json
+    def update
+      @static_block = StaticBlock.find(params[:id])
+
+      respond_to do |format|
+        if @static_block.update_attributes(params[:static_block])
+          format.html { redirect_to @static_block, notice: 'Static block was successfully updated.' }
+          format.json { head :no_content }
+        else
+          format.html { render action: "edit" }
+          format.json { render json: @static_block.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /static_blocks/1
+    # DELETE /static_blocks/1.json
+    def destroy
+      @static_block = StaticBlock.find(params[:id])
+      @static_block.destroy
+
+      respond_to do |format|
+        format.html { redirect_to static_blocks_url }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/app/helpers/static_blocks/application_helper.rb

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

data/app/helpers/static_blocks/static_blocks_helper.rb

@@ -0,0 +1,4 @@
+module StaticBlocks
+  module StaticBlocksHelper
+  end
+end

data/app/models/static_blocks/static_block.rb

@@ -0,0 +1,16 @@
+module StaticBlocks
+  class StaticBlock < ActiveRecord::Base
+    attr_accessible :content, :status, :title
+    after_save :clear_cache
+    scope :published, where(:status => 'published')
+    translates :content
+
+    def to_s
+      content
+    end
+
+    def clear_cache
+      Rails.cache.delete("static_block::"+title)
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>StaticBlocks</title>
+  <%= stylesheet_link_tag    "static_blocks/application", :media => "all" %>
+  <%= javascript_include_tag "static_blocks/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+  <div class="navbar">
+    <div class="navbar-inner">
+      <div class="container">
+        <%= link_to "Static Blocks", static_blocks_path, :class => "brand" %>
+        <div class="nav-collapse collapse">
+          <ul class="nav pull-right">
+            <li><%= link_to "List", static_blocks_path %></li>
+            <li><%= link_to "New", new_static_block_path %></li>
+          </ul>
+        </div><!--/.nav-collapse -->
+      </div>
+    </div>
+  </div>
+
+  <div class="container">
+
+    <% flash.each do |name, msg| %>
+    <% if msg.is_a?(String) %>
+    <div class="alert alert-<%= name == :notice ? "success" : "error" %>">
+      <a class="close" data-dismiss="alert">&#215;</a>
+      <%= content_tag :div, msg, :id => "flash_#{name}" %>
+    </div>
+    <% end %>
+    <% end %>
+
+    <div id="locale">
+      Language
+
+      <% StaticBlocks.config.locales.each do |loc| %>
+        <%= link_to_unless_current loc, locale: loc %>
+      <% end %>
+    </div>
+
+    <%= yield %>
+
+  </div>
+
+  <script type="text/javascript">
+  $('.wysihtml5').each(function(i, elem) {
+    $(elem).wysihtml5({
+      html: true
+    });
+  });
+  </script>
+
+</body>
+</html>

data/app/views/static_blocks/static_blocks/_form.html.erb

@@ -0,0 +1,29 @@
+<%= form_for(@static_block) do |f| %>
+  <% if @static_block.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@static_block.errors.count, "error") %> prohibited this static_block from being saved:</h2>
+
+      <ul>
+      <% @static_block.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %>
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :content %>
+    <%= f.text_area :content, :class => 'wysihtml5' %>
+  </div>
+  <div class="field">
+    <%= f.label :status %>
+    <%= f.select(:status, [['Draft', 'draft'], ['Published', 'published']]) %>
+  </div>
+  <div class="actions">
+    <%= f.submit 'Submit', class: "btn btn-primary" %>
+  </div>
+<% end %>

data/app/views/static_blocks/static_blocks/edit.html.erb

@@ -0,0 +1,4 @@
+<h1>Editing static block</h1>
+
+<%= render 'form' %>
+

data/app/views/static_blocks/static_blocks/index.html.erb

@@ -0,0 +1,45 @@
+<h1>Listing static blocks</h1>
+
+<div class="well">
+  <%= search_form_for @search do |f| %>
+    <div class="field">
+      <%= f.label :title_cont, "Title contains" %>
+      <%= f.text_field :title_cont %>
+    </div>
+    <div class="field">
+      <%= f.label :content_cont, "Content contains" %>
+      <%= f.text_field :content_cont %>
+    </div>
+    <div class="field">
+      <%= f.label :status_cont, "Status contains" %>
+      <%= f.select(:status_cont, [['', ''], ['Draft', 'draft'], ['Published', 'published']]) %>
+    </div>
+    <div class="actions"><%= f.submit "Search" %></div>
+  <% end %>
+</div>
+
+<%= paginate @static_blocks, :theme => 'twitter-bootstrap' %>
+
+<table id="static-block-list" class="table table-striped">
+  <tr>
+    <th style="min-width: 60px;"><%= sort_link(@search, :title, "Title") %></th>
+    <th><%= sort_link(@search, :content, "Content") %></th>
+    <th style="min-width: 80px;"><%= sort_link(@search, :status, "Status") %></th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+  <% @static_blocks.each do |static_block| %>
+  <tr>
+    <td><%= static_block.title %></td>
+    <td><%= static_block.content %></td>
+    <td><%= static_block.status %></td>
+    <td><%= link_to 'Show', static_block_path(static_block), class: "btn btn-mini btn-success" %></td>
+    <td><%= link_to 'Edit', edit_static_block_path(static_block), class: "btn btn-mini btn-warning" %></td>
+    <td><%= link_to 'Destroy', static_block, class: "btn btn-mini btn-danger", method: :delete, data: { confirm: 'Are you sure?' } %></td>
+  </tr>
+  <% end %>
+</table>
+
+<%= paginate @static_blocks, :theme => 'twitter-bootstrap' %>

data/app/views/static_blocks/static_blocks/new.html.erb

@@ -0,0 +1,3 @@
+<h1>New static block</h1>
+
+<%= render 'form' %>

data/app/views/static_blocks/static_blocks/show.html.erb

@@ -0,0 +1,23 @@
+<h1>Showing Static Block</h1>
+
+<div>
+  <p>
+    <b>Title:</b>
+    <%= @static_block.title %>
+  </p>
+
+  <p>
+    <b>Status:</b>
+    <%= @static_block.status %>
+  </p>
+
+  <p>
+    <%= link_to 'Edit', edit_static_block_path(@static_block), class: "btn btn-primary btn-warning" %>
+  </p>
+</div>
+
+<hr>
+
+<div class="well">
+  <%= raw(@static_block.content) %>
+</div>

data/config/routes.rb

@@ -0,0 +1,4 @@
+StaticBlocks::Engine.routes.draw do
+  resources :static_blocks
+  root to: 'static_blocks#index'
+end

data/db/migrate/20130611042319_create_static_blocks_static_blocks.rb

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

data/db/migrate/20130612034816_create_static_block_translations.rb

@@ -0,0 +1,13 @@
+class CreateStaticBlockTranslations < ActiveRecord::Migration
+  def up
+    StaticBlocks::StaticBlock.create_translation_table!({
+      content: :text
+    }, {
+      migrate_data: true
+    })
+  end
+
+  def down
+    StaticBlock.drop_translation_table! migrate_data: true
+  end
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module StaticBlocks
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_static_blocks_config
+        copy_file "static_blocks_config_template.rb", "config/initializers/static_block.rb"
+      end
+
+      def copy_migrations
+        rake('static_blocks:install:migrations')
+      end
+    end
+  end
+end

data/lib/static_blocks/engine.rb

@@ -0,0 +1,36 @@
+require "jquery-rails"
+require "sass-rails"
+require "bootstrap-sass"
+require "bootstrap-wysihtml5-rails"
+require "ransack"
+require "kaminari"
+require "bootstrap-kaminari-views"
+require "globalize3"
+
+module StaticBlocks
+  class Engine < ::Rails::Engine
+    isolate_namespace StaticBlocks
+    config.generators.integration_tool :rspec
+    config.generators.test_framework :rspec
+
+    initializer "static_blocks.include_helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        helper StaticBlocks::StaticBlocksHelper
+      end
+    end
+  end
+
+  def self.config(&block)
+    unless defined? @@config
+      @@config ||= StaticBlocks::Engine::Configuration.new
+      @@config.locales = ['en']
+      @@config.http_auth = false
+      @@config.username = "admin"
+      @@config.password = "password"
+    end
+
+    yield @@config if block
+
+    return @@config
+  end
+end

data/lib/static_blocks/helpers.rb

@@ -0,0 +1,17 @@
+module StaticBlocks
+  module StaticBlocksHelper
+    def static_block_for(name, default = nil)
+      Rails.cache.fetch("static_block::"+name.to_s) do
+        StaticBlock.published.find_by_title(name.to_s).content || default || "StaticBlock for #{name.to_s} missing"
+      end
+    end
+
+    def static_block_published?(name)
+      Rails.cache.fetch("static_block::"+name.to_s) do
+        StaticBlock.published.find_by_title(name.to_s) || false
+      end
+    end
+
+    alias_method :s, :static_block_for
+  end
+end

data/lib/static_blocks/version.rb

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