cowl 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d415ce09daf37251429ae3953e415cde9bfdbbd3
-  data.tar.gz: 95847e09b6e320df61230f6ef38010ac3d616bac
+  metadata.gz: f4c8fcb9be685e11e164c6fafa86fe354eba6714
+  data.tar.gz: 6c8b6e63914a308fc77da6423f9b1e2a38f4e5a0
 SHA512:
-  metadata.gz: a4720ae08bf1a4d6b6a5230114edd4f667348b6edde8c58f68febdb9fe82a29c485212d725e9d1b3dd455fb1aec22480b1b166a1b66c402a3ae79b0774249bff
-  data.tar.gz: 3bfade1de48b7de81dfbc0a1c0d0f57754f67985d8b0d5f49210badc2b2aec9d601c55704cfe0c4d2fbad5c44689ca53a2eb4ad1f7c9385699643b320aac6d17
+  metadata.gz: a2663c5811b77a77bb346337ec43e48974b9073dc18a997f9261fe6c7629f71b1676989a1f73a2be3c52dcccd10db08359a7441a92bf2cedc1dbbd66e2b19635
+  data.tar.gz: b84ce5aa9cff6f05194c397c36498b087913dc98b63005694031135a0ab3189ac851ca292fba3b14a5a034cb9ee259c7fdb779c5bb31c906d911c87bf3b2faff

data/CONFIGURE.md

@@ -15,7 +15,7 @@ Run `cowl -h` or `cowl --help` for a full list, or refer to the source code for
 ```
 $ cowl -h
 Usage: cowl [options] [<files>]
-    -i, --ignore pattern             Ignore file names matching Ruby regex pattern
+    -i, --ignore pattern             Ignore file patterns (fnmatch)
     -w, --max-width=                 Maximum column width, either an integer or "unlimited". Default: 80
     -h, --help                       Print usage info
     -v, --version                    Print version info

data/README.md

@@ -1,25 +1,8 @@
 # cowl - column width linter
 
-# HOMEPAGE
+`cowl` helps you keep your source code / text in a terminal-friendly 80-column width.
 
-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
+# EXAMPLES
 
 ```
 $ cowl examples/
@@ -28,26 +11,45 @@ examples/hello.bf:3:++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++
 $ cat examples/hello.bf | cowl
 stdin:3:++++++++[>++++[>++>+++>+++>+<<<<-]>+>+>->>+[<]<-]>>.>---.+++++++..+++.>>.<-.<.+++.------.--------.>>+.>++.
 
-$ wc -L examples/hello.bf
-106 examples/hello.bf
+$ wc -c examples/hello.bf
+     158 examples/hello.bf
 
-$ cowl -w 106 examples/
+$ cowl -w 160 examples/hello.bf
 $
 
-$ cowl -i .bf examples/
+$ cowl -i '*.bf' examples/
 $
 
 $ cowl -h
 Usage: cowl [options] [<files>|-]
-    -i, --ignore pattern             Ignore file names matching Ruby regex pattern
+    -i, --ignore pattern             Ignore file patterns (fnmatch)
     -w, --max-width=                 Maximum column width, either an integer or "unlimited". Default: 80
     -h, --help                       Print usage info
     -v, --version                    Print version info
 ```
 
+# 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 scanning, like `jshint .`
+* Optional ignore patterns, like `.gitignore`
+* 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
+
 # REQUIREMENTS
 
-* [Ruby](https://www.ruby-lang.org/) 2+
+* [Ruby](https://www.ruby-lang.org/) 2.0+
 * [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`.

data/bin/cowl

@@ -3,28 +3,24 @@
 require 'rubygems'
 require 'find'
 require 'optparse'
+require 'dotsmack'
 require 'yaml'
 require 'cowl'
 
-IGNORE_FILENAME = '.cowlignore'
-CONFIGURATION_FILENAME = '.cowlrc.yml'
-
 def main
   ignores = DEFAULT_IGNORES
 
-  filenames = ['-']
-
   configuration_flags = {}
 
   option = OptionParser.new do |option|
     option.banner = "Usage: cowl [options] [<files>|-]"
 
-    option.on('-i', '--ignore pattern', 'Ignore file names matching Ruby regex pattern') do |pattern|
+    option.on('-i', '--ignore pattern', 'Ignore file patterns (fnmatch)') do |pattern|
       ignores << pattern
     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
+      configuration_flags['max_width'] = max_width
     end
 
     option.on('-h', '--help', 'Print usage info') do
@@ -40,100 +36,31 @@ def main
 
   option.parse!
 
-  filenames = ARGV unless ARGV.empty?
-
-  if filenames.empty? || filenames == ['-'] then
-    configuration_dotfile = DEFAULT_CONFIGURATION
-
-    pwd = Dir.pwd
-
-    dir = pwd
-
-    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)
+  filenames =
+    if ARGV == []
+      ['-']
+    else
+      ARGV
     end
 
