brainstem 2.0.0 → 2.1.0

data/spec/brainstem/concerns/presenter_dsl_spec.rb

@@ -125,12 +125,26 @@ describe Brainstem::Concerns::PresenterDSL do
   end
 
   describe 'the nodoc! method' do
-    before do
+    it "is stored in the configuration" do
+      presenter_class.nodoc! "Description for why these are nodoc"
+      expect(presenter_class.configuration[:nodoc]).to eq "Description for why these are nodoc"
+    end
+
+    it "is defaults to true" do
       presenter_class.nodoc!
+      expect(presenter_class.configuration[:nodoc]).to be true
     end
+  end
 
+  describe 'the internal! method' do
     it "is stored in the configuration" do
-      expect(presenter_class.configuration[:nodoc]).to be true
+      presenter_class.internal! "Description for why these are internal docs"
+      expect(presenter_class.configuration[:internal]).to eq "Description for why these are internal docs"
+    end
+
+    it "is defaults to true" do
+      presenter_class.internal!
+      expect(presenter_class.configuration[:internal]).to be true
     end
   end
 
@@ -172,6 +186,24 @@ describe Brainstem::Concerns::PresenterDSL do
         expect(orders[:created_at][:info]).to eq "sorts by creation time"
       end
     end
+
+    context "when setting the direction" do
+      it "sets the direction to true by default" do
+        presenter_class.sort_order :created_at, value, info: "sorts by creation time"
+
+        expect(orders[:created_at][:direction]).to be_truthy
+      end
+
+      context "when direction is given" do
+        it "respects the given direction value" do
+          presenter_class.sort_order :created_at, value, info: "sorts by creation time", direction: false
+          presenter_class.sort_order :updated_at, value, info: "sorts by creation time", direction: true
+
+          expect(orders[:created_at][:direction]).to be_falsey
+          expect(orders[:updated_at][:direction]).to be_truthy
+        end
+      end
+    end
   end
 
   describe 'the conditional block' do

data/spec/brainstem/dsl/association_spec.rb

@@ -5,10 +5,13 @@ describe Brainstem::DSL::Association do
   let(:name) { :user }
   let(:target_class) { User }
   let(:description) { "This object's user" }
-  let(:options) { { info: description } }
+  let(:type) { :belongs_to }
+  let(:response_key) { :user_id }
+  let(:polymorphic_classes) { [User, Task] }
+  let(:options) { { info: description, response_key: response_key, type: type, polymorphic_classes: polymorphic_classes } }
   let(:association) { Brainstem::DSL::Association.new(name, target_class, options) }
 
-  describe 'description' do
+  describe '#description' do
     context 'when `info` is specified in the options' do
       it 'returns the value specified with the info key' do
         expect(association.description).to eq(description)
@@ -24,8 +27,56 @@ describe Brainstem::DSL::Association do
     end
   end
 
+  describe '#response_key' do
+    context 'when `response_key` is specified in the options' do
+      it 'returns the value specified with the response_key key' do
+        expect(association.response_key).to eq(response_key)
+      end
+    end
+
+    context 'when `response_key` is not specified in the options' do
+      let(:options) { {} }
+
+      it 'returns nil' do
+        expect(association.response_key).to be_nil
+      end
+    end
+  end
+
+  describe '#type' do
+    context 'when `type` is specified in the options' do
+      it 'returns the value specified with the type key' do
+        expect(association.type).to eq(type)
+      end
+    end
+
+    context 'when `type` is not specified in the options' do
+      let(:options) { {} }
+
+      it 'returns nil' do
+        expect(association.type).to be_nil
+      end
+    end
+  end
+
+  describe '#polymorphic_classes' do
+    context 'when `polymorphic_classes` is specified in the options' do
+      it 'returns the value specified with the polymorphic_classes key' do
+        expect(association.polymorphic_classes).to eq(polymorphic_classes)
+      end
+    end
+
+    context 'when `polymorphic_classes` is not specified in the options' do
+      let(:options) { {} }
+
+      it 'returns nil' do
+        expect(association.polymorphic_classes).to be_nil
+      end
+    end
+  end
+
   describe "#run_on" do
-    let(:context) { { } }
+    let(:context) { {} }
 
     context 'with no special options' do
       it 'calls the method by name on the model' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brainstem
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mavenlink
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -240,6 +240,9 @@ files:
 - lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/response_definitions_formatter.rb
 - lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_collection_formatter.rb
 - lib/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_formatter.rb
+- lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/endpoint_param_formatter.rb
+- lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/presenter_field_formatter.rb
+- lib/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter.rb
 - lib/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter.rb
 - lib/brainstem/api_docs/formatters/open_api_specification/version_2/presenter_formatter.rb
 - lib/brainstem/api_docs/formatters/open_api_specification/version_2/security_definitions_formatter.rb
@@ -308,6 +311,9 @@ files:
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/response_definitions_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_collection_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_formatter_spec.rb
+- spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/endpoint_param_formatter_spec.rb
+- spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/presenter_field_formatter_spec.rb
+- spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/presenter_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/security_definitions_formatter_spec.rb
@@ -400,6 +406,9 @@ test_files:
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/response_definitions_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_collection_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint_formatter_spec.rb
+- spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/endpoint_param_formatter_spec.rb
+- spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/presenter_field_formatter_spec.rb
+- spec/brainstem/api_docs/formatters/open_api_specification/version_2/field_definitions/response_field_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/info_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/presenter_formatter_spec.rb
 - spec/brainstem/api_docs/formatters/open_api_specification/version_2/security_definitions_formatter_spec.rb