Let's raise the visibility of code documentation in Ruby!
Inch CI is here! Make your own badge with the new CI service: http://inch-ci.org

thoughtbot/paperclip

Easy file attachment management for ActiveRecord – Read the documentation

This page shows an evaluation of the documentation of thoughtbot/paperclip.

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
Paperclip
A
Paperclip::Attachment
A
Paperclip::Thumbnail
A
Paperclip::Interpolations
A
Paperclip::Storage::S3
Show 45 more ...
A
Paperclip::Geometry
A
Paperclip::Interpolations::PluralCache#initialize
A
Paperclip::AttachmentRegistry#initialize
A
Paperclip::ContentTypeDetector#detect
A
Paperclip::AdapterRegistry#initialize
A
Paperclip::Attachment#uploaded_file
A
Paperclip::Storage::Filesystem
A
Paperclip::Geometry#resize_to
A
Paperclip::Interpolations.all
A
Paperclip::Attachment#errors
A
Paperclip::Shoulda::Matchers
A
Paperclip::Geometry#smaller
A
Paperclip::Geometry#larger
A
Paperclip::Geometry#to_s
A
Paperclip::Storage::Fog
A
Paperclip::Processor
A
Paperclip::Tempfile
A
Paperclip::Schema
A
Paperclip::Style
A
Paperclip::Thumbnail#transformation_command
A
Paperclip::Attachment#original_filename
A
Paperclip::Interpolations#fingerprint
A
Paperclip.missing_attachments_styles
A
Paperclip::TempfileEncoding#binmode
A
Paperclip::Attachment#content_type
A
Paperclip::Interpolations#basename
A
Paperclip::Style#processor_options
A
Paperclip::Attachment#fingerprint
A
Paperclip::Attachment#created_at
A
Paperclip::Attachment#updated_at
A
Paperclip::Geometry#auto_orient
A
Paperclip::Style#default_format
A
Paperclip::Attachment#time_zone
A
Paperclip::Attachment#destroy
A
Paperclip::Interpolations#id
A
Paperclip::Style#processors
A
Paperclip::Geometry#inspect
A
Paperclip::Attachment#save
A
Paperclip::Attachment#size
A
Paperclip::Geometry#aspect
A
Paperclip::Style#geometry
A
Paperclip::Style#whiny
A
Paperclip.options
A
Paperclip::Attachment#file?
A
Paperclip::Thumbnail#make
Proper documentation present
B
Paperclip::Attachment#reprocess!
B
Paperclip::Helpers#run
B
Paperclip:: #validates_attachment
B
Paperclip:: #do_not_validate_attachment_file_type
B
Paperclip:: #validates_media_type_spoof_detection
Show 50 more ...
B
Paperclip:: #validates_attachment_content_type
B
Paperclip:: #validates_attachment_file_name
B
Paperclip:: #validates_attachment_presence
B
Paperclip:: #validates_attachment_size
B
Paperclip::Interpolations.interpolate
B
Paperclip::Tempfile#make_tmpname
B
Paperclip::Attachment#clear
B
Paperclip::ClassMethods#has_attached_file
B
Paperclip::Attachment#initialize
B
Paperclip::Helpers#each_instance_with_attachment
B
Paperclip::Style#initialize
B
Paperclip::ProcessorHelpers#register_processor
B
Paperclip::Interpolations#rails_root
B
Paperclip::Interpolations#rails_env
B
Paperclip::Interpolations#filename
B
Paperclip::Interpolations#style
B
Paperclip::Interpolations#param
B
Paperclip:: #validate_attachment_content_type
B
Paperclip:: #validate_attachment_presence
B
Paperclip::Shoulda::Matchers#validate_attachment_size
B
Paperclip::Interpolations#content_type_extension
B
Paperclip::Shoulda::Matchers#have_attached_file
B
Paperclip::Interpolations#dotextension
B
Paperclip::Interpolations#id_partition
B
Paperclip::Geometry#transformation_to
B
Paperclip::Interpolations#updated_at
B
Paperclip::Attachment#instance_write
B
Paperclip::Interpolations#attachment
B
Paperclip::Interpolations#extension
B
Paperclip::Interpolations#timestamp
B
Paperclip::Attachment#instance_read
B
Paperclip::Attachment#expiring_url
B
Paperclip::Attachment#staged_path
B
Paperclip::Interpolations#class
B
Paperclip::Attachment#hash_key
B
Paperclip::Interpolations#hash
B
Paperclip::Geometry#initialize
B
Paperclip::Processor#identify
B
Paperclip::Geometry.from_file
B
Paperclip::Interpolations.[]=
B
Paperclip::Interpolations.[]
B
Paperclip::Processor#convert
B
Paperclip::Attachment#assign
B
Paperclip::Attachment#to_s
B
Paperclip::Attachment#path
B
Paperclip::Attachment#url
B
Paperclip::Geometry.parse
B
Paperclip::Logger#log
B
Paperclip::Style#[]
B
Paperclip::Thumbnail#initialize
Needs work
C
Paperclip::Helpers#configure
Undocumented
U
Paperclip:: #check_validity!
U
Paperclip:: #check_validity!
U
Paperclip:: #check_validity!
U
Paperclip::Helpers#reset_duplicate_clash_check!
U
Paperclip::ProcessorHelpers#clear_processors!
Show 274 more ...
U
Paperclip.save_current_attachments_styles!
U
PaperclipGenerator
U
Paperclip:: #failure_message_when_negated
U
Paperclip:: #failure_message_when_negated
U
Paperclip:: #failure_message_when_negated
U
Paperclip:: #rejecting
U
Paperclip:: #allowing
U
Paperclip:: #define_paperclip_callbacks
U
Paperclip::Callbacks::Running#run_paperclip_callbacks
U
Paperclip::Schema::TableDefinition#has_attached_file
U
Paperclip::Schema::CommandRecorder#add_attachment
U
Paperclip::Schema::Statements#drop_attached_file
U
Paperclip::Schema::Statements#remove_attachment
U
Paperclip::Schema::TableDefinition#attachment
U
Paperclip::AttachmentRegistry.each_definition
U
Paperclip::Schema::Statements#add_attachment
U
Paperclip::AdapterRegistry#register
U
Paperclip::Helpers#interpolates
U
Paperclip:: #failure_message
U
Paperclip:: #failure_message
U
Paperclip:: #description
U
Paperclip:: ::AttachmentFileTypeIgnoranceValidator.helper_method_name
U
Paperclip:: #initialize
U
Paperclip:: #failure_message
U
Paperclip:: #description
U
Paperclip:: #override_method
U
Paperclip:: #initialize
U
Paperclip:: #validate_each
U
Paperclip:: #validate_blacklist
U
Paperclip:: #validate_whitelist
U
Paperclip:: ::AttachmentContentTypeValidator.helper_method_name
U
Paperclip:: #greater_than
U
Paperclip:: #description
U
Paperclip:: #initialize
U
Paperclip:: ::AttachmentFileNameValidator.helper_method_name
U
Paperclip:: #less_than
U
Paperclip:: #validate_whitelist
U
Paperclip:: #validate_blacklist
U
Paperclip:: #forbidden_types
U
Paperclip:: #failure_message
U
Paperclip:: #validate_each
U
Paperclip:: ::AttachmentPresenceValidator.helper_method_name
U
Paperclip:: #create_validating_before_filter
U
Paperclip:: #validate_each
U
Paperclip:: #allowed_types
U
Paperclip:: ::ValidateAttachmentContentTypeMatcher
U
Paperclip:: #mark_invalid
U
Paperclip:: #description
U
Paperclip:: ::AttachmentSizeValidator.helper_method_name
U
Paperclip:: #initialize
U
Paperclip:: #validate_each
U
Paperclip:: #validate_each
U
Paperclip:: #initialize
U
Paperclip:: ::ValidateAttachmentPresenceMatcher
U
Paperclip:: #attachment_definitions
U
Paperclip:: #mark_invalid
U
Paperclip:: #underscore_and_pluralize
U
Paperclip:: #in
U
Paperclip:: #validate_before_processing
U
Paperclip:: #initialize
U
Paperclip:: #forbidden
U
Paperclip:: #validate_each
U
Paperclip:: ::ValidateAttachmentSizeMatcher
U
Paperclip:: ::AttachmentFileTypeIgnoranceValidator
U
Paperclip:: #allowed
U
Paperclip:: #initialize
U
Paperclip::Validators::MediaTypeSpoofDetectionValidator
U
Paperclip::Shoulda::Matchers::HaveAttachedFileMatcher
U
Paperclip::Validators::AttachmentContentTypeValidator
U
Paperclip::UploadedFileAdapter.content_type_detector=
U
Paperclip::FileCommandContentTypeDetector#initialize
U
Paperclip::UploadedFileAdapter.content_type_detector
U
Paperclip::Validators::AttachmentPresenceValidator
U
Paperclip::Validators::AttachmentFileNameValidator
U
Paperclip::Storage::Filesystem#copy_to_local_file
U
Paperclip::Interpolations::PluralCache#pluralize
U
Paperclip::FileCommandContentTypeDetector#detect
U
Paperclip::AdapterRegistry#registered_handlers
U
Paperclip::Validators::AttachmentSizeValidator
U
Paperclip::AttachmentRegistry.definitions_for
U
Paperclip::AttachmentRegistry#definitions_for
U
Paperclip::AttachmentRegistry#each_definition
U
Paperclip::Storage::S3#obtain_s3_instance_for
U
Paperclip.registered_attachments_styles_path=
U
Paperclip::AbstractAdapter#original_filename=
U
Paperclip.registered_attachments_styles_path
U
Paperclip::MediaTypeSpoofDetector#initialize
U
Paperclip::AbstractAdapter#original_filename
U
Paperclip::Storage::Fog#copy_to_local_file
U
Paperclip::Storage::S3#http_proxy_password
U
Paperclip::ProcessorHelpers#load_processor
U
Paperclip::Thumbnail#source_file_options=
U
Paperclip::ContentTypeDetector#initialize
U
Paperclip::UploadedFileAdapter#initialize
U
Paperclip::Storage::Fog#parse_credentials
U
Paperclip::Attachment#source_file_options
U
Paperclip::FileCommandContentTypeDetector
U
Paperclip::Storage::S3#copy_to_local_file
U
Paperclip::Thumbnail#source_file_options
U
Paperclip::Storage::S3#parse_credentials
U
Paperclip::StringioAdapter#content_type=
U
Paperclip::EmptyStringAdapter#initialize
U
Paperclip::Storage::S3#set_storage_class
U
Paperclip::HasAttachedFile::ClassMethods
U
Paperclip::AttachmentAdapter#initialize
U
Paperclip::AbstractAdapter#content_type
U
Paperclip::AttachmentRegistry#names_for
U
Paperclip::Storage::S3#s3_storage_class
U
Paperclip::MediaTypeSpoofDetector.using
U
Paperclip::AttachmentRegistry.names_for
U
PaperclipGenerator#migration_class_name
U
Paperclip::Storage::Fog#fog_credentials
U
Paperclip::AdapterRegistry#handler_for
U
Paperclip::TempfileFactory#random_name
U
Paperclip::Attachment#queued_for_write
U
Paperclip::Interpolations::PluralCache
U
Paperclip::GeometryDetector#initialize
U
Paperclip::Interpolations.plural_cache
U
Paperclip::Storage::S3#set_permissions
U
Paperclip::Thumbnail#current_geometry=
U
Paperclip::AttachmentRegistry#register
U
Paperclip::Attachment#post_processing=
U
Paperclip::Storage::S3#http_proxy_user
U
Paperclip::Storage::S3#http_proxy_port
U
Paperclip::Storage::S3#http_proxy_host
U
Paperclip::AbstractAdapter#fingerprint
U
Paperclip::AttachmentRegistry.register
U
PaperclipGenerator#migration_file_name
U
Paperclip::Attachment.default_options
U
Paperclip::Storage::S3#s3_url_options
U
PaperclipGenerator#generate_migration
U
Paperclip::Storage::S3#s3_credentials
U
Paperclip::StringioAdapter#initialize
U
Paperclip::FilenameCleaner#initialize
U
Paperclip::Thumbnail#convert_options=
U
Paperclip::HasAttachedFile#initialize
U
Paperclip::Attachment#convert_options
U
Paperclip::Storage::Fog#flush_deletes
U
Paperclip::Thumbnail#current_geometry
U
Paperclip::Thumbnail#target_geometry=
U
Paperclip::Storage::S3#s3_permissions
U
Paperclip::Attachment#post_processing
U
Paperclip::Attachment#default_options
U
Paperclip::Thumbnail#target_geometry
U
Paperclip::Storage::Fog#expiring_url
U
Paperclip::Storage::S3#create_bucket
U
Paperclip::Storage::Fog#flush_writes
U
Paperclip::Thumbnail#convert_options
U
Paperclip::HasAttachedFile.define_on
U
Paperclip::Validators::HelperMethods
U
Paperclip::Style#source_file_options
U
Paperclip::Storage::S3#s3_host_alias
U
Paperclip::TempfileFactory#extension
U
Paperclip::GeometryParser#initialize
U
Paperclip::AttachmentRegistry#clear
U
Paperclip::Storage::S3#s3_interface
U
Paperclip::TempfileFactory#generate
U
Paperclip::Attachment#default_style
U
Paperclip::Validators::ClassMethods
U
Paperclip::UriAdapter#content_type=
U
Paperclip::TempfileFactory#basename
U
Paperclip::Storage::S3#expiring_url
U
Paperclip::AttachmentRegistry.clear
U
Paperclip::Storage::S3#s3_host_name
U
Paperclip::Storage::Fog#public_url
U
Paperclip::Schema::CommandRecorder
U
Paperclip::Schema::TableDefinition
U
Paperclip::Attachment#interpolator
U
Paperclip::Attachment#only_process
U
Paperclip::UrlGenerator#initialize
U
Paperclip::AbstractAdapter#inspect
U
Paperclip::Storage::S3#s3_protocol
U
Paperclip::Storage::Fog#fog_public
U
Paperclip::Storage::S3#bucket_name
U
Paperclip::MediaTypeSpoofDetector
U
Paperclip::Thumbnail#auto_orient=
U
PaperclipGenerator#migration_name
U
Paperclip::HasAttachedFile#define
U
Paperclip::FileAdapter#initialize
U
Paperclip::Attachment#processors
U
Paperclip::Storage::S3#s3_object
U
Paperclip::Processor#attachment=
U
Paperclip::Storage::Fog#fog_file
U
Paperclip::NilAdapter#initialize
U
Paperclip::Style#convert_options
U
Paperclip::UriAdapter#initialize
U
Paperclip::GeometryDetector#make
U
Paperclip::Thumbnail#auto_orient
U
Paperclip::Storage::S3#s3_bucket
U
Paperclip::FilenameCleaner#call
U
Paperclip::AbstractAdapter#read
U
Paperclip::Processor#initialize
U
Paperclip::AbstractAdapter#size
U
Paperclip::Processor#attachment
U
Paperclip::UploadedFileAdapter
U
PaperclipGenerator.source_root
U
Paperclip::Attachment#instance
U
Paperclip::AdapterRegistry#for
U
Paperclip::IdentityAdapter#new
U
Paperclip::Callbacks::Defining
U
Paperclip::Thumbnail#animated=
U
Paperclip::HttpUrlProxyAdapter
U
Paperclip::GeometryParser#make
U
Paperclip::ContentTypeDetector
U
Paperclip::EmptyStringAdapter
U
Paperclip::Schema::Statements
U
Paperclip::Callbacks::Running
U
Paperclip::Attachment#options
U
Paperclip::Interpolations#url
U
Paperclip::Attachment#as_json
U
Paperclip::Thumbnail#animated
U
Paperclip::Geometry#modifier=
U
Paperclip::Processor#options=
U
Paperclip::AttachmentRegistry
U
Paperclip::Thumbnail#format=
U
Paperclip::Helpers#class_for
U
Paperclip::AttachmentAdapter
U
Paperclip::Attachment#styles
U
Paperclip::Geometry#modifier
U
Paperclip::Processor#options
U
Paperclip::Geometry#height=
U
Paperclip::GeometryDetector
U
Paperclip::ProcessorHelpers
U
Paperclip::UrlGenerator#for
U
Paperclip::TempfileEncoding
U
Paperclip::Thumbnail#whiny=
U
Paperclip::Thumbnail#format
U
Paperclip::Style#attachment
U
Paperclip::Attachment#whiny
U
Paperclip::FilenameCleaner
U
Paperclip::Attachment#name
U
Paperclip::AdapterRegistry
U
Paperclip::Processor#file=
U
Paperclip::Thumbnail#whiny
U
Paperclip::AbstractAdapter
U
Paperclip::HasAttachedFile
U
Paperclip::TempfileFactory
U
Paperclip::IdentityAdapter
U
Paperclip::Geometry#width=
U
Paperclip::Geometry#height
U
Paperclip::StringioAdapter
U
Paperclip::Geometry#width
U
Paperclip::Logger#logger=
U
Paperclip::DataUriAdapter
U
Paperclip::Railtie.insert
U
Paperclip::Processor#file
U
Paperclip::GeometryParser
U
Paperclip::Processor.make
U
Paperclip::Processor#make
U
Paperclip::Style#format
U
Paperclip::ClassMethods
U
Paperclip::UrlGenerator
U
Paperclip.io_adapters=
U
Paperclip::FileAdapter
U
Paperclip.io_adapters
U
Paperclip::NilAdapter
U
Paperclip::UriAdapter
U
Paperclip::Style#name
U
Paperclip::Style#[]=
U
Paperclip::Callbacks
U
Paperclip::Helpers
U
Paperclip::Railtie
U
Paperclip::Logger
U
Paperclip::Glue
U
Paperclip:: #rejected_types_and_failures
U
Paperclip:: #accepted_types_and_failures
U
Paperclip:: #passes_validation_with_size
U
Paperclip:: #expected_attachment
U
Paperclip::NilAdapter#read
U
Paperclip::HttpUrlProxyAdapter#initialize
U
Paperclip::NilAdapter#original_filename
U
Paperclip::DataUriAdapter#initialize
U
Paperclip::NilAdapter#content_type
U
Paperclip::NilAdapter#size

Let's raise the visibility of documentation in Ruby!

This page is for thoughtbot/paperclip 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