blueprint-generators-rails 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 575a658dff129cd604d23f2c5a75c9a8c0e1fdb8
-  data.tar.gz: 7dc6ad06758386e8081812f32af30a3f9cbb4c62
+  metadata.gz: ed74bf88f68d1cf0892cd924c01c3867d5565520
+  data.tar.gz: a23b7c4d5e80b834dfc9105a48a61938dea4b23b
 SHA512:
-  metadata.gz: 72f5f62af8171a98708756a84e4216b787201fdcfdc1592b6b7d891f1441eab4d1a678b956871fc3c30c70e08c7de8fe0a997f6b25933cb450300d3fe08a67df
-  data.tar.gz: 88a256a12ab19301597490c657d8996d8e17fdcd28175a344f759ef24f0679ee05fcfffced7c55a9f393f0f4ea5799900e93c9dc74777acd0a7342ec3265c70d
+  metadata.gz: a78b4e02fe8544c9a7ed2e2e2d1a934255d047e6fde1d84eeafa5c29979189c07a9fbae7a1883c32455c607e3ad504430bc93c5953e6000028593d3c722e32c9
+  data.tar.gz: 5291415e66479f219ab46171baf0d3cedab1c3bc528b95f48bdc7629caf9c1c54b2ba29d26300f89ad67ca5d97d8ce9b4df93c265e4f03460721003dfca85e1b

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

@@ -1,7 +1,7 @@
 module Blueprint
   module Generators
     module Rails
-      VERSION = "0.0.8"
+      VERSION = "0.1.0"
     end
   end
 end

data/lib/tasks/blueprint.rake

@@ -1,39 +1,46 @@
 namespace :blueprint do
 
+  @debug = false
+
   desc 'Generate a Conceptual Model diagram for the current Rails project'
   task :cm, [:options] => :environment do |t, args|
     Rails.application.eager_load!
 
+    # set the debug flag
+    @debug = args[:options] == 'debug'
+
+    # we store the detected model in a hash - which we later serialize to PogoScript
+    model = { }
+
     # for debugging purposes
     step_count = 1
 
+    # get the configured app name
     app_name = Rails.application.class.parent_name
-    pogo = "conceptual model for \"" + app_name + "\""
 
-    if args[:options] == 'debug'
-      puts "#{step_count}. Generating conceptual model PogoScript for " + app_name
-      step_count += 1
-    end
+    print_debug step_count, "Generating conceptual model PogoScript for " + app_name
+    step_count += 1
 
-    models = ActiveRecord::Base.descendants
-    models.each { |m|
+    concepts = ActiveRecord::Base.descendants
+    concepts.each { |m|
+      next if m.name.starts_with?'HABTM' # we skip Rails 'special' HABTM model classes
 
       concept_name = humanise(m.name)
-      pogo << "\n concept \"" + concept_name + "\"\n"
 
-      if args[:options] == 'debug'
-        puts "#{step_count}. Adding concept " + concept_name
-        step_count += 1
-      end
+      # add the concept to the model hash
+      model[concept_name] = [ ]
+
+      print_debug step_count, "Adding concept " + concept_name
+      step_count += 1
 
       unless m.superclass.to_s == 'ActiveRecord::Base'
         is_a_name = humanise(m.superclass.to_s.singularize.capitalize)
-        pogo << "  is a \"" + is_a_name + "\"\n"
 
-        if args[:options] == 'debug'
-          puts "#{step_count}. Concept " + concept_name + " is a " + is_a_name
-          step_count += 1
-        end
+        # add the node relationship to the concept
+        model[concept_name].push({ :type => 'is a', :name => is_a_name })
+
+        print_debug step_count, "Concept " + concept_name + " is a " + is_a_name
+        step_count += 1
       end
 
       associations = m.reflect_on_all_associations
@@ -45,36 +52,72 @@ namespace :blueprint do
         case a.macro
           when :belongs_to, :has_one
             has_one_name = humanise(a.name.to_s.singularize.capitalize)
-            pogo << "  has one \"" + has_one_name + "\"\n"
 
-            if args[:options] == 'debug'
-              puts "#{step_count}. Concept " + concept_name + " has one " + has_one_name
-              step_count += 1
-            end
+            # add the node relationship to the concept
+            model[concept_name].push({ :type => 'has one', :name => has_one_name })
+
+            print_debug step_count, "Concept " + concept_name + " has one " + has_one_name
+            step_count += 1
 
           when :has_many
             has_many_name = humanise(a.name.to_s.singularize.capitalize)
-            pogo << "  has many \"" + has_many_name + "\"\n"
 
-            if args[:options] == 'debug'
-              puts "#{step_count}. Concept " + concept_name + " has one " + has_many_name
-              step_count += 1
+            # add the node relationship to the concept
+            model[concept_name].push({ :type => 'has many', :name => has_many_name })
+
+            print_debug step_count, "Concept " + concept_name + " has one " + has_many_name
+            step_count += 1
+
+          when :has_and_belongs_to_many
+            # this is a many-to-many, so we add two 'has many' relationships (one of each side)
+            has_many_name = humanise(a.name.to_s.singularize.capitalize)
+
+            # add the first side of the 'has many' if it does not already exist
+            if model[concept_name].find { |v| v[:type] == 'has many' && v[:name] == has_many_name }.nil?
+              model[concept_name].push({ :type => 'has many', :name => has_many_name })
             end
 
-          else
-            # TODO support other macro types and variants (i.e.: has_and_belongs_to_many, through, etc)
+            # if the model hash doesn't have any entry for the many side of the relationship, create it
+            if model[has_many_name].nil?
+              model[has_many_name] = [ ]
+            end
 
-            if args[:options] == 'debug'
-              puts "#{step_count}. Did not recognise macro type!"
-              step_count += 1
+            # add the second side of the 'has many' if it does not already exist
+            if model[has_many_name].find { |v| v[:type] == 'has many' && v[:name] == concept_name }.nil?
+              model[has_many_name].push({ :type => 'has many', :name => concept_name })
             end
 
-          # TODO error condition
+            print_debug step_count, "Concept " + concept_name + " has many-to-many with " + has_many_name
+            step_count += 1
+
+          else
+            print_debug step_count, "Did not recognise macro type: " + a.macro.to_s
+            step_count += 1
+
+        end
+      }
+    }
 
+    # now generate the PogoScript
+    pogo = "conceptual model for \"" + app_name + "\""
+    model.each { |name, relationships|
+      pogo << "\n concept \"" + name + "\"\n"
+
+      relationships.each { |r|
+        case r[:type]
+          when 'is a'
+            pogo << "  is a \"" + r[:name] + "\"\n"
+          when 'has one'
+            pogo << "  has one \"" + r[:name] + "\"\n"
+          when 'has many'
+            pogo << "  has many \"" + r[:name] + "\"\n"
+          else
+            # TODO implement
         end
       }
     }
 
+    # output the result
     puts ''
     puts 'Navigate to the link below and paste the provided script into the editor'
     puts ''
@@ -110,4 +153,10 @@ namespace :blueprint do
       str
     end
 
+    def self.print_debug(step_count, str)
+      if @debug
+        puts "#{step_count}. " + str
+      end
+    end
+
 end

metadata

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