-    if ignores.none? { |ignore| pwd =~ %r(#{ignore}) } then
-      dir = Dir.pwd
-
-      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 = DEFAULT_CONFIGURATION.merge(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_stdin(configuration)
-    end
-  else
-    recursive_filenames = []
+  dotsmack = Dotsmack::Smacker.new(
+    dotignore = '.cowlignore',
+    additional_ignores = ignores,
+    dotconfig = '.cowlrc.yml'
+  )
 
-    filenames.each do |f|
-      if File.directory? f
-        recursive_filenames = recursive_filenames.concat(recursive_list(f, ignores))
+  dotsmack.enumerate(filenames).each do |filename, config|
+    config =
+      if config.nil?
+        configuration_flags
       else
-        recursive_filenames << f
-      end
-    end
-
-    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)
+        YAML.load(config).merge(configuration_flags)
       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 = DEFAULT_CONFIGURATION.merge(YAML.load_file(config_file))
-            break
-          else
-            dir = File.expand_path("..", dir)
-          end
-        end
-
-        # Hack to Reset configuration when changing directories
-        configuration_dotfile = DEFAULT_CONFIGURATION unless File.exist?(dir + File::SEPARATOR + CONFIGURATION_FILENAME)
-
-        # Command line flags override dotfile settings
-        configuration = configuration_dotfile.merge(configuration_flags)
-
-        check(f, configuration)
-      end
+    if filename == '-'
+      check_stdin(config)
+    else
+      check(filename, config)
     end
   end
 end

data/lib/cowl.rb

@@ -1,33 +1,52 @@
-require 'rubygems'
 require 'ptools'
 require 'tempfile'
 
-$stdout.sync = true
-
-require 'version'
+require_relative 'version'
 
 DEFAULT_IGNORES = %w(
-  tmp/
-  \.hg/
-  \.svn/
-  \.git/
-  \.git
-  \.gitignore
-  node_modules/
-  bower_components/
-  \.vagrant/
+  tmp
+  .hg
+  .svn
+  .git
+  .gitignore
+  node_modules
+  bower_components
+  target
+  dist
+  .vagrant
   Gemfile.lock
-  \.exe
-  \.bin
-  \.app
-  \.xcodeproj/
-  \.dSYM/
-  \.png
-  \.jpg
-  \.jpeg
-  \.svg
-  \.min.js
-  -min.js
+  *.exe
+  *.bin
+  *.apk
+  *.ap_
+  res
+  *.dmg
+  *.pkg
+  *.app
+  *.xcodeproj
+  *.lproj
+  *.xcassets
+  *.pmdoc
+  *.dSYM
+  *.class
+  *.zip
+  *.jar
+  *.war
+  *.xpi
+  *.jad
+  *.cmo
+  *.cmi
+  *.png
+  *.gif
+  *.jpg
+  *.jpeg
+  *.tiff
+  *.ico
+  *.svg
+  *.dot
+  *.wav
+  *.mp3
+  *[.-]min.*
 )
 
 DEFAULT_MAX_WIDTH = 80
@@ -35,7 +54,7 @@ DEFAULT_MAX_WIDTH = 80
 UNLIMITED = 'unlimited'
 
 DEFAULT_CONFIGURATION = {
-  "max_width" => DEFAULT_MAX_WIDTH
+  'max_width' => DEFAULT_MAX_WIDTH
 }
 
 #
@@ -64,25 +83,19 @@ class Widening
   end
 end
 
-def self.recursive_list(directory, ignores = DEFAULT_IGNORES)
-  Find.find(directory).reject do |f|
-    File.directory?(f) ||
-    ignores.any? { |ignore| f =~ %r(#{ignore}) } ||
-
-    begin
-      File.binary?(f)
-    rescue Errno::ENOENT
-      true
+def self.check_stdin(configuration = nil)
+  configuration =
+    if configuration.nil?
+      DEFAULT_CONFIGURATION
+    else
+      configuration
     end
-  end
-end
 
-def self.check_stdin(configuration = DEFAULT_CONFIGURATION)
-  max_width = configuration["max_width"]
+  max_width = configuration['max_width']
 
   contents = $stdin.read
 
-  t = Tempfile.new('aspelllint')
+  t = Tempfile.new('cowl')
   t.write(contents)
   t.close
 
@@ -99,8 +112,15 @@ def self.check_stdin(configuration = DEFAULT_CONFIGURATION)
   end
 end
 
-def self.check(filename, configuration = DEFAULT_CONFIGURATION)
-  max_width = configuration["max_width"]
+def self.check(filename, configuration = nil)
+  configuration =
+    if configuration.nil?
+      DEFAULT_CONFIGURATION
+    else
+      configuration
+    end
+
+  max_width = configuration['max_width']
 
   if max_width != UNLIMITED
     output = `grep -n \'^.\\{#{max_width.to_i + 1},\\}$\' \"#{filename}\"`

data/lib/version.rb

@@ -2,5 +2,5 @@
 # Cowl
 #
 module Cowl
-  VERSION = '0.5'
+  VERSION = '0.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cowl
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Andrew Pennebaker
@@ -24,6 +24,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dotsmack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -245,7 +259,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -253,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: column width linter