cider_ci-rspec_support 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 273a75fe82aa49c3632476ceda4e74ff0e5e166f
+  data.tar.gz: f37d760fd65ddb5d571439f9912dd0e783048415
+SHA512:
+  metadata.gz: 839fe13ffc70415a9f9f44d3acf94b140c8ff9f1a91d50ed0ce32b33920a99a6f07972334d21db8a453d4be474d298ee2fd68e04d3ecbe2827f1b2a6395b0597
+  data.tar.gz: 314797ff5c1a6bdc5a2b645b438267baffcf30bf29754ebcc9f48ee724830a5933c7b7e3d66ff97a4ab77f29e73f383ce16a8ff7a21a7496001ede9a1cdec8e3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rubocop.yml

@@ -0,0 +1,89 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-06 15:11:15 +0100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 7
+Metrics/AbcSize:
+  Max: 50
+
+# Offense count: 9
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 29
+
+# Offense count: 1
+Style/AccessorMethodName:
+  Enabled: false
+
+# Offense count: 2
+Style/ClassAndModuleCamelCase:
+  Enabled: false
+
+# Offense count: 2
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxLineLength.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Offense count: 5
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, MinBodyLength, SupportedStyles.
+Style/Next:
+  Enabled: false
+
+# Offense count: 1
+Style/RescueModifier:
+  Enabled: false
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/SignalException:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/TrailingWhitespace:
+  Enabled: false
+
+# Offense count: 1
+Lint/Eval:
+  Enabled: false
+
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Thomas Schank
+
+MIT License
+
+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,40 @@
+# Cider-CI Support for Rspec
+
+This gem provides convenience executables to work with Rspec and Cider-CI.
+
+See also [Cider-CI Support for Ruby and Ruby on Rails][].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cider_ci-rspec_support', '~> 1.0.0'
+```
+
+## Usage
+
+
+### Update 
+
+    bundle exec cider-ci_rspec-support update spec/
+
+This will read all specs and update or create the corresponding Cider-CI tasks
+in `./cider-ci/tasks/rspec-tasks.yml` and
+`./cider-ci/tasks/rspec-feature-tasks.yml` respectively. The target files can
+be configured, try 
+
+    bundle exec cider-ci_rspec-support --help
+
+
+### Check 
+
+    bundle exec cider-ci_rspec-support check spec/
+
+This will check if an update is required. It will print out a warning and exit
+with non zero if so. It is recommended to use this command in a Cider-CI task
+to tests if the specification is up to date.
+
+
+  [Cider-CI Support for Ruby and Ruby on Rails]: https://github.com/cider-ci/cider-ci_ruby-support
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/cider-ci_rspec-support

@@ -0,0 +1,161 @@
+#!/usr/bin/env ruby
+###############################################################################
+#
+# Cider-CI Taks management for Rspec tests. 
+#
+# Authors: Thomas Schank <DrTom@schank.ch>
+#
+###############################################################################
+
+###############################################################################
+# Read and write
+###############################################################################
+ 
+require 'cider_ci/rspec_support'
+require 'cider_ci/rspec_support/util'
+require 'cider_ci/rspec_support/deep_merge'
+
+require 'YAML'
+
+def read_tasks(path)
+  Hash[CiderCI::RspecSupport::Util.deep_symbolize_keys(YAML.load_file(path))]
+rescue 
+  {}
+end
+
+def write_tasks(path, tasks)
+  abs_path = File.absolute_path(path)
+  FileUtils.mkdir_p File.dirname(abs_path)
+  File.open abs_path, 'w' do |f|
+    f.write Hash[
+      CiderCI::RspecSupport::Util.deep_stringify_keys(tasks).sort].to_yaml
+  end
+end
+
+def compute_output(tasks, file_path, template)
+  CiderCI::RspecSupport::DeepMerge.deep_merge(
+    Hash[tasks.map do |task|
+      [task.key, task.spec_properties(template)]
+    end],
+    read_tasks(file_path).select do|k| 
+      tasks.map(&:key).map(&:to_sym).include? k
+    end)
+end
+
+###############################################################################
+# check, main, update
+###############################################################################
+ 
+ 
+def update(options, collected)
+  write_tasks(options.rspec_tasks_path,
+              compute_output(collected.tasks,  
+                             options.rspec_tasks_path, 
+                             options.task_body_template))
+
+  write_tasks(options.rspec_feature_tasks_path,
+              compute_output(collected.feature_tasks,  
+                             options.rspec_feature_tasks_path, 
+                             options.feature_task_body_template))
+end
+
+def keys_equal?(tasks, file)
+  Set.new(tasks.map(&:key).map(&:to_s)) == 
+    Set.new(read_tasks(file).keys.map(&:to_s))
+end
+
+def check(options, collected)
+  unless keys_equal? collected.tasks, options.rspec_tasks_path
+    abort "Rspec tasks are out of date." 
+  end
+
+  unless keys_equal? collected.feature_tasks, options.rspec_feature_tasks_path
+    abort "Rspec feature tasks are out of date." 
+  end
+
+  puts "Rspec feature tasks and regular tasks are up to date."
+  exit 0
+end
+
+def main
+  options = default_options
+  parse_options options
+  command = ARGV.shift
+  collected = collect_rspec_tasks
+
+  case command
+  when 'update'
+    update options, collected
+  when 'check'
+    check options, collected
+  else
+    abort "Don't know command '#{command}'"
+  end
+end
+
+###############################################################################
+# Rspec
+###############################################################################
+
+require 'cider_ci/rspec_support/collector'
+
+def collect_rspec_tasks
+  rspec_args = ["--format", CiderCI::RspecSupport::Collector.to_s, 
+                "--dry-run"].concat(ARGV)
+  RSpec::Core::Runner.run(rspec_args, $stderr, $stdout)
+
+  CiderCI::RspecSupport.collector
+end
+
+###############################################################################
+# Options
+###############################################################################
+ 
+require 'optparse'
+require 'ostruct'
+
+def parse_options(options)
+  OptionParser.new do |opts|
+    opts.banner = 'Usage: cider-ci_rspec-support ' \
+      '[options] COMMAND [files or directories]'
+
+    opts.on('-f', '--rspec-feature-tasks FILE', String,
+            "default: #{options.rspec_feature_tasks_path}") do |f|
+      options.respec_feature_tasks = f
+    end
+
+    opts.on('-t', '--rspec-tasks FILE', String, 
+            "default: #{options.rspec_tasks_path}") do |t|
+      options.rspec_tasks = t
+    end
+
+    opts.on(nil, '--task-body-template TEMPLATE', String, 
+            "default: #{options.task_body_template}") do |t|
+      options.task_body_template = t
+    end
+
+    opts.on(nil, '--feature-task-body-template TEMPLATE', String, 
+            "default: #{options.feature_task_body_template}") do |t|
+      options.feature_task_body_template = t
+    end
+  end.parse!
+  options
+end
+
+def default_options
+  options = OpenStruct.new
+  options.rspec_tasks_path = './.cider-ci/tasks/rspec-tasks.yml'
+  options.rspec_feature_tasks_path = './.cider-ci/tasks/rspec-feature-tasks.yml'
+
+  options.feature_task_body_template = 
+    '%[DISPLAY=":$XVNC_PORT" bundle exec rspec "#{rspec_path}"]'
+
+  options.task_body_template = '%[bundle exec rspec "#{rspec_path}"]'
+
+  options
+end
+
+###############################################################################
+# here we go 
+###############################################################################
+main

data/cider_ci-rspec_support.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cider_ci/rspec_support'
+require 'cider_ci/rspec_support/version'
+require 'cider_ci/rspec_support/collector'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cider_ci-rspec_support'
+  spec.version       = ::CiderCI::RspecSupport::VERSION
+  spec.authors       = ['Thomas Schank']
+  spec.email         = ['DrTom@schank.ch']
+  spec.summary       = 'Cider-CI support for Rspec'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/cider-ci/cider-ci_ruby-rspec-support'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)/)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_runtime_dependency 'rspec', '~> 3.1'
+
+  spec.add_runtime_dependency 'rspec-core', '>= 3.0.0', '< 4.0.0'
+end

data/lib/cider_ci/rspec_support/collector.rb

@@ -0,0 +1,42 @@
+require 'cider_ci/rspec_support'
+require 'cider_ci/rspec_support/task'
+require 'rspec/core'
+
+module CiderCI
+  module RspecSupport
+    class Collector
+      RSpec::Core::Formatters.register self, :example_started
+
+      attr_reader :tasks
+      attr_reader :feature_tasks
+
+      def initialize(_output)
+        ::CiderCI::RspecSupport.collector = self
+        @tasks = Set.new
+        @feature_tasks = Set.new 
+      end
+
+      def example_started(notification)
+        metadata = notification.example.metadata
+        case metadata[:type]
+        when :feature
+          @feature_tasks << Task.new(
+             file_path: metadata[:file_path],
+             line_number: metadata[:line_number],
+             description: metadata[:full_description])
+        else
+          if present? metadata[:file_path]
+            @tasks <<  Task.new(
+               file_path: metadata[:file_path],
+               line_number: nil,
+               description: metadata[:example_group][:description])
+          end
+        end
+      end
+
+      def present?(str)
+        str && !str.gsub(/\s+/, '').empty?
+      end
+    end
+  end
+end

data/lib/cider_ci/rspec_support/deep_merge.rb

@@ -0,0 +1,35 @@
+require 'set'
+
+module CiderCI
+  module RspecSupport
+    module DeepMerge
+      class << self
+        def deep_merge(obj1, obj2)
+          if obj1.is_a?(Hash) && obj2.is_a?(Hash)
+            deep_merge_hashes obj1, obj2
+          else
+            obj2
+          end
+        end
+
+        private 
+
+        def keys(h1, h2)
+          Set.new(h1.keys) + Set.new(h2.keys)
+        end
+
+        def deep_merge_hashes(h1, h2)
+          Hash[(keys(h1, h2)).map do |k|
+            [k, if h1.key?(k) && h2.key?(k) 
+                  deep_merge(h1[k], h2[k])
+                elsif h2.key?(k)
+                  h2[k]
+                else
+                  h1[k]
+                end]
+          end]
+        end
+      end
+    end
+  end
+end

data/lib/cider_ci/rspec_support/task.rb

@@ -0,0 +1,39 @@
+require 'digest'
+
+module CiderCI
+  module RspecSupport
+    class Task
+      
+
+      attr_reader :properties
+
+      def initialize(properties)
+        @properties = properties.freeze
+      end
+
+      def hash
+        Digest.hexencode(Digest::MD5.digest(rspec_path)).to_i(36)
+      end
+
+      def eql?(other)
+        rspec_path == other.rspec_path
+      end
+
+      def rspec_path
+        [@properties[:file_path], @properties[:line_number]].compact.join(":")
+      end
+
+      alias_method :key, :rspec_path
+
+      def spec_properties(script_main_body_template)
+        { name:  @properties[:description],
+          scripts: {
+            main: {
+              body: eval(script_main_body_template)
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/cider_ci/rspec_support/util.rb

@@ -0,0 +1,33 @@
+require 'set'
+module CiderCI
+  module RspecSupport
+    module Util
+      IDENDITY = ->(x) { x }
+      class << self
+        def transform(object, 
+                      key_transformer = IDENDITY, 
+                      value_transformer = IDENDITY) 
+          case object
+          when Hash
+            Hash[object.map do |k, v| 
+              [key_transformer.call(k), 
+               transform(v, key_transformer, value_transformer)]
+            end]
+          when Array
+            object.map { |v| transform(v, key_transformer, value_transformer) }
+          else
+            value_transformer.call(object)
+          end
+        end
+
+        def deep_symbolize_keys(object)
+          transform(object, ->(x) { x.to_sym })
+        end
+
+        def deep_stringify_keys(object)
+          transform(object, ->(x) { x.to_s })
+        end
+      end
+    end
+  end
+end

data/lib/cider_ci/rspec_support/version.rb

@@ -0,0 +1,5 @@
+module CiderCI
+  module RspecSupport
+    VERSION = '1.0.0'
+  end
+end

data/lib/cider_ci/rspec_support.rb

@@ -0,0 +1,9 @@
+require 'cider_ci/rspec_support/version'
+
+module CiderCI
+  module RspecSupport
+    class << self
+      attr_accessor :collector
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: cider_ci-rspec_support
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thomas Schank
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: ''
+email:
+- DrTom@schank.ch
+executables:
+- cider-ci_rspec-support
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/cider-ci_rspec-support
+- cider_ci-rspec_support.gemspec
+- lib/cider_ci/rspec_support.rb
+- lib/cider_ci/rspec_support/collector.rb
+- lib/cider_ci/rspec_support/deep_merge.rb
+- lib/cider_ci/rspec_support/task.rb
+- lib/cider_ci/rspec_support/util.rb
+- lib/cider_ci/rspec_support/version.rb
+homepage: https://github.com/cider-ci/cider-ci_ruby-rspec-support
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Cider-CI support for Rspec
+test_files: []
+has_rdoc: