enlint 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07b94cdaaa325460bc0f1d2914aefc6062ec0abe
+  data.tar.gz: 4fdcb7ddf3cc9b5b64ca05357322df1cad0a595c
+SHA512:
+  metadata.gz: fd3f7dd9531c43fd0c3bdd3fb9e64a386e5a63028eba051ac47e33890c2ff45cf690d6eaa160a39f251384a5716b2943579d071bc669aa52fa2a0a8eb99e4d4a
+  data.tar.gz: 09491a8f512067b8e4b2a49f850af707bf1ab3ab569686ca68a6ebae81c1d63ccf9c86531b9edfcf18daf1b870a7382fbf7f6ca90355b9f1a7c181052d4a10da

data/LICENSE.md

@@ -0,0 +1,23 @@
+# FreeBSD License
+
+# Copyright 2014 Andrew Pennebaker. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/enlint

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'find'
+require 'optparse'
+
+require 'rubygems'
+require 'enlint'
+
+def main
+  ignores = DEFAULT_IGNORES
+
+  filenames = ['.']
+
+  option = OptionParser.new do |option|
+    option.banner = 'Usage: enlint [options] [<files>]'
+
+    option.on('-i', '--ignore pattern', 'Ignore file names matching Ruby regex pattern') do |pattern|
+      ignores << pattern
+    end
+
+    option.on('-h', '--help', 'Print usage info') do
+      puts option
+      exit
+    end
+
+    option.on('-v', '--version', 'Print version info') do
+      puts "enlint #{EnLint::VERSION}"
+      exit
+    end
+  end
+
+  option.parse!
+
+  filenames = ARGV unless ARGV.empty?
+
+  recursive_filenames = []
+
+  filenames.each do |f|
+    if File.directory? f
+      recursive_filenames = recursive_filenames.concat(recursive_list(f, ignores))
+    else
+      recursive_filenames << f
+    end
+  end
+
+  recursive_filenames.each { |f| check f }
+end
+
+begin
+  main
+# User may quit enlint before completion.
+rescue Interrupt
+  nil
+# enlint may be piped to another program (e.g. `less`),
+# which is quit before enlint completes.
+rescue Errno::EPIPE, Errno::EMFILE
+  nil
+end

data/lib/enlint.rb

@@ -0,0 +1,113 @@
+require 'rubygems'
+require 'ptools'
+
+require 'version'
+
+DEFAULT_IGNORES = %w(
+  .hg/
+  .svn/
+  .git/
+  .git
+  .gitignore
+  node_modules/
+  .vagrant/
+  Gemfile.lock
+  .exe
+  .bin
+  .pdf
+  .png
+  .jpg
+  .jpeg
+  .svg
+  .min.js
+  -min.js
+)
+
+#
+# Note that order is significant;
+# Only the earliest file pattern match's rule applies.
+#
+DEFAULT_RULES = [
+  [/\.reg$/, /utf-16/],
+  [/.*/, /(utf-8|ascii|binary|unknown)/]
+]
+
+# Warning for files that do not exist
+NO_SUCH_FILE = 'no such file'
+
+#
+# Parse, model, and print an encoding.
+# Distinct from Ruby's built-in Encoding class.
+#
+class AnEncoding
+  attr_accessor :filename, :empty, :encoding
+
+  def self.parse(filename, file_line)
+    if file_line =~ /ERROR\:/ then
+      AnEncoding.new(filename, false, NO_SUCH_FILE)
+    else
+      match = file_line.match(/^.+\:\s+(.+);\s+charset=(.+)$/)
+
+      empty = match[1] == 'inode/x-empty'
+      encoding = match[2]
+
+      AnEncoding.new(filename, empty, encoding)
+    end
+  end
+
+  def initialize(filename, empty, encoding)
+    @filename = filename
+    @empty = empty
+    @encoding = encoding
+  end
+
+  def violate?(rules)
+    # Ignore empty files, which are considered binary.
+    if @empty then
+      false
+    else
+      preferred = rules.select { |rule| filename =~ rule.first }.first[1]
+
+      if ! (encoding =~ preferred) then
+        [encoding, preferred]
+      else
+        false
+      end
+    end
+  end
+
+  def to_s(encoding_difference = false)
+    if encoding_difference then
+      observed = encoding_difference[0]
+      preferred = encoding_difference[1].inspect
+
+      if observed == NO_SUCH_FILE then
+        "#{@filename}: #{NO_SUCH_FILE}"
+      else
+        "#{@filename}: observed #{observed} preferred: #{preferred}"
+      end
+    else
+      "#{@filename}: #{@encoding}"
+    end
+  end
+end
+
+def self.recursive_list(directory, ignores = DEFAULT_IGNORES)
+  Find.find(directory).reject do |f|
+    File.directory?(f) ||
+    ignores.any? { |ignore| f =~ /#{ignore}/ } ||
+    File.binary?(f)
+  end
+end
+
+def self.check(filename, rules = DEFAULT_RULES)
+  line = `file -i "#{filename}" 2>&1`
+
+  encoding = AnEncoding.parse(filename, line)
+
+  encoding_difference = encoding.violate?(rules)
+
+  if encoding_difference then
+    puts encoding.to_s(encoding_difference)
+  end
+end

data/lib/version.rb

@@ -0,0 +1,6 @@
+#
+# EnLint
+#
+module EnLint
+  VERSION = '0.1'
+end

metadata

@@ -0,0 +1,258 @@
+--- !ruby/object:Gem::Specification
+name: enlint
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Andrew Pennebaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: reek
+  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: flay
+  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: flog
+  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: roodi
+  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: churn
+  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: cane
+  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: excellent
+  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'
+- !ruby/object:Gem::Dependency
+  name: tailor
+  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: guard
+  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: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: cucumber
+  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: See README.md for example usage
+email: andrew.pennebaker@gmail.com
+executables:
+- enlint
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- bin/enlint
+- lib/enlint.rb
+- lib/version.rb
+homepage: https://github.com/mcandre/enlint
+licenses:
+- FreeBSD
+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.2.2
+signing_key: 
+specification_version: 4
+summary: encoding linter
+test_files: []