alchemy_cms 3.2.1 → 3.3.0.rc1

data/lib/alchemy/resources_helper.rb

@@ -31,20 +31,20 @@ module Alchemy
       @_resource_scope ||= [resource_url_proxy].concat(resource_handler.namespace_for_scope)
     end
 
-    def resources_path(resource_or_name=resource_handler.resources_name, options={})
+    def resources_path(resource_or_name = resource_handler.resources_name, options = {})
       polymorphic_path (resource_scope + [resource_or_name]), options
     end
 
-    def resource_path(resource=resource_handler.resource_name, options={})
+    def resource_path(resource = resource_handler.resource_name, options = {})
       resources_path(resource, options)
     end
 
-    def new_resource_path(options={})
+    def new_resource_path(options = {})
       new_polymorphic_path (resource_scope + [resource_handler.resource_name]), options
     end
 
-    def edit_resource_path(resource=nil, options={})
-      path_segments = (resource_scope + [resource] or resource_handler.resource_array)
+    def edit_resource_path(resource = nil, options = {})
+      path_segments = (resource_scope + [resource] || resource_handler.resource_array)
       edit_polymorphic_path path_segments, options
     end
 
@@ -61,6 +61,7 @@ module Alchemy
     # If the attribute has a relation, the related object's attribute value will be returned.
     #
     # The output will be truncated after 50 chars.
+    # Pass another number to truncate then and pass false to disable this completely.
     #
     # @param [Alchemy::Resource] resource
     # @param [Hash] attribute
@@ -68,7 +69,7 @@ module Alchemy
     #
     # @return [String]
     #
-    def render_attribute(resource, attribute, options={})
+    def render_attribute(resource, attribute, options = {})
       options.reverse_merge!(truncate: 50)
       value = resource.send(attribute[:name])
       if (relation = attribute[:relation]) && value.present?
@@ -77,10 +78,13 @@ module Alchemy
       elsif attribute[:type] == :datetime && value.present?
         value = l(value)
       end
-      value.to_s.truncate(options[:truncate])
+      if options[:truncate]
+        value = value.to_s.truncate(options[:truncate])
+      end
+      value
     rescue ActiveRecord::RecordNotFound => e
       warning e
-      _t(:not_found)
+      Alchemy.t(:not_found)
     end
 
     # Returns a options hash for simple_form input fields.
@@ -93,7 +97,7 @@ module Alchemy
         options.merge as: 'string',
           input_html: {
             type: 'date',
-            value: l(resource_instance_variable.send(attribute[:name]) || Time.now, format: :datepicker)
+            value: l(resource_instance_variable.send(attribute[:name]) || Time.current, format: :datepicker)
           }
       when 'time'
         options.merge(as: 'time')
@@ -116,7 +120,7 @@ module Alchemy
 
     # Returns an array of all resource_relations names
     def resource_relations_names
-      resource_handler.resource_relations.collect { |k, v| v[:name].to_sym }
+      resource_handler.resource_relations.collect { |_k, v| v[:name].to_sym }
     end
 
     # Returns the attribute's column for sorting
@@ -125,11 +129,44 @@ module Alchemy
     #
     def sortable_resource_header_column(attribute)
       if relation = attribute[:relation]
-        "#{relation[:model_association].table_name}.#{relation[:attr_method]}"
+        "#{relation[:model_association].name}_#{relation[:attr_method]}"
       else
         attribute[:name]
       end
     end
 
+    # Renders the row for a resource record in the resources table.
+    #
+    # This helper has a nice fallback. If you create a partial for your record then this partial will be rendered.
+    #
+    # Otherwise the default +app/views/alchemy/admin/resources/_resource.html.erb+ partial gets rendered.
+    #
+    # == Example
+    #
+    # For a resource named +Comment+ you can create a partial named +_comment.html.erb+
+    #
+    #   # app/views/admin/comments/_comment.html.erb
+    #   <tr>
+    #     <td><%= comment.title %></td>
+    #     <td><%= comment.body %></td>
+    #   </tr>
+    #
+    # NOTE: Alchemy gives you a local variable named like your resource
+    #
+    def render_resources
+      render partial: resource_name, collection: resources_instance_variable
+    rescue ActionView::MissingTemplate
+      render partial: 'resource', collection: resources_instance_variable
+    end
+
+    # Returns all the params necessary to get you back from where you where
+    # before: the Ransack query and the current page.
+    #
+    def current_location_params
+      {
+        q: params[:q],
+        page: params[:page]
+      }
+    end
   end
 end

data/lib/alchemy/routing_constraints.rb

@@ -1,15 +1,14 @@
 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
+  # For instance we only want to handle html and rss requests and
   # don't want to swallow the rails/info routes in development mode.
   #
   class RoutingConstraints
-    LOCALE_REGEXP = /[a-z]{2}(-[a-z]{2})?/
+    LOCALE_REGEXP = /[a-z]{2}(-[a-zA-Z]{2})?/
 
     def matches?(request)
       @request = request
@@ -22,13 +21,13 @@ module Alchemy
 
     private
 
-    # We only want html requests to be handled by us.
+    # We only want html and rss 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)
+      @request.format.symbol.nil? || (@request.format.symbol == :html) || (@request.format.symbol == :rss)
     end
 
     # We don't want to handle the Rails info routes.

data/lib/alchemy/seeder.rb

@@ -5,7 +5,6 @@ module Alchemy
     extend Alchemy::Shell
 
     class << self
-
       # 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.
@@ -15,7 +14,7 @@ module Alchemy
         create_root_page
       end
 
-    protected
+      protected
 
       def create_default_site
         desc "Creating default Alchemy site"
@@ -46,8 +45,6 @@ module Alchemy
           log "Alchemy root page was already present.", :skip
         end
       end
-
     end
-
   end
 end

data/lib/alchemy/shell.rb

@@ -2,7 +2,6 @@
 require 'thor/shell/color'
 
 module Alchemy
-
   # Provides methods for collecting sentences and displaying them
   # in a list on the shell / log
   #
@@ -26,7 +25,7 @@ module Alchemy
       end
     end
 
-    def todo(todo, title='')
+    def todo(todo, title = '')
       add_todo [title, todo]
     end
 
@@ -49,15 +48,15 @@ module Alchemy
     # Prints out all the todos
     #
     def display_todos
-      if todos.length > 0
-        log "\nTODOs:", :message
-        log "------\n", :message
-        todos.each_with_index do |todo, i|
-          title = "\n#{i+1}. #{todo[0]}"
-          log title, :message
-          puts '-' * title.length
-          log todo[1], :message
-        end
+      return if todos.empty?
+
+      log "\nTODOs:", :message
+      log "------\n", :message
+      todos.each_with_index do |todo, i|
+        title = "\n#{i + 1}. #{todo[0]}"
+        log title, :message
+        puts '-' * title.length
+        log todo[1], :message
       end
     end
 
@@ -66,7 +65,7 @@ module Alchemy
     # @param [String] message
     # @param [Symbol] type
     #
-    def log(message, type=nil)
+    def log(message, type = nil)
       unless Alchemy::Shell.silenced?
         case type
         when :skip
@@ -81,7 +80,7 @@ module Alchemy
       end
     end
 
-  private
+    private
 
     # Gives the color string using Thor
     # Used for colorizing the message on the shell
@@ -97,6 +96,5 @@ module Alchemy
         ""
       end
     end
-
   end
 end

data/lib/alchemy/tasks/helpers.rb

@@ -1,7 +1,6 @@
 module Alchemy
   module Tasks
     module Helpers
-
       def database_dump_command(adapter)
         database_command(adapter, 'dump')
       end
@@ -11,18 +10,18 @@ module Alchemy
       end
 
       def database_config
-        raise "Could not find #{database_config_file}!" if !File.exists?(database_config_file)
+        raise "Could not find #{database_config_file}!" if !File.exist?(database_config_file)
         @database_config ||= begin
           config_file = YAML.load(ERB.new(File.read(database_config_file)).result)
           config_file.fetch(environment)
-          rescue KeyError
+        rescue KeyError
             raise "Database configuration for #{environment} not found!"
         end
       end
 
       private
 
-      def database_command(adapter, action='import')
+      def database_command(adapter, action = 'import')
         case adapter.to_s
         when /mysql/
           "#{mysql_command(mysql_command_for(action))} #{database_config['database']}"
@@ -33,7 +32,7 @@ module Alchemy
         end
       end
 
-      def mysql_command(cmd='mysql')
+      def mysql_command(cmd = 'mysql')
         command = [cmd]
         if database_config['username']
           command << "--user='#{database_config['username']}'"
@@ -47,7 +46,7 @@ module Alchemy
         command.join(' ')
       end
 
-      def postgres_command(cmd='psql')
+      def postgres_command(cmd = 'psql')
         command = []
         if database_config['password']
           command << "PGPASSWORD='#{database_config['password']}'"
@@ -77,7 +76,6 @@ module Alchemy
       def environment
         ENV['RAILS_ENV'] || 'development'
       end
-
     end
   end
 end

data/lib/alchemy/test_support/essence_shared_examples.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 shared_examples_for "an essence" do
   let(:element) { Alchemy::Element.new }
   let(:content) { Alchemy::Content.new(name: 'foo') }
-  let(:content_description) { {'name' => 'foo'} }
+  let(:content_definition) { {'name' => 'foo'} }
 
   it "touches the content after update" do
     essence.save
@@ -19,8 +19,8 @@ shared_examples_for "an essence" do
     expect(essence.to_partial_path).to eq("alchemy/essences/#{underscored_essence}_view")
   end
 
-  describe '#description' do
-    subject { essence.description }
+  describe '#definition' do
+    subject { essence.definition }
 
     context 'without element' do
       it { is_expected.to eq({}) }
@@ -31,28 +31,28 @@ shared_examples_for "an essence" do
         expect(essence).to receive(:element).at_least(:once).and_return(element)
       end
 
