best_practice_project 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c461d3d29af225c5b4d7dc63106672f1475a5461
-  data.tar.gz: 86c8f5715fe4892e48051eccdf49a509241fb5c3
+  metadata.gz: 7476699c6b4511029adeecf0d84827384f943a9b
+  data.tar.gz: d21a33dcb8e43f164cdc06446d061c299da1bedf
 SHA512:
-  metadata.gz: c5cf5c610bd621e35fffa543f643c02f2bb2d1ba1f9a5b4f735448ab727fdb9da03820229e11a89165bdbd18aea9695f52f208029cc4b96f816ffba8b10c8d89
-  data.tar.gz: 3b14768ddd300da0804a1cbddea3266505ab5438d728ae5ba48723fc0adcbd1733befd127a98ec5fbf6ea3d6b06c2c13397b7ff0ac7f096099c2ce8c3fe1b200
+  metadata.gz: e7a57f1f55926c87e7a2b11741b6c5b1bf8b88d85b9caf66f7c2b6f3d8c005b623232003dc014abd0d88cade9e8a100c027a24ce3927ad24db950ee54a4ef7d1
+  data.tar.gz: 412447dde027d00e4d9fecfd4d9994ad709c5eb93dc1354a9dcf4c780762951fe8597c75925d88cf9986feeaa9cbdd41e1d432971542869eeca26b36b6db5412

data/Gemfile

@@ -3,10 +3,12 @@ source "http://rubygems.org"
 # Example:
 #   gem "activesupport", ">= 2.3.5"
 
-gem "rubocop", "0.35.0", require: false
-gem "coffeelint", "1.11.0", require: false
-gem "scss_lint", require: false
-gem "rails_best_practices", require: false
+#gem "rubocop", "~> 0.35.0", require: false
+#gem "coffeelint", "~> 1.11.0", require: false
+#gem "scss_lint", "~> 0.42.2", require: false
+#gem "rails_best_practices", "~> 1.15.7", require: false
+
+gem "psych", "~> 2.0.0", require: false
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -1,34 +1,12 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.2.4)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
     addressable (2.3.8)
-    ast (2.1.0)
-    astrolabe (1.3.1)
-      parser (~> 2.2)
     builder (3.2.2)
-    code_analyzer (0.4.5)
-      sexp_processor
-    coffee-script (2.4.1)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.9.1.1)
-    coffeelint (1.11.0)
-      coffee-script
-      execjs
-      json
-    colored (1.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.1.3)
     docile (1.1.5)
-    erubis (2.7.0)
-    execjs (2.6.0)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
     git (1.2.9.1)
@@ -42,7 +20,6 @@ GEM
       oauth2
     hashie (3.4.3)
     highline (1.7.8)
-    i18n (0.7.0)
     jeweler (2.0.1)
       builder
       bundler (>= 1.0)
@@ -55,7 +32,6 @@ GEM
     json (1.8.3)
     jwt (1.5.2)
     mini_portile (0.6.2)
-    minitest (5.8.2)
     multi_json (1.11.2)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
@@ -67,24 +43,11 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    parser (2.2.3.0)
-      ast (>= 1.1, < 3.0)
-    powerpack (0.1.1)
+    psych (2.0.5)
     rack (1.6.4)
-    rails_best_practices (1.15.7)
-      activesupport
-      code_analyzer (>= 0.4.3)
-      colored
-      erubis
-      i18n
-      json
-      require_all
-      ruby-progressbar
-    rainbow (2.0.0)
     rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
-    require_all (1.3.3)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -93,40 +56,23 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
-    rubocop (0.35.0)
-      astrolabe (~> 1.3)
-      parser (>= 2.2.3.0, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-    ruby-progressbar (1.7.5)
-    sass (3.4.19)
-    scss_lint (0.42.2)
-      rainbow (~> 2.0)
-      sass (~> 3.4.15)
-    sexp_processor (4.6.0)
     simplecov (0.10.0)
       docile (~> 1.1.0)
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
-  coffeelint (= 1.11.0)
   jeweler (~> 2.0.1)
-  rails_best_practices
+  psych (~> 2.0.0)
   rdoc (~> 3.12)
   rspec (~> 2.8.0)
-  rubocop (= 0.35.0)
-  scss_lint
   simplecov
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/best_practice_project.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: best_practice_project 0.0.1 ruby lib
+# stub: best_practice_project 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "best_practice_project"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["kaspernj"]
-  s.date = "2015-11-13"
+  s.date = "2015-11-25"
   s.description = "A bundle of various linters and code inspection tools"
   s.email = "k@spernj.org"
   s.extra_rdoc_files = [
@@ -28,8 +28,9 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "best_practice_project.gemspec",
-    "config/rubocop.yml",
     "lib/best_practice_project.rb",
+    "lib/best_practice_project/rubocop_handler.rb",
+    "lib/config/rubocop.yml",
     "lib/tasks/best_practice_project.rake",
     "shippable.yml",
     "spec/best_practice_project_spec.rb",
@@ -44,20 +45,14 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rubocop>, ["= 0.35.0"])
-      s.add_runtime_dependency(%q<coffeelint>, ["= 1.11.0"])
-      s.add_runtime_dependency(%q<scss_lint>, [">= 0"])
-      s.add_runtime_dependency(%q<rails_best_practices>, [">= 0"])
+      s.add_runtime_dependency(%q<psych>, ["~> 2.0.0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
     else
-      s.add_dependency(%q<rubocop>, ["= 0.35.0"])
-      s.add_dependency(%q<coffeelint>, ["= 1.11.0"])
-      s.add_dependency(%q<scss_lint>, [">= 0"])
-      s.add_dependency(%q<rails_best_practices>, [">= 0"])
+      s.add_dependency(%q<psych>, ["~> 2.0.0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
@@ -65,10 +60,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rubocop>, ["= 0.35.0"])
-    s.add_dependency(%q<coffeelint>, ["= 1.11.0"])
-    s.add_dependency(%q<scss_lint>, [">= 0"])
-    s.add_dependency(%q<rails_best_practices>, [">= 0"])
+    s.add_dependency(%q<psych>, ["~> 2.0.0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

data/lib/best_practice_project.rb

@@ -1,5 +1,11 @@
+require "yaml"
+
 class BestPracticeProject
-  attr_reader :rails
+  path = "#{File.dirname(__FILE__)}/best_practice_project"
+
+  autoload :RubocopHandler, "#{path}/rubocop_handler"
+
+  attr_reader :rails, :rubocop_handler
   alias_method :rails?, :rails
 
   def self.load_tasks
@@ -7,38 +13,41 @@ class BestPracticeProject
   end
 
   def initialize
-    @rubocop_actual_config_path = File.realpath("#{File.dirname(__FILE__)}/../config/rubocop.yml")
+    @rubocop_handler = BestPracticeProject::RubocopHandler.new(best_practice_project: self) if rubocop_installed?
 
-    if Object.const_defined?(:Rails)
-      @rails = true
-
-      @rubocop_config_path = Rails.root.join("config", "rubocop.yml").to_s
-      @scss_config_path = Rails.root.join("config", "scss-lint.yml").to_s
-      @coffee_lint_config_path = Rails.root.join("config", "coffeelint.json").to_s
-    else
-      @rails = false
-
-      @rubocop_config_path = "config/rubocop.yml"
+    if rails?
+      @scss_config_path = Rails.root.join("config", "scss-lint.yml").to_s if scss_installed?
+      @coffee_lint_config_path = Rails.root.join("config", "coffeelint.json").to_s if coffee_lint_installed?
     end
 
     @commands = []
 
     if rails?
-      @commands << scss_lint_command
-      @commands << coffee_lint_command
-      @commands << rails_best_practices_command
+      @commands << scss_lint_command if scss_installed?
+      @commands << coffee_lint_command if coffee_lint_installed?
+      @commands << rails_best_practices_command if rails_best_practices_installed?
     end
 
-    @commands << rubocop_command
+    @commands << proc { @rubocop_handler.execute }
+  end
+
+  def rails?
+    @rails = Object.const_defined?(:Rails) if @rails == nil
+    @rails
   end
 
   def execute
     process_status = true
 
     @commands.each do |command|
-      puts "Executing: #{command}"
+      if command.is_a?(Proc)
+        puts "Executing: #{@rubocop_handler.command}"
+        status = command.call unless status
+      else
+        puts "Executing: #{command}"
+        status = system(command)
+      end
 
-      status = system(command)
       process_status = status unless status
     end
 
@@ -46,20 +55,9 @@ class BestPracticeProject
   end
 
   def generate_configs
-    generate_rubocop_config
-    generate_scss_config
-    generate_coffee_lint_config
-  end
-
-  def rubocop_command
-    command = "bundle exec rubocop --display-cop-names"
-    command << " --rails" if rails?
-
-    if File.exist?(@rubocop_config_path)
-      command << " \"--config=#{@rubocop_config_path}\""
-    end
-
-    command
+    @rubocop_handler.generate_config if rubocop_installed?
+    generate_scss_config if scss_lint_installed?
+    generate_coffee_lint_config if coffee_lint_installed?
   end
 
   def scss_lint_command
@@ -76,13 +74,51 @@ class BestPracticeProject
 
 private
 
+  def rubocop_installed?
+    begin
+      require "rubocop"
+      true
+    rescue LoadError
+      false
+    end
+  end
+
+  def scss_lint_installed?
+    begin
+      require "scss_lint"
+      true
+    rescue LoadError
+      false
+    end
+  end
+
+  def coffee_lint_installed?
+    begin
+      require "coffeelint"
+      true
+    rescue LoadError
+      false
+    end
+  end
+
+  def rails_best_practices_installed?
+    begin
+      require "rails_best_practices"
+      true
+    rescue LoadError
+      false
+    end
+  end
+
   def generate_coffee_lint_config
+    return unless @coffee_lint_config_path
     return puts "Coffee-Lint config already exists in #{@coffee_lint_config_path}" if File.exist?(@coffee_lint_config_path)
 
     puts "FIXME: Generate Coffee-Lint configuration!"
   end
 
   def generate_scss_config
+    return unless @scss_config_path
     return puts "SCSS-Lint config already exists in #{@scss_config_path}" if File.exist?(@scss_config_path)
 
     config = `bundle exec scss-lint --format=Config`
@@ -93,48 +129,4 @@ private
 
     puts "Generated SCSS-Lint config in #{@scss_config_path}"
   end
-
-  def generate_rubocop_config
-    return puts "Rubocop config already exists in #{@rubocop_config_path}" if File.exist?(@rubocop_config_path)
-
-    project_todo_path = Rails.root.join("config", "rubocop_todo.yml").to_s
-
-    generated_todo_config = {}
-    generated_todo_config["inherit_from"] = @rubocop_actual_config_path
-    generated_todo_config.merge!(generate_rubocop_todo_config)
-
-    File.open(project_todo_path, "w") do |fp|
-      fp.write(YAML.dump(generated_todo_config))
-    end
-
-    puts "Generated Rubocop todo config in #{project_todo_path}"
-
-    generated_config = {}
-    generated_config["inherit_from"] = "rubocop_todo.yml"
-
-    File.open(@rubocop_config_path, "w") do |fp|
-      fp.write(YAML.dump(generated_config))
-    end
-
-    puts "Generated Rubocop config in  #{@rubocop_config_path}"
-  end
-
-  def generate_rubocop_todo_config
-    todo_file_path = Rails.root.join(".rubocop_todo.yml").to_s
-    todo_backup_file_path = Rails.root.join(".rubocop_todo_backup.yml").to_s
-
-    if File.exist?(todo_file_path)
-      File.rename(todo_file_path, todo_backup_file_path)
-    end
-
-    system("rubocop --rails --display-cop-names --auto-gen-config --config=#{@rubocop_actual_config_path}")
-
-    raise "Todo-file was not generated" unless File.exist?(todo_file_path)
-
-    todo_config = YAML.load_file(todo_file_path)
-    File.unlink(todo_file_path)
-    File.rename(todo_backup_file_path, todo_file_path) if File.exist?(todo_backup_file_path)
-
-    todo_config
-  end
 end

data/lib/best_practice_project/rubocop_handler.rb

@@ -0,0 +1,97 @@
+class BestPracticeProject::RubocopHandler
+  def initialize(args)
+    @bpp = args.fetch(:best_practice_project)
+    @actual_config_path = File.realpath("#{File.dirname(__FILE__)}/../../config/rubocop.yml")
+
+    if rails?
+      @config_path = Rails.root.join("config", "rubocop.yml").to_s
+      @todo_path = Rails.root.join("config", "rubocop_todo.yml").to_s
+    else
+      @config_path = "config/rubocop.yml"
+      @todo_path = "config/rubocop_todo.yml"
+    end
+  end
+
+  def rails?
+    @bpp.rails?
+  end
+
+  def update_best_practice_path
+    self.inherit_from_to = @actual_config_path
+  end
+
+  def reset_best_practice_path
+    self.inherit_from_to = "$$$best_practice_project_config_path$$$"
+  end
+
+  def command
+    command = "bundle exec rubocop --display-cop-names"
+    command << " --rails" if rails?
+    command << " \"--config=#{@config_path}\"" if File.exist?(@config_path)
+    command
+  end
+
+  def generate_config
+    return puts "Rubocop config already exists in #{@config_path}" if File.exist?(@config_path)
+
+    File.open(@todo_path, "w") do |fp|
+      fp.write(generate_todo_config)
+    end
+
+    puts "Generated Rubocop todo config in #{@todo_path}"
+
+    generated_config = {}
+    generated_config["inherit_from"] = "rubocop_todo.yml"
+
+    File.open(@config_path, "w") do |fp|
+      fp.write(YAML.dump(generated_config))
+    end
+
+    puts "Generated Rubocop config in  #{@config_path}"
+  end
+
+  def generate_todo_config
+    if rails?
+      todo_file_path = Rails.root.join(".rubocop_todo.yml").to_s
+      todo_backup_file_path = Rails.root.join(".rubocop_todo_backup.yml").to_s
+    else
+      todo_file_path = ".rubocop_todo.yml"
+      todo_backup_file_path = ".rubocop_todo_backup.yml"
+    end
+
+    if File.exist?(todo_file_path)
+      File.rename(todo_file_path, todo_backup_file_path)
+    end
+
+    system("rubocop --rails --display-cop-names --auto-gen-config --config=#{@actual_config_path}")
+
+    raise "Todo-file was not generated" unless File.exist?(todo_file_path)
+
+    todo_config = File.read(todo_file_path)
+    File.unlink(todo_file_path)
+    File.rename(todo_backup_file_path, todo_file_path) if File.exist?(todo_backup_file_path)
+
+    todo_config
+  end
+
+  def execute
+    update_best_practice_path
+
+    begin
+      system(command)
+    ensure
+      reset_best_practice_path
+    end
+  end
+
+private
+
+  def inherit_from_to=(new_inherit_from)
+    todo_config = File.read(@todo_path)
+    todo_config.gsub!(/^inherit_from: (.+)$/, "inherit_from: \"#{new_inherit_from}\"")
+
+    File.open(@todo_path, "w") do |fp|
+      fp.write(todo_config)
+    end
+  end
+end

data/{config → lib/config}/rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - db/schema.rb
+    - spec/dummy/db/schema.rb
 
 Metrics/LineLength:
   Max: 160
@@ -11,6 +12,9 @@ Metrics/MethodLength:
 Metrics/AbcSize:
   Max: 25
 
+Metrics/ClassLength:
+  Max: 250
+
 Style/AccessModifierIndentation:
   EnforcedStyle: outdent
 

data/lib/tasks/best_practice_project.rake

@@ -6,8 +6,8 @@ namespace "best_practice_project" do
   task "run_rubocop" do
     best_practice_project = BestPracticeProject.new
 
-    puts "Executing: #{best_practice_project.rubocop_command}"
-    exit system(best_practice_project.rubocop_command)
+    puts "Executing: #{best_practice_project.rubocop_handler.command}"
+    best_practice_project.rubocop_handler.execute
   end
 
   task "run_scss_lint" do

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: best_practice_project
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.35.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.35.0
-- !ruby/object:Gem::Dependency
-  name: coffeelint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.11.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.11.0
-- !ruby/object:Gem::Dependency
-  name: scss_lint
-  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_best_practices
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -153,8 +111,9 @@ files:
 - Rakefile
 - VERSION
 - best_practice_project.gemspec
-- config/rubocop.yml
 - lib/best_practice_project.rb
+- lib/best_practice_project/rubocop_handler.rb
+- lib/config/rubocop.yml
 - lib/tasks/best_practice_project.rake
 - shippable.yml
 - spec/best_practice_project_spec.rb