fixnames 0.3.0

data/lib/fixnames/version.rb

@@ -0,0 +1,10 @@
+class Fixnames
+  module Version
+    MAJOR = 0
+    MINOR = 3
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/fixnames/banners_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames::Filters do
+  describe "#banners" do
+    context "when TRUE" do
+      before do
+        @testopt.banners = true
+      end
+
+      describe "should remove banner blocks" do
+        subject { 'foobar' }
+        it_should_fix 'foo[xvid]bar',   'foo[divx]bar'
+        it_should_fix 'foo[ xvid ]bar', 'foo[_divx_]bar'
+      end
+
+      describe "should recognize advers with various bracket styles" do
+        subject { 'foobar' }
+        it_should_fix 'foo[xvid]bar', 'foo(xvid)bar'
+        it_should_fix 'foo{xvid}bar', 'foo<xvid>bar'
+      end
+    end
+
+    context "when FALSE" do
+      before do
+        @testopt.banners = false
+        @testopt.charstrip_allow_brackets = true
+      end
+
+      describe "should ALLOW banner blocks" do
+        it_should_not_change 'abc[XVID]xyz', 'foo[divx]bar'
+        it_should_not_change 'foo[xvid]bar', 'foo(xvid)bar'
+        it_should_not_change 'foo{xvid}bar', 'foo<xvid>bar'
+      end
+    end
+  end
+end

data/spec/fixnames/brackets_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:brackets] is TRUE" do
+    before do
+      @testopt.brackets = true
+    end
+
+    describe "should remove bracket expressions" do
+      subject { 'foobar' }
+      it_should_fix 'foo[x]bar', 'fo(foo)ob<bar>ar'
+      it_should_fix 'foo[ x ]bar', 'fo(-foo-)ob<_bar_>ar'
+    end
+  end
+
+  context "when option[:brackets] is FALSE" do
+    before do
+      @testopt.brackets = false
+      @testopt.charstrip_allow_brackets = true
+    end
+
+    describe "should replace ALLOW bracket expressions" do
+      it_should_not_change 'foo[x]bar', 'fo(foo)ob<bar>ar'
+    end
+  end
+end

data/spec/fixnames/camelcase_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:camelcase] is TRUE" do
+    before do
+      @testopt.camelcase = true
+    end
+
+    describe "should replace camelCase with underscore_case" do
+      subject { 'foo_bar' }
+      it_should_fix 'fooBar'
+    end
+  end
+
+  context "when option[:camelcase] is FALSE" do
+    before do
+      @testopt.camelcase = false
+    end
+
+    describe "should allow aA style case patterns" do
+      it_should_not_change 'xYzZy', 'fooBarBaz'
+    end
+  end
+end

data/spec/fixnames/charstrip_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:charstrip] is non-nil" do
+    describe "should allow common filename characters" do
+      it_should_not_change 'abc', 'a_b', 'a-b', 'a.b'
+    end
+
+    describe "should strip most punctuation" do
+      subject { 'ab' }
+      it_should_fix 'a[b', 'a]b'
+      it_should_fix 'a{b', 'a}b'
+      it_should_fix 'a(b', 'a)b'
+      it_should_fix 'a\'b', 'a"b'
+      it_should_fix 'a,b', 'a+b'
+      it_should_fix 'a!b', 'a~b'
+      it_should_fix 'a#b', 'a@b'
+    end
+  end
+end

data/spec/fixnames/checksums_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:checksums] is TRUE" do
+    before do
+      @testopt.checksums = true
+    end
+
+    describe "should remove [1A2B3C4D] style checksum markers" do
+      subject { 'foobar' }
+      it_should_fix 'foo[1A2B3C4D]bar', 'foo[1a2b3c4d]bar'
+      it_should_fix 'foo(1A2B3C4D)bar', 'foo(1a2b3c4d)bar'
+      it_should_fix 'foo{1A2B3C4D}bar', 'foo{1a2b3c4d}bar'
+    end
+  end
+
+  context "when option[:checksums] is FALSE" do
+    before do
+      @testopt.checksums = false
+      @testopt.charstrip_allow_brackets = true
+    end
+
+    describe "should allow checksum markers" do
+      it_should_not_change 'foo[1A2B3C4D]bar', 'foo[1a2b3c4d]bar'
+      it_should_not_change 'foo(1A2B3C4D)bar', 'foo(1a2b3c4d)bar'
+      it_should_not_change 'foo{1A2B3C4D}bar', 'foo{1a2b3c4d}bar'
+    end
+  end
+end

data/spec/fixnames/fixdots_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:fix_dots] is TRUE" do
+    before do
+      @testopt.fix_dots = true
+    end
+
+    describe "should replace early dots with underbars" do
+      subject { 'file_name.txt' }
+      it_should_fix 'file.name.txt'
+    end
+
+    describe "should replace ALL early dots, recursively" do
+      subject { 'it_should_replace_it_even_with_all_these.dots' }
+      it_should_fix 'it.should.replace.it.even.with.all.these.dots'
+    end
+
+    describe "should compress neighboring dots to a single character" do
+      subject { 'file.txt' }
+      it_should_fix 'file..txt', 'file...txt', 'file....txt'
+    end
+  end
+
+  context "when option[:fix_dots] is FALSE" do
+    before do
+      @testopt.fix_dots = false
+    end
+
+    describe "should allow multiple dots" do
+      it_should_not_change 'file.name.txt'
+      it_should_not_change 'file..txt', 'file...txt', 'file....txt'
+    end
+  end
+end

data/spec/fixnames/hack_and_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:hack_and] is TRUE" do
+    before do
+      @testopt.hack_and = true
+    end
+
+    describe "should replace \"&\" with \"_and_\"" do
+      subject { 'a_and_b' }
+      it_should_fix 'a&b', 'a & b', 'a_&_b', 'a &_b', 'a_& b'
+    end
+  end
+
+  context "when option[:hack_and] is FALSE" do
+    before do
+      @testopt.hack_and = false
+    end
+
+    describe "should replace ALLOW \"&\"" do
+      it_should_not_change 'a&b'
+    end
+  end
+end

data/spec/fixnames/lowercase_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:lowercase] is TRUE" do
+    before do
+      @testopt.lowercase = true
+    end
+
+    describe "should allow lowercase" do
+      it_should_not_change 'ab_c', 'ab-c', 'ab.c'
+    end
+
+    describe "should fix uppercase" do
+      subject { 'abc' }
+      it_should_fix 'ABC', 'Abc', 'aBc', 'abC'
+    end
+  end
+
+  context "when option[:lowercase] is FALSE" do
+    before do
+      @testopt.lowercase = false
+    end
+
+    describe "should ALLOW uppercase" do
+      it_should_not_change 'ABC', 'Abc', 'aBc', 'abC'
+    end
+  end
+end

data/spec/fixnames/semicolon_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:semicolon] is TRUE" do
+    before do
+      @testopt.semicolon = true
+    end
+
+    describe "should replace semicolons and surrounding whitespace with a single dash" do
+      subject { 'a-b' }
+      it_should_fix 'a;b', 'a; b', 'a ;b', 'a ; b', 'a-; b', 'a ;-b'
+    end
+  end
+
+  context "when option[:semicolon] is FALSE" do
+    before do
+      @testopt.semicolon = false
+    end
+
+    describe "should ALLOW semicolons" do
+      it_should_not_change 'a;b'
+    end
+  end
+end

data/spec/fixnames/whitespace_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Fixnames do
+  context "when option[:whitespace] is non-nil" do
+    describe "should preserve simple names" do
+      it_should_not_change 'abc', 'a-b', 'a.b'
+    end
+
+    describe "should convert all spaces to underscores" do
+      subject { 'ab_c' }
+      it_should_fix 'ab c'
+    end
+
+    describe "should convert all tabs to underscores" do
+      subject { 'ab_c' }
+      it_should_fix "ab\tc"
+    end
+
+    describe "should pass single underscores unchanged" do
+      it_should_not_change 'a_b'
+    end
+
+    describe "should collapse multiple spaces" do
+      subject { 'a_b' }
+      it_should_fix 'a  b', 'a   b', 'a    b'
+    end
+
+    describe "should collapse multiple underscores to a single character" do
+      subject { 'a_b' }
+      it_should_fix 'a__b', 'a___b', 'a____b'
+    end
+
+    describe "should collapse multiple mixed whitespaces characters to a single underscore" do
+      subject { 'a_b' }
+      it_should_fix 'a_ b', 'a _b', 'a _ b', 'a_ _b'
+    end
+
+    describe "should erase trailing whitespace" do
+      subject { 'ab' }
+      it_should_fix 'ab ',  'ab_',  'ab_ ', 'ab _', 'ab__', 'ab  '
+    end
+
+    describe "should erase leading whitespace" do
+      subject { 'ab' }
+      it_should_fix ' ab', '_ab', '_ ab', ' _ab', '__ab', '  ab'
+    end
+
+    describe "should pass a single dot unchanged" do
+      it_should_not_change 'abc.d', 'ab_c.d', 'a-bc.d'
+    end
+
+    describe "should remove whitespace preceding a dot" do
+      subject { 'a.b' }
+      it_should_fix  'a .b',   'a_.b',   'a-.b'
+      it_should_fix 'a  .b',  'a _.b',  'a_ .b'
+      it_should_fix 'a__.b', 'a _ .b', 'a- _.b'
+    end
+
+    describe "should remove whitespace around a single dash" do
+      subject { 'a-b' }
+      it_should_fix 'a- b',  'a-_b', 'a -b',  'a_-b'
+      it_should_fix 'a_-_b', 'a - b', 'a_- b', 'a -_b'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'fixnames'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before do
+    @testopt = Fixnames::Option.new
+  end
+end
+

data/spec/support/should_fix_helpers.rb

@@ -0,0 +1,19 @@
+def fixed_for(x)
+  Fixnames::FixFile.fix_name x, @testopt
+end
+
+def it_should_not_change(*args)
+  args.each do |x|
+    specify "unchanged: #{x.inspect}" do
+      fixed_for(x).should eq(x)
+    end
+  end
+end
+
+def it_should_fix(*args)
+  args.each do |x|
+    specify "produces #{subject.call.inspect} when fixing: #{x.inspect}" do
+      fixed_for(x).should eq(subject)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fixnames'
+
+class Test::Unit::TestCase
+  def fixopt_global
+    { }
+    # { :verbose => 3 }
+  end
+
+  def obj(str)
+    FixFileNames.new str, FixFileNames::DEFAULT_OPTIONS.merge(fixopt_global).merge(testopt)
+  end
+
+  def fix(str)
+    obj(str).fixed
+  end
+
+  def assert_nofix(str)
+    assert_equal str, fix(str), "Expected NO FIXES to affect the filename."
+  end
+
+  def fixed_is(val=nil)
+    @fixed_is ||= val if val
+    @fixed_is
+  end
+
+  def assert_fix(orig, fixed=fixed_is)
+    assert_equal fixed, fix(orig)
+  end
+end

data/test/test_charstrip.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class TestCharstrip < Test::Unit::TestCase
+  def testopt
+    { }
+  end
+
+  def test_nospace
+    assert_nofix 'abc'
+    assert_nofix 'a_b'
+    assert_nofix 'a-b'
+    assert_nofix 'a.b'
+  end
+
+  def test_charstrip
+    fixed_is 'ab'
+
+    assert_fix 'a[b'
+    assert_fix 'a]b'
+    assert_fix 'a{b'
+    assert_fix 'a}b'
+    assert_fix 'a(b'
+    assert_fix 'a)b'
+    assert_fix 'a\'b'
+    assert_fix 'a"b'
+    assert_fix 'a,b'
+    assert_fix 'a+b'
+    assert_fix 'a!b'
+    assert_fix 'a~b'
+    assert_fix 'a/b'
+    assert_fix "a\\b"
+    assert_fix 'a#b'
+    assert_fix 'a@b'
+  end
+end