cspec 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e6512690d45aa69b0fd226cb3cbca981c05b5f162abee524553e5f91aefa6d3
-  data.tar.gz: 86de0ecc3c9ef516fb6826982bd0688dade55354d487a35670df4e868ea99098
+  metadata.gz: cda46241abf4da89965884153263bde46dca2f2861f260797ae0d7e0dd9112f5
+  data.tar.gz: c313da5f4b11eba2dc9f666d39377ae2c5d53780dfbf3a7521c97b16d02cd8d0
 SHA512:
-  metadata.gz: ecf7e5dbce6382722a9cf26bef10c8d75a940d797dc6ddc23c971131084321a2cc6aa3248a816ab0301fb16d5aef0e62980cc38ca5de7feea1341750719f59f6
-  data.tar.gz: c2830c4864d15e6861948bf5bd1da88ca11066f676d82cbd0c47865a983cc7f1357c73e55db23551c0f08ef73915c5697ea953111c5c431ae777c824a1e3f54c
+  metadata.gz: a31c47d67801b6e6efd5e7ad7903e3bdec312c8df734e84768b27f707f6a89c3b0b14545c14d8450416afc3d331647fe209b3094652a68b690abb02405afcb30
+  data.tar.gz: 6132fb403d49a14b014ffeade47400dc2c2e1c95e207573e64d50acae0bdfcab40f7fe9e6e2891ae2b563a415bd818177c89a86dce4f97a286cad93efd9cdb7b

data/.github/workflows/ruby.yml

@@ -0,0 +1,48 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    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 }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Install Rubocop
+      run: gem install rubocop
+    - name: Run Rubocop
+      run: rubocop
+    - name: Run Specs
+      run: bundle exec rspec
+    - name: Run Basic Example
+      working-directory: ./examples/basic
+      run: bundle install && bundle exec ruby myspec.rb
+    - name: Run Method Args Example
+      working-directory: ./examples/method_args
+      run: bundle install && bundle exec ruby myspec.rb
+    - name: Run Class Methods Example
+      working-directory: ./examples/class_methods
+      run: bundle install && bundle exec ruby myspec.rb  

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: .rubocop_todo.yml
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+Metrics/BlockLength:
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 11
+
+Metrics/ParameterLists:
+  Max: 6
+
+Security/Eval:
+  Exclude:
+    - 'lib/cspec/data_type.rb'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    cspec (0.1.2)
+    cspec (0.1.5)
 
 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

@@ -5,6 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cspec/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.5.0'
   spec.name          = 'cspec'
   spec.version       = Cspec::VERSION
   spec.authors       = ['Jarrod Folino']
@@ -40,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.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cspec
+
+BUNDLED WITH
+   1.17.2

data/examples/advance/myspec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cspec'
+
+class MyClass
+  def greet(fname, sname)
+    "Hello, #{fname} #{sname}"
+  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,2 @@
+class,name,type,method,method_arg_1,method_arg_2,expected
+MyClass,my test,instance,greent,Bob,Jones,"Hello, Bo Jones"

data/examples/basic/Gemfile

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

data/examples/basic/Gemfile.lock

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

data/examples/basic/myspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cspec'
 
 class MyClass
@@ -7,4 +9,5 @@ class MyClass
 end
 
 result = CSpec::Runner.run!("#{Dir.pwd}/specs.csv")
-puts "Success: #{result}"
+puts "Success: #{result}"
+exit result ? 0 : 1

data/examples/basic/specs.csv

@@ -1,2 +1,2 @@
-class,name,type,method,expected
-MyClass,my test,instance,hello,worldsds
+class,name,type,method,method_args_1,expected
+MyClass,my test,instance,hello,,world

data/examples/class_methods/Gemfile

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

data/examples/class_methods/Gemfile.lock

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

data/examples/class_methods/myspec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'cspec'
+
+class MyClass
+  def self.hello
+    'world'
+  end
+
+  def self.say(name)
+    "Hello, #{name}"
+  end
+end
+
+result = CSpec::Runner.run!("#{Dir.pwd}/specs.csv")
+puts "Success: #{result}"
+exit result ? 0 : 1

data/examples/class_methods/specs.csv

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

data/examples/method_args/Gemfile

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

data/examples/method_args/Gemfile.lock

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

data/examples/method_args/myspec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'cspec'
+
+class MyClass
+  def greet(name)
+    "Hello, #{name}"
+  end
+end
+
+result = CSpec::Runner.run!("#{Dir.pwd}/specs.csv")
+puts "Success: #{result}"
+exit result ? 0 : 1

data/examples/method_args/specs.csv

@@ -0,0 +1,2 @@
+class,name,type,method,method_arg_1,expected
+MyClass,my test,instance,greet,Bob,"Hello, Bob"

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'spec'
+
+module CSpec
+  module Loader
+    def self.load(filename)
+      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)
+      process_arg(spec, /method_arg_\d+/, 'method_args').merge(
+        process_arg(spec, /initialization_arg_\d+/, 'initialization_args')
+      )
+    end
+
+    def self.process_arg(spec, regex, aggregate_key)
+      spec.merge({
+                   aggregate_key => spec.keys
+                 .select { |k| k.match?(regex) }
+                 .inject([]) { |values, key| values << spec[key] }
+                 })
+    end
+
+    def self.validate(filename)
+      headers = CSV.open(filename, &:readline)
+      ::CSpec::Validator.validate(headers)
+    end
+  end
+end

data/lib/cspec/result.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CSpec
+  class Result
+    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, error)
+    end
+
+    def initialize(spec, error)
+      @spec = spec
+      @error = error
+    end
+
+    def ==(other)
+      error == other.error &&
+        spec == other.spec
+    end
+
+    def to_s
+      "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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CSpec
+  module Runner
+    def self.run!(filepath)
+      errors = Loader.validate(filepath)
+      unless errors.empty?
+        puts errors
+        return false
+      end
+      specs = Loader.load(filepath)
+      results = run(specs)
+
+      return true if CSpec::Result.success?(results)
+
+      ResultsOutputter.display(results)
+      false
+    end
+
+    def self.run(specs)
+      specs.map do |spec|
+        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)
+      end
+    end
+  end
+end

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.3'
+  VERSION = '0.2.0'
 end

data/lib/cspec.rb

@@ -1,101 +1,15 @@
 # frozen_string_literal: true
 
 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'
-require_relative 'result'
 
 module CSpec
-  module ResultsOutputter
-    def self.display(results)
-      results.each do |r|
-        puts r
-      end
-    end
-  end
-
-  module Loader
-    def self.load(filename)
-      ::CSV.open(filename, headers: :first_row).map(&:to_h)
-    end
-
-    def self.validate(filename)
-      errors = []
-      headers = CSV.open(filename, &:readline)
-      %w[class type name method expected].each do |required_header|
-        errors << "Need header: #{required_header}" unless headers.include?(required_header)
-      end
-      errors
-    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[:initialize_params])
-      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
-  end
-
-  module DataType
-    def self.convert(input)
-      if input =~ /^\d+\.\d+$/
-        input.to_f
-      elsif input =~ /^\d+$/
-        input.to_i
-      elsif input =~ /^\[.*\]$/
-        eval(input)
-      elsif ['', nil, 'nil'].include?(input)
-        nil
-      else
-        input.to_s
-      end
-    end
-  end
-
-  module Runner
-    def self.run!(filepath)
-      errors = Loader.validate(filepath)
-      if errors.size != 0
-        puts errors
-        return false
-      end
-      specs = Loader.load(filepath)
-      results = run(specs)
-
-      if CSpec::Result.success?(results)
-        return true
-      else
-        ResultsOutputter.display(results)
-        return false
-      end
-    end
-
-    def self.run(specs)
-      results = []
-      specs.each do |spec|
-        result = case spec[:type]
-                 when 'class'
-                   ::CSpec::Executer.do_class(spec)
-                 when 'instance'
-                   ::CSpec::Executer.do_instance(spec)
-                 end
-
-        result = ::CSpec::DataType.convert(result)
-        results << if result == ::CSpec::DataType.convert(spec[:expected])
-                     Result.new(spec['name'], spec['class'], spec['method'], nil, spec['description'], nil)
-                   else
-                     Result.new(spec['name'], spec['class'], spec['method'],
-                                "Expected #{spec[:expected]}, got: #{result}", spec['description'], nil)
-                   end
-      rescue StandardError => e
-        results << Result.new(spec[:name], spec[:class], spec[:method], e.inspect, spec[:description], nil)
-      end
-      results
-    end
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cspec
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Jarrod Folino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2022-03-06 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
@@ -59,8 +73,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -70,13 +87,32 @@ 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
 - examples/basic/specs.csv
+- examples/class_methods/Gemfile
+- examples/class_methods/Gemfile.lock
+- examples/class_methods/myspec.rb
+- examples/class_methods/specs.csv
+- examples/method_args/Gemfile
+- examples/method_args/Gemfile.lock
+- 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
-- lib/result.rb
 homepage: https://github.com/jarroddalefolino/cspec
 licenses:
 - MIT
@@ -90,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/result.rb

@@ -1,31 +0,0 @@
-module CSpec
-  class Result
-    attr_reader :name, :class, :method, :error, :description, :details
-
-    def self.success?(results)
-      results.count {|r|r.error != nil} == 0
-    end
-
-    def initialize(name, klass, method, error, description, details)
-      @name = name
-      @error = error
-      @class = klass
-      @method = method
-      @description = description
-      @details = details
-    end
-
-    def ==(other)
-      name == other.name &&
-        self.class == other.class &&
-        self.method == other.method &&
-        self.error == other.error &&
-        self.description == other.description &&
-        self.details == other.details
-    end
-
-    def to_s
-        "name: #{self.name}, class: #{self.class}, method: #{self.method}, error: #{self.error}, description: #{self.description}, details: #{self.details}"
-    end
-  end
-end