awesome_scrub 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 243516de8bf34a201f878dbb5115eb0976a951b3
-  data.tar.gz: 243555a009d6856d3eba2d4af662c7c310736a52
+  metadata.gz: dbe558801a238b16bb144989824ee1933cd95ab6
+  data.tar.gz: 520e73654086d8c5ecfa42e85e123a6baba95db2
 SHA512:
-  metadata.gz: 06342dda73e5f48be202bc73525567ad1ad60786012389c66c307210a2342317382f9e21cf1548084872d173506fab0b5c40438e4211589a397e204435716f83
-  data.tar.gz: aca9cf00237a696a7edde0609fa2dbccc67eaa3dc89aeac97839eb140cb54180bec653837fdb1e2ee7c61e19a9bfa5ae982a7dd9da52daeb258ff4cc063cb627
+  metadata.gz: 71ea054936dcd9de2b03fc2c7843745b41694bcc12733a148648fbce99e63b8839ee5f1d128bdf8c21d80d854769baa106eda48e381ca688087152d206021d6d
+  data.tar.gz: de5a6b377bbf73dbffe129dcc5b287146f8d51f5903c3d8774f80124486936bccf790c6d387f7c57b9f3ee23e0059e6c61fc83a6d2bffc22b1573110010177fa

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0-preview2
+before_install: gem install bundler --pre
+notifications:
+  email:
+    - ogataken@gmail.com
+branches:
+  only:
+    - master

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in awesome_scrub.gemspec
 gemspec
+
+platform :mri_20, :mri_21 do
+  gem 'byebug'
+end

data/README.md

@@ -1,6 +1,80 @@
 # AwesomeScrub
 
