dotsmack 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3dffb1c482c853c56be3b48b344e5dcd3f45347c
+  data.tar.gz: 8e641d9d1d463b9a92d00aac08e97020011b3e58
+SHA512:
+  metadata.gz: 6437eb61b4b3e1828b8a940f89d82e2a34a2a0dc501d6d5c65ea604d66ca5ce0d483f33229605176a84ec351fac2364877f35e3bddd9885f0ed5b9c71faa8db0
+  data.tar.gz: 7f734c28a591e72dd53e091e0c85f322e70a730af83d8e95c1fbfc166ef7866249c03b4c8f3b7de0dd6d12b2e282f37ce75587ff431bd2ae12ad95baf3e49bda

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/README.md

@@ -0,0 +1,104 @@
+# dotsmack - a library for modern, per-directory dotfile configuration
+
+# HOMEPAGE
+
+https://github.com/mcandre/dotsmack
+
+# RUBYGEMS
+
+https://rubygems.org/gems/dotsmack
+
+# ABOUT
+
+Dotsmack is a Ruby library for adding modern dotfile customization to your Ruby applications.
+
+* Recursive file scanning, like `jshint .`
+* dotignore files - [fnmatch](http://man.cx/fnmatch) syntax, like `.gitignore`
+* dotconfig files - any format (getoptlong, YAML, JSON, ...)
+* Searches for dotfiles in `.`, `..`, etc., up to `$HOME`.
+
+# EXAMPLES
+
+```
+$ tree -a examples/twitch/
+examples/twitch/
+├── bin
+│   └── twitch
+└── test
+    ├── .twitchignore
+    ├── a-tale-of-two-cities.txt
+    ├── embiggened
+    │   └── beginning-programming-with-java-for-dummies.txt
+    ├── fahrenheit-451.txt
+    ├── shortened
+    │   └── beginning-programming-with-java-for-dummies.txt
+    └── supertwitter
+        ├── .twitchrc.yml
+        ├── README.md
+        └── beginning-programming-with-java-for-dummies.txt
+
+5 directories, 9 files
+
+$ head examples/twitch/bin/twitch 
+#!/usr/bin/env ruby
+
+#
+# Tweet validator
+#
+
+require 'rubygems'
+require 'dotsmack'
+require 'yaml'
+
+$ examples/twitch/bin/twitch examples/twitch/test/
+examples/twitch/test/a-tale-of-two-cities.txt: 614
+
+$ examples/twitch/bin/twitch < examples/twitch/test/a-tale-of-two-cities.txt 
+-: 614
+```
+
+More examples:
+
+* [aspelllint](https://github.com/mcandre/aspelllint)
+* [enlint](https://github.com/mcandre/enlint)
+* [cowl](https://github.com/mcandre/cowl)
+* [gtdlint](https://github.com/mcandre/gtdlint)
+* [lili](https://github.com/mcandre/lili)
+
+# REQUIREMENTS
+
+* [Ruby](https://www.ruby-lang.org/) 2+
+
+# INSTALL
+
+Install via [RubyGems](http://rubygems.org/):
+
+```
+$ gem install aspelllint
+```
+
+# LICENSE
+
+FreeBSD
+
+# DEVELOPMENT
+
+## Testing
+
+Keep the interface working:
+
+```
+$ cucumber
+```
+
+## Linting
+
+Keep the code tidy:
+
+```
+$ rake lint
+```
+
+## Git Hooks
+
+See `hooks/`.

data/lib/dotsmack.rb

@@ -0,0 +1,241 @@
+require 'rubygems'
+require 'find'
+
+#
+# Dotsmack - File, dotignore, and dotconfig scanner.
+#
+# Scans for files recursively.
+#
+# Searches for dotfiles in:
+#
+# * The same directory as path
+# * An ancestor directory, up to $HOME
+# * If path is not $HOME-relative, search only $HOME
+#
+# dotignore assumes fnmatch format.
+# dotconfig may be in any format.
+#
+module Dotsmack
+  HOME = File.expand_path(ENV['HOME'])
+  PARENT_OF_HOME = File.expand_path('..', HOME)
+
+  FNMATCH_FLAGS =
+    File::FNM_DOTMATCH | # Allow matching on Unix hidden dotfiles
+    File::FNM_EXTGLOB    # Allow matching with {..., ...} group patterns
+
+  #
+  # More intuitive behavior for fnmatch
+  #
+  def self.fnmatch?(pattern, path)
+    File.fnmatch(pattern, path, FNMATCH_FLAGS) ||
+      File.fnmatch("**/#{pattern}", path, FNMATCH_FLAGS) ||
+      ((pattern.end_with?('/') || pattern.end_with?('\\')) &&
+        File.fnmatch("**/#{pattern}*", path, FNMATCH_FLAGS))
+  end
+
+  #
+  # Smacker dotfile scanner/enumerator.
+  #
+  class Smacker
+    attr_accessor :dotignore, :dotconfig, :additional_ignores, :path2ignore, :path2config
+
+    #
+    # Create a Smacker dotfile scanner/enumerator.
+    #
+    # @dotignore Filename for ignore patterns (optional)
+    # @dotconfig Filename for configuration (optional)
+    #
+    def initialize(dotignore = nil, additional_ignores = [], dotconfig = nil)
+      @dotignore = dotignore
+      @dotconfig = dotconfig
+      @additional_ignores = additional_ignores
+
+      @path2dotignore = {}
+      @path2dotconfig = {}
+
+      if !dotignore.nil?
+        home_dotignore = "#{HOME}#{File::SEPARATOR}#{dotignore}"
+
+        @path2dotignore[PARENT_OF_HOME] = []
+
+        @path2dotignore[HOME] =
+          if File.exist?(home_dotignore)
+            open(home_dotignore).read.split("\n")
+          else
+            []
+          end
+      end
+
+      if !dotconfig.nil?
+        home_dotconfig = "#{HOME}#{File::SEPARATOR}#{dotconfig}"
+
+        @path2dotconfig[PARENT_OF_HOME] = nil
+
+        @path2dotconfig[HOME] =
+          if File.exist?(home_dotconfig)
+            open(home_dotconfig).read
+          else
+            nil
+          end
+      end
+    end
+
+    #
+    # Scan for dotignore.
+    #
+    # Assumes dir is an absolute path.
+    # Assumes dir is not a symlink.
+    # Assumes dir is $HOME-relative.
+    #
+    def scan_for_dotignore!(dir)
+      if @path2dotignore.has_key?(dir)
+        @path2dotignore[dir]
+      else
+        candidate = "#{dir}#{File::SEPARATOR}#{@dotignore}"
+
+        dotignore =
+          if File.exist?(candidate)
+            open(candidate).read.split("\n")
+          else
+            []
+          end
+
+        parent = File.expand_path('..', dir)
+
+        # Determine parent dotignore
+        parents_dotignore = scan_for_dotignore!(parent)
+
+        # Merge candidate and parent information
+        dotignore.concat(parents_dotignore)
+
+        @path2dotignore[dir] = dotignore
+
+        dotignore
+      end
+    end
+
+    #
+    # Scan for dotconfig.
+    #
+    # Assumes dir is an absolute path.
+    # Assumes dir is not a symlink.
+    # Assumes dir is $HOME-relative.
+    #
+    def scan_for_dotconfig!(dir)
+      if @path2dotconfig.has_key?(dir)
+        @path2dotconfig[dir]
+      else
+        candidate = "#{dir}#{File::SEPARATOR}#{@dotconfig}"
+
+        parent = File.expand_path('..', dir)
+
+        # Use first dotconfig found.
+        dotconfig =
+          if File.exist?(candidate)
+            open(candidate).read
+          else
+            scan_for_dotconfig!(parent)
+          end
+
+        @path2dotconfig[dir] = dotconfig
+
+        dotconfig
+      end
+    end
+
+    #
+    # Determines whether path is dotignored.
+    #
+    def ignore?(path)
+      path = File.absolute_path(path)
+
+      dir =
+        if File.directory?(path)
+          path
+        else
+          File.expand_path('..', path)
+        end
+
+      relative_to_home = dir.start_with?(HOME)
+
+      if !relative_to_home
+        dir = HOME
+      end
+
+      scan_for_dotignore!(dir)
+
+      (@path2dotignore[dir] + @additional_ignores).any? do |pattern|
+        Dotsmack::fnmatch?(pattern, path)
+      end
+    end
+
+    #
+    # Returns dotconfig for path.
+    #
+    def config(path)
+      path = File.absolute_path(path)
+
+      dir =
+        if File.directory?(path)
+          path
+        else
+          File.expand_path('..', path)
+        end
+
+      relative_to_home = dir.start_with?(HOME)
+
+      if !relative_to_home
+        dir = HOME
+      end
+
+      scan_for_dotconfig!(dir)
+
+      @path2dotconfig[dir]
+    end
+
+    #
+    # Recursively enumerate files named or nested in paths array.
+    #
+    # Skips dotignored files.
+    #
+    # Returns [file, dotconfig] pairs.
+    #
+    def enumerate(paths)
+      files = []
+
+      paths.each do |path|
+        # STDIN idiom
+        if path == '-'
+          files << [
+            path,
+            if @dotconfig.nil?
+              nil
+            else
+              config(Dir.pwd)
+            end
+          ]
+        # Skip symlinks
+        elsif File.symlink?(path)
+          nil
+        elsif File.directory?(path) && (@dotignore.nil? || !ignore?(path))
+          files.concat(
+            enumerate(
+              Find.find(path).reject do |p| File.directory?(p) end
+            )
+          )
+        elsif !ignore?(path)
+          files << [
+              path,
+              if @dotconfig.nil?
+                nil
+              else
+                config(path)
+              end
+          ]
+        end
+      end
+
+      files
+    end
+  end
+end

data/lib/version.rb

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

metadata

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: dotsmack
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Andrew Pennebaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ptools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: roodi
+  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: churn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: excellent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: tailor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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: '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: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: See README.md for example usage
+email: andrew.pennebaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/dotsmack.rb
+- lib/version.rb
+homepage: https://github.com/mcandre/dotsmack
+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: a library for modern, per-directory dotfile configuration
+test_files: []