lib/charyf/utils/generator/actions.rb
# frozen_string_literal: true
module Charyf
module Generators
module Actions
def initialize(*) # :nodoc:
super
@in_group = nil
@after_bundle_callbacks = []
end
# 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 "charyf", "1.0", git: "https://github.com/Charyf/charyf-core"
# gem "RedCloth", ">= 4.1.0", "< 4.2.0"
def gem(*args)
options = args.last.is_a?(Hash) ? args.pop : {}
name, *versions = 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.dup
if versions = versions.any? ? versions : options.delete(:version)
_versions = Array(versions)
_versions.each do |version|
parts << quote(version)
end
message << " (#{_versions.join(", ")})"
end
message = options[:git] if options[:git]
log :gemfile, message
comment = options.delete(:comment)
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
str = "\n#{' ' if @in_group}# #{comment}" + str if comment
append_file "Gemfile", str, verbose: false
end
end
# Wraps gem entries inside a group.
#
# gem_group :development, :test do
# gem "rspec"
# end
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
# Add the given source to +Gemfile+
#
# If block is given, gem entries in block are wrapped into the source group.
#
# add_source "http://gems.github.com/"
#
# add_source "http://gems.github.com/" do
# gem "rspec"
# end
def add_source(source, options = {}, &block)
log :source, source
in_root do
if block
append_file "Gemfile", "\nsource #{quote(source)} do", force: true
@in_group = true
instance_eval(&block)
@in_group = false
append_file "Gemfile", "\nend\n", force: true
else
prepend_file "Gemfile", "source #{quote(source)}\n", verbose: false
end
end
end
# Adds a line inside the Application class for <tt>config/application.rb</tt>.
#
# If options <tt>:env</tt> is specified, the line is appended to the corresponding
# file in <tt>config/environments</tt>.
#
# environment do
# "config.action_controller.asset_host = 'cdn.provider.com'"
# end
#
# environment(nil, env: "development") do
# "config.action_controller.asset_host = 'localhost:3000'"
# end
def environment(data = nil, options = {})
sentinel = "class Application < Charyf::Application\n"
env_file_sentinel = "Charyf.application.configure do\n"
data ||= yield if block_given?
in_root do
if options[:env].nil?
inject_into_file "config/application.rb", optimize_indentation(data, 4), after: sentinel, verbose: false
else
Array(options[:env]).each do |env|
inject_into_file "config/environments/#{env}.rb", optimize_indentation(data, 2), after: env_file_sentinel, verbose: false
end
end
end
end
alias :application :environment
# Run a command in git.
#
# git :init
# git add: "this.file that.rb"
# git add: "onefile.rb", rm: "badfile.cxx"
def git(commands = {})
if commands.is_a?(Symbol)
run "git #{commands}"
else
commands.each do |cmd, options|
run "git #{cmd} #{options}"
end
end
end
# # Create a new file in the <tt>lib/</tt> 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")
# def lib(filename, data = nil)
# log :lib, filename
# data ||= yield if block_given?
# create_file("lib/#{filename}", optimize_indentation(data), verbose: false)
# end
# # 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"')
# def rakefile(filename, data = nil)
# log :rakefile, filename
# data ||= yield if block_given?
# create_file("lib/tasks/#{filename}", optimize_indentation(data), verbose: false)
# end
# # Create a new initializer with the provided code (either in a block or a string).
# #
# # initializer("globals.rb") do
# # data = ""
# #
# # ['MY_WORK', 'ADMINS', 'BEST_COMPANY_EVAR'].each do |const|
# # data << "#{const} = :entp\n"
# # end
# #
# # data
# # end
# #
# # initializer("api.rb", "API_KEY = '123456'")
# def initializer(filename, data = nil)
# log :initializer, filename
# data ||= yield if block_given?
# create_file("config/initializers/#{filename}", optimize_indentation(data), verbose: false)
# end
#
# # Generate something using a generator from Charyf 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")
# def generate(what, *args)
# log :generate, what
# argument = args.flat_map(&:to_s).join(" ")
#
# in_root {run_ruby_script("bin/charyf generate #{what} #{argument}", verbose: false)}
# end
#
# Registers a callback to be executed after bundle and spring binstubs
# have run.
#
# after_bundle do
# git add: '.'
# end
def after_bundle(&block)
@after_bundle_callbacks << block
end
private
# Define log for backwards compatibility. If just one argument is sent,
# invoke say, otherwise invoke say_status. Differently from say and
# similarly to say_status, this method respects the quiet? option given.
def log(*args) # :doc:
if args.size == 1
say args.first.to_s unless options.quiet?
else
args << (behavior == :invoke ? :green : :red)
say_status(*args)
end
end
#
# # Runs the supplied command using either "rake ..." or "charyf ..."
# # based on the executor parameter provided.
# def execute_command(executor, command, options = {}) # :doc:
# log executor, command
# env = options[:env] || ENV["CHARYF_ENV"] || "development"
# sudo = options[:sudo] && !Gem.win_platform? ? "sudo " : ""
# config = {verbose: false}
#
# config.merge!(capture: options[:capture]) if options[:capture]
#
# in_root {run("#{sudo}#{extify(executor)} #{command} CHARYF_ENV=#{env}", config)}
# end
#
# # Add an extension to the given name based on the platform.
# def extify(name) # :doc:
# if Gem.win_platform?
# "#{name}.bat"
# else
# name
# end
# end
# Surround string with single quotes if there is no quotes.
# Otherwise fall back to double quotes
def quote(value) # :doc:
return value.inspect unless value.is_a? String
if value.include?("'")
value.inspect
else
"'#{value}'"
end
end
#
# # Returns optimized string with indentation
# def optimize_indentation(value, amount = 0) # :doc:
# return "#{value}\n" unless value.is_a?(String)
#
# if value.lines.size > 1
# value.strip_heredoc.indent(amount)
# else
# "#{value.strip.indent(amount)}\n"
# end
# end
end
end
end