cgriego / active_attr Goto Github PK

Create a YARD Handler for the .attribute DSL.

Handle doc comments for the attributes and overridden implementations with their own doc comments.

Verify compatibility with FactoryGirl's associations support.

http://thechangelog.com/post/3032074343/top-ten-reasons-why-i-wont-use-your-open-source-project

• Description
• Installation instructions
• Where to get help
• Contribution guidelines
• Contributor list
• Credits, Inspiration, Alternatives

Since attributes now have meaningful options, redefining an attribute should replace the attribute instead of being ignored.

Add travis config, hook, and a README.md with SSL build image.

Models have associations with other models, and attributes don't cover this case very well (especially when initializing a model with a deeply nested hash).

ActionPack will try to determine the attributes a model has by accessing the class method .attribute_names. One use case is in ParamsWrapper. ActiveRecord returns an Array of Strings.

Verify compatibility with FactoryGirl

This module will raise an exception when mass assigning attributes that include an unknown attribute.

Model will be reserved for a full-featured model while BasicModel is just the bare minimum to pass ActiveModel's lint.

Setup and backfill documentation using yard.

Class and instance logger accessors, default to Rails Logger.

Initialize should accept a block form

Similar to type casting, but it's conversion of the data instead of the type. For example, normalize Time/DateTime to UTC. Related is stripping fractional seconds.

An mostly all-in-one starting point, comes with what most people would expect to be built-in.

Defines #{attr}? and #attribute?

The behavior of these methods will be affected by Typecasting.

Instead of StrictMassAssignment being a module, change MassAssignment to use injectable behavior for dealing with unknown attributes. Allow a default behavior to be set on the class (overridden on subclasses and a global default on the module) and use options to override the behavior at call time.

Handle ActionPack's multi-parameter params for complex attributes that come from date fields and such.

Including MassAssignment should get you an #initialize(attributes) method and an #attributes= method that walks a hash and assigns values if the object responds to a setter for the key.

This means that right now you can't mix MassAssignment and Attributes together and both work.

1. I tried just calling super, and that works great in 1.9 but fails in 1.8 because Object#initialize in 1.8 doesn't accept any arguments while 1.9 will accept any number of arguments. 1.8 fails with ArgumentError.
2. I tried using alias method chaining, but as soon as the class defines its own #initialize then it overwrites the carefully chained initialization methods.
3. I tried and considered other things as well…
4. I think the best shot is to do alias method chaining inside of an anonymous Module similar to how ActiveModel::AttributeMethods works.

Not provided by ActiveModel, this is unique to each modeling library.

Activate all rspec matchers by requiring active_attr/rspec.

Validate compatibility with validates_timeliness

Makes a model schemaless model to allow undefined attributes to be written and read, similar to a struct.

Use ActiveModel::MassAssignmentSecurity, with its roles support, hooked into the MassAssignment methods.

Allow defaults to be defined for attributes. Support procs for lazy evaluation. Should be applied at initialization.

Actionpack's FormHelper depends on particular methods being present to work with nested/association attributes.

Offer typecasting by attribute. @attributes should stay in the raw form. Method for getting the attribute value from before typecasting should be available. Probably need to define #read_attribute_for_validation that reads the before typecast value.

.attribute(:attr_name, :type => Class)

Give the large amount of typecasting that could occur, it would be useful for the framework to cache the results of the conversion for types.

1. opt in
2. lifecycle methods to purge the cached conversions
3. block form to disable the action
4. block form to enable the action

Use ActiveModel::MassAssignmentSecurity, with its roles support, hooked into the MassAssignment methods.

Self explanatory

The bare bones required to pass ActiveModel's lint tests.

I debate the usefulness of this, but a module that provides an after_initialize callback will provide parity with ORMs and make it easier to hook into initialization for novice Ruby coders.

A matcher, and macros, for specifying ActiveAttr associations.

ActiveRecord calls this a DangerousAttributeError. Mongoid calls it an InvalidField.

Including Attributes gets you attribute definition with .attribute (no typecasting) with #{attr}, #{attr}=, #read_attribute, #write_attribute, and #attributes that utilize an internal @attributes instance variable.