kuhsaft 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dece1070f1406b31773243d2f070e48387f15a27
-  data.tar.gz: 22cb559490bc2b7e86eb92a475eb1ef9f7939d06
+  metadata.gz: a644e28bc6049a19a8878e3476d648d7257000e2
+  data.tar.gz: dd5345fd7f913827a6efb2056cd9f79dfb598f36
 SHA512:
-  metadata.gz: b0ba82b69049bbaa1ca7a62fa0d2c156f86908b4114a891e35db58320c7455b774e46c706bcb5df9a8244aef26b9ab97d25a14a002948f6a97a4b5489e5c0f6a
-  data.tar.gz: a6c5464e5cbeea1fc505bc53582fab6bfde81cba649d7bd4cfcee16f3c8c052243d56b934452eb40a9ddea2f14162fa65de87a590bef53dcaad5e91ce0d99f7e
+  metadata.gz: a884c25283286b6a15e7b450e6467b870d9220c0e940af760ead60e369fb1a8a6ffaf1a8119d267c0b1ee7743a4f5b216810f0522fb0fc8ab620531198218daa
+  data.tar.gz: 95fb7cce42f9f7919ea94a4da3e9d47096e15651f32b56ddca2d188c84db3c9f104c1078dac92ae575a078c9c144adf384c21f40f16e32d0bfd254d36a3c1364

data/README.md

@@ -10,7 +10,7 @@ Kuhsaft is made by some Rails developers at Screen Concept that got tired of
 fiddling with unusable content management sytems. We are trying hard to make a
 minimalistic and developer friendly CMS. Our goal is to provide a system for
 ourselves and our customers that makes the of-the-shelf website project a
-hasselfree thing. On one side easy to set up, integrate and customize (good for
+hasslefree thing. On one side easy to set up, integrate and customize (good for
 devs) on the other hand it should be easily usable by anyone.
 
 ## What's in it
@@ -99,11 +99,10 @@ Make sure they are in the `config.assets.precompile` array in environments like
 
 There's a dummy app inside spec/dummy. Get it running by executing the following steps:
 
-* remove eventual migrations inside `spec/dummy/db/migrate`
-* run `rake kuhsaft:install:migrations` again
-* run `rake db:migrate` and `rake db:seed`
-
-Start up the dummy app. The first two steps also make sure you're ready to run `rspec spec` to run the test suite. (Todo: This workflow must be improved))
+```
+rake setup
+rake start_dummy
+```
 
 # Usage
 
@@ -199,6 +198,78 @@ Finally, add the new translation locale to your `available_locales` inside your
 
     config.available_locales = [:en, :fr]
 
+## Adding a language switch
+
+Add scope around routes:
+
+    scope "(:locale)", locale: /de|en|fr/ do
+      root 'kuhsaft/pages#show'
+    end
+
+Set the locale in the ApplicationController in a before_action and set default url options:
+
+    before_action :set_locale
+
+    def set_locale
+      if I18n.available_locales.map{|sym| sym.to_s }.include?(params[:locale])
+        I18n.locale = params[:locale]
+      else
+        I18n.locale = I18n.default_locale
+      end
+    end
+
+    def default_url_options(options={})
+      { locale: I18n.locale }
+    end
+
+Add method to ApplicationHelper which redirects to homepage when current page is not translated.
+Make sure to have the homepage translated in every available language.
+
+    def localized_url(url, target_locale)
+      page = Kuhsaft::Page.find_by_url("#{I18n.locale}/#{url}")
+      I18n.with_locale target_locale do
+        translated_url = page.presence && page.url
+        if translated_url.present?
+          "/#{translated_url}"
+        else
+          root_path(locale: target_locale)
+        end
+      end
+    end
+
+    def language_link(url, locale)
+      localized_url(params[:url], locale)
+    end
+
+Add language switch to navigation:
+
+    SimpleNavigation::Configuration.run do |navigation|
+      I18n.available_locales.each do |locale|
+        primary.item locale, locale.to_s.upcase, language_link(params[:url], locale), highlights_on: Proc.new { I18n.locale == locale }
+      end
+    end
+
+Make sure to render only pages which are translated and published by using `published` and `translated` scope, so pages
+without translation and which are not published will not be displayed in the navigation.
+Here is an example of a possible navigation:
+
+    SimpleNavigation::Configuration.run do |navigation|
+      navigation.items do |primary|
+        primary.dom_class = 'right'
+        primary.selected_class = 'active'
+        Kuhsaft::Page.find_by(slug_de: 'meta-navigation').children.published.translated.each do |page|
+          primary.item page.id, page.title, page.link, class: 'contact icon'
+        end
+
+        primary.item '', 'Sprache', '#', class: 'language icon has-dropdown'do |language|
+          I18n.available_locales.each do |locale|
+            language.dom_class = 'dropdown'
+            language.item locale, language_text(locale), language_link(params[:url], locale), highlights_on: Proc.new { I18n.locale == locale }, class: "icon lang-#{locale}"
+          end
+        end
+      end
+    end
+
 ## Styling the content
 
 By default, the text editor lets you add the following tags, for which you should supply some styles in your app:
@@ -207,17 +278,19 @@ By default, the text editor lets you add the following tags, for which you shoul
 
 ## Building a navigation
 
-Building a navigation is simple, access to the page tree is available through the common methods built into the ancestry gem. Just make sure you are only accessing published pages for your production site, using the `published` scope.
+Building a navigation is simple, access to the page tree is available through the common methods built into the ancestry gem.
+Just make sure you are only accessing published pages for your production site, using the `published` scope.
+Or if your page is translated, using the `translated` scope and the `published` scope.
 
 ### 2 level navigation example using simple-navigation
 
     SimpleNavigation::Configuration.run do |navigation|
       navigation.items do |primary|
         # build first level
-        Kuhsaft::Page.roots.published.each do |page|
+        Kuhsaft::Page.roots.published.translated.each do |page|
           primary.item page.id, page.title, page.link do |sub_item|
             # build second level
-            page.children.published.each do |subpage|
+            page.children.published.translated.each do |subpage|
               sub_item.item subpage.id, subpage.title, subpage.link
             end
           end

data/Rakefile

@@ -11,6 +11,27 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
+module Postgres
+  class << self
+    def exec(query)
+      `psql postgres -tAc "#{query}"`
+    end
+
+    def user_exists?(username)
+      exec("SELECT 1 FROM pg_user WHERE usename='#{username}'").strip == '1'
+    end
+
+    def drop_user(username)
+      puts "dropping user #{username}"
+      puts exec("DROP USER #{username}").inspect
+    end
+
+    def create_user(username)
+      user_exists?(username) ? false : `createuser -s #{username}`
+    end
+  end
+end
+
 desc "Run specs"
 RSpec::Core::RakeTask.new(:spec => :setup)
 
@@ -22,7 +43,9 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+desc 'set up the dummy app for testing'
 task :setup do
+  Postgres.create_user 'screenconcept'
   Dir.chdir('spec/dummy') do
     `bundle exec rake kuhsaft:install:migrations`
     `bundle exec rails generate kuhsaft:install:assets`
@@ -33,3 +56,11 @@ task :setup do
 end
 
 task :default => [:spec]
+
+desc 'start the dummy app'
+task :start_dummy do
+  Dir.chdir('spec/dummy') do
+    ENV['BUNDLE_GEMFILE'] = '../../Gemfile'
+    `bundle exec rails server`
+  end
+end

data/app/controllers/kuhsaft/cms/admin_controller.rb

@@ -1,6 +1,6 @@
 module Kuhsaft
   module Cms
-    class AdminController < ActionController::Base
+    class AdminController < InheritedResources::Base
       respond_to :html
       layout 'kuhsaft/cms/application'
       before_filter :set_content_locale
@@ -16,4 +16,4 @@ module Kuhsaft
       end
     end
   end
-end
+end

data/app/models/kuhsaft/page.rb

@@ -20,6 +20,7 @@ class Kuhsaft::Page < ActiveRecord::Base
   default_scope { order('position ASC') }
 
   scope :published, -> { where(:published => Kuhsaft::PublishState::PUBLISHED) }
+  scope :translated, -> { where("url_#{I18n.locale} is not null") }
 
   # TODO: cleanup page_types (content pages => nil or PageType::CONTENT
   scope :content_page, -> { where(

data/app/uploaders/kuhsaft/asset_brick_asset_uploader.rb

@@ -13,7 +13,7 @@ class Kuhsaft::AssetBrickAssetUploader < CarrierWave::Uploader::Base
   # Override the directory where uploaded files will be stored.
   # This is a sensible default for uploaders that are meant to be mounted:
   def store_dir
-    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+    "uploads/#{model.class.name.underscore.gsub(/^kuhsaft/,'cms')}/#{mounted_as}/#{model.id}"
   end
 
   # Provide a default URL as a default if there hasn't been a file uploaded:

data/app/uploaders/kuhsaft/image_brick_image_uploader.rb

@@ -12,7 +12,7 @@ module Kuhsaft
     # Override the directory where uploaded files will be stored.
     # This is a sensible default for uploaders that are meant to be mounted:
     def store_dir
-      "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      "uploads/#{model.class.name.underscore.gsub(/^kuhsaft/,'cms')}/#{mounted_as}/#{model.id}"
     end
 
     # Provide a default URL as a default if there hasn't been a file uploaded:

data/db/migrate/14_move_kuhsaft_assets.rb

@@ -0,0 +1,22 @@
+class MoveKuhsaftAssets < ActiveRecord::Migration
+  def old_kuhsaft_assets_dir
+    File.join(Rails.root,'public/uploads/kuhsaft')
+  end
+
+  def new_kuhsaft_assets_dir
+    File.join(Rails.root,'public/uploads/cms')
+  end
+
+  def up
+    if File.exists? old_kuhsaft_assets_dir
+      puts "Moving Kuhsaft Assets from #{old_kuhsaft_assets_dir} to #{new_kuhsaft_assets_dir}"
+      File.rename old_kuhsaft_assets_dir, new_kuhsaft_assets_dir
+    end
+  end
+
+  def down
+    if File.exists? new_kuhsaft_assets_dir
+      File.rename new_kuhsaft_assets_dir, old_kuhsaft_assets_dir
+    end
+  end
+end

data/db/seeds.rb

@@ -1,13 +1,20 @@
 # Add default kuhsaft brick types
+brick_types = [
+  { class_name: 'Kuhsaft::TextBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::LinkBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::VideoBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::AccordionBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::AccordionItemBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::TwoColumnBrick', group: 'layout_elements' },
+  { class_name: 'Kuhsaft::SliderBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::ImageBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::PlaceholderBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::AnchorBrick', group: 'elements' },
+  { class_name: 'Kuhsaft::AssetBrick', group: 'elements' }
+]
+
+brick_types.each do |bt|
+  brick_type = Kuhsaft::BrickType.find_or_create_by(class_name: bt[:class_name])
+  brick_type.update! bt
+end
 
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::TextBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::LinkBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::VideoBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::AccordionBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::AccordionItemBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::TwoColumnBrick', :group => 'layout_elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::SliderBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::ImageBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::PlaceholderBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::AnchorBrick', :group => 'elements')
-Kuhsaft::BrickType.create(:class_name => 'Kuhsaft::AssetBrick', :group => 'elements')

data/lib/kuhsaft.rb

@@ -15,4 +15,5 @@ module Kuhsaft
   require 'bootstrap-sass'
   require 'haml'
   require 'ckeditor'
+  require 'inherited_resources'
 end

data/lib/kuhsaft/version.rb

@@ -1,3 +1,3 @@
 module Kuhsaft
-  VERSION = "2.0.3"
+  VERSION = "2.1.0"
 end

data/spec/controllers/kuhsaft/cms/admin_controller_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Kuhsaft::Cms::AdminController do
+  subject { described_class }
+
+  it { expect(Kuhsaft::Cms::AdminController.ancestors).to include(InheritedResources::Base) }
+end

data/spec/dummy/config/boot.rb

@@ -1,4 +1,3 @@
 # Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
 require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/database.yml

@@ -1,23 +1,19 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
 development:
-  adapter: mysql2
+  adapter: postgresql
   database: kuhsaft_development
-  user: root
+  username: screenconcept
   password:
+  host: localhost
+  encoding: unicode
   pool: 5
-  timeout: 5000
+  port: <%= ENV["BOXEN_POSTGRESQL_PORT"] || 5432 %>
 
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
 test:
-  adapter: mysql2
-  database: kuhsaft_test
-  user: root
+  adapter: postgresql
+  database: kuhsaft_development
+  username: screenconcept
   password:
+  host: localhost
+  encoding: unicode
   pool: 5
-  timeout: 5000
+  port: <%= ENV["BOXEN_POSTGRESQL_PORT"] || 5432 %>

data/spec/features/search_spec.rb

@@ -32,13 +32,13 @@ describe 'pages#index' do
       end
 
       it 'highlights search term in preview' do
-        within("ul.search-results mark") do
+        within("ul.search-results.success") do
           page.should have_content('Chromodorididae')
         end
       end
 
       it 'truncates the text' do
-        find('.summary .fulltext').text.length.should == 208
+        find('.summary .excerpt').text.length.should == 110
       end
     end
 

data/spec/models/brick_spec.rb

@@ -36,7 +36,7 @@ describe Kuhsaft::Brick do
 
   describe '#parents' do
     it 'returns the chain of parents' do
-      item1, item2, item3 = mock, mock, Kuhsaft::Brick.new
+      item1, item2, item3 = double, double, Kuhsaft::Brick.new
       item2.stub(:brick_list).and_return(item1)
       item3.stub(:brick_list).and_return(item2)
       item3.parents.should == [item1, item2]
@@ -56,7 +56,7 @@ describe Kuhsaft::Brick do
     end
 
     it 'returns true if the brick has siblings' do
-      item1, item2, item3 = mock, mock, Kuhsaft::Brick.new
+      item1, item2, item3 = double, double, Kuhsaft::Brick.new
       item1.stub(:bricks).and_return([item2, item3])
       item2.stub(:brick_list).and_return(item1)
       item3.stub(:brick_list).and_return(item1)

data/spec/models/page_spec.rb

@@ -393,4 +393,23 @@ describe Kuhsaft::Page do
       end
     end
   end
+
+  describe '#translated' do
+    before :each do
+      @page_1 = create(:page, title: 'Page 1', slug: 'page1')
+      @page_2 = create(:page, title: 'Page 2', slug: 'page1')
+      @page_3 = create(:page, title: 'Page 3', slug: 'page1')
+    end
+
+    it 'returns all pages that have a translation' do
+      expect(Kuhsaft::Page.translated).to eq [@page_1, @page_2, @page_3]
+    end
+
+    it 'does not return untranslated pages' do
+      I18n.with_locale :de do
+        @page_1.update(title: 'Page 1 fr', slug: 'page_1_fr')
+        expect(Kuhsaft::Page.translated).to eq [@page_1]
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,9 @@
 ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require 'rails/test_help'
-require 'rspec/rails'
-require 'factory_girl'
-require 'capybara/rails'
-require 'rake'
+[ 'rails/test_help', 'rspec/rails', 'factory_girl', 'capybara/rails',
+  'rake', 'database_cleaner', 'pry-debugger'
+  ].each{|lib| require lib }
 
 FactoryGirl.find_definitions
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kuhsaft
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Immanuel Häussermann
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -71,7 +71,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -252,6 +252,90 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inherited_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -450,6 +534,7 @@ files:
 - db/migrate/11_update_url_and_redirect_url_value.rb
 - db/migrate/12_regenerate_fulltext.rb
 - db/migrate/13_add_page_title_to_pages.rb
+- db/migrate/14_move_kuhsaft_assets.rb
 - db/seeds.rb
 - lib/generators/kuhsaft/assets/install_generator.rb
 - lib/generators/kuhsaft/translations/add_generator.rb
@@ -471,6 +556,7 @@ files:
 - vendor/assets/stylesheets/nestable.css
 - Rakefile
 - README.md
+- spec/controllers/kuhsaft/cms/admin_controller_spec.rb
 - spec/controllers/kuhsaft/pages_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/spec-image.png
@@ -568,6 +654,7 @@ signing_key:
 specification_version: 4
 summary: A tool that helps you to manage your content within your app.
 test_files:
+- spec/controllers/kuhsaft/cms/admin_controller_spec.rb
 - spec/controllers/kuhsaft/pages_controller_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/images/spec-image.png