-Wrap `String#scrub`.
+Easy to use `String#scrub`. Prevent Invalid byte sequence in UTF-8.
+Wrap `params[:name].respond_to?(:scrub) ? params[:name].scrub : params[:name]` to `params[:name].awesome_scrub`.
+
+[![Gem Version](https://badge.fury.io/rb/awesome_scrub.png)](http://badge.fury.io/rb/awesome_scrub)
+[![Build Status](https://api.travis-ci.org/sanemat/awesome_scrub.png?branch=master)](https://travis-ci.org/sanemat/awesome_scrub)
+[![Code Climate](https://codeclimate.com/github/sanemat/awesome_scrub.png)](https://codeclimate.com/github/sanemat/awesome_scrub)
+
+## Use case
+
+### Before:
+```ruby
+@name = params[:name].presence || 'nobody'
+```
+
+### After:
+```ruby
+@name = awesome_scrub(params[:name]).presence || 'noby'
+```
+
+## Point
+
+Almost time this is no problem, but params[:name] include `invalid byte sequence in UTF-8`, like `invalid_byte_sequence.presence` (`invalid_byte_sequence.present?`) raises `ArgumentError: invalid byte sequence in UTF-8`.
+
+This problem's solution is `String#scrub`(Feature of Ruby2.1, and `string-scrub` gem which backport for Ruby2.0), this replaces invalid characters. [Feature #6752: Replacing ill-formed subsequencce - ruby-trunk - Ruby Issue Tracking System](http://bugs.ruby-lang.org/issues/6752)
+
+This stil has problem for writing code, `params[:name]` is `String` or `nil`, and some case `Array`, `Fixnum`, and other object does not have `#scrub` method.
+
+### Work around
+
+```ruby
+name = params[:name].respond_to?(:scrub) ? params[:name].scrub : params[:name]
+@name = name.presence || 'nobody'
+```
+
+### Solution
+```ruby
+@name = awesome_scrub(params[:name]).presence || 'noby'
+```
+
+## Usage
+
+### Methods
+
+```ruby
+# call scrub
+awesome_scrub(args) #=> args.scrub
+
+# call scrub!
+awesome_scrub!(args) #=> args.scrub!
+```
+
+### Examples
+```ruby
+class Foo
+  include AwesomeScrub
+
+  def bar
+    awesome_scrub(any)
+  end
+end
+```
+OR
+```ruby
+class Foo
+  extend AwesomeScrub
+
+  def bar
+    awesome_scrub(any)
+  end
+end
+```
+OR
+```ruby
+AwesomeScrub::awesome_scrub(any)
+```
 
 ## Installation
 
@@ -16,10 +90,6 @@ Or install it yourself as:
 
     $ gem install awesome_scrub
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it ( http://github.com/sanemat/awesome_scrub/fork )

data/Rakefile

@@ -1 +1,9 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+  t.warning = true
+  t.verbose = true
+end

data/awesome_scrub.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = AwesomeScrub::VERSION
   spec.authors       = ['sanemat']
   spec.email         = ['o.gata.ken@gmail.com']
-  spec.summary       = %q{Wrap String#scrub.}
-  spec.description   = %q{Support String#scrub preventing Invalid byte sequence in UTF-8.}
+  spec.summary       = %q{Easy to use String#scrub.}
+  spec.description   = %q{Wrap String#scrub preventing Invalid byte sequence in UTF-8.}
   spec.homepage      = 'https://github.com/sanemat/awesome_scrub'
   spec.license       = 'MIT'
 
@@ -18,10 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version     = '>= 2.0.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.5.0.rc'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '> 4'
   # NOTE: Recommend, but if you implement `#scrub` yourself, no problem.
   #spec.add_dependency 'string-scrub' if RUBY_VERSION < '2.1'
 end

data/lib/awesome_scrub.rb

@@ -8,7 +8,13 @@ module AwesomeScrub
   module ClassMethods
   end
 
+  extend self
+
   def awesome_scrub(args)
     args.respond_to?(:scrub) ? args.scrub : args
   end
+
+  def awesome_scrub!(args)
+    args.respond_to?(:scrub!) ? args.scrub! : args
+  end
 end

data/lib/awesome_scrub/version.rb

@@ -1,3 +1,3 @@
 module AwesomeScrub
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/test/awesome_scrub_test.rb

@@ -0,0 +1,49 @@
+require 'minitest/autorun'
+require_relative '../lib/awesome_scrub'
+
+module AwesomeScrub
+  class AwesomeScrubTest < Minitest::Test
+
+    class TestClassWithInstanceAwesomeScrubs
+      include AwesomeScrub
+    end
+
+    class TestClassWithClassAwesomeScrubs
+      extend AwesomeScrub
+    end
+
+    def setup
+      @instance_with_modules = TestClassWithInstanceAwesomeScrubs.new
+    end
+
+    def test_normal_string
+      [@instance_with_modules, TestClassWithClassAwesomeScrubs, AwesomeScrub].each do |awesome_scrub|
+        assert_equal('foo', awesome_scrub.awesome_scrub('foo'))
+      end
+    end
+
+    def test_bang_normal_string
+      [@instance_with_modules, TestClassWithClassAwesomeScrubs, AwesomeScrub].each do |awesome_scrub|
+        assert_equal('foo', awesome_scrub.awesome_scrub!('foo'))
+      end
+    end
+
+    def test_call_scrub
+      [@instance_with_modules, TestClassWithClassAwesomeScrubs, AwesomeScrub].each do |awesome_scrub|
+        mock = MiniTest::Mock.new
+        mock.expect(:scrub, 'woot')
+        awesome_scrub.awesome_scrub(mock)
+        assert mock.verify
+      end
+    end
+
+    def test_bang_call_scrub
+      [@instance_with_modules, TestClassWithClassAwesomeScrubs, AwesomeScrub].each do |awesome_scrub|
+        mock = MiniTest::Mock.new
+        mock.expect(:scrub!, 'woot')
+        awesome_scrub.awesome_scrub!(mock)
+        assert mock.verify
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: awesome_scrub
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.5.0.rc
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.5.0.rc
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,21 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Support String#scrub preventing Invalid byte sequence in UTF-8.
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Wrap String#scrub preventing Invalid byte sequence in UTF-8.
 email:
 - o.gata.ken@gmail.com
 executables: []
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,6 +68,7 @@ files:
 - awesome_scrub.gemspec
 - lib/awesome_scrub.rb
 - lib/awesome_scrub/version.rb
+- test/awesome_scrub_test.rb
 homepage: https://github.com/sanemat/awesome_scrub
 licenses:
 - MIT
@@ -65,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -76,5 +92,6 @@ rubyforge_project:
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Wrap String#scrub.
-test_files: []
+summary: Easy to use String#scrub.
+test_files:
+- test/awesome_scrub_test.rb