Module: Pinnable

Defined in:

lib/pinnable.rb,
lib/pinnable/engine.rb,
lib/pinnable/version.rb,
app/models/pinnable/pin.rb,
lib/pinnable/configuration.rb,
app/models/pinnable/comment.rb,
app/jobs/pinnable/application_job.rb,
app/services/pinnable/add_comment.rb,
app/services/pinnable/capture_pin.rb,
app/services/pinnable/resolve_pin.rb,
app/helpers/pinnable/widget_helper.rb,
app/models/pinnable/application_record.rb,
app/helpers/pinnable/application_helper.rb,
app/mailers/pinnable/application_mailer.rb,
app/controllers/pinnable/pins_controller.rb,
app/serializers/pinnable/marker_serializer.rb,
app/controllers/pinnable/markers_controller.rb,
app/controllers/pinnable/comments_controller.rb,
lib/generators/pinnable/install/install_generator.rb

Overview

Pinnable — a host-agnostic, mountable visual-feedback layer. Enable it for some users, flip a toggle, click any element on any page, leave a note. Notes remember who/where/which-element, re-anchor on reload, and are worked like a task list.

Everything the host differs on — auth, the gate, multitenancy, the audit sink — is injected through ‘Pinnable.config`, so the engine carries no app-specific coupling.

Defined Under Namespace

Modules: ApplicationHelper, Generators, WidgetHelper Classes: AddComment, ApplicationController, ApplicationJob, ApplicationMailer, ApplicationRecord, CapturePin, Comment, CommentsController, Configuration, Engine, MarkerSerializer, MarkersController, Pin, PinsController, ResolvePin

Constant Summary

VERSION =

"0.1.0"

Class Method Summary

• .config ⇒ Object
• .configure {|config| ... } ⇒ Object
• .reset_config! ⇒ Object

Class Method Details

.config ⇒ Object

# File 'lib/pinnable.rb', line 13

def config = @config ||= Configuration.new

.configure {|config| ... } ⇒ Object

Yields:

• (config)

# File 'lib/pinnable.rb', line 14

def configure = yield config

.reset_config! ⇒ Object

# File 'lib/pinnable.rb', line 15

def reset_config! = @config = Configuration.new