attribute_normalizer 0.2.0 → 0.2.1

data/README.textile

@@ -4,6 +4,10 @@ p. A little normalization goes a long way in helping maintain data integrity.
 
 h2. Recent Changes
 
+* 0.2.1
+** ActiveModel Support Built-in
+** Fix for :with option getting dropped when normalizing several attributes
+
 * 0.2.0
 ** Removed the normalization on reads.
 ** Added out of the box support for CassandraObjects
@@ -11,11 +15,9 @@ h2. Recent Changes
 ** Added the ability to define global normalizers
 ** *Strings are no longer get 'strip' called on them before getting passed on to your defined normalization blocks*
 
-* 0.1.2
-** Changed post-normalization attribute assignment to call super to avoid preventing plugins/gems/hooks to work on the same attribute.
-
 h2. Supported ORMs
 
+* _Active Model_
 * Active Record
 * CassandraObjects
 
@@ -31,12 +33,18 @@ h2. Install
 
 p. Then just required it.  Rails usages is as follows.
 
+h3. Rails 2
+
 <pre><code># config/environment.rb
-  gem.config 'attribute_normalizer'</code></pre>
+ config.gem 'attribute_normalizer'</code></pre>
+
+h3. Rails 3
+<pre><code># Gemfile
+gem 'attribute_normalizer'</code></pre>
 
 p. It also still works as a traditional Rails plugin.
 
-  ./script/plugin install git://github.com/mdeering/attribute_normalizer.git
+<pre><code>./script/plugin install git://github.com/mdeering/attribute_normalizer.git</code></pre>
 
 h2. Usage
 
@@ -109,14 +117,24 @@ h2. Test Helpers
 
 p. If you are running RSpec there is matcher available for use.  Usage can been seen above.  Include it as follows.
 
+h3. Rails 2
+
 <pre><code># spec/spec_helper.rb
 # ...
-
 Spec::Runner.configure do |config|
   # ...
   config.include AttributeNormalizer::RSpecMatcher, :type => :models
 end</code></pre>
 
+h3. Rails 3
+
+<pre><code># spec/spec_helper.rb
+# ...
+Spec::Runner.configure do |config|
+  # ...
+  config.include AttributeNormalizer::RSpecMatcher # Models group type is missing at this time rspec-rails 2.0.0.beta.11
+end</code></pre>
+
 p. _I will gladly take a patch to add a macro to Test::Unit if someone submits it._
 
 h2. Credits

data/lib/attribute_normalizer/model_inclusions.rb

@@ -0,0 +1,36 @@
+module AttributeNormalizer
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def normalize_attributes(*attributes, &block)
+      options = attributes.extract_options!
+      with    = options.delete(:with)
+
+      attributes.each do |attribute|
+        define_method "normalize_#{attribute}" do |value|
+          normalized = if block_given? && !value.blank?
+            yield(value)
+          elsif !with.nil? && !value.blank?
+            unless AttributeNormalizer.configuration.normalizers.has_key?(with)
+              raise AttributeNormalizer::MissingNormalizer.new("No normalizer was found for #{with}")
+            end
+            AttributeNormalizer.configuration.normalizers[with].call(value, options)
+          else
+            value.is_a?(String) ? value.strip : value
+          end
+          normalized.nil? || (normalized.is_a?(String) && normalized == '') ? nil : normalized
+        end
+        self.send :private, "normalize_#{attribute}"
+
+        define_method "#{attribute}=" do |value|
+          super(self.send(:"normalize_#{attribute}", value))
+        end
+
+      end
+    end
+    alias :normalize_attribute :normalize_attributes
+  end
+end

data/lib/attribute_normalizer/rspec_matcher.rb

@@ -0,0 +1,45 @@
+module AttributeNormalizer
+
+  module RSpecMatcher
+
+    def normalize_attribute(attribute)
+      NormalizeAttribute.new(attribute)
+    end
+
+    class NormalizeAttribute
+
+      def initialize(attribute)
+        @attribute = attribute
+        @from = ''
+      end
+
+      def description
+        "normalize #{@attribute} from #{@from.nil? ? 'nil' : "\"#{@from}\""} to #{@to.nil? ? 'nil' : "\"#{@to}\""}"
+      end
+
+      def failure_message
+        "#{@attribute} did not normalize as expected! \"#{@subject.send(@attribute)}\" != #{@to.nil? ? 'nil' : "\"#{@to}\""}"
+      end
+
+      def from(value)
+        @from = value
+        self
+      end
+
+      def to(value)
+        @to = value
+        self
+      end
+
+      def matches?(subject)
+        @subject = subject
+        @subject.send("#{@attribute}=", @from)
+
+        @subject.send(@attribute) == @to
+      end
+
+    end
+
+  end
+
+end

data/lib/attribute_normalizer.rb

@@ -11,102 +11,27 @@ module AttributeNormalizer
     yield(configuration)
   end
 
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
   class Configuration
-
     attr_accessor :normalizers
-
     def initialize
       @normalizers = {}
     end
-
   end
 
-  module ClassMethods
-
-    def normalize_attributes(*attributes, &block)
-      options = attributes.extract_options!
-
-      attributes.each do |attribute|
-
-        klass = class << self; self end
-
-        klass.send :define_method, "normalize_#{attribute}" do |value|
-          normalized = if block_given? && !value.blank?
-            yield(value)
-          elsif !options[:with].nil? && !value.blank?
-            raise AttributeNormalizer::MissingNormalizer.new("No normalizer was found for #{options[:with]}") unless AttributeNormalizer.configuration.normalizers.has_key?(options[:with])
-            this = AttributeNormalizer.configuration.normalizers[options.delete(:with)].call(value, options)
-          else
-             value.is_a?(String) ? value.strip : value
-           end
-          normalized.nil? || (normalized.is_a?(String) && normalized == '') ? nil : normalized
-        end
-
-        klass.send :private, "normalize_#{attribute}"
-
-        src = <<-end_src
-          def #{attribute}=(value)
-            super(self.class.send(:normalize_#{attribute}, value))
-          end
-        end_src
-
-        module_eval src, __FILE__, __LINE__
-
-      end
-
-    end
-
-    alias :normalize_attribute :normalize_attributes
-
-  end
-
-  module RSpecMatcher
-
-    def normalize_attribute(attribute)
-      NormalizeAttribute.new(attribute)
-    end
-
-    class NormalizeAttribute
-
-      def description
-        "normalize #{@attribute} from #{@from.nil? ? 'nil' : "\"#{@from}\""} to #{@to.nil? ? 'nil' : "\"#{@to}\""}"
-      end
-
-      def failure_message
-        "#{@attribute} did not normalize as expected! \"#{@subject.send(@attribute)}\" != #{@to.nil? ? 'nil' : "\"#{@to}\""}"
-      end
-
-      def from(value)
-        @from = value
-        self
-      end
-
-      def initialize(attribute)
-        @attribute = attribute
-        @from = ''
-      end
+end
 
-      def matches?(subject)
-        @subject = subject
-        @subject.send("#{@attribute}=", @from)
-        return false unless @subject.send(@attribute) == @to
-        true
-      end
 
-      def to(value)
-        @to = value
-        self
-      end
+require 'attribute_normalizer/model_inclusions'
+require 'attribute_normalizer/rspec_matcher'
 
-    end
 
+def include_attribute_normalizer(class_or_module)
+  return if class_or_module.include?(AttributeNormalizer)
+  class_or_module.class_eval do
+    extend AttributeNormalizer::ClassMethods
   end
-
 end
 
-ActiveRecord::Base.send(:include, AttributeNormalizer)    if defined?(ActiveRecord::Base)
-CassandraObject::Base.send(:include, AttributeNormalizer) if defined?(CassandraObject::Base)
+include_attribute_normalizer(ActiveModel::Base)     if defined?(ActiveModel::Base)
+include_attribute_normalizer(ActiveRecord::Base)    if defined?(ActiveRecord::Base)
+include_attribute_normalizer(CassandraObject::Base) if defined?(CassandraObject::Base)

data/rails/init.rb

@@ -1 +1 @@
-require File.join(File.dirname(__FILE__), *%w[.. lib attribute_normalizer])
+require 'attribute_normalizer'

data/spec/book_spec.rb

@@ -4,14 +4,14 @@ describe Book do
 
   it { should normalize_attribute(:author).from(' Michael Deering ').to('Michael Deering') }
 
-  it { should normalize_attribute(:price).from('$3,450.98').to(3450.98) }
+  it { should normalize_attribute(:us_price).from('$3.50').to(3.50) }
+  it { should normalize_attribute(:cnd_price).from('$3,450.98').to(3450.98) }
 
   it { should normalize_attribute(:summary).from('Here is my summary that is a little to long').to('Here is m...') }
 
-  it { should normalize_attribute(:title).from('pick up chicks with magic tricks').to('Pick Up Chicks With Magic Tricks')}
+  it { should normalize_attribute(:title).from('pick up chicks with magic tricks').to('Pick Up Chicks With Magic Tricks') }
 
   context 'normalization should not interfear with other hooks and aliases on the attribute assignment' do
