mixin_comment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3ba1d04a4df226d3003ee545eff150313db134be536c2d9947222400c0b4713
+  data.tar.gz: 6c925dcf01c961cbc2232070d47bc8eac9c4ddba0c6f211c3ec6190c430d962e
+SHA512:
+  metadata.gz: ffd54ff8b9a130c673f07820d9a0afb2fe2ee97ddcc508de4d0ea43ba2b8532f3d7b658976e8e8714ab447045caaa2af8d24cbe3b3dcb64e98790030cfce720a
+  data.tar.gz: a056874441c344682264bc6f4c1d6b123af42db0c46fb556416d5d5c4f003e0a68afc360f16f18772e358772720a688334a7fbe9c2cf0bfe5936d7195efdd510

data/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7, 3.0]
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        exclude:
+          - ruby: 3.0
+            gemfile: rails50
+          - ruby: 3.0
+            gemfile: rails51
+          - ruby: 3.0
+            gemfile: rails52
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Prepare test
+      run: |
+        cd spec/dummy
+        BUNDLE_GEMFILE=../../${{ env.BUNDLE_GEMFILE }} RAILS_ENV=test bundle exec rake db:create db:migrate
+        cd ../..
+    - name: Run test
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+.project
+Gemfile.lock
+coverage/
+gemfiles/*.lock
+pkg/
+tmp/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/schema_*.rb
+spec/dummy/log/*.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+* First release.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yoshikazu Kaneta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# MixinComment
+
+Verification of comments for roughly designed mixin module.
+
+## Dependencies
+
+* ruby 2.6+
+* activesupport 5.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mixin_comment'
+```
+
+Then execute:
+
+    $ bundle
+
+## Usage
+
+Add comments with specific labels preceding to the module definition.
+For example:
+
+```ruby
+# [required methods] method, method2
+module A
+  def call_method
+    method
+  end
+
+  def call_method2
+    method2
+  end
+end
+
+class Item
+  include A
+
+  def method
+  end
+end
+```
+
+The label `[required methods]` means that the class `Item` which includes the module `A` should have two methods named `method` and `method2`.
+You can verify validity of classes as follows:
+
+```ruby
+# speficy your directory which contains *.rb files
+results = MixinComment.verify('app')
+
+results[0].module_name
+#=> "A"
+results[0].label
+#=> "required methods"
+results[0].errors
+#=> [[Item, "method2"]]
+```
+
+In this example the class `Item` does not have `method2`,
+so `[[Item, "method2"]]` is returned as an error.
+
+### Supported labels
+
+Following labels are available:
+
+* `required methods`: verify existence of instance methods in classes.
+* `required class methods`: verify existence of class methods in classes.
+* `required override methods`: verify existence of override methods in classes.
+
+Special labels for ActiveRecord models are also available:
+
+* `required columns`: verify existence of columns in ActiveRecord models.
+* `required associations`: verify existence of associations in ActiveRecord models.
+
+### For Rails
+
+In case you develops rails application, rake task is available:
+
+```shell-session
+$ bundle exec rake mixin_comment:verify
+Item#method2 is required method by A
+```
+
+Note that database schema will be loaded to define attribute methods for ActiveRecord model.
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/kanety/mixin_comment.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mixin_comment"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails50.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.0.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.1.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/mixin_comment.rb

@@ -0,0 +1,24 @@
+require 'rdoc'
+require 'active_support/all'
+
+require 'mixin_comment/version'
+require 'mixin_comment/part'
+require 'mixin_comment/loader'
+require 'mixin_comment/parser'
+require 'mixin_comment/verifier'
+require 'mixin_comment/railtie' if defined?(Rails)
+
+module MixinComment
+  class << self
+    def verify(dirs)
+      parts = Parser.new(dirs).call
+
+      Loader.new(dirs).call
+
+      parts.each do |part|
+        Verifier.new(part).call
+      end
+      parts
+    end
+  end
+end

data/lib/mixin_comment/loader.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module MixinComment
+  class Loader
+    def initialize(dirs)
+      @dirs = Array(dirs)
+    end
+
+    def call
+      load
+      load_rails if defined? Rails
+    end
+
+    private
+
+    def load
+      Dir[@dirs.map { |dir| "#{dir}/**/*.rb" }.join(',')].each do |path|
+        full_path = path
+        full_path = File.join(Dir.pwd, full_path) unless path.start_with?('/')
+        require full_path
+      end
+    end
+
+    def load_rails
+      Rails.application.eager_load!
+      ActiveRecord::Base.descendants.each(&:define_attribute_methods)
+    end
+  end
+end

data/lib/mixin_comment/parser.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MixinComment
+  class Parser
+    def initialize(dirs)
+      @dirs = Array(dirs)
+      @parts = []
+    end
+
+    def call
+      rdoc = RDoc::RDoc.new
+      rdoc.document(['--dry-run'] + @dirs)
+
+      rdoc.generator.classes.each do |mod|
+        next unless mod.module?
+        mod.comment_location.each do |comments|
+          comments.each do |comment|
+            if comment.is_a?(RDoc::Comment)
+              parse_module_comment(mod, comment)
+            end
+          end
+        end
+      end
+
+      @parts
+    end
+
+    private
+
+    def parse_module_comment(mod, comment)
+      comment.parse.parts.each do |part|
+        if part.type == :LABEL
+          part.items.each do |item|
+            if item.label[0].in?(MixinComment::Part::LABELS)
+              parse_label_parts(mod, item.label[0], item.parts)
+            end
+          end
+        end
+      end
+    end
+
+    def parse_label_parts(mod, label, parts)
+      attributes = parts.map do |part|
+        part.parts.map do |text|
+          text.strip.split(/\s*,\s*/)
+        end
+      end.flatten.compact
+
+      @parts << Part.new(mod.full_name, label, attributes)
+    end
+  end
+end

data/lib/mixin_comment/part.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MixinComment
+  class Part
+    LABELS = [
+      'required methods',
+      'required class methods',
+      'required override methods',
+      'required columns',
+      'required associations'
+    ]
+
+    attr_accessor :module_name, :label, :attributes
+    attr_accessor :errors
+
+    def initialize(module_name, label, attributes)
+      @module_name = module_name
+      @label = label
+      @attributes = attributes
+      @errors = []
+    end
+
+    def has_errors?
+      @errors.present?
+    end
+
+    def show_errors
+      errors.each do |klass, attr|
+        puts "#{klass}##{attr} is #{label.singularize} by #{module_name}"
+      end
+    end
+  end
+end

data/lib/mixin_comment/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module MixinComment
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'mixin_comment/tasks/verify.rake'
+    end
+  end
+end

data/lib/mixin_comment/tasks/verify.rake

@@ -0,0 +1,8 @@
+namespace :mixin_comment do
+  desc 'Verify mixin comments'
+  task :verify => :environment do
+    dirs = ENV.key?('DIRS') ? ENV['DIRS'].split(',') : [Rails.root.join('app').to_s]
+    results = MixinComment.verify(dirs)
+    results.each(&:show_errors)
+  end
+end

data/lib/mixin_comment/verifier.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module MixinComment
+  class Verifier
+    def initialize(part)
+      @part = part
+    end
+
+    def call
+      included_classes(@part.module_name).each do |klass|
+        @part.attributes.each do |attr|
+          send("verify_#{@part.label.gsub(' ', '_')}", klass, attr)
+        end
+      end
+    end
+
+    private
+
+    def included_classes(module_name)
+      mod = module_name.constantize
+      klasses = ObjectSpace.each_object(Class).to_a
+      klasses.select { |klass| klass.included_modules.include?(mod) }.sort_by(&:name)
+    end
+
+    def verify_required_methods(klass, attr)
+      unless klass.method_defined?(attr)
+        @part.errors << [klass, attr]
+      end
+    end
+
+    def verify_required_class_methods(klass, attr)
+      unless klass.singleton_class.method_defined?(attr)
+        @part.errors << [klass, attr]
+      end
+    end
+
+    def verify_required_override_methods(klass, attr)
+      unless klass.method_defined?(attr, false)
+        @part.errors << [klass, attr]
+      end
+    end
+
+    def verify_required_columns(klass, attr)
+      unless klass.column_names.include?(attr)
+        @part.errors << [klass, attr]
+      end
+    end
+
+    def verify_required_associations(klass, attr)
+      unless klass.reflect_on_association(attr)
+        @part.errors << [klass, attr]
+      end
+    end
+  end
+end

data/lib/mixin_comment/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MixinComment
+  VERSION = '0.1.0'
+end

data/mixin_comment.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mixin_comment/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mixin_comment"
+  spec.version       = MixinComment::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  spec.email         = ["kaneta@sitebridge.co.jp"]
+  spec.summary       = %q{Verification of comments for roughly designed mixin module}
+  spec.description   = %q{Verification of comments for roughly designed mixin module}
+  spec.homepage      = "https://github.com/kanety/mixin_comment"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "rdoc"
+
+  spec.add_development_dependency "rails", ">= 5.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: mixin_comment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Verification of comments for roughly designed mixin module
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- lib/mixin_comment.rb
+- lib/mixin_comment/loader.rb
+- lib/mixin_comment/parser.rb
+- lib/mixin_comment/part.rb
+- lib/mixin_comment/railtie.rb
+- lib/mixin_comment/tasks/verify.rake
+- lib/mixin_comment/verifier.rb
+- lib/mixin_comment/version.rb
+- mixin_comment.gemspec
+homepage: https://github.com/kanety/mixin_comment
+licenses: []
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Verification of comments for roughly designed mixin module
+test_files: []