rails_review 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8081bec27a4fa952c34d15ac85aaa9f7b6cad635
+  data.tar.gz: eefb6dbbb1b28b350b20cd77416bf8a31a1ea6a1
+SHA512:
+  metadata.gz: 360cf2c5bfbbd2744160bb916078efa1491f56b051c56677eda8bb34dffc1b9ed2649b14acaff41b2dd605efdaf395df8b48a7d3a36df37cc44be2dd3981c273
+  data.tar.gz: ba1221789081eefa087c3f9d85bbc6433f3fea236c81dc38d3ee36314584e34e5c14bbd5b2311af66a5bcae7b6f892db3ce0548f3cad6807a9bb8fa0647f1aa9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_review.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 RubyEffect Software Solutions Pvt. Ltd.
+
+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,57 @@
+# Rails Review
+
+Rails Review gem checks your rails applications against style guides present at [Rails Style Guide Repository](https://github.com/bbatsov/rails-style-guide) and reports the code snippets where the style guide is not met.
+
+## Installation
+
+Add this line to your application's Gemfile in the development group:
+
+```ruby
+gem 'rails_review'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_review
+
+## Usage
+
+Run the following rake task to start the rails style guide checks on your application.
+
+    $ rake rails_review:start
+
+## 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`.
+
+## Contributing
+
+1. Fork it ( https://github.com/rubyeffect/rails_review/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Note
+
+In the current version, 17 [Rails Style Guide](https://github.com/bbatsov/rails-style-guide) points are being checked. Further checks would be added in future commits.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## About RubyEffect
+
+![RubyEffect](http://blog.rubyeffect.com/wp-content/uploads/2015/05/cropped-re_original_logo.png)
+
+RubyEffect builds intuitive, live and elegant software that solves real world problems. We love open source and it's community.
+
+Liked this gem? You may also like the articles we post on our [blog](http://blog.rubyeffect.com). Please do check
+
+We would love to work on your ideas and see them grow. Say hello @ http://rubyeffect.com/contact

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 "rails_review"
+
+# 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/lib/rails_review.rb

@@ -0,0 +1,15 @@
+require "rails_review/checker"
+require "rails_review/error"
+require "rails_review/version"
+require "rails_review/railtie" if defined?(Rails)
+
+module RailsReview
+  class << self
+    def start
+      RailsReview::Checker.gemlock_check
+      RailsReview::Checker.timezone_check
+      RailsReview::Checker.custom_validator_directory_check
+      RailsReview::Checker.app_directory_check
+    end
+  end
+end

data/lib/rails_review/checker.rb

@@ -0,0 +1,105 @@
+module RailsReview
+  class Checker
+    @@errors = {}
+    class << self
+
+      # Method to check whether Gemfile.lock is present in .gitignore or not
+      def gemlock_check
+        File.foreach('.gitignore').with_index do |line, index|
+          if line.include? 'Gemfile.lock'
+            @@errors["/.gitignore"] = [{:gemlock => index + 1}]
+            break
+          end
+        end
+      end
+
+      # Method to check if timezone has been configured
+      def timezone_check
+        line_num = 0
+        config_line  = ''
+        File.foreach("#{Rails.root}/config/application.rb").with_index do |line, index |
+          if line.include? "config.time_zone"
+            line_num = index + 1
+            config_line = line
+          end
+          break if line_num != 0
+        end
+        formatted_config_line = config_line.gsub(' ', '')
+        if formatted_config_line.first == '#' || formatted_config_line.length == 19
+          @@errors["/config/application.rb"] = [{:timezone => line_num}]
+        end
+      end
+
+      # Method to check if separate directory is being used for custom validators
+      def custom_validator_directory_check
+        if Dir["#{Rails.root}/app/validators"].empty?
+          @@errors["/validators"] = [{:validators => "not found"}]
+        end
+      end
+
+      def app_directory_check
+        files = Dir.glob(File.join(["#{Rails.root}/app", '**', '*'])).reject { |f| File.directory?(f) || f.include?("/assets/") }
+
+        files.each do |file|
+          File.foreach(file).with_index do |line, index|
+            @@errors[file] = [] unless @@errors.has_key?(file)
+            @@errors[file] << {:time_now => index + 1} if line.include? 'Time.now'
+            @@errors[file] << {:time_parse => index + 1} if line.include? 'Time.parse'
+
+            # Controller Specific Checks
+            if file.include?("/controllers/")
+              formatted_line = line.gsub(' ', '')
+              if formatted_line.include?("render:inline") || formatted_line.include?("renderinline:")
+                @@errors[file] << {:render_inline => index + 1}
+              end
+              if formatted_line.include?("render:text") || formatted_line.include?("rendertext:")
+                @@errors[file] << {:render_text => index + 1}
+              end
+              if formatted_line.include?("render:status") || formatted_line.include?("renderstatus:")
+                status = formatted_line.gsub("render:status", '').gsub("renderstatus:", '').first
+                @@errors[file] << {:render_status => index + 1} if status =~ /^[-+]?[1-9]([0-9]*)?$/
+              end
+            end
+
+            # Checks for all sub-directories of app except views
+            unless file.include?("/views/")
+              @@errors[file] << {:find_by_sql => index + 1} if line.include?("find_by_sql") && !line.include?("<<")
+              @@errors[file] << {:update_attribute => index + 1} if line.include?("update_attribute(")
+              @@errors[file] << {:dot_all => index + 1} if line.include?(".all")
+            end
+
+            # Models specific checks
+            if file.include?("/models/")
+              @@errors[file] << {:table_name => index + 1} if line.include?("self.table_name")
+              @@errors[file] << {:read_attribute => index + 1} if line.include?("read_attribute")
+              @@errors[file] << {:write_attribute => index + 1} if line.include?("write_attribute")
+              @@errors[file] << {:habtm => index + 1} if line.include?("has_and_belongs_to_many")
+              formatted_line = line.gsub(" ", "")
+              @@errors[file] << {:prepend_true => index + 1} if !(formatted_line.include?("prepend:true") || formatted_line.include?(":prepend=>true")) && line.include?("before_destroy")
+              @@errors[file] << {:dependent_destroy => index + 1} if (line.include?('has_one') || line.include?('has_many')) && !line.include?('dependent')
+            end
+
+          end
+        end
+        print
+      end # app_directory_check method end
+
+      # Print errors found
+      def print
+        puts "The following style guide issues have been found:\n"
+        serial_number = 0
+        @@errors.each do |filename, errors_list|
+          next if errors_list.blank?
+          computed_filename = filename.gsub("#{Rails.root}", '')
+          puts "#{serial_number + 1}. #{computed_filename}\n"
+          serial_number += 1
+          errors_list.each_with_index do |error, i|
+            puts "\t#{i+1}. #{RailsReview::Error::MAP[error.keys.first]} - line: #{error.values.first}\n"
+          end
+          puts "\n"
+        end
+      end
+
+    end # class self end
+  end # class Checker end
+end # module RailsReview end

data/lib/rails_review/error.rb

@@ -0,0 +1,25 @@
+module RailsReview
+  class Error
+
+    # Mapping symbols to respective description of rails style guide.
+    MAP = {
+      :gemlock => "Do not remove the Gemfile.lock from version control. This is not some randomly generated file - it makes sure that all of your team members get the same gem versions when they do a bundle install",
+      :timezone => "Config your timezone accordingly in application.rb",
+      :validators => "Keep custom validators under app/validators",
+      :time_now => "Don't use Time.now. Use Time.zone.now or Time.current instead",
+      :time_parse => "Don't use Time.parse. Use Time.zone.parse instead",
+      :render_inline => "Prefer using a template over inline rendering",
+      :render_text => "Prefer render plain: over render text:",
+      :render_status => "Prefer corresponding symbols to numeric HTTP status codes. They are meaningful and do not look like 'magic' numbers for less known HTTP status codes.",
+      :find_by_sql => "When specifying an explicit query in a method such as find_by_sql, use heredocs with squish. This allows you to legibly format the SQL with line breaks and indentations, while supporting syntax highlighting in many tools (including GitHub, Atom, and RubyMine).",
+      :update_attribute => "Beware of the behavior of the update_attribute method. It doesn't run the model validations (unlike update_attributes) and could easily corrupt the model state.",
+      :dot_all => "Use find_each to iterate over a collection of AR objects. Looping through a collection of records from the database (using the all method, for example) is very inefficient since it will try to instantiate all the objects at once. In that case, batch processing methods allow you to work with the records in batches, thereby greatly reducing memory consumption.",
+      :table_name => "Avoid altering ActiveRecord defaults (table names, primary key, etc) unless you have a very good reason (like a database that's not under your control).",
+      :read_attribute => "Prefer self[:attribute] over read_attribute(:attribute)",
+      :write_attribute => "Prefer self[:attribute] = value over write_attribute(:attribute, value)",
+      :habtm => "Prefer has_many :through to has_and_belongs_to_many. Using has_many :through allows additional attributes and validations on the join model.",
+      :prepend_true => "Since Rails creates callbacks for dependent associations, always call before_destroy callbacks that perform validation with prepend: true",
+      :dependent_destroy => "Define the dependent option to the has_many and has_one associations."
+    }
+  end
+end

data/lib/rails_review/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails_review'
+require 'rails'
+module RailsReview
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/rails_review/tasks/rails_review.rake

@@ -0,0 +1,6 @@
+namespace :rails_review do
+  desc "Task to initiate the rails style guide checks"
+  task :start do
+    RailsReview::start
+  end
+end

data/lib/rails_review/version.rb

@@ -0,0 +1,3 @@
+module RailsReview
+  VERSION = "0.0.1"
+end

data/rails_review.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_review/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_review"
+  spec.version       = RailsReview::VERSION
+  spec.authors       = ["Sanjay Vedula"]
+  spec.email         = ["opensource@rubyeffect.com"]
+
+  spec.summary       = %q{This gem checks your rails application against the rails style guide.}
+  spec.description   = %q{This gem checks your rails application against the rails style guide and highlights the places where the rails style guide points are not met.}
+  spec.homepage      = "http://www.rubyeffect.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rails_review
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sanjay Vedula
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-27 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'
+description: This gem checks your rails application against the rails style guide
+  and highlights the places where the rails style guide points are not met.
+email:
+- opensource@rubyeffect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_review.rb
+- lib/rails_review/checker.rb
+- lib/rails_review/error.rb
+- lib/rails_review/railtie.rb
+- lib/rails_review/tasks/rails_review.rake
+- lib/rails_review/version.rb
+- rails_review.gemspec
+homepage: http://www.rubyeffect.com
+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.8
+signing_key: 
+specification_version: 4
+summary: This gem checks your rails application against the rails style guide.
+test_files: []