rspec_create_model 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 342535e338b1786e3675ed7b49f476c7dbf178705ed890c20e061c5e24488f7a
+  data.tar.gz: f21ca8a2e2a69cfbfaf0bf085504d2bc56554ec22ed9cef89840f71a1d230896
+SHA512:
+  metadata.gz: 1502395a4641429d3a5478d9e6c3a3e5bb5f3d3c1c53cbe7d289f61988564cf0b661162f0a3be97a02d21a5e1b41982d800750992194b8ff09d547985f0c5b17
+  data.tar.gz: 48816672e69dc0f92e662c45b18de7a77e77547e1631eb99a39618de5c3e61e3a47e83f6b3b800dd2a6aeb7642ef981fdbb59a8bbf62ac882b8a3825a1e4125e

data/.github/workflows/gem-push.yml

@@ -0,0 +1,44 @@
+name: Ruby Gem
+
+on:
+  push:
+    tags: [ '*' ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    environment: production
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 3.0
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 3.0.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,18 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.7, '3.0', 3.1, head, truffleruby, truffleruby-head]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rspec

data/.gitignore

@@ -0,0 +1 @@
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec_match_structure.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"
+
+gem "simplecov"
+
+gem "activerecord", "~> 7.0", ">= 7.0.3"
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    rspec_create_model (0.0.1)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.0)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 7.0, >= 7.0.3)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec_create_model!
+  rubocop (~> 1.7)
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   2.2.15

data/README.md

@@ -0,0 +1,57 @@
+![Tests](https://github.com/monade/rspec_create_model/actions/workflows/test.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/rspec_create_model.svg)](https://badge.fury.io/rb/rspec_create_model)
+
+# rspec_create_model
+
+A rspec matcher for Rail's ActiveRecord, to check the type of models created from actions.
+
+## Installation
+
+Add the gem to your Gemfile
+
+```ruby
+  gem 'rspec_create_model', github: 'monade/rspec_create_model'
+```
+
+## Example usage
+
+Given the following records:
+
+```ruby
+class Author < ActiveRecord::Base
+  attribute :name, type: :String
+  has_many :articles, dependent: :destroy
+
+  after_create :create_empty_book
+
+  def create_empty_book
+    Book.create!(author_id: id, title: "First Empty Book")
+  end
+end
+
+class Book < ActiveRecord::Base
+  belongs_to :author, optional: false
+  attribute :title, type: :String
+end
+```
+
+You can match created records like this:
+
+```ruby
+expect { Author.create!(name: "Some author name") }.to create_model(Author)
+
+expect { Author.create!(name: "Some author name") }
+  .to create_model(Author)
+  .and create_model(Book)
+```
+
+When the matcher is called, 2 instace variable get set: **@created_record** and **@created_records**
+
+these variables includes the newly created records. You can also use them if you want, like this:
+
+```ruby
+expect { Author.create!(name: "Some author name") }.to create_model(Author)
+
+expect(@created_record).to be_a(Author)
+expect(@created_records).to all(be_a(Author))
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rspec_create_model/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RspecCreateModel
+  VERSION = '0.0.1'
+end

data/lib/rspec_create_model.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :create_model do |model_class|
+  match(notify_expectation_failures: true) do |block|
+    previous_elements = model_class.all.to_a
+    block.call
+    new_elements = model_class.all.to_a
+    created_elements = new_elements - previous_elements
+    if created_elements.any?
+      block.binding.receiver.instance_variable_set(:@created_record, created_elements.first)
+      block.binding.receiver.instance_variable_set(:@created_records, created_elements)
+      true
+    else
+      false
+    end
+  end
+
+  supports_block_expectations
+
+  failure_message do |_|
+    "Expected { } to create a new #{model_class}, but it didn't."
+  end
+
+  failure_message_when_negated do |_|
+    "Expected { } not to create a new #{model_class}, but it did."
+  end
+end

data/rspec_create_model.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+
+require_relative "lib/rspec_create_model/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_create_model"
+  spec.version       = RspecCreateModel::VERSION
+  spec.authors       = ["Mònade"]
+  spec.email         = ["hello@monade.io"]
+
+  spec.summary       = "An RSpec matcher to match the structure of a given created model."
+  spec.description   = "An RSpec matcher to match the structure of a given created model."
+  spec.homepage      = "https://github.com/monade/rspec_create_model"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/monade/rspec_create_model/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rspec_create_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mònade
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: An RSpec matcher to match the structure of a given created model.
+email:
+- hello@monade.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rspec_create_model.rb
+- lib/rspec_create_model/version.rb
+- rspec_create_model.gemspec
+homepage: https://github.com/monade/rspec_create_model
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/monade/rspec_create_model
+  source_code_uri: https://github.com/monade/rspec_create_model
+  changelog_uri: https://github.com/monade/rspec_create_model/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: An RSpec matcher to match the structure of a given created model.
+test_files: []