mudguard 0.1.4 → 0.2.0

data/lib/mudguard/infrastructure/cli/view.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mudguard
+  module Infrastructure
+    module Cli
+      # Handles user input
+      class View
+        def print(text)
+          puts text
+        end
+      end
+    end
+  end
+end

data/lib/mudguard/infrastructure/persistence/.mudguard.template.yml

@@ -0,0 +1,6 @@
+'./**/*.rb':
+  # uncomment following lines to allow all dependencies
+  # - .*
+
+  # all code can depend on modules or constants defined in same module
+  - ^(::.+)(::[^:]+)* -> \1(::[^:]+)*$

data/lib/mudguard/infrastructure/persistence/policy_file.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "yaml"
+require_relative "../../domain/policies"
+require_relative "../../domain/error"
+
+module Mudguard
+  module Infrastructure
+    module Persistence
+      # A file containing the Mudguard-Policies
+      class PolicyFile
+        class << self
+          def read(project_path)
+            policy_file = File.join(project_path, ".mudguard.yml")
+            policy_exists = File.exist?(policy_file)
+
+            unless policy_exists
+              template_file = File.join(__dir__, ".mudguard.template.yml")
+              FileUtils.cp(template_file, policy_file)
+            end
+
+            read_yml(policy_file)
+          end
+
+          private
+
+          def read_yml(policy_file)
+            yaml_file = File.read(policy_file)
+            yaml = YAML.safe_load(yaml_file, [Symbol], [], policy_file) || {}
+            yaml.transform_values { |value| (value || []).map(&method(:unsymbolize)) }
+          rescue Psych::SyntaxError => e
+            raise Mudguard::Domain::Error, "#{policy_file} is invalid (#{e.message})"
+          end
+
+          def unsymbolize(dependency)
+            if dependency.is_a?(Symbol)
+              ":#{dependency}"
+            else
+              dependency
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mudguard/infrastructure/persistence/project_repository.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "policy_file"
+require_relative "ruby_files"
+require_relative "../../domain/source_policies"
+
+module Mudguard
+  module Infrastructure
+    module Persistence
+      # Provides access to the persisted source and policies
+      class ProjectRepository
+        class << self
+          def load_source_policies(project_path)
+            file = PolicyFile.read(project_path)
+            scopes = file.flat_map do |patterns, policies|
+              sources = RubyFiles.select(project_path, patterns: [patterns])
+              sources.flat_map { |s| { source: s, policies: policies } }
+            end
+
+            sources = scopes.group_by { |e| e[:source] }
+
+            sources.map do |source, group|
+              policies = group.flat_map { |r| r[:policies] }.uniq
+              Domain::SourcePolicies.new(source: source, policies: policies)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mudguard/infrastructure/persistence/ruby_files.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "mudguard/domain/source"
+
+module Mudguard
+  module Infrastructure
+    module Persistence
+      # Provides access to all ruby-files of a project
+      class RubyFiles
+        class << self
+          def select(project_path, patterns: nil)
+            project_exists = Dir.exist?(project_path)
+
+            unless project_exists
+              raise Mudguard::Domain::Error, "expected project #{project_path} doesn't exists"
+            end
+
+            patterns = [File.join("**", "*.rb")] if patterns.nil?
+            enumerate_files(project_path, patterns)
+          end
+
+          private
+
+          def enumerate_files(project_path, patterns)
+            project_path_name = Pathname.new(project_path)
+            ruby_files = patterns.map { |p| File.join(project_path, p) }
+            Dir.glob(ruby_files).map do |f|
+              file_path_name = Pathname.new(f)
+              diff_path = file_path_name.relative_path_from(project_path_name).to_s
+              Mudguard::Domain::Source.new(location: File.join("./", diff_path),
+                                           code_loader: -> { File.read(f) })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mudguard/infrastructure/rake/task.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rake"
+require "rake/tasklib"
+require_relative "../../application/application"
+require_relative "../../infrastructure/cli/notification_adapter"
+require_relative "../../infrastructure/cli/view"
+
+module Mudguard
+  module Infrastructure
+    module Rake
+      # Provides Mudguard Rake Tasks
+      class Task < ::Rake::TaskLib
+        def initialize(project_dir: Dir.pwd)
+          @project_dir = project_dir
+
+          desc "Run Mudguard"
+          task(:mudguard) do
+            view = Mudguard::Infrastructure::Cli::View.new
+            notification = Mudguard::Infrastructure::Cli::NotificationAdapter.new(view: view)
+            ok = Application.check(@project_dir, notification)
+            abort unless ok
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mudguard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mudguard
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/mudguard.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "mudguard helps your ruby project not becoming a "\
                        "'Big ball of mud'"
-  spec.homepage      = "https://gibhub.com/Enceradeira/mudguard"
+  spec.homepage      = "https://github.com/Enceradeira/mudguard"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -40,4 +40,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~>0.80"
 
   spec.add_dependency "parser", "~>2.7"
+  spec.add_dependency "rake", "~> 13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mudguard
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Jorg Jenni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: 
 email:
 - jorg.jenni@jennius.co.uk
@@ -160,6 +174,7 @@ extra_rdoc_files: []
 files:
 - ".envrc"
 - ".gitignore"
+- ".mudguard.yml"
 - ".rubocop.yml"
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
@@ -171,23 +186,37 @@ files:
 - Rakefile
 - exe/mudguard
 - lib/mudguard.rb
-- lib/mudguard/error.rb
-- lib/mudguard/policies.rb
-- lib/mudguard/policy_file.rb
-- lib/mudguard/ruby_analyser.rb
-- lib/mudguard/ruby_files.rb
+- lib/mudguard/application/application.rb
+- lib/mudguard/domain/const_visitor.rb
+- lib/mudguard/domain/consts.rb
+- lib/mudguard/domain/dependencies.rb
+- lib/mudguard/domain/dependency.rb
+- lib/mudguard/domain/dependency_visitor.rb
+- lib/mudguard/domain/error.rb
+- lib/mudguard/domain/policies.rb
+- lib/mudguard/domain/source.rb
+- lib/mudguard/domain/source_policies.rb
+- lib/mudguard/domain/source_processor.rb
+- lib/mudguard/domain/texts.rb
+- lib/mudguard/infrastructure/cli/controller.rb
+- lib/mudguard/infrastructure/cli/notification_adapter.rb
+- lib/mudguard/infrastructure/cli/view.rb
+- lib/mudguard/infrastructure/persistence/.mudguard.template.yml
+- lib/mudguard/infrastructure/persistence/policy_file.rb
+- lib/mudguard/infrastructure/persistence/project_repository.rb
+- lib/mudguard/infrastructure/persistence/ruby_files.rb
+- lib/mudguard/infrastructure/rake/task.rb
 - lib/mudguard/version.rb
-- lib/tasks/gem.rake
 - lib/tasks/rubocop.rake
 - lib/tasks/test.rake
 - mudguard.gemspec
 - pkg/mudguard-0.1.0.gem
-homepage: https://gibhub.com/Enceradeira/mudguard
+homepage: https://github.com/Enceradeira/mudguard
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gibhub.com/Enceradeira/mudguard
-  source_code_uri: https://gibhub.com/Enceradeira/mudguard
+  homepage_uri: https://github.com/Enceradeira/mudguard
+  source_code_uri: https://github.com/Enceradeira/mudguard
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/mudguard/policies.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "ruby_analyser"
-
-module Mudguard
-  # Contains the policies to be enforced
-  class Policies
-    def initialize(policies: [])
-      @policies = policies.map { |l| l.gsub(/\s/, "") }.map { |p| /^#{p}/ }
-    end
-
-    def check(sources)
-      sources.all? do |source|
-        dependencies = RubyAnalyser.find_mod_dependencies(source)
-        dependencies.all? do |d|
-          @policies.any? do |p|
-            d.match?(p)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mudguard/policy_file.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "policies"
-require_relative "error"
-
-module Mudguard
-  # A file containing the Mudguard-Policies
-  class PolicyFile
-    def self.read(policy_file)
-      policy_exists = File.exist?(policy_file)
-
-      raise Error, "expected policy file #{policy_file} doesn't exists" unless policy_exists
-
-      Policies.new(policies: File.readlines(policy_file))
-    end
-  end
-end

data/lib/mudguard/ruby_analyser.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require "parser/current"
-
-module Mudguard
-  # Analyses Ruby-Source and returns extracted information
-  class RubyAnalyser
-    class << self
-      def find_mod_dependencies(source)
-        begin
-          root = Parser::CurrentRuby.parse(source)
-        rescue Parser::SyntaxError
-          return []
-        end
-        return [] if root.nil?
-
-        process(root)
-      end
-
-      private
-
-      def process(node, module_name = "")
-        case node
-        when type?(:module)
-          process_module(node.children)
-        when type?(:class)
-          process_class(node.children, module_name)
-        when type?(:const)
-          ["#{module_name}->#{find_const_name(node.children)}"]
-        else
-          ignore_and_continue(node, module_name)
-        end
-      end
-
-      def ignore_and_continue(node, module_name)
-        case node
-        when children?
-          node.children.flat_map { |c| process(c, module_name) }
-        else
-          []
-        end
-      end
-
-      def process_module(children)
-        module_name = find_const_name(children[0].children)
-        process(children[1], module_name)
-      end
-
-      def process_class(children, module_name)
-        process(children[1], module_name)
-      end
-
-      def find_const_name(children)
-        return nil if children.nil?
-
-        module_name = find_const_name(children[0]&.children)
-        const_name = children[1].to_s
-        if module_name.nil?
-          const_name
-        else
-          "#{module_name}::#{const_name}"
-        end
-      end
-
-      def children?
-        ->(n) { n.respond_to?(:children) }
-      end
-
-      def type?(type)
-        ->(n) { n.respond_to?(:type) && n.type == type }
-      end
-    end
-  end
-end

data/lib/mudguard/ruby_files.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Mudguard
-  # Provides access to all ruby-files of a project
-  class RubyFiles
-    class << self
-      def all(project_path)
-        project_exists = Dir.exist?(project_path)
-
-        raise Error, "expected project #{project_path} doesn't exists" unless project_exists
-
-        ruby_files = File.join(project_path, "**", "*.rb")
-        Dir.glob(ruby_files).lazy
-      end
-    end
-  end
-end

data/lib/tasks/gem.rake

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec/core/rake_task"
-require "mudguard/version"
-
-namespace :gem do
-  desc "Publishes the gem on rubygems.org"
-  task publish: "gem:build" do
-    exec("gem push mudguard-#{Mudguard::VERSION}.gem")
-  end
-  desc "Builds the gem"
-  task :build do
-    exec("gem build mudguard.gemspec")
-  end
-end