web_safe_filename 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6223884d12a8d765badcbf08f9504eb46814080e
+  data.tar.gz: c605793ec12995b98d22d167a8a5280a79c4000a
+SHA512:
+  metadata.gz: 46be502684ebc91a7bb5b1c598a007261af248c042c59bea1527887e0051f744ba691ff736c4ddadc1254caf1be2a2575697e7fd4a36a8becae4f86a8936e43f
+  data.tar.gz: 2abb6c65dcca37d0b6ab0c258b8b17f3257b33e60dee8ad50b8947b0596ffe348afd8e8a04e3db721306cc32da6a11a7bb23adfb311c5a88ec614da56a9b21e3

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dave Shaffer
+
+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,37 @@
+# Web-Safe Filename
+
+This is a command line Ruby script for batch converting filenames. This script recursively parses the current directory and child directories and converts all web-safe characters into dashes.
+
+by [Dave Shaffer](mailto:dave.shaffer@gmail.com)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'web_safe_filename'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install web_safe_filename
+
+## Usage
+
+Run `web_safe_filename` from the terminal in the desired directory. It is unlikely you will want use this in a Rails application, but be sure to run it in the right directory if you do, since this script will touch everything.
+
+## Tests
+
+To run the tests, clone the repository and run `rake` or `rake test` in the repo directory. This will create a bunch of test files in `spec/test_files` and then delete them upon completion. Any feedback on how to improve the test coverage would be awesome since there's really only one test.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/web_safe_filename/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 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end
+
+desc 'Run tests'
+task :default => :test

data/bin/web_safe_filename

@@ -0,0 +1,7 @@
+#! /usr/bin/env ruby
+
+require 'web_safe_filename'
+
+include WebSafeFilename
+
+WebSafeFilename::Scrubber.start

data/lib/web_safe_filename/version.rb

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

data/lib/web_safe_filename.rb

@@ -0,0 +1,25 @@
+require 'web_safe_filename/version'
+require 'uri'
+
+module WebSafeFilename
+  class Scrubber
+
+    def self.start
+      new.traverse_directories
+    end
+
+    def scrub(file)
+      File.rename(file, file.gsub(/[\x00\\:\*\?\"<>\|,#\$\@\%\!\^\~ ]/, '-'))
+    end
+
+    def traverse_directories(directory = Dir.pwd)
+      Dir.chdir(directory) do
+        Dir.glob('*').each do |entry|
+          traverse_directories(entry) if File.directory?(entry)
+          scrub(entry)
+        end
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'fileutils'
+require 'web_safe_filename'
+
+# Test helpers
+
+def generate_random_filename(length, start_char = 32)
+  Array.new(length) { rand(start_char..126) }
+    .reject {|i| [42,47,92].include?(i) }
+    .map { |c| c.chr }.join
+end
+
+def generate_name_list
+  list = []
+  rand(1..30).times { list << generate_random_filename(30) }
+  list
+end
+
+def generate_test_files
+  Dir.mkdir('spec/test_files') unless Dir.exist?('spec/test_files')
+  Dir.chdir('spec/test_files') do
+    dirs = generate_name_list
+    FileUtils.mkdir(dirs)
+    dirs.each do |dir|
+      Dir.chdir(dir) { FileUtils.touch(generate_name_list) }
+    end
+  end
+end

data/spec/web_safe_filename_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe WebSafeFilename do
+  before do
+    generate_test_files
+  end
+
+  after do
+    FileUtils.rm_rf('spec/test_files')
+  end
+
+  it 'should rename files and folders' do
+    Dir.chdir('spec/test_files') do
+      before_dir_list = Dir.glob('*')
+      WebSafeFilename::Scrubber.start
+      before_dir_list.wont_equal Dir.glob('*')
+    end
+  end
+
+end

data/web_safe_filename.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'web_safe_filename/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "web_safe_filename"
+  spec.version       = WebSafeFilename::VERSION
+  spec.authors       = ["Dave Shaffer"]
+  spec.email         = ["dave.shaffer@gmail.com"]
+  spec.summary       = %q{CLI script for batch renaming files.}
+  spec.description   = %q{This script will recursively rename all files in all directories under where it is run. This is pretty dangerous crap so I don't recommend doing it.}
+  spec.homepage      = "http://daveshaffer.co"
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: web_safe_filename
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dave Shaffer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: This script will recursively rename all files in all directories under
+  where it is run. This is pretty dangerous crap so I don't recommend doing it.
+email:
+- dave.shaffer@gmail.com
+executables:
+- web_safe_filename
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/web_safe_filename
+- lib/web_safe_filename.rb
+- lib/web_safe_filename/version.rb
+- spec/spec_helper.rb
+- spec/web_safe_filename_spec.rb
+- web_safe_filename.gemspec
+homepage: http://daveshaffer.co
+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.6
+signing_key: 
+specification_version: 4
+summary: CLI script for batch renaming files.
+test_files:
+- spec/spec_helper.rb
+- spec/web_safe_filename_spec.rb