rails-erd 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ada96cc38a16ade059a334c1b0c228f1d950799
-  data.tar.gz: 4ce8b31b96b63dd9da6651d932787d78067fbc74
+  metadata.gz: 7e5205eb093cf7ca1ffd731eb201853c1b4134d3
+  data.tar.gz: 04deb363195d35173242a3479176013eeb1b5402
 SHA512:
-  metadata.gz: 05bebbfc35caa2f8db94a5fd444de5342d8fa1ebae29f5d954b7858b2a61ab9dccd7c48093e19dbac693584de9e41e0c50c1030fbd4b30e59e44e58a73838a0f
-  data.tar.gz: 8b6d762b352f2638e482deb1f8e2330af32a040a651264b70cee13d1bfbfce7dc594ede091d8a3df66954be5dc3b0c798e289c0eb64f2979a1f68b946aa6d110
+  metadata.gz: b9e3a914f4eefec4a97304d2a621b0dd3105741401ab1438db75292ecfc50f968aeb6e7f36a0937088f6152ed355692ee53b5585f0090d97e5b800aa06c39dce
+  data.tar.gz: 11b65a72efea78e56f6bf25d1363d3ef1fe94336f8556e266480216aa573d27784aae16784cef7f79d1860e34375fef6906f2a9c352ae2b4c73ec067db2dc904

data/README.md

@@ -5,7 +5,7 @@ Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
 
 The second goal of Rails ERD is to provide you with a tool to inspect your application's domain model. If you don't like the default output, it is very easy to use the API to build your own diagrams.
 
-Rails ERD was created specifically for Rails 3. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.
+Rails ERD was created specifically for Rails and works on versions 3.0-4.2. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.
 
 
 Preview
@@ -53,10 +53,12 @@ markup: true
 notation: simple
 orientation: horizontal
 polymorphism: false
+sort: true
 warn: true
 title: sample title
 exclude: null
