Module: Biogem::Render

Included in:
Jeweler::Generator
Defined in:
lib/bio-gem/generator/render.rb

Instance Method Summary collapse

Instance Method Details

#after_render_template(source, buf) ⇒ Object

new hook for removing stuff (FIXME: could use a test!!)



7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/bio-gem/generator/render.rb', line 7

def after_render_template(source,buf)
  if source == 'other_tasks.erb'
    $stdout.puts "\tremove jeweler rcov lines"
    # remove rcov related lines from jeweler Rakefile
    remove = "require 'rcov/rcovtask'"
    if buf =~ /#{remove}/
      # $stdout.puts buf,'---'
      buf1 = buf.split(/\n/)
      i = buf1.index(remove)
      buf = (buf1[0..i-1] + buf1[i+7..-1]).join("\n")
    end
  end
  buf
end

#create_bin ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/bio-gem/generator/render.rb', line 90

def create_bin
  # create the 'binary' in ./bin
  mkdir_in_target bin_dir
  output_template_in_target_generic path('bin/bio-plugin'), path(bin_dir, bin_name)
  # TODO: set the file as executable (Windows?)
  File.chmod 0755, path(target_dir, bin_dir, bin_name)
end

#create_db_structure ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/bio-gem/generator/render.rb', line 120

def create_db_structure
  migrate_dir = path(db_dir, "migrate")
  mkdir_in_target(db_dir)
  mkdir_in_target(migrate_dir)
  mkdir_in_target("config") unless exists_dir?("config")
  mkdir_in_target(path("lib/bio"))
  mkdir_in_target(lib_sub_module)
  output_template_in_target_generic 'database', path("config/database.yml")
  output_template_in_target_generic 'migration', path(migrate_dir,"001_create_example.rb" )
  output_template_in_target_generic 'seeds', path(db_dir, "seeds.rb")
  output_template_in_target_generic_append 'rakefile', 'Rakefile', template_dir_biogem
  #TODO I'd like to have a parameter from command like with defines the Namespace of the created bio-gem to automatically costruct directory structure
  output_template_in_target_generic 'db_connection', path(lib_sub_module,"connect.rb")
  output_template_in_target_generic 'db_model', path(lib_sub_module,"example.rb")
end

#create_ffi_structure ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/bio-gem/generator/render.rb', line 108

def create_ffi_structure
  # create ./ext/src and ./ext/include for the .c and .h files
  mkdir_in_target(ext_dir)
  src_dir = path(ext_dir,'src')
  mkdir_in_target(src_dir)
  # create ./lib/ffi for the Ruby ffi
  mkdir_in_target(path(lib_dir,"ffi"))
  # copy C files
  output_template_in_target_generic path('ffi/ext.c'), path(src_dir, "ext.c" )
  output_template_in_target_generic path('ffi/ext.h'), path(src_dir, "ext.h" )
end

#create_lib ⇒ Object 



84
85
86
87
88
 
# File 'lib/bio-gem/generator/render.rb', line 84

def create_lib
  output_template_in_target_generic path('lib/bioruby-plugin.rb'), path(lib_dir, lib_filename)
  mkdir_in_target(lib_plugin_dir)
  output_template_in_target_generic path('lib/plugin.rb'), path(lib_dir, project_name, lib_plugin_filename)
end

#create_meta ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/bio-gem/generator/render.rb', line 70

def create_meta
  # this section is for Biogem META packages only!
  unless File.exists?(target_dir) || File.directory?(target_dir)
    FileUtils.mkdir target_dir
  else
    raise FileInTheWay, "The directory #{target_dir} already exists, aborting. Maybe move it out of the way before continuing?"
  end
  output_template_in_target '.gitignore'
  output_template_in_target 'Rakefile'
  output_template_in_target 'Gemfile'  if should_use_bundler
  output_template_in_target 'LICENSE.txt'
  output_template_in_target '.document'
end

#create_plugin_files ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/bio-gem/generator/render.rb', line 51

def create_plugin_files
  if options[:biogem_meta]
    create_meta 
  else
    original_create_files
    create_lib
    create_bin if options[:biogem_bin]
    create_test_data if options[:biogem_test_data]
    create_ffi_structure if options[:biogem_ffi]
    create_db_structure if options[:biogem_db]
    create_rails_engine if options[:biogem_engine]
  end 
  # Always do these
  output_template_in_target_generic 'README.rdoc'
  output_template_in_target_generic 'README.md'
  output_template_in_target_generic_append 'gitignore', '.gitignore'
  output_template_in_target_generic_append 'travis.yml', '.travis.yml'
end

#create_rails_engine ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/bio-gem/generator/render.rb', line 136

def create_rails_engine
  # create the structures and files needed to have a ready to go Rails' engine
  namespace = options[:biogem_engine] # are we using this?
  engine_dirs.each do |dir|
    mkdir_in_target(dir) unless exists_dir?(dir)
  end
  output_template_in_target_generic 'engine', path('lib', engine_filename )
  output_template_in_target_generic_append 'library', path('lib', lib_filename)
  output_template_in_target_generic 'routes', path('config', "routes.rb" )
  output_template_in_target_generic 'foos_controller', path('app',"controllers", "foos_controller.rb" )
  output_template_in_target_generic 'foos_view_index', path('app',"views","foos", "index.html.erb" )
  output_template_in_target_generic 'foos_view_show', path('app',"views","foos", "show.html.erb" )
  output_template_in_target_generic 'foos_view_example', path('app',"views","foos", "example.html.erb" )
  output_template_in_target_generic 'foos_view_new', path('app',"views","foos", "new.html.erb" )
end

#create_test_data ⇒ Object 



98
99
100
101
102
103
104
105
106
 
# File 'lib/bio-gem/generator/render.rb', line 98

def create_test_data
  mkdir_in_target("test") unless File.exists? "#{target_dir}/test"
  #TODO use and iterator ...
  mkdir_in_target test_data_dir
  mkdir_in_target 'test/data/input'
  mkdir_in_target 'test/data/regression'
  mkdir_in_target 'test/data/rspec'
  mkdir_in_target 'test/data/cucumber'
end

#output_template_in_target_generic(source, destination = source, template_dir = template_dir_biogem) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/bio-gem/generator/render.rb', line 30

def output_template_in_target_generic(source, destination = source, template_dir = template_dir_biogem)
  final_destination = path(target_dir, destination)
  template_result   = render_template_generic(source, template_dir)

  File.open(final_destination, 'w') {|file| file.write(template_result)}
  $stdout.puts "\tcreate\t#{destination}"
end

#output_template_in_target_generic_append(source, destination = source, template_dir = template_dir_biogem) ⇒ Object 



38
39
40
41
42
43
44
45
 
# File 'lib/bio-gem/generator/render.rb', line 38

def output_template_in_target_generic_append(source, destination = source, template_dir = template_dir_biogem)
  final_destination = path(target_dir, destination)
  template_result   = render_template_generic(source, template_dir)

  File.open(final_destination, 'a') {|file| file.write(template_result)}

  $stdout.puts "\tappend\t#{destination}"
end

#render_template_generic(source, template_dir = template_dir_biogem) ⇒ Object 



22
23
24
25
26
27
28
 
# File 'lib/bio-gem/generator/render.rb', line 22

def render_template_generic(source, template_dir = template_dir_biogem)
  template_contents = File.read(path(template_dir, source))
  template          = ERB.new(template_contents, nil, '<>')

  # squish extraneous whitespace from some of the conditionals
  template.result(binding).gsub(/\n\n\n+/, "\n\n")
end

#template_dir_biogem ⇒ Object 



47
48
49
 
# File 'lib/bio-gem/generator/render.rb', line 47

def template_dir_biogem
  path(File.dirname(__FILE__),'..', 'templates')
end