metro-ld25 0.3.3

data/lib/metro/views/no_view.rb

@@ -0,0 +1,34 @@
+module Metro
+  module Views
+
+    class NoView
+
+      #
+      # A NoView is a last resort view which means this is will always will exist.
+      #
+      # @param [String] view_path the name of the view to find
+      # @return a true all the time as this is the last resort format.
+      #
+      def self.exists?(view_path)
+        true
+      end
+
+      #
+      # A NoView will return an empty Hash to provide compatibility with other view
+      # types.
+      #
+      def self.parse(view_path)
+        {}
+      end
+
+      #
+      # @return the file type format of this view.
+      #
+      def self.format
+        :none
+      end
+
+    end
+
+  end
+end

data/lib/metro/views/parsers.rb

@@ -0,0 +1,42 @@
+require_relative 'yaml_view'
+require_relative 'json_view'
+require_relative 'no_view'
+
+module Metro
+  module Views
+
+    module Parsers
+      extend self
+
+      #
+      # Register a view parser.
+      #
+      # A parser is any class or instance that responds to #exists?(view_path),
+      # #parse(view_path) and #format.
+      #
+      # @param [Parser] parser the parser to add to the list of available parsers.
+      #
+      def register(parser)
+        parsers.push parser
+      end
+
+      #
+      # @return [Array<Parsers>] an array of all the registered view parsers. The
+      #   last parser is the NoView parser.
+      #
+      def parsers
+        @parsers ||= []
+      end
+
+      def parsers_with_no_view_fallback
+        parsers + [ NoView ]
+      end
+
+    end
+
+    Parsers.register YAMLView
+    Parsers.register JSONView
+
+  end
+end
+

data/lib/metro/views/scene_view.rb

@@ -0,0 +1,107 @@
+require_relative 'view'
+
+module Metro
+
+  #
+  # SceneView provides support for a Scene to have a view as well as giving
+  # additional tools to also help draw that view.
+  #
+  module SceneView
+
+    #
+    # A Scene by default uses the name of the Scene to find it's associated
+    # view.
+    #
+    # @example Standard View Name
+    #
+    #     class OpeningScene < Metro::Scene
+    #
+    #       def show
+    #         puts "View Brought To You By: #{view_name} # => View Brought To You By opening
+    #       end
+    #     end
+    #
+    # @example Custom View Name
+    #
+    #     class ClosingScene < Metro::Scene
+    #       view_name 'alternative'
+    #
+    #       def show
+    #         puts "View Brought To You By: #{view_name} # => View Brought To You By alternative
+    #       end
+    #     end
+    #
+    def view_name
+      self.class.view_name
+    end
+
+    #
+    # @return the view for this scene.
+    #
+    def view
+      self.class.view
+    end
+
+    #
+    # Loads and caches the view content based on the avilable view parsers and
+    # the view files defined.
+    #
+    # @return the content contained within the view
+    #
+    def view_content
+      view.content
+    end
+
+    #
+    # Saves the current content of the view back through the view's writer
+    #
+    def save_view
+      view.content = self.to_hash
+      view.save
+    end
+
+    #
+    # When the module is included insure that all the class helper methods are added
+    # at the same time.
+    #
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      #
+      # A Scene by default uses the name of the Scene to find it's associated
+      # view.
+      #
+      # @example Custom View Name
+      #
+      #     class ClosingScene < Metro::Scene
+      #       view_name 'alternative'
+      #     end
+      #
+      #     ClosingScene.view_name # => views/alternative
+      #
+      def view_name(name = nil)
+        name ? view.name = name : view.name
+        view.name
+      end
+
+      #
+      # Loads and caches the view content based on the avilable view parsers and
+      # the view files defined.
+      #
+      # @return a view object
+      #
+      def view
+        @view ||=begin
+          view = View.new
+          view.name = scene_name
+          view
+        end
+      end
+
+    end
+
+  end
+end

data/lib/metro/views/view.rb

@@ -0,0 +1,133 @@
+require_relative 'parsers'
+require_relative 'writers'
+
+module Metro
+
+  #
+  # A view represents the representation of the content found within
+  # the view file. A view has the ability to save/load the content
+  # as well.
+  #
+  class View
+
+    #
+    # The name of the view, which is used to influence the file path.
+    #
+    attr_accessor :name
+
+    #
+    # The content contained within the view.
+    #
+    def content
+      @content ||= begin
+        parsed_content = parse
+        parsed_content.default = {}
+        parsed_content
+      end
+    end
+
+    #
+    # Set the content of the view.
+    #
+    # @param [Hash] value the hash content that will represent this view
+    #
+    def content=(value)
+      value.default = {}
+      @content = value
+    end
+
+    #
+    # A Scene view path is based on the view name.
+    #
+    # @example Standard View Path
+    #
+    #     class OpeningScene < Metro::Scene
+    #     end
+    #
+    #     OpeniningScene.view_path # => views/opening
+    #
+    # @example Custom View Path
+    #
+    #     class ClosingScene < Metro::Scene
+    #       view_name 'alternative'
+    #     end
+    #
+    #     ClosingScene.view_path # => views/alternative
+    #
+    def view_path
+      File.join "views", name
+    end
+
+    #
+    # Parse the content found at the view path for the view.
+    #
+    # @return the hash of content stored within the view file.
+    #
+    def parse
+      parser.parse(view_path)
+    end
+
+    #
+    # The parser for this view is one of the supported parsers. A parser
+    # is selected if the parser is capable of finding the content to
+    # load.
+    #
+    def parser
+      @parser ||= supported_parsers.find { |parser| parser.exists? view_path }
+    end
+
+    #
+    # Supported view formats
+    #
+    def supported_parsers
+      Views::Parsers.parsers_with_no_view_fallback
+    end
+
+    #
+    # Ask the parser to save the current content of the view at the view path
+    #
+    def save
+      writer.write(view_path,content)
+    end
+
+    #
+    # Return the format of the view. By default the format of the view is dictated
+    # by the format of the content that is parsed.
+    #
+    def format
+      @format || parser.format
+    end
+
+    #
+    # Setting the format allows the view to be changed from the current format as
+    # dictated what is parsed by the parser.
+    #
+    # This is mostly to benefit the edit transition scene which inherits all the view
+    # related data from the scene that is being edited but does not inherit the
+    # the view (which would have the parser).
+    #
+    # @see EditTransitionScene
+    #
+    attr_writer :format
+
+    #
+    # The writer for this view. If the view has already been parsed then use
+    #
+    def writer
+      @writer ||= begin
+        writer_matching_existing_parser = supported_writers.find { |writer| writer.format == format }
+        writer_matching_existing_parser || default_writer
+      end
+    end
+
+    def supported_writers
+      Views::Writers.writers
+    end
+
+    def default_writer
+      Views::Writers.default_writer
+    end
+
+  end
+
+end

data/lib/metro/views/writers.rb

@@ -0,0 +1,43 @@
+require_relative 'yaml_view'
+require_relative 'json_view'
+
+module Metro
+  module Views
+
+    module Writers
+      extend self
+
+      #
+      # Register a view writer
+      #
+      # A writer is any class or instance that responds to #write(view_path,content),
+      # and #format.
+      #
+      # @param [Writer] writer the writer to add to the list of available writers..
+      #
+      def register(writer)
+        writers.push writer
+      end
+
+      #
+      # @return [Array<Writers>] an array of all the registered view writers.
+      #
+      def writers
+        @writers ||= []
+      end
+
+      #
+      # The default view writer, this is the one that will be used if no view
+      # can be found by the writers.
+      #
+      attr_accessor :default_writer
+
+    end
+
+    Writers.register YAMLView
+    Writers.register JSONView
+    Writers.default_writer = YAMLView
+
+  end
+end
+

data/lib/metro/views/yaml_view.rb

@@ -0,0 +1,94 @@
+require 'yaml'
+
+module Metro
+  module Views
+
+    class YAMLView
+
+      #
+      # Determine if a view exists for this specified format
+      #
+      # @param [String] view_path the name of the view to find
+      # @return a true if the yaml view exists and false if it does not exist.
+      #
+      def self.exists?(view_path)
+        yaml_view_paths(view_path).find { |view_path| File.exists? view_path }
+      end
+
+      #
+      # Parse the contents of the view given the name.
+      #
+      # @param [String] view_path the name of the view to read
+      # @return a Hash that contains the contents of the view.
+      #
+      def self.parse(view_path)
+        YAML.load(File.read(yaml_view_path(view_path))) or { }
+      end
+
+      #
+      # @return the file type format of this view.
+      #
+      def self.format
+        :yaml
+      end
+
+      #
+      # @param [String] view_path the file path to the view which to save the content
+      # @param [Hash] content the content to save within the view
+      #
+      def self.write(view_path,content)
+        filename = write_filepath(view_path)
+        yaml_content = content.to_yaml
+        File.write(filename,yaml_content)
+      end
+
+      #
+      # @return the default extension to use when saving yaml files.
+      #
+      def self.default_extname
+        @default_extname || ".yaml"
+      end
+
+      #
+      # Set the default extname
+      #
+      # @example
+      #
+      #     Metro::Views::YAMLView.default_extname = ".yml"
+      #
+      def self.default_extname=(value)
+        @default_extname = value
+      end
+
+      private
+
+      #
+      # If a file already exists with .yaml or .yml use that extension. Otherwise, we
+      # will fall back to the default extension name.
+      #
+      def self.write_filepath(view_path)
+        if existing_file = exists?(view_path)
+          existing_file
+        else
+          "#{view_path}#{default_extname}"
+        end
+      end
+
+      #
+      # A helper method to get the view file.
+      #
+      def self.yaml_view_path(view_path)
+        yaml_view_paths(view_path).find { |view_path| File.exists? view_path }
+      end
+
+      #
+      # A helper method to generate the name of the yaml view file. In this case
+      # it is the view name with the suffix `.yaml` or `.yml`.
+      #
+      def self.yaml_view_paths(view_path)
+        File.extname(view_path) == "" ? [ "#{view_path}.yaml", "#{view_path}.yml" ] : [ view_path ]
+      end
+    end
+
+  end
+end