html_gen 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9753960ad1d9d4235acd59b7e1ccd83655ac7ca
-  data.tar.gz: 3dbb63796e2e4596c36e72d24b12adf513cbe214
+  metadata.gz: 5ca7ca82d9a45a1dc1208d8635acfa91f4a3d950
+  data.tar.gz: 16ffb22120f4dc9eae6e81f265bd27ecc00694c1
 SHA512:
-  metadata.gz: 14e3119b2fa1b40980901d12d32abab0e4ddfc64dce190f1917180d461ce79e70fb90a94ea25358ba0f725d2576e026ac7bd4e1ce9c77e805165a716f153de98
-  data.tar.gz: 2421cc2f43cb78eee2a63338b4911a46ede4025f7c96ba83dd28cb1e9ea5d1980dccda4e728afd85b70a95f9d248c8cc1ea19e5ef471d7966efc92b5f9530f11
+  metadata.gz: 67e9f9a315d26e6c85c938e7ce6eba41855592c5c4b48d8d17b163bb6cbcf1eb6010974e32e1d1a35e458733e7d59e8418dd4b0c0e8bae88d3ef01411a618940
+  data.tar.gz: 540ea4bb36340410039276fef5251c0edd83ba7ea545a8294655a0ae32cf344f6a9cbcccefc33575faea5c89c20bbb032e4b5b0a04971eff49a98839206fb134

data/.rubocop.yml

@@ -0,0 +1,54 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - db/schema.rb
+    - spec/dummy/db/schema.rb
+    - html_gen.gemspec
+
+# https://github.com/AtomLinter/linter-rubocop/issues/2
+Style/FileName:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 250
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLines:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/NilComparison:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+  Enabled: true
+
+# Disabled on purpose: https://github.com/bbatsov/rubocop/issues/1758
+Style/ClosingParenthesisIndentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,74 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-20 15:14:18 +0100 using RuboCop version 0.36.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 6
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/html_gen/parser.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: AlignWith, SupportedStyles, AutoCorrect.
+# SupportedStyles: keyword, variable, start_of_line
+Lint/EndAlignment:
+  Enabled: false
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/html_gen/element.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 82
+
+# Offense count: 3
+Metrics/CyclomaticComplexity:
+  Max: 35
+
+# Offense count: 3
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 189
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 72
+
+# Offense count: 5
+Metrics/PerceivedComplexity:
+  Max: 41
+
+# Offense count: 6
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/html_gen/element.rb'
+    - 'lib/html_gen/parser.rb'
+
+# Offense count: 5
+Style/IdenticalConditionalBranches:
+  Exclude:
+    - 'lib/html_gen/element.rb'
+    - 'lib/html_gen/parser.rb'
+
+# Offense count: 1
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/html_gen/parser.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'lib/html_gen/parser.rb'

data/Gemfile

@@ -13,4 +13,6 @@ group :development do
   gem "rdoc", "~> 3.12"
   gem "bundler", ">= 1.0.0"
   gem "jeweler", "~> 1.8.4"
+  gem "best_practice_project", github: "kaspernj/best_practice_project"
+  gem "rubocop"
 end

data/Gemfile.lock

@@ -1,7 +1,17 @@
+GIT
+  remote: git://github.com/kaspernj/best_practice_project.git
+  revision: 85edcdab3e63de1374de10f01fcf4a621099aae2
+  specs:
+    best_practice_project (0.0.8)
+      auto_autoloader
+
 GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.3.7)
+    ast (2.2.0)
+    auto_autoloader (0.0.4)
+      string-cases
     builder (3.2.2)
     codeclimate-test-reporter (0.4.6)
       simplecov (>= 0.7.1, < 1.0.0)
@@ -40,7 +50,11 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    parser (2.3.0.1)
+      ast (~> 2.2)
+    powerpack (0.1.1)
     rack (1.6.0)
+    rainbow (2.0.0)
     rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
