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 



19
20
21
22
23
24
25
 
# File 'lib/generators/spree/install/install_generator.rb', line 19

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

Instance Method Details

#add_files ⇒ Object 



38
39
40
 
# File 'lib/generators/spree/install/install_generator.rb', line 38

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

#additional_tweaks ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/generators/spree/install/install_generator.rb', line 42

def additional_tweaks
  return unless File.exists? 'public/robots.txt'
  append_file "public/robots.txt", "    User-agent: *\n    Disallow: /checkout\n    Disallow: /cart\n    Disallow: /orders\n    Disallow: /user\n    Disallow: /account\n    Disallow: /api\n    Disallow: /password\n  ROBOTS\nend\n".strip_heredoc

#complete ⇒ Object 



199
200
201
202
203
204
205
206
 
# File 'lib/generators/spree/install/install_generator.rb', line 199

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 



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

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\n      # Load application's view overrides\n      Dir.glob(File.join(File.dirname(__FILE__), \"../app/overrides/*.rb\")) do |c|\n        Rails.configuration.cache_classes ? require(c) : load(c)\n      end\n    end\n  APP\n\n  if !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)

#create_database ⇒ Object 



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

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 



74
75
76
 
# File 'lib/generators/spree/install/install_generator.rb', line 74

def create_overrides_directory
  empty_directory "app/overrides"
end

#include_seed_data ⇒ Object 



102
103
104
105
106
107
108
 
# File 'lib/generators/spree/install/install_generator.rb', line 102

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

#install_migrations ⇒ Object 



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

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

#load_sample_data ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/generators/spree/install/install_generator.rb', line 162

def load_sample_data
  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 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/generators/spree/install/install_generator.rb', line 175

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 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/generators/spree/install/install_generator.rb', line 139

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 = lambda { 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 



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/generators/spree/install/install_generator.rb', line 27

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

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

#run_migrations ⇒ Object 



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

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

#setup_assets ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/generators/spree/install/install_generator.rb', line 56

def setup_assets
  @lib_name = 'spree'
  %w{javascripts stylesheets images}.each do |path|
    empty_directory "vendor/assets/#{path}/spree/frontend" if defined? Spree::Frontend || Rails.env.test?
    empty_directory "vendor/assets/#{path}/spree/backend" if defined? Spree::Backend || Rails.env.test?
  end

  if defined? Spree::Frontend || Rails.env.test?
    template "vendor/assets/javascripts/spree/frontend/all.js"
    template "vendor/assets/stylesheets/spree/frontend/all.css"
  end

  if defined? Spree::Backend || Rails.env.test?
    template "vendor/assets/javascripts/spree/backend/all.js"
    template "vendor/assets/stylesheets/spree/backend/all.css"
  end
end