attr_cleaner 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Thomas Drake-Brockman
+
+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.rdoc

@@ -0,0 +1,31 @@
+= AttrCleaner
+
+Cleans up your model attributes. Strips leading and trailing space, and turns empty strings into nil. Only supports Rails 3.
+
+== Installing
+
+Add this to your Gemfile:
+
+  gem "attr_cleaner"
+
+== 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

@@ -15,7 +15,12 @@ module AttrCleaner
       write_attribute_without_cleaner(attr_name, value)
     end
     
-    module ClassMethods      
+    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)
         

data/lib/attr_cleaner/version.rb

@@ -1,3 +1,3 @@
 module AttrCleaner
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Thomas Drake-Brockman
@@ -30,6 +30,8 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- LICENSE
+- README.rdoc
 - Rakefile
 - attr_cleaner.gemspec
 - lib/attr_cleaner.rb