rails_admin_config_edit_spec.rb

require 'spec_helper'

describe "RailsAdmin Config DSL Edit Section" do

  subject { page }

  describe "attr_accessible" do


    it "should be configurable in the controller scope" do

      RailsAdmin.config do |config|
        config.excluded_models = []
        config.attr_accessible_role do
          _current_user.attr_accessible_role # sould be :custom_role
        end

        config.model FieldTest do
          edit do
            field :string_field
            field :restricted_field
            field :protected_field
          end
        end
      end

      visit new_path(:model_name => "field_test")
      fill_in "field_test[string_field]", :with => "No problem here"
      fill_in "field_test[restricted_field]", :with => "I'm allowed to do that as :custom_role only"
      should have_no_selector "field_test[protected_field]"
      click_button "Save"
      @field_test = FieldTest.first
      @field_test.string_field.should == "No problem here"
      @field_test.restricted_field.should == "I'm allowed to do that as :custom_role only"
    end
  end
  
  describe "css hooks" do
    it "should be present" do
      visit new_path(:model_name => "team")
      should have_selector("#team_division_id_field.field.belongs_to_association_type.division_field")
    end
  end

  describe "field groupings" do

    it "should be hideable" do
      RailsAdmin.config Team do
        edit do
          group :default do
            label "Hidden group"
            hide
          end
        end
      end
      visit new_path(:model_name => "team")
      # Should not have the group header
      should have_no_selector("legend", :text => "Hidden Group")
      # Should not have any of the group's fields either
      should have_no_selector("select#team_division")
      should have_no_selector("input#team_name")
      should have_no_selector("input#team_logo_url")
      should have_no_selector("input#team_manager")
      should have_no_selector("input#team_ballpark")
      should have_no_selector("input#team_mascot")
      should have_no_selector("input#team_founded")
      should have_no_selector("input#team_wins")
      should have_no_selector("input#team_losses")
      should have_no_selector("input#team_win_percentage")
      should have_no_selector("input#team_revenue")
    end

    it "should hide association groupings by the name of the association" do
      RailsAdmin.config Team do
        edit do
          group :players do
            hide
          end
        end
      end
      visit new_path(:model_name => "team")
      # Should not have the group header
      should have_no_selector("legend", :text => "Players")
      # Should not have any of the group's fields either
      should have_no_selector("select#team_player_ids")
    end

    it "should be renameable" do
      RailsAdmin.config Team do
        edit do
          group :default do
            label "Renamed group"
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("legend", :text => "Renamed group")
    end

    describe "help" do

      it "should show help section if present" do
        RailsAdmin.config Team do
          edit do
            group :default do
              help "help paragraph to display"
            end
          end
        end
        visit new_path(:model_name => "team")
        should have_selector('legend small', :text => "help paragraph to display")
      end

      it "should not show help if not present" do
        RailsAdmin.config Team do
          edit do
            group :default do
              label 'no help'
            end
          end
        end
        visit new_path(:model_name => "team")
        should_not have_selector('legend small')
      end

      it "should be able to display multiple help if there are multiple sections" do
        RailsAdmin.config Team do
          edit do
            group :default do
              field :name
              help 'help for default'
            end
            group :other_section do
              label "Other Section"
              field :division
              help 'help for other section'
            end
          end
        end
        visit new_path(:model_name => "team")
        should have_selector("legend small", :text => 'help for default')
        should have_selector("legend small", :text => 'help for other section')
        should have_selector("legend small", :count => 2)
      end
    end

    it "should have accessor for its fields" do
      RailsAdmin.config Team do
        edit do
          group :default do
            field :name
            field :logo_url
          end
          group :belongs_to_associations do
            label "Belong's to associations"
            field :division
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("legend", :text => "Basic info")
      should have_selector("legend", :text => "Belong's to associations")
      should have_selector("label", :text => "Name")
      should have_selector("label", :text => "Logo url")
      should have_selector("label", :text => "Division")
      should have_selector(".field", :count => 3)
    end

    it "should have accessor for its fields by type" do
      RailsAdmin.config Team do
        edit do
          group :default do
            field :name
            field :logo_url
          end
          group :other do
            field :division_id
            field :manager
            field :ballpark
            fields_of_type :string do
              label { "#{label} (STRING)" }
            end
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Name")
      should have_selector("label", :text => "Logo url")
      should have_selector("label", :text => "Division")
      should have_selector("label", :text => "Manager (STRING)")
      should have_selector("label", :text => "Ballpark (STRING)")
    end
  end

  describe "items' fields" do

    it "should show all by default" do
      visit new_path(:model_name => "team")
      should have_selector("select#team_division_id")
      should have_selector("input#team_name")
      should have_selector("input#team_logo_url")
      should have_selector("input#team_manager")
      should have_selector("input#team_ballpark")
      should have_selector("input#team_mascot")
      should have_selector("input#team_founded")
      should have_selector("input#team_wins")
      should have_selector("input#team_losses")
      should have_selector("input#team_win_percentage")
      should have_selector("input#team_revenue")
      should have_selector("select#team_player_ids")
      should have_selector("select#team_fan_ids")
    end

    it "should appear in order defined" do
      RailsAdmin.config Team do
        edit do
          field :manager
          field :division
          field :name
        end
      end
      visit new_path(:model_name => "team")
      should have_selector(:xpath, "//*[contains(@class, 'field')][1]//*[@id='team_manager']")
      should have_selector(:xpath, "//*[contains(@class, 'field')][2]//*[@id='team_division_id']")
      should have_selector(:xpath, "//*[contains(@class, 'field')][3]//*[@id='team_name']")
    end

    it "should only show the defined fields if some fields are defined" do
      RailsAdmin.config Team do
        edit do
          field :division
          field :name
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Division")
      should have_selector("label", :text => "Name")
      should have_selector(".field", :count => 2)
    end

    it "should delegates the label option to the ActiveModel API" do
      RailsAdmin.config Team do
        edit do
          field :manager
          field :fans
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Team Manager")
      should have_selector("label", :text => "Some Fans")
    end

    it "should be renameable" do
      RailsAdmin.config Team do
        edit do
          field :manager do
            label "Renamed field"
          end
          field :division
          field :name
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Renamed field")
      should have_selector("label", :text => "Division")
      should have_selector("label", :text => "Name")
    end

    it "should be renameable by type" do
      RailsAdmin.config Team do
        edit do
          fields_of_type :string do
            label { "#{label} (STRING)" }
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Division")
      should have_selector("label", :text => "Name (STRING)")
      should have_selector("label", :text => "Logo url (STRING)")
      should have_selector("label", :text => "Manager (STRING)")
      should have_selector("label", :text => "Ballpark (STRING)")
      should have_selector("label", :text => "Mascot (STRING)")
      should have_selector("label", :text => "Founded")
      should have_selector("label", :text => "Wins")
      should have_selector("label", :text => "Losses")
      should have_selector("label", :text => "Win percentage")
      should have_selector("label", :text => "Revenue")
      should have_selector("label", :text => "Players")
      should have_selector("label", :text => "Fans")
    end

    it "should be globally renameable by type" do
      RailsAdmin::Config.models do
        edit do
          fields_of_type :string do
            label { "#{label} (STRING)" }
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Division")
      should have_selector("label", :text => "Name (STRING)")
      should have_selector("label", :text => "Logo url (STRING)")
      should have_selector("label", :text => "Manager (STRING)")
      should have_selector("label", :text => "Ballpark (STRING)")
      should have_selector("label", :text => "Mascot (STRING)")
      should have_selector("label", :text => "Founded")
      should have_selector("label", :text => "Wins")
      should have_selector("label", :text => "Losses")
      should have_selector("label", :text => "Win percentage")
      should have_selector("label", :text => "Revenue")
      should have_selector("label", :text => "Players")
      should have_selector("label", :text => "Fans")
    end

    it "should be flaggable as read only and be configurable with formatted_value" do
      RailsAdmin.config Team do
        edit do
          field :name do
            read_only true
            formatted_value do
              "I'm outputed in the form"
            end
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_content("I'm outputed in the form")
    end

    it "should be hideable" do
      RailsAdmin.config Team do
        edit do
          field :manager do
            hide
          end
          field :division
          field :name
        end
      end
      visit new_path(:model_name => "team")
      should have_no_selector("#team_manager")
      should have_selector("#team_division_id")
      should have_selector("#team_name")
    end

    it "should be hideable by type" do
      RailsAdmin.config Team do
        edit do
          fields_of_type :string do
            hide
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Division")
      should have_no_selector("label", :text => "Name")
      should have_no_selector("label", :text => "Logo url")
      should have_no_selector("label", :text => "Manager")
      should have_no_selector("label", :text => "Ballpark")
      should have_no_selector("label", :text => "Mascot")
      should have_selector("label", :text => "Founded")
      should have_selector("label", :text => "Wins")
      should have_selector("label", :text => "Losses")
      should have_selector("label", :text => "Win percentage")
      should have_selector("label", :text => "Revenue")
      should have_selector("label", :text => "Players")
      should have_selector("label", :text => "Fans")
    end

    it "should be globally hideable by type" do
      RailsAdmin::Config.models do
        edit do
          fields_of_type :string do
            hide
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector("label", :text => "Division")
      should have_no_selector("label", :text => "Name")
      should have_no_selector("label", :text => "Logo url")
      should have_no_selector("label", :text => "Manager")
      should have_no_selector("label", :text => "Ballpark")
      should have_no_selector("label", :text => "Mascot")
      should have_selector("label", :text => "Founded")
      should have_selector("label", :text => "Wins")
      should have_selector("label", :text => "Losses")
      should have_selector("label", :text => "Win percentage")
      should have_selector("label", :text => "Revenue")
      should have_selector("label", :text => "Players")
      should have_selector("label", :text => "Fans")
    end

    it "should have option to customize the help text" do
      RailsAdmin.config Team do
        edit do
          field :manager do
            help "#{help} Additional help text for manager field."
          end
          field :division
          field :name
        end
      end
      visit new_path(:model_name => "team")
      find("#team_manager_field .help-block").should have_content("Required. 100 characters or fewer. Additional help text for manager field.")
      find("#team_division_id_field .help-block").should have_content("Required")
      find("#team_name_field .help-block").should have_content("Optional. 50 characters or fewer.")
    end

    it "should have option to override required status" do
      RailsAdmin.config Team do
        edit do
          field :manager do
            optional true
          end
          field :division do
            optional true
          end
          field :name do
            required true
          end
        end
      end
      visit new_path(:model_name => "team")
      find("#team_manager_field .help-block").should have_content("Optional. 100 characters or fewer.")
      find("#team_division_id_field .help-block").should have_content("Optional")
      find("#team_name_field .help-block").should have_content("Required. 50 characters or fewer.")
    end
  end

  describe "input format of" do

    before(:each) do
      RailsAdmin::Config.excluded_models = [RelTest]
      @time = ::Time.now.getutc
    end

    describe "a datetime field" do

      it "should default to %B %d, %Y %H:%M" do
        visit new_path(:model_name => "field_test")
        fill_in "field_test[datetime_field]", :with => @time.strftime("%B %d, %Y %H:%M")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.datetime_field.strftime("%Y-%m-%d %H:%M").should eql(@time.strftime("%Y-%m-%d %H:%M"))
      end

      it "should have a simple customization option" do
        RailsAdmin.config FieldTest do
          edit do
            field :datetime_field do
              date_format :default
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[datetime_field]", :with => @time.strftime("%a, %d %b %Y %H:%M:%S")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.datetime_field.should eql(::DateTime.parse(@time.to_s))
      end

      it "should have a customization option" do
        RailsAdmin.config FieldTest do
          list do
            field :datetime_field do
              strftime_format "%Y-%m-%d %H:%M:%S"
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[datetime_field]", :with => @time.strftime("%Y-%m-%d %H:%M:%S")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.datetime_field.should eql(::DateTime.parse(@time.to_s))
      end
    end

    describe "a timestamp field" do

      it "should default to %B %d, %Y %H:%M" do
        visit new_path(:model_name => "field_test")
        fill_in "field_test[timestamp_field]", :with => @time.strftime("%B %d, %Y %H:%M")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.timestamp_field.strftime("%Y-%m-%d %H:%M").should eql(@time.strftime("%Y-%m-%d %H:%M"))
      end

      it "should have a simple customization option" do
        RailsAdmin.config FieldTest do
          edit do
            field :timestamp_field do
              date_format :default
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[timestamp_field]", :with => @time.strftime("%a, %d %b %Y %H:%M:%S")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.timestamp_field.should eql(::DateTime.parse(@time.to_s))
      end

      it "should have a customization option" do
        RailsAdmin.config FieldTest do
          edit do
            field :timestamp_field do
              strftime_format "%Y-%m-%d %H:%M:%S"
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[timestamp_field]", :with => @time.strftime("%Y-%m-%d %H:%M:%S")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.timestamp_field.should eql(::DateTime.parse(@time.to_s))
      end
    end

    describe " a field with 'format' as a name (Kernel function)" do

      it "should be updatable without any error" do
        RailsAdmin.config FieldTest do
          edit do
            field :format
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[format]", :with => "test for format"
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.format.should eql("test for format")
      end
    end


    describe "a time field" do

      it "should default to %H:%M" do
        visit new_path(:model_name => "field_test")
        fill_in "field_test[time_field]", :with => @time.strftime("%H:%M")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.time_field.strftime("%H:%M").should eql(@time.strftime("%H:%M"))
      end

      it "should have a customization option" do
        RailsAdmin.config FieldTest do
          edit do
            field :time_field do
              strftime_format "%I:%M %p"
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[time_field]", :with => @time.strftime("%I:%M %p")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.time_field.strftime("%H:%M").should eql(@time.strftime("%H:%M"))
      end
    end

    describe "a date field" do

      it "should default to %B %d, %Y" do
        visit new_path(:model_name => "field_test")
        fill_in "field_test[date_field]", :with => @time.strftime("%B %d, %Y")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.date_field.should eql(::Date.parse(@time.to_s))
      end

      it "should cover a timezone lag even if in UTC+n:00 timezone." do
        Time.zone = 'Tokyo' # +09:00

        visit new_path(:model_name => "field_test")
        fill_in "field_test[date_field]", :with => @time.strftime("%B %d, %Y")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.date_field.should eql(::Date.parse(@time.to_s))
      end

      it "should have a simple customization option" do
        RailsAdmin.config FieldTest do
          edit do
            field :date_field do
              date_format :default
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[date_field]", :with => @time.strftime("%Y-%m-%d")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.date_field.should eql(::Date.parse(@time.to_s))
      end

      it "should have a customization option" do
        RailsAdmin.config FieldTest do
          edit do
            field :date_field do
              strftime_format "%Y-%m-%d"
            end
          end
        end
        visit new_path(:model_name => "field_test")
        fill_in "field_test[date_field]", :with => @time.strftime("%Y-%m-%d")
        click_button "Save"
        @record = RailsAdmin::AbstractModel.new("FieldTest").first
        @record.date_field.should eql(::Date.parse(@time.to_s))
      end
    end
  end

  describe "fields which are nullable and have AR validations" do

    it "should be required" do
      # draft.notes is nullable and has no validation
      field = RailsAdmin::config("Draft").edit.fields.find{|f| f.name == :notes}
      field.properties[:nullable?].should be true
      field.required?.should be false

      # draft.date is nullable in the schema but has an AR
      # validates_presence_of validation that makes it required
      field = RailsAdmin::config("Draft").edit.fields.find{|f| f.name == :date}
      field.properties[:nullable?].should be true
      field.required?.should be true

      # draft.round is nullable in the schema but has an AR
      # validates_numericality_of validation that makes it required
      field = RailsAdmin::config("Draft").edit.fields.find{|f| f.name == :round}
      field.properties[:nullable?].should be true
      field.required?.should be true

      # team.revenue is nullable in the schema but has an AR
      # validates_numericality_of validation that allows nil
      field = RailsAdmin::config("Team").edit.fields.find{|f| f.name == :revenue}
      field.properties[:nullable?].should be true
      field.required?.should be false
    end
  end

  describe "CKEditor Support" do

    it "should start with CKEditor disabled" do
       field = RailsAdmin::config("Draft").edit.fields.find{|f| f.name == :notes}
       field.ckeditor.should be false
    end

    it "should add Javascript to enable CKEditor" do
      RailsAdmin.config Draft do
        edit do
          field :notes do
            ckeditor true
          end
        end
      end
      visit new_path(:model_name => "draft")
      should have_selector("script", :text => /CKEDITOR\.replace.*?draft_notes/)
    end
  end

  describe "Paperclip Support" do

    it "should show a file upload field" do
      RailsAdmin.config User do
        edit do
          field :avatar
        end
      end
      visit new_path(:model_name => "user")
      should have_selector("input#user_avatar")
    end
  end

  describe "Enum field support" do
    it "should auto-detect enumeration when object responds to '\#{method}_enum'" do
      class Team
        def color_enum
          ["blue", "green", "red"]
        end
      end
      RailsAdmin.config Team do
        edit do
          field :color
        end
      end
      visit new_path(:model_name => "team")
      should have_selector(".enum_type select")
      should have_content("green")
      Team.send(:remove_method, :color_enum) # Reset
    end

    it "should allow configuration of the enum method" do
      class Team
        def color_list
          ["blue", "green", "red"]
        end
      end
      RailsAdmin.config Team do
        edit do
          field :color, :enum do
            enum_method :color_list
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector(".enum_type select")
      should have_content("green")
      Team.send(:remove_method, :color_list) # Reset
    end

    it "should allow direct listing of enumeration options and override enum method" do
      class Team
        def color_list
          ["blue", "green", "red"]
        end
      end
      RailsAdmin.config Team do
        edit do
          field :color, :enum do
            enum_method :color_list
            enum do
              ["yellow", "black"]
            end
          end
        end
      end
      visit new_path(:model_name => "team")
      should have_selector(".enum_type select")
      should have_no_content("green")
      should have_content("yellow")
      Team.send(:remove_method, :color_list) # Reset
    end

  end

  describe "ColorPicker Support" do
    it "should show input with class color" do
      RailsAdmin.config Team do
        edit do
          field :color, :color
        end
      end
      visit new_path(:model_name => "team")
      should have_selector(".color_type input")
    end
  end
end