-      context 'but without content descriptions' do
+      context 'but without content definitions' do
         it { is_expected.to eq({}) }
       end
 
-      context 'and content descriptions' do
+      context 'and content definitions' do
         before do
           allow(essence).to receive(:content).and_return(content)
         end
 
         context 'containing the content name' do
           before do
-            expect(element).to receive(:content_descriptions).at_least(:once).and_return([content_description])
+            expect(element).to receive(:content_definitions).at_least(:once).and_return([content_definition])
           end
 
-          it "returns the content description" do
-            is_expected.to eq(content_description)
+          it "returns the content definition" do
+            is_expected.to eq(content_definition)
           end
         end
 
         context 'not containing the content name' do
           before do
-            expect(element).to receive(:content_descriptions).at_least(:once).and_return([])
+            expect(element).to receive(:content_definitions).at_least(:once).and_return([])
           end
 
           it { is_expected.to eq({}) }
@@ -69,16 +69,16 @@ shared_examples_for "an essence" do
   end
 
   describe 'validations' do
-    context 'without essence description in elements.yml' do
+    context 'without essence definition in elements.yml' do
       it 'should return an empty array' do
-        allow(essence).to receive(:description).and_return nil
+        allow(essence).to receive(:definition).and_return nil
         expect(essence.validations).to eq([])
       end
     end
 
-    context 'without validations defined in essence description in elements.yml' do
+    context 'without validations defined in essence definition in elements.yml' do
       it 'should return an empty array' do
-        allow(essence).to receive(:description).and_return({name: 'test', type: 'EssenceText'})
+        allow(essence).to receive(:definition).and_return({name: 'test', type: 'EssenceText'})
         expect(essence.validations).to eq([])
       end
     end
@@ -86,7 +86,7 @@ shared_examples_for "an essence" do
     describe 'presence' do
       context 'with string given as validation type' do
         before do
-          allow(essence).to receive(:description).and_return({'validate' => ['presence']})
+          allow(essence).to receive(:definition).and_return({'validate' => ['presence']})
         end
 
         context 'when the ingredient column is empty' do
@@ -113,7 +113,7 @@ shared_examples_for "an essence" do
       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}]})
+            allow(essence).to receive(:definition).and_return({'validate' => [{'presence' => true}]})
           end
 
           context 'when the ingredient column is empty' do
@@ -139,7 +139,7 @@ shared_examples_for "an essence" do
 
         context 'where the value is false' do
           before do
-            allow(essence).to receive(:description).and_return({'validate' => [{'presence' => false}]})
+            allow(essence).to receive(:definition).and_return({'validate' => [{'presence' => false}]})
           end
 
           it 'should be valid' do
@@ -151,13 +151,13 @@ shared_examples_for "an essence" do
 
     describe 'uniqueness' do
       before do
-        allow(essence).to receive(:element).and_return(build_stubbed(:element))
+        allow(essence).to receive(:element).and_return(build_stubbed(:alchemy_element))
         essence.update(essence.ingredient_column.to_sym => ingredient_value)
       end
 
       context 'with string given as validation type' do
         before do
-          expect(essence).to receive(:description).at_least(:once).and_return({'validate' => ['uniqueness']})
+          expect(essence).to receive(:definition).at_least(:once).and_return({'validate' => ['uniqueness']})
         end
 
         context 'when a duplicate exists' do
@@ -194,7 +194,7 @@ shared_examples_for "an essence" do
       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}]})
+            expect(essence).to receive(:definition).at_least(:once).and_return({'validate' => [{'uniqueness' => true}]})
           end
 
           context 'when a duplicate exists' do
@@ -230,7 +230,7 @@ shared_examples_for "an essence" do
 
         context 'where the value is false' do
           before do
-            allow(essence).to receive(:description).and_return({'validate' => [{'uniqueness' => false}]})
+            allow(essence).to receive(:definition).and_return({'validate' => [{'uniqueness' => false}]})
           end
 
           it 'should be valid' do
@@ -248,8 +248,8 @@ shared_examples_for "an essence" do
   end
 
   context 'delegations' do
-    let(:page)    { create(:restricted_page) }
-    let(:element) { create(:element, name: 'headline', create_contents_after_create: true, page: page) }
+    let(:page)    { create(:alchemy_page, :restricted) }
+    let(:element) { create(:alchemy_element, name: 'headline', create_contents_after_create: true, page: page) }
     let(:content) { element.contents.find_by(essence_type: 'Alchemy::EssenceText') }
     let(:essence) { content.essence }
 
@@ -272,8 +272,8 @@ shared_examples_for "an essence" do
   end
 
   describe 'essence relations' do
-    let(:page)    { create(:restricted_page) }
-    let(:element) { create(:element) }
+    let(:page)    { create(:alchemy_page, :restricted) }
+    let(:element) { create(:alchemy_element) }
 
     it "registers itself on page as essence relation" do
       expect(page.respond_to?(essence.class.model_name.route_key)).to be(true)