rabbitmq-spec 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d1814e687f3b0ce55d3baca067879c62365a0b8
-  data.tar.gz: e6af3aaea895f09c47893d4996e10e59120635bb
+  metadata.gz: 016cfd923683057289d676445546b13f59314f89
+  data.tar.gz: da4ce486cd8e02f41bd3dc7d7b1573b3e8659d35
 SHA512:
-  metadata.gz: 97f57760a21a605dc747db947c62b0049bdfdf57a1b026aee8c5b3ca4e6c9b44d3c7fc87de49b9ff4c7ae7a6352f364857bb9fbf5d0aafc44c2b524c51620cbc
-  data.tar.gz: ce151b629973854e7cdfad63a78e45a5109e5573131ccad9b9678cdbee97016230cc1647ff23638b8b29aa6936469b0b7a4b46956aa3e721b673455b7c78101c
+  metadata.gz: 16270c70679b6eeb18689da2f88b07139e89024d3d6e572d0372a4e7d0bcb2949f104802c306ad12d0060d2a41c5bb456cd58835be8308bc8835eb9a5ad4fd81
+  data.tar.gz: 04607f00200dc540f61875d2a81f26e1101e3d7d1b5f45016e614f6c762f1caa575852ef0d37307a9edb379922d28f34249b2f96324fc794fa00595ffe150b01

data/.rubocop.yml

@@ -9,6 +9,10 @@ Style/ClassAndModuleChildren:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Metrics/LineLength:
+  Max: 100
+  IgnoredPatterns: ['\A#']
+
 AllCops:
   Exclude:
     - rabbitmq-spec.gemspec

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--markup markdown
+--default-return void

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
+gem 'yard', '~> 0.9.9', require: false
+
 # Specify your gem's dependencies in rabbitmq-spec.gemspec
 gemspec

data/README.md

@@ -74,6 +74,15 @@ On each mqspec file. You can use the following syntax:
       end
     end
   end
+
+  # you can declare queues outside exchanges.
+  # The setup process will not bind them to anything
+  queue 'queue-name' do
+    description 'queue1 description'
+    options do
+      durable true
+    end
+  end
 `````
 
 ## RabbitMQ Setup

data/lib/rabbitmq-spec.rb

@@ -1,5 +1,6 @@
 require 'rabbitmq-spec/version'
 
+# Global RabbitMQ namespace
 module RabbitMQSpec
   autoload :DSL, 'rabbitmq-spec/dsl'
   autoload :Entity, 'rabbitmq-spec/entity'

data/lib/rabbitmq-spec/dsl.rb

@@ -1,7 +1,19 @@
+# Namespace for all DSL logic.
+# Use this module to evaluate a string in our DSL format
+# and fetch a world instance containing all the entities extracted
+# from the DSL specification
+# @example
+#    RabbitMQSpec::DSL.evaluate(%Q{
+#      exchange 'name1' do
+#        description %Q{ My Exchange }
+#      end
+#    })
 module RabbitMQSpec::DSL
   autoload :World, 'rabbitmq-spec/dsl/world'
   autoload :Builder, 'rabbitmq-spec/dsl/builder'
 
+  # @param dsl String in the DSL format to be evaluated by.
+  # @return [World] Configured by the DSL definition.
   def self.evaluate(dsl)
     world = World.new
     world.instance_eval(dsl)

data/lib/rabbitmq-spec/dsl/builder.rb

@@ -1,3 +1,6 @@
+# @api private
+# Namespace for all DSL builders.
+# Each builder is a class that implements the methods that are called when evaluating the DSL
 class RabbitMQSpec::DSL::Builder
   autoload :Base, 'rabbitmq-spec/dsl/builder/base'
   autoload :Queue, 'rabbitmq-spec/dsl/builder/queue'

data/lib/rabbitmq-spec/dsl/builder/base.rb

@@ -1,22 +1,44 @@
+# Base class for each builder.
+# A Builder is a class where the DSL evaluator will run
+# the DSL files. It is where we define our DSL syntax.
+# For more info to know how to use it,
+# see the specs related to the builders.
 class RabbitMQSpec::DSL::Builder::Base
   # class methods
+
+  # @private
+  # Helper method to inhereted classes.
+  # We declare witch methods will be allowed to be called
+  # inside a builder instance in order to store the value
+  # passed to the method
   def self.define_dsl_attribute(attribute_name)
     @allowed_dsl_attributes ||= []
     @allowed_dsl_attributes << attribute_name.to_sym
   end
 
+  # @private
+  # Helper method to inhereted classes.
+  # The child class must call this method
+  # Passing and entity to be builded after
+  # all the the attributes was filled
   def self.define_entity_class(entity_class)
     @entity_class = entity_class
   end
 
+  # @private
   def self.get_entity_class
     @entity_class
   end
 
+  # @private
   def self.has_dsl_attribute?(attribute_name)
     @allowed_dsl_attributes.include?(attribute_name.to_sym)
   end
 
+  # @public
+  # This method evaluates the given blog inside
+  # a new instance of the Builder class
+  # and asks for the class to build the correlated entity
   def self.build(default_entity_values = {}, &block)
     builder = new(default_entity_values)
     builder.instance_eval(&block)
@@ -28,6 +50,9 @@ class RabbitMQSpec::DSL::Builder::Base
     @builded_attributes = {}.merge(default_entity_values)
   end
 
+  # For each method called we verify if it's
+  # an defined attribute for the builder.
+  # If it is then we store the argument as value of the attribute
   def method_missing(method_name, *args, &block)
     if self.class.has_dsl_attribute?(method_name.to_sym)
       @builded_attributes[method_name.to_sym] = if block_given?
@@ -51,6 +76,8 @@ class RabbitMQSpec::DSL::Builder::Base
 
   private
 
+  # Helper class to evaluate blocks that are passe
+  # to the defined attributes for the inhereted classes
   class HashBuilder
     def initialize
       @hash = {}

data/lib/rabbitmq-spec/dsl/builder/exchange.rb

@@ -1,3 +1,4 @@
+# Behavior inside the "exchange" DSL keyword
 class RabbitMQSpec::DSL::Builder::Exchange < RabbitMQSpec::DSL::Builder::Base
   define_entity_class RabbitMQSpec::Entity::Exchange
 

data/lib/rabbitmq-spec/dsl/builder/queue.rb

@@ -1,3 +1,4 @@
+# Behavior inside the "queue" DSL keyword
 class RabbitMQSpec::DSL::Builder::Queue < RabbitMQSpec::DSL::Builder::Base
   define_entity_class RabbitMQSpec::Entity::Queue
 

data/lib/rabbitmq-spec/dsl/world.rb

@@ -1,12 +1,30 @@
+# Class to generate instances for the DSL evaluation
+# @api private
+# @attr exchanges [Array<RabbitMQSpec::Entity::Exchange>]
+# @attr single_queues [Array<RabbitMQSpec::Entity::Queue>]
+
 class RabbitMQSpec::DSL::World
   attr_reader :exchanges
+  attr_reader :single_queues
 
   def initialize
     @exchanges = []
+    @single_queues = []
   end
 
+  # DSL exchange keyword
+  # @attr name [String] Name of the exchange
+  # @yield Block to be evaluated on RabbitMQSpec::DSL::Builder::Exchange build proccess
   def exchange(name, &block)
     new_exchange = RabbitMQSpec::DSL::Builder::Exchange.build(name: name, &block)
     @exchanges << new_exchange
   end
+
+  # DSL queue keyword
+  # @attr name [String] Name of the queue
+  # @yield Block to be evaluated on RabbitMQSpec::DSL::Builder::Exchange build proccess
+  def queue(name, &block)
+    new_queue = RabbitMQSpec::DSL::Builder::Queue.build(name: name, &block)
+    @single_queues << new_queue
+  end
 end

data/lib/rabbitmq-spec/entity.rb

@@ -1,3 +1,4 @@
+# Namespace for all entities related to our Business Logic
 module RabbitMQSpec::Entity
   autoload :Exchange, 'rabbitmq-spec/entity/exchange'
   autoload :Queue, 'rabbitmq-spec/entity/queue'

data/lib/rabbitmq-spec/entity/exchange.rb

@@ -1,3 +1,9 @@
+# Represents an exchange in the AMPQ broker
+# @attr name [String]
+# @attr description [String]
+# @attr queues [Array<RabbitMQSpec::Entity::Queue>]
+# @attr options [Hash] Configuration options
+
 class RabbitMQSpec::Entity::Exchange
   attr_accessor :name
   attr_accessor :description

data/lib/rabbitmq-spec/entity/queue.rb

@@ -1,3 +1,9 @@
+# Represents an queue in the AMPQ broker
+# @attr name [String]
+# @attr description [String]
+# @attr routing_key [String]
+# @attr options [Hash] Configuration options
+
 class RabbitMQSpec::Entity::Queue
   attr_accessor :name
   attr_accessor :description

data/lib/rabbitmq-spec/setup.rb

@@ -1,5 +1,10 @@
 require 'bunny'
 
+# Does the AMPQ Broker setup by reading all mqspecs files,
+# evaluating them and connecting to the broker using the provided url
+# in order to create all exchanges, queues and bindings
+# @example
+#   RabbitMQSpec::Setup.run(['/my/path/folde1', 'my/direct_mqspec/file.rb'], 'amqp://guest:guest@localhost:5672')
 class RabbitMQSpec::Setup
   autoload :Runner, 'rabbitmq-spec/setup/runner'
   autoload :WorldSetupper, 'rabbitmq-spec/setup/world_setupper'
@@ -12,6 +17,7 @@ class RabbitMQSpec::Setup
       end
     end
 
+    # @private
     def with_client(ampq_broker_url)
       client = Bunny.new(ampq_broker_url, automatically_recover: false)
       channel = nil
@@ -22,8 +28,8 @@ class RabbitMQSpec::Setup
       rescue Exception => ex
         raise ex
       ensure
-        channel and channel.close
-        client and client.close
+        channel && channel.close
+        client && client.close
       end
     end
   end

data/lib/rabbitmq-spec/setup/runner.rb

@@ -1,3 +1,12 @@
+# @api private
+# Read each file and setups RabbitMQ based on
+# each mqspec defined on them
+# @example
+#   RabbitMQSpec::Setup::Runner.run(
+#      [
+#        '/my/path/folde1',
+#        'my/direct_mqspec/file.rb']
+#      ], bunny_client)
 class RabbitMQSpec::Setup::Runner
   def initialize(paths_to_read, client)
     @paths_to_read = paths_to_read
@@ -10,11 +19,12 @@ class RabbitMQSpec::Setup::Runner
     end
   end
 
-  def worlds
+  # private methods
+  private def worlds
     @paths_to_read.map { |path| RabbitMQSpec::Setup::WorldFetcher.call(path) }
   end
 
-  def setup_world(world)
+  private def setup_world(world)
     RabbitMQSpec::Setup::WorldSetupper.call(world, @client)
   end
 end

data/lib/rabbitmq-spec/setup/world_fetcher.rb

@@ -1,3 +1,8 @@
+# @api private
+# Given a file path it opens the file and
+# evaluate its content using the DSL
+# @example
+#   RabbitMQSpec::Setup::WorldFetcher.('/my/file/path.rb')
 module RabbitMQSpec::Setup::WorldFetcher
   class << self
     def call(mqspec_file_path)

data/lib/rabbitmq-spec/setup/world_setupper.rb

@@ -1,9 +1,17 @@
+# @api private
+# It uses the client to configure the RabbitMQ
+# according with the world object
+# @example
+#   RabbitMQSpec::Setup::WorldSetupper.(world, client)
 module RabbitMQSpec::Setup::WorldSetupper
   class << self
     def call(world, client)
       world.exchanges.each do |exchange|
         setup_exchange(exchange, client)
       end
+      world.single_queues.each do |queue|
+        setup_queue(queue, client)
+      end
     end
 
     def setup_exchange(exchange, client)
@@ -17,5 +25,9 @@ module RabbitMQSpec::Setup::WorldSetupper
         end
       end
     end
+
+    def setup_queue(queue, client)
+      client.queue(queue.name, queue.options)
+    end
   end
 end

data/lib/rabbitmq-spec/version.rb

@@ -1,3 +1,4 @@
 module RabbitMQSpec
-  VERSION = '1.0.1'.freeze
+  # Current gem version (semantic versioning)
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbitmq-spec
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Vinicius Oyama
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-15 00:00:00.000000000 Z
+date: 2017-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -139,6 +139,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -183,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Gem for documenting and configuring RabbitMQ brokers.