Module: LiveCable

Defined in:
lib/live_cable.rb,
lib/live_cable/error.rb,
lib/live_cable/engine.rb,
lib/live_cable/testing.rb,
lib/live_cable/version.rb,
lib/live_cable/observer.rb,
lib/live_cable/component.rb,
lib/live_cable/container.rb,
lib/live_cable/delegator.rb,
lib/live_cable/connection.rb,
lib/live_cable/csrf_checker.rb,
lib/live_cable/configuration.rb,
lib/live_cable/model_observer.rb,
lib/live_cable/render_context.rb,
lib/live_cable/delegation/hash.rb,
lib/live_cable/component/events.rb,
lib/live_cable/delegation/array.rb,
lib/live_cable/delegation/model.rb,
lib/live_cable/observer_tracking.rb,
lib/live_cable/rendering/handler.rb,
lib/live_cable/rendering/partial.rb,
lib/live_cable/delegation/methods.rb,
lib/live_cable/rendering/compiler.rb,
lib/live_cable/rendering/renderer.rb,
lib/live_cable/component/lifecycle.rb,
lib/live_cable/component/rendering.rb,
lib/live_cable/component/streaming.rb,
lib/live_cable/connection/messaging.rb,
lib/live_cable/testing/render_state.rb,
lib/live_cable/testing/test_channel.rb,
lib/live_cable/component/broadcasting.rb,
lib/live_cable/testing/test_component.rb,
lib/live_cable/connection/broadcasting.rb,
lib/live_cable/rendering/render_result.rb,
lib/live_cable/component/identification.rb,
lib/live_cable/connection/error_handling.rb,
lib/live_cable/rendering/method_analyzer.rb,
lib/live_cable/rendering/method_collector.rb,
lib/live_cable/rendering/partial_renderer.rb,
lib/live_cable/connection/state_management.rb,
lib/live_cable/component/reactive_variables.rb,
lib/live_cable/rendering/dependency_visitor.rb,
lib/live_cable/connection/channel_management.rb,
lib/live_cable/testing/test_cable_connection.rb,
lib/live_cable/connection/component_management.rb,
lib/live_cable/rendering/method_dependency_visitor.rb,
lib/live_cable/component/method_dependency_tracking.rb,
lib/generators/live_cable/component/component_generator.rb

Defined Under Namespace

Modules: Delegation, Generators, ModelObserver, ObserverTracking, Rendering, Testing Classes: Component, Configuration, Connection, Container, CsrfChecker, Delegator, Engine, Error, Observer, RenderContext

Constant Summary collapse

VERSION = 
'0.2.0'

Class Method Summary collapse

Class Method Details

.configuration ⇒ Object 



21
22
23
 
# File 'lib/live_cable/configuration.rb', line 21

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



25
26
27
 
# File 'lib/live_cable/configuration.rb', line 25

def configure
  yield configuration
end

.instance_from_string(string, id) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/live_cable.rb', line 22

def self.instance_from_string(string, id)
  klass = Live
  klass_string = string.camelize

  begin
    klass_string.split('::').each do |part|
      unless klass.const_defined?(part)
        raise LiveCable::Error,
          "Component Live::#{klass_string} not found, make sure it is located in the Live:: module"
      end

      klass = klass.const_get(part)
    end
  rescue NameError
    raise LiveCable::Error, "Invalid component name \"#{string}\" - Live::#{klass_string} not found"
  end

  klass = "Live::#{klass_string}".safe_constantize

  unless klass < LiveCable::Component
    raise LiveCable::Error, 'Components must extend LiveCable::Component'
  end

  klass.new(id)
end