-only: 
+only: null
+prepend_primary: false
 ```
 
 

data/lib/rails_erd.rb

@@ -46,10 +46,12 @@ module RailsERD
         :notation, :simple,
         :orientation, :horizontal,
         :polymorphism, false,
+        :sort, true,
         :warn, true,
         :title, true,
         :exclude, nil,
-        :only, nil
+        :only, nil,
+        :prepend_primary, false
       ]
     end
   end

data/lib/rails_erd/cli.rb

@@ -57,6 +57,18 @@ Choice.options do
     desc "Filter to exclude listed models in diagram."
   end
 
+  option :sort do
+    long "--sort=BOOLEAN"
+    desc "Sort attribute list alphabetically"
+    default "false"
+  end
+
+  option :prepend_primary do
+    long "--prepend_primary=BOOLEAN"
+    desc "Ensure primary key is at start of attribute list"
+    default "false"
+  end
+
   separator ""
   separator "Output options:"
 
@@ -118,7 +130,7 @@ module RailsERD
           if key.start_with? "no_"
             opts[key.gsub("no_", "").to_sym] = !value
           elsif value.to_s.include? ","
-            opts[key.to_sym] = value.split(",").map(&:to_sym)
+            opts[key.to_sym] = value.split(",").map(&:to_s)
           else
             opts[key.to_sym] = value
           end

data/lib/rails_erd/config.rb

@@ -60,12 +60,15 @@ module RailsERD
       when :filetype, :notation, :orientation
         value.to_sym
 
+      # [<string>]
+      when :only, :exclude
+        Array(value).join(",").split(",").map { |v| v.strip }
       # true | false
       when :disconnected, :indirect, :inheritance, :markup, :polymorphism, :warn
         !!value
 
       # nil | <string>
-      when :filename, :only, :exclude
+      when :filename
         value.nil? ? nil : value.to_s
 
       # true | false | <string>

data/lib/rails_erd/diagram.rb

@@ -150,8 +150,8 @@ module RailsERD
 
     def filtered_entities
       @domain.entities.reject { |entity|
-        options.exclude && entity.model && [options.exclude].flatten.include?(entity.name.to_sym) or
-        options.only && entity.model && ![options.only].flatten.include?(entity.name.to_sym) or
+        options.exclude && entity.model && [options.exclude].flatten.include?(entity.name.to_s) or
+        options.only && entity.model && ![options.only].flatten.include?(entity.name.to_s) or
         !options.inheritance && entity.specialized? or
         !options.polymorphism && entity.generalized? or
         !options.disconnected && entity.disconnected?

data/lib/rails_erd/domain/attribute.rb

@@ -10,7 +10,20 @@ module RailsERD
 
       class << self
         def from_model(domain, model) # @private :nodoc:
-          model.columns.collect { |column| new(domain, model, column) }.sort
+          attributes = model.columns.collect { |column| new(domain, model, column) }
+          attributes.sort! if RailsERD.options[:sort]
+
+          if RailsERD.options[:prepend_primary]
+            primary_key = ActiveRecord::Base.get_primary_key(model)
+            primary = attributes.detect{ |column| column.name == primary_key }
+
+            if primary
+              attributes.delete(primary)
+              attributes.unshift(primary)
+            end
+          end
+
+          attributes
         end
       end
 
@@ -47,6 +60,10 @@ module RailsERD
         !column.null or @model.validators_on(name).map(&:kind).include?(:presence)
       end
 
+       def unique?
+         @model.validators_on(name).map(&:kind).include?(:uniqueness)
+       end
+
       # Returns +true+ if this attribute is the primary key of the entity.
       def primary_key?
         @model.primary_key.to_s == name.to_s
@@ -93,7 +110,10 @@ module RailsERD
       def type_description
         type.to_s.tap do |desc|
           desc << " #{limit_description}" if limit_description
-          desc << " ∗" if mandatory? # Add a hair space + low asterisk (Unicode characters).
+          desc << " ∗" if mandatory? && !primary_key? # Add a hair space + low asterisk (Unicode characters)
+          desc << " U" if unique? && !primary_key? && !foreign_key? # Add U if unique but non-key
+          desc << " PK" if primary_key?
+          desc << " FK" if foreign_key?
         end
       end
 

data/lib/rails_erd/domain/entity.rb

@@ -40,7 +40,7 @@ module RailsERD
 
       # Returns an array of attributes for this entity.
       def attributes
-        @attributes ||= if generalized? then [] else Attribute.from_model(domain, model) end
+        @attributes ||= generalized? ? [] : Attribute.from_model(domain, model)
       end
 
       # Returns an array of all relationships that this entity has with other

data/lib/rails_erd/domain/relationship.rb

@@ -190,7 +190,7 @@ module RailsERD
       end
 
       def foreign_key_required?(association)
-        if association.belongs_to?
+        if !association.active_record.abstract_class? and association.belongs_to?
           column = association.active_record.columns_hash[association.send(Domain.foreign_key_method_name)] and !column.null
         end
       end

data/lib/rails_erd/version.rb

@@ -1,4 +1,4 @@
 module RailsERD
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
   BANNER = "RailsERD #{VERSION}"
 end

data/test/support_files/erdconfig.example

@@ -13,6 +13,6 @@ orientation: horizontal
 polymorphism: false
 warn: true
 title: sample title
-exclude: null
+exclude:
 only: 
 

data/test/support_files/erdconfig.exclude.example

@@ -0,0 +1,18 @@
+attributes:
+  - content
+  - foreign_key
+  - inheritance
+disconnected: true
+filename: erd
+filetype: pdf
+indirect: true
+inheritance: false
+markup: true
+notation: simple
+orientation: horizontal
+polymorphism: false
+warn: true
+title: sample title
+exclude: Book,Author
+only: 
+

data/test/unit/attribute_test.rb

@@ -30,6 +30,30 @@ class AttributeTest < ActiveSupport::TestCase
       Domain::Attribute.from_model(Domain.new, Foo).reject(&:primary_key?).first.column
   end
 
+  test "from_model should return attributes with sorted order if sort is true" do
+    RailsERD.options[:sort] = true
+    create_model "Foo"
+    add_column :foos, :a, :string
+    assert_equal %w{a id}, Domain::Attribute.from_model(Domain.new, Foo).map(&:name)
+  end
+
+  test "from_model should return attributes with original order if sort is false" do
+    RailsERD.options[:sort] = false
+    create_model "Foo"
+    add_column :foos, :a, :string
+    assert_equal %w{id a}, Domain::Attribute.from_model(Domain.new, Foo).map(&:name)
+  end
+
+  test "from_model should return attributes with PK first if sort is false and prepend_primary is true" do
+    RailsERD.options[:sort]            = false
+    RailsERD.options[:prepend_primary] = true
+
+    create_model "Foo"
+    add_column :foos, :a, :string
+
+    assert_equal %w{id a}, Domain::Attribute.from_model(Domain.new, Foo).map(&:name)
+  end
+
   test "spaceship should sort attributes by name" do
     create_model "Foo", :a => :string, :b => :string, :c => :string
     a = create_attribute(Foo, "a")

data/test/unit/config_test.rb

@@ -24,8 +24,30 @@ class ConfigTest < ActiveSupport::TestCase
       polymorphism: false,
       warn:         true,
       title:        "sample title",
-      exclude:      nil,
-      only:         nil
+      exclude:      [],
+      only:         []
+    }
+    assert_equal expected_hash, RailsERD::Config.load
+  end
+
+  test "load_config_file should return a hash from USER_WIDE_CONFIG_FILE when only USER_WIDE_CONFIG_FILE exists." do
+    set_user_config_file_to("erdconfig.exclude.example")
+
+    expected_hash = {
+      attributes:   [:content, :foreign_key, :inheritance],
+      disconnected: true,
+      filename:     "erd",
+      filetype:     :pdf,
+      indirect:     true,
+      inheritance:  false,
+      markup:       true,
+      notation:     :simple,
+      orientation:  :horizontal,
+      polymorphism: false,
+      warn:         true,
+      title:        "sample title",
+      exclude:      ['Book', 'Author'],
+      only:         []
     }
     assert_equal expected_hash, RailsERD::Config.load
   end
@@ -56,8 +78,8 @@ class ConfigTest < ActiveSupport::TestCase
       polymorphism: false,
       warn:         true,
       title:        "sample title",
-      exclude:      nil,
-      only:         nil
+      exclude:      [],
+      only:         []
     }
     assert_equal expected_hash, RailsERD::Config.load
   end

data/test/unit/diagram_test.rb

@@ -126,27 +126,27 @@ class DiagramTest < ActiveSupport::TestCase
   test "generate should filter excluded entity" do
     create_model "Book"
     create_model "Author"
-    assert_equal [Book], retrieve_entities(:exclude => :Author).map(&:model)
+    assert_equal [Book], retrieve_entities(:exclude => ['Author']).map(&:model)
   end
 
   test "generate should filter excluded entities" do
     create_model "Book"
     create_model "Author"
     create_model "Editor"
-    assert_equal [Book], retrieve_entities(:exclude => [:Author, :Editor]).map(&:model)
+    assert_equal [Book], retrieve_entities(:exclude => ['Author', 'Editor']).map(&:model)
   end
 
   test "generate should include only specified entity" do
     create_model "Book"
     create_model "Author"
-    assert_equal [Book], retrieve_entities(:only => [:Book]).map(&:model)
+    assert_equal [Book], retrieve_entities(:only => ['Book']).map(&:model)
   end
 
   test "generate should include only specified entities" do
     create_model "Book"
     create_model "Author"
     create_model "Editor"
-    assert_equal [Author, Editor], retrieve_entities(:only => [:Author, :Editor]).map(&:model)
+    assert_equal [Author, Editor], retrieve_entities(:only => ['Author', 'Editor']).map(&:model)
   end
 
   test "generate should filter disconnected entities if disconnected is false" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Rolf Timmermans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -97,6 +97,7 @@ files:
 - lib/rails_erd/version.rb
 - test/support_files/erdconfig.another_example
 - test/support_files/erdconfig.example
+- test/support_files/erdconfig.exclude.example
 - test/test_helper.rb
 - test/unit/attribute_test.rb
 - test/unit/cardinality_test.rb
@@ -109,7 +110,8 @@ files:
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb
 homepage: https://github.com/voormedia/rails-erd
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -134,6 +136,7 @@ summary: Entity-relationship diagram for your Rails models.
 test_files:
 - test/support_files/erdconfig.another_example
 - test/support_files/erdconfig.example
+- test/support_files/erdconfig.exclude.example
 - test/test_helper.rb
 - test/unit/attribute_test.rb
 - test/unit/cardinality_test.rb