mudguard 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e84d450c1adfd300b6be1e11244dd8eec43bc4ef2dffdd090974290591bce06f
-  data.tar.gz: c36b94a49c130dc29b6ce80befc227121348c53b977a88451337bc6987b5a0fa
+  metadata.gz: c6b60554fbef1a22d26bcc61a3b7362f9351d3a86464e1e1e3c29f44d6f8d44f
+  data.tar.gz: 2a3617b3c12dc0ce2ecafdf09b6b0d9eb1464b3f51e7f93360c875fc5d63a3ff
 SHA512:
-  metadata.gz: 4db49720f6381c3c67a7e2e669235e070d8ed2cb650f48f41752dd95a243da43dc1bbc7bec7947828fd40c7abf3c7dc786c366cd04efb026d2c732cc5908d8d2
-  data.tar.gz: 84291c975dce9b7b893ae831dcfc54cafe16313d17b86f590d27a529b231fe4e1c2a4683455746c7a5143bbf880fe39f17ffb7be16954a63647eb98bda5a22ad
+  metadata.gz: 647203da7407adc474020ab9b559847ba0cdcbf308a031ca980f02d63c45222abc52c144c03f7bbc497f24f23a37541cb37f45fd555079b44f5d95bbe6c2fcba
+  data.tar.gz: 576533ce4ca809ea053bb8c3ea36f6ed20b51b989f071bbfb10204b91ecf1196d82e9af4132a92b431621618b6c5e8da09d1c8d6c9c1181664a4c67111a4277d

data/.gitignore

@@ -13,3 +13,6 @@
 # Ignore RSpec Working Dir
 /.rspec
 .rspec_status
+
+# Ignore pkg (gem dir)
+/pkg

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mudguard (0.1.4)
+    mudguard (0.1.5)
       parser (~> 2.7)
 
 GEM

data/Guardfile

@@ -12,5 +12,5 @@ guard "rspec", rspec_options do
   watch(%r{^lib/mudguard/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch(%r{^lib/mudguard/(.+)\.rb$}) { |m| Dir.glob("spec/lib/#{m[1]}_*.rb") }
   watch("spec/spec_helper.rb") { "spec" }
-  watch(%r{^exe\/mudguard$}) { |_| "spec/bin/mudguard_spec.rb" }
+  watch(%r{^exe\/mudguard$}) { |_| "spec/exe/mudguard_spec.rb" }
 end

data/exe/mudguard

@@ -1,20 +1,13 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "mudguard"
-require "optparse"
+require "mudguard/infrastructure/cli/view"
+require "mudguard/infrastructure/cli/controller"
 
 # Checks the dependencies of a ruby project
 module Mudguard
-  parser = OptionParser.new do |opts|
-    opts.banner = "Usage: mudguard [options] [directory]"
-    opts.on("-h", "--help", "Prints this help") do
-      puts opts
-      exit
-    end
-  end
-
-  directories = parser.parse!
-  ok = directories.all?(&Mudguard.method(:check))
+  view = Mudguard::Infrastructure::Cli::View.new
+  parser = Mudguard::Infrastructure::Cli::Controller.new(view: view)
+  ok = parser.parse!(ARGV)
   exit(ok ? 0 : 1)
 end

data/lib/mudguard/application/application.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../infrastructure/persistence/policy_file"
+require_relative "../infrastructure/persistence/ruby_files"
+
+# Contains methods to check if your project is a bit muddy
+module Mudguard
+  # API to mudguard
+  module Application
+    class << self
+      def check(project_path, notification)
+        policy_file_path = File.expand_path("MudguardFile", project_path)
+        policies = Infrastructure::Persistence::PolicyFile.read(policy_file_path)
+
+        policies.check(Infrastructure::Persistence::RubyFiles.all(project_path), notification)
+      end
+    end
+  end
+end

data/lib/mudguard/domain/dependency.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mudguard
+  module Domain
+    # A Dependency between Modules
+    class Dependency
+      def initialize(location: nil, dependency:)
+        @location = location
+        @dependency = dependency
+      end
+
+      def inspect
+        "{#{@location}, #{@dependency}}"
+      end
+
+      def to_s
+        "#{@location} #{@dependency}"
+      end
+
+      def match(policy)
+        @dependency.match(policy)
+      end
+
+      def ==(other)
+        @location == other.instance_eval { @location } &&
+          @dependency == other.instance_eval { @dependency }
+      end
+    end
+  end
+end

data/lib/mudguard/{error.rb → domain/error.rb}

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Mudguard
-  class Error < StandardError
+  module Domain
+    class Error < StandardError
+    end
   end
 end

data/lib/mudguard/domain/policies.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Mudguard
+  module Domain
+    # 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, notification)
+        result = check_sources(sources, notification)
+
+        count = result[:count]
+        violations = result[:violations]
+
+        files = pluralize("file", count)
+        problems = pluralize("problem", violations)
+        notification.add("#{count} #{files} inspected, #{violations} #{problems} detected")
+        violations.zero?
+      end
+
+      private
+
+      def pluralize(word, count)
+        count == 1 ? word : "#{word}s"
+      end
+
+      def check_sources(sources, notification)
+        sources.each_with_object(count: 0, violations: 0) do |source, result|
+          result[:count] += 1
+          dependencies = source.find_mod_dependencies
+          result[:violations] += check_dependencies(dependencies, notification)
+        end
+      end
+
+      def check_dependencies(dependencies, notification)
+        dependencies.reject { |d| check_dependency(d, notification) }.count
+      end
+
+      def check_dependency(dependency, notification)
+        is_allowed = @policies.any? { |p| dependency.match(p) }
+        notification.add("#{dependency} not allowed") unless is_allowed
+        is_allowed
+      end
+    end
+  end
+end

data/lib/mudguard/{ruby_analyser.rb → domain/source.rb}

@@ -1,14 +1,28 @@
 # frozen_string_literal: true
 
 require "parser/current"
+require "mudguard/domain/dependency"
 
 module Mudguard
-  # Analyses Ruby-Source and returns extracted information
-  class RubyAnalyser
-    class << self
-      def find_mod_dependencies(source)
+  module Domain
+    # Represents a Ruby source file
+    class Source
+      def initialize(location: nil, code:)
+        @code = code
+        @location = location
+      end
+
+      def ==(other)
+        @code == other.instance_eval { @code } && @location == other.instance_eval { @location }
+      end
+
+      def inspect
+        @location
+      end
+
+      def find_mod_dependencies
         begin
-          root = Parser::CurrentRuby.parse(source)
+          root = Parser::CurrentRuby.parse(@code)
         rescue Parser::SyntaxError
           return []
         end
@@ -26,12 +40,18 @@ module Mudguard
         when type?(:class)
           process_class(node.children, module_name)
         when type?(:const)
-          ["#{module_name}->#{find_const_name(node.children)}"]
+          [create_dependency(module_name, node)]
         else
           ignore_and_continue(node, module_name)
         end
       end
 
+      def create_dependency(module_name, node)
+        dependency = "#{module_name}->#{find_const_name(node.children)}"
+        location = "#{@location}:#{node.location.line}"
+        Dependency.new(location: location, dependency: dependency)
+      end
+
       def ignore_and_continue(node, module_name)
         case node
         when children?

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "mudguard/application/application"
+require_relative "notification_adapter"
+
+module Mudguard
+  module Infrastructure
+    module Cli
+      # Parses the cli arguments
+      class Controller
+        def initialize(view:)
+          @view = view
+          @done = false
+          @parser = ::OptionParser.new do |opts|
+            opts.banner = "Usage: mudguard [options] [directory]"
+            opts.on("-h", "--help", "Prints this help") do
+              view.print(opts.to_s)
+              @done = true
+            end
+          end
+        end
+
+        def parse!(argv)
+          directories = @parser.parse!(argv)
+
+          return true if @done
+
+          notification = NotificationAdapter.new(view: @view)
+          directories = [Dir.pwd] if directories.empty?
+          directories.all? { |d| Mudguard::Application.check(d, notification) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mudguard
+  module Infrastructure
+    module Cli
+      # Forwards Notification to the view for printing
+      class NotificationAdapter
+        def initialize(view:)
+          @view = view
+        end
+
+        def add(text)
+          @view.print(text)
+        end
+      end
+    end
+  end
+end

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/policy_file.rb

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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "mudguard/domain/source"
+
+module Mudguard
+  module Infrastructure
+    module Persistence
+      # Provides access to all ruby-files of a project
+      class RubyFiles
+        class << self
+          def all(project_path)
+            project_exists = Dir.exist?(project_path)
+
+            unless project_exists
+              raise Mudguard::Domain::Error, "expected project #{project_path} doesn't exists"
+            end
+
+            enumerate_files(project_path)
+          end
+
+          private
+
+          def enumerate_files(project_path)
+            project_path_name = Pathname.new(project_path)
+            ruby_files = File.join(project_path, "**", "*.rb")
+            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: File.read(f))
+            end.lazy
+          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.1.5"
 end

data/lib/mudguard.rb

@@ -1,19 +1,4 @@
 # frozen_string_literal: true
 
-require "mudguard/version"
-require_relative "mudguard/policy_file"
-require_relative "mudguard/ruby_files"
-
-# Contains methods to check if your project is a bit muddy
-module Mudguard
-  class << self
-    def check(project_path)
-      policy_file_path = File.expand_path("MudguardFile", project_path)
-      policies = PolicyFile.read(policy_file_path)
-
-      files = RubyFiles.all(project_path).map { |f| File.read(f) }
-
-      policies.check(files)
-    end
-  end
-end
+require_relative "./mudguard/version"
+require_relative "./mudguard/application/application"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mudguard
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Jorg Jenni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,13 +171,17 @@ 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/dependency.rb
+- lib/mudguard/domain/error.rb
+- lib/mudguard/domain/policies.rb
+- lib/mudguard/domain/source.rb
+- lib/mudguard/infrastructure/cli/controller.rb
+- lib/mudguard/infrastructure/cli/notification_adapter.rb
+- lib/mudguard/infrastructure/cli/view.rb
+- lib/mudguard/infrastructure/persistence/policy_file.rb
+- lib/mudguard/infrastructure/persistence/ruby_files.rb
 - lib/mudguard/version.rb
-- lib/tasks/gem.rake
 - lib/tasks/rubocop.rake
 - lib/tasks/test.rake
 - mudguard.gemspec

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_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