hexx-suit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6db3970977e3cec6c389e31e36e13df1a1744c25
+  data.tar.gz: 6330afe7eb0c5fd3c67d61d23b58c4acdefddf82
+SHA512:
+  metadata.gz: 8936e786a6839d456fd3da48ae37e11190481c83f8e399ac22b456bb0f5cf7d6ce9c61f591ff92978428afd0ef651011ad423eb4bd7b6f90c866c23f7669d018
+  data.tar.gz: 74512e4cafa561cdb5ca4bd0ceb2e953100b504b4b7a4e6afb497c015f9c66d67f0084699a6cdd3b2c1496a6ef5679aa1ed4666b91011abd1903ddc2a1342c55

data/.rubocop.yml

@@ -0,0 +1,71 @@
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+
+Lint/RescueException:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/ClassLength:
+  Exclude:
+    - 'lib/**/generator*'
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'spec/**/*'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/**/version.rb'
+    - 'spec/**/*'
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'Gemfile'
+    - '*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Exclude:
+    - 'spec/**/*'

data/.yardopts

@@ -0,0 +1,3 @@
+--asset LICENSE
+--exclude lib/hexx/version.rb
+--hide-api hide

data/Guardfile

@@ -0,0 +1,29 @@
+guard :rspec, cmd: "bundle exec rspec" do
+
+  watch("bin/hexx-suit") { "spec/tests/bin/install_spec.rb" }
+
+  watch(%r{^lib/tasks/(.+)\.rb$}) do |m|
+    [
+      "spec/tests/tasks/#{ m[1] }_spec.rb",
+      "spec/tests/tasks/#{ m[1] }/**/*_spec.rb"
+    ]
+  end
+
+  watch(%r{^lib/hexx/suit/(.+)\.rb$}) do |m|
+    "spec/tests/lib/#{ m[1] }_spec.rb"
+  end
+
+  watch(%r{^lib/hexx/suit/(.+)/base\.rb$}) do |m|
+    "spec/tests/lib/#{ m[1] }/*_spec.rb"
+  end
+
+  watch("lib/hexx/suit.rb") { "spec" }
+
+  watch("lib/hexx-suit.rb") { "spec" }
+
+  watch(/^spec.+_spec\.rb$/)
+
+  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
+
+  watch("spec/spec_helper*.rb") { "spec" }
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2014 Andrew Kozin, https://github.com/nepalez
+
+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,164 @@
+# Hexx::Suit
+
+[![Gem Version](https://img.shields.io/gem/v/hexx-suit.svg?style=flat)][gem]
+[![Build Status](https://img.shields.io/travis/nepalez/hexx-suit/master.svg?style=flat)][travis]
+[![Dependency Status](https://img.shields.io/gemnasium/nepalez/hexx-suit.svg?style=flat)][gemnasium]
+[![Coverage](https://img.shields.io/coveralls/nepalez/hexx-suit.svg?style=flat)][coveralls]
+[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](file:LICENSE)
+
+[gem]: https://rubygems.org/gems/hexx-suit
+[travis]: https://travis-ci.org/nepalez/hexx-suit
+[gemnasium]: https://gemnasium.com/nepalez/hexx-suit
+[codeclimate]: https://codeclimate.com/github/nepalez/hexx-suit
+[coveralls]: https://coveralls.io/r/nepalez/hexx-suit
+
+The module collects the test/development suit to be shared among projects, along with base settings for included packages.
+
+It also defines a set of Rake tasks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+    group :test, :development do
+        gem "hexx-suit"
+    end
+```
+
+Then execute:
+
+```
+    $ bundle
+```
+
+And run the task from the application root:
+
+```
+    $ hexx-suit install
+```
+
+Require the gem in the `spec_helper.rb` **before** loading application:
+
+```ruby
+    # spec/spec_helper.rb
+    require "hexx-suit"
+
+    # Loads coveralls and pippi runtime metrics
+    # in the application's scope.
+    Hexx::Suit.load_metrics_for(self)
+
+    # ...
+    require "my_app"
+```
+
+You can configure all metrics separately in a corresponding yml files, that are created at `config/metrics` directory. The directory also contains default STYLEGUIDE. Feel free to adapt it to your needs.
+
+## Usage
+
+The gem adds three tasks for a development process authomation:
+
+### Test
+
+The task runs rspec (runs no coverage controls) **in a bundle environment**.
+
+```
+    $ rake test
+```
+
+This is a simple shortcut for longer syntaxes:
+
+```
+    $ bundle exec rspec spec
+```
+
+### Debug
+
+The tasks runs specs wrapped to pry `rescue` command.
+
+```
+    $ rake debug
+```
+
+This is the same as:
+
+```
+    $ bundle exec rescue rspec spec
+```
+
+### Check
+
+The task runs rspec under the test coverage control, and then calls all the code metrics, except for mutation testing.
+
+```
+    $ rake check
+```
+
+You can use single metrics as well:
+
+```
+    $ rake check:yardstick
+```
+
+See all tasks at:
+
+```
+    $ rake -T check
+```
+
+All the tasks will use settings from `config/metrics` folder.
+
+## Package content
+
+The gem loads dependencies from the projects below.
+
+### Tools for Testing
+
+* [rspec v3.0+](http://rspec.info/) - a Ruby test framework.
+* [guard-rspec](https://github.com/guard/guard-rspec) - an authomatic tests launcher.
+* [coveralls](https://coveralls.io/) - a tool for the test coverage control.
+* [mutant](https://github.com/mbj/mutant) - a Ruby mutation testing.
+
+### Tools for Debugging
+
+* [pry](https://github.com/pry/pry/wiki) - a Ruby development console and debugging tool.
+* [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug)
+* [pry-rescue](https://github.com/ConradIrwin/pry-rescue)
+* [pry-stack-explorer](https://github.com/pry/pry-stack_explorer)
+
+### Tools for Tasks Authomation
+
+* [rake](https://github.com/ruby/rake) - a Ruby command line interface (CLI).
+
+### Code Metrics
+
+* [rubocop](https://github.com/bbatsov/rubocop) - a Ruby static code analyzer
+* [metric_fu](https://github.com/metricfu/metric_fu/) - a collection of Ruby code analyzers.
+* [pippi](https://github.com/tcopeland/pippi) - a utility for finding suboptimal Ruby class API usage. 
+
+### Tools for Documenting
+
+* [yard](https://yardoc.org/) - a Ruby documentation tool.
+* [inch](https://trivelop.de/inch/) - a documentation measurement tool.
+* [yardstick](https://github.com/dkubb/yardstick) - a tool that verifies documentation coverage of Ruby code
+
+## Compatibility
+
+Tested under MRI rubies >= 2.1
+
+RSpec 3.0+ used for testing
+
+## Contributing
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or version
+  (if you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## License
+
+See [MIT LICENSE](file: LICENSE).

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+  exit
+end
+
+# Loads bundler tasks
+Bundler::GemHelper.install_tasks
+
+# Loads the Hexx::Suit without tasks
+require "hexx-suit"
+
+# Sets the :spec task to default
+task :default do
+  system "bundle exec rspec spec"
+end

data/bin/hexx-suit

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "hexx-suit"
+
+# Command line runner.
+class CLI < Thor
+  register(
+    Hexx::Suit::Install,
+    "install",
+    "install [NAME]",
+    "Creates a Rakefile in the application root."
+  )
+end
+
+CLI.start

data/config/initializers/focus.rb

@@ -0,0 +1,5 @@
+# Runs tests tagged by :focus only
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/config/initializers/garbage_collection.rb

@@ -0,0 +1,11 @@
+# Delays garbage collection until the end of testing.
+RSpec.configure do |config|
+
+  config.before(:each) do
+    GC.disable
+  end
+
+  config.after(:each) do
+    GC.enable
+  end
+end

data/config/initializers/i18n.rb

@@ -0,0 +1,3 @@
+require "i18n"
+
+I18n.enforce_available_locales = false

data/config/initializers/random_order.rb

@@ -0,0 +1,4 @@
+# Runs tests in a random order
+RSpec.configure do |config|
+  config.order = "random"
+end

data/config/initializers/rspec.rb

@@ -0,0 +1,11 @@
+# Configures RSpec default settings
+RSpec.configure do |config|
+
+  config.mock_with :rspec do |mocks|
+    mocks.yield_receiver_to_any_instance_implementation_blocks = false
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/lib/hexx-suit.rb

@@ -0,0 +1,16 @@
+# Loads the parts of the suit to be available.
+%w(i18n pry rake rspec thor yaml).each { |gem| require gem }
+
+# Loads the code (the order is significant)
+Dir.chdir File.expand_path("../..", __FILE__) do
+  Dir[
+    "./config/initializers/*.rb",
+    "./lib/hexx/suit/utils/*.rb",
+    "./lib/hexx/suit/metrics/base.rb",
+    "./lib/hexx/suit/metrics/metric_fu/base.rb",
+    "./lib/hexx/suit/metrics/metric_fu/*.rb",
+    "./lib/hexx/suit/metrics/*.rb",
+    "./lib/hexx/suit/*.rb",
+    "./lib/hexx/suit.rb"
+  ].each { |file| require file }
+end

data/lib/hexx/suit.rb

@@ -0,0 +1,101 @@
+# Shared namespace for the Hexx-based gems
+module Hexx
+
+  # Namespace for the module.
+  #
+  # @api public
+  module Suit
+    class << self
+
+      # Loads all the necessary rake tasks
+      #
+      # @example
+      #   Hexx::Suit.install_tasks
+      #
+      # @return [self]
+      def install_tasks
+        load_gem_tasks
+        load_rspec_tasks
+        load_custom_tasks
+
+        self
+      end
+
+      # Loads runtime metrics in a given scope
+      #
+      # Checks if a corresponding environment is set
+      #
+      # @example
+      #   # spec/spec_helper.rb
+      #   Hexx::Suit.load_metrics_for(self)
+      #
+      # @param [Object] scope
+      #
+      # @return [self]
+      def load_metrics_for(scope)
+        load_pippi_for(scope)
+        load_coverage_for(scope)
+
+        self
+      end
+
+      private
+
+      # Loads runtime coverage metric in a given scope
+      #
+      # @param [Object] scope
+      #
+      # @return self
+      def load_coverage_for(scope)
+        return unless ENV["USE_SIMPLECOV"]
+        scope.instance_eval { Hexx::Suit::Metrics::SimpleCov.run }
+      end
+
+      # Loads runtime pippi metric in a given scope
+      #
+      # @param [Object] scope
+      #
+      # @return [self]
+      def load_pippi_for(scope)
+        return unless ENV["USE_PIPPI"]
+        scope.instance_eval { Hexx::Suit::Metrics::Pippi.run }
+      end
+
+      # Loads bundler rake tasks
+      #
+      # @return [self]
+      #
+      # @api private
+      def load_gem_tasks
+        require "bundler/gem_tasks"
+        ::Bundler::GemHelper.install_tasks
+
+        self
+      end
+
+      # Loads rspec +spec+ rake task
+      #
+      # @return [self]
+      #
+      # @api private
+      def load_rspec_tasks
+        require "rspec/core/rake_task"
+        ::RSpec::Core::RakeTask.new(:spec)
+
+        self
+      end
+
+      # Loads rake tasks, defined in the gem
+      #
+      # @return [self]
+      #
+      # @api private
+      def load_custom_tasks
+        tasks = ::File.expand_path "../../tasks/**/*.rake", __FILE__
+        ::Dir[tasks].each { |task| load task }
+
+        self
+      end
+    end # singleton_class Suit
+  end # module Suit
+end # module Hexx