dark_finger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2175e36eaa195b08572b40995a9291bf961bba87
+  data.tar.gz: 5419ca9cfd34ccf28fc360da5b57cc98697c04fb
+SHA512:
+  metadata.gz: 29e2b1f85d9d3ceb0027cc5596faf57fcd31de49460f1b6bca740ffb6be9f6a1d85f8bbef1f285c881c13bc8c8e768f1dfc24a5c5667f8ad2e0b145086a3d735
+  data.tar.gz: 528bfdced0087243bede4441486f3c63aa53cc0d284043dc42a85a97a0df08bd0fc582620b2e593e2f9a60188b091b54d61fb30f7be4780327a5fdcb909f4896

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Professor Wang Matrix PhD
+
+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,82 @@
+# DarkFinger
+
+A Rubocop extension to check the layout of ActiveModel files. The cop will
+check that elements appear together, in the right order, and commented as
+desired.
+
+Supported elements:
+
+* associations
+* attributes
+* callbacks
+* constants
+* enums
+* includes
+* modules
+* scopes
+* validations
+* class_methods
+* instance_methods
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dark_finger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dark_finger
+
+## Usage
+
+Install the gem. Then, in your `.rubycop.yml` file, require `dark_finger` and
+add your desired config.
+
+For example, here is the default config:
+
+```ruby
+# in .rubocop.yml
+
+
+# this is required
+require: dark_finger
+
+DarkFinger/ModelStructure:
+  enabled: true
+  required_order:
+    - module
+    - include
+    - enum
+    - constant
+    - association
+    - validation
+    - scope
+    - attributes
+    - callback
+    - class_method
+    - instance_method
+  required_comments:
+    association: Relationships
+    attribute: Attributes
+    callback: Callbacks
+    constant: Constants
+    enum: Enums
+    include: Includes
+    module: Modules
+    scope: Scopes
+    validation: Validation
+
+```
+
+## 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 "dark_finger"
+
+# 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/dark_finger.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dark_finger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dark_finger"
+  spec.version       = DarkFinger::VERSION
+  spec.authors       = ["Professor Wang Matrix PhD", "Urban Cougar"]
+  spec.email         = ["professor.wang.matrix.phd@gmail.com", "urbancougarltd@gmail.com"]
+
+  spec.summary       = "ActiveModel layout cop for Rubocop"
+  spec.homepage      = "https://github.com/the-suBLAM-executive-council/dark_finger"
+  spec.license       = "MIT"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency 'rubocop', '>= 0.58.0'
+end

data/lib/dark_finger/version.rb

@@ -0,0 +1,3 @@
+module DarkFinger
+  VERSION = "0.1.1"
+end

data/lib/dark_finger.rb

@@ -0,0 +1,4 @@
+require 'rubocop'
+require "dark_finger/version"
+require File.dirname(__FILE__) + "/rubocop/cop/dark_finger/model_structure"
+require File.dirname(__FILE__) + "/rubocop/cop/dark_finger/active_model_node_decorator"

data/lib/rubocop/cop/dark_finger/active_model_node_decorator.rb

@@ -0,0 +1,113 @@
+module RuboCop
+  module Cop
+    module DarkFinger
+      class ActiveModelNodeDecorator < SimpleDelegator
+        def initialize(node)
+          super
+        end
+
+        def node_type
+          if validation?
+            ModelStructure::VALIDATION
+          elsif association?
+            ModelStructure::ASSOCIATION
+          elsif callback?
+            ModelStructure::CALLBACK
+          elsif scope?
+            ModelStructure::SCOPE
+          elsif is_include?
+            ModelStructure::INCLUDE
+          elsif enum?
+            ModelStructure::ENUM
+          elsif attributes?
+            ModelStructure::ATTRIBUTES
+          else
+            nil
+          end
+        end
+
+        def ignore_due_to_nesting?
+          return false if nested_directly_in_class?
+          return false if nested_in_with_options?
+          true
+        end
+
+        def preceeding_comment(processed_source)
+          comment = processed_source.ast_with_comments[self].last&.text
+          return comment if comment
+
+          # This is needed since, in this example, ast_with_comments maps the
+          # comment to `:foo` instead of the outter `validate`. Not sure how
+          # else to do this.
+          #
+          # ## Validations ##
+          # validate { :foo }
+          comment = processed_source.comments.find do |comment|
+            comment.location.line == location.first_line - 1
+          end
+
+          return comment.text if comment
+
+          if nested_in_with_options?
+            ActiveModelNodeDecorator.new(parent).preceeding_comment(processed_source)
+          end
+        end
+
+        private
+
+        def nested_in_with_options?
+          parent&.method_name == :with_options
+        end
+
+        def nested_directly_in_class?
+          return false unless parent
+
+          return true if parent.class_type?
+
+          return true if parent.begin_type? && parent.parent&.class_type?
+
+          if parent.block_type? || parent.lambda_or_proc?
+            grand_parent = parent.parent
+            great_grand_parent = parent.parent&.parent
+            return true if grand_parent.begin_type? && great_grand_parent&.class_type?
+          end
+
+          false
+        end
+
+        def validation?
+          method_name =~ /^validate/
+        end
+
+        def association?
+          method_name =~ /^(has_one|has_many|has_and_belongs_to_many|belongs_to)$/
+        end
+
+        def callback?
+          method_name =~ %r{
+            ^(after|before|around)
+            _
+            (initialize|find|touch|save|validation|create|update|destroy|commit|rollback)$
+          }x
+        end
+
+        def scope?
+          method_name =~ /(default_)?scope/
+        end
+
+        def is_include?
+          method_name.to_s == 'include'
+        end
+
+        def enum?
+          method_name.to_s == 'enum'
+        end
+
+        def attributes?
+          method_name =~ /^attr_/
+        end
+      end
+
+    end
+  end
+end

data/lib/rubocop/cop/dark_finger/model_structure.rb

@@ -0,0 +1,148 @@
+# bundle exec rubocop -d  -r ./path/to/this/cop.rb --only DarkFinger/ModelStructure ./app/models/foo.rb
+#
+# TODO:
+#
+# * Constructors
+# * Handle "Misc" stuff
+
+require File.dirname(__FILE__) + '/active_model_node_decorator'
+
+module RuboCop
+  module Cop
+    module DarkFinger
+      class ModelStructure < ::RuboCop::Cop::Cop
+        ASSOCIATION = :association
+        ATTRIBUTES = :attribute
+        CALLBACK = :callback
+        CLASS_METHOD = :class_method
+        CONSTANT = :constant
+        ENUM = :enum
+        INCLUDE = :include
+        INSTANCE_METHOD = :instance_method
+        MODULE = :module
+        SCOPE = :scope
+        VALIDATION = :validation
+
+        DEFAULT_REQUIRED_ORDER = [
+          MODULE,
+          INCLUDE,
+          ENUM,
+          CONSTANT,
+          ASSOCIATION,
+          VALIDATION,
+          SCOPE,
+          ATTRIBUTES,
+          CALLBACK,
+          CLASS_METHOD,
+          INSTANCE_METHOD,
+        ]
+
+        DEFAULT_REQUIRED_COMMENTS = {
+          ASSOCIATION => 'Relationships',
+          ATTRIBUTES => 'Attributes',
+          CALLBACK => 'Callbacks',
+          CONSTANT => 'Constants',
+          ENUM => 'Enums',
+          INCLUDE => 'Includes',
+          MODULE => 'Modules',
+          SCOPE => 'Scopes',
+          VALIDATION => 'Validations'
+        }
+
+        attr_reader :required_order, :required_comments
+
+        def initialize(*args, required_order: nil, required_comments: nil, **_)
+          super
+          @class_elements_seen = []
+          @required_order = required_order || cop_config['required_order'] || DEFAULT_REQUIRED_ORDER
+          @required_comments = required_comments || cop_config['required_comments'] || DEFAULT_REQUIRED_COMMENTS
+
+          # symbolize order/comments
+          @required_order.map!(&:to_sym)
+          @required_comments = Hash[ @required_comments.map {|k,v| [k.to_sym, v]} ]
+        end
+
+        def on_send(node)
+          process_node(node)
+        end
+
+        def on_casgn(node)
+          process_node(node, seen_element: CONSTANT)
+        end
+
+        def on_module(node)
+          process_node(node, seen_element: MODULE)
+        end
+
+        def on_def(node)
+          process_node(node, seen_element: INSTANCE_METHOD)
+        end
+
+        def on_defs(node)
+          process_node(node, seen_element: CLASS_METHOD)
+        end
+
+        private
+
+        attr_reader :class_elements_seen
+
+        def process_node(node, seen_element: nil)
+          return if @order_violation_reported
+
+          node = ActiveModelNodeDecorator.new(node)
+          seen_element ||= node.node_type
+
+          return unless seen_element
+
+          return if node.ignore_due_to_nesting?
+
+          if first_time_seeing?(seen_element)
+            detect_comment_violation(node, seen_element)
+          end
+
+          seen(seen_element)
+          detect_order_violation(node)
+        end
+
+        def seen(class_element)
+          return unless required_order.include?(class_element)
+          class_elements_seen << class_element
+          class_elements_seen.compact!
+        end
+
+        def first_time_seeing?(class_element)
+          !class_elements_seen.include?(class_element)
+        end
+
+        def detect_comment_violation(node, class_element)
+          return false unless required_comments[class_element]
+
+          comment = node.preceeding_comment(processed_source)
+          unless comment && comment =~ Regexp.new(%Q(^\s*##\s*#{required_comments[class_element]} ##$))
+            add_offense(node, message: "Expected preceeding comment: \"## #{required_comments[class_element]} ##\"")
+          end
+        end
+
+        def detect_order_violation(node)
+          if order_violation_detected?
+            @order_violation_reported = true
+            add_offense(
+              node,
+              message: "Model elements must appear in order: \n\n* #{required_order.join("\n* ")}\n".freeze
+            )
+          end
+        end
+
+        def order_violation_detected?
+          required_order_for_elements_seen != class_elements_seen
+        end
+
+        def required_order_for_elements_seen
+          class_elements_seen.sort do |class_elem_1, class_elem_2|
+            required_order.index(class_elem_1) <=> required_order.index(class_elem_2)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: dark_finger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Professor Wang Matrix PhD
+- Urban Cougar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+description: 
+email:
+- professor.wang.matrix.phd@gmail.com
+- urbancougarltd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dark_finger.gemspec
+- lib/dark_finger.rb
+- lib/dark_finger/version.rb
+- lib/rubocop/cop/dark_finger/active_model_node_decorator.rb
+- lib/rubocop/cop/dark_finger/model_structure.rb
+homepage: https://github.com/the-suBLAM-executive-council/dark_finger
+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.5.2.1
+signing_key: 
+specification_version: 4
+summary: ActiveModel layout cop for Rubocop
+test_files: []