lib/rails_erd.rb in rails-erd-0.2.0 vs lib/rails_erd.rb in rails-erd-0.3.0
- old
+ new
@@ -1,54 +1,36 @@
require "active_support/ordered_options"
require "rails_erd/railtie" if defined? Rails
# Rails ERD provides several options that allow you to customise the
-# generation of the diagram and the domain model itself. Currently, the
-# following options are supported:
+# generation of the diagram and the domain model itself. For an overview of
+# all options available in Rails ERD, see README.rdoc.
#
-# exclude_foreign_keys:: Excludes foreign key columns from attribute lists.
-# Defaults to +true+.
-# exclude_primary_keys:: Excludes primary key columns from attribute lists.
-# Defaults to +true+.
-# exclude_timestamps:: Excludes timestamp columns (<tt>created_at/on</tt> and
-# <tt>updated_at/on</tt>) from attribute lists. Defaults
-# to +true+.
-# exclude_unconnected:: Excludes entities that are not connected to other
-# entities from the diagram. Defaults to +true+.
-# file_type:: The file type of the generated diagram. Defaults to +:pdf+, which
-# is the recommended format. Other formats may render significantly
-# worse than a PDF file.
-# orientation:: The direction of the hierarchy of entities. Either +:horizontal+
-# or +:vertical+. Defaults to +:horizontal+. The orientation of the
-# PDF that is generated depends on the amount of hierarchy
-# in your models.
-# suppress_warnings:: When set to +true+, no warnings are printed to the
-# command line while processing the domain model. Defaults
-# to +false+.
-#
# You can specify the option on the command line if you use Rails ERD with
# Rake:
#
-# % rake erd orientation=vertical exclude_timestamps=false
+# % rake erd orientation=vertical title='My model diagram'
#
# When using Rails ERD from within Ruby, you can set the options on the
# RailsERD namespace module:
#
# RailsERD.options.orientation = :vertical
-# RailsERD.options.exclude_timestamps = false
+# RailsERD.options.title = "My model diagram"
module RailsERD
class << self
# Access to default options. Any instance of RailsERD::Domain and
# RailsERD::Diagram will use these options unless overridden.
attr_accessor :options
end
self.options = ActiveSupport::OrderedOptions[
- :exclude_foreign_keys, true,
- :exclude_primary_keys, true,
- :exclude_timestamps, true,
- :exclude_unconnected, true,
- :file_type, :pdf,
+ :attributes, :regular,
+ :disconnected, true,
+ :filename, "ERD",
+ :filetype, :pdf,
+ :indirect, true,
+ :notation, :simple,
:orientation, :horizontal,
- :suppress_warnings, false
+ :warn, true,
+ :title, true
]
end