-
     before do
       @book = Book.create!(:title => 'Original Title')
     end
@@ -19,11 +19,9 @@ describe Book do
     it 'should still reflect that the attribute has been changed through the call to super' do
       lambda { @book.title = 'New Title' }.should change(@book, :title_changed?).from(false).to(true)
     end
-
   end
 
   context 'when another instance of the same saved record has been changed' do
-
     before do
       @book = Book.create!(:title => 'Original Title')
       @book2 = Book.find(@book.id)
@@ -33,7 +31,17 @@ describe Book do
     it "should reflect the change when the record is reloaded" do
       lambda { @book.reload }.should change(@book, :title).from('Original Title').to('New Title')
     end
+  end
+
+  context 'normalization should work with multiple attributes at the same time' do
+    before do
+      @book = Book.new(:title => '  Bad Title   ', :author => '   Bad Author   ')
+    end
 
+    it "should apply normalizations to both attributes" do
+      @book.title.should  == 'Bad Title'
+      @book.author.should == 'Bad Author'
+    end
   end
 
 end

data/spec/connection_and_schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Base.establish_connection({
+  :database => ":memory:",
+  :adapter  => 'sqlite3',
+  :timeout  => 500
+})
+
+ActiveRecord::Schema.define do
+  create_table :books, :force => true do |t|
+    t.string  :author
+    t.string  :isbn
+    t.decimal :cnd_price
+    t.decimal :us_price
+    t.string  :summary
+    t.string  :title
+  end
+end

data/spec/models/author.rb

@@ -0,0 +1,13 @@
+class Author < ActiveModel::Base
+
+  normalize_attribute  :name
+
+  normalize_attribute  :hourly_cost, :with => :currency
+
+  normalize_attributes :biography,   :with => :truncate, :length => 12
+
+  normalize_attributes :email_address do |value|
+    value.is_a?(String) ? value.titleize.strip : value
+  end
+
+end

data/spec/models/book.rb

@@ -0,0 +1,13 @@
+class Book < ActiveRecord::Base
+
+  normalize_attribute  :author
+
+  normalize_attribute  :us_price, :cnd_price, :with => :currency
+
+  normalize_attributes :summary, :with => :truncate, :length => 12
+
+  normalize_attributes :title do |value|
+    value.is_a?(String) ? value.titleize.strip : value
+  end
+
+end

data/spec/test_helper.rb

@@ -1,11 +1,11 @@
 require 'rubygems'
 require 'spec'
-require 'active_support'
 require 'active_record'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'attribute_normalizer'
 
+
 AttributeNormalizer.configure do |config|
 
   config.normalizers[:currency] = lambda do |value, options|
@@ -25,33 +25,11 @@ AttributeNormalizer.configure do |config|
 
 end
 
-ActiveRecord::Base.establish_connection({ :database => ":memory:", :adapter => 'sqlite3', :timeout => 500 })
-
-ActiveRecord::Schema.define do
-  create_table :books, :force => true do |t|
-    t.string  :author
-    t.string  :isbn
-    t.decimal :price
-    t.string  :summary
-    t.string  :title
-  end
-end
-
-class Book < ActiveRecord::Base
-
-  normalize_attribute  :author
 
-  normalize_attribute  :price, :with => :currency
+require 'connection_and_schema'
+require 'models/book'
 
-  normalize_attributes :summary, :with => :truncate, :length => 12
-
-  normalize_attributes :title do |value|
-    value.is_a?(String) ? value.titleize.strip : value
-  end
-
-end
 
 Spec::Runner.configure do |config|
-  config.include AttributeNormalizer::RSpecMatcher, :type => :models
-end
-
+  config.include AttributeNormalizer::RSpecMatcher
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: attribute_normalizer
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Michael Deering
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-14 00:00:00 -06:00
+date: 2010-08-18 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -33,9 +34,14 @@ files:
 - install.rb
 - install.txt
 - lib/attribute_normalizer.rb
+- lib/attribute_normalizer/model_inclusions.rb
+- lib/attribute_normalizer/rspec_matcher.rb
 - rails/init.rb
 - spec/attribute_normalizer_spec.rb
 - spec/book_spec.rb
+- spec/connection_and_schema.rb
+- spec/models/author.rb
+- spec/models/book.rb
 - spec/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/mdeering/attribute_normalizer
@@ -49,27 +55,34 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Attribute normalizer that excepts code blocks.
 test_files: 
 - spec/attribute_normalizer_spec.rb
 - spec/book_spec.rb
+- spec/connection_and_schema.rb
+- spec/models/author.rb
+- spec/models/book.rb
 - spec/test_helper.rb