inch 0.0.1 → 0.1.0

data/lib/inch/cli/command/options/base_list.rb

@@ -0,0 +1,84 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class BaseList < Base
+          attribute :full, false
+          attribute :visibility, [:public, :protected]
+          attribute :namespaces
+          attribute :undocumented
+          attribute :depth
+
+          def parse(args)
+            opts = OptionParser.new
+            opts.banner = usage
+
+            descriptions.each do |text|
+              opts.separator "  " + text
+            end
+
+            set_options(opts)
+            parse_yardopts_options(opts, args)
+            parse_options(opts, args)
+
+            @paths = get_paths(args)
+          end
+
+          def set_options(opts)
+            list_options(opts)
+            common_options(opts)
+
+            yardopts_options(opts)
+          end
+
+          protected
+
+          def list_options(opts)
+            opts.separator ""
+            opts.separator "List options:"
+
+            opts.on("--all", "Show all objects in the output") do
+              @full = true
+            end
+
+            opts.on("--only-namespaces", "Only show namespaces (classes, modules)") do
+              @namespaces = :only
+            end
+            opts.on("--no-namespaces", "Only show namespace children (methods, constants, attributes)") do
+              @namespaces = :none
+            end
+
+            opts.on("--no-public", "Do not show public objects") do
+              set_visibility :public, false
+            end
+            opts.on("--no-protected", "Do not show protected objects") do
+              set_visibility :protected, false
+            end
+            opts.on("--private", "Show private objects") do
+              set_visibility :private, true
+            end
+
+            opts.on("--only-undocumented", "Only show undocumented objects") do
+              @undocumented = :only
+            end
+            opts.on("--no-undocumented", "Only show documented objects") do
+              @undocumented = :none
+            end
+
+            opts.on("--depth [DEPTH]", "Only show objects up to a given DEPTH in the class tree") do |depth|
+              @depth = depth.to_i
+            end
+          end
+
+          def set_visibility(_visibility, true_or_false)
+            if true_or_false
+              visibility.push(_visibility)
+            else
+              visibility.delete(_visibility)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/base_object.rb

@@ -0,0 +1,47 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class BaseObject < Base
+          attribute :object_names, []
+
+          def parse(args)
+            opts = OptionParser.new
+            opts.banner = usage
+
+            descriptions.each do |text|
+              opts.separator "  " + text
+            end
+
+            set_options(opts)
+            parse_yardopts_options(opts, args)
+            parse_options(opts, args)
+
+            @object_names = parse_object_names(args)
+            @paths = get_paths(args)
+          end
+
+          def set_options(opts)
+            common_options(opts)
+
+            yardopts_options(opts)
+          end
+
+          private
+
+          # TODO: really check the last parameters if they are globs, files
+          # or switches and find the object_name(s) that way
+          def parse_object_names(args)
+            arguments = Arguments.new(args)
+            object_names = arguments.object_names
+            object_names.each do |n|
+              @yard_files.delete(n)
+              args.delete(n)
+            end
+            object_names
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/console.rb

@@ -0,0 +1,26 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Console < BaseObject
+          def descriptions
+            [
+              "",
+              "Provides a PRY based REPL to inspect objects.",
+              "",
+              "Example: " + "$ inch console lib/**/*.rb Foo::Bar#initialize".cyan,
+              "",
+              "Shortcut commands on the prompt are:",
+              "",
+              "all".ljust(5) + " returns all code objects",
+              "f".ljust(5) + " finds an object by its path",
+              "ff".ljust(5) + " finds all objects given a partial path",
+              "o".ljust(5) + " returns the code object for OBJECT_NAME (if present)",
+            ]
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/inspect.rb

@@ -0,0 +1,25 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Inspect < BaseObject
+
+          def descriptions
+            [
+              "",
+              "Example: " + "$ inch inspect lib/**/*.rb Foo::Bar#initialize".cyan,
+              "",
+              "Shows one or more objects in detail."
+            ]
+          end
+
+          def verify
+            if object_names.empty?
+              kill # "Provide a name to an object to show it's evaluation."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/list.rb

@@ -0,0 +1,30 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class List < BaseList
+          attribute :numbers, false
+
+          def descriptions
+            [
+              "",
+              "Lists objects that can be improved regarding their documentation ordered by their grade.",
+              "",
+              "Example: " + "$ inch list lib/**/*.rb --all".cyan,
+              "",
+              description_grades,
+              description_arrows
+            ]
+          end
+
+          def list_options(opts)
+            super
+            opts.on("--numbers", "Show numbers instead of grades and arrows") do |depth|
+              @numbers = true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/show.rb

@@ -0,0 +1,27 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Show < BaseObject
+
+          def descriptions
+            [
+              "",
+              "Example: " + "$ inch show lib/**/*.rb Foo::Bar#initialize".cyan,
+              "",
+              "Shows one or more objects in detail.",
+              description_grades,
+              description_arrows
+            ]
+          end
+
+          def verify
+            if object_names.empty?
+              kill # "Provide a name to an object to show it's evaluation."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/stats.rb

@@ -0,0 +1,20 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Stats < BaseList
+          FORMATS = %w(text json yaml)
+
+          attribute :format, FORMATS.first
+
+          def list_options(opts)
+            super
+            opts.on("-f", "--format [FORMAT]", FORMATS, "Set output FORMAT") do |format|
+              @format = format
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/suggest.rb

@@ -0,0 +1,61 @@
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Suggest < BaseList
+          attribute :object_count, 20
+          attribute :file_count, 5
+
+          attribute :proper_grades, [:A, :B]
+          attribute :grades_to_display, [:B, :C, :U]
+          attribute :object_min_priority, 0
+          attribute :object_max_score, ::Inch::Evaluation::Base::MAX_SCORE
+
+          attribute :pedantic, false
+
+          def set_options(opts)
+            list_options(opts)
+            suggest_options(opts)
+            common_options(opts)
+
+            yardopts_options(opts)
+          end
+
+          def descriptions
+            [
+              "",
+              "Suggests objects and files that can be improved regarding their documentation.",
+              "",
+              "Example: " + "$ inch suggest lib/**/*.rb --pedantic".cyan,
+              "",
+              description_grades,
+              description_arrows
+            ]
+          end
+
+          protected
+
+          def suggest_options(opts)
+            opts.separator ""
+            opts.separator "Suggest options:"
+
+            opts.on("-n", "--objects [COUNT]", "Show COUNT objects") do |count|
+              @object_count = count.to_i
+            end
+            opts.on("--pedantic", "Be excessively concerned with minor details and rules") do |count|
+              # all objects are considered a priority
+              @object_min_priority = -99
+              # only objects with the highest score are omitted from the list
+              @object_max_score = object_max_score - 1
+              # only A-listers are regarded as 'proper'
+              @proper_grades = [:A]
+              @grades_to_display = [:A, :B, :C]
+              @object_count = 30
+              @pedantic = true
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/output/base.rb

@@ -0,0 +1,32 @@
+require 'optparse'
+
+module Inch
+  module CLI
+    module Command
+      module Output
+        # Abstract base class for CLI output
+        #
+        class Base
+          include TraceHelper
+
+          PRIORITY_MAP = {
+              (4..99) => "\u2191", # north
+              (2...4) => "\u2197", # north-east
+              (0..1)  => "\u2192", # east
+              (-2..-1) => "\u2198", # south-east
+              (-99..-3) => "\u2193", # south-east
+            }
+          PRIORITY_ARROWS = PRIORITY_MAP.values
+
+          def priority_arrow(priority, color = :white)
+            PRIORITY_MAP.each do |range, str|
+              if range.include?(priority)
+                return str.color(color).dark
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/output/console.rb

@@ -0,0 +1,45 @@
+module Inch
+  module CLI
+    module Command
+      module Output
+        class Console < Base
+          extend Forwardable
+
+          attr_reader :object, :objects, :source_parser
+
+          def_delegators :source_parser, :all_objects, :find_object, :find_objects
+          alias :all :all_objects
+          alias :ff :find_objects
+          alias :f :find_object
+          alias :o :object
+
+          COLOR = :color198     # magenta-ish
+          BG_COLOR = :color207  # magenta-ish
+
+          def initialize(options, object, objects, source_parser)
+            @options = options
+            @object = object
+            @objects = objects
+            @source_parser = source_parser
+
+            run
+          end
+
+          def run
+            trace
+            trace_header("Welcome to Inch's console", COLOR, BG_COLOR)
+            trace edged(COLOR, @options.usage)
+            @options.descriptions.each do |line|
+              trace edged(COLOR, line)
+            end
+            run_pry
+          end
+
+          def run_pry
+            binding.pry
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/output/inspect.rb

