best_practice_project 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3feff99f742a8d651220cda76b234a83e21aac1c
-  data.tar.gz: f13c39da87f542f1f5cb832d6b30666f6137a286
+  metadata.gz: c461d3d29af225c5b4d7dc63106672f1475a5461
+  data.tar.gz: 86c8f5715fe4892e48051eccdf49a509241fb5c3
 SHA512:
-  metadata.gz: 0497860d33208af0b7fa473401bbbc6bb279a1ee9b3f363d35566e6a05603a2dd492dffd38860f741903eda022e728e042abb21f442b8323680664670bd0f82d
-  data.tar.gz: b3c3841612b4e8c990654f2ccb2c126efb42e442159c82e347f2a9914123c1b9da986f33c57c57e31bfd838e3d4a933a90ea11126ce10c89d442e9ff49672de7
+  metadata.gz: c5cf5c610bd621e35fffa543f643c02f2bb2d1ba1f9a5b4f735448ab727fdb9da03820229e11a89165bdbd18aea9695f52f208029cc4b96f816ffba8b10c8d89
+  data.tar.gz: 3b14768ddd300da0804a1cbddea3266505ab5438d728ae5ba48723fc0adcbd1733befd127a98ec5fbf6ea3d6b06c2c13397b7ff0ac7f096099c2ce8c3fe1b200

data/README.md

@@ -1,6 +1,49 @@
+[![Build Status](https://img.shields.io/shippable/56404e3d1895ca447422feda.svg)](https://app.shippable.com/projects/56404e3d1895ca447422feda/builds/latest)
+
 # BestPracticeProject
 
-Description goes here.
+A bundle of various coverage and analytical tools to help you keep your code clean. The idea is that you only have to bundle this project, run the generate config command and start writing clean code for your project.
+
+- Rubocop
+- Rails Best Practices
+- SCSS Lint
+- CoffeeLint
+
+## In development!
+
+This project is still in early development. Currently generating configs only works for Rubocop and SCSS Lint.
+
+## Install
+
+Add to your Gemfile and bundle:
+```ruby
+gem "best_practice_project"
+```
+
+Add this to your Rakefile:
+```ruby
+BestPracticeProject.load_tasks
+```
+
+## Usage
+
+First you can generate some todo configs like this:
+```bash
+bundle exec rake best_practice_project:generate_configs
+```
+
+You can then run all the checks like this:
+```bash
+bundle exec rake best_practice_project:run
+```
+
+You can also run each check manually like this:
+```bash
+bundle exec rake best_practice_project:run_rubocop
+bundle exec rake best_practice_project:run_rails_best_practices
+bundle exec rake best_practice_project:run_coffee_lint
+bundle exec rake best_practice_project:run_scss_lint
+```
 
 ## Contributing to best_practice_project
 

data/Rakefile

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
-require 'rubygems'
-require 'bundler'
+require "rubygems"
+require "bundler"
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,42 +9,45 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
+require "rake"
 
-require 'jeweler'
+require "jeweler"
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "best_practice_project"
   gem.homepage = "http://github.com/kaspernj/best_practice_project"
   gem.license = "MIT"
-  gem.summary = %Q{A bundle of various linters and code inspection tools}
-  gem.description = %Q{A bundle of various linters and code inspection tools}
+  gem.summary = %(A bundle of various linters and code inspection tools)
+  gem.description = %(A bundle of various linters and code inspection tools)
   gem.email = "k@spernj.org"
   gem.authors = ["kaspernj"]
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.pattern = FileList["spec/**/*_spec.rb"]
 end
 
 desc "Code coverage detail"
 task :simplecov do
-  ENV['COVERAGE'] = "true"
-  Rake::Task['spec'].execute
+  ENV["COVERAGE"] = "true"
+  Rake::Task["spec"].execute
 end
 
-task :default => :spec
+task default: :spec
 
-require 'rdoc/task'
+require "rdoc/task"
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
 
-  rdoc.rdoc_dir = 'rdoc'
+  rdoc.rdoc_dir = "rdoc"
   rdoc.title = "best_practice_project #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
+
+require "best_practice_project"
+BestPracticeProject.load_tasks

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/best_practice_project.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "best_practice_project"
+  s.version = "0.0.1"
+
+  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.description = "A bundle of various linters and code inspection tools"
+  s.email = "k@spernj.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "best_practice_project.gemspec",
+    "config/rubocop.yml",
+    "lib/best_practice_project.rb",
+    "lib/tasks/best_practice_project.rake",
+    "shippable.yml",
+    "spec/best_practice_project_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kaspernj/best_practice_project"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.0"
+  s.summary = "A bundle of various linters and code inspection tools"
+
+  if s.respond_to? :specification_version then
+    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_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<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      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<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/config/rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  Exclude:
+    - db/schema.rb
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/AbcSize:
+  Max: 25
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLines:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+  Enabled: true

data/lib/best_practice_project.rb

@@ -0,0 +1,140 @@
+class BestPracticeProject
+  attr_reader :rails
+  alias_method :rails?, :rails
+
+  def self.load_tasks
+    load "#{File.dirname(__FILE__)}/tasks/best_practice_project.rake"
+  end
+
+  def initialize
+    @rubocop_actual_config_path = File.realpath("#{File.dirname(__FILE__)}/../config/rubocop.yml")
+
+    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"
+    end
+
+    @commands = []
+
+    if rails?
+      @commands << scss_lint_command
+      @commands << coffee_lint_command
+      @commands << rails_best_practices_command
+    end
+
+    @commands << rubocop_command
+  end
+
+  def execute
+    process_status = true
+
+    @commands.each do |command|
+      puts "Executing: #{command}"
+
+      status = system(command)
+      process_status = status unless status
+    end
+
+    process_status
+  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
+  end
+
+  def scss_lint_command
+    "bundle exec scss-lint --config config/scss-lint.yml app/assets/stylesheets/" if rails?
+  end
+
+  def coffee_lint_command
+    "bundle exec coffeelint.rb -f config/coffeelint.json -r app/assets/javascripts/" if rails?
+  end
+
+  def rails_best_practices_command
+    "bundle exec rails_best_practices" if rails?
+  end
+
+private
+
+  def generate_coffee_lint_config
+    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 puts "SCSS-Lint config already exists in #{@scss_config_path}" if File.exist?(@scss_config_path)
+
+    config = `bundle exec scss-lint --format=Config`
+
+    File.open(@scss_config_path, "w") do |fp|
+      fp.write(config)
+    end
+
+    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/tasks/best_practice_project.rake

@@ -0,0 +1,37 @@
+namespace "best_practice_project" do
+  task "run" do
+    exit BestPracticeProject.new.execute
+  end
+
+  task "run_rubocop" do
+    best_practice_project = BestPracticeProject.new
+
+    puts "Executing: #{best_practice_project.rubocop_command}"
+    exit system(best_practice_project.rubocop_command)
+  end
+
+  task "run_scss_lint" do
+    best_practice_project = BestPracticeProject.new
+
+    puts "Executing: #{best_practice_project.scss_lint_command}"
+    exit system(best_practice_project.scss_lint_command)
+  end
+
+  task "run_coffee_lint" do
+    best_practice_project = BestPracticeProject.new
+
+    puts "Executing: #{best_practice_project.coffee_lint_command}"
+    exit system(best_practice_project.coffee_lint_command)
+  end
+
+  task "run_rails_best_practices" do
+    best_practice_project = BestPracticeProject.new
+
+    puts "Executing: #{best_practice_project.rails_best_practices_command}"
+    exit system(best_practice_project.rails_best_practices_command)
+  end
+
+  task "generate_configs" do
+    BestPracticeProject.new.generate_configs
+  end
+end

data/shippable.yml

@@ -0,0 +1,10 @@
+language: ruby
+cache: bundler
+archive: true
+rvm:
+  - ruby-2.1.2
+script:
+  - bundle exec rspec
+  - bundle exec best_practice_project:run
+notifications:
+   email: false

data/spec/best_practice_project_spec.rb

@@ -1,7 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require File.expand_path(File.dirname(__FILE__) + "/spec_helper")
 
 describe "BestPracticeProject" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'simplecov'
+require "simplecov"
 
 module SimpleCov::Configuration
   def clean_filters
@@ -8,22 +8,21 @@ end
 
 SimpleCov.configure do
   clean_filters
-  load_adapter 'test_frameworks'
+  load_adapter "test_frameworks"
 end
 
 ENV["COVERAGE"] && SimpleCov.start do
   add_filter "/.rvm/"
 end
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
-require 'rspec'
-require 'best_practice_project'
+require "rspec"
+require "best_practice_project"
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: best_practice_project
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - kaspernj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -152,7 +152,11 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- best_practice_project.gemspec
+- config/rubocop.yml
 - lib/best_practice_project.rb
+- lib/tasks/best_practice_project.rake
+- shippable.yml
 - spec/best_practice_project_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kaspernj/best_practice_project