git_cleanser 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 548e9a6536c08e66ebab5e762d74537b111f9405
-  data.tar.gz: 7acb5377a907af8b7939ebb174d33588361f534b
+  metadata.gz: 2ae5b34a095ef77959d687f118ae624562f8c1b1
+  data.tar.gz: c9bad03944efe7f819f1874608bab11cf521a20a
 SHA512:
-  metadata.gz: 869ddbc9957efdff769deb5bd3cb26a32ac1577b81c5e5d7a3a1868dcd12d8101febd729467a6e391b4fcf7f29e08d076e502861456f037bebb305c6950b2210
-  data.tar.gz: d7c600693312d658c3053d4fc28c52873f7054d1db1c8264fdb11574c7ecccfce51fabe29ee31800146b169a1531c88f4245e77c658ee397394f61865587edac
+  metadata.gz: 1762aab44dccae1af7f15ea993fe9ff84c0e7765db6f25acf8c2fd68b494b99b272b95cc3dc7daf961c36d6eba2a496d4a49cebfb7139f753b1d83efe4e929bd
+  data.tar.gz: e46f767cf51469c1732b55bafd0a2edf15a93810c39a6b3fe84137de8fc6ab50492d2efca2ba856cd861c96e7b90cfd32414eda31ed9f769a0ce8443ce518d6f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/README.md

@@ -1,6 +1,20 @@
 # GitCleanser
 
-TODO: Write a gem description
+It's not ideal, but we've all worked with repositories containing compiled
+files and their source code.  When there are 5 files and they follow a naming
+convention, it's easily fixable.  When there are 1,000 files and they are all
+named differently, fixing it seems insurmountable.  This tool helps iteratively
+remove these files from your repository in the later case.
+
+## Todo
+
+- [x] Add an option for human readable or YAML output
+- [ ] Set up CI
+- [ ] Put some examples in the README
+- [x] Check that things added to .gitignore are also `git rm`ed
+- [ ] Add a filter for files so that you can specify *.css or *.js or what have you
+- [ ] Handle checked in library files
+- [ ] The exit code returns an error if any files are yet to be dealth with (for CI)
 
 ## Installation
 

data/Rakefile

@@ -1,2 +1,14 @@
 require "bundler/gem_tasks"
+require "cucumber/rake/task"
 
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: ['spec', 'cucumber']

data/bin/git_cleanser

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'git_cleanser'
+GitCleanser::CLI.new(ARGV.dup).execute!

data/features/detecting_compiled_files.feature

@@ -0,0 +1,29 @@
+Feature: Detecting compiled files
+  When a file is compiled but not git ignored, let the user know.
+
+  Scenario:
+    Given a file named "git_cleanser.yml" with:
+      """
+      ---
+      compiled_files_command: echo ignored_and_generated.o committed.o
+      """
+    And a file named ".gitignore" with:
+      """
+      ignored_and_generated.o
+      ignored_not_generated.o
+      """
+    And an empty file named "ignored_and_generated.o"
+    And an empty file named "ignored_not_generated.o"
+    And an empty, tracked file named "committed.o"
+    When I run `git_cleanser --format=yaml`
+    Then the exit status should be 0
+
+    And its output for "generated_but_not_ignored" should contain "committed.o"
+    And its output for "generated_but_not_ignored" should not contain "ignored_and_generated.o"
+    And its output for "generated_but_not_ignored" should not contain "ignored_not_generated.o"
+
+    And its output for "ignored_but_not_generated" should contain "ignored_not_generated.o"
+    And its output for "ignored_but_not_generated" should not contain "ignored_and_generated.o"
+    And its output for "ignored_but_not_generated" should not contain "committed.o"
+
+    And its output for "ignored_but_tracked" should be empty

data/features/detecting_ignored_but_tracked_files.feature

@@ -0,0 +1,29 @@
+Feature: Detecting ignored but tracked files
+  When a file is is in the git ignore but also tracked, let the user know.
+
+  Scenario:
+    Given a file named "git_cleanser.yml" with:
+      """
+      ---
+      compiled_files_command: echo ignored.o ignored.tracked.o tracked.o
+      """
+    And a file named ".gitignore" with:
+      """
+      ignored.o
+      ignored.tracked.o
+      """
+    And an empty file named "ignored.o"
+    And an empty, tracked file named "tracked.o"
+    And an empty, tracked file named "ignored.tracked.o"
+    When I run `git_cleanser --format=yaml`
+    Then the exit status should be 0
+
+    And its output for "ignored_but_tracked" should contain "ignored.tracked.o"
+    And its output for "ignored_but_tracked" should not contain "tracked.o"
+    And its output for "ignored_but_tracked" should not contain "ignored.o"
+
+    And its output for "generated_but_not_ignored" should contain "ignored.tracked.o"
+    And its output for "generated_but_not_ignored" should contain "tracked.o"
+    And its output for "generated_but_not_ignored" should not contain "ignored.o"
+
+    And its output for "ignored_but_not_generated" should be empty

data/features/detecting_uncompiled_files.feature

@@ -0,0 +1,25 @@
+Feature: Detecting uncompiled files
+  When a file is not compiled, but is tracked, let the user know.
+  So that they can make it automatically compiled.
+
+  Scenario:
+    Given a file named "git_cleanser.yml" with:
+      """
+      ---
+      compiled_files_command: echo generated.js
+      """
+    And an empty file named ".gitignore"
+    And an empty, tracked file named "generated.js"
+    And an empty, tracked file named "spontaneous-generation.js"
+    When I run `git_cleanser --format=yaml`
+    Then the exit status should be 0
+
+    And its output for "generated_but_not_ignored" should contain "generated.js"
+    And its output for "generated_but_not_ignored" should not contain "spontaneous-generation.js"
+
+    And its output for "ignored_but_not_generated" should be empty
+
+    And its output for "ignored_but_tracked" should be empty
+
+    And its output for "uncompiled" should contain "spontaneous-generation.js"
+    And its output for "uncompiled" should not contain "generated.js"

data/features/output_formats.feature

@@ -0,0 +1,31 @@
+Feature: Output formats
+  Both computers and humans can parse this output
+
+  Scenario: Default is human readable
+    Given a file named "git_cleanser.yml" with:
+      """
+      ---
+      compiled_files_command: echo style.css
+      """
+    And an empty file named "style.css"
+    When I run `git_cleanser`
+    Then the output should contain:
+      """
+      These files are ignored, but not compiled (maybe they should be added to the compiled files list?):
+        (no files)
+      """
+    And the output should contain:
+      """
+      These files are compiled but not ignored (maybe they should be added to .gitignore?):
+        style.css
+      """
+
+  Scenario: YAML is available with an option
+    Given a file named "git_cleanser.yml" with:
+      """
+      ---
+      compiled_files_command: echo style.css
+      """
+    And an empty file named "style.css"
+    When I run `git_cleanser --format=yaml`
+    Then its output is YAML

data/features/step_definitions/detecting_compiled_files_steps.rb

@@ -0,0 +1,22 @@
+require 'aruba/api'
+require 'aruba/cucumber/hooks'
+require 'aruba/reporting'
+
+require 'yaml'
+
+World(Aruba::Api)
+
+Then(/^its output for "(.*?)" should not contain "(.*?)"$/) do |key, value|
+  output = YAML.load(unescape(all_output))
+  expect(output[key]).not_to include(value)
+end
+
+Then(/^its output for "(.*?)" should contain "(.*?)"$/) do |key, value|
+  output = YAML.load(unescape(all_output))
+  expect(output[key]).to include(value)
+end
+
+Then(/^its output for "(.*?)" should be empty$/) do |key|
+  output = YAML.load(unescape(all_output))
+  expect(output[key]).to be_empty
+end

data/features/step_definitions/git_files_step_definitions.rb

@@ -0,0 +1,8 @@
+World(Aruba::Api)
+
+Given(/^an empty, tracked file named "(.*?)"$/) do |file_name|
+  write_file(file_name, "")
+  in_current_dir do
+    `git add -f "#{file_name}"`
+  end
+end

data/features/step_definitions/output_formats_step_defintions.rb

@@ -0,0 +1,8 @@
+Then(/^its output is YAML$/) do
+  output = YAML.load(unescape(all_output))
+  expect(output).to be_instance_of(Hash)
+
+  GitCleanser::Formatter::YAML::KEYS.each do |key|
+    expect(output).to have_key(key)
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,20 @@
+require 'aruba'
+require 'aruba/cucumber'
+require 'aruba/in_process'
+
+require 'git_cleanser'
+
+Aruba::InProcess.main_class = GitCleanser::CLI
+Aruba.process = Aruba::InProcess
+
+# Around does not work in this case, so store the temp directory
+# in a global variable to clean it up later.
+Before do
+  $tmp_dir = Dir.mktmpdir("git_cleanser_test")
+  system "git init -q", chdir: $tmp_dir
+  @dirs = [$tmp_dir]
+end
+
+After '~@no-clobber' do
+  FileUtils.rm_r($tmp_dir, secure: true)
+end

data/git_cleanser.gemspec

@@ -16,6 +16,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "paint", "~> 1.0.0"
+  spec.add_dependency "slop", "~> 4.0.0"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber", "~> 1.3.19"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "aruba", "~> 0.6.2"
 end

data/lib/git_cleanser.rb

@@ -1,5 +1,6 @@
-require "git_cleanser/version"
+Dir[File.join(__dir__, "**", "*.rb")].each do |file|
+  require file
+end
 
 module GitCleanser
-  # Your code goes here...
 end

data/lib/git_cleanser/cli.rb

@@ -0,0 +1,27 @@
+require 'slop'
+
+module GitCleanser
+  class CLI
+    def initialize(argv, stdin=STDIN, stdout=STDOUT, stderr=STDERR, kernel=Kernel, config_loader=ConfigLoader.new)
+      @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+      @config = config_loader.config
+    end
+
+    def execute!
+      smart_thing = SmartThing.new(@config)
+
+      opts = Slop.parse @argv do |o|
+        o.string '-f', '--format', 'output format'
+      end
+
+      formatter = case opts[:format]
+                    when 'yaml'
+                      Formatter::YAML
+                    else
+                      Formatter::Human
+                    end
+
+      @stdout.puts formatter.new.format(smart_thing)
+    end
+  end
+end

data/lib/git_cleanser/config_loader.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+module GitCleanser
+  class ConfigLoader
+    def config
+      @config ||= YAML.load(File.read("git_cleanser.yml"))
+    end
+  end
+end

data/lib/git_cleanser/formatter.rb

@@ -0,0 +1,4 @@
+module GitCleanser
+  module Formatter
+  end
+end

data/lib/git_cleanser/formatter/human.rb

@@ -0,0 +1,34 @@
+require 'paint'
+
+module GitCleanser
+  module Formatter
+    class Human
+      KEYS = {
+        "generated_but_not_ignored" => "These files are compiled but not ignored (maybe they should be added to .gitignore?):",
+        "ignored_but_not_generated" => "These files are ignored, but not compiled (maybe they should be added to the compiled files list?):",
+        "ignored_but_tracked" => "These files are ignored, but also tracked (maybe they should be removed from the repo or not ignored?):",
+        "uncompiled" => "These files look like compilation results, but aren't yet automatically compiled (maybe they should be added to your compiler?):"
+      }
+
+      def format(smart_thing)
+        KEYS.map do |(key, message)|
+          format_message(message) + "\n" + format_list(smart_thing.public_send(key))
+        end.join("\n\n")
+      end
+
+      private
+
+      def format_message message
+        Paint[message, :magenta]
+      end
+
+      def format_list list
+        if list.any?
+          list.map { |file| Paint["  #{file}", :red] }.join("\n")
+        else
+          Paint["  (no files)", :green]
+        end
+      end
+    end
+  end
+end

