attribute-filters 1.1.2 → 1.1.3

data.tar.gz.sig

@@ -1,2 +1 @@
-[��z\�/�^��0��BT]6�Yc��/-�V�XA8��`�Cg�	�U�6��aP�]U���G�2�)���t�qL�`�6���-���iK���W�Ty4��ʺ.I;Z��g�z�Z���Cz��1wa��<8S�=��=��J]�ꇁW�]3��a���W��\~��&�ݎA���Á[�s��ODM]
-P�"��}\:aR���[�?^�%���}���yb죱<�Rڠ��F�\��ۇ
+7�Fq�%���b��(L�{"ÀM(@#V?%�������u�j^Q�1�<]��Z~.�<�jF\�{������q[,`ω�9��q��8lɯ(P6	(���,2�>���j+z��	��RCh/�p6{=n�"�+0G�AV6绔r�UsO4O<�f�Z"�|�-�{{Hi��(��zD��ȑ�D��3�9!1�{�C�\t�︰g����r#�L�d
�;%��ݘ�W]4�p[���U�v1x5A��+����O�

data/.yardopts

@@ -6,7 +6,7 @@
 -p docs/yard-tpl
 -t default
 -
-docs/USAGE
+docs/USAGE.md
 docs/HISTORY
 ChangeLog
 docs/COPYING

data/ChangeLog

@@ -1,3 +1,191 @@
+commit 275690a75a7218aab8766a50d61b8be5eec20509
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Tue Jul 10 11:32:08 2012 +0200
+
+    Bugfix release 1.1.3
+
+commit 1087942cbf4e003e72524e4b877f98960e3c004e
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jul 8 10:50:35 2012 +0200
+
+    Preparing for release 1.2.0
+
+commit 7963c74a4ee7e59baecbccf83acdfc101a29257a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jul 8 10:40:13 2012 +0200
+
+    README links updated
+
+commit 65ddb3ef269de01ca122c5949d2401990bc34e53
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jul 8 10:13:01 2012 +0200
+
+    Removed the show DSL method from AttrQuery proxy class
+
+commit 2216013e69c30bd3ab3e6c5ff9ecd4379f768239
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jul 8 10:12:24 2012 +0200
+
+    Documentation updated, finished editing the USAGE
+
+commit 40db8f483d43bd894bff7437e9582c82f6f6db6a
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jul 8 10:11:34 2012 +0200
+
+    Added the Common module with common filtering methods
+
+commit 067712ddfd5c7435e7066c1dca94b2b39c5edb09
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 16:16:34 2012 +0200
+
+    Added checking of model methods that are needed for a proper operation
+
+commit 813b22d395d3376db0e31a1e6de6ec8f43f04c04
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 16:15:19 2012 +0200
+
+    Replaced changed_attributes calls by more generic calls to changes method in DSL's filtering methods
+
+commit 246937196e11b7abbaeb2c7b35134c9a239716bb
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 14:44:54 2012 +0200
+
+    Re-added from_attributes_that alias for instance method attribute_set
+
+commit 355d637d1fa0e37b693b69da705d6844904613c5
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 14:44:19 2012 +0200
+
+    Proxy class Query is now viral and tries to wrap the results in its own instances
+
+commit d484f5bbac557cb46f5a686ba26620334ee89d05
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 14:41:00 2012 +0200
+
+    Added from_attributes_that as the alias for attribute_set instance method, documentation updated
+
+commit acae50c77864ebbec1946979d3d5f2753a16d4cd
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 13:40:35 2012 +0200
+
+    USAGE updated
+
+commit cb4374b295cca47ef8a3fdf1c796296ab423367c
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 13:40:23 2012 +0200
+
+    Used original sort and sort_by implementation and intermediate array in enumerator (performance)
+
+commit 2b6b316298da88970c655234aec22959eabc2e02
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 01:30:20 2012 +0200
+
+    ChangeLog updated
+
+commit 007a5384e65afec1c453080bebb7b813da99b00d
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 01:29:56 2012 +0200
+
+    Added 'none' and 'one' presence selectors to AttributeSet::Query class
+
+commit c5c6b5d9d8049dfd0d45b6607e2858de3b83544d
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 01:26:38 2012 +0200
+
+    Added AttributeSetEnumerable and AttributeSetEnumerator
+
+commit 069b357b8c75456c9c2fe27b3570fe3cd3077c4d
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 01:25:07 2012 +0200
+
+    Virtual attributes support methods moved (documentation parsing purposes)
+
+commit acbc2e8426371019ade72c7b33b330834b3b73d7
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 01:23:00 2012 +0200
+
+    Serious bugfix in AttributeSet::Query proxy class (typo caused incorrect processing)
+
+commit 1c13b364a3f26da726e85b19d1fda16786985c82
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sat Jul 7 01:21:38 2012 +0200
+
+    Documentation updated
+
+commit 295da0da4b14f3b1a9399400139a15ecdfcf27d1
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jul 6 13:43:12 2012 +0200
+
+    Added virtual attributes support in filters
+
+commit aae677905aa9ae47eca7e708babcbc0c7f34c7c1
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Fri Jul 6 02:49:49 2012 +0200
+
+    Documentation updated
+
+commit 95619151c116585bb325b6f242c921dad1a33977
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 16:02:27 2012 +0200
+
+    Renamed USAGE to USAGE.md
+
+commit 1c0bb54762b5ccc60fb3c27c0c24fe19ac078020
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 15:58:59 2012 +0200
+
+    Preparing for new release
+
+commit 6b75c4de40301060b2b5b19824f00cc5acc0fa8e
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 15:21:13 2012 +0200
+
+    Added DSL instance methods attribute_sets and attributes_to_sets
+
+commit e545baad64e6820d93cdc7c89b2ece83f12d6329
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 15:20:02 2012 +0200
+
+    Added missing respond_to? definitions to proxy classes
+
+commit f856d0b6f669cafc3ec5a1d84030e99870b5fcee
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 15:19:18 2012 +0200
+
+    Added DSL keyword for querying which attribute sets are associated with an attribute
+
+commit 5611e8c098c21d38f0fa9bd21f338f51a658ae30
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 15:16:18 2012 +0200
+
+    README updated
+
+commit c68b3219ef0923d1184c0c5efb4240c1d53a89d5
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 13:38:06 2012 +0200
+
+    Added the_attribute DSL method for instances and AttributeSet::AttrQuery proxy class
+
+commit 964e46d2a77502192461c6f1e208dab73871caa9
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Thu Jul 5 12:23:27 2012 +0200
+
+    Added filter_attribute DSL keyword for adding attribute names to specified sets (alternative syntax)
+    
+    - Added @__attributes_to_sets_map for storing reverse mappings of attribute names to sets;
+    - Changed the way the internal data structures are accessed by adding private methods:
+      __attributes_to_sets_map and __attribute_sets
+    - Internal data structures are now duplicated when accessed from outside and the default value
+      for a set (when an element doesn't exist) is an empty set
+    - Updated RSpec examples,
+    - Added new DSL example to README.
+
+commit e8c2c98b55152fff9b6515197f5315b0dfe702ea
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Jul 1 00:57:34 2012 +0200
+
+    Documentation fixed and updated
+
 commit 0235e6184da1ca9ef4264a772032c820d76fec19
 Author: Paweł Wilk <siefca@gnu.org>
 Date:   Sun Jul 1 00:42:03 2012 +0200

data/Manifest.txt

@@ -13,13 +13,15 @@ docs/HISTORY
 docs/LEGAL
 docs/LGPL-LICENSE
 docs/TODO
-docs/USAGE
+docs/USAGE.md
 docs/rdoc.css
 docs/yard-tpl/default/fulldoc/html/css/common.css
 init.rb
 lib/attribute-filters.rb
 lib/attribute-filters/active_model_insert.rb
 lib/attribute-filters/attribute_set.rb
+lib/attribute-filters/attribute_set_attrquery.rb
+lib/attribute-filters/attribute_set_enum.rb
 lib/attribute-filters/attribute_set_query.rb
 lib/attribute-filters/common_filters.rb
 lib/attribute-filters/dsl_filters.rb

data/README.md

@@ -1,9 +1,7 @@
 Attribute Filters for Rails
 ===========================
 
-**attribute-filters version `1.1`** (**`Sugar, ah honey honey`**)
-
-**THIS IS BETA!**
+**attribute-filters version `1.2`** (**`Lavender Bunch`**)
 
 * https://rubygems.org/gems/attribute-filters
 * https://github.com/siefca/attribute-filters/tree
@@ -31,17 +29,17 @@ To refine that process you may write more generic methods
 for altering attributes. They should be designed to handle
 common operations and not tied to certain attributes.
 
-Enough words, let's see that approach in action.
+Enough words, let's see that in action.
 
 ### Before ###
 
 ```ruby
 class User < ActiveRecord::Base
-  
+
   before_validation :strip_and_downcase_username
   before_validation :strip_and_downcase_email
   before_validation :strip_and_capitalize_real_name
-  
+
   def strip_and_downcase_username
     if username.present?
       self.username = self.username.strip.mb_chars.downcase.to_s
@@ -54,14 +52,13 @@ class User < ActiveRecord::Base
       self.email.downcase!
     end
   end
-  
+
   def strip_and_capitalize_real_name
     if real_name.present?
       self.real_name = self.real_name.strip.mb_chars.split(' ').
                         map { |n| n.capitalize }.join(' ')
     end
-  end
-  
+  end  
 end
 ```
   
@@ -73,83 +70,97 @@ The filtering code is not reusable since it operates on specific attributes.
 
 ```ruby
 class User < ActiveRecord::Base
-  
   attributes_that should_be_stripped:     [ :username, :email, :real_name ]
   attributes_that should_be_downcased:    [ :username, :email ]
   attributes_that should_be_capitalized:  [ :real_name ]
-  
+
   before_validation :strip_names
   before_validation :downcase_names
   before_validation :capitalize_names
-  
+
   def downcase_names
     filter_attributes_that :should_be_downcased do |atr|
       atr.mb_chars.downcase.to_s
     end
   end
-  
+
   def capitalize_names
     filter_attributes_that :should_be_capitalized do |atr|
       atr.mb_chars.split(' ').map { |n| n.capitalize }.join(' ')
     end
   end
-  
+
   def strip_names
     for_attributes_that(:should_be_stripped) { |atr| atr.strip! }
   end
-  
 end
 ```
 
-Attributes that need to be altered may be simply added to the attribute sets
+or even shorter:
+
+```ruby
+class User < ActiveRecord::Base
+  include ActiveModel::AttributeFilters::Common
+
+  attributes_that should_be_stripped:           [ :username, :email, :real_name ]
+  attributes_that should_be_downcased:          [ :username, :email ]
+  attributes_that should_be_fully_capitalized:  [ :real_name ]
+
+  before_validation :strip_attributes
+  before_validation :downcase_attributes
+  before_validation :fully_capitalize_attributes
+end
+```
+
+Attributes that have to be altered may be simply added to the attribute sets
 that you define and then filtered with generic methods. You can use
 these methods in all your models if you wish.
 
 The last action can be performed by putting the filtering methods into
 some base class that models inherit form or (better) into your own
-handy module that is included in your models.
+handy module that is included in your models. Alternatively you can
+use predefined filters from `ActiveModel::AttributeFilters::Common` module.
 
-Usage
------
-
-You can use it to do attribute filtering as presented above but you can also
-try using ActiveModel::AttributeSet directly, which helps to express some logic.
-For example:
+If you would rather like to group filters by attribute names then
+the alternative syntax may be helpful:
 
 ```ruby
 class User < ActiveRecord::Base
-  
-  attributes_that_are required_to_trade: [ :username, :home_address, :bank_account ]
-  
-  def can_trade?
-    are_attributes(:required_to_trade).all.present?
-  end
-  
+  the_attribute email:        [ :should_be_stripped, :should_be_downcased   ]
+  the_attribute username:     [ :should_be_stripped, :should_be_downcased   ]
+  the_attribute real_name:    [ :should_be_stripped, :should_be_capitalized ]
 end
 ```
 
-* See [USAGE](http://rubydoc.info/gems/attribute-filters/file/docs/USAGE) for more examples and detailed information about the usage.
+Usage
+-----
+
+You can use it to filter attributes (as presented above) but you can also
+use it to express some logic
+[on your own](http://http://rubydoc.info/gems/attribute-filters/file/docs/USAGE#Custom_applications).
+
+* See [USAGE](http://rubydoc.info/gems/attribute-filters/file/docs/USAGE) for examples and detailed information about the usage.
 * See [whole documentation](http://rubydoc.info/gems/attribute-filters/) to browse all documents.
 
 How it works?
 -------------
 
-It creates a new Active Model module called ActiveModel::AttributeFilters. That module
-contains the needed DSL that goes into your models. It also creates ActiveModel::AttributeSet
+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 sets of attribute names.
 
 Then it forces Rails to include the AttributeFilters in any model that
 at any time will include ActiveModel::AttributeMethods. The last one is included
-quite often; e.g. ActiveRecord and other popular ORM-s use it. (I'm calling it
+quite often; e.g. Active Record and other popular ORM-s use it. (I'm calling it
 "the accompanying module".)
 
 That's why you can make use of attribute filters without explicitly including
 the module, as long as your application relies on any popular ORM.
 
 However, if something would go wrong or your application is somehow unusual, you can always
-include the AttributeFilters module manually in any of your models:
+include the `AttributeFilters` module manually in any of your models:
 
-```
+```ruby
 class ExampleModel
   include ActiveModel::AttributeFilters
 end
@@ -178,7 +189,7 @@ Download
 Installation
 ------------
 
-```
+```ruby
 gem install attribute-filters
 ```
 
@@ -195,6 +206,7 @@ Common rake tasks
 
 * `bundle exec rake bundler:gemfile` – regenerate the `Gemfile`
 * `bundle exec rake docs` – render the documentation (output in the subdirectory directory `doc`)
+* `bundle exec rake gem:spec` – builds static gemspec file (`attribute-filters.gemspec`)
 * `bundle exec rake gem` – builds package (output in the subdirectory `pkg`)
 * `bundle exec rake test` – performs tests
 * `bundle exec rake Manifest.txt` – regenerates the `Manifest.txt` file
@@ -213,8 +225,8 @@ Copyright (c) 2012 by Paweł Wilk.
 
 attribute-filters is copyrighted software owned by Paweł Wilk (pw@gnu.org).
 You may redistribute and/or modify this software as long as you
-comply with either the terms of the LGPL (see {file:docs/LGPL-LICENSE}),
-or Ruby's license (see {file:docs/COPYING}).
+comply with either the terms of the LGPL (see [LGPL-LICENSE](http://rubydoc.info/gems/attribute-filters/file/docs/LGPL-LICENSE)),
+or Ruby's license (see [COPYING](http://rubydoc.info/gems/attribute-filters/file/docs/COPYING)).
 
 THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS
 OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION,

data/attribute-filters.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = "attribute-filters"
-  s.version = "1.1.2.20120701004000"
+  s.version = "1.1.3.20120705154806"
 
   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-06-30"
+  s.date = "2012-07-05"
   s.description = "Concise way of filtering model attributes in Rails."
   s.email = ["pw@gnu.org"]
   s.extra_rdoc_files = ["Manifest.txt"]
-  s.files = [".rspec", ".yardopts", "ChangeLog", "Gemfile", "Gemfile.lock", "LGPL-LICENSE", "Manifest.txt", "README.md", "Rakefile", "attribute-filters.gemspec", "docs/COPYING", "docs/HISTORY", "docs/LEGAL", "docs/LGPL-LICENSE", "docs/TODO", "docs/USAGE", "docs/rdoc.css", "docs/yard-tpl/default/fulldoc/html/css/common.css", "init.rb", "lib/attribute-filters.rb", "lib/attribute-filters/active_model_insert.rb", "lib/attribute-filters/attribute_set.rb", "lib/attribute-filters/attribute_set_query.rb", "lib/attribute-filters/common_filters.rb", "lib/attribute-filters/dsl_filters.rb", "lib/attribute-filters/dsl_sets.rb", "lib/attribute-filters/helpers.rb", "lib/attribute-filters/railtie.rb", "lib/attribute-filters/version.rb", "spec/attribute-filters_spec.rb", "spec/spec_helper.rb", ".gemtest"]
+  s.files = [".rspec", ".yardopts", "ChangeLog", "Gemfile", "Gemfile.lock", "LGPL-LICENSE", "Manifest.txt", "README.md", "Rakefile", "attribute-filters.gemspec", "docs/COPYING", "docs/HISTORY", "docs/LEGAL", "docs/LGPL-LICENSE", "docs/TODO", "docs/USAGE", "docs/rdoc.css", "docs/yard-tpl/default/fulldoc/html/css/common.css", "init.rb", "lib/attribute-filters.rb", "lib/attribute-filters/active_model_insert.rb", "lib/attribute-filters/attribute_set.rb", "lib/attribute-filters/attribute_set_attrquery.rb", "lib/attribute-filters/attribute_set_query.rb", "lib/attribute-filters/common_filters.rb", "lib/attribute-filters/dsl_filters.rb", "lib/attribute-filters/dsl_sets.rb", "lib/attribute-filters/helpers.rb", "lib/attribute-filters/railtie.rb", "lib/attribute-filters/version.rb", "spec/attribute-filters_spec.rb", "spec/spec_helper.rb", ".gemtest"]
   s.homepage = "https://rubygems.org/gems/attribute-filters/"
   s.rdoc_options = ["--title", "Attribute::Filters Documentation", "--quiet"]
   s.require_paths = ["lib"]

data/docs/HISTORY

@@ -1,3 +1,28 @@
+=== 1.1.3 / 2012-07-10
+
+* major bugfixes
+
+  * In AttributeSet::Query proxy class: removed typo that caused incorrect processing
+
+* minor bugfixes
+
+  * Added missing respond_to? definitions to proxy classes
+
+* major enhancements
+
+  * Added enumerators (AttributeSetEnumerable and AttributeSetEnumerator)
+  * Added predefined filtering methods
+  * Added virtual attributes support in filters
+  * Written the usage instructions
+
+* minor enhancements
+
+  * Removed the show DSL method from AttrQuery proxy class
+  * Added checking of model methods that are needed for a proper operation
+  * Proxy class Query is now viral and tries to wrap the results in its own instances
+  * Added 'none' and 'one' presence selectors to AttributeSet::Query class
+  * Added from_attributes_that as the alias for attribute_set instance method
+
 === 1.1.2 / 2012-06-30
 
 * major bugfixes