Class: Spree::InstallGenerator

Inherits:
Rails::Generators::Base
  • Object
show all
Defined in:
lib/generators/spree/install/install_generator.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.source_paths ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/generators/spree/install/install_generator.rb', line 23

def self.source_paths
  paths = superclass.source_paths
  paths << File.expand_path('../templates', "../../#{__FILE__}")
  paths << File.expand_path('../templates', "../#{__FILE__}")
  paths << File.expand_path('templates', __dir__)
  paths.flatten
end

Instance Method Details

#add_files ⇒ Object 



45
46
47
 
# File 'lib/generators/spree/install/install_generator.rb', line 45

def add_files
  template 'config/initializers/spree.rb', 'config/initializers/spree.rb'
end

#additional_tweaks ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/generators/spree/install/install_generator.rb', line 49

def additional_tweaks
  return unless File.exist? 'public/robots.txt'

  append_file 'public/robots.txt', <<-ROBOTS.strip_heredoc
    User-agent: *
    Disallow: /checkout
    Disallow: /cart
    Disallow: /orders
    Disallow: /user
    Disallow: /account
    Disallow: /api
    Disallow: /password
    Disallow: /api_tokens
    Disallow: /cart_link
    Disallow: /account_link
  ROBOTS
end

#complete ⇒ Object 



212
213
214
215
216
217
218
219
 
# File 'lib/generators/spree/install/install_generator.rb', line 212

def complete
  unless options[:quiet]
    puts '*' * 50
    puts "Spree has been installed successfully. You're all ready to go!"
    puts ' '
    puts 'Enjoy!'
  end
end

#configure_application ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/generators/spree/install/install_generator.rb', line 89

def configure_application
  application <<-APP.strip_heredoc.indent!(4)

    config.to_prepare do
      # Load application's model / class decorators
      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
        Rails.configuration.cache_classes ? require(c) : load(c)
      end

      # Load application's view overrides
      Dir.glob(File.join(File.dirname(__FILE__), "../app/overrides/*.rb")) do |c|
        Rails.configuration.cache_classes ? require(c) : load(c)
      end
    end
  APP

  unless options[:enforce_available_locales].nil?
    application <<-APP.strip_heredoc.indent!(4)
      # Prevent this deprecation message: https://github.com/svenfuchs/i18n/commit/3b6e56e
      I18n.enforce_available_locales = #{options[:enforce_available_locales]}
    APP
  end
end

#copy_storefront ⇒ Object 



83
84
85
86
87
 
# File 'lib/generators/spree/install/install_generator.rb', line 83

def copy_storefront
  if @copy_storefront && Spree::Core::Engine.frontend_available?
    generate 'spree:frontend:copy_storefront'
  end
end

#create_database ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'lib/generators/spree/install/install_generator.rb', line 128

def create_database
  say_status :creating, 'database'
  silence_stream(STDOUT) do
    silence_stream(STDERR) do
      silence_warnings { rake 'db:create' }
    end
  end
end

#create_overrides_directory ⇒ Object 



67
68
69
 
# File 'lib/generators/spree/install/install_generator.rb', line 67

def create_overrides_directory
  empty_directory 'app/overrides'
end

#include_seed_data ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/generators/spree/install/install_generator.rb', line 113

def include_seed_data
  append_file 'db/seeds.rb', <<-SEEDS.strip_heredoc

    Spree::Core::Engine.load_seed if defined?(Spree::Core)
    Spree::Auth::Engine.load_seed if defined?(Spree::Auth)
  SEEDS
end

#install_admin ⇒ Object 



77
78
79
80
81
 
# File 'lib/generators/spree/install/install_generator.rb', line 77

def install_admin
  if @install_admin && Spree::Core::Engine.backend_available?
    generate 'spree:backend:install'
  end
end

#install_migrations ⇒ Object 



121
122
123
124
125
126
 
# File 'lib/generators/spree/install/install_generator.rb', line 121

def install_migrations
  say_status :copying, 'migrations'
  silence_stream(STDOUT) do
    silence_warnings { rake 'railties:install:migrations' }
  end
end

#install_storefront ⇒ Object 



71
72
73
74
75
 
# File 'lib/generators/spree/install/install_generator.rb', line 71

def install_storefront
  if @install_storefront && Spree::Core::Engine.frontend_available?
    generate 'spree:frontend:install'
  end
end

#load_sample_data ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/generators/spree/install/install_generator.rb', line 173

def load_sample_data
  return unless Spree::Core::Engine.sample_available?

  if @load_sample_data
    say_status :loading, 'sample data'
    silence_stream(STDOUT) do
      silence_stream(STDERR) do
        silence_warnings { rake 'spree_sample:load' }
      end
    end
  else
    say_status :skipping, 'sample data (you can always run rake spree_sample:load)'
  end
end

#notify_about_routes ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/generators/spree/install/install_generator.rb', line 188

def notify_about_routes
  insert_into_file(File.join('config', 'routes.rb'),
                   after: "Rails.application.routes.draw do\n") do
    <<-ROUTES.strip_heredoc.indent!(2)
      # This line mounts Spree's routes at the root of your application.
      # This means, any requests to URLs such as /products, will go to
      # Spree::ProductsController.
      # If you would like to change where this engine is mounted, simply change the
      # :at option to something different.
      #
      # We ask that you don't use the :as option here, as Spree relies on it being
      # the default of "spree".
      mount Spree::Core::Engine, at: '/'
    ROUTES
  end

  unless options[:quiet]
    puts '*' * 50
    puts "We added the following line to your application's config/routes.rb file:"
    puts ' '
    puts "    mount Spree::Core::Engine, at: '/'"
  end
end

#populate_seed_data ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/generators/spree/install/install_generator.rb', line 150

def populate_seed_data
  if @load_seed_data
    say_status :loading,  'seed data'
    rake_options = []
    rake_options << 'AUTO_ACCEPT=1' if options[:auto_accept]
    rake_options << "ADMIN_EMAIL=#{options[:admin_email]}" if options[:admin_email]
    rake_options << "ADMIN_PASSWORD=#{options[:admin_password]}" if options[:admin_password]

    cmd = -> { rake("db:seed #{rake_options.join(' ')}") }
    if options[:auto_accept] || (options[:admin_email] && options[:admin_password])
      silence_stream(STDOUT) do
        silence_stream(STDERR) do
          silence_warnings &cmd
        end
      end
    else
      cmd.call
    end
  else
    say_status :skipping, 'seed data (you can always run rake db:seed)'
  end
end

#prepare_options ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/generators/spree/install/install_generator.rb', line 31

def prepare_options
  @run_migrations = options[:migrate]
  @load_seed_data = options[:seed]
  @load_sample_data = options[:sample]
  @install_storefront = options[:install_storefront]
  @install_admin = options[:install_admin]
  @copy_storefront = options[:copy_storefront]

  unless @run_migrations
    @load_seed_data = false
    @load_sample_data = false
  end
end

#run_migrations ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/generators/spree/install/install_generator.rb', line 137

def run_migrations
  if @run_migrations
    say_status :running, 'migrations'
    silence_stream(STDOUT) do
      silence_stream(STDERR) do
        silence_warnings { rake 'db:migrate' }
      end
    end
  else
    say_status :skipping, "migrations (don't forget to run rake db:migrate)"
  end
end