static_blocks 0.1.1 → 1.0.0

data/README.md

@@ -1,6 +1,8 @@
 # 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.
+Static Blocks is an ultra light-weight CMS for Ruby on Rails.
+
+Create snippets of content. Place them anywhere in your views.
 
 ## Features
 * Simple admin interface
@@ -39,17 +41,17 @@ rake db:migrate
 Mount engine in routes.rb:
 
 ```ruby
-mount StaticBlocks::Engine => "/static_blocks_admin"
+mount StaticBlocks::Engine => "/static_blocks"
 ```
 
 ## Usage
 
-Visit `/static_blocks_admin` and create some static blocks.
+Visit `/static_blocks` 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.
+Use the `snippet_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 snippet_for('foo') %>
 <%=raw s('foo') %>
 ```
 
@@ -63,6 +65,7 @@ StaticBlocks.config do |config|
   config.http_auth = false
   config.username = ENV['STATIC_BLOCKS_USERNAME']
   config.password = ENV['STATIC_BLOCKS_PASSWORD']
+  config.wysihtml5 = true
 end
 ```
 
@@ -71,7 +74,7 @@ end
 Static Blocks supports i18n internationalization. Pass in an array of locales to it's config option:
 
 ```ruby
-config.locales = ['en', 'wk', 'zh', 'pirate']
+config.locales = ['en', 'wk', 'pirate']
 ```
 
 ### Optional http basic authentication
@@ -82,8 +85,11 @@ Static Blocks has an optional http basic authentication which is turned off by d
 config.http_auth = true
 ```
 
+### wysihtml5 editor
+Static Blocks uses the wysihtml5 editor which is turned on by default. To deactive, set the config option to false.
+
 ## Credits
-Written by Travis Luong
+Created by Travis Luong
 
 ## License
 [MIT](http://opensource.org/licenses/MIT)

data/app/controllers/static_blocks/application_controller.rb

@@ -11,10 +11,6 @@ module StaticBlocks
 
     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 = {})

data/app/controllers/static_blocks/{static_blocks_controller.rb → snippets_controller.rb}

@@ -1,14 +1,14 @@
 require_dependency "static_blocks/application_controller"
 
 module StaticBlocks
-  class StaticBlocksController < ApplicationController
+  class SnippetsController < ApplicationController
 
     def export
       t = Time.now.strftime('%Y%m%d%H%M%S')
       filename = "static-blocks-#{t}.csv"
       respond_to do |format|
         format.csv do
-          send_data StaticBlock.to_csv, :filename => filename
+          send_data Snippet.to_csv, :filename => filename
         end
       end
     end
@@ -18,7 +18,7 @@ module StaticBlocks
       filename = "static-blocks-translations-#{t}.csv"
       respond_to do |format|
         format.csv do
-          send_data StaticBlock.translations_to_csv, :filename => filename
+          send_data Snippet.translations_to_csv, :filename => filename
         end
       end
     end
@@ -31,7 +31,7 @@ module StaticBlocks
         redirect_to root_url
         flash[:error] = "Wrong file. You uploaded the translations."
       else
-        StaticBlock.import(params[:file])
+        Snippet.import(params[:file])
         redirect_to root_url, notice: "Static Blocks imported"
       end
     end
@@ -41,7 +41,7 @@ module StaticBlocks
         redirect_to root_url
         flash[:error] = "You did not attach a file."
       elsif params[:file].original_filename.include? 'translations'
-        StaticBlock.import_translations(params[:file])
+        Snippet.import_translations(params[:file])
         redirect_to root_url, notice: "Static Block translations imported"
       else
         redirect_to root_url
@@ -52,82 +52,82 @@ module StaticBlocks
     # GET /static_blocks
     # GET /static_blocks.json
     def index
-      @search = StaticBlock.order('title asc').search(params[:q])
-      @static_blocks = @search.result.per_page_kaminari(params[:page]).per(10)
+      @search = Snippet.order('title asc').search(params[:q])
+      @snippets = @search.result.per_page_kaminari(params[:page]).per(10)
 
       respond_to do |format|
         format.html # index.html.erb
-        format.json { render json: @static_blocks }
+        format.json { render json: @snippets }
       end
     end
 
-    # GET /static_blocks/1
-    # GET /static_blocks/1.json
+    # GET /snippets/1
+    # GET /snippets/1.json
     def show
-      @static_block = StaticBlock.find(params[:id])
+      @snippet = Snippet.find(params[:id])
 
       respond_to do |format|
         format.html # show.html.erb
-        format.json { render json: @static_block }
+        format.json { render json: @snippet }
       end
     end
 
-    # GET /static_blocks/new
-    # GET /static_blocks/new.json
+    # GET /snippets/new
+    # GET /snippets/new.json
     def new
-      @static_block = StaticBlock.new
+      @snippet = Snippet.new
 
       respond_to do |format|
         format.html # new.html.erb
-        format.json { render json: @static_block }
+        format.json { render json: @snippet }
       end
     end
 
-    # GET /static_blocks/1/edit
+    # GET /snippets/1/edit
     def edit
-      @static_block = StaticBlock.find(params[:id])
+      @snippet = Snippet.find(params[:id])
     end
 
-    # POST /static_blocks
-    # POST /static_blocks.json
+    # POST /snippets
+    # POST /snippets.json
     def create
-      @static_block = StaticBlock.new(params[:static_block])
+      @snippet = Snippet.new(params[:snippet])
 
       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 }
+        if @snippet.save
+          format.html { redirect_to @snippet, notice: 'Snippet was successfully created.' }
+          format.json { render json: @snippet, status: :created, location: @snippet }
         else
           format.html { render action: "new" }
-          format.json { render json: @static_block.errors, status: :unprocessable_entity }
+          format.json { render json: @snippet.errors, status: :unprocessable_entity }
         end
       end
     end
 
-    # PUT /static_blocks/1
-    # PUT /static_blocks/1.json
+    # PUT /snippets/1
+    # PUT /snippets/1.json
     def update
-      @static_block = StaticBlock.find(params[:id])
+      @snippet = Snippet.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.' }
+        if @snippet.update_attributes(params[:snippet])
+          format.html { redirect_to @snippet, 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 }
+          format.json { render json: @snippet.errors, status: :unprocessable_entity }
         end
       end
     end
 
-    # DELETE /static_blocks/1
-    # DELETE /static_blocks/1.json
+    # DELETE /snippets/1
+    # DELETE /snippets/1.json
     def destroy
-      @static_block = StaticBlock.find(params[:id])
-      @static_block.destroy
+      @snippet = Snippet.find(params[:id])
+      @snippet.destroy
 
       respond_to do |format|
-        format.html { redirect_to static_blocks_url }
+        format.html { redirect_to snippets_url }
         format.json { head :no_content }
       end
     end

data/app/models/static_blocks/{static_block.rb → snippet.rb}

@@ -1,5 +1,5 @@
 module StaticBlocks
-  class StaticBlock < ActiveRecord::Base
+  class Snippet < ActiveRecord::Base
     attr_accessible :content, :status, :title
     after_save :clear_cache
     scope :published, where(:status => 'published')
@@ -11,22 +11,22 @@ module StaticBlocks
     end
 
     def clear_cache
-      Rails.cache.delete("static_block::"+I18n.locale.to_s+"::"+title)
+      Rails.cache.delete("snippet::"+I18n.locale.to_s+"::"+title)
     end
 
     def self.to_csv(options = {})
-      static_blocks = self.connection.select_all('select * from static_blocks_static_blocks')
-      static_blocks_column_names = static_blocks.first.keys
+      snippets = self.connection.select_all('select * from static_blocks_snippets')
+      snippets_column_names = snippets.first.keys
       CSV.generate(options) do |csv|
-        csv << static_blocks_column_names
-        static_blocks.each do |s|
-          csv << s.values_at(*static_blocks_column_names)
+        csv << snippets_column_names
+        snippets.each do |s|
+          csv << s.values_at(*snippets_column_names)
         end
       end
     end
 
     def self.translations_to_csv(options = {})
-      translations = self.connection.select_all('select * from static_blocks_static_block_translations')
+      translations = self.connection.select_all('select * from static_blocks_snippet_translations')
       translation_column_names = translations.first.keys
       CSV.generate(options) do |csv|
         csv << translation_column_names
@@ -38,30 +38,30 @@ module StaticBlocks
 
     def self.import(file)
       CSV.foreach(file.path, headers: true) do |row|
-        static_block = find_by_title(row["title"]) || new
-        static_block.attributes = row.to_hash.slice(*accessible_attributes)
-        static_block.id = row['id']
-        static_block.save!
+        snippet = find_by_title(row["title"]) || new
+        snippet.attributes = row.to_hash.slice(*accessible_attributes)
+        snippet.id = row['id']
+        snippet.save!
       end
     end
 
     def self.import_translations(file)
       CSV.foreach(file.path, headers: true) do |row|
         # find translation
-        raw_sql = "SELECT * FROM static_blocks_static_block_translations WHERE id=#{row['id']}"
+        raw_sql = "SELECT * FROM static_blocks_snippet_translations WHERE id=#{row['id']}"
         translation = ActiveRecord::Base.connection.execute(raw_sql)
         if translation.present?
           # update existing translation
           raw_sql = "
-          UPDATE static_blocks_static_block_translations
-          SET static_blocks_static_block_id=%d, locale='%s', content='%s', created_at='%s', updated_at='%s'
-          WHERE id=%d" % [row['static_blocks_static_block_id'], row['locale'], row['content'], row['created_at'], row['updated_at'], row['id']]
+          UPDATE static_blocks_snippet_translations
+          SET static_blocks_snippet_id=%d, locale='%s', content='%s', created_at='%s', updated_at='%s'
+          WHERE id=%d" % [row['static_blocks_snippet_id'], row['locale'], row['content'], row['created_at'], row['updated_at'], row['id']]
         else
           # create new translation
           raw_sql = "
-          INSERT INTO static_blocks_static_block_translations
-          ('id', 'static_blocks_static_block_id', 'locale', 'content', 'created_at', 'updated_at') VALUES
-          ('%d', '%d', '%s', '%s', '%s', '%s')" % [row['id'], row['static_blocks_static_block_id'], row['locale'], row['content'], row['created_at'], row['updated_at']]
+          INSERT INTO static_blocks_snippet_translations
+          ('id', 'static_blocks_snippet_id', 'locale', 'content', 'created_at', 'updated_at') VALUES
+          ('%d', '%d', '%s', '%s', '%s', '%s')" % [row['id'], row['static_blocks_snippet_id'], row['locale'], row['content'], row['created_at'], row['updated_at']]
         end
         ActiveRecord::Base.connection.execute(raw_sql)
       end

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

@@ -11,13 +11,13 @@
   <div class="navbar">
     <div class="navbar-inner">
       <div class="container">
-        <%= link_to "Static Blocks", static_blocks_path, :class => "brand" %>
+        <%= link_to "Static Blocks", snippets_path, :class => "brand" %>
         <div class="nav-collapse collapse">
           <ul class="nav pull-right">
-            <li><%= link_to "List blocks", static_blocks_path %></li>
-            <li><%= link_to "New block", new_static_block_path %></li>
-            <li><%= link_to "Export", export_static_blocks_path(:format => :csv) %></li>
-            <li><%= link_to "Export translations", export_translations_static_blocks_path(:format => :csv) %></li> </ul>
+            <li><%= link_to "List blocks", snippets_path %></li>
+            <li><%= link_to "New block", new_snippet_path %></li>
+            <li><%= link_to "Export", export_snippets_path(:format => :csv) %></li>
+            <li><%= link_to "Export translations", export_translations_snippets_path(:format => :csv) %></li> </ul>
         </div><!--/.nav-collapse -->
       </div>
     </div>
@@ -34,11 +34,11 @@
     <% end %>
     <% end %>
 
