cspec 0.1.5 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 714f4f91b2400d6116f74df4ffbe5ca1bc9c5bec537e732e40be0b98a7725257
-  data.tar.gz: fba0bb895cee486513aa75eca6b822bf4dc111e9f3036638addbfb86a56d2088
+  metadata.gz: d04fe4315cc0239fbba40d3b9161a2a611ba9e5199530020dd3111904969a063
+  data.tar.gz: f79b42125b163718b31b525c7dbaab2358e774b46ab4ac40f1bf82fe575ee252
 SHA512:
-  metadata.gz: da0f7fe559c1e5cc941cda78d4d2eeb2b78a29b69364c5b0c92581772d7447cad98a5f54ce035dd243020d08487dd5d33c3254d8ad58200493d5aaad17ad11a2
-  data.tar.gz: a5da9ae8fd9f37aa85a77f5f8ea9ba56a9b89d38bfdc50724398b49722ee166ffb106515f65137d9a841d572793317265def0e2a173292ef3ccdbf45d7c39418
+  metadata.gz: 3427855f23bc9f089a938454ec8c21c2220f6ea27fbcce4707930fa2c40674cf5df7a1277dc7ed574687bbe7d70b53d8b05a732236c85581b2077dd8e9fbc785
+  data.tar.gz: 5e50f436086bf34ad3e0de488e231f87ec2fe07b8cb8f8eaa79c89b28a3333b4f74afbe0dcd6cf034b593d8907f9b24d58086db37341e8bc6b6023b343e04c8d

data/.github/workflows/ruby.yml

@@ -24,9 +24,6 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
       uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
       with:
         ruby-version: ${{ matrix.ruby-version }}

data/.rubocop_todo.yml

@@ -1,28 +1,12 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-03-04 05:00:00 UTC using RuboCop version 1.25.1.
-# 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: 3
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
 Metrics/BlockLength:
   Max: 50
 
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 11
 
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 1
 Security/Eval:
   Exclude:
-    - 'lib/cspec.rb'
+    - 'lib/cspec/data_type.rb'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    cspec (0.1.4)
+    cspec (0.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.5.0)
+    docile (1.4.0)
     rake (10.5.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -21,6 +22,12 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
 
 PLATFORMS
   ruby
@@ -30,6 +37,7 @@ DEPENDENCIES
   cspec!
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
 
 BUNDLED WITH
    1.17.2

data/cspec.gemspec

@@ -7,7 +7,7 @@ require 'cspec/version'
 Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.5.0'
   spec.name          = 'cspec'
-  spec.version       = Cspec::VERSION
+  spec.version       = CSpec::VERSION
   spec.authors       = ['Jarrod Folino']
   spec.email         = ['jarrod.folino@coderacademy.edu.au']
 
@@ -41,4 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.17'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
 end

data/examples/advance/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gem 'cspec'

data/examples/advance/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cspec (0.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cspec
+
+BUNDLED WITH
+   1.17.2

data/examples/advance/myspec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'cspec'
+
+class MyClass
+  def greet(fname, sname)
+    "Hello, #{fname} #{sname}"
+  end
+end
+
+class Util
+  def build_array(val1, val2, val3)
+    [val1, val2, val3]
+  end
+
+  def sum_array(array)
+    array.sum
+  end
+end
+
+class Calculator
+  def self.add(val1, val2)
+    val1 + val2
+  end
+
+  def self.multi_subtract(val1, val2, val3)
+    val1 - val2 - val3
+  end
+end
+
+result = CSpec::Runner.run!("#{Dir.pwd}/specs.csv")
+puts "Success: #{result}"
+exit result ? 0 : 1

data/examples/advance/specs.csv

@@ -0,0 +1,6 @@
+class,name,type,method,method_arg_1,method_arg_2,method_arg_3,expected
+MyClass,my test,instance,greet,Bob,Jones,,"Hello, Bob Jones"
+Calculator,another test,class,add,1,2,,3
+Calculator,another test,class,multi_subtract,6,2,1,3
+Util,another test,instance,build_array,6,2,1,"[6, 2, 1]"
+Util,another test,instance,sum_array,"[6, 2, 1]",,,9

data/examples/basic/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    cspec (0.1.4)
+    cspec (0.2.1)
 
 PLATFORMS
   ruby

data/examples/basic/myspec.rb

@@ -6,6 +6,10 @@ class MyClass
   def hello
     'world'
   end
+
+  def hello2(param1)
+    "world2#{param1}"
+  end
 end
 
 result = CSpec::Runner.run!("#{Dir.pwd}/specs.csv")

data/examples/basic/specs.csv

@@ -1,2 +1,12 @@
-class,name,type,method,method_args_1,expected
+class,name,type,method,method_arg_1,expected
+MyClass,my test,instance,hello2,aaa,world2aaa
 MyClass,my test,instance,hello,,world
+MyClass,my test,instance,hello2,aaa,world2aaa
+MyClass,my test,instance,hello,,world
+MyClass,my test,instance,hello2,aaa,world2aaa
+MyClass,my test,instance,hello,,world
+MyClass,my test,instance,hello2,aaa,world2aaa
+MyClass,my test,instance,hello,,world
+MyClass,my test,instance,hello2,aaa,world2aaa
+MyClass,my test,instance,hello,,world
+

data/examples/class_methods/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    cspec (0.1.4)
+    cspec (0.2.1)
 
 PLATFORMS
   ruby

data/examples/class_methods/specs.csv

@@ -1,3 +1,3 @@
-class,name,type,method,method_args_1,expected
+class,name,type,method,method_arg_1,expected
 MyClass,my test,class,hello,,world
-MyClass,my test,class,say,Bob,"Hello, Bob"
+MyClass,my test,class,say,"Bob","Hello, Bob"

data/examples/method_args/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    cspec (0.1.4)
+    cspec (0.2.1)
 
 PLATFORMS
   ruby

data/lib/cspec/code_exec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module CSpec
+  module CodeExec
+    def self.do_instance(spec)
+      class_under_test = Object.const_get(spec.class)
+      instance_under_test = class_under_test.new(*spec.initialization_args)
+      instance_under_test.send(spec.method, *spec.method_args)
+    end
+
+    def self.do_class(spec)
+      class_under_test = Object.const_get(spec.class)
+      class_under_test.send(spec.method, *spec.method_args)
+    end
+
+    def self.do(spec)
+      case spec.type
+      when 'class'
+        do_class(spec)
+      when 'instance'
+        do_instance(spec)
+      end
+    end
+  end
+end

data/lib/cspec/data_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CSpec
+  module DataType
+    def self.convert_all(inputs)
+      return nil unless inputs
+
+      inputs.map { |input| convert(input) }
+    end
+
+    def self.convert(input)
+      return input unless input.instance_of?(String)
+
+      input = input.strip
+      return input.to_f if input =~ /^\d+\.\d+$/
+      return input.to_i if input =~ /^\d+$/
+      return eval(input) if input =~ /^\[.*\]$/
+      return nil if ['', nil, 'nil'].include?(input)
+
+      input.to_s
+    end
+  end
+end

data/lib/cspec/loader.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'spec'
+
 module CSpec
   module Loader
     def self.load(filename)
-      ::CSV.open(filename, headers: :first_row).map(&:to_h)
+      specs = ::CSV.open(filename, headers: :first_row).map(&:to_h)
+      specs.map { |spec| ::CSpec::Spec.new(process_args(spec)) }
     end
 
     def self.process_args(spec)
@@ -15,16 +18,14 @@ module CSpec
     def self.process_arg(spec, regex, aggregate_key)
       spec.merge({
                    aggregate_key => spec.keys
-                 .select { |k| k.match?(regex) }
+                 .select { |k| k.match?(regex) && !spec[k].nil? }
                  .inject([]) { |values, key| values << spec[key] }
                  })
     end
 
     def self.validate(filename)
       headers = CSV.open(filename, &:readline)
-      %w[class type name method expected].map do |required_header|
-        "Need header: #{required_header}" unless headers.include?(required_header)
-      end.reject(&:nil?)
+      ::CSpec::Validator.validate(headers)
     end
   end
 end

data/lib/cspec/result.rb

@@ -2,38 +2,29 @@
 
 module CSpec
   class Result
-    attr_reader :name, :class, :method, :error, :description, :details
+    attr_reader :spec, :error
 
     def self.success?(results)
       results.count { |r| !r.error.nil? }.zero?
     end
 
     def self.from_spec(spec, error = nil)
-      Result.new(spec['name'], spec['class'], spec['method'],
-                 error, spec['description'], nil)
+      Result.new(spec, error)
     end
 
-    def initialize(name, klass, method, error, description, details)
-      @name = name
+    def initialize(spec, error)
+      @spec = spec
       @error = error
-      @class = klass
-      @method = method
-      @description = description
-      @details = details
     end
 
     def ==(other)
-      name == other.name &&
-        self.class == other.class &&
-        method == other.method &&
-        error == other.error &&
-        description == other.description &&
-        details == other.details
+      error == other.error &&
+        spec == other.spec
     end
 
     def to_s
-      "name: #{name}, class: #{self.class}, method: #{method}," \
-        " error: #{error}, description: #{description}, details: #{details}"
+      "spec: #{spec}\n" \
+        "error: #{error}"
     end
   end
 end

data/lib/cspec/results_outputter.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CSpec
+  module ResultsOutputter
+    def self.display(results)
+      results.each do |r|
+        puts r
+      end
+    end
+  end
+end

data/lib/cspec/runner.rb

@@ -19,9 +19,9 @@ module CSpec
 
     def self.run(specs)
       specs.map do |spec|
-        result = ::CSpec::DataType.convert(::CSpec::Executer.do(spec))
-        expected = ::CSpec::DataType.convert(spec[:expected])
-        error_msg = "Expected #{spec[:expected]}, got: #{result}" if result != expected
+        result = ::CSpec::CodeExec.do(spec)
+        expected = ::CSpec::DataType.convert(spec.expected)
+        error_msg = "Expected #{spec.expected}, got: #{result}" if result != expected
         Result.from_spec(spec, error_msg)
       rescue StandardError => e
         Result.from_spec(spec, e.inspect)

data/lib/cspec/spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CSpec
+  class Spec
+    attr_reader :class,
+                :name,
+                :type,
+                :method,
+                :method_args,
+                :initialization_args,
+                :expected
+
+    def initialize(hash)
+      @class = hash['class']
+      @name = hash['name']
+      @type = hash['type']
+      @method = hash['method']
+      @method_args = ::CSpec::DataType.convert_all(hash['method_args'])
+      @initialization_args = ::CSpec::DataType.convert_all(hash['initialization_args'])
+      @expected = hash['expected']
+    end
+
+    def ==(other)
+      name == other.name &&
+        self.class == other.class &&
+        method == other.method &&
+        type == other.type &&
+        method_args == other.method_args &&
+        initialization_args == other.initialization_args
+    end
+
+    def to_s
+      "name: #{name}, class: #{self.class}, method: #{method},"
+    end
+  end
+end

data/lib/cspec/validator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CSpec
+  module Validator
+    def self.validate(headers)
+      %w[class type name method expected].map do |required_header|
+        "Need header: #{required_header}" unless headers.include?(required_header)
+      end.reject(&:nil?)
+    end
+  end
+end

data/lib/cspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module Cspec
-  VERSION = '0.1.5'
+module CSpec
+  VERSION = '0.2.2'
 end

data/lib/cspec.rb

@@ -4,48 +4,12 @@ require 'cspec/version'
 require 'cspec/runner'
 require 'cspec/loader'
 require 'cspec/result'
+require 'cspec/code_exec'
+require 'cspec/data_type'
+require 'cspec/validator'
+require 'cspec/results_outputter'
 
 require 'csv'
 
 module CSpec
-  module ResultsOutputter
-    def self.display(results)
-      results.each do |r|
-        puts r
-      end
-    end
-  end
-
-  module Executer
-    def self.do_instance(spec)
-      class_under_test = Object.const_get(spec['class'])
-      instance_under_test = class_under_test.new(*spec['initialization_args'])
-      instance_under_test.send(spec['method'], *spec['method_args'])
-    end
-
-    def self.do_class(spec)
-      class_under_test = Object.const_get(spec['class'])
-      class_under_test.send(spec['method'], *spec['method_args'])
-    end
-
-    def self.do(spec)
-      case spec[:type]
-      when 'class'
-        do_class(spec)
-      when 'instance'
-        do_instance(spec)
-      end
-    end
-  end
-
-  module DataType
-    def self.convert(input)
-      return input.to_f if input =~ /^\d+\.\d+$/
-      return input.to_i if input =~ /^\d+$/
-      return eval(input) if input =~ /^\[.*\]$/
-      return nil if ['', nil, 'nil'].include?(input)
-
-      input.to_s
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cspec
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.2
 platform: ruby
 authors:
 - Jarrod Folino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: A testing framework to run unit tests via csv
 email:
 - jarrod.folino@coderacademy.edu.au
@@ -73,6 +87,10 @@ files:
 - bin/console
 - bin/setup
 - cspec.gemspec
+- examples/advance/Gemfile
+- examples/advance/Gemfile.lock
+- examples/advance/myspec.rb
+- examples/advance/specs.csv
 - examples/basic/Gemfile
 - examples/basic/Gemfile.lock
 - examples/basic/myspec.rb
@@ -86,9 +104,14 @@ files:
 - examples/method_args/myspec.rb
 - examples/method_args/specs.csv
 - lib/cspec.rb
+- lib/cspec/code_exec.rb
+- lib/cspec/data_type.rb
 - lib/cspec/loader.rb
 - lib/cspec/result.rb
+- lib/cspec/results_outputter.rb
 - lib/cspec/runner.rb
+- lib/cspec/spec.rb
+- lib/cspec/validator.rb
 - lib/cspec/version.rb
 homepage: https://github.com/jarroddalefolino/cspec
 licenses: