alchemy_cms 2.8.3 → 2.9.0

data/lib/alchemy/auth_accessors.rb

@@ -0,0 +1,54 @@
+# Provides authentication accessors.
+#
+# Alchemy has some defaults for user model name and login logout path names:
+#
+# +Alchemy.user_class_name+ defaults to +'User'+
+# +Alchemy.login_path defaults to +'/login'+
+# +Alchemy.logout_path defaults to +'/admin/logout'+
+#
+# Anyway, you can tell Alchemy about your authentication model configuration:
+#
+#   1. Your user class name - @see: Alchemy.user_class
+#   2. The path to the login form - @see: Alchemy.login_path
+#   3. The path to the logout method - @see: Alchemy.logout_path
+#
+# == Example
+#
+#     # config/initializers/alchemy.rb
+#     Alchemy.user_class_name = 'Admin'
+#     Alchemy.login_path = '/auth/login'
+#     Alchemy.logout_path = '/auth/logout'
+#
+# If you don't have your own user model or don't want to provide one,
+# add the `alchemy-devise` gem into your App's Gemfile.
+#
+module Alchemy
+  mattr_accessor :user_class_name, :login_path, :logout_path
+
+  # Defaults
+  #
+  @@user_class_name = 'User'
+  @@login_path = '/login'
+  @@logout_path = '/logout'
+
+  # Returns the user class
+  #
+  # Set your App's user class to Alchemy.user_class_name in an initializer.
+  #
+  # Defaults to +User+
+  #
+  # == Example
+  #
+  #     # config/initializers/alchemy.rb
+  #     Alchemy.user_class_name = 'Admin'
+  #
+  def self.user_class
+    @@user_class ||= begin
+      if @@user_class_name.is_a?(String)
+        @@user_class_name.constantize
+      else
+        raise 'Alchemy.user_class_name must be a String, not a Class.'
+      end
+    end
+  end
+end

data/lib/alchemy/capistrano.rb

@@ -1,6 +1,9 @@
 # This recipe contains Capistrano recipes for handling the uploads, ferret index and picture cache files while deploying your application.
 # It also contains a ferret:rebuild_index task to rebuild the index after deploying your application.
 require 'fileutils'
+require 'alchemy/tasks/helpers'
+
+include Alchemy::Tasks::Helpers
 
 ::Capistrano::Configuration.instance(:must_exist).load do
 
@@ -100,7 +103,7 @@ EOF
         database
       end
 
-      desc "Imports the database into your local development machine."
+      desc "Imports the server database into your local development machine."
       task :database, :roles => [:db], :only => {:primary => true} do
         require 'spinner'
         server = find_servers_for_task(current_task).first
@@ -147,23 +150,8 @@ EOF
       def db_import_cmd(server)
         dump_cmd = "cd #{current_path} && #{rake} RAILS_ENV=#{fetch(:rails_env, 'production')} alchemy:db:dump"
         sql_stream = "ssh -p #{fetch(:port, 22)} #{user}@#{server} '#{dump_cmd}'"
-        "#{sql_stream} | mysql #{mysql_credentials} #{database_config['database']}"
+        "#{sql_stream} | #{database_import_command(database_config['adapter'])} 1>/dev/null 2>&1"
       end
-
-      def mysql_credentials
-        mysql_credentials = []
-        if database_config['username']
-          mysql_credentials << "--user='#{database_config['username']}'"
-        end
-        if database_config['password']
-          mysql_credentials << "--password='#{database_config['password']}'"
-        end
-        if (host = database_config['host']) && (host != 'localhost')
-          mysql_credentials << "--host='#{host}'"
-        end
-        mysql_credentials.join(' ')
-      end
-
     end
 
   end

data/lib/alchemy/engine.rb

@@ -2,7 +2,6 @@
 require 'coffee-rails'
 require 'compass-rails'
 require 'declarative_authorization'
-require 'devise'
 require 'dynamic_form'
 require 'jquery-rails'
 require 'jquery-ui-rails'
@@ -10,9 +9,11 @@ require 'kaminari'
 require 'rails3-jquery-autocomplete'
 require 'sass-rails'
 require 'sassy-buttons'
+require 'userstamp'
 
 # Require globally used Alchemy mixins
 require 'alchemy/auth/engine'
+require 'alchemy/auth_accessors'
 require 'alchemy/config'
 require 'alchemy/errors'
 require 'alchemy/essence'
@@ -26,6 +27,7 @@ require 'alchemy/mount_point'
 require 'alchemy/name_conversions'
 require 'alchemy/page_layout'
 require 'alchemy/picture_attributes'
+require 'alchemy/resource'
 require 'alchemy/tinymce'
 
 # Require hacks
@@ -37,7 +39,6 @@ require File.join(File.dirname(__FILE__), '../middleware/flash_session_cookie')
 
 module Alchemy
   class Engine < Rails::Engine
-
     isolate_namespace Alchemy
     engine_name 'alchemy'
     config.mount_at = '/'
@@ -65,11 +66,6 @@ module Alchemy
       )
     end
 
-    # filter sensitive information during logging
-    initializer "alchemy.params.filter" do |app|
-      app.config.filter_parameters += [:password, :password_confirmation]
-    end
-
     initializer "alchemy.add_authorization_rules" do
       Alchemy::Auth::Engine.get_instance.load(File.join(File.dirname(__FILE__), '../..', 'config/authorization_rules.rb'))
     end
@@ -78,5 +74,9 @@ module Alchemy
       ApplicationController.send(:include, Alchemy::LanguageHelpers)
     end
 
+    config.after_initialize do
+      require 'alchemy/userstamp'
+    end
+
   end
 end

data/lib/alchemy/errors.rb

@@ -56,4 +56,10 @@ module Alchemy
     end
   end
 
+  class NoCurrentUserFoundError < StandardError
+    # Raised if no current_user is found to authorize against.
+    def message
+      "You need to provide a current_user method in your ApplicationController that returns the current authenticated user."
+    end
+  end
 end

data/lib/alchemy/essence.rb

@@ -32,7 +32,7 @@ module Alchemy #:nodoc:
           attr_accessor :validation_errors
           attr_accessible :ingredient
           include Alchemy::Essence::InstanceMethods
-          stampable(:stamper_class_name => 'Alchemy::User')
+          stampable stamper_class_name: Alchemy.user_class_name
           validate :essence_validations, :on => :update
           has_many :contents, :as => :essence
           has_many :elements, :through => :contents
@@ -106,7 +106,7 @@ module Alchemy #:nodoc:
               case description['validate_format_as']
               when 'email'
               then
