Module: Pageflow::Seeds

Defined in:
lib/pageflow/seeds.rb

Overview

Provides a DSL for seeding the database with Pageflow models. Include this module in your ‘db/seeds.rb` file.

Examples:


# db/seeds.rb
include Pageflow::Seeds

default_password 'supersecret'

(name: 'example') do ||
  user(account: ,
       email: '[email protected]',
       role: 'admin',
       first_name: 'John',
       last_name: 'Doe')
end

Constant Summary collapse

DEFAULT_USER_PASSWORD = 
'!Pass123'

Instance Method Summary collapse

Instance Method Details

#account(attributes) {|account| ... } ⇒ Account

Create an Account with a default Theming if no account by that name exists.

Parameters:

  • attributes (Hash) —

    attributes to override defaults

Options Hash (attributes):

  • :name (String) —

    required

Yields:

  • (account) —

    a block to be called before the account is saved

Returns:

  • (Account) —

    newly created account



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/pageflow/seeds.rb', line 29

def (attributes, &block)
  Account.find_or_create_by!(attributes.slice(:name)) do ||
    .attributes = attributes.reverse_merge(name: 'Pageflow')

    build_default_theming_for()

    ()
    yield() if block_given?
  end
end

#build_default_theming_for(account, attributes = {}) {|theming| ... } ⇒ Theming

Build a default Theming for an Account. To be used inside a block passed to #account.

Examples:


(name: 'example') do ||
  build_default_theming_for() do |theming|
    theming.theme_name = 'mdr'
  end
end

Parameters:

  • account (Account) —

    the account to build a default themeing for

  • attributes (Hash) (defaults to: {}) —

    further attributes to override defaults

Yields:

  • (theming) —

    a block which is passed the newly built theming

Returns:

  • (Theming) —

    newly built theming



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/pageflow/seeds.rb', line 55

def build_default_theming_for(, attributes = {}, &block)
  default_attributes = {
    imprint_link_label: 'Impressum',
    imprint_link_url: 'http://example.com/impressum.html',
    copyright_link_label: '© Pageflow 2014',
    copyright_link_url: 'http://www.example.com/copyright.html'
  }

  .build_default_theming(default_attributes.merge(attributes), &block)
end

#default_user_password(password = nil) ⇒ Object

Set the default password to use for created users. Call before using #user.

Parameters:

  • password (String) (defaults to: nil) 


92
93
94
95
96
97
98
 
# File 'lib/pageflow/seeds.rb', line 92

def default_user_password(password = nil)
  if password
    @default_user_password = password
  else
    @default_user_password || DEFAULT_USER_PASSWORD
  end
end

#membership(attributes) ⇒ Membership

Create a Membership for the given user and entity. Create a Membership for the corresponding account first if a Membership on an entry is to be created and no Membership on the entry’s account exists yet.

:entry and :account are lower-priority aliases for :entity

Parameters:

  • attributes (Hash) —

    attributes to override defaults

Options Hash (attributes):

  • :user (User) —

    required

  • :entity (Entity) —

    required

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/pageflow/seeds.rb', line 141

def membership(attributes)
  if (attributes[:entry].present? && attributes[:entity].present?) ||
     (attributes[:account].present? && attributes[:entity].present?)
    say_attribute_precedence(':entity', ':entry and :account')
  end
  unless attributes[:entity].present?
     attributes
  end

  if attributes[:entity].is_a?(Entry) || attributes[:entry].present?
    entry = attributes[:entity] || attributes[:entry]
    unless attributes[:user].accounts.include?(entry.)
      Membership.find_or_create_by!(entity: entry.,
                                    user: attributes[:user],
                                    role: :member) do |membership|
        say_creating_membership(membership)
      end
    end
  end

  Membership.find_or_create_by!(attributes) do |membership|
    say_creating_membership(membership)
  end
end

#sample_entry(attributes) {|entry| ... } ⇒ Entry

Create a sample Entry with some chapter and pages if no entry with that title exists in the given account.

Parameters:

  • attributes (Hash) —

    attributes to override defaults

Options Hash (attributes):

  • :account (Account) —

    required

  • :title (title) —

    required

Yields:

  • (entry) —

    a block to be called before the entry is saved

Returns:

  • (Entry) —

    newly created entry



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/pageflow/seeds.rb', line 108

def sample_entry(attributes)
  entry = Entry.where(attributes.slice(:account, :title)).first

  if entry.nil?
    entry = Entry.create!(attributes) do |created_entry|
      created_entry.theming = attributes.fetch(:account).default_theming

      say_creating_entry(created_entry)
      yield(created_entry) if block_given?
    end

    storyline = entry.draft.storylines.first

    chapter = storyline.chapters.create!(title: 'Chapter 1', position: 0)
    chapter.pages.create!(template: 'background_image')
    chapter.pages.create!(template: 'background_image')

    chapter = storyline.chapters.create!(title: 'Chapter 2', position: 1)
    chapter.pages.create!(template: 'video')
  end

  entry
end

#user(attributes) {|user| ... } ⇒ User

Create a User if none with the given email exists yet.

Parameters:

  • attributes (Hash) —

    attributes to override defaults

Options Hash (attributes):

  • :email (String) —

    required

Yields:

  • (user) —

    a block to be called before the user is saved

Returns:

  • (User) —

    newly created user



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/pageflow/seeds.rb', line 72

def user(attributes, &block)
  default_attributes = {
    password: default_user_password,
    first_name: 'Elliot',
    last_name: 'Example'
  }

  User.find_or_create_by!(attributes.slice(:email)) do |user|
    user.attributes = default_attributes.merge(attributes)
    user.password_confirmation = user.password

    say_creating_user(user)
    yield(user) if block_given?
  end
end