rubocop-rails-order_model_macros 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9910318653f0f4e74ea09b0c8ff74af711c57ec8
+  data.tar.gz: 67052e409250b6bb5ef0562ec0cfbe1978f5bb93
+SHA512:
+  metadata.gz: fac171e9a0b679a4d2b89ed91c906c94022ede67bfa3e03ec18d91efcea02d8907476383f8f6dd302cb741a1eb9666532be01f29ff63635611d18117979488b1
+  data.tar.gz: 2243b42702576db4dd8e4523218a4fff0c1abb485b6557cd3431cd6922b9c579958243549ac917b28e1329ef04a6073af7bab85b727027fb68d128b1f7c2bed6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at caroline.artz@centro.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rubocop-rails-order_model_declarative_methods.gemspec
+# gem 'rubocop', git: "https://github.com/bbatsov/rubocop.git"
+gem 'rubocop', '~> 0.47.1'
+gem 'pry'
+gemspec
+
+gem "awesome_print", require: false

data/MIT_LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) Joshua Hagins <hagins.josh@gmail.com>
+
+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,39 @@
+# RuboCop::Rails::OrderModelMacros
+
+TODO: Add overview/docs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-rails-order_model_macros'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubocop-rails-order_model_macros
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-rails-order_model_macros. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop/rails/order_model_macros"
+
+# 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/config/default.yml

@@ -0,0 +1,31 @@
+Rails/OrderModelMacros:
+  Description: 'Sort macros methos in Rails models.'
+  Enabled: true
+  PreferredGroupOrdering:
+    - default_scope
+    - class_method
+    - enum
+    - association
+    - validation
+    - callback
+    - delegate
+    - rails
+    - gem
+    - custom
+    - scope
+  PreferredInnerGroupOrdering:
+    association:
+      - belongs_to
+      - has_one
+      - has_and_belongs_to_many
+      - has_many
+    validation:
+      - validates
+      - validate
+      - with_options
+  Rails:
+    - accepts_nested_attributes_for
+    - serialize
+    - store_accessor
+  Custom: null
+  Gem: null

data/lib/rubocop-rails-order_model_macros.rb

@@ -0,0 +1,13 @@
+require 'pathname'
+require 'yaml'
+
+require 'rubocop'
+require 'rubocop/rails/order_model_macros'
+require 'rubocop/rails/order_model_macros/configuration'
+require 'rubocop/rails/order_model_macros/version'
+require 'rubocop/rails/inject'
+
+RuboCop::Rails::Inject.defaults!
+
+# cops
+require 'rubocop/cop/rails/order_model_macros'

data/lib/rubocop/cop/rails/order_model_macros.rb

@@ -0,0 +1,152 @@
+module RuboCop
+  module Cop
+    module Rails
+      class OrderModelMacros < Cop
+        include RuboCop::Rails::OrderModelMacros::Configuration
+
+        MSG = "Macros are not properly sorted."
+        MSG_OUTER_GROUPS = "Macro method groups not sorted. Move %{group1} above %{group2}.".freeze
+        MSG_WITHIN_GROUP = "Not sorted within %{type}. Move %{method1} above %{method2}.".freeze
+
+        DEFAULT_SCOPE = :default_scope
+        CLASS_METHODS = /^[mc]attr_(reader|writer|accessor)/
+        ENUM = :enum
+        CALLBACKS = /^(before|around|after)_\w*/
+        DELEGATE = :delegate
+        SCOPE = :scope
+
+        GROUPED = %i(
+          association
+          validation
+        ).freeze
+
+        def on_class(node)
+          _name, superclass, body = *node
+
+          return unless body
+          return unless body.begin_type?
+          return unless %w(ActiveRecord ApplicationRecord).include?(superclass.descendants.first.const_name)
+
+          targets = target_methods(body)
+          return true if correct_grouping?(targets) && correct_within_groups?(targets)
+
+          add_offense(body, :expression, @message || MSG)
+        end
+
+        private
+
+        def target_types(targets)
+          targets.map { |target| method_type(target) }
+        end
+
+        def correct_within_groups?(targets)
+          grouped = targets
+            .group_by { |target| method_type(target) }
+            .keep_if { |type, _targets| GROUPED.include?(type) }
+
+          grouped.all? do |type, targets_for_type|
+            ordered_for_type = preferred_group_ordering[type]
+            squeezed = squeeze(targets_for_type.map(&:method_name))
+
+            a = (ordered_for_type & squeezed)
+            b = (squeezed & ordered_for_type)
+
+            a == b || (set_within_group_error_message(type, a, b) and false)
+          end
+        end
+
+        def plural_form(group)
+          group.to_s + "s"
+        end
+
+        def correct_grouping?(targets)
+          target_types = target_types(targets)
+          return false unless single_groups?(target_types)
+
+          type_order = preferred_group_ordering.keys
+          squeezed = squeeze(target_types)
+
+          a = type_order & squeezed
+          b = squeezed & type_order
+
+          a == b || (set_outer_group_error_message(a, b) and false)
+        end
+
+        def single_groups?(targets)
+          squeeze(targets) == targets.uniq
+        end
+
+        def squeeze(targets)
+          targets.each_with_object([]) do |el, squeezed|
+            squeezed << el unless squeezed.last == el
+          end
+        end
+
+        def target_methods(body)
+          body.children.compact.select do |child|
+            child.send_type? && matches_targets?(child.method_name)
+          end
+        end
+
+        def matches_targets?(declared)
+          all_targets[:regexps].any? { |regex| regex === declared } || all_targets[:names].include?(declared)
+        end
+
+        def all_targets
+          types = preferred_group_ordering
+            .values
+            .flatten
+            .partition { |target_type| target_type.is_a?(Regexp) }
+
+          {
+            regexps: types.first, # array of Regexps
+            names: types.last # array of Symbols
+          }
+        end
+
+        def target_mapping
+          {
+            default_scope: DEFAULT_SCOPE,
+            class_method: CLASS_METHODS,
+            enum: ENUM,
+            association: association_macros,
+            validation: validation_macros,
+            callback: CALLBACKS,
+            delegate: DELEGATE,
+            rails: rails_macros,
+            gem: gem_macros,
+            custom: custom_macros,
+            scope: SCOPE
+          }
+        end
+
+        def method_type(target)
+          case target.method_name
+          when DEFAULT_SCOPE          then :default_scope
+          when CLASS_METHODS          then :class_method
+          when ENUM                   then :enum
+          when CALLBACKS              then :callback
+          when DELEGATE               then :delegate
+          when SCOPE                  then :scope
+          when *association_macros    then :association
+          when *custom_macros         then :custom
+          when *gem_macros            then :gem
+          when *rails_macros          then :rails
+          when *validation_macros     then :validation
+          else raise "Unreachable code"
+          end
+        end
+
+        def set_outer_group_error_message(a, b)
+          first_error = a.zip(b).find { |x, y| x != y }
+          @message = MSG_OUTER_GROUPS % {group1: plural_form(first_error.first), group2: plural_form(first_error.last)}
+        end
+
+        def set_within_group_error_message(type, a, b)
+          first_error = a.zip(b).find { |x, y| x != y }
+          @message = MSG_WITHIN_GROUP % {type: plural_form(type), method1: first_error.first, method2: first_error.last}
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rails/inject.rb

@@ -0,0 +1,24 @@
+# This file is copied from rubocop-rspec
+require 'yaml'
+require 'pry'
+
+module RuboCop
+  module Rails
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      DEFAULT_FILE = File.expand_path(
+        '../../../../config/default.yml', __FILE__
+      )
+
+      def self.defaults!
+        hash = ConfigLoader.send(:load_yaml_configuration, DEFAULT_FILE)
+        config = Config.new(hash, DEFAULT_FILE)
+        puts "configuration from #{DEFAULT_FILE}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, DEFAULT_FILE)
+
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/rails/order_model_macros.rb

@@ -0,0 +1,6 @@
+module RuboCop
+  module Rails
+    module OrderModelMacros
+    end
+  end
+end

data/lib/rubocop/rails/order_model_macros/configuration.rb

@@ -0,0 +1,36 @@
+module RuboCop
+  module Rails
+    module OrderModelMacros
+      module Configuration
+        def preferred_group_ordering
+          @preferred_group_ordering ||= begin
+            groups = @config.for_cop('Rails/OrderModelMacros')['PreferredGroupOrdering'].map(&:to_sym) || []
+            groups.each_with_object({}) do |group, mapping|
+              mapping[group] = target_mapping[group]
+            end
+          end
+        end
+
+        def custom_macros
+          @custom_macros ||= (config = @config.for_cop('Rails/OrderModelMacros')['Custom'] and config.map(&:to_sym)) || []
+        end
+
+        def rails_macros
+          @rails_macros ||= (@config.for_cop('Rails/OrderModelMacros')['Rails'].map(&:to_sym) || [])
+        end
+
+        def gem_macros
+          @gem_macros ||= (config = @config.for_cop('Rails/OrderModelMacros')['Gem'] and config.map(&:to_sym)) || []
+        end
+
+        def association_macros
+          @association_macros ||= (@config.for_cop('Rails/OrderModelMacros')['PreferredInnerGroupOrdering']['association'].map(&:to_sym) || [])
+        end
+
+        def validation_macros
+          @validation_macros ||= (@config.for_cop('Rails/OrderModelMacros')['PreferredInnerGroupOrdering']['validation'].map(&:to_sym) || [])
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rails/order_model_macros/version.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+
+module RuboCop
+  module Rails
+    module OrderModelMacros
+      module Version
+        STRING = "0.1.1".freeze
+
+        def self.gem_version
+          Gem::Version.new(STRING)
+        end
+      end
+    end
+  end
+end

data/rubocop-rails-order_model_macros.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rubocop/rails/order_model_macros/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-rails-order_model_macros"
+  spec.version       = RuboCop::Rails::OrderModelMacros::Version::STRING
+  spec.authors       = ["Caroline Artz"]
+  spec.email         = ["ceartz@gmail.com"]
+
+  spec.summary       = "Extension of RuboCop for ordering macro style methods in Rails models"
+  spec.description   = "Extension of RuboCop for ordering macro style methods in Rails models"
+  spec.homepage      = "https://github.com/carolineartz/rubocop-rails-order_model_macros"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rubocop', '~> 0.47.1'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "rspec", "~> 3.4"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-rails-order_model_macros
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Caroline Artz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.47.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Extension of RuboCop for ordering macro style methods in Rails models
+email:
+- ceartz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- MIT_LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/default.yml
+- lib/rubocop-rails-order_model_macros.rb
+- lib/rubocop/cop/rails/order_model_macros.rb
+- lib/rubocop/rails/inject.rb
+- lib/rubocop/rails/order_model_macros.rb
+- lib/rubocop/rails/order_model_macros/configuration.rb
+- lib/rubocop/rails/order_model_macros/version.rb
+- rubocop-rails-order_model_macros.gemspec
+homepage: https://github.com/carolineartz/rubocop-rails-order_model_macros
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Extension of RuboCop for ordering macro style methods in Rails models
+test_files: []