-                matcher = Devise.email_regexp
+                matcher = Alchemy::Config.get(:email_regexp)
               when 'url'
               then
                 matcher = /^[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$/ix

data/lib/alchemy/seeder.rb

@@ -2,7 +2,7 @@ require "alchemy/shell"
 
 module Alchemy
   class Seeder
-    extend Shell
+    extend Alchemy::Shell
 
     class << self
 

data/lib/alchemy/tasks/helpers.rb

@@ -0,0 +1,83 @@
+module Alchemy
+  module Tasks
+    module Helpers
+
+      def database_dump_command(adapter)
+        database_command(adapter, 'dump')
+      end
+
+      def database_import_command(adapter)
+        database_command(adapter, 'import')
+      end
+
+      def database_config
+        raise "Could not find #{database_config_file}!" if !File.exists?(database_config_file)
+        @database_config ||= begin
+          config_file = YAML.load_file(database_config_file)
+          config_file.fetch(environment)
+          rescue KeyError
+            raise "Database configuration for #{environment} not found!"
+        end
+      end
+
+      private
+
+      def database_command(adapter, action='import')
+        case adapter.to_s
+        when /mysql/
+          "#{mysql_command(mysql_command_for(action))} #{database_config['database']}"
+        when /postgresql/
+          "#{postgres_command(postgres_command_for(action))} #{database_config['database']}"
+        else
+          raise ArgumentError, "Alchemy only supports #{action}ing MySQL and PostgreSQL databases. #{adapter} is not supported."
+        end
+      end
+
+      def mysql_command(cmd='mysql')
+        command = [cmd]
+        if database_config['username']
+          command << "--user='#{database_config['username']}'"
+        end
+        if database_config['password']
+          command << "--password='#{database_config['password']}'"
+        end
+        if (host = database_config['host']) && (host != 'localhost')
+          command << "--host='#{host}'"
+        end
+        command.join(' ')
+      end
+
+      def postgres_command(cmd='psql')
+        command = []
+        if database_config['password']
+          command << "PGPASSWORD='#{database_config['password']}'"
+        end
+        command << cmd
+        if database_config['username']
+          command << "--username='#{database_config['username']}'"
+        end
+        if (host = database_config['host']) && (host != 'localhost')
+          command << "--host='#{host}'"
+        end
+        command.join(' ')
+      end
+
+      def mysql_command_for(action)
+        action == 'import' ? 'mysql' : 'mysqldump'
+      end
+
+      def postgres_command_for(action)
+        action == 'import' ? 'psql' : 'pg_dump --clean'
+      end
+
+      def database_config_file
+        "./config/database.yml"
+      end
+
+      def environment
+        ENV['RAILS_ENV'] || 'development'
+      end
+
+    end
+  end
+end

data/lib/alchemy/test_support/auth_helpers.rb

@@ -0,0 +1,35 @@
+module Alchemy
+  module TestSupport
+
+    # Helpers for authentication
+    #
+    module AuthHelpers
+
+      def sign_in(user = admin_user)
+        controller.stub current_alchemy_user: user
+      end
+
+      def registered_user
+        mock_user([:registered])
+      end
+
+      def author_user
+        mock_user([:author])
+      end
+
+      def editor_user
+        mock_user([:editor])
+      end
+
+      def admin_user
+        mock_user([:admin])
+      end
+
+      def mock_user(roles)
+        mock_model(Alchemy.user_class, alchemy_roles: roles.map(&:to_sym), role_symbols: roles.map(&:to_sym))
+      end
+
+    end
+
+  end
+end

data/lib/alchemy/test_support/controller_requests.rb

@@ -0,0 +1,37 @@
+# Based on spree commerce controller hacks.
+# https://github.com/spree/spree/blob/master/core/spec/support/controller_hacks.rb
+# Thanks!
+
+module Alchemy
+  module TestSupport
+    module ControllerRequests
+
+      def get(action, parameters = nil, session = nil, flash = nil)
+        process_alchemy_action(action, parameters, session, flash, "GET")
+      end
+
+      # Executes a request simulating POST HTTP method and set/volley the response
+      def post(action, parameters = nil, session = nil, flash = nil)
+        process_alchemy_action(action, parameters, session, flash, "POST")
+      end
+
+      # Executes a request simulating PUT HTTP method and set/volley the response
+      def put(action, parameters = nil, session = nil, flash = nil)
+        process_alchemy_action(action, parameters, session, flash, "PUT")
+      end
+
+      # Executes a request simulating DELETE HTTP method and set/volley the response
+      def delete(action, parameters = nil, session = nil, flash = nil)
+        process_alchemy_action(action, parameters, session, flash, "DELETE")
+      end
+
+      private
+
+      def process_alchemy_action(action, parameters = nil, session = nil, flash = nil, method = "GET")
+        parameters ||= {}
+        process(action, parameters.merge!(:use_route => :alchemy), session, flash, method)
+      end
+
+    end
+  end
+end

data/{spec/support → lib/alchemy/test_support}/factories.rb

@@ -1,32 +1,5 @@
 FactoryGirl.define do
 
-  factory :user, :class => 'Alchemy::User' do
-    firstname "John"
-    lastname "Doe"
-    email 'john@doe.com'
-    login "jdoe"
-    password 's3cr3t'
-    password_confirmation 's3cr3t'
-    language 'en'
-
-    factory :admin_user do
-      roles 'admin'
-    end
-
-    factory :registered_user do
-      roles 'registered'
-    end
-
-    factory :author_user do
-      roles 'author'
-    end
-
-    factory :editor_user do
-      roles 'editor'
-    end
-
-  end
-
   factory :language, :class => 'Alchemy::Language' do
     name 'Deutsch'
     code 'de'
@@ -105,7 +78,7 @@ FactoryGirl.define do
   end
 
   factory :picture, :class => 'Alchemy::Picture' do
-    image_file File.new(File.expand_path('../image.png', __FILE__))
+    image_file File.new(File.expand_path('../../../../spec/fixtures/image.png', __FILE__))
     name 'image'
     image_file_name 'image.png'
     upload_hash Time.now.hash
@@ -125,4 +98,10 @@ FactoryGirl.define do
     name 'A Site'
     host 'domain.com'
   end
+
+  factory :attachment, :class => 'Alchemy::Attachment' do
+    file File.new(File.expand_path('../../../../spec/fixtures/image.png', __FILE__))
+    name 'image'
+    file_name 'image.png'
+  end
 end

data/{spec/support/alchemy → lib/alchemy/test_support}/integration_helpers.rb

@@ -1,7 +1,7 @@
 require 'declarative_authorization/maintenance'
 
 module Alchemy
-  module Specs
+  module TestSupport
 
     # Helpers for integration specs
     #
@@ -10,31 +10,19 @@ module Alchemy
     module IntegrationHelpers
       include ::Authorization::TestHelper
 
-      # Shortcut method for:
+      # Used in Capybara features specs. Stubs the current_alchemy_user
       #
-      #   * create_admin_user
-      #   * login_into_alchemy
+      # It mocks an admin user, but you can pass in a user object that would be used as stub.
       #
-      def authorize_as_admin
-        create_admin_user
-        login_into_alchemy
-      end
-
-      # Capybara actions to login into Alchemy Backend
-      #
-      # You should have a admin user before loggin in.
-      #
-      # See: create_admin_user method
-      #
-      def login_into_alchemy
+      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
-        visit login_path
-        fill_in('user_login', :with => 'jdoe')
-        fill_in('user_password', :with => 's3cr3t')
-        click_on('Login')
+        if !user
+          user = mock_model('DummyUser', alchemy_roles: %w(admin), role_symbols: [:admin], language: 'en')
+        end
+        ApplicationController.any_instance.stub(:current_user).and_return(user)
       end
 
       # Load additional authorization_rules for specs.
@@ -43,21 +31,7 @@ module Alchemy
       #
       def load_authorization_rules
         instance = Alchemy::Auth::Engine.get_instance
-        instance.load(File.join(File.dirname(__FILE__), '../../dummy', 'config/authorization_rules.rb'))
-      end
-
-      # Creates an admin user in a way it works
-      #
-      # You should create it once in a before block
-      #
-      # === Example:
-      #
-      #   before do
-      #     create_admin_user
-      #   end
-      #
-      def create_admin_user
-        FactoryGirl.create(:admin_user)
+        instance.load(File.join(File.dirname(__FILE__), '../../../spec/dummy', 'config/authorization_rules.rb'))
       end
 
       # Capybara actions to create a new element.
@@ -73,7 +47,6 @@ module Alchemy
           click_button 'Add'
         end
       end
-
     end
 
   end