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 



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

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 



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

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

#complete ⇒ Object 



180
181
182
183
184
185
186
187
 
# File 'lib/generators/spree/install/install_generator.rb', line 180

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 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/generators/spree/install/install_generator.rb', line 81

def configure_application
  application "\n    config.to_prepare do\n      # Load application's model / class decorators\n      Dir.glob(File.join(File.dirname(__FILE__), \"../app/**/*_decorator*.rb\")) do |c|\n        Rails.configuration.cache_classes ? require(c) : load(c)\n      end\n    end\n  APP\n\n  unless options[:enforce_available_locales].nil?\n    application <<-APP.strip_heredoc.indent!(4)\n      # Prevent this deprecation message: https://github.com/svenfuchs/i18n/commit/3b6e56e\n      I18n.enforce_available_locales = \#{options[:enforce_available_locales]}\n    APP\n  end\nend\n".strip_heredoc.indent!(4)

#include_seed_data ⇒ Object 



100
101
102
103
104
105
 
# File 'lib/generators/spree/install/install_generator.rb', line 100

def include_seed_data
  append_file 'db/seeds.rb', "\n    Spree::Core::Engine.load_seed if defined?(Spree::Core)\n  SEEDS\nend\n".strip_heredoc

#install_admin ⇒ Object 



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/generators/spree/install/install_generator.rb', line 70

def install_admin
  if @install_admin && Spree::Core::Engine.admin_available?
    generate 'spree:admin:install'

    # generate devise controllers if authentication is devise
    if @authentication == 'devise'
      generate 'spree:admin:devise'
    end
  end
end

#install_authentication ⇒ Object

Currently we only support devise, in the future we will also add support for default Rails authentication



51
52
53
54
55
56
57
 
# File 'lib/generators/spree/install/install_generator.rb', line 51

def install_authentication
  if @authentication == 'devise'
    generate 'spree:authentication:devise'
  elsif @authentication == 'dummy'
    # this is for dummy / test app
  end
end

#install_migrations ⇒ Object 



107
108
109
110
111
112
113
114
115
 
# File 'lib/generators/spree/install/install_generator.rb', line 107

def install_migrations
  say_status :copying, 'migrations'
  silence_stream(STDOUT) do
    silence_warnings { rake 'active_storage:install:migrations' }
    silence_warnings { rake 'action_text:install:migrations' }
    silence_warnings { rake 'spree:install:migrations' }
    silence_warnings { rake 'spree_api:install:migrations' }
  end
end

#install_storefront ⇒ Object 



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/generators/spree/install/install_generator.rb', line 59

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

    # generate devise controllers if authentication is devise
    if @authentication == 'devise'
      generate 'spree:storefront:devise'
    end
  end
end

#load_sample_data ⇒ Object 



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/generators/spree/install/install_generator.rb', line 145

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

  if @load_sample_data
    say_status :loading, 'sample data'
    rake 'spree_sample:load'
  else
    say_status :skipping, 'sample data (you can always run rake spree_sample:load)'
  end
end

#notify_about_routes ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/generators/spree/install/install_generator.rb', line 156

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

#populate_seed_data ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/generators/spree/install/install_generator.rb', line 126

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_warnings &cmd
    else
      cmd.call
    end
  else
    say_status :skipping, 'seed data (you can always run bin/rails db:seed)'
  end
end

#prepare_options ⇒ Object 



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

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]
  @authentication = options[:authentication]

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

#run_migrations ⇒ Object 



117
118
119
120
121
122
123
124
 
# File 'lib/generators/spree/install/install_generator.rb', line 117

def run_migrations
  if @run_migrations
    say_status :running, 'migrations'
    rake 'db:migrate'
  else
    say_status :skipping, "migrations (don't forget to run rake db:migrate)"
  end
end