generative 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 02a4f62bfe5c5c3d05c10bc1196bb33abe6ee992
-  data.tar.gz: e692488353ac4202143d4ac3ec18597a72c5f10b
+SHA256:
+  metadata.gz: 3dc4a220c7ed12097f5fa3fad6118130d716c7836146303ea35a33566fd44313
+  data.tar.gz: 05bc94db4ae4340694a1acbd7d6ffd9f83f352bf36a9fd9571836d6fff00464f
 SHA512:
-  metadata.gz: 9840d498e882fec2575c43153a6c618988b2b8931923d7645c59d46ee0b82fa37e3b1797d6e5353fb5e272d9c6e5d173d478afc15981fba0d6c832e4ca0ef8a6
-  data.tar.gz: 4876dafd32294af5d8d74324263e84a6e840467667d7ead681dff0c68b179ace66fd585ebf5060b5a923f4eb7d704a952d59e2f41aee441f3f610def7fec49d5
+  metadata.gz: a49da806f77ba8a38e40b72a146429cc7e4dc63260de5a201aadded4a484b41db7ec7a3239f30202597172943de3b3fc3c28da62ba4c1b15d3649e843798e5d0
+  data.tar.gz: 6803173dd0267d2a00291e47904524872bc2e8f9945f757498122bf64fddb1cf78c02ecd3d7bd50f55bd47d11d87692e867cbd062d6d919a9cb505e6a74a43ae

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.0", "2.7", "2.6", "2.5", "ruby-head"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rake ci

data/CHANGELOG.md

@@ -1,14 +1,32 @@
 # Changelog
 
-## 0.2.0
+## 0.2.5 (2022-01-25)
+
+https://github.com/justincampbell/generative/compare/v0.2.4...v0.2.5
+
+- Fix: require forwardable ([#30](https://github.com/justincampbell/generative/pull/30))
+
+## 0.2.4 (2016-09-15)
+
+https://github.com/justincampbell/generative/compare/v0.2.4...v0.2.4
+
+## 0.2.3 (2014-12-16)
+
+https://github.com/justincampbell/generative/compare/v0.2.2...v0.2.3
+
+## 0.2.2 (2014-12-08)
+
+https://github.com/justincampbell/generative/compare/v0.2.0...v0.2.2
+
+## 0.2.0 (2014-08-13)
 
 * Drop support for RSpec 2
 * Update RSpec integration to support RSpec 3 final (@jessitron)
 
-## 0.1.0
+## 0.1.0 (2013-12-18)
 
 * Add support for RSpec 2
 
-## 0.0.1
+## 0.0.1 (2013-11-21)
 
 * Initial release

data/README.md

@@ -1,9 +1,9 @@
 # Generative
 
-> Generative testing for RSpec
-> [![Gem Version](https://badge.fury.io/rb/generative.png)](http://badge.fury.io/rb/generative)
-> [![Build Status](https://travis-ci.org/justincampbell/generative.png?branch=master)](https://travis-ci.org/justincampbell/generative)
-> [![Code Climate](https://codeclimate.com/github/justincampbell/generative.png)](https://codeclimate.com/github/justincampbell/generative)
+> Generative and property-based testing for RSpec
+> [![Gem Version](https://badge.fury.io/rb/generative.svg)](http://badge.fury.io/rb/generative)
+> [![CI](https://github.com/justincampbell/generative/actions/workflows/ci.yml/badge.svg)](https://github.com/justincampbell/generative/actions/workflows/ci.yml)
+> [![Code Climate](https://codeclimate.com/github/justincampbell/generative.svg)](https://codeclimate.com/github/justincampbell/generative)
 
 ## Installation
 
@@ -22,7 +22,7 @@ end
 
 ```
 --color
---format progress
+--format Generative::Formatter
 --require generative
 ```
 
@@ -48,7 +48,7 @@ would a `let`. Then, write your `it`/`specify` blocks as usual (while keeping
 in mind that the input could be anything).
 
 ```rb
-describe String do
+RSpec.describe String do
   let(:string) { "abc" }
 
   describe "#reverse" do
@@ -71,6 +71,22 @@ describe String do
 end
 ```
 
+Alternatively, you can modify existing specs in a minimally intrusive way by just adding two tags to an existing context and using the fact that `data` is just an alias for `let`:
+```ruby
+RSpec.describe String do
+  describe "#reverse", generative: true, order: :generative do
+    let(:string) { rand(12345).to_s }
+
+    it "maintains length" do
+      expect(string.reverse.length).to eq(string.length)
+    end
+
+    it "is not destructive" do
+      expect(string.reverse.reverse).to eq(string)
+    end
+  end
+end
+```
 ### Running
 
 Generative comes with a `generative` command, which simply runs rspec with the
@@ -79,7 +95,7 @@ required arguments:
 ```
 $ generative
 + GENERATIVE_COUNT=10_000
-+ rspec --require generative --format Generative --tag generative
++ rspec --require generative --format Generative::Formatter --tag generative
 Run options: include {:generative=>true}
 
 String
@@ -110,3 +126,88 @@ Given the examples above, running `rspec` will use the default "progress"
 formatter. Requiring generative will modify this formatter to output blue dots
 instead of green for generative tests. Generative also includes it's own
 formatter, which will only display generative test names once, also in blue.
+
+### Generators
+
+Generative allows you to register your own custom generators for generative
+tests. Registering a generator requires two thing, a name and an object that
+responds to `#call`.
+
+Whether you just want to use lambdas.
+
+```rb
+Generative.register_generator(:full_name) { "#{Generative.generate(:string)} #{Generative.generate(:string}" }
+
+Generative.register_generator(:user) { FactoryGirl.build(:user, id: Generative.generate(:integer)) }
+```
+
+A class or module that responds to `#call`.
+
+```rb
+class LameGenerator
+  def self.call
+    random_string
+  end
+end
+
+Generative.register_generator(:lame, LameGenerator)
+```
+
+Or you want to use a fancy library.
+
+```rb
+FakeTypeMappingLibrary
+  generator_for Bar do
+    initializer Float, Fixnum
+
+    accessor :baz, Float
+    accessor :quz, NotherClass
+  end
+end
+
+Generative.register_generator(:bar, Bar }
+```
+
+You can then use your generators using the `generate` helper.
+
+```rb
+RSpec.describe String do
+  let(:string) { "abc" }
+
+  describe "#reverse" do
+    generative do
+      data(:string) { generate(:my_fancy_string) }
+
+      it "maintains length" do
+        expect(string.reverse.length).to eq(string.length)
+      end
+    end
+  end
+end
+```
+
+#### I heard you like generators so I put some generators in your generators...
+
+If you want to use other generators in your registered generator, do note
+you have to use Generative's module level method `.generate` like so...
+
+```rb
+Generative.register_generator :user do
+  User.new( first_name: Generative.generate(:string, max: 100) )
+end
+```
+
+
+
+### Pre-made Generators
+
+**Note**: At this time Generative provides no pre-made generators. We
+encourage you to go out and seek good ways of generating
+data and maybe even package them up as your own gems. If you
+do, let us know and we'll link to it here.
+
+
+#### [Degenerate](https://github.com/niftyn8/degenerate)
+
+This library has a few generators for some basic primitives... A great start if
+you're looking to move quickly.

data/Rakefile

@@ -13,10 +13,10 @@ task :acceptance do
   ENV.delete('GENERATIVE_COUNT')
 
   [
-    ['rspec', '13'],
-    ['rake spec', '13'],
-    ['rake generative', '30000'],
-    ['bin/generative', '30000']
+    ['rspec', '22'], # can we do this some other way
+    ['rake spec', '22'], # sucks to bump as we add tests...
+    ['rake generative', '40000'],
+    ['bin/generative', '40000']
   ].each do |command, expected_example_count|
     puts "Checking output of `#{command}`"
     output = %x{#{command}}

data/bin/generative

@@ -13,7 +13,7 @@ command = %w[
   --tag generative
 ].join(' ')
 
-command = "GENERATIVE_COUNT=#{ENV['GENERATIVE_COUNT']} #{command}"
+command = "export GENERATIVE_COUNT=#{ENV['GENERATIVE_COUNT']}; #{command}; unset GENERATIVE_COUNT"
 
 puts command
 system command

data/generative.gemspec

@@ -2,19 +2,24 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+authors = {
+  "Justin Campbell" => "justin@justincampbell.com",
+  "Dan McClory" => "danmcclory@gmail.com",
+  "Nate West" => "natescott.west@gmail.com"
+}
+
 Gem::Specification.new do |gem|
   gem.name          = 'generative'
-  gem.version       = '0.2.0'
-  gem.authors       = ["Justin Campbell",          "Dan McClory"]
-  gem.email         = ["justin@justincampbell.me", "danmcclory@gmail.com"]
-  gem.description   = "Generative testing for RSpec"
-  gem.summary       = "Generative testing for RSpec"
+  gem.version       = '0.2.5'
+  gem.authors       = authors.keys
+  gem.email         = authors.values
+  gem.description   = "Generative and property-based testing for RSpec"
+  gem.summary       = "Generative and property-based testing for RSpec"
   gem.homepage      = "https://github.com/justincampbell/generative"
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |file| File.basename file }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
   gem.add_dependency 'rspec', '>= 3.0'

data/lib/generative/dsl.rb

@@ -4,5 +4,10 @@ class RSpec::Core::ExampleGroup
 
   class << self
     alias_method :data, :let
+    alias_method :for_every, :let
+  end
+
+  def generate(generator_name, *args)
+    Generative.generate(generator_name, *args)
   end
 end

data/lib/generative/formatters.rb

@@ -37,7 +37,8 @@ module Generative
       output.puts if @group_level == 0
 
       if generative?(example_group)
-        output.puts "#{current_indentation}#{detail_color('generative')}"
+        group_description = "#{example_group.description} (generative)"
+        output.puts "#{current_indentation}#{detail_color(group_description)}"
 
         @group_level += 1
         example_group.examples.each do |example|
@@ -72,7 +73,7 @@ module Generative
       example = notification.example
 
       if generative?(example)
-        RSpec.wants_to_quit = true
+        RSpec.world.wants_to_quit = true
       end
 
       super

data/lib/generative/generator_manager.rb

@@ -0,0 +1,30 @@
+module Generative
+  class InvalidGenerator < StandardError; end
+  class UnregisteredGenerator < StandardError; end
+
+  class GeneratorManager
+
+    attr_reader :generators
+
+    def initialize(preregistered_generators={})
+      @generators = Hash.new(preregistered_generators)
+    end
+
+    def register_generator(name, factory=nil, &generator)
+      registerable = block_given? ? generator : factory
+      msg = "#{registerable} must respond to :call"
+      raise InvalidGenerator, msg unless generator_valid?(registerable)
+      @generators.merge!(name => registerable)
+    end
+
+    def find_and_call(name, *args)
+      generators.fetch(name) do
+        raise UnregisteredGenerator, "#{name} generator not registered"
+      end.call(*args)
+    end
+
+    def generator_valid?(generator)
+      generator.respond_to?(:call)
+    end
+  end
+end

data/lib/generative/rake_task.rb

@@ -8,7 +8,7 @@ module Generative
 
       self.name = :generative if name == :spec
 
-      desc "Run Generative specs" unless Rake.application.last_comment
+      desc "Run Generative specs" unless Rake.application.last_description
 
       options = %w[
         --require generative

data/lib/generative.rb

@@ -1,8 +1,29 @@
 require 'rspec/core'
+require 'forwardable'
 
 module Generative
+
   DEFAULT_COUNT = '10_000'
 
+  class << self
+    extend Forwardable
+    def_delegators :manager, :register_generator, :find_and_call
+  end
+
+  def self.generate(generator_name, *args)
+    find_and_call(generator_name, *args)
+  end
+
+  def self.manager
+    @manager ||= GeneratorManager.new(preregistered_generators)
+  end
+
+  def self.preregistered_generators
+    {
+        # nothing to see here yet
+    }
+  end
+
   def self.running?
     !!ENV['GENERATIVE_COUNT']
   end
@@ -11,3 +32,4 @@ end
 require 'generative/dsl'
 require 'generative/formatters'
 require 'generative/ordering'
+require 'generative/generator_manager'

data/spec/generative/generator_manager_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe Generative::GeneratorManager do
+
+  subject { Generative::GeneratorManager.new }
+
+  describe "#register_generator_generator" do
+    it "throws an exception if a block or a factory object isn't given" do
+      expect { subject.register_generator(:test) }.to raise_error(Generative::InvalidGenerator)
+    end
+
+    it "registers a new generator when given a generator block" do
+      name, generator = :test, lambda { "hi" }
+      expect(subject.generators).not_to include(name)
+      expect(subject.register_generator(name) { "hi" }).to include(name)
+      expect(subject.generators[name].call).to eq("hi")
+    end
+
+    it "registers a new generator when given a factory object" do
+      name, factory = :test, OpenStruct.new(call: true)
+      expect(subject.generators).not_to include(name)
+      expect(subject.register_generator(name, factory)).to include(name)
+      expect(subject.generators[name].call).to be_truthy
+    end
+  end
+
+  describe "#find_and_call" do
+    it "calls a specific generator passing in it's arguments" do
+      name, generator = :test, lambda { |arg| arg }
+      subject.register_generator(name, &generator)
+      expect(subject.find_and_call(name, "hi")).to eq("hi")
+    end
+
+    it "raises an error fo ran unregistered generator" do
+      expect { subject.find_and_call(:nope) }
+        .to raise_error(Generative::UnregisteredGenerator)
+    end
+
+    describe "#generator_valid?" do
+      it "returns false if an object doesn't respond to :call or :build" do
+        expect(subject.generator_valid?(nil)).to be_falsey
+      end
+
+      it "returns true if an object doesn't respond to :call" do
+        generator = OpenStruct.new(call: true)
+        expect(subject.generator_valid?(generator)).to be_truthy
+      end
+    end
+  end
+end

data/spec/generative/ordering_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Generative::ORDERING do
+RSpec.describe Generative::ORDERING do
   let(:ordering) { Generative::ORDERING }
 
   around do |example|

data/spec/generative/rake_task_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'generative/rake_task'
 
-describe Generative::RakeTask do
+RSpec.describe Generative::RakeTask do
   let(:task) { Generative::RakeTask.new(*args) }
   let(:args) { [] }
 

data/spec/generative_spec.rb

@@ -1,6 +1,8 @@
 require 'generative'
 
-describe String do
+Generative.register_generator(:string) { "a" * rand(255) }
+
+RSpec.describe String do
   let(:string) { "abc" }
 
   describe "#length" do
@@ -17,6 +19,16 @@ describe String do
         expect(string.length).to be >= 0
       end
     end
+
+    xit "uses registered generators"
+
+    generative do
+      data(:string) { generate(:string) }
+
+      it "is never negative" do
+        expect(string.length).to be >= 0
+      end
+    end
   end
 
   describe "#reverse" do

data/spec/spec_helper.rb

@@ -20,4 +20,5 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   #config.order = 'random'
+  config.disable_monkey_patching!
 end

metadata

@@ -1,56 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: generative
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Justin Campbell
 - Dan McClory
-autorequire: 
+- Nate West
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.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'
-description: Generative testing for RSpec
+description: Generative and property-based testing for RSpec
 email:
-- justin@justincampbell.me
+- justin@justincampbell.com
 - danmcclory@gmail.com
+- natescott.west@gmail.com
 executables:
 - generative
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -61,9 +63,11 @@ files:
 - lib/generative.rb
 - lib/generative/dsl.rb
 - lib/generative/formatters.rb
+- lib/generative/generator_manager.rb
 - lib/generative/ordering.rb
 - lib/generative/rake_task.rb
 - lib/generative/version.rb
+- spec/generative/generator_manager_spec.rb
 - spec/generative/ordering_spec.rb
 - spec/generative/rake_task_spec.rb
 - spec/generative_spec.rb
@@ -72,29 +76,23 @@ homepage: https://github.com/justincampbell/generative
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+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.0.14
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
-summary: Generative testing for RSpec
-test_files:
-- spec/generative/ordering_spec.rb
-- spec/generative/rake_task_spec.rb
-- spec/generative_spec.rb
-- spec/spec_helper.rb
-has_rdoc: 
+summary: Generative and property-based testing for RSpec
+test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1
-  - ruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-script:
-  - rake ci