closing_comments 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3db284866963dbbf428bd2ba95eea36824e3b1b2
+  data.tar.gz: d194e7ac4fc744fda9df95cfb01ae078f8a187db
+SHA512:
+  metadata.gz: 3237f635443fdcd056454dd5295f1eeab4a1c54650050136657e7f0b02d51697919f32302c4d0ec629d01c73bf8fc7aece58729a13ca8938e9c5e797661a317c
+  data.tar.gz: 8a95866c78a9114ed6e69354e8400ce9b0ee28a7b2c321cfab30ffdbbb02a38cd6c58da3a4586bf4e5666411af01f5159f8f6dca2428cf1209e1dc2e4b54a026

data/bin/closing_comments

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+require 'optparse'
+require 'closing_comments'
+
+module ClosingComments
+  class App
+    def initialize(args)
+      @args = args
+      @processor = options.fetch(:processor, Processor::Reporter.new)
+    end
+
+    def run
+      @args = ['.'] if @args.empty?
+      @args.each(&method(:process))
+      @processor.report
+      Kernel.exit(@processor.success? ? 0 : 1)
+    end
+
+    def process(path)
+      return @processor.process(path: path) if File.file?(path)
+      Dir.glob(File.join(path, '/**/*.rb')).each(&method(:process))
+    end
+
+    def options
+      {}.tap do |options|
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: closing_comments [options]'
+          opts.on('-a', '--auto-fix', 'Automatically fix issues') do
+            options[:processor] = Processor::Fixer.new
+          end
+        end.parse!(@args)
+      end
+    end
+  end # class App
+end # module ClosingComments
+
+ClosingComments::App.new(ARGV).run

data/ensure_version.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'net/http'
+require 'singleton'
+
+require 'colorize'
+
+class EnsureVersion
+  include Singleton
+
+  def call
+    if compare
+      puts "#{'[OK]'.green} Local version (#{local_version}) higher than " \
+           "remote (#{remote_version})."
+      Kernel.exit(0)
+    end
+    puts "#{'[FAIL]'.red} Local version (#{local_version}) not higher than " \
+         "remote (#{remote_version}), please bump."
+    Kernel.exit(1)
+  end
+
+  private
+
+  def compare
+    local_version > remote_version
+  end
+
+  def local_version
+    Gem.loaded_specs[name].version
+  end
+
+  def remote_version
+    @remote_version ||= begin
+      version = JSON.parse(rubygems_response.body).fetch('version')
+      Gem::Version.new(version == 'unknown' ? 0 : version)
+    end
+  end
+
+  # This method reeks of :reek:FeatureEnvy (url).
+  def rubygems_response
+    url = URI.parse("https://rubygems.org/api/v1/versions/#{name}/latest.json")
+    req = Net::HTTP::Get.new(url.to_s)
+    Net::HTTP.start(url.host, url.port, use_ssl: true) do |http|
+      http.request(req)
+    end
+  end
+
+  def name
+    'closing_comments'
+  end
+end # class EnsureVersion
+
+EnsureVersion.instance.call if __FILE__ == $PROGRAM_NAME

data/lib/closing_comments.rb

@@ -0,0 +1,3 @@
+require 'closing_comments/commentable'
+require 'closing_comments/processor'
+require 'closing_comments/source'

data/lib/closing_comments/commentable.rb

@@ -0,0 +1,97 @@
+require 'forwardable'
+require 'singleton'
+
+module ClosingComments
+  class Commentable
+    extend Forwardable
+
+    def_delegators :@node, :children, :loc
+    def_delegators :loc, :first_line, :last_line
+
+    def initialize(node)
+      @node = node
+    end
+
+    def name
+      @name ||= name!(children.first)
+    end
+
+    def single_line?
+      first_line == last_line
+    end
+
+    def ending
+      "end # #{entity} #{name}"
+    end
+
+    private
+
+    # This method reeks of :reek:FeatureEnvy and :reek:TooManyStatements.
+    def name!(node)
+      return node unless node.is_a?(Parser::AST::Node)
+      type = node.type
+      return '' if type == :cbase
+      first, second = node.children
+      if type == :str
+        loc = node.loc
+        # Preserve quote formatting, some folks may prefer double quotes.
+        return "#{loc.begin.source}#{first}#{loc.end.source}"
+      end
+      first ? [name!(first), second].join('::') : second
+    end
+
+    class Class < Commentable
+      def entity
+        'class'
+      end
+    end # class Class
+
+    class Module < Commentable
+      def entity
+        'module'
+      end
+    end # class Module
+
+    class Block < Commentable
+      RSPEC = %i[context describe shared_context shared_examples].freeze
+      private_constant :RSPEC
+
+      def commentable?
+        dispatch.type == :send && rspec?
+      end
+
+      def name
+        name!(dispatch.children[2])
+      end
+
+      def entity
+        return message if implicit_receiver?
+        [name!(receiver), message].join('.')
+      end
+
+      private
+
+      def rspec?
+        return false unless implicit_receiver? || name!(receiver) == :RSpec
+        RSPEC.include?(message)
+      end
+
+      def dispatch
+        children.first
+      end
+
+      def receiver
+        dispatch.children.first
+      end
+
+      # This method reeks of :reek:NilCheck.
+      def implicit_receiver?
+        receiver.nil?
+      end
+
+      def message
+        dispatch.children[1]
+      end
+    end # class Block
+  end # class Commentable
+end # module ClosingComments

data/lib/closing_comments/processor.rb

@@ -0,0 +1,70 @@
+require 'colorize'
+
+module ClosingComments
+  class Processor
+    def initialize
+      @reportables = {}
+    end
+
+    # TODO(marcinw): catch parsing errors;
+    def process(path:)
+      source = Source.from(path: path)
+      handle(source)
+      @reportables[path] = source if source.problematic?
+    end
+
+    def success?
+      @reportables.empty?
+    end
+
+    private
+
+    attr_reader :reportables
+
+    class Reporter < Processor
+      def handle(source)
+        print source.problematic? ? 'F'.red : '.'.green
+      end
+
+      def report
+        puts("\n\n")
+        return puts 'All good!'.green if reportables.empty?
+        puts "Problems #{action} in #{reportables.count} files:\n".red
+        reportables.each(&method(:report_file))
+      end
+
+      private
+
+      def action
+        'found'
+      end
+
+      def report_file(path, source)
+        puts "#{path}:"
+        source.problems.sort_by(&:line).each do |problem|
+          puts "  #{problem.line}:#{problem.column} #{problem.message}"
+        end
+        puts('')
+      end
+    end # class Reporter
+
+    class Fixer < Reporter
+      # This method reeks of :reek:FeatureEnvy.
+      def handle(source)
+        return super unless source.problematic?
+        File.write(source.path, source.fix)
+        print 'A'.yellow
+      end
+
+      private
+
+      def action
+        'fixed'
+      end
+    end # class Fixer
+
+    class JSON < Processor
+      def handle(_); end # Don't stare, I'm just implementing an API, ok?
+    end # class JSON
+  end # class Processor
+end # module ClosingComments

data/lib/closing_comments/source.rb

@@ -0,0 +1,133 @@
+require 'forwardable'
+require 'parser/ruby24'
+
+module ClosingComments
+  class Source
+    extend Forwardable
+
+    attr_reader :path, :content
+    def_delegators :visitor, :entities
+
+    def self.from(path:)
+      new(path: path, content: File.read(path))
+    end
+
+    def initialize(path:, content:)
+      @path = path
+      @content = content
+    end
+
+    def problematic?
+      problems.count.positive?
+    end
+
+    def problems
+      @problems ||=
+        entities
+        .reject(&:single_line?)
+        .reject(&method(:commented?))
+        .map { |ent| Problem.new(ent, line(number: ent.last_line)) }
+    end
+
+    def fix
+      lines.map.with_index(1) { |default, no| fixes[no] || default }.join("\n")
+    end
+
+    private
+
+    def fixes
+      @fixes ||=
+        problems
+        .map { |problem| [problem.line, problem.fix] }
+        .to_h
+    end
+
+    def line(number:)
+      lines[number - 1]
+    end
+
+    def lines
+      @lines ||= content.split("\n").push('')
+    end
+
+    # This method reeks of :reek:FeatureEnvy (entity).
+    def commented?(entity)
+      line(number: entity.last_line).end_with?(entity.ending)
+    end
+
+    def visitor
+      @visitor ||= visitor_class.new(content)
+    end
+
+    def visitor_class
+      path.end_with?('_spec.rb') ? Visitor::Spec : Visitor
+    end
+
+    class Problem
+      def initialize(entity, line)
+        @entity = entity
+        @line = line
+      end
+
+      def line
+        @entity.last_line
+      end
+
+      def column
+        @line.index('end')
+      end
+
+      def fix
+        @line[0...column] + @entity.ending
+      end
+
+      def message
+        "missing #{@entity.entity} closing comment"
+      end
+
+      def to_h
+        {
+          line: line,
+          column: column,
+          message: message,
+        }
+      end
+    end # class Problem
+
+    class Visitor
+      attr_reader :entities
+
+      def initialize(content)
+        @entities = []
+        recursively_visit(Parser::Ruby24.parse(content))
+        entities.freeze
+      end
+
+      private
+
+      def recursively_visit(node)
+        return unless node.is_a?(Parser::AST::Node)
+        visit_current(node)
+        node.children.each(&method(:recursively_visit))
+      end
+
+      def visit_current(node)
+        case node.type
+        when :class then entities << Commentable::Class.new(node)
+        when :module then entities << Commentable::Module.new(node)
+        end
+      end
+
+      class Spec < Visitor
+        private
+
+        def visit_current(node)
+          return super unless node.type == :block
+          block = Commentable::Block.new(node)
+          entities << block if block.commentable?
+        end
+      end # class Spec
+    end # class Visitor
+    private_constant :Visitor
+  end # class Source
+end # module ClosingComments

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: closing_comments
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Marcin Wyszynski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Helper to add closing comments to Ruby entities
+email: 
+executables:
+- closing_comments
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/closing_comments
+- ensure_version.rb
+- lib/closing_comments.rb
+- lib/closing_comments/commentable.rb
+- lib/closing_comments/processor.rb
+- lib/closing_comments/source.rb
+homepage: https://github.com/marcinwyszynski/closing_comments
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Helper to add closing comments to Ruby entities
+test_files: []