must_be_ordered 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a1a7de42fce71b462168b877fea343b390e652444fd108b600acab085e698ef
+  data.tar.gz: 8f922bf53233ad23f302c92ea2a14cc6424d32c47cdbe016257c910ab14cad96
+SHA512:
+  metadata.gz: 74b85a2342e60b86b7046e6b7af40bb0edc51654ac993c620b1bca194df1374652a9bb7868f241f437711edcf97ec8027e7ebb0912a666e858bdd5746caf73f7
+  data.tar.gz: 3aff39148e50ae49c271f548726804ac67f68b1eef9937e20e67e2b9cc431ef89ab96e6265ea25965a30bbbe537d36fa2ba340dd67b64209e584a1c0c48f2a6f

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+  - 2.4.4
+  - 2.3.6
+before_install: gem install bundler -v 1.16.2
+gemfile:
+  - Gemfile.rails-5.2
+  - Gemfile.rails-5.1
+  - Gemfile.rails-5.0

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in must_be_ordered.gemspec
+gemspec
+
+gem 'activerecord', '~> 5.2'

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    must_be_ordered (0.1.0)
+      activerecord (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.2)
+  bundler (~> 1.16)
+  must_be_ordered!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+
+BUNDLED WITH
+   1.16.2

data/Gemfile.rails-5.0

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in must_be_ordered.gemspec
+gemspec
+
+gem 'activerecord', '~> 5.0'

data/Gemfile.rails-5.1

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in must_be_ordered.gemspec
+gemspec
+
+gem 'activerecord', '~> 5.1'

data/Gemfile.rails-5.2

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in must_be_ordered.gemspec
+gemspec
+
+gem 'activerecord', '~> 5.2'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 pi-chan
+
+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,48 @@
+# MustBeOrdered
+
+[![Build Status](https://travis-ci.org/pi-chan/must_be_ordered.svg?branch=master)](https://travis-ci.org/pi-chan/must_be_ordered)
+
+`must_be_ordered` gem is to warn or raise error if `order` is not set to ActiveRecord's Relation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'must_be_ordered'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Configuration:
+
+```ruby
+# config/initializers/must_be_ordered.rb
+MustBeOrdered.enabled = !Rails.env.production?
+
+# choose action you need
+MustBeOrdered.raise = true
+MustBeOrdered.must_be_ordered_logger = true
+MustBeOrdered.rails_logger = true
+```
+
+Models:
+
+```ruby
+class Item < ActoveRecord::Base
+  must_be_ordered
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pi-chan/must_be_ordered.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://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 "must_be_ordered"
+
+# 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(__FILE__)

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/lib/must_be_ordered.rb

@@ -0,0 +1,42 @@
+require "active_record"
+
+require "must_be_ordered/version"
+require "must_be_ordered/notifier"
+require "must_be_ordered/stack_trace_filter"
+require "must_be_ordered/relation_check"
+
+module MustBeOrdered
+  class << self
+    def enabled=(value)
+      @enabled = value
+    end
+
+    def enabled?
+      !!@enabled
+    end
+
+    def raise=(should_raise)
+      Notifier.exception_class = (should_raise ? MustBeOrdered::OrderNotApplied : nil)
+    end
+
+    def rails_logger=(active)
+      Notifier.rails_logger = active
+    end
+
+    def must_be_ordered_logger=(active)
+      Notifier.customized_logger = active
+    end
+  end
+
+  def self.extended(klass)
+    klass.class_eval do
+      class_attribute :__must_be_ordered__
+    end
+  end
+
+  def must_be_ordered
+    self.__must_be_ordered__ = true
+  end
+end
+
+ActiveRecord::Base.extend MustBeOrdered

data/lib/must_be_ordered/notifier.rb

@@ -0,0 +1,33 @@
+module MustBeOrdered
+  module Notifier
+    module_function
+
+    def exception_class=(should_raise)
+      @exception_class = (should_raise ? MustBeOrdered::OrderNotApplied : nil)
+    end
+
+    def customized_logger=(active)
+      return unless active
+      require 'fileutils'
+      require 'logger'
+      root_path = (defined?(::Rails) ? Rails.root.to_s : Dir.pwd).to_s
+      FileUtils.mkdir_p(root_path + '/log')
+      must_be_ordered_log_file = File.open("#{root_path}/log/must_be_ordered.log", 'a+')
+      must_be_ordered_log_file.sync = true
+      @customized_logger = Logger.new(must_be_ordered_log_file)
+      def @customized_logger.format_message(severity, timestamp, _progname, msg)
+        "#{timestamp.strftime('%Y-%m-%d %H:%M:%S')}[#{severity}] #{msg}"
+      end
+    end
+
+    def rails_logger=(active)
+      @rails_logger = active
+    end
+
+    def notify(message)
+      @customized_logger.warn(message) if @customized_logger
+      Rails.logger.warn(message) if @rails_logger
+      raise @exception_class, message if @exception_class
+    end
+  end
+end

data/lib/must_be_ordered/relation_check.rb

@@ -0,0 +1,21 @@
+module MustBeOrdered
+  class OrderNotApplied < StandardError; end
+
+  module RelationCheck
+    include StackTraceFilter
+
+    private
+
+    def exec_queries(&block)
+      return super unless MustBeOrdered.enabled?
+
+      if klass.__must_be_ordered__? && order_values.empty?
+        trace = caller_in_project.join("\n")
+        Notifier.notify("MustBeOrdered order not applied #{klass.to_s}:\n#{trace}")
+      end
+      super
+    end
+  end
+end
+
+ActiveRecord::Relation.prepend MustBeOrdered::RelationCheck

data/lib/must_be_ordered/stack_trace_filter.rb

@@ -0,0 +1,63 @@
+module MustBeOrdered
+  module StackTraceFilter
+    VENDOR_PATH = '/vendor'
+
+    def caller_in_project
+      app_root = defined?(::Rails) ? Rails.root.to_s : Dir.pwd
+      vendor_root = app_root + VENDOR_PATH
+      bundler_path = Bundler.bundle_path.to_s
+      select_caller_locations do |location|
+        caller_path = location_as_path(location)
+        caller_path.include?(app_root) && !caller_path.include?(vendor_root) && !caller_path.include?(bundler_path)
+      end
+    end
+
+    private
+
+    def pattern_matches?(location, pattern)
+      path = location_as_path(location)
+      case pattern
+      when Array
+        pattern_path = pattern.first
+        filter = pattern.last
+        return false unless pattern_matches?(location, pattern_path)
+
+        case filter
+        when Range
+          filter.include?(location.lineno)
+        when Integer
+          filter == location.lineno
+        when String
+          filter == location.base_label
+        end
+      when String
+        path.include?(pattern)
+      when Regexp
+        path =~ pattern
+      end
+    end
+
+    def location_as_path(location)
+      ruby_19? ? location : location.absolute_path.to_s
+    end
+
+    def select_caller_locations
+      if ruby_19?
+        caller.select do |caller_path|
+          yield caller_path
+        end
+      else
+        caller_locations.select do |location|
+          yield location
+        end
+      end
+    end
+
+    def ruby_19?
+      if @ruby_19.nil?
+        @ruby_19 = Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
+      end
+      @ruby_19
+    end
+  end
+end

data/lib/must_be_ordered/version.rb

@@ -0,0 +1,3 @@
+module MustBeOrdered
+  VERSION = "0.1.0"
+end

data/must_be_ordered.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "must_be_ordered/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "must_be_ordered"
+  spec.version       = MustBeOrdered::VERSION
+  spec.authors       = ["pi-chan", "nof"]
+  spec.email         = ["hiromasa.ohno.1007@gmail.com"]
+
+  spec.summary       = "`must_be_ordered` gem is to warn or raise error if `order` is not set to ActiveRecord's Relation."
+  spec.description   = ""
+  spec.homepage      = "https://github.com/pi-chan/must_be_ordered"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activerecord', ['>= 5.0']
+
+  spec.add_development_dependency 'bundler', "~> 1.16"
+  spec.add_development_dependency 'rake', "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.0"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: must_be_ordered
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pi-chan
+- nof
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 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: pry-byebug
+  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: ''
+email:
+- hiromasa.ohno.1007@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Gemfile.rails-5.0
+- Gemfile.rails-5.1
+- Gemfile.rails-5.2
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/must_be_ordered.rb
+- lib/must_be_ordered/notifier.rb
+- lib/must_be_ordered/relation_check.rb
+- lib/must_be_ordered/stack_trace_filter.rb
+- lib/must_be_ordered/version.rb
+- must_be_ordered.gemspec
+homepage: https://github.com/pi-chan/must_be_ordered
+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.7.7
+signing_key: 
+specification_version: 4
+summary: "`must_be_ordered` gem is to warn or raise error if `order` is not set to
+  ActiveRecord's Relation."
+test_files: []