rubycritic 1.3.0 → 1.4.0

data/lib/rubycritic/report_generators/base.rb

@@ -1,50 +0,0 @@
-require "erb"
-require "pathname"
-require "rubycritic/report_generators/view_helpers"
-
-module Rubycritic
-  module Generator
-
-    class Base
-      def self.erb_template(template_path)
-        ERB.new(File.read(File.join(TEMPLATES_DIR, template_path)))
-      end
-
-      TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
-      LAYOUT_TEMPLATE = erb_template(File.join("layouts", "application.html.erb"))
-
-      include ViewHelpers
-
-      def file_href
-        "file://#{file_pathname}"
-      end
-
-      def file_pathname
-        File.join(file_directory, file_name)
-      end
-
-      def file_directory
-        @file_directory ||= root_directory
-      end
-
-      def file_name
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      def render
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      private
-
-      def root_directory
-        @root_directory ||= Pathname.new(Config.root)
-      end
-
-      def get_binding
-        binding
-      end
-    end
-
-  end
-end

data/lib/rubycritic/report_generators/code_file.rb

@@ -1,38 +0,0 @@
-require "rubycritic/report_generators/base"
-require "rubycritic/report_generators/line"
-
-module Rubycritic
-  module Generator
-
-    class CodeFile < Base
-      LINE_NUMBER_OFFSET = 1
-      TEMPLATE = erb_template("code_file.html.erb")
-
-      def initialize(analysed_module)
-        @analysed_module = analysed_module
-        @pathname = @analysed_module.pathname
-      end
-
-      def file_directory
-        @file_directory ||= root_directory + @pathname.dirname
-      end
-
-      def file_name
-        @pathname.basename.sub_ext(".html")
-      end
-
-      def render
-        file_code = ""
-        File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|
-          location = Location.new(@pathname, line_number)
-          line_smells = @analysed_module.smells_at_location(location)
-          file_code << Line.new(file_directory, line_text, line_smells).render
-        end
-
-        file_body = TEMPLATE.result(get_binding { file_code })
-        LAYOUT_TEMPLATE.result(get_binding { file_body })
-      end
-    end
-
-  end
-end

data/lib/rubycritic/report_generators/code_index.rb

@@ -1,24 +0,0 @@
-require "rubycritic/report_generators/base"
-
-module Rubycritic
-  module Generator
-
-    class CodeIndex < Base
-      TEMPLATE = erb_template("code_index.html.erb")
-
-      def initialize(analysed_modules)
-        @analysed_modules = analysed_modules
-      end
-
-      def file_name
-        "code_index.html"
-      end
-
-      def render
-        index_body = TEMPLATE.result(get_binding)
-        LAYOUT_TEMPLATE.result(get_binding { index_body })
-      end
-    end
-
-  end
-end

data/lib/rubycritic/report_generators/current_code_file.rb

@@ -1,17 +0,0 @@
-require "rubycritic/report_generators/code_file"
-
-module Rubycritic
-  module Generator
-
-    class CurrentCodeFile < CodeFile
-      def file_directory
-        @file_directory ||= root_directory
-      end
-
-      def file_name
-        "current_file.html"
-      end
-    end
-
-  end
-end

data/lib/rubycritic/report_generators/line.rb

@@ -1,31 +0,0 @@
-require "rubycritic/report_generators/base"
-require "cgi"
-
-module Rubycritic
-  module Generator
-
-    class Line < Base
-      NORMAL_TEMPLATE = erb_template("line.html.erb")
-      SMELLY_TEMPLATE = erb_template("smelly_line.html.erb")
-
-      attr_reader :file_directory
-
-      def initialize(file_directory, text, smells)
-        @file_directory = file_directory
-        @text = CGI.escapeHTML(text.chomp)
-        @smells = smells
-        @template =
-          if @smells.empty?
-            NORMAL_TEMPLATE
-          else
-            SMELLY_TEMPLATE
-          end
-      end
-
-      def render
-        @template.result(binding).delete("\n") + "\n"
-      end
-    end
-
-  end
-end

data/lib/rubycritic/report_generators/overview.rb

@@ -1,25 +0,0 @@
-require "rubycritic/report_generators/base"
-require "rubycritic/report_generators/turbulence"
-
-module Rubycritic
-  module Generator
-
-    class Overview < Base
-      TEMPLATE = erb_template("overview.html.erb")
-
-      def initialize(analysed_modules)
-        @turbulence_data = Turbulence.data(analysed_modules)
-      end
-
-      def file_name
-        "overview.html"
-      end
-
-      def render
-        index_body = TEMPLATE.result(get_binding)
-        LAYOUT_TEMPLATE.result(get_binding { index_body })
-      end
-    end
-
-  end
-end

data/lib/rubycritic/report_generators/smells_index.rb

@@ -1,36 +0,0 @@
-require "rubycritic/report_generators/base"
-
-module Rubycritic
-  module Generator
-
-    class SmellsIndex < Base
-      TEMPLATE = erb_template("smells_index.html.erb")
-
-      def initialize(analysed_modules)
-        @smells = analysed_modules.flat_map(&:smells).uniq
-        @analysed_module_names = analysed_module_names(analysed_modules)
-        @show_status = (Config.mode == :default)
-      end
-
-      def file_name
-        "smells_index.html"
-      end
-
-      def render
-        index_body = TEMPLATE.result(get_binding)
-        LAYOUT_TEMPLATE.result(get_binding { index_body })
-      end
-
-      private
-
-      def analysed_module_names(analysed_modules)
-        names = {}
-        analysed_modules.each do |analysed_module|
-          names[analysed_module.pathname] = analysed_module.name
-        end
-        names
-      end
-    end
-
-  end
-end

data/lib/rubycritic/reporters/base.rb

@@ -1,24 +0,0 @@
-require "fileutils"
-
-module Rubycritic
-  module Reporter
-
-    class Base
-      ASSETS_DIR = File.expand_path("../../report_generators/assets", __FILE__)
-
-      def create_directories_and_files(generators)
-        Array(generators).each do |generator|
-          FileUtils.mkdir_p(generator.file_directory)
-          File.open(generator.file_pathname, "w+") do |file|
-            file.write(generator.render)
-          end
-        end
-      end
-
-      def copy_assets_to_report_directory
-        FileUtils.cp_r(ASSETS_DIR, Config.root)
-      end
-    end
-
-  end
-end

data/lib/rubycritic/reporters/main.rb

@@ -1,51 +0,0 @@
-require "rubycritic/reporters/base"
-require "rubycritic/report_generators/overview"
-require "rubycritic/report_generators/smells_index"
-require "rubycritic/report_generators/code_index"
-require "rubycritic/report_generators/code_file"
-
-module Rubycritic
-  module Reporter
-
-    class Main < Base
-      def initialize(analysed_modules)
-        @analysed_modules = analysed_modules
-      end
-
-      def generate_report
-        create_directories_and_files(generators)
-        copy_assets_to_report_directory
-        report_location
-      end
-
-      private
-
-      def generators
-        [overview_generator, code_index_generator, smells_index_generator] + file_generators
-      end
-
-      def overview_generator
-        @overview_generator ||= Generator::Overview.new(@analysed_modules)
-      end
-
-      def code_index_generator
-        Generator::CodeIndex.new(@analysed_modules)
-      end
-
-      def smells_index_generator
-        Generator::SmellsIndex.new(@analysed_modules)
-      end
-
-      def file_generators
-        @analysed_modules.map do |analysed_module|
-          Generator::CodeFile.new(analysed_module)
-        end
-      end
-
-      def report_location
-        overview_generator.file_href
-      end
-    end
-
-  end
-end

data/lib/rubycritic/reporters/mini.rb

@@ -1,30 +0,0 @@
-require "rubycritic/reporters/base"
-require "rubycritic/report_generators/current_code_file"
-
-module Rubycritic
-  module Reporter
-
-    class Mini < Base
-      def initialize(analysed_modules)
-        @analysed_module = analysed_modules.first
-      end
-
-      def generate_report
-        create_directories_and_files(file_generator)
-        copy_assets_to_report_directory
-        report_location
-      end
-
-      private
-
-      def file_generator
-        @file_generator ||= Generator::CurrentCodeFile.new(@analysed_module)
-      end
-
-      def report_location
-        file_generator.file_href
-      end
-    end
-
-  end
-end