rails_mocks 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18844b035c16dde338319e066450327234660c9eb12d3a9c202e3e6f1bf601d4
-  data.tar.gz: 2a6493246d7d5f8e52d3f73def90060b8391a8423823aba45868da110bb2d77f
+  metadata.gz: a4371d59c15e78aa06d592cb0819115f29e771f2e3b726b76c954aea6d0d5c05
+  data.tar.gz: 8b297f71b3e94062a713a105b8a383ae0f3728d3b33383d17529f6b9e001a286
 SHA512:
-  metadata.gz: 287bbcdcf0f8d507644c53c34f89e8e290b6fabc8478f6b6e7c3cfe973c804029e6d4cd0d647033ad06ffa52cfe522cb47b0523bfc02e17152cc494ce40d63cd
-  data.tar.gz: f1aa861a3d1c78e21923a7f3491ed53689f37d9cb5aeaa060f8bd5ee0ab2a744e93097c6e6f2a1f466427c92d27e39d733dbed207edd9cc0a8a1aa376cb5c6e2
+  metadata.gz: 32ebe5518215d2dd4e516162ebafc9b2dc1865910eee37f93e8f64918e85d0c0571536e7af995dd7cb939d6a8793802ed8ae6b763d647a52128468be467e0507
+  data.tar.gz: abe002326c17f96a8b7b3c0e281e7371ee44d067ecbfca3fcb6c10d5d06547fb0d0693dfa6d87016c10fc34c653499c85133b18a2c7da9ceffb4865c5266c7d5

data/README.md

@@ -1,3 +1,106 @@
 # Rails Mocks
 
 `Rails Mocks` Makes stubbing in your Rails application from an external resource easier.
+
+The gem adds middleware to rails to execute [stubs](https://github.com/rspec/rspec-mocks/blob/main/README.md#method-stubs)
+before make any query. It based on [rspec-mocks](https://github.com/rspec/rspec-mocks/blob/main/README.md) library.
+
+## Install
+```ruby
+group :test do
+  gem "rails_mocks", "~> 0.0.1"
+end
+```
+
+## Available functionality
+
+What we can execute before make request on the rails side:
+```ruby
+# Instead of User we can use any rails constant
+# It can be name of service, model, controller, etc
+allow(User).to receive(:name)
+allow(Book).to receive(:title).and_return("The Book")
+allow(OrderService).to receive(:new).with(sum: 543).and_return(double(total: 543, id: 1))
+allow(SumService).to receive(:new).with(double(a: 1, b: 5, c: 4)).and_return(double(sum: 10))
+```
+
+## Usage
+
+To stub something from external resource we should set header `RAILS_MOCKS` in the http request with the syntax below.
+
+```javascript
+req.headers["RAILS_MOCKS"] = JSON.stringify([
+    {
+        allow: "User",
+        receive: "name"
+    },
+    
+    {
+        allow: "Book",
+        receive: "title",
+        and_return: { body: "The Book" }
+    },
+    
+    {
+        allow: "OrderService",
+        receive: "new",
+        with: { body: { sum: 543 } },
+        and_return: { body: { total: 543, id: 1 }, double: true }
+    },
+    
+    {
+        allow: "SumService",
+        receive: "new",
+        with: { body: { a: 1, b: 5, c: 4 }, double: true },
+        and_return: { body: { sum: 10 }, double: true }
+    }
+])
+```
+
+### Cypress
+
+Here the example how to stub Stripe from cypress:
+
+```javascript
+describe("when do refund", function() {
+    beforeEach(function () {
+        const chargeID = "frefef-43referf-43fref"
+        
+        cy.intercept("*", req => {
+            req.headers["RAILS_MOCKS"] = JSON.stringify([
+                {
+                    allow: "Stripe::Refund",
+                    receive: "create",
+                    with: { body: { charge: chargeID }},
+                    and_return: { body: { source: chargeID, status: "refunded" }, double: true}
+                }
+            ])
+        })
+    })
+
+    it("then we click on the button and make refund",function() {
+        
+    })
+})
+```
+
+We can use `cy.intercept` to modify headers of any request from the front-end application.
+But if we want to make stub when do `cy.request` we should set headers in the cy.request [source](https://docs.cypress.io/api/commands/intercept#Controlling-the-outgoing-request): 
+
+```javascript
+cy.request({
+    method: "POST",
+    headers: {
+      RAILS_MOCKS: JSON.stringify([
+        {
+          allow: "User",
+          receive: "create"
+        }
+      ])
+    },
+    url: "/users",
+    body: body
+  })
+```
+
+

data/lib/rails_mocks/header_data.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RailsMocks
+  class HeaderData
+    MOCKS_HEADER = "HTTP_RAILS_MOCKS"
+    CONTEXTS_HEADER = "HTTP_RAILS_CONTEXTS"
+
+    def initialize(req)
+      @mocks_data = req[MOCKS_HEADER]
+      @shared_contexts_data = req[CONTEXTS_HEADER]
+    end
+
+    def run_shared_contexts(scope)
+      parsed_shared_contexts.each do |shared_context|
+        shared_context.execute(scope)
+      end
+    end
+
+    def run_stubs(scope)
+      parsed_stubs.each do |stub|
+        stub.execute(scope)
+      end
+    end
+
+    def empty?
+      mocks_data.blank? && shared_contexts_data.blank?
+    end
+
+    private
+
+    attr_reader :mocks_data, :shared_contexts_data
+
+    def parsed_stubs
+      return [] if mocks_data.blank?
+      JSON.parse(mocks_data, symbolize_names: true).map do |stub|
+        RailsMocks::Stub.new(stub)
+      end
+    end
+
+    def parsed_shared_contexts
+      return [] if shared_contexts_data.blank?
+      JSON.parse(shared_contexts_data).map do |shared_context_name|
+        RailsMocks::SharedContext.new(shared_context_name)
+      end
+    end
+  end
+end

data/lib/rails_mocks/middleware.rb

@@ -2,36 +2,30 @@
 
 module RailsMocks
   class Middleware
-    HEADER_NAME = "HTTP_RAILS_MOCKS"
+    include RSpec::Core::Hooks
+
+    alias :let :define_singleton_method
+    def metadata; end
 
     def initialize(app)
       @app = app
     end
 
     def call(req)
-      return @app.call(req) if stubs(req).blank?
+      header_data = RailsMocks::HeaderData.new(req)
+      return @app.call(req) if header_data.empty?
 
       status, headers, response = nil
+
       RSpec::Mocks.with_temporary_scope do
         RSpec::Mocks::Syntax.enable_expect(self.class)
-        parsed_stubs(req).each do |stub|
-          allow(stub.allow).to(stub.receiver)
-        end
-        status, headers, response = @app.call(req)
-      end
-      [status, headers, response]
-    end
 
-    private
+        header_data.run_shared_contexts(self)
+        header_data.run_stubs(self)
 
-    def parsed_stubs(req)
-      JSON.parse(stubs(req), symbolize_names: true).map do |stub|
-        RailsMocks::Stub.new(stub)
+        status, headers, response = @app.call(req)
       end
-    end
-
-    def stubs(req)
-      req[HEADER_NAME]
+      [status, headers, response]
     end
   end
 end

data/lib/rails_mocks/rails.rb

@@ -4,12 +4,17 @@ module RailsMocks
   class Railtie < Rails::Railtie
     initializer "rails_mocks.configure_rails_initialization" do
       insert_middleware
+      load_shared_contexts
     end
 
     def insert_middleware
       app.middleware.use RailsMocks::Middleware
     end
 
+    def load_shared_contexts
+      Dir[Rails.root.join('spec/support/shared_contexts/**/*.rb')].each { |f| require f }
+    end
+
     def app
       Rails.application
     end

data/lib/rails_mocks/shared_context.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsMocks
+  class SharedContext
+
+    def initialize(context_name)
+      @context_name = context_name
+    end
+
+    def execute(scope)
+      scope.instance_exec(&context_definition)
+      scope.hooks.send(:run_owned_hooks_for, :before, :example, scope)
+    end
+
+    private
+
+    attr_reader :context_name
+
+    def context_definition
+     RSpec.world.shared_example_group_registry
+          .send(:shared_example_groups)[:main][context_name].definition
+    end
+  end
+end

data/lib/rails_mocks/stub.rb

@@ -8,6 +8,14 @@ module RailsMocks
       @stub = stub
     end
 
+    def execute(scope)
+      scope.allow(allow).to(receiver)
+    end
+
+    private
+
+    attr_reader :stub
+
     def allow
       stub[:allow].constantize
     end
@@ -19,10 +27,6 @@ module RailsMocks
       receiver
     end
 
-    private
-
-    attr_reader :stub
-
     def _receive
       stub[:receive]
     end

data/lib/rails_mocks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsMocks
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/rails_mocks.rb

@@ -1,3 +1,5 @@
+require 'rails_mocks/header_data'
 require 'rails_mocks/stub'
+require 'rails_mocks/shared_context'
 require 'rails_mocks/middleware'
 require 'rails_mocks/rails'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_mocks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Anton Kachan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-26 00:00:00.000000000 Z
+date: 2021-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.3.2
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.1
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -61,8 +75,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/rails_mocks.rb
+- lib/rails_mocks/header_data.rb
 - lib/rails_mocks/middleware.rb
 - lib/rails_mocks/rails.rb
+- lib/rails_mocks/shared_context.rb
 - lib/rails_mocks/stub.rb
 - lib/rails_mocks/version.rb
 homepage: https://github.com/anton-kachan/rails_mocks
@@ -87,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.23
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Makes stubbing in your Rails application from an external resource easier.