how to fill html file using ruby script

Question

I have a html file has the general design (some div's) and I need to fill this div's with some html code Using ruby script.
any suggests?

example

I have page.html

<html>
<title>html Page</title>
<body>

<div id="main">
</div>

<div id="side">
</div>

</body>
</html>

and a ruby script inside it i collect some data and doing some kind of processing on it and i want to present it in a nice format**
so I want to set the div which it's id=main with some html code to be like this

<html>
<title>html Page</title>
<body>

<div id="main">
<h1>you have 30 files in games folder</h1>
</div>

<div id="side">
</div>

</body>
</html>

** why i don't use ROR? because I don't want to build a web site I just need to build a desktop tool but it's presentation layer is html code interpreted by browser to avoid working with graphics libraries

my problem isn't "how can I write to this html file" I can handle it.
my problem that If I want to create a table in the html file inside main div I will wrote the whole html code inside the ruby script to print it to the html file, is there any lib or gem that i can tell it that I want a table with 3 rows and 2 columns and it generates the html code?

To Improve this question please include more details and even better a short example showing us what you have and what you'd like to end up with. — Noah Clark
– Noah Clark, Commented Oct 18, 2011 at 21:17
You've edited your question to mention HTML tables with specific rows and columns, but that was nowhere in your original title or question. You are not being clear about what you have and what you want. — Phrogz
– Phrogz, Commented Oct 18, 2011 at 22:02
Phrogz you read my mind. The question was completely different originally and with a score of 300+ Aboelnour should know better. — Michael Durrant
– Michael Durrant, Commented Oct 18, 2011 at 22:24
Aboelnour have you seen: stackoverflow.com/questions/2634024/… ? — Noah Clark
– Noah Clark, Commented Oct 18, 2011 at 22:47
@NoadClark nice using builder.rubyforge.org would be a good tool to generate the html code in separated file. thanks. voted up your answer. — Aboelnour
– Aboelnour, Commented Oct 18, 2011 at 23:05

Phrogz · Accepted Answer · 2011-10-18 22:04:44Z

I historically have used ERB and REXML for things like this, since they both ship with Ruby (removing gem dependencies). You can combine one XML file (content) with one .erb file (for layout) and get simple merging. Here's a script I wrote for this (most of which is argument handling and extending REXML with some convenience methods):

USAGE = <<ENDUSAGE
Usage:
   rubygen source_xml [-t template_file] [-o output_file]

   -t,--template  The ERB template file to merge (default: xml_name.erb)

   -o,--output    The output file name to write  (default: template.txt)
                  If the template_file is named "somefile_XXX.yyy",
                  the output_file will default instead to "somefile.XXX"
ENDUSAGE

ARGS = {}
UNFLAGGED_ARGS = [ :source_xml ]
next_arg = UNFLAGGED_ARGS.first
ARGV.each{ |arg|
   case arg
     when '-t','--template'
       next_arg = :template_file
     when '-o','--output'
       next_arg = :output_file
     else
       if next_arg
         ARGS[next_arg] = arg
         UNFLAGGED_ARGS.delete( next_arg )
       end
       next_arg = UNFLAGGED_ARGS.first
   end
}

if !ARGS[:source_xml]
   puts USAGE
   exit
end

extension_match = /\.[^.]+$/
template_match  = /_([^._]+)\.[^.]+$/
xml_file      = ARGS[ :source_xml   ]
template_file = ARGS[ :template_file] || xml_file.sub( extension_match, '.erb' )
output_file   = ARGS[ :output_file  ] || ( ( template_file =~ template_match ) ? template_file.sub( template_match, '.\\1' ) : template_file.sub( extension_match, '.txt' ) )

require 'rexml/document'
include REXML

class REXML::Element
  # Find all descendant nodes with a specified tag name and/or attributes
  def find_all( tag_name='*', attributes_to_match={} )
    self.each_element( ".//#{REXML::Element.xpathfor(tag_name,attributes_to_match)}" ){}
  end
  # Find all child nodes with a specified tag name and/or attributes
  def kids( tag_name='*', attributes_to_match={} )
    self.each_element( "./#{REXML::Element.xpathfor(tag_name,attributes_to_match)}" ){}
  end
  def self.xpathfor( tag_name='*', attributes_to_match={} )
    out = "#{tag_name}"
    unless attributes_to_match.empty?
      out << "["
      out << attributes_to_match.map{ |key,val|
        if val == :not_empty
          "@#{key}"
        else
          "@#{key}='#{val}'"
        end
      }.join( ' and ' )
      out << "]"
    end
    out
  end

  # A hash to tag extra data onto a node during processing
  def _mydata
    @_mydata ||= {}
  end
end

start_time = Time.new
  @xmldoc = Document.new( IO.read( xml_file ), :ignore_whitespace_nodes => :all )
  @root = @xmldoc.root
  @root = @root.first if @root.is_a?( Array )
end_time = Time.new
puts "%.2fs to parse XML file (#{xml_file})" % ( end_time - start_time )

require 'erb'
File.open( output_file, 'w' ){ |o|
  start_time = Time.new
  output_code = ERB.new( IO.read( template_file ), nil, '>', 'output' ).result( binding )
  end_time = Time.new
  puts "%.2fs to run template   (#{template_file})" % ( end_time - start_time )

  start_time = Time.new
  o << output_code
}
end_time = Time.new
puts "%.2fs to write output   (#{output_file})" % ( end_time - start_time )
puts " "

This can be used for HTML or automated source code generation alike.

However, these days I would advocate using Haml and Nokogiri (if you want structured XML markup) or YAML (if you want simple-to-edit content), as these will make your markup cleaner and your template logic simpler.

Edit: Here's a simpler file that merges YAML with Haml. The last four lines do all the work:

#!/usr/bin/env ruby
require 'yaml'; require 'haml'; require 'trollop'
EXTENSION = /\.[^.]+$/

opts = Trollop.options do
  banner "Usage:\nyamlhaml [opts] <sourcefile.yaml>"
  opt :haml,   "The Haml file to use (default: sourcefile.haml)", type:String
  opt :output, "The file to create   (default: sourcefile.html)", type:String
end
opts[:source] = ARGV.shift
Trollop.die "Please specify an input Yaml file" unless opts[:source]
Trollop.die "Could not find #{opts[:source]}"   unless File.exist?(opts[:source])

opts[:haml]   ||= opts[:source].sub( EXTENSION, '.haml' )
opts[:output] ||= opts[:source].sub( EXTENSION, '.html' )
Trollop.die "Could not find #{opts[:haml]}" unless File.exist?(opts[:haml])

@data = YAML.load(IO.read(opts[:source]))
File.open( opts[:output], 'w' ) do |output|
  output << Haml::Engine.new(IO.read(opts[:haml])).render(self)
end

Here's a sample YAML file:

title: Hello World
main: "<h1>you have 30 files in games folder</h1>"
side: "I dunno, something goes here."

...and a sample Haml file:

!!! 5
%html
  %head
    %title= @data['title']
  %body
    #main= @data['main']
    #side= @data['side']

...and finally the HTML they produce:

<!DOCTYPE html>
<html>
  <head>
    <title>Hello World</title>
  </head>
  <body>
    <div id='main'><h1>you have 30 files in games folder</h1></div>
    <div id='side'>I dunno, something goes here.</div>
  </body>
</html>

I've edited the above answer to include a more modern YAML+Haml approach.
thanks for your answer i gained extra information from it :) voted up.
Thanks so much for the haml/yaml approach - it helped me tremendously to turn collected data (email responses) -> yaml -> haml -> html -> printed pdf. Highly appreciated :)

Noah Clark · Accepted Answer · 2011-10-18 22:43:55Z

6

Are you trying to create a dynamic website? For that use Rails. Are you trying to create a static website? Something like Jekyll is probably best. Are you trying to to just create some some simple .html files you can FTP up somewhere? Jekyll might be a good option or even hand coding a quick little HTML generator might be a better option.

UPDATE:

Is this what you are looking for?

hash = {
:games          => "you have 30 files in games folder",
:puppies        => "you have 12 puppies in your pocket",
:pictures   => "You have 9 files in pictures folder",
}

array = [

['run','x','y'],
[1,10,3],
[2,12,9],
[3,14,7],

]

hash.each do |key, value|
myfile = File.new("#{key}.html", "w+") 
myfile.puts "<html>"
myfile.puts "<title>html Page</title>"
myfile.puts "<body>"

myfile.puts "<div id=\"main\">"
myfile.puts "<h1>#{value}</h1>"

myfile.puts "<table border=\"1\">"
array.each do |row|
    myfile.puts "<tr>"
    row.each do |cell|
        myfile.puts "<td> #{cell} </td>"
    end
    myfile.puts "<tr>"
end

myfile.puts "</div>"

myfile.puts "<div id=\"side\">"
myfile.puts "</div>"

myfile.puts "</body>"
myfile.puts "</html>"

end

edited Oct 18, 2011 at 22:43

answered Oct 18, 2011 at 21:20

Noah Clark

8,12114 gold badges76 silver badges117 bronze badges

2 Comments

Aboelnour Over a year ago

that's what I'm trying to avoid, printing the whole HTML code inside a script won't be good. Unless there isn't another way. thanks

Noah Clark Over a year ago

@Aboelnour I've added a table generator. You're going to have to store the html somewhere. You could use something like HAML or ERB to mark it up and then it through a processes or use functions to create a template.

Nate · Accepted Answer · 2014-04-30 17:25:00Z

Continuing from @Phrogz's work, the ERB idea is a great idea. I was able to use it to build a simple Rake script that does the work for me. I find this approach to be a little easier.

rakefile.rb

task :default => :generate

task :generate do

  require 'erb'

  template_file = "page.erb"
  output_file   = "page.html"

  File.open(output_file, 'w') do |o|
    puts "Processing file: #{template_file}"
    o << ERB.new( IO.read( template_file ), nil, '>', 'output' ).result( binding )
  end

end

def render(file)
  puts "Rendering file: #{file}"
  IO.read(file)
end

$game_count = 30
def game_count
  puts "Rendering game count: #{$game_count}"
  $game_count
end

page.erb

<html>
<title>html Page</title>
<body>

<div id="main">
  <h1>you have <%= game_count %> files in games folder</h1>
</div>

<div id="side">
  <%= render "side.html" %>
</div>

</body>
</html>

side.html

<ul class="side">
  <li>Side item 1</li>
  <li>Side item 2</li>
</ul>

Running it

$ rake
Processing file: page.erb
Rendering game count: 30
Rendering file: side.html

Newly created file page.html

<html>
<title>html Page</title>
<body>

<div id="main">
  <h1>you have 30 files in games folder</h1>
</div>

<div id="side">
<ul class="side">
  <li>Side item 1</li>
  <li>Side item 2</li>
</ul>
</div>

</body>
</html>

Collectives™ on Stack Overflow

how to fill html file using ruby script

3 Answers 3

3 Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related