brainstem 1.4.1 → 2.0.0

data/lib/brainstem/concerns/formattable.rb

@@ -1,28 +1,23 @@
 require 'brainstem/api_docs'
 require 'active_support/inflector/inflections'
 
-
 module Brainstem
   module Concerns
     module Formattable
       attr_writer :formatters
 
-
       def valid_options
         super | [ :formatters ]
       end
 
-
       def formatters
         @formatters ||= ::Brainstem::ApiDocs::FORMATTERS[formatter_type]
       end
 
-
       def formatted_as(format, options = {})
         formatters[format].call(self, options)
       end
 
-
       #
       # Declares the type of formatter that should be used to format an entity
       # of this class.

data/lib/brainstem/concerns/optional.rb

@@ -34,7 +34,6 @@ module Brainstem
         [ ]
       end
 
-
       def initialize(options = {})
         options.slice(*valid_options).each {|k, v| self.send("#{k}=", v) }
       end

data/lib/brainstem/concerns/presenter_dsl.rb

@@ -10,7 +10,6 @@ require 'brainstem/dsl/conditionals_block'
 require 'brainstem/dsl/fields_block'
 require 'brainstem/dsl/associations_block'
 
-
 require 'active_support/core_ext/array/extract_options'
 
 module Brainstem
@@ -70,7 +69,6 @@ module Brainstem
           end
         end
 
-
         # @overload default_sort_order(sort_string)
         #   Sets a default sort order.
         #   @param [String] sort_string The sort order to apply by default
@@ -86,7 +84,6 @@ module Brainstem
           configuration[:default_sort_order]
         end
 
-
         #
         # @overload sort_order(name, order, options)
         #   @param [Symbol] name The name of the sort order.
@@ -121,7 +118,6 @@ module Brainstem
           })
         end
 
-
         #
         # @overload filter(name, type, options = {})
         #   @param [Symbol] name The name of the scope that may be applied as a
@@ -142,13 +138,8 @@ module Brainstem
         #   @yieldreturn [ActiveRecord::Relation] A new scope that filters the
         #     scope that was yielded.
         #
-        def filter(name, type = DEFAULT_FILTER_DATA_TYPE, options = {}, &block)
-          if type.is_a?(Hash)
-            options = type if options.blank?
-            type = DEFAULT_FILTER_DATA_TYPE
-
-            deprecated_type_warning
-          elsif type.to_s == 'array'
+        def filter(name, type, options = {}, &block)
+          if type.to_s == 'array'
             options[:item_type] = options[:item_type].to_s.presence || DEFAULT_FILTER_DATA_TYPE
           end
 
@@ -189,16 +180,6 @@ module Brainstem
 
         DEFAULT_FILTER_DATA_TYPE = 'string'
         private_constant :DEFAULT_FILTER_DATA_TYPE
-
-        def deprecated_type_warning
-          ActiveSupport::Deprecation.warn(
-            'Please specify the `type` of the filter as the second argument. If not specified, '\
-              'it will default to `:string`. This default behavior will be deprecated in the next major '\
-              'version and will need to be explicitly specified. '\
-              'e.g. `filter :status, :string, items: ["Started", "Completed"]`',
-            caller
-          )
-        end
       end
     end
   end

data/lib/brainstem/dsl/configuration.rb

@@ -60,7 +60,6 @@ module Brainstem
         @storage[key] ||= InheritableAppendSet.new
       end
 
-
       #
       # Marks a key in the configuration as nonheritable, which means that the key:
       #
@@ -82,10 +81,8 @@ module Brainstem
         self.nonheritable_keys << formatted_key unless self.nonheritable_keys.include?(formatted_key)
       end
 
-
       attr_accessor :nonheritable_keys
 
-
       #
       # Returns the keys in this configuration object that are visible to child
       # configuration objects (i.e. heritable keys).
@@ -96,7 +93,6 @@ module Brainstem
         keys - nonheritable_keys.to_a
       end
 
-
       #
       # Returns a hash of this object's storage, less those pairs that are
       # not visible to children.
@@ -107,7 +103,6 @@ module Brainstem
         to_h.select {|k, v| keys_visible_to_children.include?(format_key(k)) }
       end
 
-
       #
       # Returns the union of all keys in this configuration plus those that are
       # heritable in the parent.
@@ -122,7 +117,6 @@ module Brainstem
         end
       end
 
-
       #
       # Returns a list of nonheritable keys for the parent configuration, if
       # the parent configuration actually keeps track of it. Otherwise returns
@@ -139,7 +133,6 @@ module Brainstem
         end
       end
 
-
       #
       # Returns whether a key is nonheritable in this configuration object's
       # parent configuration.
@@ -153,7 +146,6 @@ module Brainstem
         parent_nonheritable_keys.include?(format_key(key.first))
       end
 
-
       #
       # An inversion of +key_nonheritable_in_parent+. Returns true if the
       # key is not marked as nonheritable in the parent configuration.
@@ -167,7 +159,6 @@ module Brainstem
         !key_nonheritable_in_parent?(format_key(key.first))
       end
 
-
       #
       # Returns a hash of this object's storage merged over the heritable pairs
       # of its parent configurations.
@@ -182,7 +173,6 @@ module Brainstem
         end
       end
 
-
       #
       # Returns the value for the given key, or if it could not be found:
       #   - Raises a +KeyError+ if not passed a default or a block;
@@ -210,7 +200,6 @@ module Brainstem
         end
       end
 
-
       def has_key?(key)
         @storage.has_key?(key) ||
           (@parent_configuration.has_key?(key) &&

data/lib/brainstem/presenter.rb

@@ -26,7 +26,6 @@ module Brainstem
       @presents
     end
 
-
     #
     # Returns the set of possible brainstem keys for the classes presented.
     #
@@ -39,7 +38,6 @@ module Brainstem
       end
     end
 
-
     # Return the second-to-last module in the name of this presenter, which Brainstem considers to be the 'namespace'.
     # E.g., Api::V1::FooPresenter has a namespace of "V1".
     # @return [String] The name of the second-to-last module containing this presenter.
@@ -410,12 +408,10 @@ module Brainstem
       end
     end
 
-
     def self.presenter_collection
       Brainstem.presenter_collection(namespace)
     end
 
-
     # @api protected
     # Find the global presenter collection for our namespace.
     def presenter_collection

data/lib/brainstem/version.rb

@@ -1,3 +1,3 @@
 module Brainstem
-  VERSION = "1.4.1"
+  VERSION = "2.0.0"
 end

data/spec/brainstem/api_docs/abstract_collection_spec.rb

@@ -18,7 +18,6 @@ module Brainstem
         end
       end
 
-
       describe "#<<" do
         it "adds a member to the collection" do
           subject << member
@@ -31,7 +30,6 @@ module Brainstem
         end
       end
 
-
       describe "#each" do
         it "iterates over each member" do
           subject << members
@@ -39,13 +37,11 @@ module Brainstem
         end
       end
 
-
       describe "iteration" do
         before do
           subject << member
         end
 
-
         describe "#filenames" do
           it "maps all its members" do
             stub(member).formatted_as(:markdown, {}) { "blah" }
@@ -54,7 +50,6 @@ module Brainstem
           end
         end
 
-
         describe "#each_filename" do
           it "maps all its controllers and yields each in turn" do
             stub(member).formatted_as(:markdown, {}) { "blah" }
@@ -64,7 +59,6 @@ module Brainstem
           end
         end
 
-
         describe "#formatted" do
           it "maps all its members" do
             mock(member).formatted_as(:markdown, {}) { "blah" }
@@ -82,7 +76,6 @@ module Brainstem
           end
         end
 
-
         describe "#formatted_with_filename" do
           it "maps all its members and filenames" do
             mock(member).formatted_as(:markdown, {}) { "blah" }
@@ -105,7 +98,6 @@ module Brainstem
           end
         end
 
-
         describe "#each_formatted" do
           it "maps all its controllers and yields each in turn" do
             mock(member).formatted_as(:markdown, {}) { "blah" }
@@ -120,7 +112,6 @@ module Brainstem
           end
         end
 
-
         describe "#each_formatted_with_filename" do
           it "maps all its controllers and filenames and yields each in turn" do
             mock(member).formatted_as(:markdown, {}) { "blah" }
@@ -139,7 +130,6 @@ module Brainstem
         end
       end
 
-
       describe ".with_members" do
         subject { described_class.with_members(atlas, member) }
 
@@ -147,7 +137,6 @@ module Brainstem
           expect(subject).to be_a described_class
           expect(subject.send(:members)).to eq [ member ]
         end
-
       end
 
       it_behaves_like "atlas taker"

data/spec/brainstem/api_docs/atlas_spec.rb

@@ -36,7 +36,6 @@ module Brainstem
           end
         end
 
-
         describe "validation" do
           before do
             any_instance_of(Atlas) do |instance|
@@ -166,7 +165,6 @@ module Brainstem
           end
         end
 
-
         context "when a route is invalid" do
           let(:route_2) { {
             path: "/endpoint2",
@@ -202,7 +200,6 @@ module Brainstem
         end
       end
 
-
       describe "#extract_presenters!" do
         let(:endpoint_1)           { Object.new }
         let(:endpoint_2)           { Object.new }
@@ -249,7 +246,6 @@ module Brainstem
         end
       end
 
-
       describe "#valid?" do
         before do
           any_instance_of(Atlas) do |instance|
@@ -282,7 +278,6 @@ module Brainstem
         end
       end
 
-
       describe "#allow_route?" do
         before do
           any_instance_of(Atlas) do |instance|
@@ -331,7 +326,6 @@ module Brainstem
         end
       end
 
-
       describe "#find_by_class" do
         before do
           any_instance_of(Atlas) do |instance|

data/spec/brainstem/api_docs/builder_spec.rb

@@ -16,7 +16,6 @@ module Brainstem
 
       subject { Builder.new(default_options.merge(options)) }
 
-
       describe "#initialize" do
         let(:introspector_method) { Object.new }
         let(:options)             { { introspector_method: introspector_method } }
@@ -35,7 +34,6 @@ module Brainstem
         end
       end
 
-
       describe "introspection" do
         let(:introspector_method)   { Object.new }
         let(:args_for_introspector) { { blah: true } }
@@ -55,7 +53,6 @@ module Brainstem
           end
         end
 
-
         it "passes the introspector method the introspector options" do
           mock(introspector_method).call(args_for_introspector)
           subject
@@ -67,7 +64,6 @@ module Brainstem
         end
       end
 
-
       describe "modeling" do
         let(:introspector)        { Object.new }
         let(:atlas_method)        { Object.new }

data/spec/brainstem/api_docs/controller_collection_spec.rb

@@ -36,7 +36,6 @@ module Brainstem
         end
       end
 
-
       describe "#create_from_route" do
         it "creates a new controller, adding it to the members" do
           controller = subject.create_from_route(
@@ -55,7 +54,6 @@ module Brainstem
         end
       end
 
-
       describe "#find_or_create_from_route" do
         let!(:existing_controller) { subject.create_from_route(
           path: "/posts",

data/spec/brainstem/api_docs/controller_spec.rb

@@ -15,7 +15,6 @@ module Brainstem
         end
       end
 
-
       describe "#add_endpoint" do
         let(:endpoint) { Object.new }
 
@@ -26,7 +25,6 @@ module Brainstem
         end
       end
 
-
       describe "derived fields" do
         let(:lorem)          { "lorem ipsum dolor sit amet" }
         let(:const)          { Object.new }
@@ -46,7 +44,6 @@ module Brainstem
           end
         end
 
-
         describe "configuration helpers" do
           describe "#contextual_documentation" do
             let(:default_config) { { title: { info: info, nodoc: nodoc } } }
@@ -93,7 +90,6 @@ module Brainstem
             end
           end
 
-
           describe "#default_configuration" do
             let(:default_config) { { title: nil } }
 
@@ -103,25 +99,45 @@ module Brainstem
           end
         end
 
+        describe "#tag" do
+          let(:default_config) { { tag: tag } }
 
-        describe "#nodoc?" do
-          let(:default_config) { { nodoc: nodoc } }
-
-          context "when nodoc in default" do
-            let(:nodoc) { true }
+          context "when tag in specified" do
+            let(:tag) { 'Tag Name' }
 
             it "is true" do
-              expect(subject.nodoc?).to eq true
+              expect(subject.tag).to eq(tag)
             end
           end
 
-          context "when not nodoc in default" do
-            it "is false" do
-              expect(subject.nodoc?).to eq false
+          context "when tag is not specified" do
+            let(:tag) { nil }
+
+            it "is nil" do
+              expect(subject.tag).to eq(nil)
             end
           end
         end
 
+        describe "#tag_groups" do
+          let(:default_config) { { tag_groups: tag_groups } }
+
+          context "when tag groups are specified" do
+            let(:tag_groups) { ['Group 1', 'Group 2'] }
+
+            it "is true" do
+              expect(subject.tag_groups).to eq(tag_groups)
+            end
+          end
+
+          context "when tag_groups are not specified" do
+            let(:tag_groups) { nil }
+
+            it "is nil" do
+              expect(subject.tag_groups).to eq(nil)
+            end
+          end
+        end
 
         describe "#title" do
           context "when present" do
@@ -149,7 +165,6 @@ module Brainstem
           end
         end
 
-
         describe "#description" do
           context "when present" do
             let(:default_config) { { description: { info: lorem, nodoc: nodoc } } }
@@ -177,7 +192,6 @@ module Brainstem
         end
       end
 
-
       describe "#suggested_filename" do
         let(:const)          { Object.new }
 
@@ -187,7 +201,6 @@ module Brainstem
           end
         end
 
-
         it "gsubs namespace, filename and extension" do
           instance = described_class.new(atlas,
             filename_pattern: "controllers/{{namespace}}/{{name}}_controller.{{extension}}",
@@ -202,7 +215,6 @@ module Brainstem
         end
       end
 
-
       describe "#suggested_filename_link" do
         it "gsubs filename and extension" do
 
@@ -217,7 +229,6 @@ module Brainstem
         end
       end
 
-
       it_behaves_like "formattable"
       it_behaves_like "atlas taker"
     end