attribute-filters 1.3.0 → 1.3.1

data/ChangeLog

@@ -1,3 +1,33 @@
+commit bd3f936868d7afcf22501c781e093f73b6dc8e9b
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Aug 5 14:31:12 2012 +0200
+
+    Release 1.3.1
+
+commit 8ba61780246a7677249ba875df0b6edd38cda5e8
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Aug 5 14:26:29 2012 +0200
+
+    Added is_accessible?, is_inaccessible? and is_protected? queries to AttrQuery proxy class
+
+commit 3cbdc984df09e7d3bdbca4d45713a686adac83a2
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Aug 5 11:44:45 2012 +0200
+
+    Documentation updated
+
+commit bddd9b06992b23355007f67431e4990bd4fbec49
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Aug 5 01:53:05 2012 +0200
+
+    Added all_attributes, all_accessible_attributes, all_protected_attributes, all_inaccessible_attributes
+
+commit c385eef1f671dbe27831a713f3a255d9f92154c8
+Author: Paweł Wilk <siefca@gnu.org>
+Date:   Sun Aug 5 01:51:44 2012 +0200
+
+    Added squish common filter
+
 commit fd6696a66397299042f11ba1feb4e82aeb1f2919
 Author: Paweł Wilk <siefca@gnu.org>
 Date:   Sun Aug 5 00:36:11 2012 +0200

data/README.md

@@ -136,14 +136,14 @@ some base class that all your models inherit form or (better) into your own
 handy module that is included in all your models. Alternatively you can
 use predefined filters from `ActiveModel::AttributeFilters::Common` module.
 
