Class: Rails::PluginBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/rails/generators/rails/plugin/plugin_generator.rb

Overview

The plugin builder allows you to override elements of the plugin generator without being forced to reverse the operations of the default generator.

This allows you to override entire operations, like the creation of the Gemfile, README, or JavaScript files, without needing to know exactly what those operations do so you can create another template action.

Constant Summary collapse

PASSTHROUGH_OPTIONS = 
[
  :skip_active_record, :skip_action_mailer, :skip_javascript, :skip_sprockets, :database,
  :javascript, :quiet, :pretend, :force, :skip
]

Instance Method Summary collapse

Instance Method Details

#app ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 18

def app
  if mountable?
    if api?
      directory "app", exclude_pattern: %r{app/(views|helpers)}
    else
      directory "app"
      empty_directory_with_keep_file "app/assets/images/#{namespaced_name}"
    end
  elsif full?
    empty_directory_with_keep_file "app/models"
    empty_directory_with_keep_file "app/controllers"
    empty_directory_with_keep_file "app/mailers"

    unless api?
      empty_directory_with_keep_file "app/assets/images/#{namespaced_name}"
      empty_directory_with_keep_file "app/helpers"
      empty_directory_with_keep_file "app/views"
    end
  end
end

#assets_manifest ⇒ Object 



128
129
130
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 128

def assets_manifest
  template "rails/engine_manifest.js", "app/assets/config/#{underscored_name}_manifest.js"
end

#bin(force = false) ⇒ Object 



152
153
154
155
156
157
158
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 152

def bin(force = false)
  bin_file = engine? ? "bin/rails.tt" : "bin/test.tt"
  template bin_file, force: force do |content|
    "#{shebang}\n" + content
  end
  chmod "bin", 0755, verbose: false
end

#config ⇒ Object 



66
67
68
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 66

def config
  template "config/routes.rb" if engine?
end

#gemfile ⇒ Object 



43
44
45
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 43

def gemfile
  template "Gemfile"
end

#gemfile_entry ⇒ Object 



160
161
162
163
164
165
166
167
168
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 160

def gemfile_entry
  return unless inside_application?

  gemfile_in_app_path = File.join(rails_app_path, "Gemfile")
  if File.exist? gemfile_in_app_path
    entry = "gem '#{name}', path: '#{relative_path}'"
    append_file gemfile_in_app_path, entry
  end
end

#gemspec ⇒ Object 



51
52
53
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 51

def gemspec
  template "%name%.gemspec"
end

#generate_test_dummy(force = false) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 88

def generate_test_dummy(force = false)
  opts = (options || {}).slice(*PASSTHROUGH_OPTIONS)
  opts[:force] = force
  opts[:skip_bundle] = true
  opts[:api] = options.api?
  opts[:skip_listen] = true
  opts[:skip_git] = true
  opts[:skip_turbolinks] = true

  invoke Rails::Generators::AppGenerator,
    [ File.expand_path(dummy_path, destination_root) ], opts
end

#gitignore ⇒ Object 



55
56
57
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 55

def gitignore
  template "gitignore", ".gitignore"
end

#javascripts ⇒ Object 



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 141

def javascripts
  return if options.skip_javascript?

  if mountable?
    template "rails/javascripts.js",
             "app/assets/javascripts/#{namespaced_name}/application.js"
  elsif full?
    empty_directory_with_keep_file "app/assets/javascripts/#{namespaced_name}"
  end
end

#lib ⇒ Object 



59
60
61
62
63
64
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 59

def lib
  template "lib/%namespaced_name%.rb"
  template "lib/tasks/%namespaced_name%_tasks.rake"
  template "lib/%namespaced_name%/version.rb"
  template "lib/%namespaced_name%/engine.rb" if engine?
end

#license ⇒ Object 



47
48
49
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 47

def license
  template "MIT-LICENSE"
end

#rakefile ⇒ Object 



14
15
16
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 14

def rakefile
  template "Rakefile"
end

#readme ⇒ Object 



39
40
41
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 39

def readme
  template "README.md"
end

#stylesheets ⇒ Object 



132
133
134
135
136
137
138
139
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 132

def stylesheets
  if mountable?
    copy_file "rails/stylesheets.css",
              "app/assets/stylesheets/#{namespaced_name}/application.css"
  elsif full?
    empty_directory_with_keep_file "app/assets/stylesheets/#{namespaced_name}"
  end
end

#test ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 70

def test
  template "test/test_helper.rb"
  template "test/%namespaced_name%_test.rb"
  append_file "Rakefile", <<-EOF
#{rakefile_test_tasks}

task default: :test
  EOF
  if engine?
    template "test/integration/navigation_test.rb"
  end
end

#test_dummy_assets ⇒ Object 



109
110
111
112
113
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 109

def test_dummy_assets
  template "rails/javascripts.js",    "#{dummy_path}/app/assets/javascripts/application.js", force: true
  template "rails/stylesheets.css",   "#{dummy_path}/app/assets/stylesheets/application.css", force: true
  template "rails/dummy_manifest.js", "#{dummy_path}/app/assets/config/manifest.js", force: true
end

#test_dummy_clean ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 115

def test_dummy_clean
  inside dummy_path do
    remove_file "db/seeds.rb"
    remove_file "doc"
    remove_file "Gemfile"
    remove_file "lib/tasks"
    remove_file "public/robots.txt"
    remove_file "README.md"
    remove_file "test"
    remove_file "vendor"
  end
end

#test_dummy_config ⇒ Object 



101
102
103
104
105
106
107
 
# File 'lib/rails/generators/rails/plugin/plugin_generator.rb', line 101

def test_dummy_config
  template "rails/boot.rb", "#{dummy_path}/config/boot.rb", force: true
  template "rails/application.rb", "#{dummy_path}/config/application.rb", force: true
  if mountable?
    template "rails/routes.rb", "#{dummy_path}/config/routes.rb", force: true
  end
end