Table of Contents - peeky by appydave.com
Pages
- README
- STORIES
-
USAGE
- Peeky
- Usage
- Sample Classes
- Simple example
- Complex example
- Build Class Information
- Build ClassInfo
- Build ClassInfo - pre-loaded
- Render Class
- Render class interface using class_info
- Render class interface using an instance of the intended class
- Render Class Examples
- Class interface
- Class interface - YARD
- Debug class info
Classes and Modules
- Peeky
- Peeky::Api
- Peeky::AttrInfo
- Peeky::ClassInfo
- Peeky::Error
- Peeky::Example
- Peeky::Example::YardSample
- Peeky::MethodInfo
- Peeky::ParameterInfo
- Peeky::Predicates
- Peeky::Predicates::AttrReaderPredicate
- Peeky::Predicates::AttrWriterPredicate
- Peeky::Renderer
- Peeky::Renderer::ClassDebugRender
- Peeky::Renderer::ClassInterfaceRender
- Peeky::Renderer::ClassInterfaceYardRender
- Peeky::Renderer::MethodCallMinimumParamsRender
- Peeky::Renderer::MethodSignatureRender
- Peeky::Renderer::MethodSignatureWithDebugRender
Methods
- ::create — Peeky::AttrInfo
- ::from_method — Peeky::ParameterInfo
- ::from_parameter — Peeky::ParameterInfo
- ::new — Peeky::AttrInfo
- ::new — Peeky::ClassInfo
- ::new — Peeky::MethodInfo
- ::new — Peeky::ParameterInfo
- ::new — Peeky::Renderer::ClassDebugRender
- ::new — Peeky::Renderer::ClassInterfaceRender
- ::new — Peeky::Renderer::ClassInterfaceYardRender
- ::new — Peeky::Renderer::MethodCallMinimumParamsRender
- ::new — Peeky::Renderer::MethodSignatureRender
- ::new — Peeky::Renderer::MethodSignatureWithDebugRender
- #accessors — Peeky::ClassInfo
- #accessors_source_order — Peeky::ClassInfo
- #alpha_sort1 — Peeky::Example::YardSample
- #alpha_sort2 — Peeky::Example::YardSample
- #attribute_infos — Peeky::ClassInfo
- #build_class_info — Peeky::Api
- #class_details — Peeky::Renderer::ClassDebugRender
- #class_full_name — Peeky::ClassInfo
- #class_name — Peeky::ClassInfo
- #class_renderer — Peeky::Api
- #clean_name — Peeky::MethodInfo
- #d_do_something_method — Peeky::Example::YardSample
- #default_value_type — Peeky::ParameterInfo
- #e_method_with_required_param — Peeky::Example::YardSample
- #f_method_with_required_param_and_optional_param — Peeky::Example::YardSample
- #g_method_with_required_param_and_two_optional_params — Peeky::Example::YardSample
- #get_parameter — Peeky::MethodInfo
- #guard — Peeky::AttrInfo
- #guard_reader — Peeky::AttrInfo
- #guard_writer — Peeky::AttrInfo
- #h_list_of_optional_parameters — Peeky::Example::YardSample
- #i_method_with_two_required_params_and_list_of_optional_params — Peeky::Example::YardSample
- #infer_default_paramaters — Peeky::MethodInfo
- #infer_implementation_type — Peeky::MethodInfo
- #j_method_with_list_of_named_arguments — Peeky::Example::YardSample
- #jin — Peeky::Example::YardSample
- #k_method_with_block — Peeky::Example::YardSample
- #kv — Peeky::ClassInfo
- #kv — Peeky::Renderer::ClassDebugRender
- #l_method_with_key_value_param_required — Peeky::Example::YardSample
- #lj — Peeky::Renderer::ClassDebugRender
- #load — Peeky::ClassInfo
- #map — Peeky::ParameterInfo
- #match — Peeky::MethodInfo
- #match — Peeky::Predicates::AttrReaderPredicate
- #match — Peeky::Predicates::AttrWriterPredicate
- #method? — Peeky::MethodInfo
- #method_by_name — Peeky::ClassInfo
- #method_renderer — Peeky::Api
- #methods — Peeky::ClassInfo
- #methods_source_order — Peeky::ClassInfo
- #minimal_call_format — Peeky::ParameterInfo
- #minimal_call_format_ignore — Peeky::ParameterInfo
- #minimal_call_format_key_required — Peeky::ParameterInfo
- #minimal_call_format_param_required — Peeky::ParameterInfo
- #module_name — Peeky::ClassInfo
- #n_method_with_key_value_param_required_and_optional_key_value — Peeky::Example::YardSample
- #name — Peeky::AttrInfo
- #optional? — Peeky::MethodInfo
- #optional? — Peeky::ParameterInfo
- #p_available? — Peeky::Example::YardSample
- #prerequisites — Peeky::Predicates::AttrReaderPredicate
- #prerequisites — Peeky::Predicates::AttrWriterPredicate
- #q_danger_will_robinson! — Peeky::Example::YardSample
- #readable? — Peeky::MethodInfo
- #reader_by_name — Peeky::ClassInfo
- #readers — Peeky::ClassInfo
- #readers_source_order — Peeky::ClassInfo
- #render — Peeky::Renderer::ClassDebugRender
- #render — Peeky::Renderer::ClassInterfaceRender
- #render — Peeky::Renderer::ClassInterfaceYardRender
- #render — Peeky::Renderer::MethodCallMinimumParamsRender
- #render — Peeky::Renderer::MethodSignatureRender
- #render — Peeky::Renderer::MethodSignatureWithDebugRender
- #render_accessors — Peeky::Renderer::ClassDebugRender
- #render_accessors — Peeky::Renderer::ClassInterfaceRender
- #render_accessors — Peeky::Renderer::ClassInterfaceYardRender
- #render_class — Peeky::Api
- #render_debug_logic — Peeky::Renderer::MethodSignatureWithDebugRender
- #render_end — Peeky::Renderer::ClassInterfaceRender
- #render_end — Peeky::Renderer::ClassInterfaceYardRender
- #render_end — Peeky::Renderer::MethodSignatureRender
- #render_method — Peeky::Renderer::MethodSignatureWithDebugRender
- #render_methods — Peeky::Renderer::ClassDebugRender
- #render_methods — Peeky::Renderer::ClassInterfaceRender
- #render_methods — Peeky::Renderer::ClassInterfaceYardRender
- #render_paramaters — Peeky::Renderer::ClassDebugRender
- #render_readers — Peeky::Renderer::ClassDebugRender
- #render_readers — Peeky::Renderer::ClassInterfaceRender
- #render_readers — Peeky::Renderer::ClassInterfaceYardRender
- #render_signature — Peeky::Renderer::MethodSignatureRender
- #render_start — Peeky::Renderer::ClassInterfaceRender
- #render_start — Peeky::Renderer::ClassInterfaceYardRender
- #render_writers — Peeky::Renderer::ClassDebugRender
- #render_writers — Peeky::Renderer::ClassInterfaceRender
- #render_writers — Peeky::Renderer::ClassInterfaceYardRender
- #ruby_instance_method_names — Peeky::ClassInfo
- #ruby_instance_methods — Peeky::ClassInfo
- #signature_format — Peeky::ParameterInfo
- #signature_format_block — Peeky::ParameterInfo
- #signature_format_double_splat — Peeky::ParameterInfo
- #signature_format_key_optional — Peeky::ParameterInfo
- #signature_format_key_required — Peeky::ParameterInfo
- #signature_format_param_optional — Peeky::ParameterInfo
- #signature_format_param_required — Peeky::ParameterInfo
- #signature_format_splat — Peeky::ParameterInfo
- #signatures — Peeky::ClassInfo
- #signatures_by_clean_name — Peeky::ClassInfo
- #signatures_by_name — Peeky::ClassInfo
- #to_s — Peeky::ClassInfo
- #tracer — Peeky::MethodInfo
- #type — Peeky::AttrInfo
- #wrap_default_value — Peeky::ParameterInfo
- #writable? — Peeky::MethodInfo
- #writer_by_name — Peeky::ClassInfo
- #writers — Peeky::ClassInfo
- #writers_source_order — Peeky::ClassInfo
- #z_complex — Peeky::Example::YardSample
- #z_optional_styles — Peeky::Example::YardSample