mudguard 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64fb401ff5f77f335af75d7c170a03be012b6ee2a366fb45ddef276e897f8da8
-  data.tar.gz: c14cd31398dd33c3838f07ddcb8b5c09c0c08cf3e57f046c89f6069fa7679aef
+  metadata.gz: 704ed528bcdd940b57ef601a5841eb5585ba5a32b2ef2ae9c184e8f544daba00
+  data.tar.gz: 18603a36e5cc7e95569d3c184df7ec9955ec6d11f1cb299ad9790b20d09f4b88
 SHA512:
-  metadata.gz: 7173bd1ae058ace1f8b3f86909d7b8de3c0229b5886041f8922b777f37ab58ed6d2617d7488dd9813421f2eaa4d723c1bf64dd14b21f0ea9a5a20a986e1d432c
-  data.tar.gz: 86bc09949d76af31395484859911a29d5f8dd6b2d9f6963ce1c7415e7b4a8d4ef92a347e8155e6b1784f881c779841c7625e81577812b669a3a0673b780c06a7
+  metadata.gz: f136a1d09aa59ffc8f71a842cfef6b513ac1c381d4fe09d7a0660921008b7780f5e595782d343c27f6899d9edd6fe3af6729a3b12bc15aff183129455aa1a36e
+  data.tar.gz: 51bc6a0961d73cfad36c32d359c34a22eb0faaf31bf38ca67cbba7c626f6995a25267c3004776744dcacd7b15779e9c1b0778e0ac7c5633ef40ff9c045a1a04c

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - 'bin/*'
+    - 'spec/lib/test_projects/**/*.rb'
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
@@ -9,6 +10,7 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
     - 'lib/tasks/**/*.rake'
+    - 'mudguard.gemspec'
 
 Style/Documentation:
   Exclude:
@@ -22,3 +24,7 @@ Style/HashTransformKeys:
 
 Style/HashTransformValues:
   Enabled: true
+
+Layout/LineLength:
+  Description: 'Limit lines to 100 characters.'
+  Max: 100

data/Gemfile.lock

@@ -1,19 +1,59 @@
 PATH
   remote: .
   specs:
-    mudguard (0.1.0)
+    mudguard (0.1.1)
+      parser (~> 2.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
     diff-lcs (1.3)
+    ffi (1.12.2)
+    formatador (0.2.5)
+    guard (2.16.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     jaro_winkler (1.5.4)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.4)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.19.1)
     parser (2.7.0.4)
       ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    pry-doc (1.0.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -37,17 +77,25 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    thor (1.0.1)
     unicode-display_width (1.6.1)
+    yard (0.9.24)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  guard (~> 2.1)
+  guard-rspec (~> 4.7)
   mudguard!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop
+  pry (~> 0.12)
+  pry-byebug (~> 3.7)
+  pry-doc (~> 1.0)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+  rubocop (~> 0.80)
 
 BUNDLED WITH
    2.1.4

data/Guardfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+rspec_options = {
+  cmd: "rspec",
+  notification: false,
+  failed_mode: :focus
+}
+
+guard "rspec", rspec_options do
+  watch(%r{^spec/.+_spec\.rb$})
+  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" }
+end

data/bin/_guard-core

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/guard

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/lib/mudguard/error.rb

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

data/lib/mudguard/policies.rb

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "policies"
+
+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

@@ -0,0 +1,74 @@
+# 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

@@ -0,0 +1,17 @@
+# 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/mudguard/version.rb

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

data/lib/mudguard.rb

@@ -1,8 +1,19 @@
 # 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 Error < StandardError; end
-  # Your code goes here...
+  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

data/mudguard.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jorg Jenni"]
   spec.email         = ["jorg.jenni@jennius.co.uk"]
 
-  spec.summary       = "mudguard helps with your ruby project not becoming a "\
+  spec.summary       = "mudguard helps your ruby project not becoming a "\
                        "'Big ball of mud'"
   spec.homepage      = "https://gibhub.com/Enceradeira/mudguard"
   spec.license       = "MIT"
@@ -30,7 +30,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "guard", "~> 2.1"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "pry", "~>0.12"
+  spec.add_development_dependency "pry-byebug", "~>3.7"
+  spec.add_development_dependency "pry-doc", "~>1.0"
+  spec.add_development_dependency "rake", "~>13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~>0.80"
+
+  spec.add_dependency "parser", "~>2.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mudguard
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jorg Jenni
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-08 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,48 +24,132 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.80'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.7'
 description: 
 email:
 - jorg.jenni@jennius.co.uk
@@ -80,18 +164,27 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/_guard-core
 - bin/console
+- bin/guard
 - bin/rake
 - bin/rubocop
 - bin/setup
 - 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/version.rb
 - lib/tasks/rubocop.rake
 - lib/tasks/test.rake
 - mudguard.gemspec
+- pkg/mudguard-0.1.0.gem
 homepage: https://gibhub.com/Enceradeira/mudguard
 licenses:
 - MIT
@@ -117,5 +210,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: mudguard helps with your ruby project not becoming a 'Big ball of mud'
+summary: mudguard helps your ruby project not becoming a 'Big ball of mud'
 test_files: []