RubyGems - hamlizer - Versions diffs - 0.0.1 - Mend

hamlizer 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

data/.gitignore +17 -0
data/.rvmrc +1 -0
data/Gemfile +4 -0
data/LICENSE.txt +22 -0
data/README.md +31 -0
data/Rakefile +5 -0
data/hamlizer.gemspec +24 -0
data/lib/hamlizer.rb +42 -0
data/lib/hamlizer/attributes_haml_converter.rb +38 -0
data/lib/hamlizer/element_haml_converter.rb +75 -0
data/lib/hamlizer/html_element.rb +60 -0
data/lib/hamlizer/version.rb +3 -0
data/spec/lib/hamlizer_spec.rb +113 -0
data/spec/spec_helper.rb +13 -0
metadata +111 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc ADDED Viewed

	@@ -0,0 +1 @@
1	+ rvm --create 1.9.3@hamlizer

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in hamlizer.gemspec
+gemspec

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lilibeth De La Cruz
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,31 @@
+# Hamlizer
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/lilibethdlc/hamlizer)
+HTML/ERB to HAML converter
+## Installation
+Add this line to your application's Gemfile:
+    gem 'hamlizer'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install hamlizer
+## Usage
+TODO: Write usage instructions here
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile ADDED Viewed

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task default: :spec

data/hamlizer.gemspec ADDED Viewed

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hamlizer/version'
+Gem::Specification.new do |gem|
+  gem.name = 'hamlizer'
+  gem.version = Hamlizer::VERSION
+  gem.authors = ['Lilibeth De La Cruz', 'Edgar Gonzalez']
+  gem.email = ['lilibethdlc@gmail.com', 'edggonzalezg@gmail.com']
+  gem.description = %q{Convert your views from HTML/ERB to HAML}
+  gem.summary = %q{HTML/ERB to HAML converter}
+  gem.homepage = ''
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  gem.add_dependency 'nokogiri'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'haml'
+end

data/lib/hamlizer.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require 'hamlizer/version'
+require 'hamlizer/html_element'
+require 'hamlizer/element_haml_converter'
+require 'hamlizer/attributes_haml_converter'
+require 'nokogiri'
+module Hamlizer
+  def self.hamlize(html)
+    convert_erb_to_parseable_xml!(html)
+    if html.start_with?('<html>')
+      root = Nokogiri::HTML.parse(html).root
+    else
+      root = Nokogiri::HTML::DocumentFragment.parse(html)
+    end
+    return '' if root.nil?
+    children_haml = root.children.map { |element| ElementHamlConverter.new(HtmlElement.new(element)).haml }.join("\n")
+    if html.start_with?('<html>')
+      haml = "%html"
+      haml += "\n  #{children_haml}" unless children_haml.empty?
+      haml
+    else
+      children_haml
+    end
+  end
+  def self.convert_erb_to_parseable_xml!(html)
+    remove_erb_printing_code!(html)
+    remove_erb_non_printing_code!(html)
+  end
+  def self.remove_erb_non_printing_code!(html)
+    html.gsub!(/<%(.+?)%>/, '<erb:erb_non_print>\1</erb:erb_non_print>')
+  end
+  def self.remove_erb_printing_code!(html)
+    html.gsub!(/<%=(.+?)%>/, '<erb:erb_print>\1</erb:erb_print>')
+  end
+end

data/lib/hamlizer/attributes_haml_converter.rb ADDED Viewed

@@ -0,0 +1,38 @@
+class AttributesHamlConverter
+  def initialize(element)
+    @element = element
+  end
+  def haml
+    element.has_attributes? ? (id_haml + class_haml + regular_attributes_haml) : ''
+  end
+  private
+  attr_reader :element
+  def attribute_haml(name, value)
+    if name.match(/^\w+$/)
+      attribute_name = "#{name}:"
+    else
+      attribute_name = "'#{name}' =>"
+    end
+    "#{attribute_name} '#{value}'"
+  end
+  def class_haml
+    element.html_class ? ".#{element.html_class.gsub(/\s+/, '.')}" : ''
+  end
+  def id_haml
+    element.id ? "##{element.id}" : ''
+  end
+  def regular_attributes_haml
+    attributes_haml = element.regular_attributes.map do |name, value|
+      attribute_haml name, value
+    end.compact.join(', ')
+    attributes_haml.empty? ? '' : "{ #{attributes_haml} }"
+  end
+end

data/lib/hamlizer/element_haml_converter.rb ADDED Viewed

@@ -0,0 +1,75 @@
+class ElementHamlConverter
+  def initialize(element, level = 1)
+    @element = element
+    @level = level
+  end
+  def haml
+    element_name_haml + attributes_haml + element_content_haml
+  end
+  private
+  attr_reader :element, :level
+  def attributes_haml
+    attributes_haml_converter.haml
+  end
+  def attributes_haml_converter
+    AttributesHamlConverter.new(element)
+  end
+  def element_content_haml
+    content_haml = element.children.map do |child|
+      if child.name == 'erb_print'
+        erb_print_haml(child)
+      elsif child.name == 'erb_non_print'
+        erb_non_print_haml(child)
+      elsif child.name == 'text'
+        text_haml(child)
+      else
+        "\n#{level_spacing}#{ElementHamlConverter.new(child, level + 1).haml}"
+      end
+    end.join
+    content_haml
+  end
+  def element_name_haml
+    should_include_name_in_haml? ? "%#{element.name}" : ''
+  end
+  def child_content(child)
+    child.content.gsub("\n", ' ').strip
+  end
+  def child_haml(child, code = nil)
+    if child.only_child?
+      "#{code} #{child_content(child)}"
+    else
+      code += ' ' if code
+      "\n#{level_spacing}#{code}#{child_content(child)}"
+    end
+  end
+  def erb_non_print_haml(element)
+    child_haml(element, '-')
+  end
+  def erb_print_haml(element)
+    child_haml(element, '=')
+  end
+  def level_spacing
+    '  ' * level
+  end
+  def should_include_name_in_haml?
+    (!element.div? || (element.has_id? && element.has_class?))
+  end
+  def text_haml(element)
+    child_haml(element)
+  end
+end

data/lib/hamlizer/html_element.rb ADDED Viewed

@@ -0,0 +1,60 @@
+require 'nokogiri'
+class HtmlElement
+  def initialize(element)
+    @element = element
+  end
+  def children
+    element.children.map { |child| HtmlElement.new child }
+  end
+  def content
+    element.content
+  end
+  def div?
+    element.name == 'div'
+  end
+  def has_attributes?
+    element.attributes.any?
+  end
+  def has_class?
+    html_class.nil?
+  end
+  def has_content?
+    content && !content.empty?
+  end
+  def has_id?
+    id.nil?
+  end
+  def only_child?
+    element.parent.children.count == 1
+  end
+  def html_class
+    @class ||= element['class']
+  end
+  def id
+    @id ||= element['id']
+  end
+  def name
+    element.name
+  end
+  def regular_attributes
+    Hash[element.attributes.select { |name, _| !%w(id class).include? name }]
+  end
+  private
+  attr_reader :element, :parent
+end

data/lib/hamlizer/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Hamlizer
+  VERSION = "0.0.1"
+end

data/spec/lib/hamlizer_spec.rb ADDED Viewed

@@ -0,0 +1,113 @@
+require 'spec_helper'
+describe Hamlizer do
+  describe '.hamlize' do
+    it 'leaves an empty string alone' do
+      expect(hamlize('')).to eq ''
+    end
+    it 'returns empty string for whitespace' do
+      expect(hamlize('       ')).to eq ''
+      expect(hamlize("\n\n\n\n")).to eq ''
+    end
+    it 'converts an empty tag correctly' do
+      expect(hamlize('<br/>')).to eq '%br'
+      expect(hamlize('<br>')).to eq '%br'
+    end
+    it 'converts html standard layout tags correctly' do
+      expect(hamlize('<html></html>')).to eq '%html'
+      expect(hamlize('<html><body></body></html>')).to eq "%html\n  %body"
+    end
+    it 'converts a tag with no content' do
+      expect(hamlize('<span></span>')).to eq '%span'
+    end
+    it 'converts a tag with text content' do
+      text = 'abc'
+      expect(hamlize("<span>#{text}</span>")).to eq "%span #{text}"
+      expect(hamlize("<span>#{text}\n#{text}</span>")).to eq "%span #{text} #{text}"
+    end
+    it 'converts multiple tags on the same level' do
+      expect(hamlize('<br/><br/><br/>')).to eq "%br\n%br\n%br"
+      text = 'hello'
+      expect(hamlize("<span>#{text}</span><span/>")).to eq "%span #{text}\n%span"
+    end
+    it 'converts nested tags' do
+      expect(hamlize('<div><span></span></div>')).to eq "%div\n  %span"
+      expect(hamlize('<div><p><span></span></p></div>')).to eq "%div\n  %p\n    %span"
+    end
+    it 'converts nested tags with content' do
+      expect(hamlize('<div>abc<span>abc</span></div>')).to eq "%div\n  abc\n  %span abc"
+      expect(hamlize('<div>abc<p>hello<span>abc</span></p></div>')).to eq "%div\n  abc\n  %p\n    hello\n    %span abc"
+    end
+    it 'converts a tag with attributes' do
+      title = 'El Titulo'
+      source = 'La Fuente'
+      expect(hamlize("<span title='#{title}'></span>")).to eq "%span{ title: '#{title}' }"
+      expect(hamlize("<span title='#{title}' source='#{source}'></span>")).to eq "%span{ title: '#{title}', source: '#{source}' }"
+      expect(hamlize("<span title='#{title}' data-source='#{source}'></span>")).to eq "%span{ title: '#{title}', 'data-source' => '#{source}' }"
+    end
+    it 'uses the "#id" syntax for the id attribute' do
+      id = 'el_identificador'
+      title = 'El Titulo'
+      expect(hamlize("<span id='#{id}'></span>")).to eq "%span##{id}"
+      expect(hamlize("<span id='#{id}' title='#{title}'></span>")).to eq "%span##{id}{ title: '#{title}' }"
+    end
+    it 'uses the ".class" syntax for the class attribute' do
+      html_class = 'la_clase'
+      title = 'El Titulo'
+      expect(hamlize("<span class='#{html_class}'></span>")).to eq "%span.#{html_class}"
+      expect(hamlize("<span class='#{html_class}' title='#{title}'></span>")).to eq "%span.#{html_class}{ title: '#{title}' }"
+      html_classes = %w(una_clase otra_clase)
+      expect(hamlize("<span class='#{html_classes.join(' ')}' title='#{title}'></span>")).to eq "%span.#{html_classes.join('.')}{ title: '#{title}' }"
+      expect(hamlize("<span class='#{html_classes.join('   ')}' title='#{title}'></span>")).to eq "%span.#{html_classes.join('.')}{ title: '#{title}' }"
+    end
+    it 'does not use %div for divs that have an id or a class' do
+      id = 'el_identificador'
+      html_class = 'la_clase'
+      title = 'El Titulo'
+      expect(hamlize('<div></div>')).to eq '%div'
+      expect(hamlize("<div title='#{title}'></div>")).to eq "%div{ title: '#{title}' }"
+      expect(hamlize("<div id='#{id}'></div>")).to eq "##{id}"
+      expect(hamlize("<div class='#{html_class}'></div>")).to eq ".#{html_class}"
+    end
+    it 'parses erb printing code', :focus do
+      expect(hamlize('<strong><%= item.title %></strong>')).to eq '%strong= item.title'
+      expect(hamlize('<p><%= hello %><strong><%= item.title %></strong></p>')).to eq "%p\n  = hello\n  %strong= item.title"
+      expect(hamlize('<p><% hello %><strong><%= item.title %></strong></p>')).to eq "%p\n  - hello\n  %strong= item.title"
+    end
+    it 'parses erb non-printing code' do
+      expect(hamlize('<div><% a = 2 + 2 %></div>')).to eq '%div- a = 2 + 2'
+    end
+  end
+  def hamlize(html)
+    haml = Hamlizer.hamlize(html)
+    begin
+      Haml::Engine.new(haml).to_html
+    rescue Exception => e
+      raise e.class, "#{e.message}\nIn: #{haml}" unless [NameError, NoMethodError].include? e.class
+    end
+    haml
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'hamlizer'
+require 'rspec'
+require 'haml'
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = :documentation
+  config.order = :random
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: hamlizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- Lilibeth De La Cruz
+- Edgar Gonzalez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert your views from HTML/ERB to HAML
+email:
+- lilibethdlc@gmail.com
+- edggonzalezg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hamlizer.gemspec
+- lib/hamlizer.rb
+- lib/hamlizer/attributes_haml_converter.rb
+- lib/hamlizer/element_haml_converter.rb
+- lib/hamlizer/html_element.rb
+- lib/hamlizer/version.rb
+- spec/lib/hamlizer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: HTML/ERB to HAML converter
+test_files:
+- spec/lib/hamlizer_spec.rb
+- spec/spec_helper.rb