sanistring 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTU3YmYwOWQ4ZWI3Y2M2YWViNGUyODZlOWJkNzY4YzUzY2NkZDFhYQ==
+  data.tar.gz: !binary |-
+    NDk1MzZmYzQ1YWJmMDQ1NDkwMjkwYzhjNjY1YzQxYmFhYTlmOWZiYQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjI3OThmOTE5NTg5YWU4MWM2ZDNiYmE0MDY0NzJjOGI2MDU0Y2I1OGNmMzVl
+    NThiNDJmNjg2ZjNjYzRkMWUzZTc2MzUzYzk2OTJkNjBjYTM5ODE5N2ZhYWU3
+    ZmJlMjZlNmI1OTFhZDA4NGQ5MjYwOGRlZDRkNGQ4NzJiNzFjZTQ=
+  data.tar.gz: !binary |-
+    MWUyN2YzNTYwMDUxNmNmNTZmODFlMDRjZDlkZjdmMzE2NTQ2ZDlmZmZkMmQz
+    MTgwNDk3MzM3ZTU5ZDEyZTg4MjI2MmI3MzI4ZmIwYmIxZjI0Yjk0YTNjYzY1
+    ZTg1ZWU3NTZlNWU1NmI0ZGU4NjE5YTdjNmViODU3NzRiMWE5OWM=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Hallett
+
+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,31 @@
+# Sanistring
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sanistring'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sanistring
+
+## Usage
+
+```ruby
+  Sanistring.sanitize('../path/to/some/file', whitelist: 'abcdefghijklmnop')
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sanistring.rb

@@ -0,0 +1,7 @@
+require 'sanistring/version'
+require 'sanistring/list'
+require 'sanistring/sanitize'
+
+module Sanistring
+  # Your code goes here...
+end

data/lib/sanistring/list.rb

@@ -0,0 +1,6 @@
+module Sanistring
+  class List
+    AlphaNumeric = 1
+
+  end
+end

data/lib/sanistring/sanitize.rb

@@ -0,0 +1,25 @@
+module Sanistring
+
+  def self.sanitize(name, opts = {})
+    sanitized = name.split('').map{ |char|
+      if opts[:replace] && opts[:replace][char]
+        opts[:replace][char]
+      elsif opts[:whitelist].is_a?(Fixnum)
+        case opts[:whitelist]
+        when List::AlphaNumeric
+          char if !!(/[a-zA-Z0-9]/ =~ char)
+        else
+          nil
+        end 
+      elsif opts[:whitelist].is_a?(String) && opts[:whitelist].include?(char)
+        char
+      else
+        nil
+      end
+    }.compact.join
+
+    sanitized.downcase! if opts[:downcase]
+    sanitized.upcase! if opts[:upcase]
+    sanitized
+  end
+end

data/lib/sanistring/version.rb

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

data/sanistring.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sanistring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sanistring'
+  spec.version       = Sanistring::VERSION
+  spec.authors       = ['Adam Hallett']
+  spec.email         = ['adam.t.hallett@gmail.com']
+  spec.description   = %q{Sanitize strings by whitelist and character replacement.}
+  spec.summary       = %q{Sanitize strings by whitelist and character replacement.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.3'
+  spec.add_development_dependency 'debugger'
+  spec.add_development_dependency 'rspec'
+end

data/spec/sanitizer_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Sanistring do
+
+  describe '#sanitize' do
+    it 'removes prohibited characters' do
+      Sanistring.sanitize('../abc', whitelist: Sanistring::List::AlphaNumeric).should == 'abc'
+    end
+
+    it 'replaces characters' do 
+      Sanistring.sanitize(' adam ', whitelist: Sanistring::List::AlphaNumeric, replace: {' '=> ''}).should == 'adam'
+    end
+
+    it 'returns empty string when string is entirely prohibited characters' do
+      Sanistring.sanitize('..', whitelist: Sanistring::List::AlphaNumeric).should == ''
+    end
+
+    it 'upcases string' do
+      Sanistring.sanitize('abc', upcase: true,  whitelist: Sanistring::List::AlphaNumeric).should == 'ABC'
+    end
+
+    it 'downcases string' do
+      Sanistring.sanitize('ABC', downcase: true,  whitelist: Sanistring::List::AlphaNumeric,).should == 'abc'
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sanistring'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: sanistring
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Hallett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sanitize strings by whitelist and character replacement.
+email:
+- adam.t.hallett@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sanistring.rb
+- lib/sanistring/list.rb
+- lib/sanistring/sanitize.rb
+- lib/sanistring/version.rb
+- sanistring.gemspec
+- spec/sanitizer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.10
+signing_key: 
+specification_version: 4
+summary: Sanitize strings by whitelist and character replacement.
+test_files:
+- spec/sanitizer_spec.rb
+- spec/spec_helper.rb