expressir 1.0.0 → 1.2.1

data/lib/expressir/express/hyperlink_formatter.rb

@@ -1,7 +1,21 @@
 module Expressir
   module Express
+    # Formatter module - format references as hyperlinks
+    # @example Include into Formatter subclass
+    #   formatter = Class.new(Expressir::Express::Formatter) do
+    #     include Expressir::Express::HyperlinkFormatter
+    #   end
     module HyperlinkFormatter
-      def format_expressions_simple_reference(node)
+      # @!visibility private
+      def self.included(mod)
+        if !mod.superclass.private_method_defined? :format_references_simple_reference
+          raise 'Missing method'
+        end
+      end
+
+      private
+
+      def format_references_simple_reference(node)
         return node.id unless node.base_path
 
         # find closest node with path

data/lib/expressir/express/model_visitor.rb

@@ -2,6 +2,7 @@ require "expressir/model"
 
 module Expressir
   module Express
+    # @abstract
     class ModelVisitor
       def visit(node)
         node.class.model_attrs.each do |variable|

data/lib/expressir/express/parser.rb

@@ -25,16 +25,19 @@ repo = visitor.visit(parse_tree)
 module Expressir
   module Express
     class Parser
-      def self.from_file(file, options = {})
-        skip_references = options[:skip_references]
-
+      # Parses Express file into an Express model
+      # @param [String] file Express file path
+      # @param [Boolean] skip_references skip resolving references
+      # @param [Boolean] include_source attach original source code to model elements
+      # @return [Model::Repository]
+      def self.from_file(file, skip_references: nil, include_source: nil)
         input = File.read(file)
 
         parser = ::ExpressParser::Parser.parse(input)
 
         parse_tree = parser.syntax()
 
-        visitor = Visitor.new(parser.tokens, options)
+        visitor = Visitor.new(parser.tokens, include_source: include_source)
         repository = visitor.visit(parse_tree)
 
         repository.schemas.each do |schema|
@@ -49,19 +52,22 @@ module Expressir
         repository
       end
 
-      def self.from_files(files, options = {})
-        skip_references = options[:skip_references]
-
+      # Parses Express files into an Express model
+      # @param [Array<String>] files Express file paths
+      # @param [Boolean] skip_references skip resolving references
+      # @param [Boolean] include_source attach original source code to model elements
+      # @return [Model::Repository]
+      def self.from_files(files, skip_references: nil, include_source: nil)
         schemas = files.each_with_index.map do |file, i|
           # start = Time.now
-          repository = self.from_file(file, options.merge(skip_references: true))
+          repository = self.from_file(file, skip_references: true)
           # STDERR.puts "#{i+1}/#{files.length} #{file} #{Time.now - start}"
           repository.schemas
         end.flatten
 
-        repository = Model::Repository.new({
+        repository = Model::Repository.new(
           schemas: schemas
-        })
+        )
 
         unless skip_references
           resolve_references_model_visitor = ResolveReferencesModelVisitor.new

data/lib/expressir/express/resolve_references_model_visitor.rb

@@ -5,17 +5,19 @@ module Expressir
   module Express
     class ResolveReferencesModelVisitor < ModelVisitor
       def visit(node)
-        if node.is_a? Model::Expressions::SimpleReference
-          visit_expressions_simple_reference(node)
+        if node.is_a? Model::References::SimpleReference
+          visit_references_simple_reference(node)
         end
 
         super
       end
 
-      def visit_expressions_simple_reference(node)
-        return if node.parent.is_a? Model::Expressions::AttributeReference
+      private
 
-        if node.parent.is_a? Model::InterfaceItem
+      def visit_references_simple_reference(node)
+        return if node.parent.is_a? Model::References::AttributeReference
+
+        if node.parent.is_a? Model::Declarations::InterfaceItem
           base_item = node.find("#{node.parent.parent.schema.id}.#{node.parent.ref.id}")
         else
           base_item = node.find(node.id)

data/lib/expressir/express/schema_head_formatter.rb

@@ -1,8 +1,22 @@
 module Expressir
   module Express
+    # Formatter module - format schema as schema head only
+    # @example Include into Formatter subclass
+    #   formatter = Class.new(Expressir::Express::Formatter) do
+    #     include Expressir::Express::SchemaHeadFormatter
+    #   end
     module SchemaHeadFormatter
-      def format_schema(node)
-        format_schema_head(node)
+      # @!visibility private
+      def self.included(mod)
+        if !mod.superclass.private_method_defined? :format_declarations_schema or !mod.superclass.private_method_defined? :format_declarations_schema_head
+          raise 'Missing method'
+        end
+      end
+
+      private
+
+      def format_declarations_schema(node)
+        format_declarations_schema_head(node)
       end
     end
   end