fried-test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 92d60aed6837d1a83e7c87143d1a33ca1b213059
+  data.tar.gz: c8669b44945b0c231a3074457aa392db9d10ff96
+SHA512:
+  metadata.gz: 9934df539343c2882c55e410ca461eacf23b06ad9a9e86c40a69230422814ce7f0e8d69893ef85f213a65818d0f301fa84cf1f14115af293940f42062d39847d
+  data.tar.gz: 0a24a5e78899936cf3d8d17e684cfee16ef1276aaf6378aace415555c9624cf9c1d8875bc642b160119c66bc0b59f526d411fc4d0d848386dfb5105fbb49abde

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.envrc
+/binstubs/

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0
+cache: bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fried-test.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Francesco Belladonna
+
+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,91 @@
+# Fried::Test [![Build Status][test-badge]][test-link]
+
+This gem provides a small executable named `friest` which is just an
+opinionated wrapper around `minitest/autorun`. You can run `friest` and it
+will run the test suite automatically for any test found in the directory
+`test` with any file ending with `_test.rb`.
+
+## Philosophy
+
+This gem is mainly a **philosophy** on how your tests should be written.
+Tests API should be so simple that any Ruby developer can jump in and use it.
+
+Here is how your tests should look:
+
+```ruby
+require "test_helper"
+
+class HelloWorldTest < Minitest::Spec
+  def setup
+    @text = "hello, world!"
+  end
+
+  it "uses text 'hello, world!'" do
+    assert "hello, world!" == @text
+  end
+end
+```
+
+This is pure ruby. We don't use `def` because it feels more magical having
+to prefix methods with `test_`, so `it` might as well do it. In addition,
+pure text is much  more descriptive than a method with_underscores_in_name.
+
+You are allowed to use only the following assertions:
+
+- `assert`
+- `refute`
+- `assert_raises`
+
+So that any junior can join your team and write tests immediately.
+You are not allowed to use `describe` (it creates nested classes).
+
+If you have to share tests between classes, use:
+
+```ruby
+module MySharedTest
+  it "has value equal to 0" do
+    assert @value == 0
+  end
+end
+```
+
+and just `include MySharedTest` where needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fried-test'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fried-test
+
+Then require **and activate** the gem in your `test_helper.rb`
+
+```ruby
+require "fried-test"
+Fried::Test.activate
+```
+
+The "activation" is optional, it monkey patches `Module` class so that you can
+use module to share tests.
+
+## 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/Fire-Dragon-DoL/fried-test.
+
+[test-badge]: https://travis-ci.org/Fire-Dragon-DoL/fried-test.svg?branch=master
+[test-link]: https://travis-ci.org/Fire-Dragon-DoL/fried-test

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+task :test do
+  lib = File.expand_path("../lib", __FILE__)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+  require "fried/test"
+
+  Fried::Test::CLI.()
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fried/test"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/friest

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "bundler/setup"
+require "fried/test"
+
+Fried::Test::CLI.()

data/fried-test.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fried/test/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fried-test"
+  spec.version       = Fried::Test::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+
+  spec.summary       = %q{Minitest helpers and testing philosophy}
+  spec.description   = %q{Minitest helpers and testing philosophy}
+  spec.homepage      = "https://github.com/Fire-Dragon-DoL/fried-test"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-byebug"
+
+  spec.add_runtime_dependency "minitest"
+  spec.add_runtime_dependency "minitest-reporters"
+end

data/lib/fried/test/activate.rb

@@ -0,0 +1,33 @@
+require "minitest/spec"
+
+module Fried
+  module Test
+    class Activate
+      attr_accessor :target
+
+      def initialize
+        @target = nil
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.target = Module
+        end
+      end
+
+      # @return [Void]
+      def call
+        return if target.nil?
+
+        target.class_eval do
+          include Minitest::Spec::DSL
+        end
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/autorun.rb

@@ -0,0 +1,38 @@
+require "fried/test/noop"
+require "fried/test/telemetry"
+
+module Fried
+  module Test
+    class Autorun
+      class Substitute
+        include ::Fried::Test::Telemetry
+
+        def call
+          record :call
+          nil
+        end
+      end
+
+      attr_accessor :execute
+
+      def initialize
+        @execute = Noop
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.execute = method(:require)
+        end
+      end
+
+      def call
+        execute.("minitest/autorun")
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/cli.rb

@@ -0,0 +1,38 @@
+require "fried/test/load_test_files"
+require "fried/test/load_tests_path"
+require "fried/test/autorun"
+
+module Fried
+  module Test
+    class CLI
+      attr_accessor :load_tests_path
+      attr_accessor :load_test_files
+      attr_accessor :autorun
+
+      def initialize
+        @load_tests_path = LoadTestsPath.new
+        @load_test_files = LoadTestFiles.new
+        @autorun = Autorun.new
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.load_tests_path = LoadTestsPath.build
+          instance.load_test_files = LoadTestFiles.build
+          instance.autorun = Autorun.build
+        end
+      end
+
+      def call
+        load_tests_path.()
+        load_test_files.()
+        autorun.()
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/directory/current_working_directory.rb

@@ -0,0 +1,46 @@
+require "pathname"
+
+module Fried
+  module Test
+    module Directory
+      class CurrentWorkingDirectory
+        class Substitute
+          private
+
+          attr_reader :path
+
+          public
+
+          def initialize(path = "/dev/null")
+            @path = path
+          end
+
+          def call
+            Pathname.new(path)
+          end
+        end
+
+        attr_accessor :dir
+
+        def self.build
+          new.tap do |instance|
+            instance.dir = Dir
+          end
+        end
+
+        # @return [Pathname]
+        def call
+          return Pathname.new("/dev/null") if dir.nil?
+
+          path_as_text = dir.pwd
+          Pathname.new(path_as_text)
+        end
+
+        def self.call
+          instance = build
+          instance.()
+        end
+      end
+    end
+  end
+end

data/lib/fried/test/directory/get_files_by_pattern.rb

@@ -0,0 +1,51 @@
+require "pathname"
+require "fried/test/telemetry"
+
+module Fried
+  module Test
+    module Directory
+      # Behaves like {Dir.glob}
+      class GetFilesByPattern
+        class Substitute
+          include ::Fried::Test::Telemetry
+
+          private
+
+          attr_reader :files
+
+          public
+
+          def initialize(files = [])
+            @files = files
+          end
+
+          def call(pattern, flag = 0)
+            record :call, [pattern, flag]
+            files.map(&:to_s)
+          end
+        end
+
+        attr_accessor :dir
+
+        def self.build
+          new.tap do |instance|
+            instance.dir = Dir
+          end
+        end
+
+        # @see Dir.glob
+        # @return [Array<String>]
+        def call(pattern, flags = 0)
+          return [] if dir.nil?
+
+          dir.glob(pattern, flags)
+        end
+
+        def self.call
+          instance = build
+          instance.()
+        end
+      end
+    end
+  end
+end

data/lib/fried/test/get_test_directory.rb

@@ -0,0 +1,49 @@
+require "pathname"
+require "fried/test/directory/current_working_directory"
+
+module Fried
+  module Test
+    class GetTestDirectory
+      class Substitute
+        private
+
+        attr_reader :test_path
+
+        public
+
+        def initialize(test_path)
+          @test_path = test_path
+        end
+
+        def call
+          Pathname.new(test_path)
+        end
+      end
+
+      attr_accessor :current_working_directory
+
+      def initialize
+        @current_working_directory = Directory::CurrentWorkingDirectory.new
+      end
+
+      def self.build
+        new.tap do |instance|
+          cwd = Directory::CurrentWorkingDirectory.build
+
+          instance.current_working_directory = cwd
+        end
+      end
+
+      # @return [Pathname]
+      def call
+        path = current_working_directory.()
+        path.join("./test")
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/get_test_files.rb

@@ -0,0 +1,42 @@
+require "pathname"
+require "fried/test/directory/get_files_by_pattern"
+require "fried/test/get_test_directory"
+
+module Fried
+  module Test
+    # Get absolute path to all test files for current working directory
+    class GetTestFiles
+      GlobPattern = Pathname.new("./**/*_test.rb").freeze
+
+      attr_accessor :get_files_by_pattern
+      attr_accessor :get_test_directory
+
+      def initialize
+        @get_files_by_pattern = Directory::GetFilesByPattern.new
+        @get_test_directory = GetTestDirectory.new
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.get_files_by_pattern = Directory::GetFilesByPattern.build
+          instance.get_test_directory = GetTestDirectory.build
+        end
+      end
+
+      # @return [Enumerator<Pathname>]
+      def call
+        directory = get_test_directory.()
+        pattern = directory.join(GlobPattern)
+
+        files = get_files_by_pattern.(pattern.to_s)
+        files.map! { |file| directory.join(file) }
+        files.each
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/load_test_files.rb

@@ -0,0 +1,40 @@
+require "fried/test/get_test_files"
+
+module Fried
+  module Test
+    # Load test files using {require_relative}
+    class LoadTestFiles
+      class Substitute
+        include ::Fried::Test::Telemetry
+
+        def call
+          record :call
+          nil
+        end
+      end
+
+      attr_accessor :get_test_files
+
+      def initialize
+        @get_test_files = GetTestFiles.new
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.get_test_files = GetTestFiles.build
+        end
+      end
+
+      # @return [Void]
+      def call
+        test_files = get_test_files.()
+        test_files.each { |file| require_relative file.to_s }
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/load_tests_path.rb

@@ -0,0 +1,44 @@
+require "fried/test/get_test_directory"
+require "fried/test/prepend_to_load_path"
+
+module Fried
+  module Test
+    # Puts tests path into {$LOAD_PATH}
+    class LoadTestsPath
+      class Substitute
+        include ::Fried::Test::Telemetry
+
+        def call
+          record :call
+          nil
+        end
+      end
+
+      attr_accessor :get_test_directory
+      attr_accessor :prepend_to_load_path
+
+      def initialize
+        @get_test_directory = GetTestDirectory.new
+        @prepend_to_load_path = PrependToLoadPath.new
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.get_test_directory = GetTestDirectory.build
+          instance.prepend_to_load_path = PrependToLoadPath.build
+        end
+      end
+
+      # @param [Void]
+      def call
+        lib = get_test_directory.()
+        prepend_to_load_path.(lib)
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/noop.rb

@@ -0,0 +1,5 @@
+module Fried
+  module Test
+    Noop = ->(*,**) {}.freeze
+  end
+end

data/lib/fried/test/prepend_to_load_path.rb

@@ -0,0 +1,34 @@
+module Fried
+  module Test
+    # Unshifts the path to {$LOAD_PATH} unless already existing
+    class PrependToLoadPath
+      attr_accessor :load_path
+
+      def initialize
+        @load_path = []
+      end
+
+      def self.build
+        new.tap do |instance|
+          instance.load_path = $LOAD_PATH
+        end
+      end
+
+      # @param path [String, Pathname]
+      # @return [Boolean] {true} if path was added, {false} if already present
+      def call(path)
+        text_path = path.to_s
+
+        has_path = load_path.include?(text_path)
+        load_path.unshift(text_path) unless has_path
+
+        !has_path
+      end
+
+      def self.call
+        instance = build
+        instance.()
+      end
+    end
+  end
+end

data/lib/fried/test/telemetry.rb

@@ -0,0 +1,32 @@
+module Fried
+  module Test
+    module Telemetry
+      Record = Struct.new(:signal, :time, :data)
+
+      def record(signal, data = nil)
+        @__telemetry_records__ ||= []
+        time = Time.now.utc
+        @__telemetry_records__ << Record.new(signal, time, data)
+      end
+
+      def recorded?(signal)
+        @__telemetry_records__.any? do |recorded|
+          recorded.signal == signal
+        end
+      end
+
+      def recorded_with?(signal, data)
+        @__telemetry_records__.any? do |recorded|
+          recorded.signal == signal &&
+          recorded.data == data
+        end
+      end
+
+      def recorded_times?(signal, amount)
+        @__telemetry_records__.count do |recorded|
+          recorded.signal == signal
+        end
+      end
+    end
+  end
+end

data/lib/fried/test/version.rb

@@ -0,0 +1,5 @@
+module Fried
+  module Test
+    VERSION = "0.1.0"
+  end
+end

data/lib/fried/test.rb

@@ -0,0 +1,13 @@
+require "fried/test/version"
+require "fried/test/cli"
+require "fried/test/activate"
+
+module Fried
+  module Test
+    module_function
+
+    def activate
+      Activate.()
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: fried-test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: pry-byebug
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Minitest helpers and testing philosophy
+email:
+- francesco.belladonna@gmail.com
+executables:
+- friest
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/friest
+- fried-test.gemspec
+- lib/fried/test.rb
+- lib/fried/test/activate.rb
+- lib/fried/test/autorun.rb
+- lib/fried/test/cli.rb
+- lib/fried/test/directory/current_working_directory.rb
+- lib/fried/test/directory/get_files_by_pattern.rb
+- lib/fried/test/get_test_directory.rb
+- lib/fried/test/get_test_files.rb
+- lib/fried/test/load_test_files.rb
+- lib/fried/test/load_tests_path.rb
+- lib/fried/test/noop.rb
+- lib/fried/test/prepend_to_load_path.rb
+- lib/fried/test/telemetry.rb
+- lib/fried/test/version.rb
+homepage: https://github.com/Fire-Dragon-DoL/fried-test
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Minitest helpers and testing philosophy
+test_files: []