-    <div id="locale">
-      Language
+    <div id="locale" class="well well-small">
+      <strong>Language:</strong>
 
       <% StaticBlocks.config.locales.each do |loc| %>
-        <%= link_to_unless_current loc, locale: loc %>
+        &nbsp;<%= link_to_unless_current loc, locale: loc %>
       <% end %>
     </div>
 
@@ -46,6 +46,7 @@
 
   </div>
 
+  <% if StaticBlocks.config.wysihtml5 %>
   <script type="text/javascript">
   $('.wysihtml5').each(function(i, elem) {
     $(elem).wysihtml5({
@@ -53,6 +54,7 @@
     });
   });
   </script>
+  <% end %>
 
 </body>
 </html>

data/app/views/static_blocks/{static_blocks → snippets}/_form.html.erb

@@ -1,10 +1,10 @@
-<%= form_for(@static_block) do |f| %>
-  <% if @static_block.errors.any? %>
+<%= form_for(@snippet) do |f| %>
+  <% if @snippet.errors.any? %>
     <div id="error_explanation">
-      <h2><%= pluralize(@static_block.errors.count, "error") %> prohibited this static_block from being saved:</h2>
+      <h2><%= pluralize(@snippet.errors.count, "error") %> prohibited this snippet from being saved:</h2>
 
       <ul>
-      <% @static_block.errors.full_messages.each do |msg| %>
+      <% @snippet.errors.full_messages.each do |msg| %>
         <li><%= msg %></li>
       <% end %>
       </ul>

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

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

data/app/views/static_blocks/{static_blocks → snippets}/index.html.erb

@@ -1,4 +1,4 @@
-<h1>Listing static blocks</h1>
+<h1>Listing snippets</h1>
 <div class="row">
 <div class="span6">
   <h2>Search</h2>
@@ -8,8 +8,8 @@
       <%= f.text_field :title_cont %>
     </div>
     <div class="field">
-      <%= f.label :content_cont, "Content contains" %>
-      <%= f.text_field :content_cont %>
+      <%= f.label :translations_content_cont, "Content contains" %>
+      <%= f.text_field :translations_content_cont %>
     </div>
     <div class="field">
       <%= f.label :status_cont, "Status contains" %>
@@ -20,19 +20,19 @@
 </div>
 <div class="span6">
   <h2>Import</h2>
-  <%= form_tag import_static_blocks_path, multipart: true do %>
+  <%= form_tag import_snippets_path, multipart: true do %>
     <%= file_field_tag :file %>
     <%= submit_tag "Import" %>
   <% end %>
   <h2>Import Translations</h2>
-  <%= form_tag import_translations_static_blocks_path, multipart: true do %>
+  <%= form_tag import_translations_snippets_path, multipart: true do %>
     <%= file_field_tag :file %>
     <%= submit_tag "Import Translations" %>
   <% end %>
 </div>
 </div>
 
-<%= paginate @static_blocks, :theme => 'twitter-bootstrap' %>
+<%= paginate @snippets, :theme => 'twitter-bootstrap' %>
 
 <table id="static-block-list" class="table table-striped">
   <tr>
@@ -44,16 +44,16 @@
     <th></th>
   </tr>
 
-  <% @static_blocks.each do |static_block| %>
+  <% @snippets.each do |snippet| %>
   <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>
+    <td><%= snippet.title %></td>
+    <td><%= snippet.content %></td>
+    <td><%= snippet.status %></td>
+    <td><%= link_to 'Show', snippet_path(snippet), class: "btn btn-mini btn-success" %></td>
+    <td><%= link_to 'Edit', edit_snippet_path(snippet), class: "btn btn-mini btn-warning" %></td>
+    <td><%= link_to 'Destroy', snippet, class: "btn btn-mini btn-danger", method: :delete, data: { confirm: 'Are you sure?' } %></td>
   </tr>
   <% end %>
 </table>
 
-<%= paginate @static_blocks, :theme => 'twitter-bootstrap' %>
+<%= paginate @snippets, :theme => 'twitter-bootstrap' %>

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

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