-More examples and usage
+Usage and more examples
 -----------------------
 
 You can use it to filter attributes (as presented above) but you can also
 use it to express some logic
 [on your own](http://rubydoc.info/gems/attribute-filters/file/docs/USAGE.md#Custom_applications).
 
-* See [USAGE](http://rubydoc.info/gems/attribute-filters/file/docs/USAGE.md) for examples and detailed information about the usage.
+* **See [USAGE](http://rubydoc.info/gems/attribute-filters/file/docs/USAGE.md) for examples and detailed information about the usage.**
 * See [whole documentation](http://rubydoc.info/gems/attribute-filters/) to browse all documents.
 
 ### Sneak peeks ###
@@ -160,6 +160,15 @@ use it to express some logic
   
   @user.the_attribute(:username).list.sets
   # => #<ActiveModel::AttributeSet: {:should_be_downcased, :should_be_stripped}>
+  
+  @user.the_attribute(:username).is.accessible?
+  # => true
+  
+  @user.is_the_attribute(:username).protected?
+  # => false
+  
+  @user.all_attributes.list.valid?
+  # => #<ActiveModel::AttributeSet: {"username", "email"}>
 ```
 
 How it works?

data/attribute-filters.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = "attribute-filters"
-  s.version = "1.3.0.20120804225210"
+  s.version = "1.3.1.20120805142734"
 
   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-08-04"
+  s.date = "2012-08-05"
   s.description = "Concise way of filtering model attributes in Rails."
   s.email = ["pw@gnu.org"]
   s.extra_rdoc_files = ["Manifest.txt"]

data/docs/HISTORY

@@ -1,3 +1,14 @@
+=== 1.3.1 / 2012-08-05
+
+  * major enhancements
+
+    * Added accessible?, inaccessible?, protected? attribute checks
+    * Added all_accessible_attributes, all_protected_attributes, all_inaccessible_attributes
+
+  * minor enhancements
+
+    * Added squish common filter
+
 === 1.3.0 / 2012-08-04
 
   * major bugfixes

data/docs/TODO

@@ -1,3 +1,5 @@
-* add more predefined filtering methods
+* add more rspec examples
+
+* document changed behaviour of attribute_set instance method
+
 
-* add rspec examples

data/docs/USAGE.md

@@ -207,12 +207,25 @@ is a wrapper that calls `attributes_to_sets` which returns
 a hash containing **all filtered attributes and arrays of sets**
 that the attributes belong to.
 
-
 ### Querying sets in objects ###
 
 It is possible to access attribute sets from within the ActiveModel (or ORM, like ActiveRecord) objects.
 To do that you may use instance methods that are designed for that purpose.
 
+#### `attribute_set` ####
+
+The [`attribute_set`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:attribute_set)
+method called withount an argument **returns the attribute set containing all attributes for a current object**.
+
+Example:
+
+```ruby
+  User.first.attribute_set
+  # =>  #<ActiveModel::AttributeSet: {"id", "username", "email", "password", "language", "created_at", "updated_at"}>
+```
+
+It works the same as the `all_attributes` method.
+
 #### `attribute_set(set_name)` ####
 
 The [`attribute_set`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:attribute_set)
@@ -267,9 +280,73 @@ Example:
 
 ```ruby
   User.first.all_attributes
-  # =>  #<ActiveModel::AttributeSet: {"id", "username", "email", "password", "language", "created_at", "updated_at"}> 
+  # =>  #<ActiveModel::AttributeSet: {"id", "username", "email", "password", "language", "created_at", "updated_at"}>
+```
+
+Be aware that this method requires that the used ORM has `attributes` data structure available for any model object.
+
+Instead of `all_attributes` you may also use the alias:
+
+  * `all_attributes_set`
+  
+or call the instance method `attribute_set` without arguments.
+
+#### `all_accessible_attributes` ####
+
+The [`all_accessible_attributes`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:all_accessible_attributes)
+method **returns the attribute set containing all accessible attributes**.
+
+Example:
+
+```ruby
+  User.first.all_accessible_attributes
+  # =>  #<ActiveModel::AttributeSet: {"username", "email", "language"}> 
 ```
 
+Be aware that this method requires that the used ORM has `accessible_attributes` data structure available for any model class.
+
+Instead of `all_accessible_attributes` you may also use the alias:
+
+  * `accessible_attributes_set`
+
+#### `all_protected_attributes` ####
+
+The [`all_protected_attributes`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:all_protected_attributes)
+method **returns the attribute set containing all protected attributes**.
+
+Example:
+
+```ruby
+  User.first.all_protected_attributes
+  # =>  #<ActiveModel::AttributeSet: {"id"}> 
+```
+
+Be aware that this method requires that the used ORM has `protected_attributes` data structure available for any model class.
+
+Instead of `all_protected_attributes` you may also use the alias:
+
+  * `protected_attributes_set`
+
+#### `all_inaccessible_attributes` ####
+
+The [`all_inaccessible_attributes`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:all_inaccessible_attributes)
+method **returns the attribute set containing all inaccessible attributes**. Inaccessible attributes are attributes
+that aren't listed as accessible, which includes protected attributes and attributes for which the `attr_accessible` clause
+wasn't used.
+
+Example:
+
+```ruby
+  User.first.all_inaccessible_attributes
+  # =>  #<ActiveModel::AttributeSet: {"id", "password", "created_at", "updated_at"}> 
+```
+
+Be aware that this method requires that the used ORM has `accessible_attributes` data structure available for any model class.
+
+Instead of `all_inaccessible_attributes` you may also use the alias:
+
+  * `inaccessible_attributes_set`
+
 #### `filtered_attribute(attribute_name)` ####
 
 The [`filtered_attribute`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters:filtered_attribute)
@@ -496,6 +573,9 @@ Examples:
   # => #<ActiveModel::AttributeSet: {"username", "email"}>
 ```
 
+Be aware that calling these methods causes model object to be validated. The required condition
+to use these methods is the ORM that has `errors` hash (Active Record has it).
+
 #### Querying attributes for set names ####
 
 Querying attributes to know sets they belong to uses one
@@ -583,6 +663,29 @@ with question mark. Otherwise you may get false positives
 or a strange errors when trying to test if attribute belongs
 to a set. The real method call will override your check.
 
+##### Set accessibility querying #####
+
+* **`accessible?`**
+* **`inaccessible?`**
+* **`protected?`**
+* **`is_accessible?`**
+* **`is_inaccessible?`**
+* **`is_protected?`**
+
+The methods above allow to you to test if certain attribute is accessible, inaccessible or protected.
+
+Examples:
+
+```ruby
+  u = User.first
+  u.the_attribute(:id).is.accessible?
+  # => false
+  u.the_attribute(:id).is.protected?
+  # => true
+  u.the_attribute(:id).is.inaccessible?
+  # => true
+```
+
 Attribute filters
 -----------------
 
@@ -825,6 +928,7 @@ Here is a list of the predefined filtering methods:
 * `upcase_attributes` (submodule: `Upcase` or `Case`)
 * `strip_attributes` (submodule: `Strip`)
 * `squeeze_attributes` (submodule: `Squeeze`)
+* `squish_attributes` (submodule: `Squish`)
 
 Example:
 
@@ -832,11 +936,11 @@ Example:
 class User < ActiveRecord::Base
   include ActiveModel::AttributeFilters::Common
   
-  the_attribute user:   [:should_be_stripped, :should_be_downcased  ]
-  the_attribute email:  [:should_be_stripped, :should_be_downcased  ]
-  the_attribute name:   [:should_be_stripped, :should_be_downcased, :should_be_titleized ]
+  the_attribute user:   [:should_be_squished, :should_be_downcased  ]
+  the_attribute email:  [:should_be_squished, :should_be_downcased  ]
+  the_attribute name:   [:should_be_squished, :should_be_downcased, :should_be_titleized ]
   
-  before_validation :strip_attributes
+  before_validation :squish_attributes
   before_validation :downcase_attributes
   before_validation :titleize_attributes
 end
@@ -846,20 +950,24 @@ or (better):
 
 ```ruby
 class User < ActiveRecord::Base
-  include ActiveModel::AttributeFilters::Common::Stip
+  include ActiveModel::AttributeFilters::Common::Squish
   include ActiveModel::AttributeFilters::Common::Downcase
   include ActiveModel::AttributeFilters::Common::Titleize
   
-  the_attribute user:   [:should_be_stripped, :should_be_downcased  ]
-  the_attribute email:  [:should_be_stripped, :should_be_downcased  ]
-  the_attribute name:   [:should_be_stripped, :should_be_downcased, :should_be_titleized ]
+  the_attribute user:   [:should_be_squished, :should_be_downcased  ]
+  the_attribute email:  [:should_be_squished, :should_be_downcased  ]
+  the_attribute name:   [:should_be_squished, :should_be_downcased, :should_be_titleized ]
   
-  before_validation :strip_attributes
+  before_validation :squished_attributes
   before_validation :downcase_attributes
   before_validation :titleize_attributes
 end
 ```
 
+See the
+[`ActiveModel::AttributeFilters::Common`](http://rubydoc.info/gems/attribute-filters/ActiveModel/AttributeFilters/Common)
+for detailed descriptions.
+
 Custom applications
 -------------------
 

data/lib/attribute-filters/attribute_set_attrquery.rb

@@ -15,6 +15,18 @@ module ActiveModel
     # that allows sweet constructs like:
     #   the_attribute(:x).is.in_set?
     class AttrQuery < Query
+      # Creates new query object.
+      # 
+      # @param set_object [AttributeSet] attribute set containing set names for which the query will be made
+      # @param am_object [Object] model object which has access to attributes (may be an instance of ActiveRecord or similar)
+      # @param attribute_name [Sting,Symbol] name of attribute the query is made for
+      def initialize(set_object, am_object, attribute_name)
+        @set_object = set_object
+        @am_object = am_object
+        @attribute_name = attribute_name.to_s
+        @next_method = nil
+      end
+
       # This is a proxy method that causes some calls to be
       # intercepted. Is allows to create semi-natural
       # syntax when querying attribute sets containing set names.
@@ -42,12 +54,23 @@ module ActiveModel
         when :are, :is, :one, :is_one, :in, :list, :be, :should,
              :the, :a, :sets, :in_sets, :set, :in_a_set, :in_set, :belongs_to
           self
+
         when :belongs_to?, :in?, :in_set?, :in_a_set?, :in_the_set?,
              :the_set?, :set?, :is_one_that?, :one_that?, :that?
           if args.present? && args.is_a?(::Array)
             args = args.map{ |a| a.to_sym if a.respond_to?(:to_sym) }
           end
           @set_object.include?(*args, &block)
+
+        when :accessible?, :is_accessible?
+          @am_object.all_accessible_attributes.include?(@attribute_name)
+
+        when :inaccessible?, :is_inaccessible?
+          @am_object.all_inaccessible_attributes.include?(@attribute_name)
+
+        when :protected?, :is_protected?
+          @am_object.all_protected_attributes.include?(@attribute_name)
+
         else
           set_name_str = method_sym.to_s.dup
           if !@set_object.respond_to?(method_sym) && set_name_str.slice!(/\?\z/) == '?'
@@ -63,7 +86,9 @@ module ActiveModel
         case name.to_sym
         when :are, :is, :one, :is_one, :in, :list, :be, :should, :the, :a, :sets, :in_sets,
              :set, :in_a_set, :in_set, :in?, :in_set?, :in_a_set?, :in_the_set?, :the_set?, :set?,
-             :is_one_that?, :one_that?, :that?, :belongs_to?, :belongs_to
+             :is_one_that?, :one_that?, :that?, :belongs_to?, :belongs_to,
+             :protected?, :is_protected?, :inaccessible?, :is_inaccessible?,
+             :accessible?, :is_accessible?
           true
         else
           @set_object.respond_to?(name) || name.to_s.slice(-1,1) == '?'

data/lib/attribute-filters/common_filters.rb

@@ -112,6 +112,22 @@ module ActiveModel
         end
       end
 
+      # Squeezes white characters in attributes, removes leading and trailing spaces and newlines.
+      module Squish
+        # Squeezes white characters in attributes, removes leading and trailing spaces and newlines.
+        # 
+        # The attrubutes to be squished are taken from the attribute set
+        # called +should_be_squished+. This method is safe to be
+        # used with multibyte strings (containing diacritics).
+        # 
+        # @return [void]
+        def squish_attributes
+          filter_attrs_from_set(:should_be_squished) do |atr|
+            atr.mb_chars.squish.to_s
+          end
+        end
+      end
+
       # Titleizes attributes.
       module Titleize
         # Titleizes attributes.

data/lib/attribute-filters/dsl_sets.rb

@@ -19,7 +19,9 @@ module ActiveModel
       base.extend ClassMethods
     end
 
-    # Returns the attribute set of the given name.
+    # Returns the attribute set of the given name or the set containing
+    # all attributes (if the argument is not given).
+    # 
     # @note The returned value is a duplicate. Adding or removing
     #  elements to it will have no effect. Altering attribute sets
     #  is possible on a class-level only, since attribute sets
@@ -27,8 +29,12 @@ module ActiveModel
     # 
     # @param set_name [Symbol] name of attribute set
     # @return [AttributeSet] attribute set
-    def attribute_set(set_name)
-      ActiveModel::AttributeSet::Query.new(self.class.attribute_set(set_name), self)
+    def attribute_set(set_name=nil)
+      if set_name.nil?
+        all_attributes
+      else
+        ActiveModel::AttributeSet::Query.new(self.class.attribute_set(set_name), self)
+      end
     end
     alias_method :attributes_that_are,        :attribute_set
     alias_method :from_attributes_that,       :attribute_set
@@ -48,6 +54,29 @@ module ActiveModel
     def all_attributes
       ActiveModel::AttributeSet::Query.new(AttributeSet.new(attributes.keys), self)
     end
+    alias_method :all_attributes_set, :all_attributes
+
+    # Returns a set containing all accessible attributes.
+    # @return [AttributeSet] attribute set
+    def all_accessible_attributes
+      all_attributes & self.class.accessible_attributes
+    end
+    alias_method :accessible_attributes_set, :all_accessible_attributes
+
+    # Returns a set containing all protected attributes.
+    # @return [AttributeSet] attribute set
+    def all_protected_attributes
+      all_attributes & self.class.protected_attributes
+    end
+    alias_method :protected_attributes_set, :all_protected_attributes
+
+    # Returns a set containing all attributes that are not accessible attributes.
+    # @return [AttributeSet] attribute set
+    def all_inaccessible_attributes
+      all_attributes - self.class.accessible_attributes
+    end
+    alias_method :all_non_accessible_attributes,  :all_inaccessible_attributes
+    alias_method :inaccessible_attributes_set,    :all_inaccessible_attributes
 
     # Gets all the defined attribute sets.
     # @note Use +key+ method explicitly to check if the given set exists. The hash returned by this method
@@ -71,7 +100,7 @@ module ActiveModel
     # @param attribute_name [Symbol] name of attribute set
     # @return [AttributeSet] attribute set
     def filtered_attribute(attribute_name)
-      ActiveModel::AttributeSet::AttrQuery.new(self.class.filter_attribute(attribute_name), self)
+      ActiveModel::AttributeSet::AttrQuery.new(self.class.filter_attribute(attribute_name), self, attribute_name)
     end
     alias_method :the_attribute,        :filtered_attribute
     alias_method :is_the_attribute,     :filtered_attribute

data/lib/attribute-filters/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribute-filters
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -48,11 +48,11 @@ cert_chain:
   -----END CERTIFICATE-----
 
 '
-date: 2012-08-04 00:00:00.000000000 Z
+date: 2012-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
-  requirement: &2163264920 !ruby/object:Gem::Requirement
+  requirement: &2168470740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -60,10 +60,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2163264920
+  version_requirements: *2168470740
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &2163264460 !ruby/object:Gem::Requirement
+  requirement: &2168470280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -71,10 +71,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2163264460
+  version_requirements: *2168470280
 - !ruby/object:Gem::Dependency
   name: hoe-yard
-  requirement: &2163264020 !ruby/object:Gem::Requirement
+  requirement: &2168469840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -82,10 +82,10 @@ dependencies:
         version: 0.1.2
   type: :development
   prerelease: false
-  version_requirements: *2163264020
+  version_requirements: *2168469840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2163263540 !ruby/object:Gem::Requirement
+  requirement: &2168469360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -93,10 +93,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *2163263540
+  version_requirements: *2168469360
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2163263060 !ruby/object:Gem::Requirement
+  requirement: &2168468880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -104,10 +104,10 @@ dependencies:
         version: 0.8.2
   type: :development
   prerelease: false
-  version_requirements: *2163263060
+  version_requirements: *2168468880
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2163262620 !ruby/object:Gem::Requirement
+  requirement: &2168468440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -115,10 +115,10 @@ dependencies:
         version: 3.8.0
   type: :development
   prerelease: false
-  version_requirements: *2163262620
+  version_requirements: *2168468440
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2163262180 !ruby/object:Gem::Requirement
+  requirement: &2168468000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -126,10 +126,10 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *2163262180
+  version_requirements: *2168468000
 - !ruby/object:Gem::Dependency
   name: supermodel
-  requirement: &2163261740 !ruby/object:Gem::Requirement
+  requirement: &2168467560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -137,10 +137,10 @@ dependencies:
         version: 0.1.6
   type: :development
   prerelease: false
-  version_requirements: *2163261740
+  version_requirements: *2168467560
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2163261300 !ruby/object:Gem::Requirement
+  requirement: &2168467120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -148,10 +148,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2163261300
+  version_requirements: *2168467120
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2163277220 !ruby/object:Gem::Requirement
+  requirement: &2168466680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -159,10 +159,10 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *2163277220
+  version_requirements: *2168466680
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
-  requirement: &2163276780 !ruby/object:Gem::Requirement
+  requirement: &2168466240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -170,10 +170,10 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *2163276780
+  version_requirements: *2168466240
 - !ruby/object:Gem::Dependency
   name: hoe-gemspec
-  requirement: &2163276340 !ruby/object:Gem::Requirement
+  requirement: &2168465800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -181,10 +181,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2163276340
+  version_requirements: *2168465800
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &2163275900 !ruby/object:Gem::Requirement
+  requirement: &2168465360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -192,7 +192,7 @@ dependencies:
         version: '2.16'
   type: :development
   prerelease: false
-  version_requirements: *2163275900
+  version_requirements: *2168465360
 description: Concise way of filtering model attributes in Rails.
 email:
 - pw@gnu.org
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1784207712795011672
+      hash: 1058669619257225272
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: