attribute-filters 2.0.1 → 2.0.2

data/ChangeLog

@@ -1,3 +1,33 @@
+commit c523068642e1461a11b96816d1c0b8adf20dcdc1
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Wed Nov 21 18:58:32 2012 +0100
+
+    Release 2.0.2
+
+commit ca7d41f8d7fd964bb04715b8cfe1276e641faa30
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Nov 10 03:40:43 2012 +0100
+
+    Documentation updated
+
+commit defb9c5e80809b9098e781d44e9764b8a685bfd0
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Mon Nov 5 00:07:17 2012 +0100
+
+    README updated
+
+commit 3bbf561be52ecc64998230e63601f8dac87d9d5f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Nov 4 23:57:44 2012 +0100
+
+    README updated
+
+commit ae25d0fefbe299216b82a4c3df431584cdc1610f
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Nov 4 17:04:14 2012 +0100
+
+    README updated
+
 commit 364a5df0dfe8bed367351c55b7b64c174b2a3d91
 Author: Paweł Wilk <siefca@gnu.org>
 Date:   Sun Nov 4 16:44:10 2012 +0100

data/Gemfile.lock

@@ -48,22 +48,22 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (0.9.2.2)
+    rake (0.9.5)
     rdoc (3.12)
       json (~> 1.4)
     redcarpet (2.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
+    rspec-mocks (2.12.0)
     supermodel (0.1.6)
       activemodel (~> 3.0.0)
     thor (0.14.6)
-    tzinfo (0.3.34)
+    tzinfo (0.3.35)
     yard (0.8.3)
 
 PLATFORMS

data/README.md

@@ -140,7 +140,7 @@ Attributes that should be altered may be simply added
 to the attribute sets that you define and then filtered
 with generic methods that operate on that sets. You can share
 these methods across all of your models by putting them into your own
-handy module that will be included in models that needs it.
+handy module that will be included in models that need it.
 
 Alternatively (as presented at the beginning) you can use predefined filtering methods from `ActiveModel::AttributeFilters::Common` module and its submodules. They contain filters
 for changing the case, stripping, squishng, squeezing, joining, splitting
@@ -161,13 +161,17 @@ Tracking changes and filtering virtual attributes is also easy:
 
 ```ruby
 class User < ActiveRecord::Base
-  include ActiveModel::AttributeFilters::Split
+  include ActiveModel::AttributeFilters::Common::Split
   
   split_attribute   :real_name => [ :first_name, :last_name ]
   before_validation :filter_attributes
   
   attr_virtual  :real_name
-  attr_accessor :real_name
+  attr_writer   :real_name
+  
+  def real_name
+    @real_name ||= "#{first_name} #{last_name}"
+  end
 end
 ```
 
@@ -185,9 +189,9 @@ use it to express some logic
 ### Sneak peeks ###
 
 ```ruby
-  @user.is_the_attribute.username.required_to_use_application?
+  @user.is_the_attribute.username.required_to_make_deals?
   # => true
-    
+  
   @user.the_attribute(:username).should_be_stripped?
   # => true
   
@@ -196,18 +200,21 @@ use it to express some logic
   
   @user.is_the_attribute.username.protected?
   # => false
-
+  
   @user.has_the_attribute.username.changed?
   # => false
-
+  
   @user.is_the_attribute.username.valid?
   # => true
   
   @user.are_attributes_that.should_be_stripped.all.present?
   # => false
   
+  @user.from_attributes_that.should_be_stripped.list.blank?
+  # => #<ActiveModel::AttributeSet: {"unconfirmed_email"}> 
+  
   @user.the_attribute(:username).list.sets
-  # => #<ActiveModel::AttributeSet: {:should_be_downcased, :should_be_stripped}>
+  # => {:should_be_downcased=>true, :should_be_stripped=>true}
   
   @user.attributes_that.should_be_stripped.list.present?
   # => #<ActiveModel::AttributeSet: {"username", "email"}>
@@ -227,21 +234,20 @@ How it works?
 
 It creates a new Active Model submodule called `AttributeFilters`. That module
 contains the needed DSL that goes into your models. It also creates `ActiveModel::AttributeSet`
-class which is just a new kind of set, a structure for storing attribute names.
+and `ActiveModel::MetaSet` classes which are just new kinds of hash used for storing attribute names
+and attribute set names.
 
 Then it forces Rails to include the `ActiveModel::AttributeFilters` in any model that
-at any time includes `ActiveModel::AttributeMethods`. The last one is included
-quite often; e.g. Active Record and other popular ORM-s use it. (I'm calling that thechnique
+will at any time include `ActiveModel::AttributeMethods`. The last one is included
+quite often; many popular ORM-s use it. (I'm calling that thechnique
 "the accompanying module".)
 
-That's why you can make use of attribute filters without explicitly including
-the module, as long as your application uses some popular ORM.
-
-However, if something goes wrong or your application is somehow unusual, you can always
-include the `AttributeFilters` module manually in any of your models:
+It all should work out of the box with ActiveModel. However, if your application
+is somehow unusua (for example you don't need to include `ActiveModel::AttributeMethods`)
+you can always include the `AttributeFilters` module manually in any model or entity:
 
 ```ruby
-class ExampleModel
+class User
   include ActiveModel::AttributeFilters
 end
 ```
@@ -306,10 +312,12 @@ You can send me some bitcoins if you would like to support me:
 
 * `13wZbBjs6yQQuAb3zjfHubQSyer2cLAYzH`
 
-Or you can endorse my skills on LinkedIn:
+Or you can endorse my skills on LinkedIn or Coderwall:
 
 * [pl.linkedin.com/in/pwilk](http://www.linkedin.com/profile/view?id=4251568#profile-skills)
 
+* [![endorse](http://api.coderwall.com/siefca/endorsecount.png)](http://coderwall.com/siefca)
+
 License
 -------
 

data/attribute-filters.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = "attribute-filters"
-  s.version = "2.0.1.20121104164328"
+  s.version = "2.0.2.20121121185803"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pawe\u{142} Wilk"]
   s.cert_chain = ["/Users/siefca/.gem/gem-public_cert.pem"]
-  s.date = "2012-11-04"
+  s.date = "2012-11-21"
   s.description = "Concise way of filtering model attributes in Rails."
   s.email = ["pw@gnu.org"]
   s.extra_rdoc_files = ["Manifest.txt"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--title", "Attribute::Filters Documentation", "--quiet"]
   s.require_paths = ["lib"]
   s.rubyforge_project = "attribute-filters"
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.23"
   s.signing_key = "/Users/siefca/.gem/gem-private_key.pem"
   s.summary = "Concise way of filtering and grouping model attributes in Rails"
 

data/docs/HISTORY

@@ -1,3 +1,9 @@
+=== 2.0.2 / 2012-11-18
+
+* minor enhancements
+
+  * `attribute_set` class and instance aliases are created if methods named the same aren't defined yet
+
 === 2.0.1 / 2012-10-04
 
 * major enhancements

data/docs/TODO

@@ -1,3 +1,8 @@
+* attr_virtual - handle situation when method appears because module was included (wrap include and check for methods that module has)
+
+* add some configuration keywords that would allow a quick integration with strange frameworks
+  (add proxy methods for attributes, changes and so on and allow configuration of these methods - call AR/AM if @method_slot is nil, send @method_slot otherwise)
+
 * add sanitize to common filters
   -- sanitize_url
   -- sanitize_string

data/docs/USAGE.md

@@ -76,10 +76,15 @@ end
 
 Instead of `attribute_set` you may also use one of the aliases:
 
-  * `attributes_set`, `attributes_that_are`, `attributes_that`, `properties_that`,         
+  * `af_attribute_set`, `attributes_set`, `attributes_that_are`, `attributes_that`, `properties_that`,         
     `has_attribute_set`, `has_attribute_that`, `has_attribute_that_is`, `has_attributes`,          
     `has_attributes_set`, `has_attributes_that_are`, `has_attributes_that`, `has_properties_that`
 
+**WARNING**
+
+If you are using other module that provides `attribute_set` class method (e.g. Virtus) then make sure you are including `AttributeFilters` (or `ActiveModel::AttributeMethods`) **after** including that module. Then use any other alias
+(e.g. `af_attribute_set`) instead of `attribute_set`.
+
 #### `filter_attribute(attr => set_names)` ####
 
 You may prefer the alternative syntax, that **uses attribute names**
@@ -268,6 +273,11 @@ Example:
 
 It works the same as the `all_attributes` method.
 
+**WARNING**
+
+If you are using other module that provides `attribute_set` method (e.g. Virtus) then make sure you are including `AttributeFilters` (or `ActiveModel::AttributeMethods`) **after** including that module. Then use any other alias
+(e.g. `af_attribute_set`) instead of `attribute_set`.
+
 #### `attribute_set(set_name)` ####
 
 The [`attribute_set`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:attribute_set)
@@ -303,7 +313,7 @@ There are also variants of this method that differ in a kind of taken argument:
 
 Instead of `attribute_set` you may also use one of the aliases:
 
-  * `attributes_set`, `attributes_that_are`, `attributes_that`, `properties_that`,         
+  * `af_attribute_set`, `attributes_set`, `attributes_that_are`, `attributes_that`, `properties_that`,         
     `has_attribute_set`, `has_attribute_that`, `has_attribute_that_is`, `has_attributes`,          
     `has_attributes_set`, `has_attributes_that_are`, `has_attributes_that`, `has_properties_that`
     
@@ -314,6 +324,11 @@ Instead of `attribute_set` you may also use:
 It works same way as `attribute_set(set_name)` but doesn't wrap the result in a transparent proxy
 object that brings some syntactic sugar (explained later).
 
+**WARNING**
+
+If you are using other module that provides `attribute_set` method (e.g. Virtus) then make sure you are including `AttributeFilters` (or `ActiveModel::AttributeMethods`) **after** including that module. Then use any other alias
+(e.g. `af_attribute_set`) instead of `attribute_set`.
+
 #### `attribute_sets` ####
 
 The [`attribute_sets`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:attribute_sets)
@@ -1621,7 +1636,7 @@ or
 
 #### After defining sets ####
 
-To create annotations for class-level sets use the [`annotate_attribute_set`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters/ClassMethods.html#annotate_attribute_set-instance_method) method (an its aliases):
+To create annotations for class-level sets use the [`annotate_attribute_set`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters/ClassMethods.html#annotate_attribute_set-instance_method) method or one of its aliases:
 
 * **`annotate_attributes_that_are`**
 * **`annotate_attributes_that`**

data/lib/attribute-filters/attribute_set_annotations.rb

@@ -131,9 +131,9 @@ module ActiveModel
               output_set[atr_name][default_param.to_sym] = atr_annotations
             end
           end
-          attribute_set(set_name, output_set)
+          af_attribute_set(set_name, output_set)
         else
-          attribute_set(set_name, *attribute_defs)
+          af_attribute_set(set_name, *attribute_defs)
         end
         nil
       end

data/lib/attribute-filters/attribute_set_query.rb

@@ -78,7 +78,7 @@ module ActiveModel
 
         # set name as a method name
         if @set_object.nil?
-          @set_object = @am_object.class.attribute_set(method_sym)
+          @set_object = @am_object.class.af_attribute_set(method_sym)
           return self
         end
 

data/lib/attribute-filters/common_filters/split.rb

@@ -124,7 +124,7 @@ module ActiveModel
                 :split_flatten  => [ :flatten, :split_flatten ]
               }, :split_into
             # write some defaults
-            limit, into = attribute_set(:should_be_splitted).get_annotations(atr_name, :split_limit, :split_into)
+            limit, into = af_attribute_set(:should_be_splitted).get_annotations(atr_name, :split_limit, :split_into)
             annotate_attribute_set(:should_be_splitted, atr_name, :split_limit, limit.to_i) unless limit.blank?
             if into.blank?
               annotate_attribute_set(:should_be_splitted, atr_name,:split_into, nil)

data/lib/attribute-filters/dsl_sets.rb

@@ -17,6 +17,11 @@ module ActiveModel
     # @return [void]
     def self.included(base)
       base.extend ClassMethods
+      base.module_eval do
+        unless method_defined?(:attribute_set)
+          alias_method :attribute_set, :af_attribute_set
+        end
+      end
     end
 
     # Returns the attribute set of the given name or the set containing
@@ -43,22 +48,22 @@ module ActiveModel
     # 
     # @param set_name [Symbol] name of attribute set, attribute object or any object that can initialize a set
     # @return [AttributeSet] attribute set
-    def attribute_set(set_name = nil)
+    def af_attribute_set(set_name = nil)
       ActiveModel::AttributeSet::Query.new(set_name, self)
     end
-    alias_method :attributes_that_are,        :attribute_set
-    alias_method :from_attributes_that,       :attribute_set
-    alias_method :are_attributes_that,        :attribute_set
-    alias_method :are_attributes_that_are,    :attribute_set
-    alias_method :are_attributes,             :attribute_set
-    alias_method :are_attributes_for,         :attribute_set
-    alias_method :from_attributes_that_are,   :attribute_set
-    alias_method :in_attributes_that_are,     :attribute_set
-    alias_method :attributes_that,            :attribute_set
-    alias_method :attributes_are,             :attribute_set
-    alias_method :attributes_for,             :attribute_set
-    alias_method :attributes_set,             :attribute_set
-    alias_method :properties_that,            :attribute_set
+    alias_method :attributes_that_are,        :af_attribute_set
+    alias_method :from_attributes_that,       :af_attribute_set
+    alias_method :are_attributes_that,        :af_attribute_set
+    alias_method :are_attributes_that_are,    :af_attribute_set
+    alias_method :are_attributes,             :af_attribute_set
+    alias_method :are_attributes_for,         :af_attribute_set
+    alias_method :from_attributes_that_are,   :af_attribute_set
+    alias_method :in_attributes_that_are,     :af_attribute_set
+    alias_method :attributes_that,            :af_attribute_set
+    alias_method :attributes_are,             :af_attribute_set
+    alias_method :attributes_for,             :af_attribute_set
+    alias_method :attributes_set,             :af_attribute_set
+    alias_method :properties_that,            :af_attribute_set
 
     # Returns the attribute set of the given name without wrapping
     # the result in proxy methods.
@@ -71,7 +76,7 @@ module ActiveModel
     # @param set_name [Symbol] name of attribute set
     # @return [AttributeSet] attribute set
     def attribute_set_simple(set_name)
-      self.class.attribute_set(set_name)
+      self.class.af_attribute_set(set_name)
     end
 
     # Returns a set containing all known attributes
@@ -254,9 +259,18 @@ module ActiveModel
     # This module contains class methods
     # that create DSL for managing attribute sets.
     module ClassMethods
+      def self.extended(base)
+        base.module_eval do
+          unless method_defined?(:attribute_set)
+            alias_method :attribute_set, :af_attribute_set
+          end
+        end
+      end
+
       # @overload attribute_set()
-      #   Gets all the defined attribute sets by calling +attribute_sets+.
-      #   @return [Hash{Symbol => AttributeSet<String>}] the collection of attribute sets indexed by their names
+      #   Gets all the defined attribute sets by calling +attribute_sets+ unless some other module overriden this method –
+      #   In such cache it calls that method.
+      #   @return [Object,Hash{Symbol => AttributeSet<String>}] the collection of attribute sets indexed by their names
       # 
       # @overload attribute_set(set_name)
       #   Gets the attribute set of the given name from internal storage.
@@ -281,14 +295,14 @@ module ActiveModel
       #    and arrays of attributes
       #   @param attribute_names [Array<Symbol,String>] names of additional attributes to be stored in set
       #   @return [nil]
-      def attribute_set(*args)
+      def af_attribute_set(*args)
         case args.size
         when 0
           attribute_sets
         when 1
           first_arg = args.first
           if first_arg.is_a?(Hash)                              # [write] multiple sets defined
-            first_arg.each_pair { |k, v| attribute_set(k, v) }
+            first_arg.each_pair { |k, v| af_attribute_set(k, v) }
             nil
           else                                                  # [read] single set to read
             r = __attribute_sets[first_arg.to_sym]
@@ -298,7 +312,7 @@ module ActiveModel
           first_arg = args.shift
           if first_arg.is_a?(Hash)                              # [write] multiple sets defined
             first_arg.each_pair do |k, v|
-              attribute_set(k, v, args)
+              af_attribute_set(k, v, args)
             end
           else                                                  # [write core] sinle set and optional attrs given
             AFHelpers.check_wanted_methods(self)
@@ -307,18 +321,18 @@ module ActiveModel
           nil
         end
       end
-      alias_method :attributes_set,           :attribute_set
-      alias_method :attributes_that_are,      :attribute_set
-      alias_method :attributes_that,          :attribute_set
-      alias_method :properties_that,          :attribute_set
-      alias_method :has_attribute_set,        :attribute_set
-      alias_method :has_attribute_that,       :attribute_set
-      alias_method :has_attribute_that_is,    :attribute_set
-      alias_method :has_attributes,           :attribute_set
-      alias_method :has_attributes_set,       :attribute_set
-      alias_method :has_attributes_that_are,  :attribute_set
-      alias_method :has_attributes_that,      :attribute_set
-      alias_method :has_properties_that,      :attribute_set
+      alias_method :attributes_set,           :af_attribute_set
+      alias_method :attributes_that_are,      :af_attribute_set
+      alias_method :attributes_that,          :af_attribute_set
+      alias_method :properties_that,          :af_attribute_set
+      alias_method :has_attribute_set,        :af_attribute_set
+      alias_method :has_attribute_that,       :af_attribute_set
+      alias_method :has_attribute_that_is,    :af_attribute_set
+      alias_method :has_attributes,           :af_attribute_set
+      alias_method :has_attributes_set,       :af_attribute_set
+      alias_method :has_attributes_that_are,  :af_attribute_set
+      alias_method :has_attributes_that,      :af_attribute_set
+      alias_method :has_properties_that,      :af_attribute_set
 
       # @overload filter_attribute()
       #   Gets all the defined attribute sets.
@@ -373,10 +387,10 @@ module ActiveModel
             args.flatten.compact.each do |set_name|
               if set_name.is_a?(Hash) # annotation
                 set_name.each_pair do |set_name_b, a_defs|
-                  attribute_set(set_name_b, first_arg => a_defs)
+                  af_attribute_set(set_name_b, first_arg => a_defs)
                 end
               else
-                attribute_set(set_name, first_arg)
+                af_attribute_set(set_name, first_arg)
               end
             end
           end

data/lib/attribute-filters/version.rb

@@ -14,7 +14,7 @@ module ActiveModel
     # @private
     EMAIL       = 'pw@gnu.org'
     # @private
-    VERSION     = '2.0.1'
+    VERSION     = '2.0.2'
     # @private
     NAME        = 'attribute-filters'
     # @private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribute-filters
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -36,7 +36,7 @@ cert_chain:
   YzBobXpodlZadEJ3ZlpyaXRTVmhmQ0xwNXVGd3FDcVkKTkszVElaYVBDaDFT
   Mi9FUzZ3WE52alErNUVuRUVMOWovcFNFb3A5RFlFQlBhTTJXRFZSNWkwakpU
   QWFSV3c9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -320,7 +320,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1229665950453395191
+      hash: -1525160072610592703
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -329,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: attribute-filters
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Concise way of filtering and grouping model attributes in Rails