xumlidot 0.1.0

data/lib/xumlidot/types/klass_definition.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    # representation for class information
+    class KlassDefinition
+      # TODO: I think the name could be a constant rather than an array of
+      # constants
+      class Name < Array
+        def name
+          map(&:name).flatten
+        end
+
+        def namespace
+          map(&:namespace).flatten
+        end
+
+        def ==(other)
+          namespace == other.namespace &&
+            name == other.name
+        end
+      end
+
+      attr_accessor :name,
+                    :superklass,
+                    :inherited_modules
+
+      def initialize
+        @name = Name.new
+        @superklass = Superklass.new(nil)
+        @inherited_modules = []
+      end
+
+      def to_s
+        "KLASS: #{@name.first} < #{@superklass} "
+      end
+
+      # No need to compare namespaces here since that is done in the
+      # name
+      def ==(other)
+        @name == other.name
+      end
+
+      # Returns true or false depending on whether or not, given the
+      # definition for the class, it can be considered the root namespace of
+      # the other class.
+      #
+      #  This allows us to work out is this is a klass under which the other
+      #  class should be nested in a class or module namespace heirarchy.
+      def root_namespace_for?(other)
+        [@name.name, @name.namespace].flatten == other.definition.name.namespace
+      end
+
+      def superklass_of?(other)
+        [@name.name, @name.namespace].flatten == [other.name, other.namespace].flatten
+      end
+    end
+  end
+end

data/lib/xumlidot/types/klass_methods.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    class KlassMethods < Methods
+    end
+  end
+end

data/lib/xumlidot/types/method.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    class Method
+    end
+  end
+end

data/lib/xumlidot/types/method_signature.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    # Container class
+    class MethodSignatures < Array
+      def to_s
+        each.map(&:to_s).join(', ')
+      end
+    end
+
+    # Value object for a method
+    #
+    # we store all the method details here including many
+    # which we are not yet using.
+    class MethodSignature
+      attr_accessor :name,               # symbol
+                    :args,               # Arguments
+                    :file,               # string
+                    :line_number,        # int  - these are areally a range
+                    :line_max,
+                    :visibility,         # symbol - :public, :private, or :protected
+                    :superclass_method   # true or false
+
+      def initialize
+        @superclass_method = false
+      end
+
+      def to_s
+        "#{klass} #{visibility_symbol} #{clean_name}(#{@args})"
+      end
+
+      private
+
+      def clean_name
+        tmp = @name.is_a?(Regexp) ? @name.inspect : @name.to_s
+
+        case tmp
+        when '<<'
+          '&lt;&lt;'
+        else
+          tmp
+        end
+      end
+
+      def visibility_symbol
+        case @visibility
+        when :public
+          '+'
+        when :private
+          '-'
+        when :protected
+          '#'
+        end
+      end
+
+      def klass
+        @superclass_method ? 'S' : 'I'
+      end
+    end
+  end
+end

data/lib/xumlidot/types/methods.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    class Methods < Array
+    end
+  end
+end

data/lib/xumlidot/types/module.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    # representation for module information
+    class Module < Klass
+    end
+  end
+end

data/lib/xumlidot/types/module_definition.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    # Contains information as to how the module was defined.
+    class ModuleDefinition < KlassDefinition
+      def to_s
+        "MODULE: #{@name.first}"
+      end
+    end
+  end
+end

data/lib/xumlidot/types/superklass.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../types'
+
+module Xumlidot
+  module Types
+    class Superklass < ::Xumlidot::Types::Constant
+      def initialize(name, namespace = nil)
+        super
+        @has_root = false
+      end
+
+      def <<(constant)
+        if constant == '::'
+          @has_root = true
+          return
+        end
+
+        @namespace << constant unless @name.nil?
+        @name ||= constant
+      end
+
+      # 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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require_relative '../lib/xumlidot/types'
+require_relative '../lib/xumlidot/parsers'

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: xumlidot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Lee Jackson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  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: sexp_processor
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generates XMI and DOT files for Ruby and Rails Class Diagrams
+email:
+- xumlidot@librely.com
+executables:
+- xumlidot
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/xumlidot
+- lib/xumlidot.rb
+- lib/xumlidot/diagram.rb
+- lib/xumlidot/diagram/dot.rb
+- lib/xumlidot/diagram/dot/klass.rb
+- lib/xumlidot/diagram/dot/module.rb
+- lib/xumlidot/diagram/shared/naming.rb
+- lib/xumlidot/diagram/xmi.rb
+- lib/xumlidot/diagram/xmi/argument.rb
+- lib/xumlidot/diagram/xmi/attribute.rb
+- lib/xumlidot/diagram/xmi/constant.rb
+- lib/xumlidot/diagram/xmi/id.rb
+- lib/xumlidot/diagram/xmi/klass.rb
+- lib/xumlidot/diagram/xmi/method.rb
+- lib/xumlidot/diagram/xmi/superklass.rb
+- lib/xumlidot/directory_tree.rb
+- lib/xumlidot/options.rb
+- lib/xumlidot/parsers.rb
+- lib/xumlidot/parsers/args.rb
+- lib/xumlidot/parsers/call.rb
+- lib/xumlidot/parsers/file.rb
+- lib/xumlidot/parsers/generic.rb
+- lib/xumlidot/parsers/klass_definition.rb
+- lib/xumlidot/parsers/method_signature.rb
+- lib/xumlidot/parsers/module_definition.rb
+- lib/xumlidot/parsers/scope.rb
+- lib/xumlidot/parsers/stack.rb
+- lib/xumlidot/types.rb
+- lib/xumlidot/types/argument.rb
+- lib/xumlidot/types/arguments.rb
+- lib/xumlidot/types/attribute.rb
+- lib/xumlidot/types/attributes.rb
+- lib/xumlidot/types/constant.rb
+- lib/xumlidot/types/constants.rb
+- lib/xumlidot/types/inherited_module.rb
+- lib/xumlidot/types/instance_methods.rb
+- lib/xumlidot/types/klass.rb
+- lib/xumlidot/types/klass_definition.rb
+- lib/xumlidot/types/klass_methods.rb
+- lib/xumlidot/types/method.rb
+- lib/xumlidot/types/method_signature.rb
+- lib/xumlidot/types/methods.rb
+- lib/xumlidot/types/module.rb
+- lib/xumlidot/types/module_definition.rb
+- lib/xumlidot/types/superklass.rb
+- spec/spec_helper.rb
+homepage: http://github.com/os6sense/xumlidot
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generates DOT and XMI for Ruby and Rails UML Class Diagrams.
+test_files:
+- spec/spec_helper.rb