html_gen 0.0.0 → 0.0.1

data/Gemfile

@@ -3,8 +3,6 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem "knjrbfw"
-
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do

data/Gemfile.lock

@@ -1,25 +1,14 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    datet (0.0.14)
     diff-lcs (1.1.3)
     git (1.2.5)
-    http2 (0.0.5)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
     json (1.7.4)
-    knjrbfw (0.0.78)
-      datet
-      http2
-      php4r
-      tsafe
-      wref
-    php4r (0.0.2)
-      datet
-      http2
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
@@ -31,8 +20,6 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    tsafe (0.0.11)
-    wref (0.0.5)
 
 PLATFORMS
   ruby
@@ -40,6 +27,5 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.0.0)
   jeweler (~> 1.8.4)
-  knjrbfw
   rdoc (~> 3.12)
   rspec (~> 2.8.0)

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/html_gen.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{html_gen}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kasper Johansen"]
+  s.date = %q{2012-08-10}
+  s.description = %q{A small framework for generating HTML.}
+  s.email = %q{k@spernj.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "html_gen.gemspec",
+    "lib/html_gen.rb",
+    "lib/html_gen_element.rb",
+    "spec/html_gen_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kaspernj/html_gen}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A small framework for generating HTML.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/lib/html_gen.rb

@@ -1,3 +1,4 @@
+#This class doesnt hold other methods than for autoloading of subclasses.
 class Html_gen
   #Autoloader for subclasses.
   def self.const_missing(name)
@@ -5,4 +6,9 @@ class Html_gen
     raise "Still not defined: '#{name}'." if !Html_gen.const_defined?(name)
     return Html_gen.const_get(name)
   end
+  
+  #Escapes HTML from the given string. This is to avoid any dependencies and should not be used by other libs.
+  def self.escape_html(string)
+    return string.to_s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
+  end
 end

data/lib/html_gen_element.rb

@@ -1,34 +1,88 @@
-require "knjrbfw"
-
+#This class can be used to generate HTML.
+#===Examples
+#  ele = Html_gen::Element.new(:a) #=> #<Html_gen::Element:0x00000000e5f650 @attr={}, @name=:a, @classes=[], @str_html="", @str="", @css={}, @eles=[], @nl="\n", @inden="\t">
+#  ele.classes << "custom_link"
+#  ele.css["font-weight"] = "bold"
+#  ele.attr[:href] = "http://www.youtube.com"
+#  
+#  b = ele.add_ele(:b)
+#  b.str = "Title of link"
+#  
+#  ele.html #=> "<a href=\"http://www.youtube.com\" style=\"font-weight: bold;\" class=\"custom_link\">\n\t<b>\n\t\tTitle of link\n\t</b>\n</a>\n"
 class Html_gen::Element
-  attr_accessor :attr, :css, :classes, :str, :html
+  #Attributes hash which will be used to generate attributes-elements.
+  #===Example
+  #  element.attr[:href] = "http://www.youtube.com"
+  attr_reader :attr
   
+  #CSS-hash which will be used to generate the 'style'-attribute.
+  #===Example
+  #  element.css["font-weight"] = "bold"
+  attr_reader :css
+  
+  #Classes-array which will be used to generate the 'class'-attribute.
+  #===Example
+  #  element.classes += ["class1", "class2"]
+  #  element.html #=> ... class="class1 class2"...
+  attr_reader :classes
+  
+  #This string is used to generate the value of an element. It will be HTML-escaped.
+  #===Example
+  #  element = Html_gen::Element.new("b")
+  #  element.str = "Te<i>s</i>t"
+  #  element.html(:pretty => false) #=> "<b>Te&lt;i&gt;s&lt;/i&gt;t</b>"
+  attr_accessor :str
+  
+  #This string is used to generate the value of an element. It will not be HTML-escaped.
+  #===Example
+  #  element = Html_gen::Element.new("b")
+  #  element.str_html = "Te<i>s</i>t"
+  #  element.html #=> "<b>Te<i>s</i>t</b>"
+  attr_accessor :str_html
+  
+  #You can give various arguments as shortcuts to calling the methods. You can also decide what should be used for newline and indentation.
+  #  Html_gen::Element.new(:b, {
+  #    :css => {"font-weight" => "bold"},
+  #    :attr => {"href" => "http://www.youtube.com"},
+  #    :classes => ["class1", "class2"],
+  #    :str => "A title",
+  #    :str_html => "Some custom URL as title",
+  #    :nl => "\n",
+  #    :inden => "\t",
+  #    :eles => [Html_gen::Element.new("i", :str => "Hello world!")
+  #  })
   def initialize(name, args = {})
-    if args[:attr]
-      @attr = args[:attr]
-    else
-      @attr = {}
-    end
-    
     raise "'name' should be a string or a symbol but was a '#{name.class.name}'."if !name.is_a?(String) and !name.is_a?(Symbol)
-    
     @name = name
     
-    {:classes => [], :html => "", :str => "", :css => {}, :eles => [], :nl => "\n", :inden => "\t"}.each do |arg, default_val|
+    {:attr => {}, :classes => [], :str_html => "", :str => "", :css => {}, :eles => [], :nl => "\n", :inden => "\t"}.each do |arg, default_val|
       if args[arg]
         instance_variable_set("@#{arg}", args[arg])
       else
         instance_variable_set("@#{arg}", default_val)
       end
+      
+      args.delete(arg)
     end
+    
+    raise "Unknown arguments: '#{args.keys.join(",")}'." if !args.empty?
   end
   
+  #Adds a sub-element to the element.
+  #===Examples
+  #  element = Html_gen::Element.new("a")
+  #  another_ele = element.add_ele("b")
+  #  another_ele.str = "Hello world!"
+  #  element.html #=> "<a>\n\t<b>\n\t\tHello world!\n\t</b>\n</a>\n"
   def add_ele(name, args = {})
     ele = Html_gen::Element.new(name, args)
     @eles << ele
     return ele
   end
   
+  # Returns the HTML for the element.
+  # To avoid indentation and newlines you can use the 'pretty'-argument:
+  #  element.html(:pretty => false)
   def html(args = {})
     if args[:level]
       level = args[:level]
@@ -42,15 +96,23 @@ class Html_gen::Element
       pretty = true
     end
     
+    #Used for keeping 'pretty'-value and correct indentation according to parent elements.
     pass_args = {:level => (level + 1), :pretty => pretty}
     
+    #Clone the attributes-hash since we are going to add stuff to it, and it shouldnt be reflected (if 'html' is called multiple times, it will bug unless we clone).
     attr = @attr.clone
-    classes = @classes.clone
     
-    str = ""
+    #Start generating the string with HTML (possible go give a custom 'str'-variable where the content should be pushed to).
+    if args[:str]
+      str = args[:str]
+    else
+      str = ""
+    end
+    
     str << @inden * level if pretty and level > 0
     str << "<#{@name}"
     
+    #Add content from the 'css'-hash to the 'style'-attribute in the right format.
     if !@css.empty?
       style = ""
       @css.each do |key, val|
@@ -66,36 +128,40 @@ class Html_gen::Element
       end
     end
     
+    #Add content from the 'classes'-array to the 'class'-attribute in the right format.
     if !@classes.empty?
       class_str = @classes.join(" ")
       
       if @attr[:class] and !@attr[:class].empty?
-        @attr[:class] << " #{class_str}"
+        attr[:class] << " #{class_str}"
       else
-        @attr[:class] = class_str
+        attr[:class] = class_str
       end
     end
     
+    #Write out the attributes to the string.
     attr.each do |key, val|
-      str << " #{key}=\"#{Knj::Web.html(val)}\""
+      str << " #{key}=\"#{Html_gen.escape_html(val)}\""
     end
     
-    if @eles.empty? and @str.empty? and @html.empty?
+    if @eles.empty? and @str.empty? and @str_html.empty?
+      #If no sub-string, sub-HTML or sub-elements are given, we should end the HTML with " />".
       str << " />"
       str << @nl if pretty
     else
+      #Write end-of-element and then all sub-elements.
       str << ">"
       str << @nl if pretty
       
       if !@str.empty?
         str << @inden * (level + 1) if pretty
-        str << Knj::Web.html(@str)
+        str << Html_gen.escape_html(@str)
         str << @nl if pretty
       end
       
-      if !@html.empty?
+      if !@str_html.empty?
         str << @inden * (level + 1) if pretty
-        str << @html
+        str << @str_html
         str << @nl if pretty
       end
       
@@ -108,6 +174,7 @@ class Html_gen::Element
       str << @nl if pretty
     end
     
+    #Returns the string.
     return str
   end
 end

data/spec/html_gen_spec.rb

@@ -2,13 +2,26 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "HtmlGen" do
   it "should be able to generate html" do
-    html = Html_gen::Element.new(:td, :classes => [:test]).html
+    html = Html_gen::Element.new(:td, :classes => [:test]).html(:pretty => false)
     raise "Expected valid HTML." if html != "<td class=\"test\" />"
     
-    html = Html_gen::Element.new(:td, :attr => {:colspan => 2}).html
+    html = Html_gen::Element.new(:td, :attr => {:colspan => 2}).html(:pretty => false)
     raise "Expected valid HTML." if html != "<td colspan=\"2\" />"
     
-    html = Html_gen::Element.new(:td, :css => {:width => "80px"}).html
+    html = Html_gen::Element.new(:td, :css => {:width => "80px"}).html(:pretty => false)
     raise "Expected valid HTML: '#{html}'." if html != "<td style=\"width: 80px;\" />"
+    
+    a = Html_gen::Element.new(:a)
+    b = a.add_ele(:b)
+    b.str = "Test"
+    
+    html = a.html(:pretty => false)
+    raise "Expected something else." if html != "<a><b>Test</b></a>"
+    
+    html = Html_gen::Element.new(:b, :str => "<b>Test</b>").html(:pretty => false)
+    raise "Expected escape HTML: '#{html}'." if html != "<b>&lt;b&gt;Test&lt;/b&gt;</b>"
+    
+    html = Html_gen::Element.new(:b, :str_html => "<b>Test</b>").html(:pretty => false)
+    raise "Expected escape HTML: '#{html}'." if html != "<b><b>Test</b></b>"
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: html_gen
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Kasper Johansen
@@ -13,20 +13,9 @@ cert_chain: []
 date: 2012-08-10 00:00:00 +02:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: knjrbfw
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  prerelease: false
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -34,10 +23,10 @@ dependencies:
         version: 2.8.0
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rdoc
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -45,10 +34,10 @@ dependencies:
         version: "3.12"
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -56,10 +45,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -67,7 +56,7 @@ dependencies:
         version: 1.8.4
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id004
 description: A small framework for generating HTML.
 email: k@spernj.org
 executables: []
@@ -86,6 +75,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- html_gen.gemspec
 - lib/html_gen.rb
 - lib/html_gen_element.rb
 - spec/html_gen_spec.rb
@@ -104,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1933339893132629672
+      hash: 3676011512365822361
       segments: 
       - 0
       version: "0"