rspec_request_helpers 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69e19b4a72e694e48266c3fd82963bdc49d29e1047afa3f9e8e58a20eb66ecca
-  data.tar.gz: 2c90b13de3ae5897644d4291639152ef439a808046f5b7119354939af37735b5
+  metadata.gz: 6123bd35683c01320a81b8b564d8dd518298489c2063be3ea2b83460cde16153
+  data.tar.gz: 595d6b0cede37d70e8e0a6fabc2efae031c1cb33d2a737ed7bc49391a76ab5c3
 SHA512:
-  metadata.gz: 9c049a3267279fdd1b30f3356e3568615dd0f528d1ce546d32040c7246b49d37c26f625949644038451a21073f3fbcfcd3ea0b2606804938f77ca2f2cadb101e
-  data.tar.gz: 96ae41fccbd1bbce862512002e94d5d0db5edf9701d2844154be0babfb4c1eb3986d816d484bd1b9048fca891331cc6da73b8e5bdc646ea56c9074223ff52742
+  metadata.gz: 552e36a4241ab85cc6933ced18d29b315fee8e7436a5b98f1cedc071981d5c94e0b46400f0a05bc9a7642a3c3c6346c69cd48482c0f161002d26dd8886005238
+  data.tar.gz: 0329fc125a3c35e2477b5d91e8908658c77c36c9fef6dd382b94964c46e151c21344981309b6ef80be9c9f9c61aff20414382197ec072434a790de21cd4fafca

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    rspec_request_helpers (0.1.1)
+    rspec_request_helpers (0.2.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
+      factory_bot
+      parser
       rack (~> 2.0)
       railties (>= 3.0)
       rspec (~> 3.0)
@@ -29,12 +31,15 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    ast (2.4.0)
     builder (3.2.3)
     coderay (1.1.2)
     concurrent-ruby (1.0.5)
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.7.1)
+    factory_bot (4.11.1)
+      activesupport (>= 3.0.0)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     loofah (2.2.2)
@@ -45,6 +50,8 @@ GEM
     minitest (5.11.3)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)

data/README.md

@@ -9,13 +9,32 @@ In order to use it in your `rspec/requests` specs you need to follow one rule:
     NOTE: version 0.1.1 introduced the helpers which ensure naming conventions. They have identical names and in fact are
     wrappers around RSpec `let` functionality.
 
-So what you'll got for that? Few handy methods for the testing routine
+So what you'll got for that? - Few handy methods for the testing routine
 
-* `do_get`, `do_post`, `do_put`, `do_delete`, `do_patch` shorthands for sending appropriate requests.
-* `assert_201_json`, `assert_404_xml`, `assert_422_json` etc. shorthands for asserting content type and HTTP status code only. This methods are generated depends on configuration defined in `config/initializers/rspec_request_helpers.rb`.
-* `assert_201_json_response_body`, `assert_422_json_responce_body` etc. shorthands for asserting content type, HTTP status code and if parsed body of the response is equal to `valid_response`.
-* `assert_201_json_response_object`, `assert_422_json_responce_body` etc. same as previous assert specific attribute rather than whole response body.
-* one lined form for simple examples `do_post_and_assert_201_json_response_body`
+| Action | Meaning | RSpec Example |
+|---|---|---|
+| `do_get`, `do_post`, `do_put`, `do_delete`, `do_patch` | Sends apropriate request to endpoint with valid params and headers | `get(path, valid_params, valid_headers)` |
+| `assert_201_json`, `assert_404_xml`, `assert_422_json` etc | Assert response status code and mime type (Dynamicly generated based on config ) | `expect(response).to have_http_status(status)`<br>`expect(response.content_type).to eq mime_type` |
+| `do_post_and_assert_201_json_response_body` | Shorthand for asserting content type, HTTP status code and if parsed body of the response is equal to | `expect(parsed_body).to eq(expected_response)` |
+
+Version 0.2.0 introduced `database` method which acceps the code block witch allow creation of database records via `FactoryBot` and Rspec `let`, `let!` syntax.
+
+```ruby
+#
+# Usage:
+# user(:user, name: 'Bob') translates to let(:user) { FactoryBot.create(:user, name: 'Bob') }
+# user!(:user, name: 'Bob') translates to let!(:user) { FactoryBot.create(:user, name: 'Bob') }
+# user_list(:user, name: 'Bob', 3) translates to let(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
+# user_list!(:user, name: 'Bob', 3) translates to let!(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
+#
+database do
+  company2!(:company, name: name, domain_name: domain, location: location_name)
+  company3!(:company, name: name2, domain_name: domain, location: location_name)
+  order1!(:order, :ordered, :with_items, items_count: 1, status: IN_QC, company_id: company3.id, delivered_at: Time.zone.now)
+  order2!(:order, :ordered, :with_items, items_count: 1, status: COMPLETED, company_id: company3.id, delivered_at: Time.zone.now, order_date: (Time.zone.now - 1.day))
+  order3!(:order, :ordered, :with_items, items_count: 1, status: NOT_READY, company_id: company3.id)
+end
+```
 
 ## Installation
 
@@ -54,6 +73,20 @@ RSpec.configure do |config|
 end
 ```
 
+## Configuration
+
+Create file `config/initializers/rspec_request_helpers.rb`
+
+```ruby
+RspecRequestHelpers.configure do |config|
+  # Supporded content types
+  config.content_types = { json: 'application/json' }
+
+  # Supported status codes
+  config.status_codes  = [404, 401, 422, 200, 201]
+end
+```
+
 Generate new file for API endpoint
 
     $ rails g rspec:endpoint show api/v1/users

data/lib/rspec_request_helpers/helpers.rb

@@ -1,6 +1,45 @@
 module RspecRequestHelpers
   module Helpers
     module ClassMethods
+      require 'parser/current'
+
+      class DatabaseDSLTranslator < ::Parser::TreeRewriter
+        def on_send(node)
+          _, method_name, *args = node.children
+
+          factory_attrs = args.map { |e| e.loc.expression.source }.join(', ')
+
+          case method_name
+          when /list!$/
+            replace(node.loc.expression, "let!(:#{method_name.to_s.sub(/list!$/,'')}) { FactoryBot.create_list(#{factory_attrs}) }")
+          when /list$/
+            replace(node.loc.expression, "let(:#{method_name.to_s.sub(/list$/,'')}) { FactoryBot.create_list(#{factory_attrs}) }")
+          when /!$/
+            replace(node.loc.expression, "let!(:#{method_name.to_s.sub(/!$/,'')}) { FactoryBot.create(#{factory_attrs}) }")
+          else
+            replace(node.loc.expression, "let(:#{method_name}) { FactoryBot.create(#{factory_attrs}) }")
+          end
+        end
+      end
+
+      #
+      # Tiny DSL for creating list or single database records
+      # via factory_bot syntax and Rspec :let or :let! methods
+      # Usage:
+      # user(:user, name: 'Bob') is translated to let(:user) { FactoryBot.create(:user, name: 'Bob') }
+      # user!(:user, name: 'Bob') is translated to let!(:user) { FactoryBot.create(:user, name: 'Bob') }
+      # user_list(:user, name: 'Bob', 3) is translated to let(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
+      # user_list!(:user, name: 'Bob', 3) is translated to let!(:user) { FactoryBot.create_list(:user, 3, name: 'Bob') }
+      #
+      def database(&block)
+        parser        = Parser::CurrentRuby.new
+        rewriter      = DatabaseDSLTranslator.new
+        buffer        = Parser::Source::Buffer.new('(string)')
+        buffer.source = Parser::CurrentRuby.parse(block.source).children.last.loc.expression.source
+        rspec_factory = rewriter.rewrite(buffer, parser.parse(buffer))
+        self.class_eval(rspec_factory)
+      end
+
       def path(&block)
         let(:path, &block)
       end

data/lib/rspec_request_helpers/version.rb

@@ -1,3 +1,3 @@
 module RspecRequestHelpers
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/rspec_request_helpers.gemspec

@@ -1,33 +1,33 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rspec_request_helpers/version"
+require 'rspec_request_helpers/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rspec_request_helpers"
+  spec.name          = 'rspec_request_helpers'
   spec.version       = RspecRequestHelpers::VERSION
-  spec.authors       = ["Andrii Baran"]
-  spec.email         = ["andriy.baran.v@gmail.com"]
+  spec.authors       = ['Andrii Baran']
+  spec.email         = ['andriy.baran.v@gmail.com']
 
   spec.summary       = %q{A set of helpers for request test with RSpec}
-  spec.homepage      = "https://github.com/andriy-baran/rspec_request_helpers"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/andriy-baran/rspec_request_helpers'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.2.2'
 
   version_string = ['>= 3.0']
@@ -35,11 +35,13 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', version_string
   spec.add_runtime_dependency 'actionpack',    version_string
   spec.add_runtime_dependency 'railties',      version_string
+  spec.add_runtime_dependency 'factory_bot'
 
-  spec.add_dependency "rspec", "~> 3.0"
-  spec.add_dependency "rack", "~> 2.0"
+  spec.add_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'rack', '~> 2.0'
+  spec.add_dependency 'parser'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_request_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrii Baran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-20 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  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: bundler
   requirement: !ruby/object:Gem::Requirement