@@ -52,6 +66,12 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    rubocop (0.36.0)
+      parser (>= 2.3.0.0, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+    ruby-progressbar (1.7.5)
     simplecov (0.9.1)
       docile (~> 1.1.0)
       multi_json (~> 1.0)
@@ -63,9 +83,14 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  best_practice_project!
   bundler (>= 1.0.0)
   codeclimate-test-reporter
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
+  rubocop
   string-cases
+
+BUNDLED WITH
+   1.11.2

data/Rakefile

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,41 +9,44 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
+require "rake"
 
-require 'jeweler'
+require "jeweler"
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "html_gen"
   gem.homepage = "http://github.com/kaspernj/html_gen"
   gem.license = "MIT"
-  gem.summary = %Q{A small framework for generating HTML.}
-  gem.description = %Q{A small framework for generating HTML.}
+  gem.summary = %(A small framework for generating HTML.)
+  gem.description = %(A small framework for generating HTML.)
   gem.email = "k@spernj.org"
   gem.authors = ["Kasper Johansen"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern = "spec/**/*_spec.rb"
   spec.rcov = true
 end
 
 task default: :spec
 
-require 'rdoc/task'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
 
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "html_gen #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
+
+require "best_practice_project"
+BestPracticeProject.load_tasks

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/html_gen.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: html_gen 0.0.7 ruby lib
+# stub: html_gen 0.0.8 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "html_gen"
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Kasper Johansen"]
-  s.date = "2016-01-17"
+  s.date = "2016-01-20"
   s.description = "A small framework for generating HTML."
   s.email = "k@spernj.org"
   s.extra_rdoc_files = [
@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".rubocop.yml",
+    ".rubocop_todo.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -51,12 +53,16 @@ Gem::Specification.new do |s|
       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"])
+      s.add_development_dependency(%q<best_practice_project>, [">= 0"])
+      s.add_development_dependency(%q<rubocop>, [">= 0"])
     else
       s.add_dependency(%q<string-cases>, [">= 0"])
       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"])
+      s.add_dependency(%q<best_practice_project>, [">= 0"])
+      s.add_dependency(%q<rubocop>, [">= 0"])
     end
   else
     s.add_dependency(%q<string-cases>, [">= 0"])
@@ -64,6 +70,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, [">= 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<best_practice_project>, [">= 0"])
+    s.add_dependency(%q<rubocop>, [">= 0"])
   end
 end
 

data/lib/html_gen/element.rb

@@ -1,4 +1,4 @@
-#This class can be used to generate HTML.
+# This class can be used to generate HTML.
 #===Examples
 #  ele = HtmlGen::Element.new(:a) #=> #<HtmlGen::Element:0x00000000e5f650 @attr={}, @name=:a, @classes=[], @str_html="", @str="", @css={}, @eles=[], @nl="\n", @inden="\t">
 #  ele.classes << "custom_link"
@@ -10,48 +10,48 @@
 #
 #  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 HtmlGen::Element
-  FORBIDDEN_SHORT = ["script"]
+  FORBIDDEN_SHORT = ["script"].freeze
 
-  #Attributes hash which will be used to generate attributes-elements.
+  # 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.
+  # CSS-hash which will be used to generate the 'style'-attribute.
   #===Example
   #  element.css["font-weight"] = "bold"
   attr_reader :css
 
-  #Data hash which will nest keys.
+  # Data hash which will nest keys.
   attr_reader :data
 
-  #Classes-array which will be used to generate the 'class'-attribute.
+  # 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.
+  # This string is used to generate the value of an element. It will be HTML-escaped.
   #===Example
   #  element = HtmlGen::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.
+  # This string is used to generate the value of an element. It will not be HTML-escaped.
   #===Example
   #  element = HtmlGen::Element.new("b")
   #  element.str_html = "Te<i>s</i>t"
   #  element.html #=> "<b>Te<i>s</i>t</b>"
   attr_accessor :str_html
 
-  #An array holding all the sub-elements of this element.
+  # An array holding all the sub-elements of this element.
   attr_accessor :eles
 
-  #The name of the element. "a" for <a> and such.
+  # The name of the element. "a" for <a> and such.
   attr_accessor :name
 
-  #You can give various arguments as shortcuts to calling the methods. You can also decide what should be used for newline and indentation.
+  # You can give various arguments as shortcuts to calling the methods. You can also decide what should be used for newline and indentation.
   #  HtmlGen::Element.new(:b, {
   #    css: {"font-weight" => "bold"},
   #    attr: {"href" => "http://www.youtube.com"},
@@ -63,7 +63,7 @@ class HtmlGen::Element
   #    eles: [HtmlGen::Element.new("i", str: "Hello world!")
   #  })
   def initialize(name, args = {})
-    raise "'name' should be a string or a symbol but was a '#{name.class.name}'."if !name.is_a?(String) && !name.is_a?(Symbol)
+    raise "'name' should be a string or a symbol but was a '#{name.class.name}'." if !name.is_a?(String) && !name.is_a?(Symbol)
     @name = name
 
     {attr: {}, data: {}, classes: [], str_html: "", str: "", css: {}, eles: [], nl: "\n", inden: "\t"}.each do |arg, default_val|
@@ -76,10 +76,10 @@ class HtmlGen::Element
       args.delete(arg)
     end
 
-    raise "Unknown arguments: '#{args.keys.join(",")}'." if !args.empty?
+    raise "Unknown arguments: '#{args.keys.join(",")}'." unless args.empty?
   end
 
-  #Adds a sub-element to the element.
+  # Adds a sub-element to the element.
   #===Examples
   #  element = HtmlGen::Element.new("a")
   #  another_ele = element.add_ele("b")
@@ -88,58 +88,58 @@ class HtmlGen::Element
   def add_ele(name, args = {})
     ele = HtmlGen::Element.new(name, args.merge(nl: @nl, inden: @inden))
     @eles << ele
-    return ele
+    ele
   end
 
   alias add add_ele
 
-  #Add a text-element to the element.
+  # Add a text-element to the element.
   def add_str(str)
     ele = HtmlGen::TextEle.new(str: str, inden: @inden, nl: @nl)
     @eles << ele
-    return ele
+    ele
   end
 
-  #Add a text-element to the element.
+  # Add a text-element to the element.
   def add_html(html)
     ele = HtmlGen::TextEle.new(html: html, inden: @inden, nl: @nl)
     @eles << ele
-    return ele
+    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]
-    else
-      level = 0
+    level = if args[:level]
+              args[:level]
+            else
+              0
     end
 
-    if args.key?(:pretty)
-      pretty = args[:pretty]
-    else
-      pretty = true
+    pretty = if args.key?(:pretty)
+               args[:pretty]
+             else
+               true
     end
 
-    #Used for keeping 'pretty'-value and correct indentation according to parent elements.
+    # Used for keeping 'pretty'-value and correct indentation according to parent elements.
     pass_args = {level: (level + 1), pretty: pretty, inden: @inden}
 
-    #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).
+    # 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
 
-    #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 = ""
+    # Start generating the string with HTML (possible go give a custom 'str'-variable where the content should be pushed to).
+    str = if args[:str]
+            args[:str]
+          else
+            ""
     end
 
     str << @inden * level if pretty && level > 0
     str << "<#{@name}"
 
-    #Add content from the 'css'-hash to the 'style'-attribute in the right format.
+    # Add content from the 'css'-hash to the 'style'-attribute in the right format.
     unless @css.empty?
       style = ""
       @css.each do |key, val|
@@ -154,7 +154,7 @@ class HtmlGen::Element
       end
     end
 
-    #Add content from the 'classes'-array to the 'class'-attribute in the right format.
+    # Add content from the 'classes'-array to the 'class'-attribute in the right format.
     unless @classes.empty?
       class_str = @classes.join(" ")
 
@@ -165,7 +165,7 @@ class HtmlGen::Element
       end
     end
 
-    #Write out the attributes to the string.
+    # Write out the attributes to the string.
     attr.each do |key, val|
       str << " #{key}=\"#{HtmlGen.escape_html(val)}\""
     end
@@ -176,11 +176,11 @@ class HtmlGen::Element
     skip_pretty = false
 
     if @eles.empty? && @str.empty? && @str_html.empty? && !forbidden_short
-      #If no sub-string, sub-HTML or sub-elements are given, we should end the HTML with " />".
+      # 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.
+      # Write end-of-element and then all sub-elements.
       str << ">"
 
       if @eles.empty? && @str.empty? && @str_html.empty? && forbidden_short
@@ -210,21 +210,20 @@ class HtmlGen::Element
       str << @nl if pretty
     end
 
-    #Returns the string.
-    return str
+    str
   end
 
-  #Returns the names of all sub-elements in an array.
+  # Returns the names of all sub-elements in an array.
   def eles_names
     names = []
     @eles.each do |ele|
       names << ele.name
     end
 
-    return names
+    names
   end
 
-  #Converts the content of the 'style'-attribute to css-hash-content.
+  # Converts the content of the 'style'-attribute to css-hash-content.
   def convert_style_to_css
     if !@attr[:style].to_s.strip.empty?
       style = @attr[:style]
@@ -235,13 +234,13 @@ class HtmlGen::Element
     end
 
     loop do
-      if match = style.match(/\A\s*(\S+?):\s*(.+?)\s*(;|\Z)/)
+      if (match = style.match(/\A\s*(\S+?):\s*(.+?)\s*(;|\Z)/))
         style.gsub!(match[0], "")
         key = match[1]
         val = match[2]
         raise "Such a key already exists in CSS-hash: '#{key}'." if @css.key?(key)
         @css[key] = val
-      elsif match = style.slice!(/\A\s*\Z/)
+      elsif (match = style.slice!(/\A\s*\Z/))
         break
       else
         raise "Dont know what to do with style-variable: '#{style}'."
@@ -276,15 +275,17 @@ private
   def data_attributes(data_hash, prev_key)
     html = ""
     data_hash.each do |key, value|
+      key = key.to_s.tr("_", "-") if key.is_a?(Symbol)
+
       if value.is_a?(Hash)
         html << " " unless html.empty?
-        html << "#{data_attributes(value, "#{prev_key}-#{key}")}"
+        html << data_attributes(value, "#{prev_key}-#{key}").to_s
       else
         html << " " unless html.empty?
         html << "#{prev_key}-#{key}=\"#{HtmlGen.escape_html(value)}\""
       end
     end
 
-    return html
+    html
   end
 end

data/lib/html_gen/parser.rb

@@ -1,13 +1,13 @@
-#A simple, lightweight and pure-Ruby class for parsing HTML-strings into elements.
+# A simple, lightweight and pure-Ruby class for parsing HTML-strings into elements.
 #===Examples
 #  doc = HtmlGen::Parser.new(str: a_html_variable)
 #  html_ele = doc.eles.first
 #  html_ele.name #=> "html"
 class HtmlGen::Parser
-  #An array that holds all the parsed root-elements.
+  # An array that holds all the parsed root-elements.
   attr_reader :eles
 
-  #The constructor. See class documentation for usage of this.
+  # The constructor. See class documentation for usage of this.
   def initialize(args)
     if args[:io]
       @io = args[:io]
@@ -24,17 +24,15 @@ class HtmlGen::Parser
     @eles_t = []
     @debug = args[:debug]
 
-    while !@eof || !@buffer.empty?
-      parse_tag
-    end
+    parse_tag while !@eof || !@buffer.empty?
   end
 
 private
 
-  #Ensures at least 16kb of data is loaded into the buffer.
+  # Ensures at least 16kb of data is loaded into the buffer.
   def ensure_buffer
-    while @buffer.length < 16384 && !@eof
-      str = @io.gets(16384)
+    while @buffer.length < 16_384 && !@eof
+      str = @io.gets(16_384)
       if !str
         @eof = true
       else
@@ -43,7 +41,7 @@ private
     end
   end
 
-  #Searches for a given regex. If found the contents is removed from the buffer.
+  # Searches for a given regex. If found the contents is removed from the buffer.
   def search(regex)
     ensure_buffer
 
@@ -53,10 +51,10 @@ private
       return match
     end
 
-    return false
+    false
   end
 
-  #Asumes a tag is the next to be parsed and adds it to document-data.
+  # Asumes a tag is the next to be parsed and adds it to document-data.
   def parse_tag(args = {})
     if match = search(/\A\s*<\s*(\/|)\s*(\S+?)(\s+|\/\s*>|>)/)
       tag_name = match[2].to_s.strip.downcase
@@ -78,7 +76,7 @@ private
       @eles_t << ele
       puts "New element-match: #{match.to_a}" if @debug
 
-      if end_sign.match(/^\/\s*>$/)
+      if end_sign =~ /^\/\s*>$/
         puts "End of element '#{tag_name}' for '#{@eles_t.last.name}'." if @debug
         ele = @eles_t.pop
         raise "Expected ele-name to be: '#{tag_name}' but it wasnt: '#{ele.name}'." if ele.name.to_s != tag_name
@@ -101,7 +99,7 @@ private
     end
   end
 
-  #Parses all attributes of the current tag.
+  # Parses all attributes of the current tag.
   def parse_attr_of_tag(ele, tag_name)
     loop do
       if match = search(/\A\s*(\S+)=(\"|'|)/)
@@ -129,21 +127,21 @@ private
     end
   end
 
-  #Parses an attribute-value until a given quote-char is reached.
+  # Parses an attribute-value until a given quote-char is reached.
   def parse_attr_until_quote(quote_char, quote_val)
     val = ""
 
     loop do
       ensure_buffer
       char = @buffer.slice!(0)
-      break if !char
+      break unless char
 
       if char == "\\"
         val << char
         val << @buffer.slice!(0)
       elsif char =~ quote_char
         break
-      elsif char == ">" and quote_val == :whitespace
+      elsif char == ">" && quote_val == :whitespace
         @buffer = char + @buffer
         break
       else
@@ -151,13 +149,13 @@ private
       end
     end
 
-    return val
+    val
   end
 
-  #Assumes some content of a tag is next to be parsed and parses it.
+  # Assumes some content of a tag is next to be parsed and parses it.
   def parse_content_of_tag(ele, tag_name)
     raise "Empty tag-name given: '#{tag_name}'." if tag_name.to_s.strip.empty?
-    raise "No 'ele' was given." if !ele
+    raise "No 'ele' was given." unless ele
 
     loop do
       if search(/\A\s*\Z/)
@@ -170,15 +168,15 @@ private
         break
       elsif new_ele = parse_tag(false: true)
         puts "Found new element '#{new_ele.name}' and adding it to '#{ele.name}'." if @debug
-        #ele.eles << new_ele
+        # ele.eles << new_ele
       elsif match = search(/\A(.+?)(<|\Z)/)
         puts "Text-content-match: '#{match.to_a}'." if @debug
 
-        #Put end back into buffer.
+        # Put end back into buffer.
         @buffer = match[2] + @buffer
         puts "Buffer after text-match: #{@buffer}" if @debug
 
-        #Add text element to list as finished.
+        # Add text element to list as finished.
         ele.eles << HtmlGen::TextEle.new(str: match[1])
       else
         raise "Dont know what to do with buffer: '#{@buffer}'."

data/lib/html_gen/text_ele.rb

@@ -8,36 +8,37 @@ class HtmlGen::TextEle
     @nl = args[:nl]
   end
 
-  #Returns the text that this element holds.
-  def str
-    return @str
-  end
+  # Returns the text that this element holds.
+  attr_reader :str
 
-  #Returns the text HTML-escaped.
+  # Returns the text HTML-escaped.
   def html(args)
-    if args[:level]
-      level = args[:level]
-    else
-      level = 0
-    end
+    str = ""
+    str << @inden * level(args) if pretty?(args)
+    str << html_content
+    str << @nl if pretty?(args)
+    str
+  end
 
-    if !args.key?(:pretty) or args[:pretty]
-      pretty = true
+private
+
+  def pretty?(args)
+    !args.key?(:pretty) || args[:pretty]
+  end
+
+  def level
+    if args[:level]
+      args[:level]
     else
-      pretty = false
+      0
     end
+  end
 
-    str = ""
-    str << @inden * level if pretty
-
+  def html_content
     if @str
-      str << HtmlGen.escape_html(@str)
+      HtmlGen.escape_html(@str)
     else
-      str << @html
+      @html
     end
-
-    str << @nl if pretty
-
-    return str
   end
 end

data/lib/html_gen.rb

@@ -6,7 +6,7 @@ class HtmlGen
   def self.const_missing(name)
     file_path = "#{File.dirname(__FILE__)}/html_gen/#{::StringCases.camel_to_snake(name)}.rb"
 
-    if File.exists?(file_path)
+    if File.exist?(file_path)
       require file_path
       return HtmlGen.const_get(name) if HtmlGen.const_defined?(name)
     end
@@ -16,6 +16,6 @@ class HtmlGen
 
   # 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;")
+    string.to_s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
   end
 end

data/shippable.yml

@@ -2,8 +2,9 @@ language: ruby
 cache: bundler
 archive: true
 rvm:
-  - 2.1.2
+  - 2.1.7
 script:
   - CODECLIMATE_REPO_TOKEN=81bf37d5bc3daf65852d6763dda5dbe2f39d5273dd23ac85a91d3efd41cd74d3 bundle exec rspec
+  - bundle exec rake best_practice_project:run
 notifications:
    email: false

data/spec/html_gen_parser_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
 
 describe "Parser" do
   let(:parser) { HtmlGen::Parser.new(str: "<html><head><title>Test</title></head><body>This is the body</body></html>") }

data/spec/html_gen_spec.rb

@@ -55,11 +55,11 @@ describe "HtmlGen" do
   end
 
   it "supports data attributes" do
-    div_ele = HtmlGen::Element.new(:div, str: "Test", data: {test: "value"})
+    HtmlGen::Element.new(:div, str: "Test", data: {test: "value"})
   end
 
   it "supports nested data attributes" do
-    div_ele = HtmlGen::Element.new(:div, str: "Test", data: {deep: {nested: {test: "value"}}})
-    div_ele.html(pretty: false).should eq "<div data-deep-nested-test=\"value\">Test</div>"
+    div_ele = HtmlGen::Element.new(:div, str: "Test", data: {deep: {nested: {test: "value", test_underscoe: "test"}}})
+    div_ele.html(pretty: false).should eq "<div data-deep-nested-test=\"value\" data-deep-nested-test-underscoe=\"test\">Test</div>"
   end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,14 @@
 require "codeclimate-test-reporter"
 CodeClimate::TestReporter.start
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'html_gen'
+require "rspec"
+require "html_gen"
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html_gen
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Kasper Johansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: string-cases
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: best_practice_project
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A small framework for generating HTML.
 email: k@spernj.org
 executables: []
@@ -90,6 +118,8 @@ extra_rdoc_files:
 files:
 - ".document"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt