Module: GeneratorHelper

Included in:
ReactOnRails::Generators::AdaptForOlderShakapackerGenerator, ReactOnRails::Generators::BaseGenerator, ReactOnRails::Generators::DevTestsGenerator, ReactOnRails::Generators::InstallGenerator, ReactOnRails::Generators::ReactNoReduxGenerator
Defined in:
lib/generators/react_on_rails/generator_helper.rb

Instance Method Summary collapse

Instance Method Details

#add_documentation_reference(message, source) ⇒ Object 



61
62
63
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 61

def add_documentation_reference(message, source)
  "#{message} \n#{source}"
end

#copy_file_and_missing_parent_directories(source_file, destination_file = nil) ⇒ Object 



53
54
55
56
57
58
59
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 53

def copy_file_and_missing_parent_directories(source_file, destination_file = nil)
  destination_file ||= source_file
  destination_path = Pathname.new(destination_file)
  parent_directories = destination_path.dirname
  empty_directory(parent_directories) unless dest_dir_exists?(parent_directories)
  copy_file source_file, destination_file
end

#dest_dir_exists?(dir) ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
20
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 17

def dest_dir_exists?(dir)
  dest_dir = File.join(destination_root, dir)
  Dir.exist?(dest_dir) ? dest_dir : nil
end

#dest_file_exists?(file) ⇒ Boolean

Takes a relative path from the destination root, such as ‘.gitignore` or `app/assets/javascripts/application.js`

Returns:

  • (Boolean) 


12
13
14
15
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 12

def dest_file_exists?(file)
  dest_file = File.join(destination_root, file)
  File.exist?(dest_file) ? dest_file : nil
end

#empty_directory_with_keep_file(destination, config = {}) ⇒ Object 



30
31
32
33
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 30

def empty_directory_with_keep_file(destination, config = {})
  empty_directory(destination, config)
  keep_file(destination)
end

#keep_file(destination) ⇒ Object 



35
36
37
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 35

def keep_file(destination)
  create_file("#{destination}/.keep") unless options[:skip_keeps]
end

#package_json ⇒ Object 



7
8
9
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 7

def package_json
  @package_json ||= PackageJson.read
end

#setup_file_error(file, data) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 22

def setup_file_error(file, data)
  <<~MSG
    #{file} was not found.
    Please add the following content to your #{file} file:
    #{data}
  MSG
end

#symlink_dest_file_to_dest_file(target, link) ⇒ Object

As opposed to Rails::Generators::Testing.create_link, which creates a link pointing to source_root, this symlinks a file in destination_root to a file also in destination_root.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/generators/react_on_rails/generator_helper.rb', line 42

def symlink_dest_file_to_dest_file(target, link)
  target_pathname = Pathname.new(File.join(destination_root, target))
  link_pathname = Pathname.new(File.join(destination_root, link))

  link_directory = link_pathname.dirname
  link_basename = link_pathname.basename
  target_relative_path = target_pathname.relative_path_from(link_directory)

  `cd #{link_directory} && ln -s #{target_relative_path} #{link_basename}`
end