cspec 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bce6a42b077ba1322fe740a7ee6bab8f04c43d1da2bf1c2b4f2cf98dede01d0
-  data.tar.gz: fa799c8a04d5c6ce1e754ca0e9006e76728d3e673166faf4d7d80766327145ea
+  metadata.gz: 714f4f91b2400d6116f74df4ffbe5ca1bc9c5bec537e732e40be0b98a7725257
+  data.tar.gz: fba0bb895cee486513aa75eca6b822bf4dc111e9f3036638addbfb86a56d2088
 SHA512:
-  metadata.gz: 49b499104203e05ed46fff75da408e5642e5dc9d0aa4aafe152530fd84028b19b1759cf8dc2a7805962e52ca273b664c5d9aacc8e862f64ce388345ea23a30e5
-  data.tar.gz: 105a3acebe341d7c6e5388e23e783d324f054d51e826d649e150bcb03dcecc1954f2f4db2c381b7c81e10e276ef01026ef7fbca92bd648903d311f3e4e60a392
+  metadata.gz: da0f7fe559c1e5cc941cda78d4d2eeb2b78a29b69364c5b0c92581772d7447cad98a5f54ce035dd243020d08487dd5d33c3254d8ad58200493d5aaad17ad11a2
+  data.tar.gz: a5da9ae8fd9f37aa85a77f5f8ea9ba56a9b89d38bfdc50724398b49722ee166ffb106515f65137d9a841d572793317265def0e2a173292ef3ccdbf45d7c39418

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,28 @@
+# 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'

data/Gemfile.lock

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

data/README.md

@@ -1,43 +1,34 @@
 # Cspec
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cspec`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Running test cases via CSV
 
-TODO: Delete this and the text above, and describe your gem
+The goal of this project is to have a centralised location where all specs can be run
 
-## Installation
-
-Add this line to your application's Gemfile:
+## Quick start
 
+* Add this to your `Gemfile`
 ```ruby
-gem 'cspec'
+  gem 'cspec'
+```
+* Create a CSV named `specs.csv` with the following spec
+```csv
+class,name,type,initialize_params_1,method,method_args_1,expected
+MyClass,my test,,hello,,world
+```
+* Create a file named `my_csv_specs.rb` to run the specs
+```ruby
+require 'cspec'
+
+# The implementation of the Ruby class being testedc
+class MyClass
+  def hello
+    'world'
+  end
+end
+
+# Running the specs
+result = CSpec::Runner.run!("#{Dir.pwd}/specs.csv")
+puts "Success: #{result}"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install cspec
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Cspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cspec/blob/master/CODE_OF_CONDUCT.md).
+* Run with `ruby my_csv_specs.rb`

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']

data/examples/basic/Gemfile

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

data/examples/basic/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/basic/myspec.rb

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

data/examples/basic/specs.csv

@@ -0,0 +1,2 @@
+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/loader.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module CSpec
+  module Loader
+    def self.load(filename)
+      ::CSV.open(filename, headers: :first_row).map(&:to_h)
+    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)
+      %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/{result.rb → cspec/result.rb}

@@ -1,9 +1,16 @@
+# frozen_string_literal: true
+
 module CSpec
   class Result
     attr_reader :name, :class, :method, :error, :description, :details
 
     def self.success?(results)
-      results.count {|r|r.error != nil} == 0
+      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)
     end
 
     def initialize(name, klass, method, error, description, details)
@@ -25,7 +32,8 @@ module CSpec
     end
 
     def to_s
-        "name: #{self.name}, class: #{self.class}, method: #{self.method}, error: #{self.error}, description: #{self.description}, details: #{self.details}"
+      "name: #{name}, class: #{self.class}, method: #{method}," \
+        " error: #{error}, description: #{description}, details: #{details}"
     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::DataType.convert(::CSpec::Executer.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/version.rb

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

data/lib/cspec.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 require 'cspec/version'
+require 'cspec/runner'
+require 'cspec/loader'
+require 'cspec/result'
+
 require 'csv'
-require_relative 'result'
 
 module CSpec
   module ResultsOutputter
@@ -13,89 +16,36 @@ module CSpec
     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])
+      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])
+      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
+    def self.do(spec)
+      case spec[:type]
+      when 'class'
+        do_class(spec)
+      when 'instance'
+        do_instance(spec)
       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
+  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)
 
-        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
+      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.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Jarrod Folino
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-27 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,8 +59,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,9 +73,23 @@ files:
 - bin/console
 - bin/setup
 - cspec.gemspec
+- 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/loader.rb
+- lib/cspec/result.rb
+- lib/cspec/runner.rb
 - lib/cspec/version.rb
-- lib/result.rb
 homepage: https://github.com/jarroddalefolino/cspec
 licenses:
 - MIT
@@ -86,7 +103,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:
   - - ">="