komplement 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2400a082d25fa86f6d7bf5541813fbc2c76227c4
+  data.tar.gz: b5d8f7aebb735cc924e81917416ba6ba5b3caaaf
+SHA512:
+  metadata.gz: 0b20765a4e4a02dc65b6822a13290106a049401d2b795b40d70ce9c329f1f8ccf005c69fca1eb94791005efb2526f927350065ec92594819d919ccd65d568a20
+  data.tar.gz: ba0808df7142c46dd674a468f0e5162499ba09356a1665e474e2f5b33d4d6628efe671cb2366cd465b91c829036e3beef37fa5787f2a6ef37ff7c35483faf5a5

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+README.md
+ChangeLog.md
+
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,5 @@
+/.bundle
+/Gemfile.lock
+/html/
+/pkg/
+/vendor/cache/*.gem

data/.rdoc_options

@@ -0,0 +1,16 @@
+--- !ruby/object:RDoc::Options
+encoding: UTF-8
+static_path: []
+rdoc_include:
+  - .
+charset: UTF-8
+exclude: 
+hyperlink_all: false
+line_numbers: false
+main_page: README.md
+markup: markdown
+show_hash: false
+tab_width: 8
+title: komplement Documentation
+visibility: :protected
+webcvs:

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+before_install:
+  - gem install bundler
+language: ruby
+rvm:
+  - 2.2.3
+script: bundle exec rspec spec

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2016-05-11
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Simon Symeonidis
+
+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

@@ -0,0 +1,58 @@
+# komplement
+
+It's a dumb sanity check tool for your html. The idea is that if you create your
+custom elements (for example, look at knockout.js components), and you want to
+make sure that nothing goes awry while maintaining your source, you can run this
+easilly configurable tool to do it for you.
+
+* [Homepage](https://github.com/psyomn/komplement#readme)
+* [Issues](https://github.com/psyomn/komplement/issues)
+* [Documentation](http://rubydoc.info/gems/komplement/frames)
+* [Email](mailto:lethaljellybean at gmail.com)
+
+[![Build Status](https://secure.travis-ci.org/psyomn/komplement.svg?branch=master)](https://travis-ci.org/psyomn/komplement)
+
+## Features
+## Examples
+
+If you want to do things by hand:
+
+```ruby
+    require 'komplement'
+
+    Komplement
+      .new
+      .with_ignored(%w[a br div])
+      .with_ignored(%w[custom-element potato])
+      .in_filetypes(%w[rb erb.html html])
+      .in_dirs(%w[./app ./some-other-place])
+      .run
+```
+
+A constant to get rid of most manual workings is provided for you if you want to
+use it:
+
+```ruby
+    require 'komplement'
+
+    Komplement
+      .new
+      .with_ignored(Komplement::HTML_ELEMENTS)
+      .with_ignored(%w[custom-element potato])
+      .in_filetypes(%w[rb erb.html html])
+      .in_dirs(%w[./app ./some-other-place])
+      .run
+```
+## Install
+
+    $ gem install komplement
+
+## Synopsis
+
+    $ komplement
+
+## Copyright
+
+Copyright (c) 2016 Simon (psyomn) Symeonidis
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/bin/komplement

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+root = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+if File.directory?(File.join(root,'.git'))
+  Dir.chdir(root) do
+    begin
+      require 'bundler/setup'
+    rescue LoadError => e
+      warn e.message
+      warn "Run `gem install bundler` to install Bundler"
+      exit -1
+    end
+  end
+end
+
+require 'komplement'
+include Komplement
+
+puts "Looking into #{ARGV[0]}"
+
+Komplement::Base
+  .new
+  .with_ignored(Komplement::HTML_ELEMENTS)
+  .in_filetypes(['html'])
+  .in_dirs([ARGV[0]])
+  .run

data/komplement.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'komplement/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "komplement"
+  gem.version       = Komplement::VERSION
+  gem.summary       = %q{Simple sanity checking tool for your html}
+  gem.description   = <<DESC
+    Simple sanity checking tool for your html, that will
+    scan files, and detect html elements you might be unaware of}
+DESC
+  gem.license       = "MIT"
+  gem.authors       = ["Simon Symeonidis"]
+  gem.email         = "lethaljellybean@gmail.com"
+  gem.homepage      = "https://github.com/psyomn/komplement#readme"
+
+  gem.files         = `git ls-files`.split($/)
+
+  `git submodule --quiet foreach --recursive pwd`.split($/).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/",'')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($/).map do |subpath|
+        gem.files << File.join(submodule,subpath)
+      end
+    end
+  end
+
+  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_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'rake', '~> 10.0'
+  gem.add_development_dependency 'rdoc', '~> 4.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_runtime_dependency 'nokogiri', '~> 1.6'
+  gem.add_runtime_dependency 'colorize', '~> 0.7.7'
+end

data/lib/komplement/base.rb

@@ -0,0 +1,101 @@
+require 'komplement'
+
+module Komplement
+  class Base
+    def initialize
+      @ignored_elements = @filetypes = @dirs = []
+    end
+
+    # which html elements to ignore
+    def with_ignored(ignored_a)
+      @ignored_elements += ignored_a
+      self
+    end
+
+    # filetypes to look into for html elements
+    def in_filetypes(filetypes_a)
+      @filetypes = filetypes_a.map { |e| "*.#{e}" }
+      self
+    end
+
+    # all the paths we should look into
+    def in_dirs(dirs_a)
+      @dirs += dirs_a
+      self
+    end
+
+    # returns 0 on no offenses, else 2
+    def run
+      unknown = find_offenses
+      exit process_output(unknown)
+    end
+
+    def find_offenses
+      [@ignored_elements, @filetypes, @dirs].map { |e| e.uniq! }
+
+      paths = make_paths
+      @files_of_interest = make_files(paths)
+
+      unknown = Hash.new { |h, k| h[k] = [] }
+
+      @files_of_interest.each do |file|
+        contents = File.read(file)
+        Nokogiri::HTML(contents).traverse do |node|
+          unless @ignored_elements.include? nm = node.name
+            unknown[file].push nm
+          end
+        end
+      end
+      unknown
+    end
+
+    attr_accessor :ignored_elements
+    attr_accessor :filetypes
+    attr_accessor :dirs
+
+    attr_reader :files_of_interest
+
+    private
+
+    def make_paths
+      @dirs.uniq!
+      paths = []
+      @dirs.each do |dir|
+        @filetypes.each do |filetype|
+          paths.push File.join(dir, '**', filetype)
+        end
+      end
+      paths
+    end
+
+    def make_files(paths_a)
+      files = []
+      paths_a.each do |path|
+        files += Dir.glob(path)
+      end
+      files
+    end
+
+    # @param unknown_h are the unknown elements that may have been detected
+    def process_output(unknown_h)
+      if unknown_h.empty?
+        $stderr.puts 'No problematic html found'.green.bold
+        return EXIT_SUCCESS
+      end
+
+      $stderr.puts 'ERROR: Detected possible unknown components:'.red.bold
+
+      unknown_h.each do |file_name, elements|
+        $stderr.puts file_name.green.bold
+        elements.each do |offending_element_name|
+          $stderr.puts "  #{offending_element_name}"
+        end
+      end
+
+      EXIT_FAIL
+    end
+
+    EXIT_SUCCESS = 0
+    EXIT_FAIL = 2
+  end
+end

data/lib/komplement/version.rb

@@ -0,0 +1,4 @@
+module Komplement
+  # komplement version
+  VERSION = "0.1.0"
+end

data/lib/komplement.rb

@@ -0,0 +1,17 @@
+require 'nokogiri'
+require 'colorize'
+
+require 'komplement/version'
+require 'komplement/base'
+
+module Komplement
+  HTML_ELEMENTS = %w[
+    a abbr article aside audio b body br button canvas caption col colgroup
+    comment datalist dd details div dl document dt em fieldset footer form g h1 h2
+    h3 h4 h5 head header hgroup hr HTML html i iframe img input label legend li link
+    math meta meter mfrac mi mn mo mrow msup nav noscript object ol optgroup option
+    p parameter pre progress rect rt ruby script section select small source span
+    strong style summary svg table tbody td template text textarea tfoot th thead
+    title tr ul video xml #cdata-section
+  ]
+end

data/spec/files/bad_html.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head></head>
+
+  <body>
+    <h1> This is fine </h2>
+    <potato> this is a potato </potato>
+  </body>
+</html>

data/spec/files/normal_html.html

@@ -0,0 +1,7 @@
+<html>
+  <head></heAD>
+
+  <body>
+    <h1> Hello world </h1>
+  </body>
+</html>

data/spec/komplement_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'komplement'
+
+describe Komplement do
+  it "should have a VERSION constant" do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+
+  describe Base do
+    it "should detect common html elements" do
+      ret = Komplement::Base
+              .new
+              .with_ignored(Komplement::HTML_ELEMENTS)
+              .in_filetypes(['html'])
+              .in_dirs(['./spec/files/'])
+              .find_offenses
+
+      expect(ret).to_not be_empty
+      expect(ret['./spec/files/bad_html.html']).to eq(['potato'])
+    end
+
+    it "should detect everything if no exclusion list is given" do
+      ret = Komplement::Base
+              .new
+              .with_ignored([])
+              .in_filetypes(['html'])
+              .in_dirs(['./spec/files/'])
+              .find_offenses
+
+      expect(ret).to_not be_empty
+
+      expect(ret['./spec/files/bad_html.html']).to eq([
+        "html", "text", "head", "text", "text", "text", "text",
+        "potato", "text", "h1", "body", "text", "html", "document"])
+    end
+
+    it "should ignore custom elements if specified so" do
+      ret = Komplement::Base
+              .new
+              .with_ignored(Komplement::HTML_ELEMENTS)
+              .with_ignored(['potato'])
+              .in_filetypes(['html'])
+              .in_dirs(['./spec/files/'])
+              .find_offenses
+
+      expect(ret).to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'komplement/version'
+
+include Komplement

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: komplement
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Symeonidis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+description: |2
+      Simple sanity checking tool for your html, that will
+      scan files, and detect html elements you might be unaware of}
+email: lethaljellybean@gmail.com
+executables:
+- komplement
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rdoc_options"
+- ".rspec"
+- ".travis.yml"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/komplement
+- komplement.gemspec
+- lib/komplement.rb
+- lib/komplement/base.rb
+- lib/komplement/version.rb
+- spec/files/bad_html.html
+- spec/files/normal_html.html
+- spec/komplement_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/psyomn/komplement#readme
+licenses:
+- MIT
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple sanity checking tool for your html
+test_files:
+- spec/files/bad_html.html
+- spec/files/normal_html.html
+- spec/komplement_spec.rb
+- spec/spec_helper.rb