hound-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 483245c29d53fc7fdeae5ac6349978f54dce8539
+  data.tar.gz: 9714e80febfa1571e228d08097db02d668489844
+SHA512:
+  metadata.gz: 0a7edb7d47bdea4c630d7ead838e4d5cfcbd548a52885e8a98c41ad5e03b025d2c12bb77963f3d21534a3b227e0371493b01aaae819eadceace54cc6d3ff3db9
+  data.tar.gz: c75017139604ebecdfca3eda9508730f543e75b7ab9890e82bcb879fcc7516f5800275cacab54f68e84068798abbc41d0c521413f3384dbb50e52eb674c8094e

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+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 hound.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright 2016 Platanus
+
+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,97 @@
+# Hound CLI
+
+Ruby CLI created to get and build style rules we use in Platanus to play with linters.
+This tool was built to recreate locally, the same behavior we have in [our forked version](https://github.com/platanus/hound) of [Hound](https://github.com/houndci/hound).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hound'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+### Update command
+
+This command allows you to update style rules for enabled linters.
+
+```
+$ hound rules update
+```
+
+After running this command you will get one file (with style rules) for each enabled linter in the **remote** [.hound.yml](https://raw.githubusercontent.com/platanus/la-guia/master/.hound.yml) file. Those files are understood by linters installed in your system. For example: with `ruby` language, a `.rubocop.yml` file will be created. This `.rubocop.yml`, is read by the [rubocop gem](https://github.com/bbatsov/rubocop) (a ruby linter).
+
+Example:
+
+Having...
+
+```yaml
+javascript:
+  enabled: false
+eslint:
+  enabled: true
+  config_file: style/config/.eslintrc.json
+tslint:
+  enabled: false
+  config_file: style/config/tslint.json
+ruby:
+  enabled: true
+  config_file: style/config/.rubocop.yml
+scss:
+  enabled: true
+  config_file: style/config/.scss-lint.yml
+```
+
+And running...
+
+```bash
+$ hound rules update
+```
+
+You will get in your `$HOME` path the following files:
+
+```
+.eslintrc.json
+.rubocop.yml
+.scss-lint.yml
+```
+
+Also, you can pass a linter's name to update rules for a specific language.
+
+For example:
+
+Running...
+
+```
+$ hound rules update ruby
+```
+
+You will get an updated `.rubocop.yml` file in your `$HOME` path.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## Credits
+
+Thank you [contributors](https://github.com/platanus/hound-cli/graphs/contributors)!
+
+<img src="http://platan.us/gravatar_with_text.png" alt="Platanus" width="250"/>
+
+Paperclip Attributes is maintained by [platanus](http://platan.us).
+
+## License
+
+Hound CLI is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.

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 "hound"
+
+# 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/exe/hound

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+lib = File.expand_path(File.dirname(__FILE__) + "/../lib")
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "commander"
+require "hound"
+require "hound/cli"
+
+Hound::Cli.new.run

data/hound.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hound/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hound-cli"
+  spec.version       = Hound::VERSION
+  spec.authors       = ["Platanus"]
+  spec.email         = ["rubygems@platan.us"]
+
+  spec.summary       = "Ruby CLI to generate style rules"
+  spec.description   = "Ruby CLI to generate style rules for several linters"
+
+  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_dependency "colorize", "~> 0.7", ">= 0.7.7"
+  spec.add_dependency "activesupport", "~> 4.2", ">= 4.2.6"
+  spec.add_dependency "rest-client", "~> 1.8", ">= 1.8.0"
+  spec.add_dependency "commander", "~> 4.4", ">= 4.4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "pry"
+end

data/lib/hound/cli.rb

@@ -0,0 +1,35 @@
+module Hound
+  class Cli
+    include Commander::Methods
+
+    def run
+      program :name, "Hound"
+      program :version, Hound::VERSION
+      program :description, "CLI to generate style rules"
+      define_update_cmds
+      run!
+    end
+
+    private
+
+    def define_update_cmds
+      command("rules update") do |c|
+        c.syntax = "hound rules updates"
+        c.description = "Update rules for enabled linters"
+        c.action { RulesUpdater.update }
+      end
+
+      ConfigCollection::LINTER_NAMES.each do |linter|
+        define_update_linter_cmd(linter)
+      end
+    end
+
+    def define_update_linter_cmd(linter)
+      command("rules update #{linter}") do |c|
+        c.syntax = "hound rules update #{linter}"
+        c.description = "Update rules for #{linter} linter"
+        c.action { RulesUpdater.update(linter) }
+      end
+    end
+  end
+end

data/lib/hound/config/base.rb

@@ -0,0 +1,25 @@
+module Hound
+  module Config
+    class Base
+      attr_reader :linters_file_name
+
+      def name
+        name_from_class
+      end
+
+      def linters_file_path
+        File.join(File.expand_path("~"), linters_file_name)
+      end
+
+      def rules_url
+        HoundConfig.rules_url_for(name)
+      end
+
+      private
+
+      def name_from_class
+        self.class.name.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/hound/config/eslint.rb

@@ -0,0 +1,9 @@
+module Hound
+  module Config
+    class Eslint < Base
+      def initialize
+        @linters_file_name = ".eslintrc.json"
+      end
+    end
+  end
+end

data/lib/hound/config/ruby.rb

@@ -0,0 +1,9 @@
+module Hound
+  module Config
+    class Ruby < Base
+      def initialize
+        @linters_file_name = ".rubocop.yml"
+      end
+    end
+  end
+end

data/lib/hound/config/scss.rb

@@ -0,0 +1,9 @@
+module Hound
+  module Config
+    class Scss < Base
+      def initialize
+        @linters_file_name = ".scss-lint.yml"
+      end
+    end
+  end
+end

data/lib/hound/config/tslint.rb

@@ -0,0 +1,9 @@
+module Hound
+  module Config
+    class Tslint < Base
+      def initialize
+        @linters_file_name = "tslint.json"
+      end
+    end
+  end
+end

data/lib/hound/config_collection.rb

@@ -0,0 +1,23 @@
+module Hound
+  class ConfigCollection
+    LINTER_NAMES = %w{ruby eslint tslint scss}
+
+    def self.config_instances(linter_names = [])
+      linter_names = LINTER_NAMES if linter_names.empty?
+      linter_names.map do |linter|
+        ensure_valid_linter(linter)
+        "Hound::Config::#{linter.classify}".constantize.new
+      end
+    end
+
+    class << self
+      private
+
+      def ensure_valid_linter(linter)
+        if !LINTER_NAMES.include?(linter)
+          raise Hound::Error::InvalidLang.new("Invalid #{linter} linter")
+        end
+      end
+    end
+  end
+end

data/lib/hound/errors.rb

@@ -0,0 +1,6 @@
+module Hound
+  module Error
+    class ConfigError < Exception; end
+    class InvalidLang < Exception; end
+  end
+end

data/lib/hound/hound_config.rb

@@ -0,0 +1,46 @@
+class HoundConfig
+  CONFIG_FILE_REPOSITORY = "https://raw.githubusercontent.com/platanus/la-guia/master/"
+
+  def self.content
+    @@content ||= load_content
+  end
+
+  def self.enabled_for?(linter_name)
+    # disabled if linter_name key does not exist in hound.yml
+    return false unless content.has_key?(linter_name)
+    options = options_for(linter_name)
+    # enabled if linter_name key exists and enabled key is not defined.
+    return true unless options.keys.select { |k| k.downcase === "enabled" }.any?
+    # enabled "enabled" or "Enabled" keys are true.
+    !!options["enabled"] || !!options["Enabled"]
+  end
+
+  def self.options_for(linter_name)
+    return content[linter_name] if content.try(:has_key?, linter_name)
+    Hash.new
+  end
+
+  def self.rules_url_for(linter_name)
+    path_in_repo = options_for(linter_name)["config_file"].to_s
+    HoundConfig::CONFIG_FILE_REPOSITORY + path_in_repo
+  end
+
+  class << self
+    private
+
+    def config_file_url
+      CONFIG_FILE_REPOSITORY + ".hound.yml"
+    end
+
+    def load_content
+      Hound::Parser.yaml(RestClient.get(config_file_url))
+    rescue RestClient::ResourceNotFound
+      inform_config_not_found(config_file_url)
+      Hash.new
+    end
+
+    def inform_config_not_found(url)
+      puts "config file not found in #{url}".red
+    end
+  end
+end

data/lib/hound/parser.rb

@@ -0,0 +1,7 @@
+module Hound
+  class Parser
+    def self.yaml(content)
+      YAML.safe_load(content, [Regexp])
+    end
+  end
+end

data/lib/hound/rules_updater.rb

@@ -0,0 +1,48 @@
+module Hound
+  class RulesUpdater
+    def self.update(*linter_names)
+      ConfigCollection.config_instances(linter_names).each do |linter_config|
+        get_rules(linter_config)
+      end
+    end
+
+    class << self
+      private
+
+      def get_rules(linter_config)
+        if !HoundConfig.enabled_for?(linter_config.name)
+          inform_disabled(linter_config)
+          return
+        end
+
+        rules = get_rules_from_url(linter_config)
+        return unless rules
+        write_linters_file(linter_config, rules)
+        inform_update(linter_config)
+      end
+
+      def get_rules_from_url(linter_config)
+        RestClient.get(linter_config.rules_url)
+      rescue RestClient::ResourceNotFound
+        inform_rules_not_found(linter_config)
+      end
+
+      def write_linters_file(linter_config, rules)
+        File.write(linter_config.linters_file_path, rules)
+      end
+
+      def inform_update(linter_config)
+        puts "#{linter_config.linters_file_name} (#{linter_config.name} style) was updated".green
+      end
+
+      def inform_disabled(linter_config)
+        puts "#{linter_config.linters_file_name} (#{linter_config.name} style) wasn't updated \
+because the style was undefined or disabled in .hound.yml file".yellow
+      end
+
+      def inform_rules_not_found(linter_config)
+        puts "rules for #{linter_config.name} not found in #{linter_config.rules_url}".red
+      end
+    end
+  end
+end

data/lib/hound/version.rb

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

data/lib/hound.rb

@@ -0,0 +1,19 @@
+require "colorize"
+require "rest-client"
+require "active_support/all"
+require "yaml"
+
+require "hound/version"
+require "hound/errors"
+require "hound/parser"
+require "hound/hound_config"
+require "hound/rules_updater"
+require "hound/config_collection"
+require "hound/config/base"
+require "hound/config/ruby"
+require "hound/config/eslint"
+require "hound/config/tslint"
+require "hound/config/scss"
+
+module Hound
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: hound-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Platanus
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Ruby CLI to generate style rules for several linters
+email:
+- rubygems@platan.us
+executables:
+- hound
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hound
+- hound.gemspec
+- lib/hound.rb
+- lib/hound/cli.rb
+- lib/hound/config/base.rb
+- lib/hound/config/eslint.rb
+- lib/hound/config/ruby.rb
+- lib/hound/config/scss.rb
+- lib/hound/config/tslint.rb
+- lib/hound/config_collection.rb
+- lib/hound/errors.rb
+- lib/hound/hound_config.rb
+- lib/hound/parser.rb
+- lib/hound/rules_updater.rb
+- lib/hound/version.rb
+homepage: 
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby CLI to generate style rules
+test_files: []