guide 0.0.1 → 0.5.0

data/app/models/guide/scout.rb

@@ -0,0 +1,59 @@
+class Guide::Scout
+  def initialize(starting_node)
+    @starting_node = starting_node
+
+    ensure_starting_node_exists
+  end
+
+  def visibility_along_path(node_path)
+    current_node = @starting_node
+    path_visibility = current_node.options[:visibility]
+
+    node_ids_along_path(node_path).each do |node_id|
+      current_node = current_node.child_nodes[node_id]
+      ensure_node_exists(current_node, node_id)
+      path_visibility = foggiest_visibility(path_visibility,
+                                            current_node.options[:visibility])
+    end
+
+    path_visibility
+  end
+
+  private
+
+  VISIBILITY_PRIORITY = {
+    nil => 0,
+    :unpublished => 1,
+    :restricted => 2,
+  }
+  private_constant :VISIBILITY_PRIORITY
+
+  def foggiest_visibility(first, second)
+    case
+    when VISIBILITY_PRIORITY[first] > VISIBILITY_PRIORITY[second]
+      first
+    when VISIBILITY_PRIORITY[first] < VISIBILITY_PRIORITY[second]
+      second
+    else
+      first
+    end
+  end
+
+  def node_ids_along_path(node_path)
+    @node_ids ||= node_path.split("/").map {|node_id| node_id.to_sym }
+  end
+
+  def ensure_node_exists(node, node_id)
+    unless node.present?
+      raise Guide::Errors::InvalidNode,
+        "I can't give you what you're looking for because a node in your path (#{node_id}) doesn't exist."
+    end
+  end
+
+  def ensure_starting_node_exists
+    unless @starting_node.present?
+      raise Guide::Errors::InvalidNode,
+        "I can't give you what you're looking for because the node that you told me to start from doesn't exist. This means that something is fundamentally wrong with your setup."
+    end
+  end
+end

data/app/models/guide/simulator.rb

@@ -0,0 +1,26 @@
+class Guide::Simulator
+  def initialize(structure, bouncer)
+    @structure = structure
+    @bouncer = bouncer
+  end
+
+  def fetch_scenario(scenario_id)
+    scenario(scenario_id).tap do |scenario|
+      ensure_user_can_access(scenario)
+    end
+  end
+
+  private
+
+  def scenario(scenario_id)
+    @structure.scenarios[scenario_id].tap do |scenario|
+      raise Guide::Errors::InvalidScenario unless scenario.present?
+    end
+  end
+
+  def ensure_user_can_access(scenario)
+    unless @bouncer.user_can_access?(scenario)
+      raise Guide::Errors::PermissionDenied
+    end
+  end
+end

data/app/models/guide/structure.rb

@@ -0,0 +1,75 @@
+class Guide::Structure < Guide::Node
+  def template
+    partial
+  end
+
+  def partial
+  end
+
+  def cell
+    nil
+  end
+
+  def layout_css_classes
+    {}
+  end
+
+  def formats
+    [:html]
+  end
+
+  def stylesheets
+    Guide.configuration.default_stylesheets_for_structures
+  end
+
+  def javascripts
+    Guide.configuration.default_javascripts_for_structures
+  end
+
+  def self.scenario(id, **options, &block)
+    private define_method(id, block)
+
+    scenario_definitions[id] = OpenStruct.new(
+      :name => id.to_s.titleize,
+      :options => OpenStruct.new(**options),
+    )
+  end
+
+  class_attribute :scenario_definitions
+
+  def self.inherited(sub_class)
+    sub_class.scenario_definitions = {}
+    super(sub_class)
+  end
+
+  def scenarios
+    @scenarios ||=
+    scenario_definitions.each.with_object({}) do |(id, scenario_definition), scenario_hash|
+      scenario_hash[id] = OpenStruct.new(
+        :name => scenario_definition.name,
+        :view_model => send(id),
+        :options => scenario_definition.options,
+      )
+    end
+  end
+
+  def layout_templates
+    {
+      :html => default_layout_template
+    }
+  end
+
+  def layout_view_model
+    Guide::ViewModel.new
+  end
+
+  def can_be_rendered?
+    true
+  end
+
+  private
+
+  def default_layout_template
+    Guide.configuration.default_layout_for_scenarios
+  end
+end

data/app/models/guide/view_model.rb

@@ -0,0 +1,37 @@
+class Guide::ViewModel < OpenStruct
+  def initialize(defaults = {}, overrides = {})
+    inappropriate_overrides = overrides.keys - defaults.keys
+    if inappropriate_overrides.any?
+      raise Guide::Errors::InterfaceViolation.new(
+        "You added the #{'method'.pluralize(inappropriate_overrides.size)} "\
+        "[#{inappropriate_overrides.join(", ")}] to the #{self.class.name} "\
+        "in your scenario that #{'is'.pluralize(inappropriate_overrides.size)} "\
+        "not included in its official declaration "\
+        "(maybe in the `view_model` method on your Structure)"
+      )
+    end
+
+    @guide_view_model_interface_methods = defaults.keys
+
+    super(defaults.merge(overrides))
+  end
+
+  def method_missing(method, *args, &block)
+    if respond_to?(method)
+      super
+    else
+      raise Guide::Errors::InterfaceViolation.new(
+        "You called a method '#{method}' from your template, "\
+        "but it does not exist on the #{self.class.name} in your Structure."
+      )
+    end
+  end
+
+  def guide_view_model_interface_methods
+    @guide_view_model_interface_methods
+  end
+
+  def to_ary
+    nil # because Cells calls ViewModel#flatten for some reason
+  end
+end

data/app/view_models/guide/layout_view.rb

@@ -0,0 +1,81 @@
+class Guide::LayoutView
+  attr_reader :active_node_visibility, :active_node_heritage, :active_node_title
+
+  def initialize(bouncer:,
+                 diplomat:,
+                 content_node:,
+                 active_node:,
+                 active_node_heritage:,
+                 active_node_visibility:,
+                 active_node_title:,
+                 authentication_system:,
+                 injected_html:)
+    @bouncer = bouncer
+    @diplomat = diplomat
+    @content_node = content_node
+    @active_node = active_node
+    @active_node_heritage = active_node_heritage
+    @active_node_visibility = active_node_visibility
+    @active_node_title = active_node_title
+    @authentication_system = authentication_system
+    @injected_html = injected_html
+  end
+
+  def active_node_name
+    @active_node.name
+  end
+
+  def on_homepage?
+    @active_node == @content_node
+  end
+
+  def injected_html
+    @injected_html.html_safe
+  end
+
+  def paths_to_visible_renderable_nodes
+    cartographer.draw_paths_to_visible_renderable_nodes(starting_node: @content_node)
+  end
+
+  def user_is_privileged?
+    @bouncer.user_is_privileged?
+  end
+
+  def user_signed_in?
+    @authentication_system.user_signed_in?
+  end
+
+  def url_for_sign_in
+    @authentication_system.url_for_sign_in
+  end
+
+  def url_for_sign_out
+    @authentication_system.url_for_sign_out
+  end
+
+  def supported_locales
+    @diplomat.supported_locales
+  end
+
+  def show_locale_switcher?
+    @bouncer.user_is_privileged? && @diplomat.multiple_supported_locales?
+  end
+
+  def current_locale
+    @diplomat.current_locale
+  end
+
+  def locale_param
+    'locale'
+  end
+
+  def show_image_logo?
+    Guide.configuration.asset_path_for_logo.present?
+  end
+
+  private
+
+  def cartographer
+    @cartographer ||= Guide::Cartographer.new(@bouncer)
+  end
+end

data/app/view_models/guide/navigation_view.rb

@@ -0,0 +1,25 @@
+class Guide::NavigationView
+  delegate :id, :name, :leaf_node?, :to => :@node
+
+  def initialize(bouncer:, node:, active_node:)
+    @bouncer = bouncer
+    @node = node
+    @active_node = active_node
+  end
+
+  def child_node_views
+    @node.child_nodes.map do |child_node_id, child_node|
+      self.class.new(bouncer: @bouncer,
+                     node: child_node,
+                     active_node: @active_node)
+    end
+  end
+
+  def visible_to_user?
+    @bouncer.user_can_access?(@node)
+  end
+
+  def active?
+    @node == @active_node
+  end
+end

data/app/view_models/guide/node_view.rb

@@ -0,0 +1,59 @@
+class Guide::NodeView
+  delegate :id,
+    :options,
+    :name,
+    :formats,
+    :cell,
+    :template,
+    :layout_css_classes,
+    :node_type,
+    :can_be_rendered?,
+    :view_model, :to => :@node
+
+  attr_reader :node_path
+
+  def initialize(node:, bouncer:, diplomat:, node_path:)
+    @node = node
+    @bouncer = bouncer
+    @diplomat = diplomat
+    @node_path = node_path
+  end
+
+  def visible_scenarios
+    @node.scenarios.select do |scenario_id, scenario|
+      @bouncer.user_can_access?(scenario)
+    end
+  end
+
+  def multiple_formats?
+    @node.formats.size > 1
+  end
+
+  def uses_cells?
+    cell.present?
+  end
+
+  def template_location
+    template || cell
+  end
+
+  def user_is_privileged?
+    @bouncer.user_is_privileged?
+  end
+
+  def supported_locales
+    @diplomat.supported_locales
+  end
+
+  def show_locale_switcher?
+    @bouncer.user_is_privileged? && @diplomat.multiple_supported_locales?
+  end
+
+  def current_locale
+    @diplomat.current_locale
+  end
+
+  def locale_param
+    'temp_locale'
+  end
+end

data/app/view_models/guide/scenario_layout_view.rb

@@ -0,0 +1,49 @@
+class Guide::ScenarioLayoutView
+  def initialize(node:, node_title:, scenario:, format:, injected_html:)
+    @node = node
+    @node_title = node_title
+    @scenario = scenario
+    @format = format
+    @injected_html = injected_html
+  end
+
+  def node_title
+    @node_title
+  end
+
+  def scenario_name
+    @scenario.name
+  end
+
+  def node_layout_template
+    @node.layout_templates[format] || Guide.configuration.default_layout_for_scenarios
+  end
+
+  def node_layout_view
+    @node.layout_view_model
+  end
+
+  def format
+    @format
+  end
+
+  def inject_stylesheets?
+    @format == 'html'
+  end
+
+  def node_stylesheets
+    @node.stylesheets
+  end
+
+  def inject_javascripts?
+    @format == 'html'
+  end
+
+  def node_javascripts
+    @node.javascripts
+  end
+
+  def injected_html
+    @injected_html.html_safe
+  end
+end

data/app/view_models/guide/scenario_view.rb

@@ -0,0 +1,39 @@
+class Guide::ScenarioView
+  def initialize(node:, scenario:, format:)
+    @node = node
+    @scenario = scenario
+    @format = format
+  end
+
+  def uses_cells?
+    @node.cell.present?
+  end
+
+  def cell
+    @node.cell
+  end
+
+  def template
+    @node.template || @node.partial
+  end
+
+  def format
+    @format
+  end
+
+  def view
+    @scenario.view
+  end
+
+  def view_model
+    @scenario.view_model
+  end
+
+  def layout_css_classes
+    @node.layout_css_classes || ""
+  end
+
+  def wrapper_classes
+    @scenario.options.custom_wrapper_css || ""
+  end
+end