Module: Origen::CodeGenerators::Actions

Included in:
Base
Defined in:
lib/origen/code_generators/actions.rb

Instance Method Summary collapse

Instance Method Details

#add_config(*args) ⇒ Object

Adds an entry into config/application.rb


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/origen/code_generators/actions.rb', line 34

def add_config(*args)
  options = args.extract_options!
  name, value = args

  # Set the message to be shown in logs
  message = name.to_s
  if value ||= options.delete(:value)
    message << " (#{value})"
  end
  log :insert, message

  file = File.join(Origen.root, 'config', 'application.rb')
  value = quote(value) if value.is_a?(String)
  value = ":#{value}" if value.is_a?(Symbol)
  insert_into_file file, "  config.#{name} = #{value}\n\n", after: /^\s*class.*\n/
end

#add_source(source, _options = {}) ⇒ Object

Add the given source to Gemfile

add_source "http://gems.github.com/"

106
107
108
109
110
111
112
# File 'lib/origen/code_generators/actions.rb', line 106

def add_source(source, _options = {})
  log :source, source

  in_root do
    prepend_file 'Gemfile', "source #{quote(source)}\n", verbose: false
  end
end

#comment_config(*args) ⇒ Object

Removes (comments out) the specified configuration setting from config/application.rb

comment_config :semantically_version

22
23
24
25
26
27
28
29
30
31
# File 'lib/origen/code_generators/actions.rb', line 22

def comment_config(*args)
  options = args.extract_options!
  name = args.first.to_s

  # Set the message to be shown in logs
  log :comment, name

  file = File.join(Origen.root, 'config', 'application.rb')
  comment_lines(file, /^\s*config.#{name}\s*=.*\n/)
end

#configObject


15
16
17
# File 'lib/origen/code_generators/actions.rb', line 15

def config
  @config
end

#environment(data = nil, options = {}) ⇒ Object Also known as: application

Adds a line inside the Application class for config/application.rb.

If options :env is specified, the line is appended to the corresponding file in config/environments.

environment do
  "config.autoload_paths += %W(#{config.root}/extras)"
end

environment(nil, env: "development") do
  "config.autoload_paths += %W(#{config.root}/extras)"
end

126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# File 'lib/origen/code_generators/actions.rb', line 126

def environment(data = nil, options = {})
  sentinel = /class [a-z_:]+ < Rails::Application/i
  env_file_sentinel = /Rails\.application\.configure do/
  data = yield if !data && block_given?

  in_root do
    if options[:env].nil?
      inject_into_file 'config/application.rb', "\n    #{data}", after: sentinel, verbose: false
    else
      Array(options[:env]).each do |env|
        inject_into_file "config/environments/#{env}.rb", "\n  #{data}", after: env_file_sentinel, verbose: false
      end
    end
  end
end

#gem(*args) ⇒ Object

Adds an entry into Gemfile for the supplied gem.

gem "rspec", group: :test
gem "technoweenie-restful-authentication", lib: "restful-authentication", source: "http://gems.github.com/"
gem "rails", "3.0", git: "git://github.com/rails/rails"

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/origen/code_generators/actions.rb', line 56

def gem(*args)
  options = args.extract_options!
  name, version = args

  # Set the message to be shown in logs. Uses the git repo if one is given,
  # otherwise use name (version).
  parts, message = [quote(name)], name
  if version ||= options.delete(:version)
    parts << quote(version)
    message << " (#{version})"
  end
  message = options[:git] if options[:git]

  log :gemfile, message

  options.each do |option, value|
    parts << "#{option}: #{quote(value)}"
  end

  in_root do
    str = "gem #{parts.join(', ')}"
    str = '  ' + str if @in_group
    str = "\n" + str
    append_file 'Gemfile', str, verbose: false
  end
end

#gem_group(*names, &block) ⇒ Object

Wraps gem entries inside a group.

gem_group :development, :test do
  gem "rspec-rails"
end

88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/origen/code_generators/actions.rb', line 88

def gem_group(*names, &block)
  name = names.map(&:inspect).join(', ')
  log :gemfile, "group #{name}"

  in_root do
    append_file 'Gemfile', "\ngroup #{name} do", force: true

    @in_group = true
    instance_eval(&block)
    @in_group = false

    append_file 'Gemfile', "\nend\n", force: true
  end
end

#generate(what, *args) ⇒ Object

Generate something using a generator from Rails or a plugin. The second parameter is the argument string that is passed to the generator or an Array that is joined.

generate(:authenticated, "user session")

196
197
198
199
200
201
# File 'lib/origen/code_generators/actions.rb', line 196

def generate(what, *args)
  log :generate, what
  argument = args.flat_map(&:to_s).join(' ')

  in_root { run_ruby_script("bin/rails generate #{what} #{argument}", verbose: false) }
end

#git(commands = {}) ⇒ Object

Run a command in git.

git :init
git add: "this.file that.rb"
git add: "onefile.rb", rm: "badfile.cxx"

148
149
150
151
152
153
154
155
156
# File 'lib/origen/code_generators/actions.rb', line 148

def git(commands = {})
  if commands.is_a?(Symbol)
    run "git #{commands}"
  else
    commands.each do |cmd, options|
      run "git #{cmd} #{options}"
    end
  end
end

#initialize(*args) ⇒ Object

:nodoc:


7
8
9
10
11
12
13
# File 'lib/origen/code_generators/actions.rb', line 7

def initialize(*args) # :nodoc:
  if args.last.is_a?(Hash)
    @config = args.last.delete(:config) || {}
  end
  super
  @in_group = nil
end

#lib(filename, data = nil, &block) ⇒ Object

Create a new file in the lib/ directory. Code can be specified in a block or a data string can be given.

lib("crypto.rb") do
  "crypted_special_value = '#{rand}--#{Time.now}--#{rand(1337)}--'"
end

lib("foreign.rb", "# Foreign code is fun")

166
167
168
169
# File 'lib/origen/code_generators/actions.rb', line 166

def lib(filename, data = nil, &block)
  log :lib, filename
  create_file("lib/#{filename}", data, verbose: false, &block)
end

#rake(command, options = {}) ⇒ Object

Runs the supplied rake task

rake("db:migrate")
rake("db:migrate", env: "production")
rake("gems:install", sudo: true)

208
209
210
211
212
213
# File 'lib/origen/code_generators/actions.rb', line 208

def rake(command, options = {})
  log :rake, command
  env  = options[:env] || ENV['RAILS_ENV'] || 'development'
  sudo = options[:sudo] && RbConfig::CONFIG['host_os'] !~ /mswin|mingw/ ? 'sudo ' : ''
  in_root { run("#{sudo}#{extify(:rake)} #{command} RAILS_ENV=#{env}", verbose: false) }
end

#rakefile(filename, data = nil, &block) ⇒ Object

Create a new Rakefile with the provided code (either in a block or a string).

rakefile("bootstrap.rake") do
  project = ask("What is the UNIX name of your project?")

  <<-TASK
    namespace :#{project} do
      task :bootstrap do
        puts "I like boots!"
      end
    end
  TASK
end

rakefile('seed.rake', 'puts "Planting seeds"')

186
187
188
189
# File 'lib/origen/code_generators/actions.rb', line 186

def rakefile(filename, data = nil, &block)
  log :rakefile, filename
  create_file("lib/tasks/#{filename}", data, verbose: false, &block)
end

#readme(path) ⇒ Object

Reads the given file at the source root and prints it in the console.

readme "README"

218
219
220
# File 'lib/origen/code_generators/actions.rb', line 218

def readme(path)
  log File.read(find_in_source_paths(path))
end