static_blocks 1.0.3 → 1.1.0

data/README.md

@@ -1,12 +1,12 @@
 # Static Blocks
 
-Static Blocks is an ultra light-weight CMS for Ruby on Rails.
+Static Blocks is a light-weight CMS for Ruby on Rails.
 
 Create snippets of content. Place them anywhere in your views.
 
 ## Features
 * Simple admin interface
-* i18n internationalization support
+* i18n multilingual support
 * Optional http basic authentication
 * Search
 * wysihtml5 editor
@@ -14,19 +14,19 @@ Create snippets of content. Place them anywhere in your views.
 
 ## Installation
 
-Add the following to Gemfile:
+Add the following to `Gemfile`:
 
 ```ruby
 gem 'static_blocks'
 ```
 
-Run bundle from shell:
+Run bundle:
 
 ```shell
 bundle install
 ```
 
-Run static blocks install generator from shell:
+Run static blocks install generator:
 
 ```shell
 rails generate static_blocks:install
@@ -38,7 +38,7 @@ Run migrations:
 rake db:migrate
 ```
 
-Ensure that engine is mounted in routes.rb:
+Check that Engine has been mounted in `config/routes.rb`:
 
 ```ruby
 mount StaticBlocks::Engine => "/static_blocks"
@@ -57,36 +57,65 @@ Use the `snippet_for` method or it's alias `s` to output a block onto any view t
 
 ## Configuration
 
-When you ran the install generator, a configuration file should have been created in config/initializers/static_blocks.rb:
+During installation, 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']
   config.wysihtml5 = true
+  config.globalize = false
+  config.locales = ['en']
 end
 ```
 
 ### i18n Internationalization
 
-Static Blocks supports i18n internationalization. Pass in an array of locales to it's config option:
+Static Blocks supports i18n internationalization. To active, follow the steps below:
+
+#### Step 1
+
+Set globalize option to true.
+
+```ruby
+config.globalize = true
+```
+
+#### Step 2
+
+Pass in an array of locales.
 
 ```ruby
 config.locales = ['en', 'wk', 'pirate']
 ```
 
+#### Step 3
+
+Skip this step if you are starting without any existing snippets. If you are enabling i18n on a site with existing snippets, you must export and import the snippets in order to copy them to the default locale.
+
 ### 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.
+Static Blocks has an optional http basic authentication which is turned off by default. To activate, set the http_auth option to true and create environment variables for the username and password.
 
 ```ruby
 config.http_auth = true
 ```
 
+If you are using Devise and prefer to use that instead, you could probably do something like this in `config/routes.rb`:
+
+```ruby
+authenticate :admin_user do
+  mount StaticBlocks::Engine => "/static_blocks"
+end
+```
+
 ### wysihtml5 editor
-Static Blocks uses the wysihtml5 editor which is turned on by default. To deactive, set the config option to false.
+Static Blocks uses the wysihtml5 editor which is turned on by default. To deactive, set the wysihtml5 option to false.
+
+```ruby
+config.wysihtml5 = false
+```
 
 ## Credits
 Created by Travis Luong

data/app/controllers/static_blocks/snippets_controller.rb

@@ -67,7 +67,7 @@ module StaticBlocks
     # GET /static_blocks.json
     def index
       @search = Snippet.order('title asc').search(params[:q])
-      @snippets = @search.result.per_page_kaminari(params[:page]).per(10)
+      @snippets = @search.result(distinct: true).per_page_kaminari(params[:page]).per(10)
 
       respond_to do |format|
         format.html # index.html.erb

data/app/models/static_blocks/snippet.rb

@@ -3,7 +3,7 @@ module StaticBlocks
     attr_accessible :content, :status, :title
     after_save :clear_cache
     scope :published, where(:status => 'published')
-    translates :content
+    translates :content if StaticBlocks.config.globalize
     validates :title, uniqueness: true
 
     def to_s

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

@@ -17,7 +17,9 @@
             <li><%= link_to "List snippets", snippets_path %></li>
             <li><%= link_to "New snippet", new_snippet_path %></li>
             <li><%= link_to "Export snippets", export_snippets_path(:format => :csv) %></li>
-            <li><%= link_to "Export translations", export_translations_snippets_path(:format => :csv) %></li> </ul>
+            <% if StaticBlocks.config.globalize %>
+              <li><%= link_to "Export translations", export_translations_snippets_path(:format => :csv) %></li> </ul>
+            <% end %>
         </div><!--/.nav-collapse -->
       </div>
     </div>
@@ -34,13 +36,15 @@
     <% end %>
     <% end %>
 
-    <div id="locale" class="well well-small">
-      <strong>Locale:</strong>
+    <% if StaticBlocks.config.globalize %>
+      <div id="locale" class="well well-small">
+        <strong>Locale:</strong>
 
-      <% StaticBlocks.config.locales.each do |loc| %>
-        &nbsp;<%= link_to_unless_current loc, locale: loc %>
-      <% end %>
-    </div>
+        <% StaticBlocks.config.locales.each do |loc| %>
+          &nbsp;<%= link_to_unless_current loc, locale: loc %>
+        <% end %>
+      </div>
+    <% end %>
 
     <%= yield %>
 

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

@@ -0,0 +1,37 @@
+<% if StaticBlocks.config.globalize %>
+
+  <%= 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 :translations_content_cont, "Content contains" %>
+      <%= f.text_field :translations_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 %>
+
+<% else %>
+
+  <%= 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 %>
+
+<% end %>

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

@@ -2,21 +2,7 @@
 <div class="row">
 <div class="span6">
   <h2>Search</h2>
-  <%= 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 :translations_content_cont, "Content contains" %>
-      <%= f.text_field :translations_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 %>
+  <%= render 'search' %>
 </div>
 <div class="span6">
   <h2>Import snippets</h2>
@@ -24,10 +10,12 @@
     <%= file_field_tag :file %>
     <%= submit_tag "Import snippets" %>
   <% end %>
-  <h2>Import translations</h2>
-  <%= form_tag import_translations_snippets_path, multipart: true do %>
-    <%= file_field_tag :file %>
-    <%= submit_tag "Import translations" %>
+  <% if StaticBlocks.config.globalize %>
+    <h2>Import translations</h2>
+    <%= form_tag import_translations_snippets_path, multipart: true do %>
+      <%= file_field_tag :file %>
+      <%= submit_tag "Import translations" %>
+    <% end %>
   <% end %>
   <p class="help-block">*If you are using translations, you must import snippets first and then translations.</p>
 </div>

data/lib/static_blocks/engine.rb

@@ -24,11 +24,12 @@ module StaticBlocks
   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"
       @@config.wysihtml5 = true
+      @@config.globalize = false
+      @@config.locales = ['en']
     end
 
     yield @@config if block

data/lib/static_blocks/version.rb

@@ -1,3 +1,3 @@
 module StaticBlocks
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/templates/static_blocks_config_template.rb

@@ -1,7 +1,8 @@
 StaticBlocks.config do |config|
-  config.locales = ['en']
   config.http_auth = false
   config.username = ENV['STATIC_BLOCKS_USERNAME']
   config.password = ENV['STATIC_BLOCKS_PASSWORD']
   config.wysihtml5 = true
+  config.globalize = false
+  config.locales = ['en']
 end

data/spec/dummy/config/initializers/static_blocks.rb

@@ -1,7 +1,8 @@
 StaticBlocks.config do |config|
-  config.locales = ['en', 'wk']
   config.http_auth = false
   config.username = "frodo"
   config.password = "thering"
   config.wysihtml5 = true
+  config.globalize = true
+  config.locales = ['en', 'wk']
 end