data/lib/git_cleanser/formatter/yaml.rb

@@ -0,0 +1,12 @@
+module GitCleanser
+  module Formatter
+    class YAML
+      KEYS = ["generated_but_not_ignored", "ignored_but_not_generated", "ignored_but_tracked", "uncompiled"]
+
+      def format(smart_thing)
+        output = KEYS.inject({}) { |memo, this| memo[this] = smart_thing.public_send(this); memo }
+        ::YAML.dump(output).strip
+      end
+    end
+  end
+end

data/lib/git_cleanser/smart_thing.rb

@@ -0,0 +1,42 @@
+module GitCleanser
+  class SmartThing
+    def initialize(config)
+      @config = config
+      @compiled_files = sh(@config['compiled_files_command']).split
+      @ignored_and_untracked_files = git_ls_files(:ignored, :other)
+      @ignored_but_tracked_files = git_ls_files(:ignored)
+      @all_files = Dir['**/*']
+    end
+
+    def generated_but_not_ignored
+      @compiled_files - @ignored_and_untracked_files
+    end
+
+    def ignored_but_not_generated
+      @ignored_and_untracked_files - @compiled_files
+    end
+
+    def ignored_but_tracked
+      @ignored_but_tracked_files
+    end
+
+    def uncompiled
+      @all_files - @compiled_files
+    end
+
+    private
+
+    def git_ls_files *ruby_opts
+      shell_opts = ruby_opts.map { |opt| "--#{opt}" }.join(" ")
+      sh("git ls-files -z --exclude-standard #{shell_opts}").split("\0")
+    end
+
+    def sh(cmd)
+      `#{cmd}`.tap do
+        if $?.exitstatus > 0
+          raise "Shell command failed: " + cmd
+        end
+      end
+    end
+  end
+end

data/lib/git_cleanser/version.rb

@@ -1,3 +1,3 @@
 module GitCleanser
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/cli_spec.rb

@@ -0,0 +1,58 @@
+require 'yaml'
+
+module GitCleanser
+  RSpec.describe CLI do
+    let(:stdin) { StringIO.new }
+    let(:stdout) { StringIO.new }
+    let(:stderr) { StringIO.new }
+    let(:config) { double("config") }
+    let(:config_loader) { instance_double("ConfigLoader", config: config) }
+    let(:smart_thing) { instance_double("SmartThing").as_null_object }
+    let(:formatter) { double("Formatter") }
+    let(:argv) { [] }
+    subject { CLI.new(argv, stdin, stdout, stderr, Kernel, config_loader) }
+
+    describe "output formats" do
+      before do
+        allow(SmartThing).to receive(:new).and_return(smart_thing)
+      end
+
+      context "when fomat is YAML" do
+        let(:argv) { ["--format=yaml"] }
+        it "prints YAML output" do
+          allow(Formatter::YAML).to receive(:new).and_return(formatter)
+          allow(formatter).to receive(:format).and_return("--- yaml")
+
+          subject.execute!
+          stdout.rewind
+          output = stdout.read
+
+          expect(output).to eq("--- yaml\n")
+          expect(formatter).to have_received(:format).with(smart_thing)
+        end
+      end
+
+      context "when no format is passed" do
+        it "prints human readable output" do
+          allow(Formatter::Human).to receive(:new).and_return(formatter)
+          allow(formatter).to receive(:format).and_return("Anglais")
+
+          subject.execute!
+          stdout.rewind
+          output = stdout.read
+
+          expect(output).to eq("Anglais\n")
+          expect(formatter).to have_received(:format).with(smart_thing)
+        end
+      end
+    end
+
+    it "passes the config to the SmartThing" do
+      allow(SmartThing).to receive(:new).and_return(smart_thing)
+
+      subject.execute!
+
+      expect(SmartThing).to have_received(:new).with(config)
+    end
+  end
+end

data/spec/lib/formatter/human_spec.rb

@@ -0,0 +1,9 @@
+module GitCleanser
+  module Formatter
+    describe Human do
+      it "produces equivalent output to the YAML formatter" do
+        expect(Human::KEYS.keys).to eq YAML::KEYS
+      end
+    end
+  end
+end

data/spec/lib/formatter/yaml_spec.rb

@@ -0,0 +1,30 @@
+module GitCleanser
+  module Formatter
+    describe YAML do
+      describe "#format" do
+        let(:smart_thing) { instance_double("SmartThing") }
+        subject { YAML.new.format(smart_thing) }
+
+        before do
+          allow(smart_thing).to receive(:generated_but_not_ignored).and_return(["file1", "file2"])
+          allow(smart_thing).to receive(:ignored_but_not_generated).and_return(["file3", "file4"])
+          allow(smart_thing).to receive(:ignored_but_tracked).and_return(["file5", "file6"])
+          allow(smart_thing).to receive(:uncompiled).and_return(["file7", "file8"])
+        end
+
+        it "returns output as YAML" do
+          output = ::YAML.load(subject)
+
+          expect(output["generated_but_not_ignored"]).to eq ["file1", "file2"]
+          expect(output["ignored_but_not_generated"]).to eq ["file3", "file4"]
+          expect(output["ignored_but_tracked"]).to eq ["file5", "file6"]
+          expect(output["uncompiled"]).to eq ["file7", "file8"]
+        end
+
+        it "removes trailing newlines because we add one in CLI" do
+          expect(subject).not_to end_with("\n")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'git_cleanser'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: git_cleanser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dan Finnie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-14 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,21 +66,84 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.19
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
 description: 
 email:
 - dan@danfinnie.com
-executables: []
+executables:
+- git_cleanser
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/git_cleanser
+- features/detecting_compiled_files.feature
+- features/detecting_ignored_but_tracked_files.feature
+- features/detecting_uncompiled_files.feature
+- features/output_formats.feature
+- features/step_definitions/detecting_compiled_files_steps.rb
+- features/step_definitions/git_files_step_definitions.rb
+- features/step_definitions/output_formats_step_defintions.rb
+- features/support/env.rb
 - git_cleanser.gemspec
 - lib/git_cleanser.rb
+- lib/git_cleanser/cli.rb
+- lib/git_cleanser/config_loader.rb
+- lib/git_cleanser/formatter.rb
+- lib/git_cleanser/formatter/human.rb
+- lib/git_cleanser/formatter/yaml.rb
+- lib/git_cleanser/smart_thing.rb
 - lib/git_cleanser/version.rb
+- spec/lib/cli_spec.rb
+- spec/lib/formatter/human_spec.rb
+- spec/lib/formatter/yaml_spec.rb
+- spec/spec_helper.rb
 homepage: 
 licenses:
 - MIT
@@ -77,5 +168,17 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Iteratively remove compiled files from your git repository
-test_files: []
+test_files:
+- features/detecting_compiled_files.feature
+- features/detecting_ignored_but_tracked_files.feature
+- features/detecting_uncompiled_files.feature
+- features/output_formats.feature
+- features/step_definitions/detecting_compiled_files_steps.rb
+- features/step_definitions/git_files_step_definitions.rb
+- features/step_definitions/output_formats_step_defintions.rb
+- features/support/env.rb
+- spec/lib/cli_spec.rb
+- spec/lib/formatter/human_spec.rb
+- spec/lib/formatter/yaml_spec.rb
+- spec/spec_helper.rb
 has_rdoc: