blueprint-generators-rails 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94b9c270d0dc340b6d3224eaff4f68fae3234276
-  data.tar.gz: c23beb5acf381b2e0777f0680187189b46a28b27
+  metadata.gz: 1dd712f8f1b7539509b06b248346e9f472500de2
+  data.tar.gz: 1cf019fa7f46e990266eab413ba8928aafbb50e9
 SHA512:
-  metadata.gz: 72405d03108a17cec0ffa95d4bd669845265d582b474bb6744e9248c5fde17a1f82afae5cdc863ccd1309107f24d4fe10d02d63957538c368adff6c9dd5bb6dc
-  data.tar.gz: 5795e6366ebbe021d77d5b43decafe599e13eca57e6a3979cb6c39d10b26c4e9c7ba9c8081eedda64884ce104399ab2a16779951b52b9ea7b3fe72fe5e5ab018
+  metadata.gz: 8ded0b307aabc8783e5c61a33094f97e44429c1b00490a99f6ebe96241af2ad86bcf9b2bf649611f920f13ec021be92247bfea07c30dd90b4b8b4b6c9ddfa394
+  data.tar.gz: 361b070755dbbc05a24d2c8467a42d293cdb5e57302520a02d4d80a28f913e8ab3fc6591dac8efc7f79d9ef1d0ccd7c8e0d3e72eecf4eaa671902406921d671a

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

@@ -1,7 +1,7 @@
 module Blueprint
   module Generators
     module Rails
-      VERSION = '0.2.4'
+      VERSION = '0.2.5'
     end
   end
 end

data/lib/tasks/blueprint.rake

@@ -10,8 +10,9 @@ namespace :blueprint do
     end
   end
 
-  SEQUENCE_TAG_REGEX = /#[\s]*(:seq[_up|down]*\(.*\))/
   CONCEPT_STATE_REGEX = /#[\s]*(:state*\(.*\))/
+  SEQUENCE_TAG_REGEX = /#[\s]*(:seq[_up|down]*\(.*\))/
+  ACTIVITY_TAG_REGEX = /#[\s]*(:act[_perform|decide|yes|no|end]*\(.*\))/
 
   PARAMS_REGEX = /(.*)\((.*?)\)/
 
@@ -117,20 +118,7 @@ namespace :blueprint do
         pogos << pogo.strip
       }
 
-      puts ''
-      puts 'Navigate to the link below and paste the provided script into the editor found at:'
-      puts ''
-      puts '        http://anaxim.io/#/scratchpad'
-      puts ''
-      puts '----'
-      puts '~~~~'
-      pogos.each { |pogo|
-        puts pogo
-        puts '~~~~'
-      }
-      puts '----'
-      puts ''
-
+      print_results pogos
     end
   end
 
@@ -174,7 +162,7 @@ namespace :blueprint do
             tag = line.match(SEQUENCE_TAG_REGEX).try(:captures).try(:first)
 
             if tag
-              print_debug step_count, "Found sequence start tag: '#{tag}'"
+              print_debug step_count, "Found sequence tag: '#{tag}'"
               step_count += 1
 
               # extract the tag type and parameters
@@ -226,20 +214,7 @@ namespace :blueprint do
         pogos << pogo
       }
 
-      puts ''
-      puts 'Navigate to the link below and paste the provided script into the editor found at:'
-      puts ''
-      puts '        http://anaxim.io/#/scratchpad'
-      puts ''
-      puts '----'
-      puts '~~~~'
-      pogos.each { |pogo|
-        puts pogo
-        puts '~~~~'
-      }
-      puts '----'
-      puts ''
-
+      print_results pogos
     end
   end
 
@@ -247,6 +222,169 @@ namespace :blueprint do
   task :sequence => :seq do
   end
 
+  desc 'Generate Activity diagrams for the current Rails project (requires use of semantic tags)'
+  task :act, :root_dir, :debug  do |t, args|
+    root_dir = args[:root_dir] || '.'
+    @debug = args[:debug]
+
+    if @debug
+      puts "Debug mode #{@debug}"
+      puts "Root directory for analysis is: #{root_dir}"
+    end
+
+    # check that this is actually a Rails projects
+    unless File.exist?(root_dir + '/Gemfile')
+      puts 'No Gemfile found. Is this a Rails project?'
+      next
+    end
+
+    # if we get here than all base sanity checks are passed
+
+    # for debugging purposes
+    step_count = 1
+
+    # find the remote git repository name (so that we can link to it directly in our diagrams)
+    repo_url = determine_remote_repository root_dir
+    remote_origin_found = repo_url.present?
+
+    print_debug step_count, remote_origin_found ? "Remote repository URL is #{repo_url}" : 'No remote repository URL found'
+    step_count += 1
+
+    model = { }
+
+    # otherwise continue analysis
+    Dir.chdir(root_dir) do
+      # list all files in the directory - we scan everything (but maybe we shouldn't)
+      Dir.glob('**/*.{rb,js,coffee}').each { |f|
+        file = File.stat f
+
+        if file.file?
+          line_no = 1
+
+          File.open(f).each do |line|
+
+            # we are scanning for things like this:
+            #   # :act(Test, start)
+            #   # :act_perform(Test, action)
+            #   # :act_decide(Test, condition)
+            #   # :act_yes(Test, good outcome)
+            #   # :act_no(Test, bad outcome)
+            #   # :act_end(Test, done)
+
+            tag = line.match(ACTIVITY_TAG_REGEX).try(:captures).try(:first)
+
+            if tag
+              print_debug step_count, "Found activity tag: '#{tag}'"
+              step_count += 1
+
+              # extract the tag type and parameters
+              type, parameters = tag.match(PARAMS_REGEX).try(:captures)
+
+              case type
+                when ':act'
+                  name, start_state = parameters.split(',').map(&:strip)
+                  model[name] ||= { }
+
+                  if remote_origin_found
+                    model[name][:start] ||= { :state => start_state, :at => "#{repo_url}/blob/master/#{f}#L#{line_no}" }
+                  else
+                    model[name][:start] ||= { :state => start_state }
+                  end
+
+
+                when ':act_perform'
+                  name, action = parameters.split(',').map(&:strip)
+                  if remote_origin_found
+                    (model[name][:actions] ||= [ ]) << { :type => 'action', :action => action, :at => "#{repo_url}/blob/master/#{f}#L#{line_no}" }
+                  else
+                    (model[name][:actions] ||= [ ]) << { :type => 'action', :action => action }
+                  end
+
+                when ':act_decide'
+                  name, condition = parameters.split(',').map(&:strip)
+                  if remote_origin_found
+                    (model[name][:actions] ||= [ ]) << { :type => 'decision', :condition => condition, :at => "#{repo_url}/blob/master/#{f}#L#{line_no}" }
+                  else
+                    (model[name][:actions] ||= [ ]) << { :type => 'decision', :condition => condition }
+                  end
+
+                when ':act_yes'
+                  name, action = parameters.split(',').map(&:strip)
+                  if remote_origin_found
+                    (model[name][:actions] ||= [ ]) << { :type => 'yes', :action => action, :at => "#{repo_url}/blob/master/#{f}#L#{line_no}" }
+                  else
+                    (model[name][:actions] ||= [ ]) << { :type => 'yes', :action => action }
+                  end
+
+                when ':act_no'
+                  name, action = parameters.split(',').map(&:strip)
+                  if remote_origin_found
+                    (model[name][:actions] ||= [ ]) << { :type => 'no', :action => action, :at => "#{repo_url}/blob/master/#{f}#L#{line_no}" }
+                  else
+                    (model[name][:actions] ||= [ ]) << { :type => 'no', :action => action }
+                  end
+
+                when ':act_end'
+                  name, state = parameters.split(',').map(&:strip)
+                  if remote_origin_found
+                    (model[name][:actions] ||= [ ]) << { :type => 'end', :state => state, :at => "#{repo_url}/blob/master/#{f}#L#{line_no}" }
+                  else
+                    (model[name][:actions] ||= [ ]) << { :type => 'end', :state => state }
+                  end
+
+                else
+                  raise "Tag type #{type} not recognised when generating activity diagram."
+              end
+            end
+
+            line_no += 1
+          end
+        end
+      }
+
+      # now generate the PogoScript - there may be more than one
+      pogos = [ ]
+
+      model.each { |key, value|
+        pogo = "activity \"#{key}\" starts with \"#{value[:start][:state]}\"\n"
+
+        unless value[:actions].nil?
+          value[:actions].each { |a|
+            case a[:type]
+              when 'action'
+                pogo += " perform \"#{a[:action]}\"\n"
+                pogo += "  at \"#{a[:at]}\"\n" if a[:at].present?
+              when 'decision'
+                pogo += " decide \"#{a[:condition]}\"\n"
+                pogo += "  at \"#{a[:at]}\"\n" if a[:at].present?
+              when 'yes'
+                pogo += " yes \"#{a[:action]}\"\n"
+                pogo += "  at \"#{a[:at]}\"\n" if a[:at].present?
+              when 'no'
+                pogo += " no \"#{a[:action]}\"\n"
+                pogo += "  at \"#{a[:at]}\"\n" if a[:at].present?
+              when 'end'
+                pogo += " end \"#{a[:state]}\"\n"
+                pogo += "  at \"#{a[:at]}\"\n" if a[:at].present?
+              else
+                raise "Direction not recognised when generating PogoScript: #{a[:type]}"
+            end
+
+            pogo += "\n"
+          }
+        end
+
+        pogos << pogo.strip
+      }
+
+      print_results pogos
+    end
+  end
+
+  desc 'Alias for the \'act\' task'
+  task :activity => :act do
+  end
+
   desc 'Generate a Conceptual Model diagram for the current Rails project'
   task :cm, :root_dir, :debug  do |t, args|
 
@@ -497,4 +635,20 @@ namespace :blueprint do
       end
     end
 
+    def self.print_results(pogos)
+      puts ''
+      puts 'Navigate to the link below and paste the provided script into the editor found at:'
+      puts ''
+      puts '        http://anaxim.io/#/scratchpad'
+      puts ''
+      puts '----'
+      puts '~~~~'
+      pogos.each { |pogo|
+        puts pogo
+        puts '~~~~'
+      }
+      puts '----'
+      puts ''
+    end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprint-generators-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - benjii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler