fictium 0.3.6 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f0eace448621c4f1f18d5ca332b484971bc7c7e331072007ca42159c6fa7054
-  data.tar.gz: 8989a53b0173af50de555cce3a6df2402b687e8ca3b41a0f4b372da3ea1da17f
+  metadata.gz: abb23f9ae6488365b514b80f6cc2c23aef50fb4e4d20ffe23183d9b18d562155
+  data.tar.gz: 3739c58b555069e051f1f932aa7fd446db0eec591e350512ab22706376cfb484
 SHA512:
-  metadata.gz: 93b8f6e426710c635d9b8294d63ca93b7e4475fee4106f92018bf101c258cebf05662f6776cd2e51ea56f774d5d60d3b7ddc9bddc4dca777484d7ec9b7b339d8
-  data.tar.gz: a419afbf96427c24a898f2e1e469989ae2eebd6d7580adb74a4092e502d7e63d8c7801678222f2af41d957d033c96b81c91d18fa7e41dbfc7b3c08027df111ea
+  metadata.gz: c0eff8c382ebe9954fe1ef600f5fb1ab2ef4cc44fa1f4ca2aa0909359978d4479c9c18b072a93d7f9ddff1d10635b2aba79c532c9f543b26e3f33d57aecc3f8f
+  data.tar.gz: e52b5936e1b76290b3d09d150c6f7c5668c1d0a9d7ff1fc073e00d599ffa1b633139a59a3a6b25b2e09ed51a9657f02b11ad7f9df0c7a0dd76671fbffd4972c4

data/CHANGELOG.md

@@ -17,6 +17,14 @@
 
 ## LOG
 
+### 0.4.0 (2019-11-28)
+
+Error messages
+
+#### Changes
+
+- Now the gem will check the configuration before running and give some nice error messages.
+
 ### 0.3.6 (2019-11-21)
 
 Small fixes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fictium (0.3.6)
+    fictium (0.4)
       activesupport (>= 5.1, < 6.2)
       json-schema (~> 2.8)
       verbs (~> 2.1.4)

data/README.md

@@ -68,7 +68,8 @@ To configure how this gem completes your documentation, you have some configurat
 
 ### RSpec Integration
 
-Just `require 'fictium/rspec'` in your spec helper and your RSpec test will include everything you need to work in your environment.
+Just `require 'fictium/rspec'` in your rails helper and your RSpec test will include everything you need to work in your environment.
+(be aware, the current version requires Rails to be previously loaded to work).
 
 At any test of type: :controller, you can just add the following helpers:
 

data/lib/fictium.rb

@@ -25,5 +25,23 @@ module Fictium
     def configure
       yield configuration
     end
+
+    def validate_config!
+      raise missing_fixtures if configuration.fixture_path.blank?
+    end
+
+    private
+
+    def missing_fixtures
+      <<~HEREDOC
+        Fictium requires to configure your fixture_path first in order to run Fictium.
+
+        Add the following lines into your rails_helper.rb:
+
+        Fictium.configure do |config|
+          config.fixture_path = File.join(__dir__, 'support', 'docs')
+        end
+      HEREDOC
+    end
   end
 end

data/lib/fictium/rspec.rb

@@ -33,6 +33,7 @@ RSpec.configure do |config|
   config.include Fictium::RSpec::Examples, fictium_example: true
 
   config.after(:suite) do
+    Fictium.validate_config!
     Fictium::RSpec.document.export
   end
 end

data/lib/fictium/rspec/autocomplete/params.rb

@@ -1,3 +1,5 @@
+defined?(Rails) || raise('Rails is required to be loaded before "fictium/rspec" is required.')
+
 module Fictium
   module RSpec
     module Autocomplete

data/lib/fictium/version.rb

@@ -1,5 +1,5 @@
 module Fictium
-  VERSION = '0.3.6'.freeze
+  VERSION = '0.4'.freeze
   RAILS_MIN_VERSION = '>= 5.1'.freeze
   RAILS_MAX_VERSION = '< 6.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fictium
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: '0.4'
 platform: ruby
 authors:
 - Ramiro Rojo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-21 00:00:00.000000000 Z
+date: 2019-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport