blueprint-api-rails 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d8f08fc6a6a16a012f97f982ce8242f8910ff19
-  data.tar.gz: b0d2f3ada82b8565ad8cf11a455ddf5293a9df60
+  metadata.gz: 18a23084533dcc625ff392693ca1a0b41f3652a8
+  data.tar.gz: ca5f2d2ccba38944e6007137de9c69568c593691
 SHA512:
-  metadata.gz: 1752120fbf82f5c3dc59aa472af6353888b624d632850929e09d5fc6e7ecebdafee092d55228f30939fd5301eda79061d6b0209a7614440e7b1cd2b7961956c0
-  data.tar.gz: 53024cf284cbbc36d52179fd59cdb52c57296a4b0301bf11465edcf166cc155edbb8dfdad68b1a0c6dc23c3f95e087c915be04734f8894f7eee92b4c583c0099
+  metadata.gz: 764c8bf1203f279cd57a830d975e094760397175ca94c2c8e610f09417b3e6e0ada0c5175eae64ba137559eae11a71d1a51de448c7e1b937611b7705d0dc439e
+  data.tar.gz: 929979c8e821eeba1c1d8948439dfa60991c6e9c4398ba4e527da09f4cd4a7e718e25e0e62d03996b69a4b098789d81d04121334195552ecf4209b901e349582

data/lib/blueprint/api/rails.rb

@@ -69,6 +69,21 @@ module Blueprint
       self
     end
 
+    # figures out (and returns) the remote origin for a local git repository
+    def determine_remote_repository(root_dir)
+      Dir.chdir(root_dir) do
+        git_remotes = `git remote show origin | grep 'Fetch URL: ' 2>&1`
+        repo_url = git_remotes.match(/Fetch URL: (.*).git/).try(:captures)
+
+        if !repo_url.empty?
+          repo_url = repo_url[0]
+          repo_url
+        else
+          nil
+        end
+      end
+    end
+
   end
 
   ##
@@ -91,25 +106,41 @@ module Blueprint
     # 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
+    def scan(repository_type)
+      repo_url = nil
+
+      if repository_type == :github
+        p 'GitHub has been specified as the remote repository store'
+        repo_url = determine_remote_repository '.'
+      end
 
       p 'Scanning for controllers...'
 
-      # scan for all controllers (any file with the name *Controller)
+      # scan for all controllers (any file with the name *_controller.rb)
       controllers = Dir[Rails.root.join('app/controllers/*_controller.rb')].map { |path|
-        path.match(/(\w+_controller).rb/); $1.gsub!(/_/, ' ').titleize
+        path.match(/(\w+_controller).rb/); $1
       }.reject { |clazz|
-        clazz.eql?('Application Controller')   # ignore the ApplicationController superclass
+        clazz.eql?('application_controller')   # ignore the ApplicationController superclass
       }.compact
 
       p "Found #{controllers.length} controllers - sending to Blueprint"
 
-      # send the controllers to Blueprint
-      controllers.each { |c|
-        self.element(c)       # register the element
-      }
+      if repository_type == :github
+        controllers.each { |c|
+          pretty_name = c.gsub(/_/, ' ').titleize
+          self.element(pretty_name, "#{repo_url}/blob/master/app/controllers/#{c}.rb")       # register the element
+        }
+
+      else
+        controllers.each { |c|
+          pretty_name = c.gsub(/_/, ' ').titleize
+          self.element(pretty_name)       # register the element
+        }
+
+      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
@@ -123,8 +154,8 @@ module Blueprint
       p 'Scan complete'
     end
 
-    def element(name)
-      StructuralElementDesignContext.new(@api_key, @structure_id, name)
+    def element(name, code_url = nil)
+      StructuralElementDesignContext.new(@api_key, @structure_id, name, code_url)
     end
 
     def concept(name)
@@ -178,11 +209,12 @@ module Blueprint
 
   class StructuralElementDesignContext < DesignContext
 
-    def initialize(api_key, structure_id, name)
+    def initialize(api_key, structure_id, name, code_url)
       @api_key = api_key
       @structure_id = structure_id
       @instance_id = SecureRandom.uuid
       @name = name
+      @code_url = code_url
 
       # initialise faraday
       @conn = Faraday.new(:url => BLUEPRINT_SERVER) do |faraday|
@@ -193,7 +225,8 @@ module Blueprint
       # we register the structural element immediately (so that it appears on the structure even though it has no description / messages)
       self.send DESCRIBE_ELEMENT,
                 {
-                    :name => @name
+                    :name => @name,
+                    :code_url => @code_url
                 }
     end
 
@@ -208,6 +241,15 @@ module Blueprint
       self
     end
 
+    def contains_with_pattern(pattern)
+      self.send CONTAINS,
+                {
+                    :parent => @name,
+                    :pattern => pattern
+                }
+      self
+    end
+
     def contains(constituent)
       self.send CONTAINS,
                 {
@@ -240,6 +282,48 @@ module Blueprint
                 }
     end
 
+    def related_to(relation, other)
+      self.send DESCRIBE_CONCEPT,
+                {
+                    :name => @name,
+                    :relationship => {
+                        :other => other,
+                        :relation => relation
+                    }
+                }
+
+      # return a design context for the 'other' concept (to support the fluent API)
+      ConceptDesignContext.new(@api_key, @structure_id, other)
+    end
+
+    def has_one(other)
+      self.send DESCRIBE_CONCEPT,
+                {
+                    :name => @name,
+                    :relationship => {
+                        :relation => 'has one',
+                        :other => other
+                    }
+                }
+
+      # return a design context for the 'other' concept (to support the fluent API)
+      ConceptDesignContext.new(@api_key, @structure_id, other)
+    end
+
+    def has_many(other)
+      self.send DESCRIBE_CONCEPT,
+                {
+                    :name => @name,
+                    :relationship => {
+                        :relation => 'has many',
+                        :other => other
+                    }
+                }
+
+      # return a design context for the 'other' concept (to support the fluent API)
+      ConceptDesignContext.new(@api_key, @structure_id, other)
+    end
+
     # applies a description to the (conceptual) element
     def describe(description = nil, stereotype = nil)
       self.send DESCRIBE_CONCEPT,

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

@@ -1,7 +1,7 @@
 module Blueprint
   module Api
     module Rails
-      VERSION = '0.2.3'
+      VERSION = '0.2.5'
     end
   end
 end

metadata

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