tkh_admin_panel 0.1.1 → 0.2

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 
 
+## 0.2
+
+* Added german locale and translations. Upgrader need to run the update task and run migrations
+* Added a site settings scaffold to be used throughout the whole app
+* Improved style of forms
+
+
 ## 0.1.1
 
 * Cleaned up CSS file

data/README.md

@@ -2,9 +2,7 @@
 
 This is a Rails engine with an admin panel layout, assets and basic functionality. Powered by Twitter Bootstrap + SASS for a modern responsive design.
 
-Primarily developed for Ten Thousand Hours but we are happy to share if anybody finds it useful.
-
-It's primarily developed to work in sync with the tkh_cms gem suite but over time more and more effort will be made to make it work in isolation.
+Primarily developed for Ten Thousand Hours but we are happy to share if anybody finds it useful. It's primarily developed to work in sync with the tkh_cms gem suite but over time more and more effort will be made to make it work in isolation.
 
 Please note that this gem is still in its infancy. I'm just getting started. 
 
@@ -21,6 +19,10 @@ And then execute:
 Install the admin_sidebar partial
 
 		$ rake tkh_admin_panel:setup
+		
+Run the migrations
+		
+		$ rake db:migrate
 
 Start or restart your server!
 
@@ -36,6 +38,10 @@ Update the gem:
 Update locale files.
 
 		$ rake tkh_admin_panel:update
+		
+Run new migrations if any
+		
+		$ rake db:migrate
 
 Start or restart your server!
 

data/app/assets/stylesheets/admin.css.scss

@@ -12,4 +12,13 @@ input, textarea {
 .login-info {
 	margin: 1em;
 	text-align: left;
+}
+
+form {
+	margin: 2em .5em;
+}
+
+.form-horizontal .help-block {
+	color: #999;
+	margin-top: 1px;
 }

data/app/controllers/settings_controller.rb

@@ -0,0 +1,24 @@
+class SettingsController < ApplicationController
+  
+  before_filter :authenticate
+  before_filter :authenticate_with_admin
+  
+  def show
+    @setting = Setting.first
+    switch_to_admin_layout
+  end
+  
+  def edit
+    @setting = Setting.first
+    switch_to_admin_layout
+  end
+  
+  def update
+    @setting = Setting.first
+    if @setting.update_attributes(params[:setting])
+      redirect_to @setting, notice: 'Settings were successfully updated.'
+    else
+      render action: "edit", layout: 'admin'
+    end
+  end
+end

data/app/models/setting.rb

@@ -0,0 +1,12 @@
+# this is needed for now to make mass assignment security compatible with the translation of globalize3
+Globalize::ActiveRecord::Translation.class_eval do
+  attr_accessible :locale
+end
+
+class Setting < ActiveRecord::Base
+  
+  attr_accessible :site_name, :site_tagline, :blog_name, :blog_tagline, :disable_blog, :enable_comments_in_pages, :enable_comments_in_blog
+  
+  translates :site_name, :site_tagline, :blog_name, :blog_tagline
+  
+end

data/app/views/layouts/admin.html.erb

@@ -4,7 +4,9 @@
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 		<title>
-			<% if defined?(APP_SETTINGS) && APP_SETTINGS['site_name'] %>
+			<% if defined?(Setting) && !Setting.first.site_name.blank? %>
+				<%= t("admin_panel_for") + ' ' + Setting.first.site_name %>
+			<% elsif defined?(APP_SETTINGS) && APP_SETTINGS['site_name'] %>
 				<%= t("admin_panel_for") + ' ' + APP_SETTINGS['site_name'] %>
 			<% else %>
 				<%= t 'admin_panel' %>
@@ -31,8 +33,10 @@
 				<div class="span12">
 					<%= render 'shared/login_info' %>
 					<h1>
-						<% if defined?(APP_SETTINGS) && APP_SETTINGS['site_name'] %>
-							<%= (t("admin_panel_for") + ' ' + link_to(APP_SETTINGS['site_name'], root_path)).html_safe %>
+						<% if defined?(Setting) && !Setting.first.site_name.blank? %>
+							<%= (t("admin_panel_for") + ' ' + link_to(Setting.first.site_name, root_path)).html_safe %>
+						<% elsif defined?(APP_SETTINGS) && APP_SETTINGS['site_name'] %>
+							<%= t("admin_panel_for") + ' ' + APP_SETTINGS['site_name'] %>
 						<% else %>
 							<%= t 'admin_panel' %>
 						<% end %>

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

@@ -0,0 +1,22 @@
+<h1>Edit Settings</h1>
+
+<%= simple_form_for @setting, :html => { class: 'form-horizontal' } do |f| %>
+	<%= f.error_notification %>
+	
+  <div class="form-inputs">
+		<%= f.input :site_name %><br />
+		<%= f.input :site_tagline, hint: 'a small descriptive sentence' %><br />
+		<%= f.input :enable_comments_in_pages, as: :boolean, inline_label: true, label: false  %><br />
+		<%= f.input :disable_blog, as: :boolean, inline_label: true, label: false, hint: 'should be checked if you do NOT want a blog' %><br />
+		<%= f.input :blog_name %><br />
+		<%= f.input :blog_tagline, hint: 'a small descriptive sentence' %><br />
+		<%= f.input :enable_comments_in_blog, as: :boolean, inline_label: true, label: false  %>
+	</div>
+	
+  <div class="form-actions">
+    <%= f.button :submit, :class => 'btn btn-primary' %>
+  </div>
+
+<% end %>
+
+<%= render 'shared/admin_sidebar' %>

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

@@ -0,0 +1,15 @@
+<h1>Settings</h1>
+
+<p>
+	<strong>Site name:</strong> <%= @setting.site_name %><br />
+	<strong>Site tagline:</strong> <%= @setting.site_tagline %><br />
+	<strong>Enable comments in pages?:</strong> <%= @setting.enable_comments_in_pages? ? "<span class=\"label label-success\">✓</span>".html_safe : "<span class=\"label label-important\">X</span>".html_safe %><br />
+	<strong>Blog enabled?:</strong> <%= @setting.disable_blog? ? "<span class=\"label label-important\">X</span>".html_safe : "<span class=\"label label-success\">✓</span>".html_safe %><br />
+	<strong>Blog name:</strong> <%= @setting.blog_name %><br />
+	<strong>Site name:</strong> <%= @setting.blog_tagline %><br />
+	<strong>Enable comments in blog?:</strong> <%= @setting.enable_comments_in_blog? ? "<span class=\"label label-success\">✓</span>".html_safe : "<span class=\"label label-important\">X</span>".html_safe %>
+</p>
+
+<%= link_to t('edit'), edit_setting_path(@setting), class: 'btn btn-primary' %>
+
+<%= render 'shared/admin_sidebar' %>

data/app/views/shared/_admin_sidebar.html.erb

@@ -1,7 +1,8 @@
 <% content_for :admin_sidebar do %>
 	<h2>Sections</h2>
 	<ul>
-		<li>links go here</li>
+		<li><%= link_to 'site settings', setting_path(1) %></li>
+		<li>other links go here</li>
 	</ul>
 	
 	<p>To override this, run "rake tkh_admin_panel:setup" and customize the new partial to your liking.</p>

data/app/views/shared/_language_switcher.html.erb

@@ -1,7 +1,8 @@
 <% def full_language_name( lang = :en) %>  
 	<% list = { :en => 'English', 
 							:fr => 'Français', 
-							:es => 'Español'
+							:es => 'Español',
+							:de => 'Deutch'
 						}
 	%>
   <% list[lang] %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  scope "(:locale)", locale: /#{I18n.available_locales.join("|")}/ do
+    resources :settings
+  end
+end

data/lib/generators/tkh_admin_panel/copy_files/templates/_admin_sidebar.html.erb

@@ -1,6 +1,7 @@
 <% content_for :admin_sidebar do %>
 	<h2>Sections</h2>
 	<ul>
+		<li><%= link_to 'site settings', setting_path(1) %></li>
 		<li><%= link_to 'scaffold name', 'path' %></li>
 		<li>for example ...</li>
 		<li><%= link_to 'pages', pages_path %></li>

data/lib/generators/tkh_admin_panel/create_or_update_locales/templates/de.yml

@@ -0,0 +1,3 @@
+de:
+  admin_panel: 'Administrator-Schaltfläche'
+  admin_panel_for: "Administrator-Schaltfläche für"

data/lib/generators/tkh_admin_panel/create_or_update_migrations/create_or_update_migrations_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+ 
+module TkhAdminPanel
+  module Generators
+    class CreateOrUpdateMigrationsGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "create or update setting migrations"
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+ 
+      def copy_migrations
+        puts 'creating or updating setting migrations'
+        migration_template "create_settings.rb", "db/migrate/create_settings.rb"
+      end
+ 
+    end
+  end
+end

data/lib/generators/tkh_admin_panel/create_or_update_migrations/templates/create_settings.rb

@@ -0,0 +1,32 @@
+class CreateSettings < ActiveRecord::Migration
+  
+  def self.up
+    create_table :settings do |t|
+      t.string :site_name
+      t.string :site_tagline
+      t.boolean :enable_comments_in_pages, default: false
+      t.boolean :disable_blog, default: false
+      t.string :blog_name
+      t.string :blog_tagline
+      t.boolean :enable_comments_in_blog, default: true
+      t.timestamps
+    end
+    Setting.create_translation_table! :site_name => :string, :site_tagline => :string, :blog_name => :string, :blog_tagline => :string
+    # normally it's not a good idea to populate a table in the migration but I think this is an exception
+    Setting.create([
+      { site_name: 'Name of the web site',
+        site_tagline: 'A short descriptive sentence',
+        enable_comments_in_pages: false,
+        disable_blog: false,
+        blog_name: 'Name of the blog',
+        blog_tagline: "A short descriptive sentence",
+        enable_comments_in_blog: true
+      }
+    ])
+  end
+  
+  def self.down
+    drop_table :settings
+    Setting.drop_translation_table!
+  end
+end

data/lib/tasks/tkh_admin_panel_tasks.rake

@@ -4,11 +4,13 @@ namespace :tkh_admin_panel do
   task :setup do
     system 'rails g tkh_admin_panel:copy_files -f'
     system 'rails g tkh_admin_panel:create_or_update_locales -f'
+    system 'rails g tkh_admin_panel:create_or_update_migrations'
   end
   
   desc "Update locale and other files"
   task :update do
     system 'rails g tkh_admin_panel:copy_files -s'
     system 'rails g tkh_admin_panel:create_or_update_locales -f'
+    system 'rails g tkh_admin_panel:create_or_update_migrations -s'
   end
 end

data/lib/tkh_admin_panel/version.rb

@@ -1,3 +1,3 @@
 module TkhAdminPanel
-  VERSION = "0.1.1"
+  VERSION = "0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tkh_admin_panel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2012-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -77,15 +77,23 @@ files:
 - app/assets/javascripts/custom.js.coffee
 - app/assets/stylesheets/admin.css.scss
 - app/assets/stylesheets/bootstrap_and_overrides.css.scss
+- app/controllers/settings_controller.rb
+- app/models/setting.rb
 - app/views/layouts/admin.html.erb
+- app/views/settings/edit.html.erb
+- app/views/settings/show.html.erb
 - app/views/shared/_admin_sidebar.html.erb
 - app/views/shared/_language_switcher.html.erb
+- config/routes.rb
 - lib/generators/tkh_admin_panel/copy_files/copy_files_generator.rb
 - lib/generators/tkh_admin_panel/copy_files/templates/_admin_sidebar.html.erb
 - lib/generators/tkh_admin_panel/create_or_update_locales/create_or_update_locales_generator.rb
+- lib/generators/tkh_admin_panel/create_or_update_locales/templates/de.yml
 - lib/generators/tkh_admin_panel/create_or_update_locales/templates/en.yml
 - lib/generators/tkh_admin_panel/create_or_update_locales/templates/es.yml
 - lib/generators/tkh_admin_panel/create_or_update_locales/templates/fr.yml
+- lib/generators/tkh_admin_panel/create_or_update_migrations/create_or_update_migrations_generator.rb
+- lib/generators/tkh_admin_panel/create_or_update_migrations/templates/create_settings.rb
 - lib/tasks/tkh_admin_panel_tasks.rake
 - lib/tkh_admin_panel.rb
 - lib/tkh_admin_panel/tkh_admin_panel_action_controller_extension.rb