activerecord-attr-stripper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f38c615421b4d1648505927db79ec0392220dd8e
+  data.tar.gz: 67d1e0c74f32a58bacbdc7e29622eaa522ea1f7e
+SHA512:
+  metadata.gz: 3ddd5e3bf33a396df3c91cfa93f9111f1a96ba40086b3fc28190caa4b7f90b2b1b674f4b7e8e11e834c2ecb24694c0ee9af007345f1b22af747405febc9321f0
+  data.tar.gz: 162ac7a9dfabee427cbec5fdfe5ef87dc408ae5d85e21170b183ca4bdf703cbe5d4cd270b2dde970a7ea71d356d839422a8f08cf2e60d95f170775cb7246dfa2

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+before_install:
+  - gem install bundler
+gemfile:
+  - Gemfile
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2
+  - ruby-head
+notifications:
+  email:
+    - muryoimpl@gmail.com
+script:
+  - bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-attr-stripper.gemspec
+gemspec
+
+gem 'database_cleaner'
+gem 'minitest'
+gem 'pry'
+gem 'pry-byebug', platform: [:ruby_20, :ruby_21]
+gem 'rspec', require: false
+gem 'sqlite3', platform: [:ruby, :mswin, :mingw]

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 muryoimpl
+
+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,45 @@
+activerecord-attr-stripper [![Build Status](https://travis-ci.org/muryoimpl/activerecord-attr-stripper.svg?branch=master)](https://travis-ci.org/muryoimpl/activerecord-attr-stripper)
+==========================
+
+A ActiveRecord plugin which removes leading and trailing whitespace(include zenkaku space) of attributes before validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+    gem 'activerecord-attr-stripper'
+```
+
+And then execute:
+```ruby
+    $ bundle
+```
+Or install it yourself as:
+```ruby
+    $ gem install activerecord-attr-stripper
+```
+
+## Usage
+
+```ruby
+class Post < ActiveRecord::Base
+  include ActiveRecord::Attr::Stripper
+
+  strip_attrs :title, :description, blank_to_nil: true
+end
+
+post = Post.new(title: ' 　this is title 　', description: '　')
+post.valid?
+puts post.title       #=> 'this is title'
+puts post.description #=> nil
+```
+
+`blank_to_nil` option is true, attribute's value returns nil if the attribute is '' after removing leading and tailing whitespace.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/activerecord-attr-stripper/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,2 @@
+require "bundler/gem_tasks"
+

data/activerecord-attr-stripper.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/attr/stripper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-attr-stripper"
+  spec.version       = Activerecord::Attr::Stripper::VERSION
+  spec.authors       = ["muryoimpl"]
+  spec.email         = ["muryoimpl@gmail.com"]
+  spec.summary       = %q{A ActiveRecord plugin which removes leading and trailing whitespace of attributes before validation.}
+  spec.description   = %q{A ActiveRecord plugin which removes leading and trailing whitespace of attributes before validation.}
+  spec.homepage      = "https://github.com/muryoimpl/activerecord-attr-stripper"
+  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.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activerecord"
+end

data/lib/activerecord/attr/stripper.rb

@@ -0,0 +1,2 @@
+# coding: utf-8
+require 'activerecord/attr/stripper/base'

data/lib/activerecord/attr/stripper/attr_stripper.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+module ActiveRecord
+  module Attr
+    module Stripper
+      class AttrStripper
+        class << self
+          alias :strip! :new
+        end
+
+        def before_validation(record)
+          strip_targets = record.class.class_variable_get :@@strip_targets
+
+          return if strip_targets.blank?
+
+          strip_targets.each do |target|
+            target.attrs.each do |attr|
+              attr_value = record.send(attr)
+
+              if attr_value.kind_of?(String)
+                stripped_value = strip(attr_value, target.opts)
+
+                record.send("#{attr.to_s}=", stripped_value)
+              end
+            end
+          end
+        end
+
+        private
+
+        def strip(attr_value, opts)
+          stripped_value = attr_value.gsub(/\A(\s|　)+|(\s|　)+\z/, '')
+
+          if opts[:blank_to_nil]
+            stripped_value.presence
+          else
+            stripped_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/attr/stripper/base.rb

@@ -0,0 +1,27 @@
+# coding: utf-8
+require 'activerecord/attr/stripper/version'
+require 'activerecord/attr/stripper/attr_stripper'
+require 'activerecord/attr/stripper/target'
+
+module ActiveRecord
+  module Attr
+    module Stripper
+      extend ActiveSupport::Concern
+
+      self.included do
+        cattr_accessor :strip_targets
+
+        before_validation ActiveRecord::Attr::Stripper::AttrStripper.strip!
+      end
+
+      module ClassMethods
+        def strip_attrs(*attrs)
+          return if attrs.blank?
+
+          self.strip_targets ||= []
+          self.strip_targets << Target.new(*attrs)
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/attr/stripper/target.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+module ActiveRecord
+  module Attr
+    module Stripper
+      class Target
+        attr_reader :attrs, :opts
+
+        def initialize(*attrs)
+          if attrs.last.kind_of?(Hash)
+            @attrs = attrs[0...-1]
+            @opts  = attrs.last
+          else
+            @attrs = attrs
+            @opts  = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/attr/stripper/version.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+module Activerecord
+  module Attr
+    module Stripper
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/activerecord_attr_strippter_spec.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+require 'spec_helper'
+require 'activerecord/attr/stripper'
+
+class Post < ActiveRecord::Base
+  include ActiveRecord::Attr::Stripper
+end
+
+describe ActiveRecord::Attr::Stripper do
+  TEST_VALUE = ' 　test 　'
+
+  let(:post) { Post.new(title: TEST_VALUE, description: TEST_VALUE) }
+
+  context 'when Post has .strip_attrs(:title)' do
+    before do
+      Post.class_eval do
+        strip_attrs :title
+      end
+    end
+
+    context 'without options' do
+      context 'when attr includes blank' do
+        before do
+          post.valid?
+        end
+
+        it { expect(post.title).to eq 'test' }
+        it { expect(post.description).to eq TEST_VALUE }
+      end
+
+      context 'when attr includes only blank' do
+        before do
+          post.title = '  '
+          post.valid?
+        end
+
+        it { expect(post.title).to eq '' }
+        it { expect(post.description).to eq TEST_VALUE }
+      end
+    end
+
+    context 'with options' do
+      describe ':blank_to_nil' do
+        before do
+          Post.class_eval do
+            strip_attrs :title, blank_to_nil: true
+          end
+        end
+
+        context 'when attr includes only blank' do
+          before do
+            post.title = ' 　　 '
+            post.valid?
+          end
+
+          it { expect(post.title).to be_nil }
+          it { expect(post.description).to eq TEST_VALUE }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# coding: utf-8
+require 'active_record'
+require 'database_cleaner'
+require 'pry'
+
+ActiveRecord::Base.configurations = { 'test' => { :adapter => 'sqlite3', :database => ':memory:' } }
+ActiveRecord::Base.establish_connection(:test)
+
+class CreateTables < ActiveRecord::Migration
+  def self.up
+    create_table(:posts) {|t| t.string :title; t.text :description; }
+  end
+end
+
+DatabaseCleaner[:active_record].strategy = :transaction
+
+RSpec.configure do |c|
+  c.before :all do
+    CreateTables.up unless ActiveRecord::Base.connection.table_exists?(:posts)
+  end
+
+  c.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  c.after :each do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-attr-stripper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- muryoimpl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  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: A ActiveRecord plugin which removes leading and trailing whitespace of
+  attributes before validation.
+email:
+- muryoimpl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord-attr-stripper.gemspec
+- lib/activerecord/attr/stripper.rb
+- lib/activerecord/attr/stripper/attr_stripper.rb
+- lib/activerecord/attr/stripper/base.rb
+- lib/activerecord/attr/stripper/target.rb
+- lib/activerecord/attr/stripper/version.rb
+- spec/activerecord_attr_strippter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/muryoimpl/activerecord-attr-stripper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ActiveRecord plugin which removes leading and trailing whitespace of attributes
+  before validation.
+test_files:
+- spec/activerecord_attr_strippter_spec.rb
+- spec/spec_helper.rb