hexx-suit 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fdbdb475f334c8f5e60e3fa6451b362fe480cd0
-  data.tar.gz: f0b436a826bb72e564dc73e0665da7ca76410d59
+  metadata.gz: 4e924682d1675f4e8884330b4aeabab278fbea26
+  data.tar.gz: e3d471c9998711c7056dc4fc4b7af0f250ab440a
 SHA512:
-  metadata.gz: 835100001fc537f397cac461ba3c636be4ecee2071203e9ce37f2f467a3862ecd8429f8ec7fd12e87656b1daa2ee769eb4899b8e3c9430c0fd7f389fcaa6d66a
-  data.tar.gz: 6a5e1231d15cc059f10b4436de1ea46d8e0c5030d7915b5b141be168c029ed822d574865d58eb7656b641be046ef504f012d35527d8d68904794897b07726918
+  metadata.gz: 9cfcd2f272e615b57ba4e97870c3d7eb3bf399985bba9789ebfed029e09a5562fcd17b74be9f84e01290b099a5a3b9aedbdf7b61ef78712c51ca909cb7a58fe4
+  data.tar.gz: b3b22710eec9e5e59c7d52de1706b53b5d01a568d44c7f49a514291d8e3962fc4c5f09227217e6a6e5fc8a5ecfa251d1782a5da5fb2c6c0f86eaf2839a9be6b2

data/.coveralls.yml

@@ -1 +1,2 @@
+---
 service_name: travis-ci

data/.travis.yml

@@ -3,13 +3,8 @@ language: ruby
 script: bundle exec rspec spec
 rvm:
   - '1.9.3'
-  - '2.0'
-  - '2.1'
-  - '2.2'
-  - rbx-2
-  - jruby-1.7
   - ruby-head
-  - jruby-head
-allow_failures:
-  - rvm: ruby-head
-  - rvm: jruby-head
+  - rbx-2 --1.9
+  - rbx-2 --2.0
+  - jruby-1.7-mode19
+  - jruby-head-mode21

data/Gemfile

@@ -3,15 +3,14 @@ source "https://rubygems.org"
 gemspec
 
 platforms :ruby do
-  gem "pry-rescue", "~> 1.4"
-  gem "pry-stack_explorer", "~> 0.4"
+  gem "pry-rescue", "~> 1.4", require: true
+  gem "pry-stack_explorer", "~> 0.4", require: true
 end
 
 platforms :mri_19 do
-  gem "pry-debugger", "~> 0.2"
+  gem "pry-debugger", "~> 0.2", require: true
 end
 
-platforms :mri_20, :mri_21, :mri_22 do
-  gem "pry-byebug", "~> 3.0"
-  gem "pippi", "~> 0.0"
+platforms :mri_20, :mri_21 do
+  gem "pry-byebug", "~> 3.0", require: true
 end

data/README.md

@@ -21,35 +21,34 @@ It also defines a set of Rake tasks.
 Add this line to your application's Gemfile:
 
 ```ruby
-    group :test, :development do
-        gem "hexx-suit"
-    end
+group :test, :development do
+  gem "hexx-rspec"
+  gem "hexx-suit", require: false
+end
 ```
 
 Then execute:
 
 ```
-    bundle
+bundle
 ```
 
 And run the task from the application root:
 
 ```
-    hexx-suit install
+hexx-suit install
 ```
 
-Require the gem in the `spec_helper.rb` **before** loading application:
+Require the `hexx-rspec` part of the gem in the `spec_helper.rb` **before** loading application:
 
 ```ruby
-    # spec/spec_helper.rb
-    require "hexx-suit"
+# spec/spec_helper.rb
+require "hexx-rspec"
 
-    # Loads coveralls and pippi runtime metrics
-    # in the application's scope.
-    Hexx::Suit.load_metrics_for(self)
+# Loads coveralls runtime metrics
+Hexx::RSpec.load_metrics_for(self)
 
-    # ...
-    require "my_app"
+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.
@@ -63,13 +62,13 @@ The gem adds three tasks for a development process authomation:
 The task runs rspec (runs no coverage controls) **in a bundle environment**.
 
 ```
-    rake test
+rake test
 ```
 
 This is a simple shortcut for longer syntaxes:
 
 ```
-    bundle exec rspec spec
+bundle exec rspec spec
 ```
 
 ### Debug
@@ -77,13 +76,13 @@ This is a simple shortcut for longer syntaxes:
 The tasks runs specs wrapped to pry `rescue` command.
 
 ```
-    rake debug
+rake debug
 ```
 
 This is the same as:
 
 ```
-    bundle exec rescue rspec spec
+bundle exec rescue rspec spec
 ```
 
 ### Check
@@ -91,19 +90,19 @@ This is the same as:
 The task runs rspec under the test coverage control, and then calls all the code metrics, except for mutation testing.
 
 ```
-    rake check
+rake check
 ```
 
 You can use single metrics as well:
 
 ```
-    rake check:yardstick
+rake check:yardstick
 ```
 
 See all tasks at:
 
 ```
-    rake -T check
+rake -T check
 ```
 
 All the tasks will use settings from `config/metrics` folder.
@@ -134,9 +133,8 @@ The gem loads dependencies from the projects below.
 
 * [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. Available for MRI ruby 2.0+ only.
 
-### Tools for Documenting
+### Documentation Tools
 
 * [yard](https://yardoc.org/) - a Ruby documentation tool.
 * [inch](https://trivelop.de/inch/) - a documentation measurement tool.
@@ -144,13 +142,24 @@ The gem loads dependencies from the projects below.
 
 ## Compatibility
 
-Tested under rubies:
+Tested under rubies API 1.9.3+:
 
 * MRI 1.9.3+
-* Rubinius 2+
-* JRuby 1.7+ (ruby 1.9.3)
+* Rubinius 2+ (1.9 and 2.0 modes)
+* JRuby 1.7+ (1.9 and 2.0+ modes)
 
-RSpec 3.0+ used for testing
+RSpec 3.0+ used for testing via [hexx-rspec] suit.
+
+[hexx-rspec]: https://github.com/nepalez/hexx-rspec
+
+## Latest Changes
+
+### v1.0.0
+
+* Pippi metric removed as incompatible to rubies 1.9.3
+* 'hexx-rspec' module extracted to separate gem.
+  
+  It is now possible using 'hexx-suit' with the `require: false` key.
 
 ## Contributing
 

data/Rakefile

@@ -9,10 +9,9 @@ end
 # Loads bundler tasks
 Bundler::GemHelper.install_tasks
 
-# Loads the Hexx::Suit without tasks
-require "hexx-suit"
+# Loads the Hexx::RSpec and its tasks
+require "hexx-rspec"
+Hexx::RSpec.install_tasks
 
-# Sets the :spec task to default
-task :default do
-  system "bundle exec rspec spec"
-end
+# Sets the Hexx::RSpec :test task to default
+task default: :test

data/hexx-suit.gemspec

@@ -19,17 +19,12 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 1.9.3"
 
-  s.add_runtime_dependency "coveralls", "~> 0.7"
   s.add_runtime_dependency "guard-rspec", "~> 4.3"
-  s.add_runtime_dependency "i18n", "~> 0.7"
+  s.add_runtime_dependency "hexx-rspec", "~> 0.0"
   s.add_runtime_dependency "inch", "~> 0.5"
   s.add_runtime_dependency "metric_fu", "~> 4.11"
   s.add_runtime_dependency "mutant-rspec", "~> 0.7"
-  s.add_runtime_dependency "pry", "~> 0.10"
-  s.add_runtime_dependency "rake", "~> 10.3"
-  s.add_runtime_dependency "rspec", "~> 3.0"
   s.add_runtime_dependency "rubocop", "~> 0.23"
-  s.add_runtime_dependency "thor", "~> 0.19"
   s.add_runtime_dependency "yardstick", "~> 0.9"
 
 end

data/lib/hexx/suit/install/Guardfile

@@ -1,6 +1,15 @@
 # encoding: utf-8
-guard :rspec, cmd: "rake test" do
-  watch(%r{^spec/tests/.+_spec\.rb})
-  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
-  watch(/^spec\/spec_helper\w*.rb/)  { "spec" }
-end
+
+guard :rspec, cmd: "bundle exec rspec" do
+
+  watch(/^lib(.+)\.rb$/) do |m|
+    "spec/tests#{ m[1] }_spec.rb"
+  end
+
+  watch("spec/tests/*_spec.rb")
+
+  watch("lib/*.rb")             { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
+  watch("spec/support/**/*.rb") { "spec" }
+
+end # guard :rspec

data/lib/hexx/suit/install/_rubocop.yml

@@ -1 +1,2 @@
+---
 inherit_from: "./config/metrics/rubocop.yml"

data/lib/hexx/suit/install/_yardopts

@@ -1,2 +1,3 @@
 --asset LICENSE
 --exclude lib/**/version.rb
+--output doc/api

data/lib/hexx/suit/install.rb

@@ -1,4 +1,7 @@
+# encoding: utf-8
+
 module Hexx
+
   module Suit
 
     # The generator creates a Rakefile in a destination root
@@ -15,11 +18,7 @@ module Hexx
       #
       # @api public
 
-      # Root folder for the generator's templates
-      #
-      # @return [String]
-      #
-      # @api private
+      # @private
       def self.source_root
         @source_root ||= File.expand_path "../install", __FILE__
       end
@@ -27,68 +26,38 @@ module Hexx
       namespace :install
       desc "Installs the 'hexx-suit' gem."
 
-      # Creates the Rakefile
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def create_rakefile
-        copy_file "Rakefile"
+      # @private
+      def install_rspec
+        Hexx::RSpec::Install.start
       end
 
-      # Creates the Guardfile
-      #
-      # @return [undefined]
-      #
-      # @api private
+      # @private
       def create_guardfile
         copy_file "Guardfile"
       end
 
-      # Creates the .rspec settings
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def create_rspec
-        copy_file "_rspec", ".rspec"
-      end
-
-      # Creates the .yardopts settings
-      #
-      # @return [undefined]
-      #
-      # @api private
+      # @private
       def create_yardopts
         copy_file "_yardopts", ".yardopts"
       end
 
-      # creates the metric settings
-      #
-      # @return [undefined]
-      #
-      # @api private
+      # @private
       def create_metrics
         directory "metrics", "config/metrics"
       end
 
-      # creates metric_fu loader
-      #
-      # @return [undefined]
-      #
-      # @api private
+      # @private
       def create_metrics_loader
         copy_file "_metrics", ".metrics"
       end
 
-      # creates metric_fu loader
-      #
-      # @return [undefined]
-      #
-      # @api private
+      # @private
       def create_rubocop_loader
         copy_file "_rubocop.yml", ".rubocop.yml"
       end
+
     end # class Install
+
   end # module Suit
+
 end # module Hexx

data/lib/hexx/suit/metrics/metric_fu/base.rb

@@ -1,12 +1,15 @@
 # encoding: utf-8
 
 module Hexx
+
   module Suit
+
     module Metrics
-      class MetricFu < Base
+
+      class MetricFu < RSpec::Metrics::Base
 
         # Base class for metrics configured via metric_fu
-        class Base < Metrics::Base
+        class Base < RSpec::Metrics::Base
 
           # Constructs the object and loads 'metric_fu' dependency
           #
@@ -52,8 +55,13 @@ module Hexx
               yield(metric)
             end
           end
-        end
-      end
-    end
-  end
-end
+
+        end # class Base
+
+      end # class MetricFu
+
+    end # module Metrics
+
+  end # module Suit
+
+end # module Hexx

data/lib/hexx/suit/metrics/metric_fu/cane.rb

@@ -3,7 +3,7 @@
 module Hexx
   module Suit
     module Metrics
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         # The configurer for the Cane metric
         class Cane < Base

data/lib/hexx/suit/metrics/metric_fu/churn.rb

@@ -3,7 +3,7 @@
 module Hexx
   module Suit
     module Metrics
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         # The configurer for the Churn metric
         class Churn < Base

data/lib/hexx/suit/metrics/metric_fu/flay.rb

@@ -3,7 +3,7 @@
 module Hexx
   module Suit
     module Metrics
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         # The configurer for the Flay metric
         class Flay < Base

data/lib/hexx/suit/metrics/metric_fu/reek.rb

@@ -3,7 +3,7 @@
 module Hexx
   module Suit
     module Metrics
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         # The configurer for the Reek metric
         class Reek < Base

data/lib/hexx/suit/metrics/metric_fu/roodi.rb

@@ -3,7 +3,7 @@
 module Hexx
   module Suit
     module Metrics
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         # The configurer for the Roodi metric
         class Roodi < Base

data/lib/hexx/suit/metrics/metric_fu/saikuro.rb

@@ -3,7 +3,7 @@
 module Hexx
   module Suit
     module Metrics
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         # The configurer for the Saikuro metric
         class Saikuro < Base

data/lib/hexx/suit/metrics/metric_fu.rb

@@ -5,7 +5,7 @@ module Hexx
     module Metrics
 
       # Configurator for the metric_fu and all its subpackages
-      class MetricFu < Base
+      class MetricFu < RSpec::Metrics::Base
 
         require_relative "metric_fu/base"
         require_relative "metric_fu/cane"

data/lib/hexx/suit/metrics/rubocop.rb

@@ -3,7 +3,7 @@ module Hexx
     module Metrics
 
       # Prepares and runs rubocop environment from '.hexx-suit.yml'
-      class Rubocop < Base
+      class Rubocop < RSpec::Metrics::Base
 
         # @!scope class
         # Sets ENV variables for rubocop rake tasks

data/lib/hexx/suit/metrics/yardstick.rb

@@ -3,7 +3,7 @@ module Hexx
     module Metrics
 
       # Prepares and runs yardstick environment from '.hexx-suit.yml'
-      class Yardstick < Base
+      class Yardstick < RSpec::Metrics::Base
 
         # Loads yardstick verifier
         #

data/lib/hexx/suit/metrics.rb

@@ -13,12 +13,9 @@ module Hexx
     # Configurators loads their own dependencies in a corresponding constructor.
     module Metrics
 
-      require_relative "metrics/base"
       require_relative "metrics/metric_fu"
       require_relative "metrics/rubocop.rb"
-      require_relative "metrics/simplecov.rb"
       require_relative "metrics/yardstick.rb"
-      require_relative "metrics/pippi.rb" if USE_PIPPI_METRIC
 
     end
 

data/lib/hexx/suit/version.rb

@@ -1,7 +1,13 @@
+# encoding: utf-8
+
 module Hexx
+
   module Suit
+
     # The semantic version of the module.
     # @see http://semver.org/ Semantic versioning 2.0
-    VERSION = "0.2.2".freeze
+    VERSION = "1.0.0".freeze
+
   end # module Suit
+
 end # module Hexx

data/lib/hexx/suit.rb

@@ -1,10 +1,13 @@
-# Shared namespace for the Hexx-based gems
+# encoding: utf-8
+
 module Hexx
 
   # Namespace for the module.
-  #
-  # @api public
   module Suit
+
+    require_relative "suit/metrics"
+    require_relative "suit/install"
+
     class << self
 
       # Loads all the necessary rake tasks
@@ -12,90 +15,34 @@ module Hexx
       # @example
       #   Hexx::Suit.install_tasks
       #
-      # @return [self]
+      # @return [undefined]
       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
+      # Loads runtime metrics for the host gem
       #
       # @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
+        RSpec.load_metrics_for(scope)
       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
+        Hexx::RSpec.install_tasks
       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 # singleton class Suit
+
   end # module Suit
+
 end # module Hexx

data/lib/hexx-suit.rb

@@ -1,16 +1,12 @@
-# Loads the parts of the suit to be available.
-%w(i18n pry rake rspec thor yaml).each { |gem| require gem }
+# encoding: utf-8
 
-# Pippi depends on MRI ruby 2.0+ only
-USE_PIPPI_METRIC = (RUBY_ENGINE == "ruby") && (RUBY_VERSION >= "2.0")
+require "hexx-rspec"
+require "pry"
 
-# 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.rb",
-    "./lib/hexx/suit/*.rb",
-    "./lib/hexx/suit.rb"
-  ].each { |file| require file }
-end
+# Shared namespace for the Hexx-based gems
+module Hexx
+
+  require_relative "hexx/suit/version"
+  require_relative "hexx/suit"
+
+end # module Hexx