bem_html 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3b18970639fd699f7614d5b2894e9c51007d6bf
+  data.tar.gz: fccca43f3f35e40f1c5c55c6adfdb0222cff6b34
+SHA512:
+  metadata.gz: a6ab8f5a0ef7dc586b014732876b7c84feaa8b18b2681a44b6b7296dda5a7563dbdb08ab5475d7b5e945aba661c529058c2df7be0f1be1dcde686b8747e2fa16
+  data.tar.gz: 517466b78e4e1a78925eb405be73624463aae2be87d7cfe5111cd327b64c2bf494cd6e4394ed33d7428902554b8f3a766ee7a1552e3e82ef0d85fdd410e07471

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bem_html.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/Readme.md

@@ -0,0 +1,64 @@
+# bem_html
+
+BEM helpers for HTML.
+
+Utility to convert HTML attributes (`bem-block`, `bem-element`, and `bem-modifiers`) to proper CSS classnames for use in BEM.
+
+## Purpose
+
+In large projects, BEM namespacing can get fairly complicated. In Sass and PostCSS, there exist a number of helper methods to simply the creation of nested Block, Element, Modifier classes; however, this plugin provides similar helper methods within HTML itself.
+
+## Sample Usage
+
+Say you had a BEM block called "widget" that had the following structure in HTML:
+
+~~~html
+
+<div class="widget">
+	<h1 class="widget__heading widget__heading--lime">Heading</h1>
+	<section class="widget__content">
+		<p class="widget__content__first-paragraph">First Paragraph</p>
+	</section>
+</div>
+~~~
+
+With bem-html, you could define that structure instead as the following:
+
+~~~html
+<div bem-block="widget">
+	<h1 bem-element="heading" modifiers="[:lime]">Heading</h1>
+	<section bem-element="content">
+		<p bem-element="first-paragraph">First Paragraph</p>
+	</section>
+</div>
+~~~
+
+And this extension would produce the desired HTML.
+
+Originally, this extension was specifically designed for HAML, where it really shines:
+
+~~~haml
+%div{bem:{block: :widget}}
+	%h1{bem:{element: :heading, modifiers: [:lime]}} Heading
+	%section{bem:{element: :content}}
+		%p{bem: {element: "first-paragraph"}} First Paragraph
+~~~
+
+## Installation
+
+Install using `gem bem_html`
+
+## Usage
+
+Sample Ruby code:
+
+~~~ ruby
+require "bem_html"
+
+html = IO.read("index.html")
+BemHtml.parse(html) # -> Will output index.html with bem-* tags converted to CSS names
+~~~
+
+## Todo
+
+* Binary parser for CLI usage

data/bem_html.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "bem_html"
+  s.version     = "1.0.1"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Pilsch"]
+  s.email       = ["apilsch@tamu.edu"]
+  s.homepage    = "https://github.com/oncomouse/bem_html"
+  s.summary     = %q{Build BEM class tags on HTML elements from HTML attributes (bem-block, bem-element, and bem-modifiers).}
+  # s.description = %q{A longer description of your extension}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("nokogiri", ["~> 1.6"])
+  
+  s.license = "ISC"
+  
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'bem_html')

data/lib/bem_html.rb

@@ -0,0 +1,69 @@
+require 'json'
+require 'nokogiri'
+
+class BemHtml
+	def self.parse(content)
+		html_doc = Nokogiri::HTML(content)
+		html_doc.xpath('.//*[@bem-block]|*[@bem-block]').each do |blockNode|
+			currentBlock = blockNode["bem-block"]
+			blockNode.attributes["bem-block"].remove
+			if(not blockNode['class'])
+				blockNode['class'] = ""
+			end
+			blockNode['class'] += " #{currentBlock}"
+			nextBlock = [currentBlock]
+			if(blockNode.attributes["bem-modifiers"])
+				JSON.parse(blockNode.attributes["bem-modifiers"].value.gsub(/\:(\w+)/,'"\1"')).each do |modifier|
+					nextBlock.push("#{currentBlock}--#{modifier}")
+					blockNode['class'] += " #{currentBlock}--#{modifier}"
+				end
+				blockNode.attributes["bem-modifiers"].remove
+			end
+			processingQueue = [[nextBlock, blockNode.children]]
+			while processingQueue.length > 0
+				topQueue = processingQueue.shift
+				currentBlock = topQueue[0]
+				nodes = topQueue[1]
+				nodes.each do |node|
+					next if not node.attributes
+					next if node.attributes["bem-block"]
+					next if not node.attributes["bem-element"]
+				
+					if(not node['class'])
+						node['class'] = ""
+					end
+				
+					element = node.attributes["bem-element"]
+					node.attributes["bem-element"].remove
+					if(currentBlock.respond_to? :push)
+						nextBlock = currentBlock.map do |cb|
+							node['class'] += " #{cb}__#{element}"
+							"#{cb}__#{element}"
+						end
+					else
+						nextBlock = "#{currentBlock}__#{element}"
+						node['class'] += " #{nextBlock}"
+					end
+				
+					if(node.attributes["bem-modifiers"])
+						JSON.parse(node.attributes["bem-modifiers"].value.gsub(/\:(\w+)/,'"\1"')).each do |modifier|
+							if(currentBlock.respond_to? :push)
+								currentBlock.each do |cb|
+									node['class'] += " #{cb}__#{element}--#{modifier}"
+									nextBlock.push("#{cb}__#{element}--#{modifier}")
+								end
+							else
+								node['class'] += " #{currentBlock}__#{element}--#{modifier}"
+							end
+						end
+						node.attributes["bem-modifiers"].remove
+					end
+					if(node.children.length > 0)
+						processingQueue.push([nextBlock, node.children])
+					end
+				end
+			end
+		end
+		html_doc.to_s
+	end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: bem_html
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Andrew Pilsch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- apilsch@tamu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Rakefile
+- Readme.md
+- bem_html.gemspec
+- features/support/env.rb
+- lib/bem_html.rb
+homepage: https://github.com/oncomouse/bem_html
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Build BEM class tags on HTML elements from HTML attributes (bem-block, bem-element,
+  and bem-modifiers).
+test_files:
+- features/support/env.rb