alchemy_cms 3.2.0.beta → 3.2.0.rc1

data/lib/alchemy/routing_constraints.rb

@@ -0,0 +1,49 @@
+module Alchemy
+
+  # Routing constraints for Alchemy's strong catch all route.
+  #
+  # Alchemy has a very strong catch all route.
+  # But we don't want to handle all requests.
+  #
+  # For instance we only want to handle html requests and
+  # don't want to swallow the rails/info routes in development mode.
+  #
+  class RoutingConstraints
+    LOCALE_REGEXP = /[a-z]{2}(-[a-z]{2})?/
+
+    def matches?(request)
+      @request = request
+      @params = @request.params
+
+      handable_format? && no_rails_route?
+    rescue ArgumentError => e
+      handle_invalid_byte_sequence(e)
+    end
+
+    private
+
+    # We only want html requests to be handled by us.
+    #
+    # If an unknown format is requested we want to handle this,
+    # because it could be a legacy route that needs to be redirected.
+    #
+    def handable_format?
+      @request.format.symbol.nil? || (@request.format.symbol == :html)
+    end
+
+    # We don't want to handle the Rails info routes.
+    def no_rails_route?
+      return true if !%w(development test).include?(Rails.env)
+      (@params['urlname'] =~ /\Arails\//).nil?
+    end
+
+    # Handle invalid byte sequence in UTF-8 errors with 400 status.
+    def handle_invalid_byte_sequence(e)
+      if e.message =~ /invalid byte sequence/
+        raise ActionController::BadRequest
+      else
+        raise
+      end
+    end
+  end
+end

data/lib/alchemy/seeder.rb

@@ -6,8 +6,10 @@ module Alchemy
 
     class << self
 
-      # This seed builds the necessary page structure for alchemy in your database.
-      # Run the alchemy:db:seed rake task to seed your database.
+      # This seed builds the necessary page structure for Alchemy in your database.
+      #
+      # Call this from your db/seeds.rb file with the rake db:seed task.
+      #
       def seed!
         create_default_site
         create_root_page

data/lib/alchemy/ssl_protection.rb

@@ -0,0 +1,30 @@
+module Alchemy
+  module SSLProtection
+    private
+
+    # Enforce ssl for login and all admin modules.
+    #
+    # Default is +false+
+    #
+    # === Usage
+    #
+    #   # config/alchemy/config.yml
+    #   ...
+    #   require_ssl: true
+    #   ...
+    #
+    # === Note
+    #
+    # You have to create a ssl certificate
+    # if you want to use the ssl protection.
+    #
+    def ssl_required?
+      !Rails.env.test? && Config.get(:require_ssl)
+    end
+
+    # Redirects current request to https.
+    def enforce_ssl
+      redirect_to url_for(request.params.merge(protocol: 'https'))
+    end
+  end
+end

data/lib/alchemy/test_support/essence_shared_examples.rb

@@ -84,27 +84,67 @@ shared_examples_for "an essence" do
     end
 
     describe 'presence' do
-      before do
-        allow(essence).to receive(:description).and_return({'validate' => ['presence']})
-      end
-
-      context 'when the ingredient column is empty' do
+      context 'with string given as validation type' do
         before do
-          essence.update(essence.ingredient_column.to_sym => nil)
+          allow(essence).to receive(:description).and_return({'validate' => ['presence']})
         end
 
-        it 'should not be valid' do
-          expect(essence).to_not be_valid
+        context 'when the ingredient column is empty' do
+          before do
+            essence.update(essence.ingredient_column.to_sym => nil)
+          end
+
+          it 'should not be valid' do
+            expect(essence).to_not be_valid
+          end
+        end
+
+        context 'when the ingredient column is not nil' do
+          before do
+            essence.update(essence.ingredient_column.to_sym => ingredient_value)
+          end
+
+          it 'should be valid' do
+            expect(essence).to be_valid
+          end
         end
       end
 
-      context 'when the ingredient column is not nil' do
-        before do
-          essence.update(essence.ingredient_column.to_sym => ingredient_value)
+      context 'with hash given as validation type' do
+        context 'where the value is true' do
+          before do
+            allow(essence).to receive(:description).and_return({'validate' => [{'presence' => true}]})
+          end
+
+          context 'when the ingredient column is empty' do
+            before do
+              essence.update(essence.ingredient_column.to_sym => nil)
+            end
+
+            it 'should not be valid' do
+              expect(essence).to_not be_valid
+            end
+          end
+
+          context 'when the ingredient column is not nil' do
+            before do
+              essence.update(essence.ingredient_column.to_sym => ingredient_value)
+            end
+
+            it 'should be valid' do
+              expect(essence).to be_valid
+            end
+          end
         end
 
-        it 'should be valid' do
-          expect(essence).to be_valid
+        context 'where the value is false' do
+          before do
+            allow(essence).to receive(:description).and_return({'validate' => [{'presence' => false}]})
+          end
+
+          it 'should be valid' do
+            expect(essence).to be_valid
+          end
         end
       end
     end
@@ -112,22 +152,37 @@ shared_examples_for "an essence" do
     describe 'uniqueness' do
       before do
         allow(essence).to receive(:element).and_return(build_stubbed(:element))
-        expect(essence).to receive(:description).at_least(:once).and_return({'validate' => ['uniqueness']})
         essence.update(essence.ingredient_column.to_sym => ingredient_value)
       end
 
-      context 'when a duplicate exists' do
+      context 'with string given as validation type' do
         before do
-          allow(essence).to receive(:duplicates).and_return([essence.dup])
+          expect(essence).to receive(:description).at_least(:once).and_return({'validate' => ['uniqueness']})
         end
 
-        it 'should not be valid' do
-          expect(essence).to_not be_valid
+        context 'when a duplicate exists' do
+          before do
+            allow(essence).to receive(:duplicates).and_return([essence.dup])
+          end
+
+          it 'should not be valid' do
+            expect(essence).to_not be_valid
+          end
+
+          context 'when validated essence is not public' do
+            before do
+              expect(essence).to receive(:public?).and_return(false)
+            end
+
+            it 'should be valid' do
+              expect(essence).to be_valid
+            end
+          end
         end
 
-        context 'when validated essence is not public' do
+        context 'when no duplicate exists' do
           before do
-            expect(essence).to receive(:public?).and_return(false)
+            expect(essence).to receive(:duplicates).and_return([])
           end
 
           it 'should be valid' do
@@ -136,13 +191,51 @@ shared_examples_for "an essence" do
         end
       end
 
-      context 'when no duplicate exists' do
-        before do
-          expect(essence).to receive(:duplicates).and_return([])
+      context 'with hash given as validation type' do
+        context 'where the value is true' do
+          before do
+            expect(essence).to receive(:description).at_least(:once).and_return({'validate' => [{'uniqueness' => true}]})
+          end
+
+          context 'when a duplicate exists' do
+            before do
+              allow(essence).to receive(:duplicates).and_return([essence.dup])
+            end
+
+            it 'should not be valid' do
+              expect(essence).to_not be_valid
+            end
+
+            context 'when validated essence is not public' do
+              before do
+                expect(essence).to receive(:public?).and_return(false)
+              end
+
+              it 'should be valid' do
+                expect(essence).to be_valid
+              end
+            end
+          end
+
+          context 'when no duplicate exists' do
+            before do
+              expect(essence).to receive(:duplicates).and_return([])
+            end
+
+            it 'should be valid' do
+              expect(essence).to be_valid
+            end
+          end
         end
 
-        it 'should be valid' do
-          expect(essence).to be_valid
+        context 'where the value is false' do
+          before do
+            allow(essence).to receive(:description).and_return({'validate' => [{'uniqueness' => false}]})
+          end
+
+          it 'should be valid' do
+            expect(essence).to be_valid
+          end
         end
       end
     end

data/lib/alchemy/test_support/factories.rb

@@ -2,23 +2,20 @@ require 'factory_girl'
 
 FactoryGirl.define do
 
-  factory :user, class: 'DummyUser' do
+  factory :alchemy_dummy_user, class: 'DummyUser' do
     sequence(:email) { |n| "john.#{n}@doe.com" }
     password 's3cr3t'
+    alchemy_roles ['member']
 
-    factory :admin_user do
+    trait :as_admin do
       alchemy_roles ['admin']
     end
 
-    factory :member_user do
-      alchemy_roles ['member']
-    end
-
-    factory :author_user do
+    trait :as_author do
       alchemy_roles ['author']
     end
 
-    factory :editor_user do
+    trait :as_editor do
       alchemy_roles ['editor']
     end
   end

data/lib/alchemy/test_support/integration_helpers.rb

@@ -3,24 +3,30 @@ module Alchemy
 
     # Helpers for integration specs
     #
-    # This file is included in rspec integration/request tests.
+    # This file is included in spec_helper.rb
     #
     module IntegrationHelpers
 
-      # Used in Capybara features specs. Stubs the current_alchemy_user
+      # Used to stub the current_alchemy_user
       #
-      # It mocks an admin user, but you can pass in a user object that would be used as stub.
+      # Pass either a user object or a symbol in the format of ':as_admin'.
+      # The browser language is set to english ('en')
       #
-      def authorize_as_admin(user=nil)
-        # Ensure that phantomjs has always the same browser language.
-        if Capybara.current_driver == :poltergeist
-          page.driver.headers = { 'Accept-Language' => 'en' }
-        end
-        if !user
-          user = mock_model('DummyUser', alchemy_roles: %w(admin), language: 'en')
+      def authorize_user(user_or_role = nil)
+        if user_or_role.is_a?(Alchemy.user_class)
+          user = user_or_role
+        else
+          user = build(:alchemy_dummy_user, user_or_role)
         end
+        set_phantomjs_browser_language("en")
         allow_any_instance_of(ApplicationController).to receive(:current_user).and_return(user)
       end
+
+      def set_phantomjs_browser_language(lang = nil)
+        if Capybara.current_driver == :poltergeist
+          page.driver.headers = {"Accept-Language" => lang}
+        end
+      end
     end
 
   end

data/lib/alchemy/upgrader/three_point_two.rb

@@ -22,6 +22,10 @@ class Alchemy::Upgrader::ThreePointTwoTask < Thor
           { after: sentinel, verbose: true }
       end
     end
+
+    def inject_seeder
+      append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
+    end
   end
 end
 
@@ -30,10 +34,36 @@ module Alchemy
     private
 
     def upgrade_acts_as_taggable_on_migrations
-      # We can't invoke this rake task, because Rails will use wrong engine names otherwise
-      `bundle exec rake railties:install:migrations`
-      Alchemy::Upgrader::ThreePointTwoTask.new.patch_acts_as_taggable_on_migrations
-      Rake::Task["db:migrate"].invoke
+      desc 'Installs acts_as_taggable_on migrations.'
+      if !`bundle exec rake railties:install:migrations FROM=acts_as_taggable_on_engine`.empty?
+        Alchemy::Upgrader::ThreePointTwoTask.new.patch_acts_as_taggable_on_migrations
+      end
+      `bundle exec rake db:migrate`
+    end
+
+    def inject_seeder
+      desc 'Add Alchemy seeder to `db/seeds.rb` file.'
+      Alchemy::Upgrader::ThreePointTwoTask.new.inject_seeder
+    end
+
+    def alchemy_3_2_todos
+      notice = <<-NOTE
+
+Capistrano 2 deploy script removed
+----------------------------------
+
+The Capistrano 2 based deploy script has been removed and replaced by an Capistrano 3 extension.
+
+Please update your Gemfile:
+
+group :development do
+  gem 'capistrano-alchemy', github: 'AlchemyCMS/capistrano-alchemy', branch: 'master', require: false
+end
+
+For more information please visit https://github.com/AlchemyCMS/capistrano-alchemy.
+
+NOTE
+      todo notice, 'Alchemy v3.2 changes'
     end
   end
 end

data/lib/alchemy/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
-  VERSION = "3.2.0.beta"
+  VERSION = "3.2.0.rc1"
 
   def self.version
     VERSION

data/lib/rails/generators/alchemy/install/install_generator.rb

@@ -0,0 +1,69 @@
+require 'rails'
+
+module Alchemy
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      desc "Installs Alchemy into your App."
+
+      class_option :skip_demo_files,
+        type: :boolean,
+        default: false,
+        desc: "Skip creation of demo element, page and application layout."
+
+      source_root File.expand_path('files', File.dirname(__FILE__))
+
+      def create_view_dirs
+        %w(elements page_layouts).each do |dir|
+          empty_directory Rails.root.join("app/views/alchemy/#{dir}")
+        end
+      end
+
+      def copy_config
+        copy_file "#{config_path}/config.yml",
+          Rails.root.join("config/alchemy/config.yml")
+      end
+
+      def copy_yml_files
+        %w(elements page_layouts).each do |file|
+          template "#{current_path}/templates/#{file}.yml.tt",
+            Rails.root.join("config/alchemy/#{file}.yml")
+        end
+      end
+
+      def copy_demo_views
+        return if @options[:skip_demo_files]
+
+        copy_file "application.html.erb",
+          Rails.root.join("app/views/layouts/application.html.erb")
+        copy_file "alchemy.elements.css.scss",
+          Rails.root.join("app/assets/stylesheets/alchemy.elements.css.scss")
+
+        [
+          "_article_editor.html.erb",
+          "_article_view.html.erb"
+        ].each do |file|
+          copy_file file, Rails.root.join("app/views/alchemy/elements/#{file}")
+        end
+
+        copy_file "_standard.html.erb",
+          Rails.root.join("app/views/alchemy/page_layouts/_standard.html.erb")
+
+        %w(de en es).each do |locale|
+          copy_file "alchemy.#{locale}.yml",
+            Rails.root.join("config/locales/alchemy.#{locale}.yml")
+        end
+      end
+
+      private
+
+      def config_path
+        @_config_path ||= File.expand_path('../../../../../config/alchemy', current_path)
+      end
+
+      def current_path
+        @_current_path ||= File.dirname(__FILE__)
+      end
+    end
+  end
+end