rugsweep 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjNjZDlmNzgyNjA3YzJlOWU0ZTRjM2U0ZDc3ODNmODQ4MGU3ZTk2NA==
+  data.tar.gz: !binary |-
+    ZDIyOTRjMGY0OGVjMWNkM2U2MDlmYWQ4MWNmNzZkNGYxYTRhYzE4NA==
+SHA512:
+  metadata.gz: !binary |-
+    OTgyNGRiYzhkMGQ1NzY1ZTA4NDM5YzExMWIwNGQzYjAxNDBmZWMwZDk1ZWEw
+    ZGNjMGMzODdjMjc2YjgxOWUwMzRmMGY0NmMwOTRlNmE0Yjk2MjA5MjFmMzAw
+    OTg4YTE0ZTI0ZjQ0MTM3ODA1YjFkNWNiZDZjZjJkODQwODg0NTg=
+  data.tar.gz: !binary |-
+    OGI2NjZmODNlZTBjYWExZTRmNDE0ZTIyMWQ4NGU4ZmYzN2U2NDI5N2ZmMDRl
+    NzJhNGZmMjU3NmUwMGFlYjRhZDZkYzFiMTExZTg5YTFhZjY0OGFmYTIwZTI0
+    MDMxZTc5ZjAxYmUxYTQ2NTMwZjQwOGYxYmVhMzkyYzBiNDAzNmE=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rugsweep.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonathon M. Abbott
+
+MIT License
+
+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,54 @@
+# Rugsweep
+
+[![Build Status](https://travis-ci.org/JonathonMA/rugsweep.svg?branch=master)](https://travis-ci.org/JonathonMA/rugsweep)
+
+Sweeps files under the rug.
+
+## Installation
+
+Install it using rubygems:
+
+    $ gem install rugsweep
+
+## Usage
+
+Create a configuration file: *not implemented yet*
+
+    $ rugsweep init --rug=tmp GoodFile1 GoodFile2
+
+Now you can sweep things under the rug:
+
+    $ ls
+    GoodFile1
+    GoodFile2
+    BadFile
+    BadFile2
+
+    $ rugsweep
+    (M) BadFile
+    (M) BadFile2
+
+    $ ls
+    GoodFile1
+    GoodFile2
+
+    $ ls tmp
+    BadFile
+    BadFile2
+
+You can mark additional "good" files using ok *not implemented yet*
+
+    $ rugsweep ok GoodFile3
+
+## TODO
+
+1. init
+2. ok
+
+## Contributing
+
+1. Fork it ( https://github.com/JonathonMA/rugsweep/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: [
+  :spec,
+  :rubocop,
+]

data/bin/rugsweep

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rugsweep'
+
+Rugsweep.sweep

data/lib/rugsweep.rb

@@ -0,0 +1,9 @@
+require "rugsweep/version"
+
+module Rugsweep
+  def self.sweep
+    Sweeper.new.sweep
+  end
+end
+
+require "rugsweep/sweeper"

data/lib/rugsweep/sweeper.rb

@@ -0,0 +1,97 @@
+require "fileutils"
+require "yaml"
+require "paint"
+require "pathname"
+
+module Rugsweep
+  class Sweeper
+    def initialize(logger = STDOUT)
+      @logger = logger
+    end
+
+    def log(str)
+      @logger.puts str
+    end
+
+    def log_action(action, color, entry)
+      log format("(%s) %s", Paint[action, color], entry)
+    end
+
+    def log_existing(entry, _target)
+      log_action 'S', :yellow, entry
+    end
+
+    def log_move(entry, _target)
+      log_action 'M', :green, entry
+    end
+
+    def sweep
+      ensure_dumping_ground_exists
+      filtered_entries.each do |entry|
+        target = dumping_ground.join(entry.basename)
+        if target.exist?
+          log_existing(entry, target)
+        else
+          log_move(entry, target)
+          FileUtils.mv entry, dumping_ground
+        end
+      end
+    end
+
+    private
+
+    def ensure_dumping_ground_exists
+      dumping_ground.directory? || dumping_ground.mkdir
+    end
+
+    CONFIG_FILE = ".rugsweep.yml"
+
+    def base
+      Pathname.new(".")
+    end
+
+    def entries
+      base.children
+    end
+
+    def filtered_entries
+      entries.reject do |entry|
+        filter = Filter.new(entry, keep_files)
+        filter.dotfile? || filter.ok?
+      end
+    end
+
+    def config
+      @config ||= File.open(CONFIG_FILE) { |f| YAML.load(f) }
+    end
+
+    def dumping_ground
+      @dumping_ground ||= base.join config.fetch("rug")
+    end
+
+    def keep_files
+      @keep_files ||= config.fetch("keep") + [dumping_ground.basename.to_s]
+    end
+  end
+
+  class Filter
+    def initialize(path, keepfiles)
+      @path = path
+      @keepfiles = keepfiles
+    end
+
+    def dotfile?
+      filename.start_with? "."
+    end
+
+    def ok?
+      @keepfiles.include? filename
+    end
+
+    private
+
+    def filename
+      @path.basename.to_s
+    end
+  end
+end

data/lib/rugsweep/version.rb

@@ -0,0 +1,3 @@
+module Rugsweep
+  VERSION = "0.0.1"
+end

data/rugsweep.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rugsweep/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rugsweep"
+  spec.version       = Rugsweep::VERSION
+  spec.authors       = ["Jonathon M. Abbott"]
+  spec.email         = ["jonathona@everydayhero.com.au"]
+  spec.summary       = "sweep files under the rug"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/JonathonMA/rugsweep"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "paint", "~> 0.8.7"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "rubocop", "~> 0.27.0"
+end

data/spec/rugsweep_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+require 'rugsweep'
+
+require 'yaml'
+require 'tmpdir'
+require 'stringio'
+
+describe Rugsweep do
+  it 'has a version number' do
+    expect(Rugsweep::VERSION).not_to be nil
+  end
+
+  def prepare_test_dir(dir, config, files)
+    Dir.chdir(dir) do
+      files.each do |file|
+        IO.write file, ""
+      end
+      File.open(".rugsweep.yml", "w") { |f| YAML.dump(config, f) }
+    end
+  end
+
+  let!(:dir) { Dir.mktmpdir }
+
+  after(:each) do
+    FileUtils.remove_entry_secure dir
+  end
+
+  def assert_file_present(filename)
+    path = Pathname.new(filename)
+    expect(path).to exist
+  end
+
+  def assert_file_absent(filename)
+    path = Pathname.new(filename)
+    expect(path).to_not exist
+  end
+
+  let(:log) { StringIO.new }
+
+  it "should clean a directory" do
+    config = {
+      "keep" => %w(
+        Good
+        Good2
+      ),
+      "rug" => "tmp",
+    }
+    files = %w( Good Good2 Bad Bad2 .Other )
+
+    prepare_test_dir(dir, config, files)
+
+    Dir.chdir(dir) do
+      files.each do |file|
+        assert_file_present(file)
+      end
+      Rugsweep::Sweeper.new(log).sweep
+      assert_file_present("Good")
+      assert_file_present("Good2")
+      assert_file_absent("Bad")
+      assert_file_absent("Bad2")
+      assert_file_present("tmp/Bad")
+      assert_file_present("tmp/Bad2")
+      expect(log.string).to include("Bad")
+      expect(log.string).to include("Bad2")
+      expect(log.string).to_not include("Good")
+      expect(log.string).to_not include("Good2")
+    end
+  end
+
+  it "should raise when no config file" do
+    Dir.chdir(dir) do
+      expect do
+        Rugsweep::Sweeper.new(log).sweep
+      end.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rugsweep'

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: rugsweep
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathon M. Abbott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.27.0
+description: sweep files under the rug
+email:
+- jonathona@everydayhero.com.au
+executables:
+- rugsweep
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rugsweep
+- lib/rugsweep.rb
+- lib/rugsweep/sweeper.rb
+- lib/rugsweep/version.rb
+- rugsweep.gemspec
+- spec/rugsweep_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JonathonMA/rugsweep
+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.2
+signing_key: 
+specification_version: 4
+summary: sweep files under the rug
+test_files:
+- spec/rugsweep_spec.rb
+- spec/spec_helper.rb