attr_cleaner 0.1.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13fd121c241acea325b5ab89c95aefdaabc91a22
+  data.tar.gz: f4dd8fca1416c874e971899ab4559a62717a1beb
+SHA512:
+  metadata.gz: 02dbd6aab1d253c9a137e03a6edeed70b0f76242b8c5af4cb737173b4da15cdb7bba2c343fcb1f9fb6c09ecade4651ad0e19de7a52f4d47b11b78d3a4faa7d75
+  data.tar.gz: b0206eee8379393eb280f870ea2748933483ccfe87c2bb81804d464e89b825dea011abea2ec12566cbd2f7e7a70294c1f99a575bd71f37a87128d3394be98202

data/.gitignore

@@ -1,5 +1,5 @@
 pkg/*
-.yardoc/*
 *.gem
 .bundle
-.redcar/*
+Gemfile.lock
+gemfiles/*.lock

data/.ruby-gemset

@@ -0,0 +1 @@
+attr_cleaner

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.3

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+
+sudo: false
+cache: bundler
+
+env:
+  global:
+    - TRAVIS_CI=1
+
+rvm:
+  - 1.9.3
+  - 2.3.3
+
+gemfile:
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+
+matrix:
+  exclude:
+  - rvm: 1.9.3
+    gemfile: gemfiles/rails_5.0.gemfile
+
+before_install: gem update bundler
+bundler_args: --without tools
+
+script: bundle exec rspec -b

data/Appraisals

@@ -0,0 +1,5 @@
+["4.2", "5.0"].each do |rails|
+  appraise "rails-#{rails}" do
+    gem "activerecord", "~> #{rails}", require: "active_record"
+  end
+end

data/Gemfile

@@ -1,4 +1,11 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in attr_cleaner.gemspec
 gemspec
+
+gem "rspec"
+gem "jamjar"
+
+group :tools do
+  gem "appraisal"
+  gem "byebug"
+end

data/README.md

@@ -0,0 +1,58 @@
+# AttrCleaner
+
+Cleans up your model attributes. Strips leading and trailing space, and turns
+empty strings into `nil`.
+
+Tested against Rails 4.2 and 5.0.
+
+![Travis CI](https://travis-ci.org/thomasfedb/attr_cleaner.svg?branch=master)
+
+## Install
+
+If you're using Rails with ActiveRecord all you need to do is:
+
+```ruby
+gem "attr_cleaner"
+```
+
+AttrCleaner will also work with any ORM that writes attributes via a method
+called `write_attribute`.
+
+To get AttrCleaner working with your ORM just include it into your models:
+
+```ruby
+include AttrCleaner::Model
+```
+
+AttrCleaner can also be used outside of Rails if ActiveSupport 3 is avalable.
+If you're using AttrCleaner outside of Rails, and it detects ActiveRecord is
+allready loaded, it will include itself into ActiveRecod. Make sure ActiveRecord
+is loaded first.
+
+## Usage
+
+Simply add this to any model you want to clean:
+
+```ruby
+attr_cleaner
+```
+
+You can restrict the cleaning to specific attributes with `:only` and `:except`:
+
+```ruby
+attr_cleaner only: :name
+attr_cleaner only: [:name, :age]
+attr_cleaner except: :age
+attr_cleaner except: [:age, :price]
+```
+
+Settings are be inherited, so sometimes you may need both `:only` and `:except`:
+
+```ruby
+# Remove :age from the list, add :name
+attr_cleaner only: :name, except: :age
+```
+
+## Copyright
+
+Copyright © 2010 Thomas Drake-Brockman

data/Rakefile

@@ -1,2 +1,3 @@
 require 'bundler'
+
 Bundler::GemHelper.install_tasks

data/attr_cleaner.gemspec

@@ -7,15 +7,15 @@ Gem::Specification.new do |s|
   s.version     = AttrCleaner::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Thomas Drake-Brockman"]
-  s.email       = ["thomas@pixent.com.au"]
-  s.homepage    = "https://rubygems.org/gems/attr_cleaner"
+  s.email       = ["thom@sfedb.com"]
+  s.homepage    = "https://github.com/thomasfedb/attr_cleaner"
   s.summary     = "Cleans up model attributes."
-  s.description = "Strips spaces from attributes, and sets empty strings to nil. Can be used with Rails 3, in any ActiveRecord project, or with other ORMs that define write_attribute."
+  s.description = "Strips spaces from attributes, and sets empty strings to nil."
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
-  s.add_dependency('activesupport', '~> 3.0.0')
+
+  s.add_dependency('activesupport', '>= 4.2')
 end

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rspec"
+gem "jamjar"
+gem "activerecord", "~> 4.2", :require => "active_record"
+
+group :tools do
+  gem "appraisal"
+  gem "byebug"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,14 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rspec"
+gem "jamjar"
+gem "activerecord", "~> 5.0", :require => "active_record"
+
+group :tools do
+  gem "appraisal"
+  gem "byebug"
+end
+
+gemspec :path => "../"

data/lib/attr_cleaner/model.rb

@@ -0,0 +1,25 @@
+module AttrCleaner
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method_chain :write_attribute, :cleaner
+      class_attribute :attr_cleaners
+    end
+
+    def write_attribute_with_cleaner(attr_name, value)
+      if Array(attr_cleaners).include?(attr_name.to_sym) && value.is_a?(String)
+        value = value.strip
+        value = nil if value.empty?
+      end
+
+      write_attribute_without_cleaner(attr_name, value)
+    end
+
+    module ClassMethods
+      def attr_cleaner(*columns)
+        self.attr_cleaners = columns
+      end
+    end
+  end
+end

data/lib/attr_cleaner/railtie.rb

@@ -5,7 +5,7 @@ module AttrCleaner
   class Railtie < Rails::Railtie
     initializer 'attr_cleaner.include_into_activerecord' do |app|
       ActiveSupport.on_load(:active_record) do
-        ActiveRecord::Base.send(:include, AttrCleaner::ModuleMixin)
+        ActiveRecord::Base.send(:include, AttrCleaner::Model)
       end
     end
   end

data/lib/attr_cleaner/version.rb

@@ -1,3 +1,3 @@
 module AttrCleaner
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/attr_cleaner.rb

@@ -3,7 +3,7 @@ require "active_support/core_ext/module/aliasing"
 require "active_support/core_ext/class/attribute"
 require "active_support/concern"
 
-require "attr_cleaner/module_mixin"
+require "attr_cleaner/model"
 
 # If not using active_record then include AttrCleaner::ModuleMixin.
 
@@ -12,5 +12,5 @@ if defined?(Rails::Railtie)
   require "attr_cleaner/railtie"
 else
   # If used outside of rails, just check for ActiveRecord::Base
-  ActiveRecord::Base.send(:include, AttrCleaner::ModuleMixin) if defined?(ActiveRecord::Base)
-end
+  ActiveRecord::Base.send(:include, AttrCleaner::Model) if defined?(ActiveRecord::Base)
+end

data/spec/attr_cleaner/model_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe AttrCleaner::Model do
+  let(:model) do
+    JamJar.model do
+      column :title, :string
+      column :body, :text
+    end
+  end
+
+  let(:instance) { model.new }
+
+  describe ".attr_cleaner" do
+    context "called with attributes" do
+      before { model.attr_cleaner :title, :body }
+
+      specify { expect(model.attr_cleaners).to eq [:title, :body] }
+    end
+  end
+
+  describe "#write_attribute_with_cleaner" do
+    context "with no cleaners" do
+      context "a padding string is assigned" do
+        before { instance.title = " Padded Title " }
+
+        specify { expect(instance.title).to eq " Padded Title " }
+      end
+
+      context "an empy string is assigned" do
+        before { instance.title = "  " }
+
+        specify { expect(instance.title).to eq "  " }
+      end
+    end
+
+    context "with cleaners" do
+      before { model.attr_cleaner :title }
+
+      context "a padding string is assigned" do
+        before { instance.title = " Padded Title " }
+
+        specify { expect(instance.title).to eq "Padded Title" }
+      end
+
+      context "an empy string is assigned" do
+        before { instance.title = "  " }
+
+        specify { expect(instance.title).to be_nil }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require "bundler"
+
+if ENV["TRAVIS_CI"]
+  Bundler.require
+else
+  Bundler.require(:default, :tools)
+end
+
+ActiveRecord::Base.send(:include, AttrCleaner::Model)
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -1,90 +1,77 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: attr_cleaner
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Thomas Drake-Brockman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-01 00:00:00 +08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 0
-        version: 3.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
   type: :runtime
-  version_requirements: *id001
-description: Strips spaces from attributes, and sets empty strings to nil. Can be used with Rails 3, in any ActiveRecord project, or with other ORMs that define write_attribute.
-email: 
-- thomas@pixent.com.au
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Strips spaces from attributes, and sets empty strings to nil.
+email:
+- thom@sfedb.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- .rvmrc
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
 - Gemfile
-- Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - attr_cleaner.gemspec
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
 - lib/attr_cleaner.rb
-- lib/attr_cleaner/module_mixin.rb
+- lib/attr_cleaner/model.rb
 - lib/attr_cleaner/railtie.rb
 - lib/attr_cleaner/version.rb
-has_rdoc: true
-homepage: https://rubygems.org/gems/attr_cleaner
+- spec/attr_cleaner/model_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/thomasfedb/attr_cleaner
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Cleans up model attributes.
-test_files: []
-
+test_files:
+- spec/attr_cleaner/model_spec.rb
+- spec/spec_helper.rb

data/.rvmrc

@@ -1,7 +0,0 @@
-
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-  && -s "${rvm_path:-$HOME/.rvm}/environments/ruby-1.9.2-p0@attr_cleaner" ]] ; then
-  \. "${rvm_path:-$HOME/.rvm}/environments/ruby-1.9.2-p0@attr_cleaner"
-else
-  rvm --create  "ruby-1.9.2-p0@attr_cleaner"
-fi

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    attr_cleaner (0.0.3)
-      activerecord (~> 3.0.0)
-      activesupport (~> 3.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.3)
-    arel (2.0.6)
-    builder (2.1.2)
-    i18n (0.5.0)
-    tzinfo (0.3.23)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.0.0)
-  activesupport (~> 3.0.0)
-  attr_cleaner!

data/README.rdoc

@@ -1,46 +0,0 @@
-= AttrCleaner
-
-Cleans up your model attributes. Strips leading and trailing space, and turns empty
-strings into nil.
-
-== Installing
-
-For Rails 3 with ActiveRecord just add this to your Gemfile:
-
-  gem "attr_cleaner"
-  
-Attr cleaner will play nice with any ORM that writes attributes
-via a method called `write_attribute`.
-To get AttrCleaner working with your ORM add this to an initializer file:
-  
-  MyOrm.send(:include, AttrCleaner::ModelMixin)
-  
-or, include it into your models:
-  
-  include AttrCleaner::ModelMixin
-  
-AttrCleaner can also be used outside of Rails if ActiveSupport 3 is avalable. If you're using
-AttrCleaner outside of Rails, and it detect ActiveRecord is allready loaded, it will include
-itself into ActiveRecod. Make sure ActiveRecord is loaded first.
-
-== Usage
-
-Simply add this to any model you want to clean:
-
-  attr_cleaner
-
-You can restrict the cleaning to specific attributes with `:only` and `:except`
-
-  attr_cleaner :only => :name
-  attr_cleaner :only => [:name, :age]
-  attr_cleaner :except => :age
-  attr_cleaner :except => [:age, :price]
-  
-Attributes to be cleaned can be inherited, so sometimes you may need both :only and :except
-
-  # Remove :age from the list, add :name
-  attr_cleaner :only => :name, :except => :age
-  
-== Copyright
-
-Copyright (c) 2010 Thomas Drake-Brockman. See LICENSE for details.

data/lib/attr_cleaner/module_mixin.rb

@@ -1,36 +0,0 @@
-module AttrCleaner
-  module ModuleMixin
-    extend ActiveSupport::Concern
-  
-    included do
-      alias_method_chain :write_attribute, :cleaner
-      class_attribute :attr_cleaners
-    end
-    
-    def write_attribute_with_cleaner(attr_name, value)
-      if Array(attr_cleaners).include?(attr_name.to_sym) && value.is_a?(String)
-        value = value.strip
-        value = nil if value.empty?
-      end
-      write_attribute_without_cleaner(attr_name, value)
-    end
-    
-    module ClassMethods
-      # Adds attributes to the list of attributes to be cleaned
-      # Attributes are inherited, but can be removed from :except
-      #
-      # @param [Hash] args options hash, set :only and/or :except
-      # @return [Array] a array of symbols representing the attributes to be cleaned
-      def attr_cleaner(args = {})
-        all_columns = column_names.map(&:to_sym)
-        
-        only = Array(args[:only])          
-        except = Array(args[:except])
-        
-        columns = only.empty? ? all_columns : (only & all_columns)
-        
-        self.attr_cleaners = (Array(self.attr_cleaners) + columns) - except
-      end        
-    end
-  end
-end