cowl 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eeeaea54a13d739e017d255d4d621ac6230e521
-  data.tar.gz: 98202af27c71039c0757da39ebc94e21b30339e8
+  metadata.gz: 436d01bac929781a14589af2137d683976216efd
+  data.tar.gz: 21b34be19ede64bfea48b8c1318d3ce644de4212
 SHA512:
-  metadata.gz: 6e3461512a78c1c8d46044abe148276df37df975020a98e22a0b65836026535c951b266acf77417fcdcf0d4767a40c6cbe4b1e3878bbf234ad647ff562a8a026
-  data.tar.gz: c0c6ab889dd8c5205faecf30cb517da6c86a04cc674ead45390ade986328f0a288d5ee73c71dccb7db15ef63f9297a73455d3160411f179615e4078c37ef86da
+  metadata.gz: 543230d30dff94fe4b73c722786835d2d426f225010f651eeec5afb4a49e452f6670587b2a041342db5a532a124917fccdd619262359cfa8ba749fe912992bac
+  data.tar.gz: 44ab04bc4bf5782135459ea0ba832de48081d03724f9f2cc0260991c840737aa2a709679e499c465db835e203070f377f478ddcbb6aafb3a7c83e410f9aa6c85

data/CONFIGURE.md

@@ -0,0 +1,50 @@
+# Configuration
+
+Cowl offers multiple ways to resolve preferences:
+
+1. Command-line flags (`cowl -i`, `cowl -w`)
+2. Dotfiles (`.cowlignore`, `.cowlrc.yml`)
+3. Built-in defaults (`DEFAULT_IGNORES`, `DEFAULT_MAX_WIDTH`)
+
+Any command-line flags that are present override the same settings in dotfiles and built-in defaults.
+
+# Command-line flags
+
+Run `cowl -h` or `cowl --help` for a full list, or refer to the source code for `bin/cowl`.
+
+```
+$ cowl -h
+Usage: cowl [options] [<files>]
+    -i, --ignore pattern             Ignore file names matching Ruby regex pattern
+    -w, --max-width=                 Maximum column width, either an integer or "unlimited". Default: 80
+    -h, --help                       Print usage info
+    -v, --version                    Print version info
+```
+
+# Dotfiles
+
+Cowl automatically applies any `.cowlignore` and/or `.cowlrc.yml` configuration files in the same directory as a file being scanned, or a parent directory (`../.cowlignore`, `../.cowlrc.yml`), up to `$HOME/.cowlignore`, `$HOME/.cowlrc.yml`, if any such files exist.
+
+## `.cowlignore`
+
+Samples:
+
+* [cowl/.cowlignore](https://github.com/mcandre/cowl/blob/master/.cowlignore)
+* [examples/.cowlignore](https://github.com/mcandre/cowl/blob/master/examples/.cowlignore)
+
+A `.cowlignore` may contain Ruby regex patterns of files and/or folders to exclude from scanning, one pattern per line.
+
+## `.cowlrc.yml`
+
+Samples:
+
+* [cowl/.cowlrc.yml](https://github.com/mcandre/cowl/blob/master/.cowlrc.yml)
+* [unwrapped-books/.cowlrc.yml](https://github.com/mcandre/cowl/blob/master/examples/unwrapped-books/.cowlrc.yml)
+
+`.cowlrc.yml` may contain a number of keys:
+
+* `max_width` may be an integer (e.g. `80`), or `unlimited`.
+
+# Built-in defaults
+
+`max_width` defaults to `80`.

data/README.md

@@ -0,0 +1,85 @@
+# cowl - column width linter
+
+# HOMEPAGE
+
+https://github.com/mcandre/cowl
+
+# RUBYGEMS
+
+https://rubygems.org/gems/cowl
+
+# ABOUT
+
+Cowl is a command line program for identifying text lines that are considered too long, wider than the conventional column width `80` or so.
+
+cowl is a shell wrapper around the traditional GNU [grep](http://www.gnu.org/software/grep/) backend, presenting a frontend similar to modern linters like [Reek](https://github.com/troessner/reek/wiki) and [JSHint](http://jshint.com/).
+
+* Recursive file search by default
+* Optional ignore patterns
+* Configuration via per-project and per-user [dotfiles](https://github.com/mcandre/cowl/blob/master/CONFIGURE.md#dotfiles)
+* Install via a standard programming language package manager
+
+# EXAMPLE
+
+```
+$ cowl examples/
+examples/hello.bf:3:++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.
+
+$ wc -L examples/hello.bf
+106 examples/hello.bf
+
+$ cowl -w 106 examples/
+$
+
+$ cowl -i .bf examples/
+$
+```
+
+# REQUIREMENTS
+
+* [Ruby](https://www.ruby-lang.org/) 2+
+* [grep](http://www.gnu.org/software/grep/) (often built-in, or provided by [git](http://git-scm.com/))
+
+E.g., Windows users can `chocolatey install git`.
+
+## Optional
+
+* [wc](http://linux.die.net/man/1/wc) can help determine the longest line in a file
+
+# INSTALL
+
+Install via [RubyGems](http://rubygems.org/):
+
+```
+$ gem install cowl
+```
+
+# CONFIGURE
+
+See [CONFIGURE.md](https://github.com/mcandre/cowl/blob/master/CONFIGURE.md) for details.
+
+# LICENSE
+
+FreeBSD
+
+# DEVELOPMENT
+
+## Testing
+
+Keep the interface working:
+
+```
+$ cucumber
+```
+
+## Linting
+
+Keep the code tidy:
+
+```
+$ rake lint
+```
+
+## Git Hooks
+
+See `hooks/`.

data/bin/cowl

@@ -1,32 +1,30 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
 require 'find'
 require 'optparse'
-
-require 'rubygems'
+require 'yaml'
 require 'cowl'
 
+IGNORE_FILENAME = '.cowlignore'
+CONFIGURATION_FILENAME = '.cowlrc.yml'
+
 def main
   ignores = DEFAULT_IGNORES
 
   filenames = ['.']
 
-  max_width = DEFAULT_MAX_WIDTH
+  configuration_flags = {}
 
   option = OptionParser.new do |option|
-    option.banner = 'Usage: cowl [options] [<files>]'
+    option.banner = "Usage: cowl [options] [<files>]"
 
     option.on('-i', '--ignore pattern', 'Ignore file names matching Ruby regex pattern') do |pattern|
       ignores << pattern
     end
 
-    option.on('-w=', '--max-width', 'Maximum column width (default: 80 characters). Must be non-negative.') do |width|
-      max_width = width.to_i
-
-      if max_width <= 0 then
-        puts option
-        exit
-      end
+    option.on('-w=', '--max-width', "Maximum column width, either an integer or \"unlimited\". Default: 80") do |max_width|
+      configuration_flags["max_width"] = max_width
     end
 
     option.on('-h', '--help', 'Print usage info') do
@@ -54,16 +52,57 @@ def main
     end
   end
 
-  recursive_filenames.each { |f| check(f, max_width) }
+  configuration_dotfile = DEFAULT_CONFIGURATION
+
+  recursive_filenames.each do |f|
+    dir = File.expand_path("..", f)
+
+    parent_of_home = File.expand_path("..", ENV["HOME"])
+
+    while dir != parent_of_home
+      ignore_file = dir + File::SEPARATOR + IGNORE_FILENAME
+
+      if File.exist?(ignore_file) then
+        ignores.concat(open(ignore_file).read.split("\n"))
+      end
+
+      dir = File.expand_path("..", dir)
+    end
+
+    if ignores.none? { |ignore| f =~ %r(#{ignore}) } then
+      dir = File.expand_path("..", f)
+
+      parent_of_home = File.expand_path("..", ENV["HOME"])
+
+      while dir != parent_of_home
+        config_file = dir + File::SEPARATOR + CONFIGURATION_FILENAME
+
+        if File.exist?(config_file) then
+          configuration_dotfile = YAML.load_file(config_file)
+          break
+        else
+          dir = File.expand_path("..", dir)
+        end
+      end
+
+      # Command line flags override dotfile settings
+      configuration = configuration_dotfile.merge(configuration_flags)
+
+      check(f, configuration)
+    end
+  end
 end
 
 begin
   main
-# User may quit enlint before completion.
+# User may quit before completion.
 rescue Interrupt
   nil
-# enlint may be piped to another program (e.g. `less`),
-# which is quit before enlint completes.
+# Bad regex
+rescue RegexpError => e
+  puts e
+# This program may be piped to another program (e.g. `less`),
+# which is quit before this program completes.
 rescue Errno::EPIPE, Errno::EMFILE
   nil
 end

data/lib/cowl.rb

@@ -3,8 +3,6 @@ require 'ptools'
 
 require 'version'
 
-DEFAULT_MAX_WIDTH = 80
-
 DEFAULT_IGNORES = %w(
   .hg/
   .svn/
@@ -24,6 +22,14 @@ DEFAULT_IGNORES = %w(
   -min.js
 )
 
+DEFAULT_MAX_WIDTH = 80
+
+UNLIMITED = 'unlimited'
+
+DEFAULT_CONFIGURATION = {
+  "max_width" => DEFAULT_MAX_WIDTH
+}
+
 #
 # Parse, model, and print a line too wide for its own good
 #
@@ -53,17 +59,26 @@ 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)
+    ignores.any? { |ignore| f =~ %r(#{ignore}) } ||
+
+    begin
+      File.binary?(f)
+    rescue Errno::ENOENT
+      true
+    end
   end
 end
 
-def self.check(filename, width = DEFAULT_MAX_WIDTH)
-  output = `grep -n \'^.\\{#{width + 1},\\}$\' \"#{filename}\"`
+def self.check(filename, configuration = DEFAULT_CONFIGURATION)
+  max_width = configuration["max_width"]
 
-  lines = output.split("\n")
+  if max_width != UNLIMITED
+    output = `grep -n \'^.\\{#{max_width.to_i + 1},\\}$\' \"#{filename}\"`
 
-  widenings = lines.map { |line| Widening.parse(filename, line) }
+    lines = output.split("\n")
 
-  widenings.each { |m| puts m }
+    widenings = lines.map { |line| Widening.parse(filename, line) }
+
+    widenings.each { |m| puts m }
+  end
 end

data/lib/version.rb

@@ -2,5 +2,5 @@
 # Cowl
 #
 module Cowl
-  VERSION = '0.1'
+  VERSION = '0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cowl
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Andrew Pennebaker
@@ -227,10 +227,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.md
-- bin/cowl
 - lib/cowl.rb
 - lib/version.rb
+- CONFIGURE.md
+- LICENSE.md
+- README.md
+- bin/cowl
 homepage: https://github.com/mcandre/cowl
 licenses:
 - FreeBSD
@@ -251,8 +253,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: column width linter
 test_files: []
+has_rdoc: