blueprint-api-rails 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 785506963749b0ec9c534c6ae2a2f29b43d51531
-  data.tar.gz: 692c18d746600e1f399d54d25422c00e6bcb18c7
+  metadata.gz: 8a9fe12b5d07a6b092fd9ac10f9556116e51fa27
+  data.tar.gz: 8d2d6f67c7b40f676cc344427a14f588db42ecdd
 SHA512:
-  metadata.gz: dddbdc7efef2de303de2e3c8a84862d56e9c01044a89a640e336b9f7db88a638584ee3a2428eb8dccc8063d753463950cb4ba532aeba9db53c83e1990d89b8b8
-  data.tar.gz: 1288df1666ab966e2316b523827cc970540abc5680b8477f2428791f9c38953cb07f49c3942e2543799d356b5c6f7b9b3c6239f9892a1c83ea806b8f565954a7
+  metadata.gz: 76515fe219c732211854347e732d3dd5bd96b59dfd4527f894b0e218c560953f218d32d439cde34150aae35c1d92c129d57211c60252154743c9bc4f68752342
+  data.tar.gz: da3b116b3d680f9538e794d2531d1ddccc19b9457d2615183c0b314e1d363251b4b0e73d8dbd3d381940c079a8e42655fbc4cf9b862d0476691276be07c6b99b

data/lib/blueprint/api/rails.rb

@@ -9,7 +9,6 @@ module Blueprint
   # TODO deprecate all of the branch stuff
   # TODO limit messages that are lists to a maximum of 10 elements
   # TODO add support for getting the current user (so we can analysis log messages per user)
-  # TODO only log messages to the Blueprint server if there is an API key (if there isn't we can still check rules locally)
 
   STRUCTURE_NEW = 'start'
 
@@ -48,26 +47,30 @@ module Blueprint
     # utility method for sending JSON payloads to the Anaxim servers - should never be called directly
     def send(event_type, properties = { }, message = { })
 
-      # construct the base payload
-      payload = {
-          :header => {
-              :structure_id => @structure_id,
-              :properties => properties,
-              :branch => {
-                  :name => @branch || 'master'
-              },
-              :eventType => event_type
-          }
-      }
+      # only send messages if we have an API key (even without one this gem can apply architectural verification rules)
+      unless @api_key.nil?
+
+        # construct the base payload
+        payload = {
+            :header => {
+                :structure_id => @structure_id,
+                :properties => properties,
+                :branch => {
+                    :name => @branch || 'master'
+                },
+                :eventType => event_type
+            }
+        }
 
-      # merge (append) the properties hash onto the payload (properties vary per event type)
-      payload.merge! message
+        # merge (append) the properties hash onto the payload (properties vary per event type)
+        payload.merge! message
 
-      @conn.post do |req|
-        req.url BLUEPRINT_URL_CONTEXT
-        req.headers['Content-Type'] = 'application/json'
-        req.headers['X-Api-Key'] = @api_key
-        req.body = payload.to_json
+        @conn.post do |req|
+          req.url BLUEPRINT_URL_CONTEXT
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['X-Api-Key'] = @api_key
+          req.body = payload.to_json
+        end
       end
 
       self
@@ -93,23 +96,43 @@ module Blueprint
       # the list of violations for this action
       violations = [ ]
 
+      # if all parameters are present then we can check for link rules
+      if source.present? && target.present? && type.present?
+        # check to see if there is a link rule for this source / target pair
+        if RULES.has_key?(:links)
+          link_rule = RULES[:links].find { |l| l[:source] == source && l[:target] == target }
+
+          unless link_rule.nil?
+            # there is a link rule - check that the type is allowed over the link
+            unless link_rule[:allowed] == type
+              violations << "The type #{type} is not allowed over the link #{source} -> #{target}."
+            end
+          end
+        end
+      end
+
       unless type.nil?
-        # is the type restricted to a certain structural element?
+        # is the type allowed?
+        if RULES.has_key?(:allowed)
+          unless RULES[:allowed].map { |t| t[:name] }.include?(type)
+            violations << "The type #{type} is not registered as being allowed."
+          end
+        end
 
+        # is the type restricted to a certain structural element?
         unless RULES[type].nil?   # are there any rules for this type?
 
           if RULES[type].has_key?(:only)    # do the rules for this type include an 'only' restriction?
             allowed_element = RULES[type][:only]
 
             unless allowed_element.eql?(source)
-              violations << "The type #{type} is allowed only within #{allowed_element} and it was used in #{source}."
+              violations << "The type #{type} is allowed only within #{allowed_element} and it was used within #{source}."
             end
           end
         end
       end
 
       # output architectural violations
-      # TODO make this output more obvious (and configurable?)
       unless violations.empty?
         p '### Architectural violations found ###'
         violations.each { |v|
@@ -139,8 +162,6 @@ module Blueprint
     end
 
     # performs an extract (that is, scans the code base for architectural elements)
-    # TODO this scan can be arbitrarily complex - we could scan for anything
-    # TODO add support of passing in custom scanners
     def scan(repository_type)
       repo_url = nil
 
@@ -175,7 +196,6 @@ module Blueprint
       end
 
       # now scan for models
-      # TODO support code URLs for models too
       models = Dir[Rails.root.join('app/models/*.rb')].map { |path|
         path.match(/(\w+).rb/); $1.titleize
       }.compact
@@ -189,10 +209,12 @@ module Blueprint
       p 'Scan complete'
     end
 
+    # creates a design context for a structural element
     def element(name, code_url = nil)
       StructuralElementDesignContext.new(@api_key, @structure_id, name, code_url)
     end
 
+    # creates a design context for a concept
     def concept(name)
       ConceptDesignContext.new(@api_key, @structure_id, name)
     end
@@ -218,7 +240,7 @@ module Blueprint
     end
 
     # logs a message between two nodes in the structure
-    def log(message = { }, extras = { }, type = nil, source = nil, target = nil)
+    def log(source = nil, target = nil, type = nil, message = { }, extras = { })
       # always check the logged message for architectural rules violations
       check_rules(source, target, type)
 
@@ -373,7 +395,19 @@ module Blueprint
       self
     end
 
-    # verification methods
+    # methods to support AVL (architectural verification)
+
+    # marks a conceptual type as allowed within the archiecture
+    def allow
+      unless RULES.has_key?(:allowed)
+        RULES[:allowed] = [ ]
+      end
+
+      # add the type to the allowed list
+      RULES[:allowed] << { :name => @name }
+    end
+
+    # marks a conceptual type as allowed within (and only within) a structural elements
     def only(element)
       unless RULES.has_key?(@name)
         RULES[@name] = { }
@@ -433,7 +467,7 @@ module Blueprint
       end
 
 
-      def log(message = { }, extras = { }, type = nil, source = nil, target = nil)
+      def log(source = nil, target = nil, type = nil, message = { }, extras = { })
         # always check the logged message for architectural rules violations
         check_rules(source, target, type)
 
@@ -479,8 +513,29 @@ module Blueprint
       end
     end
 
+    def allow(concept)
+      unless RULES.has_key?(:links)
+        RULES[:links] = [ ]
+      end
+
+      # look for an existing rule
+      existing_rule = RULES[:links].find { |l| l[:source] == @source && l[:target] == @target }
+
+      if existing_rule.nil?
+        existing_rule = {
+            :source => @source,
+            :target => @target,
+            :allowed => concept,
+        }
+
+        RULES[:links] << existing_rule
+      else
+        existing_rule[:allowed] = concept
+      end
+    end
+
     # logs a message between two nodes in the structure
-    def log(message = { }, extras = { }, type = nil)
+    def log(type = nil, message = { }, extras = { })
       # always check the logged message for architectural rules violations
       check_rules(@source, @target, type)
 

data/lib/blueprint/api/rails/version.rb

@@ -1,7 +1,7 @@
 module Blueprint
   module Api
     module Rails
-      VERSION = '0.2.6'
+      VERSION = '0.2.7'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprint-api-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - benjii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler