modalfields 1.2.2 → 1.3.0

data/Gemfile

@@ -1,8 +1,11 @@
 source "http://rubygems.org"
+
+gem 'modalsettings'
 gem "activesupport", ">= 2.3.5"
 gem "activerecord", ">= 2.3.5"
 # gem "rails", ">= 2.3.5"
 
+
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do

data/Gemfile.lock

@@ -21,6 +21,9 @@ GEM
       rake
       rdoc
     json (1.6.6)
+    modalsettings (1.0.0)
+      modalsupport (>= 0.8.1)
+    modalsupport (0.9.2)
     pg (0.10.1)
     rake (0.9.2.2)
     rdoc (3.12)
@@ -37,6 +40,7 @@ DEPENDENCIES
   activesupport (>= 2.3.5)
   bundler (~> 1)
   jeweler (~> 1.8.3)
+  modalsettings
   pg
   rdoc (~> 3.12)
   shoulda

data/VERSION

@@ -1 +1 @@
-1.2.2
+1.3.0

data/lib/modalfields/modalfields.rb

@@ -1,3 +1,5 @@
+require 'modalsettings'
+
 # This is a hybrid between HoboFields and model annotators.
 #
 # It works like other annotators, by updating the model annotations from the DB schema.
@@ -63,7 +65,6 @@ module ModalFields
 
   end
 
-
   class DefinitionsDsl < DslBase
     def field(name, attributes={})
       ModalFields.definitions[name.to_sym] = COMMON_ATTRIBUTES.merge(attributes)
@@ -141,8 +142,14 @@ module ModalFields
   @definitions = {}
   @column_to_field_declaration_hook = nil
   @type_aliases = {}
+  @parameters = Settings[
+    :check_all_models => false,     # consider all models (including those defined in plugins) for migration & check
+    :check_dynamic_models => false, # consider models that may have been defined dynamically not in model files
+    :update_vendor_models => false  # update also model files in vendor
+  ]
 
   class <<self
+
     attr_reader :hooks, :definitions
     # Define declaration of primary keys
     #   ModalFields.show_primary_keys = false # the default: do not show primary keys
@@ -151,6 +158,11 @@ module ModalFields
     #   ModalFields.show_primary_keys = :except_id   # only declare if named differently from 'id'
     attr_accessor :show_primary_keys
 
+    def parameters(params=nil)
+      @parameters.merge! params if params
+      @parameters
+    end
+
     # Run a definition block that executes field type definitions
     def define(&blk)
       DefinitionsDsl.new.instance_eval(&blk)
@@ -186,7 +198,7 @@ module ModalFields
     # It is recommended to run this on a clearn working directory (no uncommitted changes), so that the
     # changes can be easily reviewed.
     def update(modify=true)
-      dbmodels.each do |model, file|
+      dbmodels(dbmodel_options).each do |model, file|
         next if file.nil?
         new_fields, modified_fields, deleted_fields, deleted_model = diff(model)
         unless new_fields.empty? && modified_fields.empty? && deleted_fields.empty?
@@ -221,7 +233,7 @@ module ModalFields
     end
 
     def check
-      dbmodels.each do |model, file|
+      dbmodels(dbmodel_options).each do |model, file|
         new_fields, modified_fields, deleted_fields, deleted_model = diff(model)
         unless new_fields.empty? && modified_fields.empty? && deleted_fields.empty?
           rel_file = file && file.sub(/\A#{Rails.root}/,'')
@@ -239,7 +251,7 @@ module ModalFields
     def migration
       up = ""
       down = ""
-      dbmodels.each do |model, file|
+      dbmodels(dbmodel_options).each do |model, file|
         new_fields, modified_fields, deleted_fields, deleted_model = diff(model)
         unless new_fields.empty? && modified_fields.empty? && deleted_fields.empty?
           up << "\n"
@@ -311,20 +323,84 @@ module ModalFields
 
     private
 
-      # return ActiveRecord classes corresponding to tables, without STI derived classes, but including indirectly
-      # derived classes that do have their own tables (to achieve this we use the convention that in such cases
-      # the base class, directly derived from ActiveRecord::Base has a nil table_name)
-      def dbmodels
-        models = Dir.glob(File.join(Rails.root,"app/models/**/*.rb"))\
-                   .map{|f| [File.basename(f).chomp(".rb").camelize.constantize, f]}\
-                   .select{|c,f| has_table(c)}\
-                   .reject{|c,f| has_table(c.superclass)}
-        models += ActiveRecord::Base.send(:subclasses).reject{|c| c.name.starts_with?('CGI::') || !has_table(c) || has_table(c.superclass)}
-        models.uniq
+      # Return the database models
+      # Options:
+      #   :all_models                # Return also models in plugins, not only in the app (app/models)
+      #   :dynamic_models            # Return dynamically defined models too (not defined in a model file)
+      #   :exclude_sti_models        # Exclude derived (STI) models
+      #   :exclude_non_sti_models    # Exclude top level models
+      #   :include_files             # Return also the model definition file pathnames (return pairs of [model, file])
+      #   :only_app_files            #   But return nil for files not in the app proper
+      #   :only_app_tree_files       #   But return nil for files not in the app directory tree (app, vendor...)
+      def dbmodels(options={})
+
+        models_dir = 'app/models'
+        if Rails.respond_to?(:application)
+          models_dir = Rails.application.paths[models_dir]
+        end
+        models_dir = Rails.root.join(models_dir)
+
+        if options[:all_models]
+          # Include also models from plugins
+          model_dirs = $:.grep(/\/models\/?\Z/)
+        else
+          # Only main application models
+          model_dirs = [models_dir]
+        end
+
+        models = []
+        files = {}
+        model_dirs.each do |base|
+          Dir.glob(File.join(base,"**/*.rb")).each do |fn|
+            model = File.basename(fn).chomp(".rb").camelize.constantize
+            models << model
+            files[model.to_s] = fn
+          end
+        end
+        models = models.sort_by{|m| m.to_s}
+
+        if options[:dynamic_models]
+          # Now add dynamically generated models (not having dedicated files)
+          # note that subclasses of these models are not added here
+          models += ActiveRecord::Base.send(:subclasses)
+          models = models.uniq
+        end
+
+        models = models.uniq.reject{|model| !has_table?(model)}
+
+        non_sti_models, sti_models = models.partition{|model| model.base_class==model}
+
+        models = []
+        models += non_sti_models unless options[:exclude_non_sti_models]
+        models += sti_models unless options[:exclude_sti_models]
+        if options[:include_files]
+          models = models.map{|model| [model, files[model.to_s]]}
+          if options[:only_app_files] || options[:only_app_tree_files]
+            if options[:only_app_files]
+              suffix = models_dir.to_s
+            else
+              suffix = Rails.root.to_s
+            end
+            suffix += '/' unless suffix.ends_with?('/')
+            models = models.map{|model, file| [model, file && (file.starts_with?(suffix) ? file : nil)]}
+          end
+        end
+        models
+      end
+
+      def has_table?(cls)
+       (cls != ActiveRecord::Base) && cls.respond_to?(:table_name) && cls.table_name.present?
       end
 
-      def has_table(cls)
-        (cls!=ActiveRecord::Base) && cls.respond_to?(:table_name) && !cls.table_name.blank?
+      def dbmodel_options
+        {
+          :all_models=>parameters.check_all_models,
+          :dynamic_models=>parameters.check_dynamic_models,
+          :exclude_sti_models=>true,
+          :include_files=>true,
+          :only_app_files=>!parameters.update_vendor_models,
+          :only_app_tree_files=>parameters.update_vendor_models
+        }
       end
 
       def map_column_to_field_declaration(column)

data/modalfields.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "modalfields"
-  s.version = "1.2.2"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Javier Goizueta"]
-  s.date = "2012-09-05"
+  s.date = "2012-09-06"
   s.description = "ModelFields is a Rails plugin that adds fields declarations to your models."
   s.email = "jgoizueta@gmail.com"
   s.extra_rdoc_files = [
@@ -64,6 +64,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<modalsettings>, [">= 0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3.5"])
       s.add_runtime_dependency(%q<activerecord>, [">= 2.3.5"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
@@ -74,6 +75,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pg>, [">= 0"])
       s.add_runtime_dependency(%q<rails>, [">= 2.3.0"])
     else
+      s.add_dependency(%q<modalsettings>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 2.3.5"])
       s.add_dependency(%q<activerecord>, [">= 2.3.5"])
       s.add_dependency(%q<shoulda>, [">= 0"])
@@ -85,6 +87,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rails>, [">= 2.3.0"])
     end
   else
+    s.add_dependency(%q<modalsettings>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 2.3.5"])
     s.add_dependency(%q<activerecord>, [">= 2.3.5"])
     s.add_dependency(%q<shoulda>, [">= 0"])

data/test/helper.rb

@@ -29,7 +29,7 @@ ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) # + '/../../../..'
 
 module Rails
   def self.root
-    ENV['RAILS_ROOT']
+    Pathname(ENV['RAILS_ROOT'])
   end
   def version
     ActiveRecord::VERSION::STRING

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modalfields
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: modalsettings
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +230,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1098194892061652516
+      hash: -375049972268577712
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: