hexx-rspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7a7c03eb865178f4ad9bfd55718a5b2c38ce7cc
+  data.tar.gz: c15856816912ae234a1f47ed6d0a0a54e01320d3
+SHA512:
+  metadata.gz: c8d933bec15d75b8e14953fad124332d520d301251403059f1ad641384afac6ba9aea31c7244f57895b0c13faf5c00b5fb7af36758e0a084011198fddfef037b
+  data.tar.gz: f402fcb1ec81a89227e52d758cf2b528a32558e6113db94c8e643f2d34300d471d9a760aafd6e133a314a314eb958fe9c33f159e18808cfd4949ab1fcec4aa32

data/.coveralls.yml

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

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+*.lock
+.bundle/
+.yardoc/
+coverage/
+doc/
+log/
+pkg/
+tmp/
+output/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,67 @@
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/Documentation:
+  Exclude:
+    - '**/version.rb'
+    - '**/*_spec.rb'
+
+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.rb'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+language: ruby
+script: bundle exec rspec spec
+matrix:
+  include:
+    - rvm: '1.9.3'
+      env: 'rspec=3.0'
+    - rvm: 'ruby-head'
+      env: 'rspec=master'
+    - rvm: 'rbx-2 --1.9'
+      env: 'rspec=3.0'
+    - rvm: 'rbx-2 --2.0'
+      env: 'rspec=master'
+    - rvm: 'jruby-19mode'
+      env: 'rspec=3.0'
+    - rvm: 'jruby-21mode'
+      env: 'rspec=master'

data/.yardopts

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Guardfile

@@ -0,0 +1,29 @@
+guard :rspec, cmd: "bundle exec rspec" do
+
+  watch("bin/hexx-rspec") { "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/rspec/(.+)\.rb$}) do |m|
+    "spec/tests/lib/#{ m[1] }_spec.rb"
+  end
+
+  watch(%r{^lib/hexx/rspec/(.+)/base\.rb$}) do |m|
+    "spec/tests/lib/#{ m[1] }/*_spec.rb"
+  end
+
+  watch("lib/hexx/rspec.rb") { "spec" }
+
+  watch("lib/hexx-rspec.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) 2015 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,85 @@
+# Hexx::RSpec 
+
+[![Gem Version](https://img.shields.io/gem/v/hexx-rspec.svg?style=flat)][gem]
+[![Build Status](https://img.shields.io/travis/nepalez/hexx-rspec/master.svg?style=flat)][travis]
+[![Dependency Status](https://img.shields.io/gemnasium/nepalez/hexx-rspec.svg?style=flat)][gemnasium]
+[![Code Climate](https://img.shields.io/codeclimate/github/nepalez/hexx-rspec.svg?style=flat)][codeclimate]
+[![Coverage](https://img.shields.io/coveralls/nepalez/hexx-rspec.svg?style=flat)][coveralls]
+
+[gem]: https://rubygems.org/gems/hexx-rspec 
+[travis]: https://travis-ci.org/nepalez/hexx-rspec 
+[gemnasium]: https://gemnasium.com/nepalez/hexx-rspec 
+[codeclimate]: https://codeclimate.com/github/nepalez/hexx-rspec 
+[coveralls]: https://coveralls.io/r/nepalez/hexx-rspec 
+
+The module adds RSpec, Coveralls and Simplecov dependencies to the gem, and adds their default settings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test, :development do
+  gem "hexx-rspec"
+end
+```
+
+Then execute:
+
+```
+bundle
+```
+
+And run the task from the application root:
+
+```
+hexx-rspec install
+```
+
+Require the gem in the `spec_helper.rb` **before** loading application:
+
+```ruby
+# spec/spec_helper.rb
+require "hexx-rspec"
+
+# Loads coveralls runtime metric in the application's scope.
+Hexx::RSpec.load_metrics_for(self)
+
+# Loads the application under the test.
+require "my_app"
+```
+
+Review the `config/metrics/simplecov.yml` for coverage report settings.
+
+## Usage
+
+Use `rake test` of `rake test:coverage` respectively.
+
+Or run `rake test:coverage:run` and `rake test:coverage:display` separately.
+
+## Compatibility
+
+Tested under rubies with API 1.9.3+:
+
+* MRI 1.9.3+
+* JRuby 1.7+ (1.9 and 2.0+ modes)
+* Rubinius 2+ (1.9 and 2.0+ modes)
+
+[RSpec] 3.0+ used for testing
+
+[RSpec]: http://rspec.info
+
+## 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::RSpec without tasks
+require "hexx-rspec"
+
+# Sets the :spec task to default
+task :default do
+  system "bundle exec rspec spec"
+end

data/bin/hexx-rspec

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require "hexx-rspec"
+
+# Command line runner.
+class CLI < Thor
+  register(
+    Hexx::RSpec::Install,
+    "install",
+    "install",
+    "Installs 'hexx-rspec' into the host app."
+  )
+end
+
+CLI.start

data/config/initializer.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+# Loads configuration files
+require_relative "initializers/rspec"
+require_relative "initializers/i18n"
+require_relative "initializers/focus"
+require_relative "initializers/random_order"
+require_relative "initializers/garbage_collection"

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/hexx-rspec.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "hexx/rspec/version"
+
+Gem::Specification.new do |gem|
+
+  gem.name        = "hexx-rspec"
+  gem.version     = Hexx::RSpec::VERSION.dup
+  gem.author      = "Andrew Kozin"
+  gem.email       = "andrew.kozin@gmail.com"
+  gem.homepage    = "https://github.com/nepalez/hexx-rspec"
+  gem.summary     = "RSpec settings."
+  gem.description = "RSpec, Coveralls and Simplecov settings."
+  gem.license     = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables      = ["hexx-rspec"]
+  gem.test_files       = Dir["spec/**/*", "Rakefile", "Guardfile"]
+  gem.extra_rdoc_files = Dir["LICENSE", "README.md", ".yardopts"]
+
+  gem.required_ruby_version = ">= 1.9.3"
+
+  gem.add_runtime_dependency "coveralls", "~> 0.7"
+  gem.add_runtime_dependency "i18n", "~> 0.7"
+  gem.add_runtime_dependency "rake", "~> 10.3"
+  gem.add_runtime_dependency "rspec", "~> 3.0"
+  gem.add_runtime_dependency "simplecov", "~> 0.9"
+  gem.add_runtime_dependency "thor", "~> 0.19"
+
+end

data/lib/hexx/rspec/install/Rakefile

@@ -0,0 +1,17 @@
+# 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::RSpec and its tasks
+require "hexx-rspec"
+Hexx::RSpec.install_tasks
+
+# Sets the Hexx::RSpec :test task to default
+task default: :test

data/lib/hexx/rspec/install/_rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/lib/hexx/rspec/install/simplecov.yml

@@ -0,0 +1,8 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: # The list of groups to be shown in the coverage report
+  Libraries: "lib/"
+  Application: "app/"

data/lib/hexx/rspec/install.rb

@@ -0,0 +1,43 @@
+module Hexx
+  module RSpec
+
+    # The generator creates a Rakefile in a destination root
+    class Install < Thor::Group
+      include Thor::Actions
+
+      # @!scope class
+      # @!method start
+      # Populates files into current directory
+      #
+      # @return [undefined]
+      #
+      # @api public
+
+      # @private
+      def self.source_root
+        @source_root ||= File.expand_path "../install", __FILE__
+      end
+
+      namespace :install
+      desc "Installs the 'hexx-rspec' gem."
+
+      # @private
+      def create_rakefile
+        copy_file "Rakefile"
+      end
+
+      # @private
+      def create_rspec
+        copy_file "_rspec", ".rspec"
+      end
+
+      # @private
+      def create_simplecov
+        copy_file "simplecov.yml", "config/metrics/simplecov.yml"
+      end
+
+    end # class Install
+
+  end # module RSpec
+
+end # module Hexx

data/lib/hexx/rspec/metrics/base.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+module Hexx
+
+  module RSpec
+
+    module Metrics
+
+      # Base class for metrics configurators
+      #
+      # To be used by the 'hexx-suit' module as well
+      class Base
+
+        # The utility class for sending commands to the system
+        SYSTEM = System
+
+        # Loads metric settings and configures the current metric
+        #
+        # @return [Hexx::RSpec::Metrics]
+        #   the configured metric object
+        def self.load
+          __send__(:new).load
+        end
+
+        # Configures and runs the current metric
+        #
+        # @return (see #run)
+        def self.run
+          load.run
+        end
+
+        # Loads the configuration file and configures the metric
+        #
+        # @return [self]
+        #
+        # @api private
+        def load
+          self
+        end
+
+        # Runs the metric
+        #
+        # @abstract
+        #
+        # @return [undefined]
+        #
+        # @api private
+        def run; end
+
+        # @note
+        #   The class has a private constructor.
+        #   Use methods {.load} or {.run}.
+        private_class_method :new
+
+        private
+
+        # Extracts a hash of settings from the current file
+        #
+        # @return [Hash]
+        #
+        # @api private
+        def settings
+          @settings ||= file ? YAML.load_file(file) : {}
+        end
+
+        # Returns the name of the settings file
+        #
+        # @return [String]
+        #   when the file is present in the config/metrics folder
+        # @return [nil]
+        #   when the file is absent in the config/metrics folder
+        #
+        # @api private
+        def file
+          @file ||= Dir["config/metrics/#{ name }.yml"].first
+        end
+
+        # The name of the current metric
+        #
+        # @abstract
+        #
+        # @return [Symbol]
+        attr_reader :name
+      end
+    end
+  end
+end

data/lib/hexx/rspec/metrics/simplecov.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+module Hexx
+
+  module RSpec
+
+    module Metrics
+
+      # Prepares and runs test coverage environment
+      #
+      # @api private
+      class SimpleCov < Base
+
+        # Loads the simplecov and coveralls gem
+        #
+        # @return [Hexx::RSpec::Metrics::SimpleCov]
+        #
+        # @api private
+        def self.new
+          %w(simplecov coveralls).each { |gem| require gem }
+          super
+        end
+
+        # @!scope class
+        # Configures the SimpleCov metric
+        #
+        # @return [self]
+        def load
+          set_environment
+          configure_metric
+
+          super
+        end
+
+        # @!scope class
+        # Configures simplecov from the simplecov.yml file and starts
+        # the metric
+        #
+        # @return [undefined]
+        def run
+          metric.start
+        end
+
+        private
+
+        # simplecov metric definitions
+
+        def name
+          "simplecov"
+        end
+
+        def metric
+          ::SimpleCov
+        end
+
+        def default_options
+          {
+            "output"  => "tmp/coverage",
+            "filters" => ["spec/", "config/"],
+            "groups"  => {
+              "Libraries" => "lib/",
+              "Application" => "app/"
+            }
+          }
+        end
+
+        # operations
+
+        def set_environment
+          ENV["USE_SIMPLECOV"]    = "true"
+          ENV["SIMPLECOV_OUTPUT"] = "#{ output }/index.html"
+        end
+
+        def configure_metric
+          add_filters
+          add_groups
+          set_formatters
+          set_output
+        end
+
+        def add_filters
+          filters.each(&metric.method(:add_filter))
+        end
+
+        def add_groups
+          groups.each { |key, value| metric.add_group(key, value) }
+        end
+
+        def set_formatters
+          metric.formatter = metric::Formatter::MultiFormatter[
+            metric::Formatter::HTMLFormatter,
+            ::Coveralls::SimpleCov::Formatter
+          ]
+        end
+
+        def set_output
+          metric.coverage_dir output
+        end
+
+        # helpers
+
+        def options
+          @options ||= default_options.merge settings.to_hash
+        end
+
+        def output
+          @output = options["output"]
+        end
+
+        def filters
+          @filters ||= Array(options["filters"]).flatten.map(&:to_s)
+        end
+
+        def groups
+          @groups ||= begin
+            list = options["groups"]
+            list.is_a?(Hash) ? list : {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hexx/rspec/metrics.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Hexx
+
+  module RSpec
+
+    # Contains metric configurators
+    #
+    # Any configurator loads metric settings from a corresponding yaml,
+    # sets necessary environments via {.load} method,
+    # and then runs the metric via {.run} method.
+    #
+    # Configurators loads their own dependencies in a corresponding constructor.
+    module Metrics
+
+      require_relative "metrics/base"
+      require_relative "metrics/simplecov.rb"
+
+    end
+
+  end # module RSpec
+
+end # mdoule Hexx