rom-rb/rom Rom

Data mapping and persistence toolkit for Ruby

Refresh
#1436 (all)
Ruby (change)
50 seconds
about 17 hours ago

This page shows an evaluation of the project's documentation.

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
ROM::Repository::Root#aggregate N
A
ROM::Relation::ClassInterface#view N
A
ROM::Changeset::Stateful#map N
A
ROM::Relation::ClassInterface#schema N
A
ROM N
A
ROM::Relation#map_with N
A
ROM::Gateway.setup N
A
ROM::Transaction#rollback! N
A
ROM::Repository::ClassInterface#commands N
A
ROM::Relation::Materializable#to_a N
A
ROM::Relation::Materializable#one! N
A
ROM::Relation::Commands#command N
A
ROM::Changeset::Stateful#to_a N
A
ROM::Changeset::Stateful#to_h N
A
ROM::Memory::Dataset#insert N
A
ROM::Relation::Graph#nodes N
A
ROM::Relation::Loaded#one! N
A
ROM::Relation::Graph#root N
A
ROM::Attribute#inspect N
A
ROM::Attribute#aliased N
A
ROM::Schema#merge N
A
ROM::Relation N
A
ROM::Schema N
A
ROM::Plugins::Relation::Changeset::InstanceMethods#changeset Ne
A
ROM::Associations::Definitions::Abstract Ne
A
ROM::Schema::AssociationsDSL#one_to_many Ne
A
ROM::Notifications::Listener#subscribe Ne
A
ROM::Relation::Combined#combine_with Ne
A
ROM::InternalPluginRegistry#fetch Ne
A
ROM::Relation#struct_namespace Ne
A
ROM::Memory::Relation#project Ne
A
ROM::Memory::Dataset#project Ne
A
ROM::ConfigurationDSL#plugin Ne
A
ROM::Relation#combine_with Ne
A
ROM::Relation#wrap_around Ne
A
ROM::Commands::Graph#call Ne
A
ROM::Memory::Dataset#join Ne
A
ROM::Gateway#transaction Ne
A
ROM::Relation#combine Ne
A
ROM::Schema#exclude Ne
A
ROM::Schema#project Ne
A
ROM::Schema#append Ne
A
ROM::Relation#wrap Ne
A
ROM::Schema::DSL Ne
A
ROM::Attribute Ne
A
ROM::Plugins::Relation::Instrumentation::ClassInterface#instrument Ne
A
ROM::Plugins::Schema::Timestamps::DSL#timestamps Ne
A
ROM::Schema::DSL#associations Ne
A
ROM::Changeset::Stateful#extend Ne
A
ROM::AutoRegistrationStrategies::CustomNamespace#directory Ne
A
ROM::AutoRegistrationStrategies::CustomNamespace#namespace Ne
A
ROM::AutoRegistrationStrategies::WithNamespace#directory Ne
A
ROM::AutoRegistrationStrategies::NoNamespace#directory Ne
A
ROM::Associations::Definitions::Abstract#combine_keys Ne
A
ROM::Associations::Definitions::Abstract#foreign_key Ne
A
ROM::AutoRegistrationStrategies::NoNamespace#entity Ne
A
ROM::Plugins::Relation::Changeset::InstanceMethods Ne
A
ROM::Associations::Definitions::ManyToMany#through Ne
A
ROM::Associations::Definitions::Abstract#relation Ne
A
ROM::Associations::Definitions::Abstract#override Ne
A
ROM::Associations::Definitions::Abstract#target Ne
A
ROM::Associations::Definitions::Abstract#source Ne
A
ROM::Associations::Definitions::Abstract#result Ne
A
ROM::Associations::Definitions::Abstract#alias Ne
A
ROM::Associations::Definitions::Abstract#type Ne
A
ROM::Associations::Definitions::Abstract#view Ne
A
ROM::Associations::Definitions::Abstract#name Ne
A
ROM::AutoRegistrationStrategies::Base#file Ne
A
ROM::Initializer::InstanceMethods#options Ne
A
ROM::Lint::TestEnumerableDataset#dataset Ne
A
ROM::Associations::Abstract#combine_keys Ne
A
ROM::Notifications::Publisher#subscribe Ne
A
ROM::Changeset::Associated#associations Ne
A
ROM::Lint::EnumerableDataset#initialize Ne
A
ROM::Plugins::Relation::Instrumentation Ne
A
ROM::Associations::Abstract#foreign_key Ne
A
ROM::Plugins::Relation::RegistryReader Ne
A
ROM::Associations::Abstract#definition Ne
A
ROM::Associations::ManyToMany#through Ne
A
ROM::Associations::Abstract#relations Ne
A
ROM::Lint::TestEnumerableDataset#data Ne
A
ROM::AutoRegistration#component_dirs Ne
A
ROM::Relation::Materializable#first Ne
A
ROM::Repository::ClassInterface#[] Ne
A
ROM::Changeset::Associated#command Ne
A
ROM::Associations::Abstract#result Ne
A
ROM::Associations::Abstract#source Ne
A
ROM::Relation::Loaded#primary_keys Ne
A
ROM::Associations::Abstract#target Ne
A
ROM::CommandRegistry#relation_name Ne
A
ROM::CommandCompiler#notifications Ne
A
ROM::Relation::Curried#curry_args Ne
A
ROM::Lint::TestGateway#identifier Ne
A
ROM::Changeset::Associated#commit Ne
A
ROM::Associations::Abstract#view Ne
A
ROM::Plugins::Schema::Timestamps Ne
A
ROM::Repository#struct_namespace Ne
A
ROM::Lint::TestEnumerableDataset Ne
A
ROM::Associations::Abstract#name Ne
A
ROM::Changeset::Associated#left Ne
A
ROM::Relation::Graph#with_nodes Ne
A
ROM::Changeset::Stateful.extend Ne
A
ROM::Repository.relation_reader Ne
A
ROM::Repository::ClassInterface Ne
A
ROM::Changeset::Update#original Ne
A
ROM::AutoRegistration#directory Ne
A
ROM::AutoRegistration#namespace Ne
A
ROM::Associations::Abstract#key Ne
A
ROM::Relation::Curried#relation Ne
A
ROM::Associations::Abstract#as Ne
A
ROM::CommandCompiler#relations Ne
A
ROM::Lint::TestGateway#gateway Ne
A
ROM::Types::Methods#ForeignKey Ne
A
ROM::Relation::ClassInterface Ne
A
ROM::Associations::ManyToMany Ne
A
ROM::CommandRegistry#map_with Ne
A
ROM::CommandCompiler#commands Ne
A
ROM::CommandRegistry#compiler Ne
A
ROM::Schema::DSL#schema_class Ne
A
ROM::CommandCompiler#gateways Ne
A
ROM::CommandCompiler#registry Ne
A
ROM::Changeset::Stateful#data Ne
A
ROM::Relation::Materializable Ne
A
ROM::Memory::Commands::Delete Ne
A
ROM::Memory::Dataset#restrict Ne
A
ROM::Memory::Commands::Create Ne
A
ROM::Memory::Commands::Update Ne
A
ROM::Notifications::Publisher Ne
A
ROM::EnumerableDataset#to_ary Ne
A
ROM::Relation::Combined#node Ne
A
ROM::CommandCompiler#plugins Ne
A
ROM::CommandCompiler#adapter Ne
A
ROM::Relation::Curried#arity Ne
A
ROM::Relation::Loaded#to_ary Ne
A
ROM::Changeset::Stateful.map Ne
A
ROM::Associations::ManyToOne Ne
A
ROM::Associations::OneToMany Ne
A
ROM::CommandRegistry#mappers Ne
A
ROM::Notifications.event_bus Ne
A
ROM::Schema::AssociationsDSL Ne
A
ROM::Lint::EnumerableDataset Ne
A
ROM::Notifications::EventBus Ne
A
ROM::Notifications::Listener Ne
A
ROM::Schema::DSL#attr_class Ne
A
ROM::Repository#auto_struct Ne
A
ROM::Changeset#command_type Ne
A
ROM::Commands::Lazy::Create Ne
A
ROM::AutoRegistration#globs Ne
A
ROM::Commands::Lazy::Update Ne
A
ROM::Commands::Lazy::Delete Ne
A
ROM::Configurable#configure Ne
A
ROM::Relation::Curried#view Ne
A
ROM::Memory::Dataset#delete Ne
A
ROM::Relation::Combined.new Ne
A
ROM::Associations::Abstract Ne
A
ROM::AdapterNotPresentError Ne
A
ROM::CommandRegistry#mapper Ne
A
ROM::Changeset::Update#diff Ne
A
ROM::Memory::Dataset#order Ne
A
ROM::Changeset::Associated Ne
A
ROM::Pipeline::Operator#>> Ne
A
ROM::Attribute#to_read_ast Ne
A
ROM::Lint::TestGateway#uri Ne
A
ROM::Relation#associations Ne
A
ROM::Container#disconnect Ne
A
ROM::Repository#container Ne
A
ROM::Notifications::Event Ne
A
ROM::Schema::DSL#relation Ne
A
ROM::ElementNotFoundError Ne
A
ROM::Schema::DSL#inferrer Ne
A
ROM::CommandCompiler#meta Ne
A
ROM::Commands::Composite Ne
A
ROM::Schema::DSL#adapter Ne
A
ROM::Schema#associations Ne
A
ROM::Relation::Composite Ne
A
ROM::InvalidRelationName Ne
A
ROM::Container#relations Ne
A
ROM::Changeset::Stateful Ne
A
ROM::CommandCompiler#id Ne
A
ROM::Repository#inspect Ne
A
ROM::Relation::Combined Ne
A
ROM::Relation::Commands Ne
A
ROM::Container#commands Ne
A
ROM::Attribute#optional Ne
A
ROM::Changeset#relation Ne
A
ROM::Schema#primary_key Ne
A
ROM::Attribute#prefixed Ne
A
ROM::Container#gateways Ne
A
ROM::EnumerableDataset Ne
A
ROM::Container#mappers Ne
A
ROM::Changeset#inspect Ne
A
ROM::Attribute#wrapped Ne
A
ROM::Configuration#use Ne
A
ROM::Transformer.build Ne
A
ROM::Schema#attributes Ne
A
ROM::Registry#elements Ne
A
ROM::Relation::Curried Ne
A
ROM::Relation::ViewDSL Ne
A
ROM::Lint::TestGateway Ne
A
ROM::Relation#dataset Ne
A
ROM::AutoRegistration Ne
A
ROM::Changeset#commit Ne
A
ROM::Memory::Relation Ne
A
ROM::Schema#canonical Ne
A
ROM::Relation#mappers Ne
A
ROM::Relation#schemas Ne
A
ROM::Attribute#target Ne
A
ROM::Attribute#to_ast Ne
A
ROM::Attribute#source Ne
A
ROM::Relation::Loaded Ne
A
ROM::Repository::Root Ne
A
ROM::ConfigurationDSL Ne
A
ROM::CommandRegistry Ne
A
ROM::Memory::Gateway Ne
A
ROM::Relation#to_ast Ne
A
ROM::Relation::Graph Ne
A
ROM::Memory::Dataset Ne
A
ROM::Schema#inferrer Ne
A
ROM::Attribute#alias Ne
A
ROM::Relation#schema Ne
A
ROM::Gateway#adapter Ne
A
ROM::Types::Methods Ne
A
ROM::Attribute#name Ne
A
ROM::AssociationSet Ne
A
ROM::Registry#cache Ne
A
ROM::Attribute#meta Ne
A
ROM::Relation::Wrap Ne
A
ROM::Memory::Schema Ne
A
ROM::Attribute#type Ne
A
ROM::Gateway#logger Ne
A
ROM::Schema#prefix Ne
A
ROM::Schema#to_ast Ne
A
ROM::Relation#with Ne
A
ROM::Relation#name Ne
A
ROM::Lint::Gateway Ne
A
ROM::Schema#rename Ne
A
ROM::Changeset#new Ne
A
ROM::Notifications Ne
A
ROM::Attribute#key Ne
A
ROM::Schema#to_ary Ne
A
ROM::Relation#call Ne
A
ROM::Relation#new Ne
A
ROM::Lint::Linter Ne
A
ROM::Schema#name Ne
A
ROM::Struct#to_s Ne
A
ROM::Transformer Ne
A
ROM::Schema#to_h Ne
A
ROM::Schema#call Ne
A
ROM::Schema#wrap Ne
A
ROM::Relation#as Ne
A
ROM::OpenStruct Ne
A
ROM::Lint::Test Ne
A
ROM::Container Ne
A
ROM::Processor Ne
A
ROM::Global Ne
A
ROM::Setup Ne
A
ROM::Types Ne
A
ROM::Notifications::EventBus#initialize Ne
A
ROM::Lint::Gateway#initialize Ne
A
ROM::Relation::ClassInterface#relation_name Ne
A
ROM::Lint::Gateway#lint_transaction_support Ne
A
ROM::Lint::Gateway#lint_dataset_predicate Ne
A
ROM::Initializer::InstanceMethods#freeze Ne
A
ROM::Lint::EnumerableDataset#lint_each Ne
A
ROM::Lint::EnumerableDataset#lint_to_a Ne
A
ROM::Lint::Gateway#lint_adapter_reader Ne
A
ROM::Lint::Gateway#lint_dataset_reader Ne
A
ROM::Lint::Gateway#lint_gateway_setup Ne
A
ROM::Notifications::Publisher#trigger Ne
A
ROM::Lint::EnumerableDataset#dataset Ne
A
ROM::Relation::Materializable#each Ne
A
ROM::Notifications#register_event Ne
A
ROM::Lint::EnumerableDataset#data Ne
A
ROM::Associations::Abstract.new Ne
A
ROM::Lint::Gateway#identifier Ne
A
ROM::Notifications::Event#[] Ne
A
ROM::Repository.auto_struct Ne
A
ROM::Lint::Linter.each_lint Ne
A
ROM::Relation::Loaded#each Ne
A
ROM::Lint::Gateway#gateway Ne
A
ROM::Gateway#disconnect Ne
A
ROM::Lint::Gateway#uri Ne
A
ROM::Relation#map_to Ne
A
ROM::Schema::DSL#use Ne
A
ROM::Struct#fetch Ne
A
ROM::Relation#[] Ne
A
ROM::Relation::Combined#combine Ne
A
ROM::Relation::ViewDSL#relation Ne
A
ROM::Relation::ViewDSL#schema Ne
A
ROM::Commands::Lazy#combine Ne
A
ROM::Relation::Wrap#call Ne
A
ROM::Relation::Wrap#wrap Ne
A
ROM::Associations::Definitions::Abstract.new E
A
ROM::Schema::AssociationsDSL#many_to_many E
A
ROM::Associations::ManyToMany#join_assoc E
A
ROM::Associations::ManyToMany#target_key E
A
ROM::Associations::ManyToMany#source_key E
A
ROM::Schema::AssociationsDSL#many_to_one E
A
ROM::Associations::OneToMany#target_key E
A
ROM::Associations::ManyToOne#source_key E
A
ROM::Associations::ManyToOne#target_key E
A
ROM::Schema::AssociationsDSL#belongs_to E
A
ROM::Schema::AssociationsDSL#one_to_one E
A
ROM::Associations::OneToMany#source_key E
A
ROM::Schema::AssociationsDSL#has_one E
A
ROM::Repository::ClassInterface#new E
A
ROM::Associations::ManyToMany#call E
A
ROM::Associations::OneToMany#call E
A
ROM::Notifications::Event#payload E
A
ROM::Associations::ManyToOne#call E
A
ROM::Relation::Materializable#one E
A
ROM::Relation::ClassInterface#use E
A
ROM::Relation.struct_namespace E
A
ROM::Setup#auto_registration E
A
ROM::Relation::Loaded#pluck E
A
ROM::Relation::Curried#to_a E
A
ROM::Changeset.command_type E
A
ROM::Repository::Root.root E
A
ROM::Relation::Loaded#one E
A
ROM::Relation.auto_struct E
A
ROM::CommandCompiler#call E
A
ROM::Gateway#use_logger E
A
ROM::Changeset.relation E
A
ROM::Changeset::Create E
A
ROM::Lint::Linter#lint E
A
ROM::Relation.auto_map E
A
ROM::Changeset::Update E
A
ROM::Relation.gateway E
A
ROM::Gateway.adapter E
A
ROM::ArrayDataset E
A
ROM::Repository E
A
ROM::Schema#[] E
A
ROM::Changeset E
A
ROM::Gateway E
A
ROM::Struct E
A
ROM::Plugins::Command::Schema::ClassInterface#build E
A
ROM::Changeset::Associated#associate E
A
ROM::Relation::Graph#map_to E
A
ROM::Commands::Lazy#>> E
A
ROM::Associations::ManyToMany#foreign_key E
A
ROM::Relation::ClassInterface#set_schema! E
A
ROM::Associations::OneToMany#foreign_key E
A
ROM::Associations::ManyToOne#foreign_key E
A
ROM::Schema#finalize_associations! E
A
ROM::Plugins::Relation::Changeset E
A
ROM::Changeset::Stateful#command E
A
ROM::Changeset::Stateful#inspect E
A
ROM::Memory::Gateway#use_logger E
A
ROM::Relation::Combined#command E
A
ROM::Changeset::Create#command E
A
ROM::Memory::Gateway#logger E
A
ROM::PluginRegistryBase#[] E
A
ROM::Relation#to_a E
A
ROM::Relation#each E
A
ROM::Commands::Lazy::Delete#call E
A
ROM::Commands::Lazy::Update#call E
A
ROM::Commands::Lazy::Create#call E
A
ROM::Relation::Graph#map_with E
Please take a look
C
ROM::Relation#eager_load N

Let's raise the visibility of documentation in Open Source!

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

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

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.