Let's raise the visibility of code documentation in Ruby! What is this about?

kostyantyn/hydra_attribute

Implementation of EAV pattern for ActiveRecord models – Read the documentation

This page shows an evaluation of the documentation of kostyantyn/hydra_attribute.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
HydraAttribute
A
HydraAttribute:: #compile_select
A
HydraAttribute:: #where_not
A
HydraAttribute::Model::Persistence::ClassMethods#where
A
HydraAttribute::HydraAttributeSet#hydra_attribute
Show 78 more ...
A
HydraAttribute::HydraAttributeSet#hydra_set
A
HydraAttribute:: #register_nested_cache
A
HydraAttribute::Model::IdentityMap::ClassMethods#cache
A
HydraAttribute:: #get_from_nested_cache_or_load_all_models
A
HydraAttribute:: #define_cached_singleton_method
A
HydraAttribute:: #attributes_before_type_cast
A
HydraAttribute:: #define_attribute_methods
A
HydraAttribute:: #symbolized_columns_hash
A
HydraAttribute:: #define_attribute_method
A
HydraAttribute:: #attribute_methods_mutex
A
HydraAttribute:: #identity_map_cache_key
A
HydraAttribute:: #nested_identity_map
A
HydraAttribute:: #column_for_attribute
A
HydraAttribute:: #define_attribute_method
A
HydraAttribute:: #assign_attributes
A
HydraAttribute:: #select_manager
A
HydraAttribute:: #compile_update
A
HydraAttribute:: #compile_delete
A
HydraAttribute:: #compile_insert
A
HydraAttribute:: #identity_map
A
HydraAttribute:: #read_attribute
A
HydraAttribute:: #column_names
A
HydraAttribute:: #columns_hash
A
HydraAttribute:: #hydra_attributes_before_type_cast
A
HydraAttribute:: #destroy_all
A
HydraAttribute:: #attributes
A
HydraAttribute:: #table_name
A
HydraAttribute:: #arel_table
A
HydraAttribute:: #connection
A
HydraAttribute:: #hydra_attributes
A
HydraAttribute:: ::EntityModelIsNotPersistedError
A
HydraAttribute:: ::HydraAttributeIdIsMissedError
A
HydraAttribute:: #attributes
A
HydraAttribute:: #columns
A
HydraAttribute:: #destroy
A
HydraAttribute::Model::HasManyThrough::Relation#destroy
A
HydraAttribute::Model::Persistence::ClassMethods#update
A
HydraAttribute::HydraEntity#hydra_attribute_association
A
HydraAttribute::Model::Persistence::ClassMethods#create
A
HydraAttribute::Model::HasManyThrough::Relation#create
A
HydraAttribute::Model::HasManyThrough::Relation#build
A
HydraAttribute::Model::Persistence::ClassMethods#find
A
HydraAttribute::Model::Mediator::ClassMethods#observe
A
HydraAttribute::HydraEntity::ClassMethods#hydra_sets
A
HydraAttribute::Model::Persistence::ClassMethods#all
A
HydraAttribute::Model::Cacheable::ClassMethods#all
A
HydraAttribute::Model::HasManyThrough::Relation#<<
A
HydraAttribute::HydraValue#value_before_type_cast
A
HydraAttribute::HydraValue.delete_entity_values
A
HydraAttribute::Model::Mediator.subscriptions
A
HydraAttribute::Model::Persistence#initialize
A
HydraAttribute::Model::Persistence#attributes
A
HydraAttribute::HydraEntity#hydra_attributes
A
HydraAttribute::HydraValue#hydra_attribute
A
HydraAttribute::Model::Persistence#destroy
A
HydraAttribute::Model::Mediator.subscribe
A
HydraAttribute::Model::ClassMethods#count
A
HydraAttribute::Model::ClassMethods#first
A
HydraAttribute::Model::ClassMethods#last
A
HydraAttribute::Model::Persistence#save
A
HydraAttribute::Model::Mediator.notify
A
HydraAttribute::Model::Mediator#notify
A
HydraAttribute::HydraValue.arel_tables
A
HydraAttribute::HydraEntity#hydra_set
A
HydraAttribute::HydraValue.connection
A
HydraAttribute::Model::Mediator.clear
A
HydraAttribute::HydraValue#column
A
HydraAttribute::IdentityMap#cache
A
HydraAttribute::HydraValue#value=
A
HydraAttribute::HydraValue.column
A
HydraAttribute::HydraValue#save
A
HydraAttribute::HydraValue#id
A
HydraAttribute::HydraSet
A
HydraAttribute:: ::HydraEntityAttributeAssociation.generate_methods
A
HydraAttribute:: #hydra_attribute_association=
A
HydraAttribute::Model::Persistence#assign_attributes
A
HydraAttribute::Model::Dirty#save
A
HydraAttribute::HydraValue#initialize
Proper documentation present
B
HydraAttribute:: #delete_from_cache
B
HydraAttribute:: #update_cache
B
HydraAttribute:: #add_to_cache
B
HydraAttribute::Model::Persistence::ClassMethods#column
B
HydraAttribute::Model::Cacheable::ClassMethods#find
Show 3 more ...
B
HydraAttribute:: #execute_simple_calculation
B
HydraAttribute::Model::Cacheable#initialize
B
HydraAttribute::Model::Dirty#initialize
Needs work
C
HydraAttribute::Model::Persistence
Undocumented
U
HydraAttribute:: #delegate
U
HydraAttribute:: #where_with_hydra_attribute
U
HydraAttribute:: #migrate_to_hydra_entity
U
HydraAttribute:: #create_hydra_entity
U
HydraAttribute::Model::Persistence::ClassMethods
Show 100 more ...
U
HydraAttribute::HydraEntityAttributeAssociation
U
HydraAttribute::Migrator#migrate
U
HydraAttribute::Migrator#create
U
HydraAttribute::HydraValue
U
HydraAttribute.cache
U
HydraAttribute:: #initialize
U
HydraAttribute:: #hydra_attribute_by_name
U
HydraAttribute:: #initialize
U
HydraAttribute:: #hydra_attributes_before_type_cast
U
HydraAttribute:: #prepend_table_name
U
HydraAttribute:: #hydra_attribute_id
U
HydraAttribute:: #initialize
U
HydraAttribute:: #assign_hydra_value_options
U
HydraAttribute:: ::AttributeWasNotSelectedError
U
HydraAttribute:: #where_options
U
HydraAttribute:: #quote_columns
U
HydraAttribute:: ::Helper#build_joins
U
HydraAttribute:: ::Helper#connection
U
HydraAttribute:: ::Helper#initialize
U
HydraAttribute:: ::Helper#ref_table
U
HydraAttribute:: ::Helper#join_type
U
HydraAttribute:: ::Helper#ref_alias
U
HydraAttribute:: ::WrongProxyMethodError
U
HydraAttribute:: #initialize
U
HydraAttribute:: ::Helper#relation
U
HydraAttribute:: #initialize
U
HydraAttribute:: #hydra_value_options=
U
HydraAttribute:: ::PermissionSet
U
HydraAttribute:: #copy_initializer_file
U
HydraAttribute:: ::Helper#klass
U
HydraAttribute:: #rollback_from_hydra_entity
U
HydraAttribute:: #validate_each
U
HydraAttribute:: #hydra_attributes
U
HydraAttribute:: #build_arel
U
HydraAttribute:: #initialize
U
HydraAttribute:: ::Helper
U
HydraAttribute:: #hydra_values
U
HydraAttribute:: #has_many
U
HydraAttribute:: #relation
U
HydraAttribute:: #lock_values
U
HydraAttribute:: #initialize
U
HydraAttribute:: #scoped
U
HydraAttribute:: #initialize
U
HydraAttribute:: #records
U
HydraAttribute:: #drop_hydra_entity
U
HydraAttribute:: #initialize
U
HydraAttribute::Model::HasManyThrough::Relation#inspect
U
HydraAttribute::HydraEntityAttributeAssociation#destroy
U
HydraAttribute::ActiveRecord::AssociationPreloader#run
U
HydraAttribute::HydraEntityAttributeAssociation#entity
U
HydraAttribute::ActiveRecord::AssociationPreloader.run
U
HydraAttribute::HydraEntity::RelationDecorator#create
U
HydraAttribute::ActiveRecord::MassAssignmentSecurity
U
HydraAttribute::HydraEntity::RelationDecorator#build
U
HydraAttribute::ActiveRecord::Relation::QueryMethods
U
HydraAttribute::HydraEntityAttributeAssociation#save
U
HydraAttribute::Model::HasManyThrough::ClassMethods
U
HydraAttribute::ActiveRecord::Relation::Calculation
U
HydraAttribute::ActiveRecord::Scoping::ClassMethods
U
HydraAttribute::Model::Validations::UniqueValidator
U
HydraAttribute::ActiveRecord::Relation#exec_queries
U
HydraAttribute::ActiveRecord::ClassMethods#inspect
U
HydraAttribute::ActiveRecord::AssociationPreloader
U
HydraAttribute::Middleware::IdentityMap#initialize
U
HydraAttribute::Model::IdentityMap::ClassMethods
U
HydraAttribute::Model::HasManyThrough::Relation
U
HydraAttribute::HydraEntity::RelationDecorator
U
HydraAttribute::ActiveRecord::AttributeMethods
U
HydraAttribute::Model::Cacheable::ClassMethods
U
HydraAttribute::Model::Mediator::ClassMethods
U
HydraAttribute::Middleware::IdentityMap#call
U
HydraAttribute::Generators::InstallGenerator
U
HydraAttribute::ActiveRecord::ClassMethods
U
HydraAttribute::Model::Dirty::ClassMethods
U
HydraAttribute::Configuration.add_setting
U
HydraAttribute::HydraEntity::ClassMethods
U
HydraAttribute::Middleware::IdentityMap
U
HydraAttribute::ActiveRecord::Migration
U
HydraAttribute::ActiveRecord::Relation
U
HydraAttribute::ActiveRecord#inspect
U
HydraAttribute::Migrator#initialize
U
HydraAttribute::Model::ClassMethods
U
HydraAttribute::HydraAttributeSet
U
HydraAttribute::HydraValue#entity
U
HydraAttribute::Migrator#rollback
U
HydraAttribute::Model::Notifiable
U
HydraAttribute::Model::Cacheable
U
HydraAttribute::HydraValue#value
U
HydraAttribute::Model::Mediator
U
HydraAttribute::Configuration
U
HydraAttribute::Migrator#drop
U
HydraAttribute::ActiveRecord
U
HydraAttribute::Model::Dirty
U
HydraAttribute.identity_map
U
HydraAttribute::IdentityMap
U
HydraAttribute::HydraEntity
U
HydraAttribute::Migrator
U
HydraAttribute.config
U
HydraAttribute.setup
U
HydraAttribute:: #mass_assignment_authorizer

Let's raise the visibility of documentation in Ruby!

This page is for kostyantyn/hydra_attribute and is part of a project called "Inch Pages", showing documentation measurements provided by Inch. Inch Pages also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure!

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.

Fork me on GitHub