xumlidot 0.1.0 → 0.2.0

data/lib/xumlidot/parsers/scope.rb

@@ -5,13 +5,11 @@ require_relative '../types'
 
 module Xumlidot
   module Parsers
-
     # Save current visibility and restore it after processing
     module Scope
       # Maintains current state of method visability
       class Visibility
         class << self
-
           def state
             @state ||= :public
           end
@@ -30,13 +28,14 @@ module Xumlidot
         end
       end
 
-      def public(&block)
+      def public(&_block)
         temp_visibility = get_visibility
         set_visibility
         yield if block_given?
         set_visibility(temp_visibility)
       end
 
+      # rubocop:disable Naming/AccessorMethodName
       def set_visibility(state = :public)
         Visibility.send(state)
       end
@@ -44,11 +43,11 @@ module Xumlidot
       def get_visibility
         Visibility.state
       end
+      # rubocop:enable Naming/AccessorMethodName
 
-      module_function :set_visibility
-      module_function :get_visibility
-      module_function :public
+      module_function :set_visibility, :get_visibility, :public
+      # module_function :get_visibility
+      # module_function :public
     end
-
   end
 end

data/lib/xumlidot/parsers/stack.rb

@@ -31,12 +31,18 @@ module Xumlidot
         #
         # add(Module C, Module B)
         #
-        def add(c)
-          return if @nesting.constants.find_first(c)
+        def add(constant)
+          return if @nesting.constants.find_first(constant)
 
-          root = @nesting.constants.root_namespace_for(c)
-          (root.nil? ? @nesting.constants : root.constants) <<  c
-          @last_added = c
+          root = @nesting.constants.root_namespace_for(constant)
+          (root.nil? ? @nesting.constants : root.constants) << constant
+          @last_added = constant
+        end
+
+        def pop_last_added
+          return if @last_added.nil?
+
+          @last_added = @nesting.constants.root_namespace_for(@last_added)
         end
 
         class ExternalKlassReferences < Array
@@ -49,7 +55,9 @@ module Xumlidot
           end
         end
 
-        def resolve_inheritance(constant = nil)
+        # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
+        def resolve_inheritance(_constant = nil)
           external_klasses = ExternalKlassReferences.new
 
           # The first traversal we are going through finding all
@@ -64,9 +72,7 @@ module Xumlidot
             # If we reach here we have a superklass
             @nesting.constants.traverse do |other_klass|
               if other_klass.definition.superklass_of?(klass.definition.superklass)
-                if ::Xumlidot::Options.debug == true
-                  STDERR.puts "SETTING SUPERKLASS REFERENCE FOR #{klass} to #{other_klass}"
-                end
+                warn "SETTING SUPERKLASS REFERENCE FOR #{klass} to #{other_klass}" if ::Xumlidot::Options.debug == true
                 klass.superklass.reference = other_klass
                 break
               end
@@ -90,6 +96,8 @@ module Xumlidot
             end
           end
         end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/xumlidot/parsers.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'ruby_parser'
 require 'sexp_processor'
 require 'ostruct'
-require 'pry'
 
 require_relative 'parsers/generic'
 require_relative 'parsers/args'

data/lib/xumlidot/types/argument.rb

@@ -26,7 +26,7 @@ module Xumlidot
     class Argument
       attr_accessor :assign,
                     :default
-                    # :types # TODO: determine the type of the argument
+      # :types # TODO: determine the type of the argument
 
       attr_reader :name
 

data/lib/xumlidot/types/attribute.rb

@@ -6,7 +6,6 @@ module Xumlidot
   module Types
     # Value object for an attribute, i.e. accessor defined
     # via attr_reader, attr_writer or attribute
-    #
     class Attribute
       attr_accessor :read,
                     :write,
@@ -19,7 +18,7 @@ module Xumlidot
       end
 
       def to_s
-        "(#{accessibility}) #{@name}"
+        accessibility ? "(#{accessibility}) #{@name}" : @name
       end
 
       private

data/lib/xumlidot/types/constant.rb

@@ -11,16 +11,16 @@ module Xumlidot
     # name is a single constant, namespace is the remaining full path
     #
     # e.g
-    # For ::Xumlidot::Types::Constant tne name would be Constant and the
+    # For ::Xumlidot::Types::Constant the name would be Constant and the
     # namespace [Types, Xumlidot]
     #
-    # Note I am REALLY not happy with this design ...
+    # Note I am REALLY unhappy with this design ...
     class Constant
       attr_reader :name,
                   :namespace
 
-      attr_accessor :reference # TODO: What IS this? I think I may have thrown this
-                               # in to fix a traversal issue if so...hack!
+      # TODO: Appears unused, remove when specs complete
+      attr_accessor :reference # I think I may have thrown this in to fix a traversal issue if so...hack!
 
       def initialize(name, namespace = nil)
         @name = name

data/lib/xumlidot/types/constants.rb

@@ -17,8 +17,8 @@ module Xumlidot
 
         each do |k|
           k.constants.each do |klass|
-             found = klass.constants.find_first(constant)
-             return found unless found.nil?
+            found = klass.constants.find_first(constant)
+            return found unless found.nil?
           end
         end
         nil
@@ -36,6 +36,7 @@ module Xumlidot
         each do |k|
           k.constants.each do |klass|
             return klass if klass.definition.root_namespace_for?(constant)
+
             found = klass.constants.root_namespace_for(constant)
             return found unless found.nil?
           end

data/lib/xumlidot/types/klass.rb

@@ -46,13 +46,13 @@ module Xumlidot
         "#{definition} "
       end
 
-      def add_method(m)
-        m = m.definition if m.respond_to?(:definition)
+      def add_method(method_name)
+        method_name = method_name.definition if method_name.respond_to?(:definition)
 
-        if m.superclass_method == true
-          @class_methods << m
+        if method_name.superclass_method == true
+          @class_methods << method_name
         else
-          @instance_methods << m
+          @instance_methods << method_name
         end
       end
     end

data/lib/xumlidot/types/method_signature.rb

@@ -16,6 +16,12 @@ module Xumlidot
     # we store all the method details here including many
     # which we are not yet using.
     class MethodSignature
+      VISIBILITY_SYMBOLS = {
+        public: '+',
+        private: '-',
+        protected: '#'
+      }.freeze
+
       attr_accessor :name,               # symbol
                     :args,               # Arguments
                     :file,               # string
@@ -35,25 +41,11 @@ module Xumlidot
       private
 
       def clean_name
-        tmp = @name.is_a?(Regexp) ? @name.inspect : @name.to_s
-
-        case tmp
-        when '<<'
-          '&lt;&lt;'
-        else
-          tmp
-        end
+        @name.is_a?(Regexp) ? @name.inspect : @name.to_s
       end
 
       def visibility_symbol
-        case @visibility
-        when :public
-          '+'
-        when :private
-          '-'
-        when :protected
-          '#'
-        end
+        VISIBILITY_SYMBOLS[@visibility]
       end
 
       def klass

data/lib/xumlidot/types/superklass.rb

@@ -12,19 +12,19 @@ module Xumlidot
 
       def <<(constant)
         if constant == '::'
-          @has_root = true
+          @has_root = true # TODO: I don't see this used anywhere, remove?
           return
         end
 
         @namespace << constant unless @name.nil?
-        @name ||= constant
+        @name ||= constant # rubocop:disable Naming/MemoizedInstanceVariableName
       end
 
-      # Create a klass from the superclass for adding
-      # to the list of constants.
+      # Create a klass from the superclass for adding to the list of constants.
       def to_klass
         definition = KlassDefinition.new
         definition.name << ::Xumlidot::Types::Constant.new(@name, @namespace)
+
         Klass.new(definition)
       end
     end

data/lib/xumlidot/types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'types/method'
 require_relative 'types/methods'
 require_relative 'types/instance_methods'
@@ -13,6 +15,5 @@ require_relative 'types/method_signature'
 require_relative 'types/constants'
 require_relative 'types/module_definition'
 require_relative 'types/module'
-require_relative 'types/klass'
 require_relative 'types/attribute'
 require_relative 'types/attributes'

data/lib/xumlidot.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rubygems'
 require 'fileutils'
 
@@ -5,6 +6,7 @@ require_relative 'xumlidot/directory_tree'
 require_relative 'xumlidot/parsers'
 require_relative 'xumlidot/diagram'
 require_relative 'xumlidot/options'
+require_relative 'xumlidot/loader'
 
 module Xumlidot
 end

data/spec/spec_helper.rb

@@ -1,2 +1,21 @@
-require_relative '../lib/xumlidot/types'
-require_relative '../lib/xumlidot/parsers'
+# frozen_string_literal: true
+
+require_relative '../lib/xumlidot'
+
+# Helpers, pass in the full directory path in order to
+# generate xmi/dot output
+def generate_dot(directory)
+  options = ::Xumlidot::Options.parse(['--dot'])
+  directories = [directory]
+  ::Xumlidot::Loader.new(directories, options).load
+  ::Xumlidot::ID.reset
+end
+
+# Hmmm, for the to work for xmi we're going to have
+# to make the id generation repeatable rather than random
+def generate_xmi(directory)
+  options = ::Xumlidot::Options.parse(['--xmi', '--debug-ids'])
+  directories = [directory]
+  ::Xumlidot::Loader.new(directories, options).load
+  ::Xumlidot::ID.reset
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xumlidot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Lee Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2022-03-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: zeus
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +146,7 @@ files:
 - lib/xumlidot/diagram/xmi/method.rb
 - lib/xumlidot/diagram/xmi/superklass.rb
 - lib/xumlidot/directory_tree.rb
+- lib/xumlidot/loader.rb
 - lib/xumlidot/options.rb
 - lib/xumlidot/parsers.rb
 - lib/xumlidot/parsers/args.rb
@@ -151,7 +180,8 @@ files:
 homepage: http://github.com/os6sense/xumlidot
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -160,14 +190,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: Generates DOT and XMI for Ruby and Rails UML Class Diagrams.