@@ -0,0 +1,129 @@
+module Inch
+  module CLI
+    module Command
+      module Output
+        class Inspect < Base
+          attr_reader :objects
+
+          COLOR = :color198     # magenta-ish
+          BG_COLOR = :color207  # magenta-ish
+          LJUST = 20
+
+          def initialize(options, objects)
+            @options = options
+            @objects = objects
+
+            display_objects
+          end
+
+          private
+
+          def display_objects
+            objects.each do |o|
+              print_object(o)
+            end
+          end
+
+          def print_object(o)
+            trace
+            trace_header(o.path, COLOR, BG_COLOR)
+
+            print_file_info(o)
+            print_code_info(o)
+            print_doc_info(o)
+            print_namespace_info(o)
+            print_roles_info(o)
+
+            echo "Score (min: #{o.evaluation.min_score}, max: #{o.evaluation.max_score})".ljust(40) + "#{o.score.to_i}".rjust(5) + "#{o.priority.to_i}".rjust(4)
+            echo
+          end
+
+          def print_file_info(o)
+            o.files.each do |f|
+              echo "-> #{f[0]}:#{f[1]}".color(COLOR)
+            end
+            echo separator
+          end
+
+          def print_code_info(o)
+            if o.method?
+              o.comment_and_abbrev_source.lines.each do |line|
+                echo line.gsub(/\n$/m, '').dark
+              end
+              echo separator
+            end
+          end
+
+          def print_roles_info(o)
+            if o.roles.empty?
+              echo "No roles assigned.".dark
+            else
+              o.roles.each do |role|
+                name = role.class.to_s.split('::Role::').last
+                if role.potential_score
+                  score = "(#{role.potential_score.to_i})".rjust(5).yellow.dark
+                else
+                  value = role.score.to_i
+                  score = value.abs.to_s.rjust(4)
+                  if value < 0
+                    score = ("-" + score).red
+                  elsif value > 0
+                    score = ("+" + score).green
+                  else
+                    score = " " + score
+                  end
+                end
+                priority = role.priority.to_s.rjust(4)
+                if role.priority == 0
+                  priority = priority.dark
+                end
+                echo name.ljust(40) + score + priority
+                if role.max_score
+                  echo "  (set max score to #{role.max_score})"
+                end
+                if role.min_score
+                  echo "  (set min score to #{role.min_score})"
+                end
+              end
+            end
+            echo separator
+          end
+
+          def print_doc_info(o)
+            if o.nodoc?
+              echo "The object was tagged not to documented.".yellow
+            else
+              echo "Docstring".ljust(LJUST) + "#{o.has_doc? ? 'Yes' : 'No text'}"
+              if o.method?
+                echo "Parameters:".ljust(LJUST) + "#{o.has_parameters? ? '' : 'No parameters'}"
+                o.parameters.each do |p|
+                  echo "  " + p.name.ljust(LJUST-2) + "#{p.mentioned? ? 'Mentioned' : 'No text'} / #{p.typed? ? 'Typed' : 'Not typed'} / #{p.described? ? 'Described' : 'Not described'}"
+                end
+                echo "Return type:".ljust(LJUST) + "#{o.return_mentioned? ? 'Defined' : 'Not defined'}"
+              end
+            end
+            echo separator
+          end
+
+          def print_namespace_info(o)
+            if o.namespace?
+              echo "Children (height: #{o.height}):"
+              o.children.each do |child|
+                echo "+ " + child.path.color(COLOR)
+              end
+              echo separator
+            end
+          end
+
+          def echo(msg = "")
+            trace edged(COLOR, msg)
+          end
+
+          def separator
+            "-".color(COLOR) * (CLI::COLUMNS - 2)
+          end
+        end
+      end
+    end
+  end
+end