brutal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a587ca80409c91605c6f0045e4f3b8b40f517b755e196748f0fc8dba6bff6e9
+  data.tar.gz: 722b740531d4046ef5c3a639e93aa0c9edcfa362f63d43dfe77ae37ab9ee9062
+SHA512:
+  metadata.gz: e3147d44673898eee50b89db97c2f6ad19a48dd64b1c5df8c023ca64fe554a7d0a787f0f3241eb8e613aec2af59b50cda7331814807c80c1d2fed6ab833fac85
+  data.tar.gz: 5e5d91e3d1139fae44f148632d6c94c944e407bf75c684db73ebc7cc15fa804855d90f2e6606280cafdf42d0a630a5a48068a0df45c32311ec2f85096345576c

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Cyril Kato
+
+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,136 @@
+# Brutal
+
+> Brutal test suite scaffold generator
+
+![A lumberjack brutally cutting a tree.](img/Ferdinand_Hodler_-_Woodcutter_-_Google_Art_Project.jpg)
+
+[![Build Status](https://api.travis-ci.org/cyril/brutal.rb.svg?branch=master)][travis]
+[![Gem Version](https://badge.fury.io/rb/brutal.svg)][gem]
+[![Inline docs](https://inch-ci.org/github/cyril/brutal.rb.svg?branch=master)][inchpages]
+[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brutal'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install brutal
+
+## QuickStart
+
+Just type `brutal` in a Ruby project's folder and watch the magic happen.
+
+## Usage
+
+The Brutal YAML file handles 4 keys:
+
+* `header` (optional): Some code to execute before the test suite.
+* `subject` (required): The front object of the test suite.
+* `variables` (required): A hash to decline the subject in to various contexts.
+* `challenges` (required): An array of methods to apply to each result.
+
+## Example
+
+Given this `.brutal.yml` config file:
+
+```yaml
+header: |
+  # Some string concatenation unit tests
+
+subject: |
+  "Hello" + "%{hello_target}%{punctuation_mark}"
+
+variables:
+  :hello_target:
+    -
+    - ", Bob"
+
+  :punctuation_mark:
+    - "!"
+    - ...
+
+challenges:
+  - .to_s
+  - .length
+```
+
+The `brutal` command would generate the following file:
+
+```ruby
+# Some string concatenation unit tests
+
+# ------------------------------------------------------------------------------
+
+result = "Hello" + "!"
+
+raise unless result.to_s == "Hello!"
+raise unless result.length == 6
+
+# ------------------------------------------------------------------------------
+
+result = "Hello" + "..."
+
+raise unless result.to_s == "Hello..."
+raise unless result.length == 8
+
+# ------------------------------------------------------------------------------
+
+result = "Hello" + ", Bob!"
+
+raise unless result.to_s == "Hello, Bob!"
+raise unless result.length == 11
+
+# ------------------------------------------------------------------------------
+
+result = "Hello" + ", Bob..."
+
+raise unless result.to_s == "Hello, Bob..."
+raise unless result.length == 13
+```
+
+## Integration with Rake
+
+The generated brutal test suite `test.rb` file can be declared as follows:
+
+```ruby
+Rake::TestTask.new do |t|
+  t.pattern = 'test.rb'
+end
+```
+
+## Contact
+
+* Home page: https://github.com/cyril/brutal.rb
+* Bugs/issues: https://github.com/cyril/brutal.rb/issues
+
+## Rubies
+
+* [MRI](https://www.ruby-lang.org/)
+* [Rubinius](https://rubinius.com/)
+* [JRuby](https://www.jruby.org/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cyril/brutal.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cyril/brutal.rb/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 GreatGuardian project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cyril/brutal.rb/blob/master/CODE_OF_CONDUCT.md).
+
+[gem]: https://rubygems.org/gems/brutal
+[travis]: https://travis-ci.org/cyril/brutal.rb
+[inchpages]: https://inch-ci.org/github/cyril/brutal.rb
+[rubydoc]: https://rubydoc.info/gems/brutal/frames

data/bin/brutal

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'yaml'
+
+FILE_NAME = '.brutal.yml'
+CONF_PATH = ::File.join(::Dir.pwd, FILE_NAME)
+
+abort "File #{CONF_PATH} not found!" unless ::File.exist?(CONF_PATH)
+
+conf = ::YAML.load_file(CONF_PATH)
+
+header      = conf.fetch('header', '')
+subject     = conf.fetch('subject')
+challenges  = conf.fetch('challenges')
+variables   = conf.fetch('variables')
+
+raise ::TypeError unless header.is_a?(::String)
+raise ::TypeError unless challenges.is_a?(::Array)
+raise ::TypeError unless variables.is_a?(::Hash)
+
+require_relative ::File.join('..', 'lib', 'brutal')
+
+brutal_scaffold = case ARGV.fetch(0, nil)
+                  when nil
+                    ::Brutal::Framework::Poro
+                  else
+                    abort "Framework #{ARGV[0].inspect} not (yet) supported!"
+                  end
+
+eval(header)
+
+brutal_specs = header + brutal_scaffold.new(subject, *challenges, **variables)
+                                       .to_s
+
+file = ::File.open('test.rb', 'w')
+file.write(brutal_specs)
+file.close

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative ::File.join('..', 'lib', 'brutal')
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/brutal.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Brutal
+end
+
+Dir[File.join File.dirname(__FILE__), 'brutal', 'framework', '*.rb'].each do |fname|
+  require_relative fname
+end

data/lib/brutal/framework/base.rb

@@ -0,0 +1,17 @@
+module Brutal
+  module Framework
+    class Base
+      attr_reader :subject, :challenges, :variables
+
+      def initialize(subject, *challenges, **variables)
+        @subject    = subject
+        @challenges = challenges
+        @variables  = variables
+      end
+
+      def to_s
+        raise ::NotImplementedError
+      end
+    end
+  end
+end

data/lib/brutal/framework/poro.rb

@@ -0,0 +1,31 @@
+require_relative 'base'
+
+module Brutal
+  module Framework
+    class Poro < Base
+      def to_s
+        names       = variables.keys.sort
+        values_arr  = names.map { |name| variables.fetch(name) }
+        test_params = Array(values_arr[0]).product(*Array(values_arr[1..-1]))
+
+        test_params.inject('') do |scaffold, values|
+          attributes = names.each_with_index.inject({}) do |h, (name, i)|
+            h.merge(name.to_sym => values.fetch(i))
+          end
+
+          populated_subject = subject % attributes
+          result = eval(populated_subject)
+
+          scaffold += "\n# " + ('-' * 78) + "\n\nresult = #{populated_subject}\n"
+
+          challenges.each do |challenge|
+            value = "result#{challenge}"
+            scaffold += "raise unless #{value} == #{eval(value).inspect}\n"
+          end
+
+          scaffold
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: brutal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cyril Kato
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rubocop-performance
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Brutal test suite scaffold generator
+email: contact@cyril.email
+executables:
+- brutal
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- bin/brutal
+- bin/console
+- bin/setup
+- lib/brutal.rb
+- lib/brutal/framework/base.rb
+- lib/brutal/framework/poro.rb
+homepage: https://github.com/cyril/brutal.rb
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Brutal test suite scaffold generator
+test_files: []