blueprint-generators-rails 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95a1f4cef6d1d5f906de05fa614e527627f0c340
-  data.tar.gz: c20b7ede3ce1599b42f8cb27f8b8534bd515ae44
+  metadata.gz: a8a2b1efbd777c76bbbcc97dae7c27f0b76ac571
+  data.tar.gz: cbdef3a62bfc6dc34de02c72d0ce221b1a879d72
 SHA512:
-  metadata.gz: 7eb4b734287df247204e41968a89bad29752fac86b11537504b186a1f9676639c861a797186b9e346769ccc57fc83c3e5e88c6cdb3311b122f033c0bcd98c6dc
-  data.tar.gz: 34c15cd295910813656024f3b586f102fe2255847ab25c335748f89928819445c51f7440b4a85574448ccdb511e0ae85c6c71dd11cf705c958a98833db3e01c7
+  metadata.gz: da94016baff471085de4cf48361b3b2a29243ac742a24176f651f2ac1b982f04a5c32b4f9692d996e7f2d4cf8bb99a4487135e9e020b73fea296aa9789043328
+  data.tar.gz: cebab0c1266be740438e189c49ff455c15d7952a3ab7ba865cfce46d09d862284e9369ef6b06ca65da66250ae59ffedf43f41cf133803bc2674e0118c7a7dff6

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby '2.1.2'
 
 # Specify your gem's dependencies in blueprint-generators-rails.gemspec
 gemspec

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

@@ -1,7 +1,7 @@
 module Blueprint
   module Generators
     module Rails
-      VERSION = "0.1.9"
+      VERSION = '0.2.0'
     end
   end
 end

data/lib/tasks/blueprint.rake

@@ -2,11 +2,127 @@ namespace :blueprint do
 
   @debug = false
 
+  desc 'Generate Sequence diagrams for the current Rails project (requires use of semantic tags)'
+  task :seq, :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
+
+    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?
+
+          File.open(f).each do |line|
+
+            # we are scanning for things like this:
+            #   # @seq[test, a b]
+            #   # @seq_up[test, a b, foo bar]
+            #   # @seq_down[test, b a, bar foo]
+
+            tag = line.match(/#[\s]*(@seq[_up|down]*\[.*\])/).try(:captures).try(:first)
+
+            if tag
+              print_debug step_count, "Found sequence start tag: '#{tag}'"
+              step_count += 1
+
+              # extract the tag type and parameters
+              type, parameters = tag.match(/(.*)\[(.*?)\]/).try(:captures)
+
+              case type
+                when '@seq'
+                  name, lanes = parameters.split(',').map(&:strip)
+                  model[name] ||= { }
+                  model[name][:lanes] ||= lanes.split(' ')
+
+                when '@seq_up'
+                  name, action = parameters.split(',').map(&:strip)
+                  (model[name][:movements] ||= [ ]) << { :direction => :up, :action => action }
+
+                when '@seq_down'
+                  name, action = parameters.split(',').map(&:strip)
+                  (model[name][:movements] ||= [ ]) << { :direction => :down, :action => action }
+
+                else
+                  raise "Tag type #{type} not recognised when generating sequence diagram."
+              end
+            end
+          end
+        end
+      }
+
+      # now generate the PogoScript - there may be more than one
+      pogos = [ ]
+
+      model.each { |key, value|
+        pogo = "sequence \"#{key}\" lanes \"#{value[:lanes].uniq.join(', ')}\"\n"
+
+        unless value[:movements].nil?
+          value[:movements].each { |m|
+            case m[:direction]
+              when :up
+                pogo += " up \"#{m[:action]}\"\n"
+              when :down
+                pogo += " down \"#{m[:action]}\"\n"
+              when :fail
+                pogo += " fail down if \"#{m[:action]}\"\n"
+              else
+                raise "Direction not recognised when generating PogoScript: #{m[:direction]}"
+            end
+          }
+        end
+
+        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 ''
+
+    end
+
+  end
+
+  desc 'Alias for the \'seq\' task'
+  task :sequence => :seq do
+  end
+
   desc 'Generate a Conceptual Model diagram for the current Rails project'
   task :cm, :root_dir, :debug  do |t, args|
 
     root_dir = args[:root_dir] || '.'
-    @debug = args[:debug] || false
+    @debug = args[:debug]
 
     if @debug
       puts "Debug mode #{@debug}"
@@ -54,7 +170,7 @@ namespace :blueprint do
         f.each_line do |line|
           m, app_name = line.match(/(module )(.*)/).try(:captures)
           unless app_name.nil?
-            print_debug step_count, "Application name is " + app_name
+            print_debug step_count, "Application name is #{app_name}"
             step_count += 1
             break
           end
@@ -66,7 +182,7 @@ namespace :blueprint do
     Dir.chdir(root_dir + '/app/models') do
 
       # list all files in the directory
-      Dir.glob("**/*.rb").each { |f|
+      Dir.glob('**/*.rb').each { |f|
 
         # process each file
         File.open(f) do |g|
@@ -138,7 +254,7 @@ namespace :blueprint do
                 end
               end
 
-              print_debug step_count, "Concept " + concept_name + " has one " + has_many_name
+              print_debug step_count, "Concept #{concept_name} has one #{has_many_name}"
               step_count += 1
             end
 
@@ -163,7 +279,7 @@ namespace :blueprint do
                 model[habtm_name].push({ :type => 'has many', :name => concept_name })
               end
 
-              print_debug step_count, "Concept " + concept_name + " has many-to-many with " + habtm_name
+              print_debug step_count, "Concept #{concept_name} has many-to-many with #{habtm_name}"
               step_count += 1
             end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blueprint-generators-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - benjii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler