fixturama 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8373fb84e1acca73b060d54aab09588b6f196aa9420a6378361a9f5e011c2e71
+  data.tar.gz: 286b6cf22fecdebe1f7fec48c30bbcc49879683726c1ad3da1282e9b2eb6cd66
+SHA512:
+  metadata.gz: 705ddbd4b4c6458d3fe7338748a9dcbb1166ca8dbedbb01a9c21e37036c5a71df70963af5e3d6ba6ae50baaf04435b23e69570c7360e9577175038ec238a7a41
+  data.tar.gz: 26cbcea20fd78fe35d78edf6161f66f048d6b406e1246c55d88432e0149d11cde13c2d2577b6735f3e74dda21764cee73e077df3063765312b1de0bc22422599

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,43 @@
+---
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.3
+
+Metrics/LineLength:
+  AllowHeredoc: true
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+  
+Layout/SpaceInLambdaLiteral:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false # by intention
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,20 @@
+---
+sudo:     false
+language: ruby
+cache:    bundler
+before_install:
+  - gem install bundler --no-document
+  - gem update --system
+script:
+  - bundle exec rspec
+  - bundle exec rubocop
+rvm:
+  - 2.3.0
+  - 2.6.0
+  - ruby-head
+  - jruby-9.1.0.0
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.0.1] - [2018-03-01]
+
+This is a first public release with features extracted from production app.
+
+[0.0.1]: https://github.com/nepalez/fixturama/releases/tag/v0.0.1

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sms_aero.gemspec
+gemspec
+
+group :development, :test do
+  gem "pry",        platform: :mri
+  gem "pry-byebug", platform: :mri
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrew Kozin (aka nepalez)
+
+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,140 @@
+# Fixturama
+
+Collection of helpers for dealing with fixtures in RSpec
+
+<a href="https://evilmartians.com/">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
+
+[![Gem Version](https://badge.fury.io/rb/fixturama.svg)][gem]
+[![Build Status](https://travis-ci.org/nepalez/fixturama.svg?branch=master)][travis]
+
+## Installation
+
+```ruby
+gem "fixturama"
+```
+
+## Usage
+
+```ruby
+# spec/spec_helper.rb
+require "fixturama/rspec"
+```
+
+The gem defines 3 helpers (support ERB bindings):
+
+- `load_fixture(path, **opts)` to load data from a fixture, and deserialize YAML and JSON
+- `seed_fixture(path_to_yaml, **opts)` to prepare database
+- `stub_fixture(path_to_yaml, **opts)` to stub some classes
+
+```ruby
+# spec/models/user/_spec.rb
+RSpec.describe "GraphQL mutation 'deleteProfile'" do
+  subject { Schema.execute(mutation).to_h }
+
+  before do
+    seed_fixture("#{__dir__}/database.yml", profile_id: 42)
+    stub_fixture("#{__dir__}/stubs.yml",    profile_id: 42)
+  end
+
+  let(:mutation) { load_fixture "#{__dir__}/mutation.graphql", profile_id: 42 }
+  let(:result)   { load_fixture "#{__dir__}/result.yaml" }
+
+  it { is_expected.to eq result }
+
+  it "deletes the profile" do
+    expect { subject }.to change { Profile.find_by(id: 42) }.to nil
+  end
+
+  it "sends a notification" do
+    expect(Notifier)
+      .to receive_message_chain(:create)
+      .with("profileDeleted", 42)
+
+    subject
+  end
+end
+```
+
+The seed (`seed_fixture`) file should be a YAML/JSON with opinionated parameters, namely:
+
+- `type` for the name of the [FactoryBot][factory_bot] factory
+- `traits` for the factory traits
+- `params` for parameters of the factory
+
+```yaml
+# ./database.yml
+#
+# This is the same as
+# `create :profile, :active, id: profile_id`
+---
+- type: profile
+  traits:
+    - active
+  params:
+    id: <%= profile_id %>
+```
+
+Another opinionated format we use for stubs (`stub_fixture`):
+
+- `class` for stubbed class
+- `chain` for messages chain
+- `actions` for an array of actions for consecutive invocations of the chain
+
+Every action either `return` some value, or `raise` some exception
+
+```yaml
+# ./stubs.yml
+#
+# The first invocation acts like
+# allow(Events).to receive_message_chain(:create).and_return true
+#
+# Afterwards it will act like
+# allow(Events).to receive_message_chain(:create).and_raise AlreadyRegisteredError
+---
+- class: Events
+  chain:
+    - create
+  actions:
+    - return: true
+    - raise: AlreadyRegisteredError
+```
+
+```graphql
+mutation {
+  deleteProfile(
+    input: {
+      id: "<%= profile_id %>"
+    }
+  ) {
+    success
+    errors {
+      message
+      fields
+    }
+  }
+}
+```
+
+```yaml
+# ./result.yaml
+---
+data:
+  deleteProfile:
+    success: true
+    errors: []
+```
+
+With these helpers all the concrete settings can be extracted to fixtures.
+
+I find it especially helpful when I need to check different edge cases. Instead of polluting a specification with various parameters, I create the sub-folder with "input" and "output" fixtures for every case.
+
+Looking at the spec I can easily figure out the "structure" of expectation, while looking at fixtures I can check the concrete corner cases.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License][license].
+
+[gem]: https://rubygems.org/gems/fixturama
+[travis]: https://travis-ci.org/nepalez/fixturama
+[license]: http://opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/fixturama.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name     = "fixturama"
+  gem.version  = "0.0.1"
+  gem.author   = "Andrew Kozin (nepalez)"
+  gem.email    = "andrew.kozin@gmail.com"
+  gem.homepage = "https://github.com/nepalez/fixturama"
+  gem.summary  = "A set of helpers to prettify specs with fixtures"
+  gem.license  = "MIT"
+
+  gem.files            = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files       = gem.files.grep(/^spec/)
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE", "CHANGELOG.md"]
+
+  gem.required_ruby_version = ">= 2.2"
+
+  gem.add_runtime_dependency "factory_bot", "~> 4.0"
+  gem.add_runtime_dependency "rspec", "~> 3.0"
+  gem.add_runtime_dependency "hashie", "~> 3.6"
+
+  gem.add_development_dependency "rake", "~> 10"
+  gem.add_development_dependency "rspec-its", "~> 1.2"
+  gem.add_development_dependency "rubocop", "~> 0.49"
+end

data/lib/fixturama/rspec.rb

@@ -0,0 +1,4 @@
+require "fixturama"
+require "rspec"
+
+RSpec.configure { |config| config.include Fixturama }

data/lib/fixturama/seed.rb

@@ -0,0 +1,14 @@
+module Fixturama
+  module Seed
+    module_function
+
+    def call(opts)
+      opts   = Utils.symbolize_hash(opts)
+      type   = opts[:type].to_sym
+      traits = Utils.symbolize_array opts[:traits]
+      params = Utils.symbolize_hash  opts[:params]
+
+      FactoryBot.create(type, *traits, **params)
+    end
+  end
+end

data/lib/fixturama/stubs/actions.rb

@@ -0,0 +1,27 @@
+module Fixturama
+  class Stubs
+    class Actions
+      def add(opts)
+        queue.push build(opts)
+        self
+      end
+
+      def call_next
+        queue.pop.tap { |item| queue.push(item.dup) if queue.empty? }.call
+      end
+
+      private
+
+      def build(opts)
+        opts = Utils.symbolize_hash(opts)
+        return Raise.new opts[:raise] if opts.key?(:raise)
+
+        Return.new opts[:return]
+      end
+
+      def queue
+        @queue ||= Queue.new
+      end
+    end
+  end
+end

data/lib/fixturama/stubs/raise.rb

@@ -0,0 +1,15 @@
+module Fixturama
+  class Stubs
+    class Raise
+      def call
+        raise @exception
+      end
+
+      private
+
+      def initialize(exception)
+        @exception = Utils.constantize(exception || StandardError)
+      end
+    end
+  end
+end

data/lib/fixturama/stubs/return.rb

@@ -0,0 +1,13 @@
+module Fixturama
+  class Stubs
+    class Return
+      attr_reader :call
+
+      private
+
+      def initialize(output)
+        @call = Utils.clone(output)
+      end
+    end
+  end
+end

data/lib/fixturama/stubs.rb

@@ -0,0 +1,37 @@
+module Fixturama
+  class Stubs
+    require_relative "stubs/actions"
+    require_relative "stubs/raise"
+    require_relative "stubs/return"
+
+    def add(options)
+      options = Utils.symbolize_hash(options)
+      klass, chain, actions = options.values_at(:class, :chain, :actions)
+
+      klass = Utils.constantize(klass)
+      chain = Utils.symbolize_array(chain)
+      actions ||= { return: nil }
+
+      Array(actions).each do |action|
+        collection[[klass, chain]] ||= Actions.new
+        collection[[klass, chain]].add action
+      end
+
+      self
+    end
+
+    def apply(example)
+      collection.each do |(klass, chain), actions|
+        example.send(:allow, klass).to example.receive_message_chain(chain) do
+          actions.call_next
+        end
+      end
+    end
+
+    private
+
+    def collection
+      @collection ||= {}
+    end
+  end
+end

data/lib/fixturama/utils.rb

@@ -0,0 +1,21 @@
+module Fixturama
+  module Utils
+    module_function
+
+    def symbolize_hash(data)
+      Hash(data).transform_keys { |key| key.to_s.to_sym }
+    end
+
+    def symbolize_array(data)
+      Array(data).map { |item| item.to_s.to_sym }
+    end
+
+    def constantize(item)
+      item.to_s.constantize
+    end
+
+    def clone(item)
+      item.respond_to?(:dup) ? item.dup : item
+    end
+  end
+end

data/lib/fixturama.rb

@@ -0,0 +1,47 @@
+require "erb"
+require "factory_bot"
+require "hashie/mash"
+require "json"
+require "rspec"
+require "yaml"
+
+module Fixturama
+  require_relative "fixturama/utils"
+  require_relative "fixturama/stubs"
+  require_relative "fixturama/seed"
+
+  def stub_fixture(path, **opts)
+    items = load_fixture(path, **opts)
+    raise "The fixture should contain an array" unless items.is_a?(Array)
+
+    items.each { |item| fixturama_stubs.add(item) }
+    fixturama_stubs.apply(self)
+  end
+
+  def seed_fixture(path, **opts)
+    Array(load_fixture(path, **opts)).each { |item| Seed.call(item) }
+  end
+
+  def load_fixture(path, **opts)
+    extname = Pathname.new(path).extname
+
+    read_fixture(path, **opts).tap do |content|
+      return YAML.load(content)  if %w[.yaml .yml].include?(extname)
+      return JSON.parse(content) if extname == ".json"
+    end
+  end
+
+  def read_fixture(path, **opts)
+    content  = File.read(path)
+    hashie   = Hashie::Mash.new(opts)
+    bindings = hashie.instance_eval { binding }
+
+    ERB.new(content).result(bindings)
+  end
+
+  private
+
+  def fixturama_stubs
+    @fixturama_stubs ||= Stubs.new
+  end
+end

data/spec/fixturama/load_fixture/_spec.rb

@@ -0,0 +1,21 @@
+RSpec.describe "load_fixture" do
+  let(:expected) { { "foo" => { "bar" => 42 } } }
+
+  context "YAML" do
+    subject { load_fixture("#{__dir__}/data.yaml", id: 42) }
+
+    it { is_expected.to eq expected }
+  end
+
+  context "YML" do
+    subject { load_fixture("#{__dir__}/data.yml", id: 42) }
+
+    it { is_expected.to eq expected }
+  end
+
+  context "JSON" do
+    subject { load_fixture("#{__dir__}/data.json", id: 42) }
+
+    it { is_expected.to eq expected }
+  end
+end

data/spec/fixturama/load_fixture/data.json

@@ -0,0 +1,5 @@
+{
+  "foo": {
+    "bar": <%= id %>
+  }
+}

data/spec/fixturama/load_fixture/data.yaml

@@ -0,0 +1,3 @@
+---
+foo:
+  bar: <%= id %>

data/spec/fixturama/load_fixture/data.yml

@@ -0,0 +1,3 @@
+---
+foo:
+  bar: <%= id %>

data/spec/fixturama/seed_fixture/_spec.rb

@@ -0,0 +1,32 @@
+RSpec.describe "seed_fixture" do
+  subject { seed_fixture "#{__dir__}/seed.yml" }
+
+  before do
+    FactoryBot.define do
+      factory :foo, class: Hash do
+        transient do
+          bar { 0 }
+          baz { 0 }
+          qux { 0 }
+        end
+
+        trait :bar do
+          bar { 99 }
+        end
+
+        trait :baz do
+          baz { 77 }
+        end
+
+        skip_create
+        initialize_with { { bar: bar, baz: baz, qux: qux } }
+      end
+    end
+  end
+
+  it "runs the factory", aggregate_failures: true do
+    expect(FactoryBot).to receive(:create).and_return(bar: 99, baz: 77, qux: 42)
+
+    subject
+  end
+end

data/spec/fixturama/seed_fixture/seed.yml

@@ -0,0 +1,7 @@
+---
+- type: foo
+  traits:
+    - bar
+    - baz
+  params:
+    qux: 42

data/spec/fixturama/stub_fixture/_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe "stub_fixture" do
+  subject { Foo.new.bar }
+
+  before do
+    class Foo
+      def bar
+        "bar"
+      end
+    end
+  end
+
+  context "without stubbing" do
+    it { is_expected.to eq "bar" }
+  end
+
+  context "with first invocation" do
+    before { stub_fixture "#{__dir__}/stub.yml" }
+
+    it { is_expected.to eq "baz" }
+  end
+
+  context "with next_day invocation" do
+    before do
+      stub_fixture "#{__dir__}/stub.yml"
+      Foo.new.bar
+    end
+
+    it "raises an exception" do
+      expect { subject }.to raise_error StandardError
+    end
+  end
+
+  context "with later invocations" do
+    before do
+      stub_fixture "#{__dir__}/stub.yml"
+      3.times do begin
+                  Foo.new.bar
+                rescue
+                  nil
+                end end
+    end
+
+    it "raises an exception" do
+      expect { subject }.to raise_error StandardError
+    end
+  end
+end

data/spec/fixturama/stub_fixture/stub.yml

@@ -0,0 +1,8 @@
+---
+- class: Foo
+  chain:
+    - new
+    - bar
+  actions:
+    - return: baz
+    - raise: StandardError

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+begin
+  require "pry"
+rescue LoadError
+  nil
+end
+
+require "bundler/setup"
+require "fixturama/rspec"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: fixturama
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kozin (nepalez)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: 
+email: andrew.kozin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fixturama.gemspec
+- lib/fixturama.rb
+- lib/fixturama/rspec.rb
+- lib/fixturama/seed.rb
+- lib/fixturama/stubs.rb
+- lib/fixturama/stubs/actions.rb
+- lib/fixturama/stubs/raise.rb
+- lib/fixturama/stubs/return.rb
+- lib/fixturama/utils.rb
+- spec/fixturama/load_fixture/_spec.rb
+- spec/fixturama/load_fixture/data.json
+- spec/fixturama/load_fixture/data.yaml
+- spec/fixturama/load_fixture/data.yml
+- spec/fixturama/seed_fixture/_spec.rb
+- spec/fixturama/seed_fixture/seed.yml
+- spec/fixturama/stub_fixture/_spec.rb
+- spec/fixturama/stub_fixture/stub.yml
+- spec/spec_helper.rb
+homepage: https://github.com/nepalez/fixturama
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A set of helpers to prettify specs with fixtures
+test_files:
+- spec/fixturama/load_fixture/_spec.rb
+- spec/fixturama/load_fixture/data.json
+- spec/fixturama/load_fixture/data.yaml
+- spec/fixturama/load_fixture/data.yml
+- spec/fixturama/seed_fixture/_spec.rb
+- spec/fixturama/seed_fixture/seed.yml
+- spec/fixturama/stub_fixture/_spec.rb
+- spec/fixturama/stub_fixture/stub.yml
+- spec/spec_helper.rb